Architettura di CameraX

Questa pagina illustra l'architettura di CameraX, inclusa la struttura, come utilizzare l'API, come gestire i cicli di vita e come combinare i casi d'uso.

Struttura CameraX

Puoi utilizzare CameraX per interfacciarti con la fotocamera di un dispositivo tramite un'astrazione chiamata caso d'uso. Sono disponibili i seguenti casi d'uso:

  • Anteprima: accetta una superficie per la visualizzazione di un'anteprima, ad esempio un PreviewView.
  • Analisi delle immagini: fornisce buffer accessibili alla CPU per l'analisi, ad esempio per il machine learning.
  • Acquisizione immagine: acquisisce e salva una foto.
  • Acquisizione video: acquisisci video e audio con VideoCapture

I casi d'uso possono essere combinati e attivi contemporaneamente. Ad esempio, un'app può consentire all'utente di visualizzare l'immagine inquadrata dalla videocamera utilizzando un caso d'uso di anteprima, avere un caso d'uso di analisi delle immagini che determina se le persone ritratte nella foto sorride e includere un caso d'uso di acquisizione di immagini per scattare una foto quando lo sono.

Modello API

Per lavorare con la libreria, specifica quanto segue:

  • Il caso d'uso desiderato con le opzioni di configurazione.
  • Cosa fare con i dati di output collegando i listener.
  • Il flusso previsto, ad esempio quando attivare le videocamere e quando produrre dati, legando il caso d'uso ai ciclo di vita dell'architettura Android.

Esistono due modi per scrivere un'app CameraX: un'app CameraController (ideale se vuoi utilizzare CameraX nel modo più semplice) o un'app CameraProvider (ideale se hai bisogno di maggiore flessibilità).

Controller videocamera

Un CameraController fornisce la maggior parte delle funzionalità di base di CameraX in una singola classe. Richiede poco codice di configurazione e gestisce automaticamente l'inizializzazione della fotocamera, la gestione dei casi d'uso, la rotazione del target, il tocco per mettere a fuoco, la compressione per aumentare lo zoom e altro ancora. La classe concreta che estende CameraController è LifecycleCameraController.

Kotlin

val previewView: PreviewView = viewBinding.previewView
var cameraController = LifecycleCameraController(baseContext)
cameraController.bindToLifecycle(this)
cameraController.cameraSelector = CameraSelector.DEFAULT_BACK_CAMERA
previewView.controller = cameraController

Java

PreviewView previewView = viewBinding.previewView;
LifecycleCameraController cameraController = new LifecycleCameraController(baseContext);
cameraController.bindToLifecycle(this);
cameraController.setCameraSelector(CameraSelector.DEFAULT_BACK_CAMERA);
previewView.setController(cameraController);

I valori UseCase predefiniti per CameraController sono Preview, ImageCapture e ImageAnalysis. Per disattivare ImageCapture o ImageAnalysis, oppure per attivare VideoCapture, utilizza il metodo setEnabledUseCases().

Per altri utilizzi di CameraController, consulta l'esempio di scanner codici QR o il video sulle nozioni di base di CameraController.

CameraProvider

Un CameraProvider è comunque facile da usare, ma poiché la configurazione è gestita maggiormente dallo sviluppatore dell'app, ci sono più opportunità per personalizzare la configurazione, ad esempio attivare la rotazione delle immagini di output o impostare il formato dell'immagine di output in ImageAnalysis. Puoi anche utilizzare un Surface personalizzato per l'anteprima della fotocamera, che consente una maggiore flessibilità, mentre con CameraController devi utilizzare un PreviewView. L'utilizzo del codice Surface esistente potrebbe essere utile se è già un input per altre parti della tua app.

Configura i casi d'uso utilizzando i metodi set() e finalizzali con il metodo build(). Ogni oggetto caso d'uso fornisce un insieme di API specifiche per il caso d'uso. Ad esempio, il caso d'uso di acquisizione di immagini fornisce una chiamata al metodo takePicture().

Anziché inserire chiamate ai metodi di avvio e arresto specifici in onResume() e onPause(), l'applicazione specifica un ciclo di vita da associare alla videocamera utilizzando cameraProvider.bindToLifecycle(). Questo ciclo di vita informa CameraX quando configurare la sessione di acquisizione della fotocamera e garantisce che lo stato della fotocamera cambi in modo appropriato in base alle transizioni del ciclo di vita.

Per la procedura di implementazione di ciascun caso d'uso, consulta Implementare un'anteprima, Analizzare le immagini, Acquisizione di immagini e Acquisizione di video

Il caso d'uso di anteprima interagisce con un Surface per la visualizzazione. Le applicazioni creano il caso d'uso con le opzioni di configurazione utilizzando il seguente codice:

Kotlin

val preview = Preview.Builder().build()
val viewFinder: PreviewView = findViewById(R.id.previewView)

// The use case is bound to an Android Lifecycle with the following code
val camera = cameraProvider.bindToLifecycle(lifecycleOwner, cameraSelector, preview)

// PreviewView creates a surface provider and is the recommended provider
preview.setSurfaceProvider(viewFinder.getSurfaceProvider())

Java

Preview preview = new Preview.Builder().build();
PreviewView viewFinder = findViewById(R.id.view_finder);

// The use case is bound to an Android Lifecycle with the following code
Camera camera = cameraProvider.bindToLifecycle(lifecycleOwner, cameraSelector, preview);

// PreviewView creates a surface provider, using a Surface from a different
// kind of view will require you to implement your own surface provider.
preview.previewSurfaceProvider = viewFinder.getSurfaceProvider();

Per altri esempi di codice, consulta l'app di esempio CameraX.

Cicli di vita di CameraX

CameraX osserva un ciclo di vita per determinare quando aprire la fotocamera, quando creare una sessione di acquisizione e quando interrompere e arrestare il sistema. Le API dei casi d'uso forniscono chiamate di metodo e callback per monitorare l'avanzamento.

Come spiegato in Combinare casi d'uso, puoi associare alcune combinazioni di casi d'uso a un singolo ciclo di vita. Se la tua app deve supportare casi d'uso che non possono essere combinati, puoi:

  • Raggruppa i casi d'uso compatibili in più di un frammento e poi passa da un frammento all'altro
  • Creare un componente personalizzato del ciclo di vita e utilizzarlo per controllare manualmente il ciclo di vita della fotocamera

Se scolleghi i proprietari del ciclo di vita dei casi d'uso della visualizzazione e della fotocamera (ad esempio, se utilizzi un ciclo di vita personalizzato o un fragment retain), devi assicurarti che tutti i casi d'uso siano sganciati da CameraX utilizzando ProcessCameraProvider.unbindAll() o sganciando ogni caso d'uso singolarmente. In alternativa, quando colleghi i casi d'uso a un ciclo di vita, puoi lasciare che CameraX gestisca l'apertura e la chiusura della sessione di acquisizione e la scollegamento dei casi d'uso.

Se tutte le funzionalità della videocamera corrispondono al ciclo di vita di un singolo componente sensibile al ciclo di vita, ad esempio un frammento AppCompatActivity o AppCompat, l'utilizzo del ciclo di vita di quel componente quando si associano tutti i casi d'uso desiderati garantirà che la funzionalità della fotocamera sia pronta quando il componente sensibile al ciclo di vita è attivo e smaltito in modo sicuro, senza consumare alcuna risorsa.

LifecycleOwner personalizzati

Per i casi avanzati, puoi creare un LifecycleOwner personalizzato per consentire alla tua app di controllare esplicitamente il ciclo di vita della sessione CameraX anziché legarlo a un LifecycleOwner Android standard.

Il seguente esempio di codice mostra come creare un LifecycleOwner personalizzato semplice:

Kotlin

class CustomLifecycle : LifecycleOwner {
    private val lifecycleRegistry: LifecycleRegistry

    init {
        lifecycleRegistry = LifecycleRegistry(this);
        lifecycleRegistry.markState(Lifecycle.State.CREATED)
    }
    ...
    fun doOnResume() {
        lifecycleRegistry.markState(State.RESUMED)
    }
    ...
    override fun getLifecycle(): Lifecycle {
        return lifecycleRegistry
    }
}

Java

public class CustomLifecycle implements LifecycleOwner {
    private LifecycleRegistry lifecycleRegistry;
    public CustomLifecycle() {
        lifecycleRegistry = new LifecycleRegistry(this);
        lifecycleRegistry.markState(Lifecycle.State.CREATED);
    }
   ...
   public void doOnResume() {
        lifecycleRegistry.markState(State.RESUMED);
    }
   ...
    public Lifecycle getLifecycle() {
        return lifecycleRegistry;
    }
}

Con questo LifecycleOwner, l'app può inserire le transizioni di stato nei punti voluti nel codice. Per scoprire di più sull'implementazione di questa funzionalità nella tua app, consulta Implementazione di un LifecycleOwner personalizzato.

Casi d'uso simultanei

I casi d'uso possono essere eseguiti contemporaneamente. Sebbene i casi d'uso possano essere associati in sequenza a un ciclo di vita, è meglio associarli tutti con una singola chiamata a CameraProcessProvider.bindToLifecycle(). Per ulteriori informazioni sulle best practice per le modifiche alla configurazione, consulta Gestire le modifiche alla configurazione.

Nel seguente esempio di codice, l'app specifica i due casi d'uso da creare ed eseguire contemporaneamente. Specifica anche il ciclo di vita da utilizzare per entrambi i casi d'uso, in modo che entrambi vengano avviati e arrestati in base al ciclo di vita.

Kotlin

private lateinit var imageCapture: ImageCapture

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)

    val cameraProviderFuture = ProcessCameraProvider.getInstance(this)

    cameraProviderFuture.addListener(Runnable {
        // Camera provider is now guaranteed to be available
        val cameraProvider = cameraProviderFuture.get()

        // Set up the preview use case to display camera preview.
        val preview = Preview.Builder().build()

        // Set up the capture use case to allow users to take photos.
        imageCapture = ImageCapture.Builder()
                .setCaptureMode(ImageCapture.CAPTURE_MODE_MINIMIZE_LATENCY)
                .build()

        // Choose the camera by requiring a lens facing
        val cameraSelector = CameraSelector.Builder()
                .requireLensFacing(CameraSelector.LENS_FACING_FRONT)
                .build()

        // Attach use cases to the camera with the same lifecycle owner
        val camera = cameraProvider.bindToLifecycle(
                this as LifecycleOwner, cameraSelector, preview, imageCapture)

        // Connect the preview use case to the previewView
        preview.setSurfaceProvider(
                previewView.getSurfaceProvider())
    }, ContextCompat.getMainExecutor(this))
}

Java

private ImageCapture imageCapture;

@Override
public void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    PreviewView previewView = findViewById(R.id.previewView);

    ListenableFuture<ProcessCameraProvider> cameraProviderFuture =
            ProcessCameraProvider.getInstance(this);

    cameraProviderFuture.addListener(() -> {
        try {
            // Camera provider is now guaranteed to be available
            ProcessCameraProvider cameraProvider = cameraProviderFuture.get();

            // Set up the view finder use case to display camera preview
            Preview preview = new Preview.Builder().build();

            // Set up the capture use case to allow users to take photos
            imageCapture = new ImageCapture.Builder()
                    .setCaptureMode(ImageCapture.CAPTURE_MODE_MINIMIZE_LATENCY)
                    .build();

            // Choose the camera by requiring a lens facing
            CameraSelector cameraSelector = new CameraSelector.Builder()
                    .requireLensFacing(lensFacing)
                    .build();

            // Attach use cases to the camera with the same lifecycle owner
            Camera camera = cameraProvider.bindToLifecycle(
                    ((LifecycleOwner) this),
                    cameraSelector,
                    preview,
                    imageCapture);

            // Connect the preview use case to the previewView
            preview.setSurfaceProvider(
                    previewView.getSurfaceProvider());
        } catch (InterruptedException | ExecutionException e) {
            // Currently no exceptions thrown. cameraProviderFuture.get()
            // shouldn't block since the listener is being called, so no need to
            // handle InterruptedException.
        }
    }, ContextCompat.getMainExecutor(this));
}

CameraX consente l'uso simultaneo di un'istanza, ciascuna delle opzioni Preview, VideoCapture, ImageAnalysis e ImageCapture. Inoltre,

  • Ogni caso d'uso può funzionare da solo. Ad esempio, un'app può registrare video senza utilizzare l'anteprima.
  • Quando le estensioni sono attivate, solo la combinazione ImageCapture e Preview funziona. A seconda dell'implementazione dell'OEM, potrebbe non essere possibile aggiungere anche ImageAnalysis; le estensioni non possono essere attivate per il caso d'uso VideoCapture. Per maggiori dettagli, consulta la documentazione di riferimento delle estensioni.
  • A seconda delle funzionalità della videocamera, alcune potrebbero supportare la combinazione a modalità di risoluzione inferiori, ma non la stessa combinazione a alcune risoluzioni superiori.
  • Sui dispositivi con livello hardware della fotocamera FULL o precedente, la combinazione di Preview, VideoCapture e ImageCapture o ImageAnalysis potrebbe costringere CameraX a duplicare lo stream PRIV della fotocamera per Preview e VideoCapture. Questa duplicazione, chiamata condivisione dello stream, consente l'utilizzo simultaneo di queste funzionalità, ma comporta un aumento delle richieste di elaborazione. Di conseguenza, potresti riscontrare una latenza leggermente superiore e una durata della batteria ridotta.

Il livello hardware supportato puoi essere recuperato da Camera2CameraInfo. Ad esempio, il seguente codice verifica se la fotocamera posteriore predefinita è un dispositivo LEVEL_3:

Kotlin

@androidx.annotation.OptIn(ExperimentalCamera2Interop::class)
fun isBackCameraLevel3Device(cameraProvider: ProcessCameraProvider) : Boolean {
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
        return CameraSelector.DEFAULT_BACK_CAMERA
            .filter(cameraProvider.availableCameraInfos)
            .firstOrNull()
            ?.let { Camera2CameraInfo.from(it) }
            ?.getCameraCharacteristic(CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL) ==
            CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_3
    }
    return false
}

Java

@androidx.annotation.OptIn(markerClass = ExperimentalCamera2Interop.class)
Boolean isBackCameraLevel3Device(ProcessCameraProvider cameraProvider) {
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
        List\<CameraInfo\> filteredCameraInfos = CameraSelector.DEFAULT_BACK_CAMERA
                .filter(cameraProvider.getAvailableCameraInfos());
        if (!filteredCameraInfos.isEmpty()) {
            return Objects.equals(
                Camera2CameraInfo.from(filteredCameraInfos.get(0)).getCameraCharacteristic(
                        CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL),
                CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_3);
        }
    }
    return false;
}

Autorizzazioni

La tua app avrà bisogno dell'autorizzazione CAMERA. Per salvare le immagini in file, è necessaria anche l'autorizzazione WRITE_EXTERNAL_STORAGE, tranne sui dispositivi con Android 10 o versioni successive.

Per ulteriori informazioni sulla configurazione delle autorizzazioni per la tua app, vedi Richiedere autorizzazioni app.

Requisiti

CameraX ha i seguenti requisiti minimi di versione:

  • Livello API Android 21
  • Componenti dell'architettura Android 1.1.1

Per le attività che tengono conto del ciclo di vita, utilizza FragmentActivity o AppCompatActivity.

Dichiarare le dipendenze

Per aggiungere una dipendenza da CameraX, devi aggiungere il repository Maven di Google al tuo progetto.

Apri il file settings.gradle del tuo progetto e aggiungi il repository google() come mostrato di seguito:

Alla moda

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
    }
}

Kotlin

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
    }
}

Aggiungi quanto segue alla fine del blocco Android:

Groovy

android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
    // For Kotlin projects
    kotlinOptions {
        jvmTarget = "1.8"
    }
}

Kotlin

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }
    // For Kotlin projects
    kotlinOptions {
        jvmTarget = "1.8"
    }
}

Aggiungi quanto segue al file build.gradle di ogni modulo per un'app:

Groovy

dependencies {
  // CameraX core library using the camera2 implementation
  def camerax_version = "1.5.0-alpha03"
  // The following line is optional, as the core library is included indirectly by camera-camera2
  implementation "androidx.camera:camera-core:${camerax_version}"
  implementation "androidx.camera:camera-camera2:${camerax_version}"
  // If you want to additionally use the CameraX Lifecycle library
  implementation "androidx.camera:camera-lifecycle:${camerax_version}"
  // If you want to additionally use the CameraX VideoCapture library
  implementation "androidx.camera:camera-video:${camerax_version}"
  // If you want to additionally use the CameraX View class
  implementation "androidx.camera:camera-view:${camerax_version}"
  // If you want to additionally add CameraX ML Kit Vision Integration
  implementation "androidx.camera:camera-mlkit-vision:${camerax_version}"
  // If you want to additionally use the CameraX Extensions library
  implementation "androidx.camera:camera-extensions:${camerax_version}"
}

Kotlin

dependencies {
    // CameraX core library using the camera2 implementation
    val camerax_version = "1.5.0-alpha03"
    // The following line is optional, as the core library is included indirectly by camera-camera2
    implementation("androidx.camera:camera-core:${camerax_version}")
    implementation("androidx.camera:camera-camera2:${camerax_version}")
    // If you want to additionally use the CameraX Lifecycle library
    implementation("androidx.camera:camera-lifecycle:${camerax_version}")
    // If you want to additionally use the CameraX VideoCapture library
    implementation("androidx.camera:camera-video:${camerax_version}")
    // If you want to additionally use the CameraX View class
    implementation("androidx.camera:camera-view:${camerax_version}")
    // If you want to additionally add CameraX ML Kit Vision Integration
    implementation("androidx.camera:camera-mlkit-vision:${camerax_version}")
    // If you want to additionally use the CameraX Extensions library
    implementation("androidx.camera:camera-extensions:${camerax_version}")
}

Per ulteriori informazioni su come configurare l'app in modo che sia conforme a questi requisiti, consulta la sezione Dichiarare le dipendenze.

Interoperabilità di CameraX con Camera2

CameraX è basato su Camera2 e mette a disposizione metodi per leggere e persino scrivere proprietà nell'implementazione di Camera2. Per i dettagli completi, consulta il pacchetto Interop.

Per ulteriori informazioni su come CameraX ha configurato le proprietà Camera2, utilizza Camera2CameraInfo per leggere CameraCharacteristics sottostante. Puoi anche scegliere di scrivere le proprietà Camera2 di base in uno dei seguenti due percorsi:

Il seguente esempio di codice utilizza i casi d'uso di streaming per l'ottimizzazione per una videochiamata. Utilizza Camera2CameraInfo per verificare se il caso d'uso dello stream di videochiamate è disponibile. Quindi, utilizza un Camera2Interop.Extender per impostare il caso d'uso dello stream sottostante.

Kotlin

// Set underlying Camera2 stream use case to optimize for video calls.

val videoCallStreamId =
    CameraMetadata.SCALER_AVAILABLE_STREAM_USE_CASES_VIDEO_CALL.toLong()

// Check available CameraInfos to find the first one that supports
// the video call stream use case.
val frontCameraInfo = cameraProvider.getAvailableCameraInfos()
    .first { cameraInfo ->
        val isVideoCallStreamingSupported = Camera2CameraInfo.from(cameraInfo)
            .getCameraCharacteristic(
                CameraCharacteristics.SCALER_AVAILABLE_STREAM_USE_CASES
            )?.contains(videoCallStreamId)
        val isFrontFacing = (cameraInfo.getLensFacing() == 
                             CameraSelector.LENS_FACING_FRONT)
        (isVideoCallStreamingSupported == true) && isFrontFacing
    }

val cameraSelector = frontCameraInfo.cameraSelector

// Start with a Preview Builder.
val previewBuilder = Preview.Builder()
    .setTargetAspectRatio(screenAspectRatio)
    .setTargetRotation(rotation)

// Use Camera2Interop.Extender to set the video call stream use case.
Camera2Interop.Extender(previewBuilder).setStreamUseCase(videoCallStreamId)

// Bind the Preview UseCase and the corresponding CameraSelector.
val preview = previewBuilder.build()
camera = cameraProvider.bindToLifecycle(this, cameraSelector, preview)

Java

// Set underlying Camera2 stream use case to optimize for video calls.

Long videoCallStreamId =
    CameraMetadata.SCALER_AVAILABLE_STREAM_USE_CASES_VIDEO_CALL.toLong();

// Check available CameraInfos to find the first one that supports
// the video call stream use case.
List<CameraInfo> cameraInfos = cameraProvider.getAvailableCameraInfos();
CameraInfo frontCameraInfo = null;
for (cameraInfo in cameraInfos) {
    Long[] availableStreamUseCases = Camera2CameraInfo.from(cameraInfo)
        .getCameraCharacteristic(
            CameraCharacteristics.SCALER_AVAILABLE_STREAM_USE_CASES
        );
    boolean isVideoCallStreamingSupported = Arrays.List(availableStreamUseCases)
                .contains(videoCallStreamId);
    boolean isFrontFacing = (cameraInfo.getLensFacing() ==
                             CameraSelector.LENS_FACING_FRONT);

    if (isVideoCallStreamingSupported && isFrontFacing) {
        frontCameraInfo = cameraInfo;
    }
}

if (frontCameraInfo == null) {
    // Handle case where video call streaming is not supported.
}

CameraSelector cameraSelector = frontCameraInfo.getCameraSelector();

// Start with a Preview Builder.
Preview.Builder previewBuilder = Preview.Builder()
    .setTargetAspectRatio(screenAspectRatio)
    .setTargetRotation(rotation);

// Use Camera2Interop.Extender to set the video call stream use case.
Camera2Interop.Extender(previewBuilder).setStreamUseCase(videoCallStreamId);

// Bind the Preview UseCase and the corresponding CameraSelector.
Preview preview = previewBuilder.build()
Camera camera = cameraProvider.bindToLifecycle(this, cameraSelector, preview)

Risorse aggiuntive

Per scoprire di più su CameraX, consulta le seguenti risorse aggiuntive.

Codelab

  • Introduzione a CameraX

    • Esempio di codice

  • Esempi di app CameraX

    •