camera/camera-camera2-pipe/src/main/java/androidx/camera/camera2/pipe/compat/Configuration.kt - platform/frameworks/support - Git at Google

 /*
  * Copyright 2021 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.
  */

 @file:RequiresApi(21) // TODO(b/200306659): Remove and replace with annotation on package-info.java

 package androidx.camera.camera2.pipe.compat

 import android.graphics.SurfaceTexture
 import android.hardware.camera2.CaptureRequest
 import android.hardware.camera2.params.OutputConfiguration
 import android.os.Build
 import android.util.Size
 import android.view.Surface
 import android.view.SurfaceHolder
 import androidx.annotation.RequiresApi
 import androidx.camera.camera2.pipe.CameraId
 import androidx.camera.camera2.pipe.OutputStream.OutputType
 import androidx.camera.camera2.pipe.UnsafeWrapper
 import androidx.camera.camera2.pipe.core.checkNOrHigher
 import androidx.camera.camera2.pipe.core.checkOOrHigher
 import androidx.camera.camera2.pipe.core.checkPOrHigher
 import androidx.camera.camera2.pipe.compat.OutputConfigurationWrapper.Companion.SURFACE_GROUP_ID_NONE
 import java.util.concurrent.Executor

 /**
  * A data class that mirrors the fields in [android.hardware.camera2.params.SessionConfiguration] so
  * that a real instance can be constructed when creating a
  * [android.hardware.camera2.CameraCaptureSession] on newer versions of the OS.
  */
 internal data class SessionConfigData(
     val sessionType: Int,
     val inputConfiguration: InputConfigData?,
     val outputConfigurations: List<OutputConfigurationWrapper>,
     val executor: Executor,
     val stateCallback: CameraCaptureSessionWrapper.StateCallback,

     val sessionTemplateId: Int,
     val sessionParameters: Map<CaptureRequest.Key<*>, Any>
 ) {
     companion object {
         /* NOTE: These must keep in sync with their SessionConfiguration values. */
         const val SESSION_TYPE_REGULAR = 0
         const val SESSION_TYPE_HIGH_SPEED = 1
     }
 }

 /**
  * A data class that mirrors the fields in [android.hardware.camera2.params.InputConfiguration] so
  * that a real instance can be constructed when creating a
  * [android.hardware.camera2.CameraCaptureSession] on newer versions of the OS.
  */
 internal data class InputConfigData(
     val width: Int,
     val height: Int,
     val format: Int
 )

 /**
  * An interface for [OutputConfiguration] with minor modifications.
  *
  * The primary modifications to this class are to make it harder to accidentally changes things that
  * cannot be modified after the [android.hardware.camera2.CameraCaptureSession] has been created.
  *
  * [OutputConfiguration]'s are NOT immutable, and changing state of an [OutputConfiguration] may
  * require the CameraCaptureSession to be finalized or updated.
  */
 internal interface OutputConfigurationWrapper : UnsafeWrapper<OutputConfiguration> {
     /**
      * This method will return null if the output configuration was created without a Surface,
      * and until addSurface is called for the first time.
      *
      * @see OutputConfiguration.getSurface
      */
     val surface: Surface?

     /**
      * This method returns the current list of surfaces for this [OutputConfiguration]. Since the
      * [OutputConfiguration] is stateful, this value may change as a result of calling addSurface
      * or removeSurface.
      *
      * @see OutputConfiguration.getSurfaces
      */
     val surfaces: List<Surface>

     /** @see OutputConfiguration.addSurface */
     fun addSurface(surface: Surface)

     /** @see OutputConfiguration.removeSurface */
     fun removeSurface(surface: Surface)

     /** @see OutputConfiguration.setPhysicalCameraId */
     val physicalCameraId: CameraId?

     /** @see OutputConfiguration.enableSurfaceSharing */
     val surfaceSharing: Boolean

     /** @see OutputConfiguration.getMaxSharedSurfaceCount */
     val maxSharedSurfaceCount: Int

     /** @see OutputConfiguration.getSurfaceGroupId */
     val surfaceGroupId: Int

     companion object {
         const val SURFACE_GROUP_ID_NONE = -1
     }
 }

 @RequiresApi(24)
 internal class AndroidOutputConfiguration(
     private val output: OutputConfiguration,
     override val surfaceSharing: Boolean,
     override val maxSharedSurfaceCount: Int,
     override val physicalCameraId: CameraId?
 ) : OutputConfigurationWrapper {

     @RequiresApi(24)
     companion object {
         /**
          * Create and validate an OutputConfiguration for Camera2.
          */
         fun create(
             surface: Surface?,
             outputType: OutputType = OutputType.SURFACE,
             size: Size? = null,
             surfaceSharing: Boolean = false,
             surfaceGroupId: Int = SURFACE_GROUP_ID_NONE,
             physicalCameraId: CameraId? = null
         ): OutputConfigurationWrapper {
             check(Build.VERSION.SDK_INT >= Build.VERSION_CODES.N)

             // Create the OutputConfiguration using the groupId via the constructor (if set)
             val configuration: OutputConfiguration
             if (outputType == OutputType.SURFACE) {
                 check(surface != null) {
                     "OutputConfigurations defined with ${OutputType.SURFACE} must provide a valid" +
                         " surface!"
                 }
                 configuration = if (surfaceGroupId != SURFACE_GROUP_ID_NONE) {
                     OutputConfiguration(surfaceGroupId, surface)
                 } else {
                     OutputConfiguration(surface)
                 }
             } else {
                 if (Build.VERSION.SDK_INT < Build.VERSION_CODES.O) {
                     throw IllegalStateException(
                         "Deferred OutputConfigurations are not supported on API " +
                             "${Build.VERSION.SDK_INT} (requires API ${Build.VERSION_CODES.O})"
                     )
                 }

                 check(size != null) {
                     "Size must defined when creating a deferred OutputConfiguration."
                 }
                 val outputKlass = when (outputType) {
                     OutputType.SURFACE_TEXTURE -> SurfaceTexture::class.java
                     OutputType.SURFACE_VIEW -> SurfaceHolder::class.java
                     OutputType.SURFACE -> throw IllegalStateException(
                         "Unsupported OutputType: $outputType"
                     )
                 }
                 configuration = Api26Compat.newOutputConfiguration(size, outputKlass)
             }

             // Enable surface sharing, if set.
             if (surfaceSharing) {
                 configuration.enableSurfaceSharingCompat()
             }

             // Pass along the physicalCameraId, if set.
             if (physicalCameraId != null) {
                 configuration.setPhysicalCameraIdCompat(physicalCameraId)
             }

             // Create and return the Android
             return AndroidOutputConfiguration(
                 configuration,
                 surfaceSharing,
                 if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
                     Api28Compat.getMaxSharedSurfaceCount(configuration)
                 } else {
                     1
                 },
                 physicalCameraId
             )
         }

         private fun OutputConfiguration.enableSurfaceSharingCompat() {
             checkNOrHigher("surfaceSharing")
             if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
                 Api26Compat.enableSurfaceSharing(this)
             }
         }

         private fun OutputConfiguration.setPhysicalCameraIdCompat(physicalCameraId: CameraId) {
             checkPOrHigher("physicalCameraId")
             if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
                 Api28Compat.setPhysicalCameraId(this, physicalCameraId.value)
             }
         }
     }

     override val surface: Surface? = output.surface
     override val surfaces: List<Surface>
         get() {
             if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
                 return Api26Compat.getSurfaces(output)
             }

             // On older versions of the OS, only one surface is allowed, and if an output
             // configuration is in a deferred state it may not have a surface when it's first
             // created.
             return listOfNotNull(output.surface)
         }

     override fun addSurface(surface: Surface) {
         checkOOrHigher("addSurface")
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
             Api26Compat.addSurfaces(output, surface)
         }
     }

     override fun removeSurface(surface: Surface) {
         checkPOrHigher("removeSurface")
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
             Api28Compat.removeSurface(output, surface)
         }
     }

     override val surfaceGroupId: Int
         get() = output.surfaceGroupId

     override fun unwrap(): OutputConfiguration = output

     override fun toString(): String = output.toString()
 }
	/*
	* Copyright 2021 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.
	*/

	@file:RequiresApi(21) // TODO(b/200306659): Remove and replace with annotation on package-info.java

	package androidx.camera.camera2.pipe.compat

	import android.graphics.SurfaceTexture
	import android.hardware.camera2.CaptureRequest
	import android.hardware.camera2.params.OutputConfiguration
	import android.os.Build
	import android.util.Size
	import android.view.Surface
	import android.view.SurfaceHolder
	import androidx.annotation.RequiresApi
	import androidx.camera.camera2.pipe.CameraId
	import androidx.camera.camera2.pipe.OutputStream.OutputType
	import androidx.camera.camera2.pipe.UnsafeWrapper
	import androidx.camera.camera2.pipe.core.checkNOrHigher
	import androidx.camera.camera2.pipe.core.checkOOrHigher
	import androidx.camera.camera2.pipe.core.checkPOrHigher
	import androidx.camera.camera2.pipe.compat.OutputConfigurationWrapper.Companion.SURFACE_GROUP_ID_NONE
	import java.util.concurrent.Executor

	/**
	* A data class that mirrors the fields in [android.hardware.camera2.params.SessionConfiguration] so
	* that a real instance can be constructed when creating a
	* [android.hardware.camera2.CameraCaptureSession] on newer versions of the OS.
	*/
	internal data class SessionConfigData(
	val sessionType: Int,
	val inputConfiguration: InputConfigData?,
	val outputConfigurations: List<OutputConfigurationWrapper>,
	val executor: Executor,
	val stateCallback: CameraCaptureSessionWrapper.StateCallback,

	val sessionTemplateId: Int,
	val sessionParameters: Map<CaptureRequest.Key<*>, Any>
	) {
	companion object {
	/* NOTE: These must keep in sync with their SessionConfiguration values. */
	const val SESSION_TYPE_REGULAR = 0
	const val SESSION_TYPE_HIGH_SPEED = 1
	}
	}

	/**
	* A data class that mirrors the fields in [android.hardware.camera2.params.InputConfiguration] so
	* that a real instance can be constructed when creating a
	* [android.hardware.camera2.CameraCaptureSession] on newer versions of the OS.
	*/
	internal data class InputConfigData(
	val width: Int,
	val height: Int,
	val format: Int
	)

	/**
	* An interface for [OutputConfiguration] with minor modifications.
	*
	* The primary modifications to this class are to make it harder to accidentally changes things that
	* cannot be modified after the [android.hardware.camera2.CameraCaptureSession] has been created.
	*
	* [OutputConfiguration]'s are NOT immutable, and changing state of an [OutputConfiguration] may
	* require the CameraCaptureSession to be finalized or updated.
	*/
	internal interface OutputConfigurationWrapper : UnsafeWrapper<OutputConfiguration> {
	/**
	* This method will return null if the output configuration was created without a Surface,
	* and until addSurface is called for the first time.
	*
	* @see OutputConfiguration.getSurface
	*/
	val surface: Surface?

	/**
	* This method returns the current list of surfaces for this [OutputConfiguration]. Since the
	* [OutputConfiguration] is stateful, this value may change as a result of calling addSurface
	* or removeSurface.
	*
	* @see OutputConfiguration.getSurfaces
	*/
	val surfaces: List<Surface>

	/** @see OutputConfiguration.addSurface */
	fun addSurface(surface: Surface)

	/** @see OutputConfiguration.removeSurface */
	fun removeSurface(surface: Surface)

	/** @see OutputConfiguration.setPhysicalCameraId */
	val physicalCameraId: CameraId?

	/** @see OutputConfiguration.enableSurfaceSharing */
	val surfaceSharing: Boolean

	/** @see OutputConfiguration.getMaxSharedSurfaceCount */
	val maxSharedSurfaceCount: Int

	/** @see OutputConfiguration.getSurfaceGroupId */
	val surfaceGroupId: Int

	companion object {
	const val SURFACE_GROUP_ID_NONE = -1
	}
	}

	@RequiresApi(24)
	internal class AndroidOutputConfiguration(
	private val output: OutputConfiguration,
	override val surfaceSharing: Boolean,
	override val maxSharedSurfaceCount: Int,
	override val physicalCameraId: CameraId?
	) : OutputConfigurationWrapper {

	@RequiresApi(24)
	companion object {
	/**
	* Create and validate an OutputConfiguration for Camera2.
	*/
	fun create(
	surface: Surface?,
	outputType: OutputType = OutputType.SURFACE,
	size: Size? = null,
	surfaceSharing: Boolean = false,
	surfaceGroupId: Int = SURFACE_GROUP_ID_NONE,
	physicalCameraId: CameraId? = null
	): OutputConfigurationWrapper {
	check(Build.VERSION.SDK_INT >= Build.VERSION_CODES.N)

	// Create the OutputConfiguration using the groupId via the constructor (if set)
	val configuration: OutputConfiguration
	if (outputType == OutputType.SURFACE) {
	check(surface != null) {
	"OutputConfigurations defined with ${OutputType.SURFACE} must provide a valid" +
	" surface!"
	}
	configuration = if (surfaceGroupId != SURFACE_GROUP_ID_NONE) {
	OutputConfiguration(surfaceGroupId, surface)
	} else {
	OutputConfiguration(surface)
	}
	} else {
	if (Build.VERSION.SDK_INT < Build.VERSION_CODES.O) {
	throw IllegalStateException(
	"Deferred OutputConfigurations are not supported on API " +
	"${Build.VERSION.SDK_INT} (requires API ${Build.VERSION_CODES.O})"
	)
	}

	check(size != null) {
	"Size must defined when creating a deferred OutputConfiguration."
	}
	val outputKlass = when (outputType) {
	OutputType.SURFACE_TEXTURE -> SurfaceTexture::class.java
	OutputType.SURFACE_VIEW -> SurfaceHolder::class.java
	OutputType.SURFACE -> throw IllegalStateException(
	"Unsupported OutputType: $outputType"
	)
	}
	configuration = Api26Compat.newOutputConfiguration(size, outputKlass)
	}

	// Enable surface sharing, if set.
	if (surfaceSharing) {
	configuration.enableSurfaceSharingCompat()
	}

	// Pass along the physicalCameraId, if set.
	if (physicalCameraId != null) {
	configuration.setPhysicalCameraIdCompat(physicalCameraId)
	}

	// Create and return the Android
	return AndroidOutputConfiguration(
	configuration,
	surfaceSharing,
	if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
	Api28Compat.getMaxSharedSurfaceCount(configuration)
	} else {
	1
	},
	physicalCameraId
	)
	}

	private fun OutputConfiguration.enableSurfaceSharingCompat() {
	checkNOrHigher("surfaceSharing")
	if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
	Api26Compat.enableSurfaceSharing(this)
	}
	}

	private fun OutputConfiguration.setPhysicalCameraIdCompat(physicalCameraId: CameraId) {
	checkPOrHigher("physicalCameraId")
	if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
	Api28Compat.setPhysicalCameraId(this, physicalCameraId.value)
	}
	}
	}

	override val surface: Surface? = output.surface
	override val surfaces: List<Surface>
	get() {
	if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
	return Api26Compat.getSurfaces(output)
	}

	// On older versions of the OS, only one surface is allowed, and if an output
	// configuration is in a deferred state it may not have a surface when it's first
	// created.
	return listOfNotNull(output.surface)
	}

	override fun addSurface(surface: Surface) {
	checkOOrHigher("addSurface")
	if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
	Api26Compat.addSurfaces(output, surface)
	}
	}

	override fun removeSurface(surface: Surface) {
	checkPOrHigher("removeSurface")
	if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
	Api28Compat.removeSurface(output, surface)
	}
	}

	override val surfaceGroupId: Int
	get() = output.surfaceGroupId

	override fun unwrap(): OutputConfiguration = output

	override fun toString(): String = output.toString()
	}