CameraEventCallbacks.java
/*
* Copyright 2019 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 androidx.camera.camera2.impl;
import androidx.annotation.NonNull;
import androidx.annotation.RequiresApi;
import androidx.camera.core.impl.CaptureConfig;
import androidx.camera.core.impl.MultiValueSet;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
/**
* Different implementations of {@link CameraEventCallback}.
*/
@RequiresApi(21) // TODO(b/200306659): Remove and replace with annotation on package-info.java
public final class CameraEventCallbacks extends MultiValueSet<CameraEventCallback> {
public CameraEventCallbacks(@NonNull CameraEventCallback... callbacks) {
addAll(Arrays.asList(callbacks));
}
/** Returns a camera event callback which calls a list of other callbacks. */
@NonNull
public ComboCameraEventCallback createComboCallback() {
return new ComboCameraEventCallback(getAllItems());
}
/** Returns a camera event callback which does nothing. */
@NonNull
public static CameraEventCallbacks createEmptyCallback() {
return new CameraEventCallbacks();
}
@NonNull
@Override
public MultiValueSet<CameraEventCallback> clone() {
CameraEventCallbacks ret = createEmptyCallback();
ret.addAll(getAllItems());
return ret;
}
/**
* A CameraEventCallback which contains a list of CameraEventCallback and will
* propagate received callback to the list.
*/
public static final class ComboCameraEventCallback {
private final List<CameraEventCallback> mCallbacks = new ArrayList<>();
ComboCameraEventCallback(List<CameraEventCallback> callbacks) {
for (CameraEventCallback callback : callbacks) {
mCallbacks.add(callback);
}
}
/**
* Invokes {@link CameraEventCallback#onInitSession()} on all registered callbacks and
* returns a {@link CaptureConfig} list that aggregates all the results for setting the
* session parameters.
*
* @return a {@link List<CaptureConfig>} that contains session parameters to be configured
* upon creating {@link android.hardware.camera2.CameraCaptureSession}
*/
@NonNull
public List<CaptureConfig> onInitSession() {
List<CaptureConfig> ret = new ArrayList<>();
for (CameraEventCallback callback : mCallbacks) {
CaptureConfig presetCaptureStage = callback.onInitSession();
if (presetCaptureStage != null) {
ret.add(presetCaptureStage);
}
}
return ret;
}
/**
* Invokes {@link CameraEventCallback#onEnableSession()} on all registered callbacks and
* returns a {@link CaptureConfig} list that aggregates all the results. The returned
* list contains capture request parameters to be set on a single request that will be
* triggered right after {@link android.hardware.camera2.CameraCaptureSession} is
* configured.
*
* @return a {@link List<CaptureConfig>} that contains capture request parameters to be
* set on a single request that will be triggered after
* {@link android.hardware.camera2.CameraCaptureSession} is configured.
*/
@NonNull
public List<CaptureConfig> onEnableSession() {
List<CaptureConfig> ret = new ArrayList<>();
for (CameraEventCallback callback : mCallbacks) {
CaptureConfig enableCaptureStage = callback.onEnableSession();
if (enableCaptureStage != null) {
ret.add(enableCaptureStage);
}
}
return ret;
}
/**
* Invokes {@link CameraEventCallback#onRepeating()} on all registered callbacks and
* returns a {@link CaptureConfig} list that aggregates all the results. The returned
* list contains capture request parameters to be set on the repeating request.
*
* @return a {@link List<CaptureConfig>} that contains capture request parameters to be
* set on the repeating request.
*/
@NonNull
public List<CaptureConfig> onRepeating() {
List<CaptureConfig> ret = new ArrayList<>();
for (CameraEventCallback callback : mCallbacks) {
CaptureConfig repeatingCaptureStage = callback.onRepeating();
if (repeatingCaptureStage != null) {
ret.add(repeatingCaptureStage);
}
}
return ret;
}
/**
* Invokes {@link CameraEventCallback#onDisableSession()} on all registered callbacks and
* returns a {@link CaptureConfig} list that aggregates all the results. The returned
* list contains capture request parameters to be set on a single request that will be
* triggered right before {@link android.hardware.camera2.CameraCaptureSession} is closed.
*
* @return a {@link List<CaptureConfig>} that contains capture request parameters to be
* set on a single request that will be triggered right before
* {@link android.hardware.camera2.CameraCaptureSession} is closed.
*/
@NonNull
public List<CaptureConfig> onDisableSession() {
List<CaptureConfig> ret = new ArrayList<>();
for (CameraEventCallback callback : mCallbacks) {
CaptureConfig disableCaptureStage = callback.onDisableSession();
if (disableCaptureStage != null) {
ret.add(disableCaptureStage);
}
}
return ret;
}
/**
* Invokes {@link CameraEventCallback#onDeInitSession()} on all registered callbacks.
*/
public void onDeInitSession() {
for (CameraEventCallback callback : mCallbacks) {
callback.onDeInitSession();
}
}
@NonNull
public List<CameraEventCallback> getCallbacks() {
return mCallbacks;
}
}
}