[libcamera-devel,RFCv2,1/2] libcamera: camera_sensor: Define CameraSensorInfo

3356 diff mbox series

Define the CameraSensorInfo structure that reports the current image sensor
configuration.

Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
---
 src/libcamera/camera_sensor.cpp       | 106 ++++++++++++++++++++++++++
 src/libcamera/include/camera_sensor.h |  19 +++++
 2 files changed, 125 insertions(+)

Hi Jacopo,

Thanks for your work.

Over all I like what I see in this patch and I agree with the todo 
items, nice work.

On 2020-03-27 12:31:51 +0100, Jacopo Mondi wrote:
> Define the CameraSensorInfo structure that reports the current image sensor
> configuration.
> 
> Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
> ---
>  src/libcamera/camera_sensor.cpp       | 106 ++++++++++++++++++++++++++
>  src/libcamera/include/camera_sensor.h |  19 +++++
>  2 files changed, 125 insertions(+)
> 
> diff --git a/src/libcamera/camera_sensor.cpp b/src/libcamera/camera_sensor.cpp
> index 09771fc40bbb..df1d82d29f74 100644
> --- a/src/libcamera/camera_sensor.cpp
> +++ b/src/libcamera/camera_sensor.cpp
> @@ -30,6 +30,112 @@ namespace libcamera {
>  
>  LOG_DEFINE_CATEGORY(CameraSensor);
>  
> +/**
> + * \struct CameraSensorInfo
> + * \brief Report the image sensor characteristics
> + *
> + * The structure reports image sensor characteristics used by IPA modules to
> + * tune their algorithms based on the image sensor model currently in use and
> + * its configuration.
> + *
> + * The here reported information describe the sensor's intrinsics
> + * characteristics, such as its pixel array size and the sensor model name,
> + * as well as information relative to the currently configured mode, such as
> + * the produced image size and the bit depth of the requested image format.
> + *
> + * Instances of this structure are meant to be assembled by the CameraSensor
> + * class and its specialized subclasses by inspecting the sensor static
> + * properties as well as the currently configured sensor mode.
> + */
> +
> +/**
> + * \var CameraSensorInfo::name
> + * \brief The image sensor name
> + */
> +
> +/**
> + * \var CameraSensorInfo::bitsPerPixel
> + * \brief The bits per-pixel of the image format produced by the image sensor
> + */
> +
> +/**
> + * \var CameraSensorInfo::activeAreaSize
> + * \brief The size of the active pixel array area of the sensor
> + *
> + * \todo Reference the corresponding property
> + */
> +
> +/**
> + * \var CameraSensorInfo::analogCrop
> + * \brief The portion of the pixel array active area which is read-out and
> + * processed
> + *
> + * The analog crop rectangle top-left corner is defined as the displacement from
> + * from the top-left corner of the pixel array active area. The rectangle
> + * horizontal and vertical sizes define the portion of the pixel matrix which
> + * is read-out and provided to the sensor's on-board ISP before any analog
> + * processing takes place.
> + */
> +
> +/**
> + * \var CameraSensorInfo::outputSize
> + * \brief The size of the images produced by the camera sensor
> + *
> + * The output image size defines the horizontal and vertical sizes of the images
> + * produced by the image sensor. The final output image size is defined as the
> + * end result of the sensor's on-board ISP pipeline processing stages, applied
> + * on the pixel array matrix analog crop rectangle. Each ISP processing stage
> + * that applies pixel sub-sampling techniques, such as pixel binning or
> + * skipping, or perform additional digital cropping concur in the definition
> + * of the final output image size.
> + */
> +
> +/**
> + * \var CameraSensorInfo::horizontalBinning
> + * \brief The binning factor, in the horizontal direction, of the image sensor
> + * configuration
> + *
> + * \todo Remove this field and compute the binning factor in the IPA
> + */
> +
> +/**
> + * \var CameraSensorInfo::verticalBinning
> + * \brief The binning factor, in the vertical direction, of the image sensor
> + * configuration
> + *
> + * \todo Remove this field and compute the binning factor in the IPA
> + */
> +
> +/**
> + * \var CameraSensorInfo::horizontalScaling
> + * \brief The horizontal scaling factor, calculated as the ratio between
> + * the active pixel array horizontal size and the horizontal size of the
> + * output image
> + *
> + * \todo Remove this field and compute the scaling factor in the IPA
> + */
> +
> +/**
> + * \var CameraSensorInfo::verticalScaling
> + * \brief The vertical scaling factor, calculated as the ratio between
> + * the active pixel array vertical size and the vertical size of the
> + * output image
> + *
> + * \todo Remove this field and compute the scaling factor in the IPA
> + */
> +
> +/**
> + * \var CameraSensorInfo::noiseFactor
> + * \brief Scaling of the noise compared to the native sensor mode
> + *
> + * \todo Improve this description
> + */
> +
> +/**
> + * \var CameraSensorInfo::lineDuration
> + * \brief Line scan-out duration in nanoseconds
> + */
> +
>  /**
>   * \class CameraSensor
>   * \brief A camera sensor based on V4L2 subdevices
> diff --git a/src/libcamera/include/camera_sensor.h b/src/libcamera/include/camera_sensor.h
> index 6e4d2b0118bc..acc6022cf0e8 100644
> --- a/src/libcamera/include/camera_sensor.h
> +++ b/src/libcamera/include/camera_sensor.h
> @@ -24,6 +24,25 @@ class V4L2Subdevice;
>  
>  struct V4L2SubdeviceFormat;
>  
> +struct CameraSensorInfo {
> +	std::string name;
> +
> +	uint32_t bitsPerPixel;
> +
> +	Size activeAreaSize;
> +	Rectangle analogCrop;
> +	Size outputSize;
> +
> +	uint8_t horizontalBinning;
> +	uint8_t verticalBinning;
> +	double horizontalScaling;
> +	double verticalScaling;
> +
> +	double noiseFactor;
> +
> +	double lineDuration;
> +};
> +
>  class CameraSensor : protected Loggable
>  {
>  public:
> -- 
> 2.25.1
> 
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel