[go: nahoru, domu]

blob: 66e9cf641144f06b46c960b48c0a078118506f9b [file] [log] [blame]
/*
* 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.core.impl;
import android.content.Context;
import android.util.Size;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.RequiresApi;
import androidx.camera.core.InitializationException;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* Camera device manager to provide the guaranteed supported stream capabilities related info for
* all camera devices
*/
@RequiresApi(21) // TODO(b/200306659): Remove and replace with annotation on package-info.java
public interface CameraDeviceSurfaceManager {
/**
* Interface for deferring creation of a CameraDeviceSurfaceManager.
*/
interface Provider {
/**
* Creates a new, initialized instance of a CameraDeviceSurfaceManager.
*
* @param context the android context
* @param cameraManager the camera manager object used to query the camera information.
* @param availableCameraIds current available camera ids.
* @return the factory instance
* @throws InitializationException if it fails to create the factory
*/
@NonNull
CameraDeviceSurfaceManager newInstance(@NonNull Context context,
@Nullable Object cameraManager, @NonNull Set<String> availableCameraIds)
throws InitializationException;
}
/**
* Check whether the input surface configuration list is under the capability of any combination
* of this object.
*
* @param isConcurrentCameraModeOn true if concurrent camera mode is on, otherwise false.
* @param cameraId the camera id of the camera device to be compared
* @param surfaceConfigList the surface configuration list to be compared
* @return the check result that whether it could be supported
*/
boolean checkSupported(
boolean isConcurrentCameraModeOn,
@NonNull String cameraId,
@Nullable List<SurfaceConfig> surfaceConfigList);
/**
* Transform to a SurfaceConfig object with cameraId, image format and size info
*
* @param isConcurrentCameraModeOn true if concurrent camera mode is on, otherwise false.
* @param cameraId the camera id of the camera device to transform the object
* @param imageFormat the image format info for the surface configuration object
* @param size the size info for the surface configuration object
* @return new {@link SurfaceConfig} object
*/
@Nullable
SurfaceConfig transformSurfaceConfig(
boolean isConcurrentCameraModeOn,
@NonNull String cameraId,
int imageFormat,
@NonNull Size size);
/**
* Retrieves a map of suggested stream specifications for the given list of use cases.
*
* @param isConcurrentCameraModeOn true if concurrent camera mode is on, otherwise false.
* @param cameraId the camera id of the camera device used by the use cases
* @param existingSurfaces list of surfaces already configured and used by the camera. The
* stream specifications for these surface can not change.
* @param newUseCaseConfigs list of configurations of the use cases that will be given a
* suggested stream specification
* @return map of suggested stream specifications for given use cases
* @throws IllegalStateException if not initialized
* @throws IllegalArgumentException if {@code newUseCaseConfigs} is an empty list, if
* there isn't a supported combination of surfaces
* available, or if the {@code cameraId}
* is not a valid id.
*/
@NonNull
Map<UseCaseConfig<?>, StreamSpec> getSuggestedStreamSpecs(
boolean isConcurrentCameraModeOn,
@NonNull String cameraId,
@NonNull List<AttachedSurfaceInfo> existingSurfaces,
@NonNull List<UseCaseConfig<?>> newUseCaseConfigs);
}