diff options
Diffstat (limited to 'android/hardware/camera2/params/SessionConfiguration.java')
-rw-r--r-- | android/hardware/camera2/params/SessionConfiguration.java | 200 |
1 files changed, 200 insertions, 0 deletions
diff --git a/android/hardware/camera2/params/SessionConfiguration.java b/android/hardware/camera2/params/SessionConfiguration.java new file mode 100644 index 00000000..a79a6c17 --- /dev/null +++ b/android/hardware/camera2/params/SessionConfiguration.java @@ -0,0 +1,200 @@ +/* + * Copyright (C) 2017 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + + +package android.hardware.camera2.params; + +import android.annotation.NonNull; +import android.annotation.Nullable; +import android.annotation.IntDef; +import android.os.Handler; +import android.hardware.camera2.CameraCaptureSession; +import android.hardware.camera2.CameraCharacteristics; +import android.hardware.camera2.CameraDevice; +import android.hardware.camera2.CaptureRequest; +import android.hardware.camera2.params.InputConfiguration; +import android.hardware.camera2.params.OutputConfiguration; + +import java.util.Collections; +import java.util.List; +import java.util.ArrayList; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; + +import static com.android.internal.util.Preconditions.*; + +/** + * A helper class that aggregates all supported arguments for capture session initialization. + */ +public final class SessionConfiguration { + /** + * A regular session type containing instances of {@link OutputConfiguration} running + * at regular non high speed FPS ranges and optionally {@link InputConfiguration} for + * reprocessable sessions. + * + * @see CameraDevice#createCaptureSession + * @see CameraDevice#createReprocessableCaptureSession + */ + public static final int SESSION_REGULAR = CameraDevice.SESSION_OPERATION_MODE_NORMAL; + + /** + * A high speed session type that can only contain instances of {@link OutputConfiguration}. + * The outputs can run using high speed FPS ranges. Calls to {@link #setInputConfiguration} + * are not supported. + * + * @see CameraDevice#createConstrainedHighSpeedCaptureSession + */ + public static final int SESSION_HIGH_SPEED = + CameraDevice.SESSION_OPERATION_MODE_CONSTRAINED_HIGH_SPEED; + + /** + * First vendor-specific session mode + * @hide + */ + public static final int SESSION_VENDOR_START = + CameraDevice.SESSION_OPERATION_MODE_VENDOR_START; + + /** @hide */ + @Retention(RetentionPolicy.SOURCE) + @IntDef(prefix = {"SESSION_"}, value = + {SESSION_REGULAR, + SESSION_HIGH_SPEED }) + public @interface SessionMode {}; + + // Camera capture session related parameters. + private List<OutputConfiguration> mOutputConfigurations; + private CameraCaptureSession.StateCallback mStateCallback; + private int mSessionType; + private Handler mHandler = null; + private InputConfiguration mInputConfig = null; + private CaptureRequest mSessionParameters = null; + + /** + * Create a new {@link SessionConfiguration}. + * + * @param sessionType The session type. + * @param outputs A list of output configurations for the capture session. + * @param cb A state callback interface implementation. + * @param handler The handler on which the callback will be invoked. If it is + * set to null, the callback will be invoked on the current thread's + * {@link android.os.Looper looper}. + * + * @see #SESSION_REGULAR + * @see #SESSION_HIGH_SPEED + * @see CameraDevice#createCaptureSession(List, CameraCaptureSession.StateCallback, Handler) + * @see CameraDevice#createCaptureSessionByOutputConfigurations + * @see CameraDevice#createReprocessableCaptureSession + * @see CameraDevice#createConstrainedHighSpeedCaptureSession + */ + public SessionConfiguration(@SessionMode int sessionType, + @NonNull List<OutputConfiguration> outputs, + @NonNull CameraCaptureSession.StateCallback cb, @Nullable Handler handler) { + mSessionType = sessionType; + mOutputConfigurations = Collections.unmodifiableList(new ArrayList<>(outputs)); + mStateCallback = cb; + mHandler = handler; + } + + /** + * Retrieve the type of the capture session. + * + * @return The capture session type. + */ + public @SessionMode int getSessionType() { + return mSessionType; + } + + /** + * Retrieve the {@link OutputConfiguration} list for the capture session. + * + * @return A list of output configurations for the capture session. + */ + public List<OutputConfiguration> getOutputConfigurations() { + return mOutputConfigurations; + } + + /** + * Retrieve the {@link CameraCaptureSession.StateCallback} for the capture session. + * + * @return A state callback interface implementation. + */ + public CameraCaptureSession.StateCallback getStateCallback() { + return mStateCallback; + } + + /** + * Retrieve the {@link CameraCaptureSession.StateCallback} for the capture session. + * + * @return The handler on which the callback will be invoked. If it is + * set to null, the callback will be invoked on the current thread's + * {@link android.os.Looper looper}. + */ + public Handler getHandler() { + return mHandler; + } + + /** + * Sets the {@link InputConfiguration} for a reprocessable session. Input configuration are not + * supported for {@link #SESSION_HIGH_SPEED}. + * + * @param input Input configuration. + * @throws UnsupportedOperationException In case it is called for {@link #SESSION_HIGH_SPEED} + * type session configuration. + */ + public void setInputConfiguration(@NonNull InputConfiguration input) { + if (mSessionType != SESSION_HIGH_SPEED) { + mInputConfig = input; + } else { + throw new UnsupportedOperationException("Method not supported for high speed session" + + " types"); + } + } + + /** + * Retrieve the {@link InputConfiguration}. + * + * @return The capture session input configuration. + */ + public InputConfiguration getInputConfiguration() { + return mInputConfig; + } + + /** + * Sets the session wide camera parameters (see {@link CaptureRequest}). This argument can + * be set for every supported session type and will be passed to the camera device as part + * of the capture session initialization. Session parameters are a subset of the available + * capture request parameters (see {@link CameraCharacteristics#getAvailableSessionKeys}) + * and their application can introduce internal camera delays. To improve camera performance + * it is suggested to change them sparingly within the lifetime of the capture session and + * to pass their initial values as part of this method. + * + * @param params A capture request that includes the initial values for any available + * session wide capture keys. + */ + public void setSessionParameters(CaptureRequest params) { + mSessionParameters = params; + } + + /** + * Retrieve the session wide camera parameters (see {@link CaptureRequest}). + * + * @return A capture request that includes the initial values for any available + * session wide capture keys. + */ + public CaptureRequest getSessionParameters() { + return mSessionParameters; + } +} |