SurfaceProcessorWithExecutor.java
/*
* Copyright 2022 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.core.processing;
import static androidx.core.util.Preconditions.checkState;
import androidx.annotation.NonNull;
import androidx.annotation.VisibleForTesting;
import androidx.camera.core.SurfaceOutput;
import androidx.camera.core.SurfaceProcessor;
import androidx.camera.core.SurfaceRequest;
import java.util.concurrent.Executor;
/**
* A wrapper of a pair of {@link SurfaceProcessor} and {@link Executor}.
*
* <p> Wraps the external {@link SurfaceProcessor} and {@link Executor} provided by the app. It
* makes sure that CameraX always invoke the {@link SurfaceProcessor} on the correct
* {@link Executor}.
*/
public class SurfaceProcessorWithExecutor implements SurfaceProcessorInternal {
@NonNull
private final SurfaceProcessor mSurfaceProcessor;
@NonNull
private final Executor mExecutor;
public SurfaceProcessorWithExecutor(
@NonNull SurfaceProcessor surfaceProcessor,
@NonNull Executor executor) {
checkState(!(surfaceProcessor instanceof SurfaceProcessorInternal),
"SurfaceProcessorInternal should always be thread safe. Do not wrap.");
mSurfaceProcessor = surfaceProcessor;
mExecutor = executor;
}
@NonNull
@VisibleForTesting
public SurfaceProcessor getProcessor() {
return mSurfaceProcessor;
}
@NonNull
@VisibleForTesting
public Executor getExecutor() {
return mExecutor;
}
@Override
public void onInputSurface(@NonNull SurfaceRequest request) {
mExecutor.execute(() -> mSurfaceProcessor.onInputSurface(request));
}
@Override
public void onOutputSurface(@NonNull SurfaceOutput surfaceOutput) {
mExecutor.execute(() -> mSurfaceProcessor.onOutputSurface(surfaceOutput));
}
@Override
public void release() {
// No-op. External SurfaceProcessor should not be released by CameraX.
}
}