From 212417bfe17b81ca0e4ad4a9d1730f24a7770734 Mon Sep 17 00:00:00 2001 From: Jacopo Mondi Date: Sat, 10 Oct 2020 11:47:52 +0200 Subject: android: camera_stream: Add documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add a brief documentation block to the CameraStream class. Reviewed-by: Niklas Söderlund Reviewed-by: Laurent Pinchart Signed-off-by: Jacopo Mondi --- src/android/camera_stream.cpp | 21 +++++++++++++++++++++ src/android/camera_stream.h | 5 ----- 2 files changed, 21 insertions(+), 5 deletions(-) (limited to 'src/android') diff --git a/src/android/camera_stream.cpp b/src/android/camera_stream.cpp index eac14805..d8e45c2a 100644 --- a/src/android/camera_stream.cpp +++ b/src/android/camera_stream.cpp @@ -17,6 +17,27 @@ using namespace libcamera; LOG_DECLARE_CATEGORY(HAL); +/* + * \class CameraStream + * \brief Map a camera3_stream_t to a StreamConfiguration + * + * The CameraStream class maps a camera3_stream_t provided by Android + * camera framework to a libcamera::StreamConfiguration. + * + * The StreamConfiguration is represented by its index as recorded in the + * CameraConfiguration and not by pointer as StreamConfiguration is subject to + * relocation. + * + * A single StreamConfiguration may be used to deliver one or more streams to + * the Android framework. The mapping type between a camera3 stream to a + * StreamConfiguration is described by the CameraStream::Type. + * + * CameraStream handles all the aspects of producing a stream with the size + * and format requested by the camera3 stream from the data produced by + * the associated libcamera::Stream, including the creation of the encoder + * and buffer allocation. + */ + CameraStream::CameraStream(CameraDevice *cameraDevice, Type type, camera3_stream_t *camera3Stream, unsigned int index) : cameraDevice_(cameraDevice), type_(type), diff --git a/src/android/camera_stream.h b/src/android/camera_stream.h index 8df0101c..47f3fc61 100644 --- a/src/android/camera_stream.h +++ b/src/android/camera_stream.h @@ -128,11 +128,6 @@ private: libcamera::CameraConfiguration *config_; Type type_; camera3_stream_t *camera3Stream_; - /* - * The index of the libcamera StreamConfiguration as added during - * configureStreams(). A single libcamera Stream may be used to deliver - * one or more streams to the Android framework. - */ unsigned int index_; std::unique_ptr encoder_; -- cgit v1.2.1