ImageCaptureExtender.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.extensions;
import android.content.Context;
import android.hardware.camera2.CameraCharacteristics;
import android.os.Build;
import android.util.Pair;
import android.util.Size;
import androidx.annotation.GuardedBy;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.OptIn;
import androidx.annotation.RestrictTo;
import androidx.camera.camera2.impl.Camera2ImplConfig;
import androidx.camera.camera2.impl.CameraEventCallback;
import androidx.camera.camera2.impl.CameraEventCallbacks;
import androidx.camera.camera2.interop.Camera2CameraInfo;
import androidx.camera.camera2.interop.ExperimentalCamera2Interop;
import androidx.camera.core.CameraInfo;
import androidx.camera.core.CameraSelector;
import androidx.camera.core.CameraX;
import androidx.camera.core.ImageCapture;
import androidx.camera.core.Logger;
import androidx.camera.core.UseCase;
import androidx.camera.core.impl.CaptureBundle;
import androidx.camera.core.impl.CaptureConfig;
import androidx.camera.core.impl.CaptureStage;
import androidx.camera.core.impl.Config;
import androidx.camera.extensions.ExtensionsErrorListener.ExtensionsErrorCode;
import androidx.camera.extensions.impl.CaptureProcessorImpl;
import androidx.camera.extensions.impl.CaptureStageImpl;
import androidx.camera.extensions.impl.ImageCaptureExtenderImpl;
import androidx.camera.extensions.internal.AdaptingCaptureProcessor;
import androidx.camera.extensions.internal.AdaptingCaptureStage;
import androidx.camera.extensions.internal.ExtensionVersion;
import androidx.camera.extensions.internal.Version;
import androidx.core.util.Consumer;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.atomic.AtomicBoolean;
/**
* Class for using an OEM provided extension on image capture.
*/
public abstract class ImageCaptureExtender {
private static final String TAG = "ImageCaptureExtender";
static final Config.Option<Integer> OPTION_IMAGE_CAPTURE_EXTENDER_MODE =
Config.Option.create("camerax.extensions.imageCaptureExtender.mode", Integer.class);
private ImageCapture.Builder mBuilder;
private ImageCaptureExtenderImpl mImpl;
@ExtensionMode.Mode
private int mEffectMode;
private ExtensionCameraFilter mExtensionCameraFilter;
void init(ImageCapture.Builder builder, ImageCaptureExtenderImpl implementation,
@ExtensionMode.Mode int effectMode) {
mBuilder = builder;
mImpl = implementation;
mEffectMode = effectMode;
mExtensionCameraFilter = new ExtensionCameraFilter(mImpl);
}
/**
* Indicates whether extension function can support with the given {@link CameraSelector}.
*
* @param cameraSelector The selector that determines a camera that will be checked for the
* availability of extensions.
* @return True if the specific extension function is supported for the camera device.
*/
public boolean isExtensionAvailable(@NonNull CameraSelector cameraSelector) {
return getCameraWithExtension(cameraSelector) != null;
}
/**
* Returns the camera specified with the given camera selector and this extension, null if
* there's no available can be found.
*/
private String getCameraWithExtension(@NonNull CameraSelector cameraSelector) {
CameraSelector.Builder extensionCameraSelectorBuilder =
CameraSelector.Builder.fromSelector(cameraSelector);
extensionCameraSelectorBuilder.addCameraFilter(mExtensionCameraFilter);
return CameraUtil.getCameraIdUnchecked(extensionCameraSelectorBuilder.build());
}
/**
* Enables the derived image capture extension feature. If the extension can't be
* applied on any of the cameras specified with the given {@link CameraSelector}, it will be
* no-ops.
*
* <p>Enabling extensions on {@link ImageCapture} may limit the number of cameras which can
* be selected when the {@link ImageCapture} is used as a parameter to bindToLifecycle.
* BindToLifecycle will throw an exception if no cameras are found that support the extension.
*
* <p>Image capture extension has dependence on preview extension. A
* PREVIEW_EXTENSION_REQUIRED error will be thrown if corresponding preview extension is not
* enabled together.
*
* @param cameraSelector The selector used to determine the camera for which to enable
* extensions.
*/
public void enableExtension(@NonNull CameraSelector cameraSelector) {
String cameraId = getCameraWithExtension(cameraSelector);
if (cameraId == null) {
// If there's no available camera id for the extender to function, just return here
// and it will be no-ops.
return;
}
// TODO: This will be move to a single place for enabling extensions. See b/135434036
// Sets the extension camera id filter to the config.
CameraSelector originalSelector = mBuilder.getUseCaseConfig().getCameraSelector(null);
if (originalSelector == null) {
mBuilder.setCameraSelector(
new CameraSelector.Builder().addCameraFilter(mExtensionCameraFilter).build());
} else {
mBuilder.setCameraSelector(CameraSelector.Builder.fromSelector(
originalSelector).addCameraFilter(mExtensionCameraFilter).build());
}
CameraCharacteristics cameraCharacteristics = CameraUtil.getCameraCharacteristics(cameraId);
mImpl.init(cameraId, cameraCharacteristics);
// TODO(b/161302102): Remove usage of deprecated CameraX.getContext()
@SuppressWarnings("deprecation")
Context context = CameraX.getContext();
updateBuilderConfig(mBuilder, mEffectMode, mImpl, context);
}
/**
* Update extension related configs to the builder.
*/
private static void updateBuilderConfig(@NonNull ImageCapture.Builder builder,
@ExtensionMode.Mode int effectMode, @NonNull ImageCaptureExtenderImpl impl,
@NonNull Context context) {
CaptureProcessorImpl captureProcessor = impl.getCaptureProcessor();
if (captureProcessor != null) {
builder.setCaptureProcessor(new AdaptingCaptureProcessor(captureProcessor));
}
if (impl.getMaxCaptureStage() > 0) {
builder.setMaxCaptureStages(impl.getMaxCaptureStage());
}
ImageCaptureAdapter imageCaptureAdapter = new ImageCaptureAdapter(impl, context);
new Camera2ImplConfig.Extender<>(builder).setCameraEventCallback(
new CameraEventCallbacks(imageCaptureAdapter));
builder.setUseCaseEventCallback(imageCaptureAdapter);
try {
Consumer<Collection<UseCase>> attachedUseCasesUpdateListener =
useCases -> checkPreviewEnabled(effectMode, useCases);
builder.setAttachedUseCasesUpdateListener(attachedUseCasesUpdateListener);
} catch (NoSuchMethodError e) {
// setAttachedUseCasesUpdateListener function may not exist in the used core library.
// Catches the NoSuchMethodError and make the extensions be able to be enabled but
// only the ExtensionsErrorListener does not work.
Logger.e(TAG, "Can't set attached use cases update listener.");
}
builder.setCaptureBundle(imageCaptureAdapter);
builder.getMutableConfig().insertOption(OPTION_IMAGE_CAPTURE_EXTENDER_MODE, effectMode);
List<Pair<Integer, Size[]>> supportedResolutions = getSupportedResolutions(impl);
if (supportedResolutions != null) {
builder.setSupportedResolutions(supportedResolutions);
}
}
/**
* Get the supported resolutions.
*
* @hide
*/
@RestrictTo(RestrictTo.Scope.LIBRARY)
@Nullable
public static List<Pair<Integer, Size[]>> getSupportedResolutions(
@NonNull ImageCaptureExtenderImpl impl) {
if (ExtensionVersion.getRuntimeVersion().compareTo(Version.VERSION_1_1) < 0) {
return null;
}
try {
return impl.getSupportedResolutions();
} catch (NoSuchMethodError e) {
Logger.e(TAG, "getSupportedResolution interface is not implemented in vendor library.");
return null;
}
}
static void checkPreviewEnabled(@ExtensionMode.Mode int effectMode,
Collection<UseCase> activeUseCases) {
boolean isPreviewExtenderEnabled = false;
boolean isMismatched = false;
// In case all use cases are unbound when doing the check.
if (activeUseCases == null || activeUseCases.isEmpty()) {
return;
}
for (UseCase useCase : activeUseCases) {
int previewExtenderMode = useCase.getCurrentConfig().retrieveOption(
PreviewExtender.OPTION_PREVIEW_EXTENDER_MODE, ExtensionMode.NONE);
if (effectMode == previewExtenderMode) {
isPreviewExtenderEnabled = true;
} else if (previewExtenderMode != ExtensionMode.NONE) {
isMismatched = true;
}
}
if (isMismatched) {
ExtensionsManager.postExtensionsError(
ExtensionsErrorCode.MISMATCHED_EXTENSIONS_ENABLED);
} else if (!isPreviewExtenderEnabled) {
ExtensionsManager.postExtensionsError(
ExtensionsErrorCode.PREVIEW_EXTENSION_REQUIRED);
}
}
/**
* An implementation to adapt the OEM provided implementation to core.
*
* @hide
*/
@RestrictTo(RestrictTo.Scope.LIBRARY)
public static class ImageCaptureAdapter extends CameraEventCallback implements
UseCase.EventCallback,
CaptureBundle {
@NonNull
private final ImageCaptureExtenderImpl mImpl;
@NonNull
private final Context mContext;
private final AtomicBoolean mActive = new AtomicBoolean(true);
private final Object mLock = new Object();
@GuardedBy("mLock")
private volatile int mEnabledSessionCount = 0;
@GuardedBy("mLock")
private volatile boolean mUnbind = false;
public ImageCaptureAdapter(@NonNull ImageCaptureExtenderImpl impl,
@NonNull Context context) {
mImpl = impl;
mContext = context;
}
@OptIn(markerClass = ExperimentalCamera2Interop.class)
@Override
public void onAttach(@NonNull CameraInfo cameraInfo) {
if (mActive.get()) {
String cameraId = Camera2CameraInfo.from(cameraInfo).getCameraId();
CameraCharacteristics cameraCharacteristics =
Camera2CameraInfo.extractCameraCharacteristics(cameraInfo);
mImpl.onInit(cameraId, cameraCharacteristics, mContext);
}
}
@Override
public void onDetach() {
synchronized (mLock) {
mUnbind = true;
if (mEnabledSessionCount == 0) {
callDeInit();
}
}
}
private void callDeInit() {
if (mActive.get()) {
mImpl.onDeInit();
mActive.set(false);
}
}
@Override
@Nullable
public CaptureConfig onPresetSession() {
if (mActive.get()) {
CaptureStageImpl captureStageImpl = mImpl.onPresetSession();
if (captureStageImpl != null) {
if (Build.VERSION.SDK_INT >= 28) {
return new AdaptingCaptureStage(captureStageImpl).getCaptureConfig();
} else {
Logger.w(TAG, "The CaptureRequest parameters returned from "
+ "onPresetSession() will be passed to the camera device as part "
+ "of the capture session via "
+ "SessionConfiguration#setSessionParameters(CaptureRequest) "
+ "which only supported from API level 28!");
}
}
}
return null;
}
@Override
@Nullable
public CaptureConfig onEnableSession() {
try {
if (mActive.get()) {
CaptureStageImpl captureStageImpl = mImpl.onEnableSession();
if (captureStageImpl != null) {
return new AdaptingCaptureStage(captureStageImpl).getCaptureConfig();
}
}
return null;
} finally {
synchronized (mLock) {
mEnabledSessionCount++;
}
}
}
@Override
@Nullable
public CaptureConfig onDisableSession() {
try {
if (mActive.get()) {
CaptureStageImpl captureStageImpl = mImpl.onDisableSession();
if (captureStageImpl != null) {
return new AdaptingCaptureStage(captureStageImpl).getCaptureConfig();
}
}
return null;
} finally {
synchronized (mLock) {
mEnabledSessionCount--;
if (mEnabledSessionCount == 0 && mUnbind) {
callDeInit();
}
}
}
}
@Override
@Nullable
public List<CaptureStage> getCaptureStages() {
if (mActive.get()) {
List<CaptureStageImpl> captureStages = mImpl.getCaptureStages();
if (captureStages != null && !captureStages.isEmpty()) {
ArrayList<CaptureStage> ret = new ArrayList<>();
for (CaptureStageImpl s : captureStages) {
ret.add(new AdaptingCaptureStage(s));
}
return ret;
}
}
return null;
}
}
}