From 6a31a8d8e2742990f3b3a3dbf5157a9e1cb835ea Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Mon, 28 Jun 2021 01:54:17 +0300 Subject: libcamera: buffer: Rename buffer.h to framebuffer.h libcamera names header files based on the classes they define. The buffer.h file is an exception. Rename it to framebuffer.h. Signed-off-by: Laurent Pinchart Reviewed-by: Umang Jain Reviewed-by: Jacopo Mondi Reviewed-by: Hirokazu Honda Reviewed-by: Kieran Bingham --- include/libcamera/buffer.h | 74 ---- include/libcamera/framebuffer.h | 74 ++++ include/libcamera/internal/buffer.h | 52 --- include/libcamera/internal/framebuffer.h | 52 +++ include/libcamera/internal/ipa_data_serializer.h | 2 +- include/libcamera/internal/meson.build | 2 +- include/libcamera/internal/tracepoints/request.tp | 2 +- include/libcamera/internal/v4l2_videodevice.h | 2 +- include/libcamera/ipa/ipa_interface.h | 2 +- include/libcamera/meson.build | 2 +- include/libcamera/stream.h | 2 +- src/android/camera_device.h | 4 +- src/android/camera_stream.h | 4 +- src/android/camera_worker.h | 2 +- src/android/jpeg/encoder.h | 2 +- src/android/jpeg/encoder_libjpeg.h | 2 +- src/android/jpeg/post_processor_jpeg.h | 2 +- src/android/jpeg/thumbnailer.h | 2 +- src/android/mm/generic_camera_buffer.cpp | 2 +- src/android/post_processor.h | 4 +- src/cam/buffer_writer.h | 2 +- src/cam/capture.h | 2 +- src/ipa/ipu3/ipu3.cpp | 4 +- src/ipa/raspberrypi/raspberrypi.cpp | 4 +- src/ipa/rkisp1/rkisp1.cpp | 2 +- src/libcamera/buffer.cpp | 383 --------------------- src/libcamera/framebuffer.cpp | 383 +++++++++++++++++++++ src/libcamera/framebuffer_allocator.cpp | 2 +- src/libcamera/meson.build | 2 +- src/libcamera/pipeline/ipu3/frames.cpp | 2 +- src/libcamera/pipeline/raspberrypi/raspberrypi.cpp | 2 +- src/libcamera/pipeline/rkisp1/rkisp1.cpp | 2 +- src/libcamera/pipeline/simple/converter.cpp | 2 +- src/libcamera/pipeline_handler.cpp | 2 +- src/libcamera/request.cpp | 2 +- src/qcam/dng_writer.h | 2 +- src/qcam/main_window.h | 2 +- src/qcam/viewfinder.h | 2 +- src/qcam/viewfinder_gl.h | 2 +- src/qcam/viewfinder_qt.h | 2 +- src/v4l2/v4l2_camera.h | 2 +- test/mapped-buffer.cpp | 2 +- test/v4l2_subdevice/v4l2_subdevice_test.h | 2 +- test/v4l2_videodevice/buffer_sharing.cpp | 2 +- test/v4l2_videodevice/capture_async.cpp | 2 +- test/v4l2_videodevice/v4l2_m2mdevice.cpp | 2 +- test/v4l2_videodevice/v4l2_videodevice_test.h | 2 +- 47 files changed, 555 insertions(+), 555 deletions(-) delete mode 100644 include/libcamera/buffer.h create mode 100644 include/libcamera/framebuffer.h delete mode 100644 include/libcamera/internal/buffer.h create mode 100644 include/libcamera/internal/framebuffer.h delete mode 100644 src/libcamera/buffer.cpp create mode 100644 src/libcamera/framebuffer.cpp diff --git a/include/libcamera/buffer.h b/include/libcamera/buffer.h deleted file mode 100644 index 323d1cba..00000000 --- a/include/libcamera/buffer.h +++ /dev/null @@ -1,74 +0,0 @@ -/* SPDX-License-Identifier: LGPL-2.1-or-later */ -/* - * Copyright (C) 2019, Google Inc. - * - * buffer.h - Buffer handling - */ -#ifndef __LIBCAMERA_BUFFER_H__ -#define __LIBCAMERA_BUFFER_H__ - -#include -#include - -#include - -#include - -namespace libcamera { - -class Request; - -struct FrameMetadata { - enum Status { - FrameSuccess, - FrameError, - FrameCancelled, - }; - - struct Plane { - unsigned int bytesused; - }; - - Status status; - unsigned int sequence; - uint64_t timestamp; - std::vector planes; -}; - -class FrameBuffer final -{ -public: - struct Plane { - FileDescriptor fd; - unsigned int length; - }; - - FrameBuffer(const std::vector &planes, unsigned int cookie = 0); - - const std::vector &planes() const { return planes_; } - - Request *request() const { return request_; } - void setRequest(Request *request) { request_ = request; } - const FrameMetadata &metadata() const { return metadata_; } - - unsigned int cookie() const { return cookie_; } - void setCookie(unsigned int cookie) { cookie_ = cookie; } - - void cancel() { metadata_.status = FrameMetadata::FrameCancelled; } - -private: - LIBCAMERA_DISABLE_COPY_AND_MOVE(FrameBuffer) - - friend class V4L2VideoDevice; /* Needed to update metadata_. */ - - std::vector planes_; - - Request *request_; - FrameMetadata metadata_; - - unsigned int cookie_; -}; - -} /* namespace libcamera */ - -#endif /* __LIBCAMERA_BUFFER_H__ */ diff --git a/include/libcamera/framebuffer.h b/include/libcamera/framebuffer.h new file mode 100644 index 00000000..baf22a46 --- /dev/null +++ b/include/libcamera/framebuffer.h @@ -0,0 +1,74 @@ +/* SPDX-License-Identifier: LGPL-2.1-or-later */ +/* + * Copyright (C) 2019, Google Inc. + * + * framebuffer.h - Frame buffer handling + */ +#ifndef __LIBCAMERA_FRAMEBUFFER_H__ +#define __LIBCAMERA_FRAMEBUFFER_H__ + +#include +#include + +#include + +#include + +namespace libcamera { + +class Request; + +struct FrameMetadata { + enum Status { + FrameSuccess, + FrameError, + FrameCancelled, + }; + + struct Plane { + unsigned int bytesused; + }; + + Status status; + unsigned int sequence; + uint64_t timestamp; + std::vector planes; +}; + +class FrameBuffer final +{ +public: + struct Plane { + FileDescriptor fd; + unsigned int length; + }; + + FrameBuffer(const std::vector &planes, unsigned int cookie = 0); + + const std::vector &planes() const { return planes_; } + + Request *request() const { return request_; } + void setRequest(Request *request) { request_ = request; } + const FrameMetadata &metadata() const { return metadata_; } + + unsigned int cookie() const { return cookie_; } + void setCookie(unsigned int cookie) { cookie_ = cookie; } + + void cancel() { metadata_.status = FrameMetadata::FrameCancelled; } + +private: + LIBCAMERA_DISABLE_COPY_AND_MOVE(FrameBuffer) + + friend class V4L2VideoDevice; /* Needed to update metadata_. */ + + std::vector planes_; + + Request *request_; + FrameMetadata metadata_; + + unsigned int cookie_; +}; + +} /* namespace libcamera */ + +#endif /* __LIBCAMERA_FRAMEBUFFER_H__ */ diff --git a/include/libcamera/internal/buffer.h b/include/libcamera/internal/buffer.h deleted file mode 100644 index beae0cb9..00000000 --- a/include/libcamera/internal/buffer.h +++ /dev/null @@ -1,52 +0,0 @@ -/* SPDX-License-Identifier: LGPL-2.1-or-later */ -/* - * Copyright (C) 2020, Google Inc. - * - * buffer.h - Internal buffer handling - */ -#ifndef __LIBCAMERA_INTERNAL_BUFFER_H__ -#define __LIBCAMERA_INTERNAL_BUFFER_H__ - -#include -#include - -#include -#include - -#include - -namespace libcamera { - -class MappedBuffer -{ -public: - using Plane = Span; - - ~MappedBuffer(); - - MappedBuffer(MappedBuffer &&other); - MappedBuffer &operator=(MappedBuffer &&other); - - bool isValid() const { return error_ == 0; } - int error() const { return error_; } - const std::vector &maps() const { return maps_; } - -protected: - MappedBuffer(); - - int error_; - std::vector maps_; - -private: - LIBCAMERA_DISABLE_COPY(MappedBuffer) -}; - -class MappedFrameBuffer : public MappedBuffer -{ -public: - MappedFrameBuffer(const FrameBuffer *buffer, int flags); -}; - -} /* namespace libcamera */ - -#endif /* __LIBCAMERA_INTERNAL_BUFFER_H__ */ diff --git a/include/libcamera/internal/framebuffer.h b/include/libcamera/internal/framebuffer.h new file mode 100644 index 00000000..0c76fc62 --- /dev/null +++ b/include/libcamera/internal/framebuffer.h @@ -0,0 +1,52 @@ +/* SPDX-License-Identifier: LGPL-2.1-or-later */ +/* + * Copyright (C) 2020, Google Inc. + * + * framebuffer.h - Internal frame buffer handling + */ +#ifndef __LIBCAMERA_INTERNAL_FRAMEBUFFER_H__ +#define __LIBCAMERA_INTERNAL_FRAMEBUFFER_H__ + +#include +#include + +#include +#include + +#include + +namespace libcamera { + +class MappedBuffer +{ +public: + using Plane = Span; + + ~MappedBuffer(); + + MappedBuffer(MappedBuffer &&other); + MappedBuffer &operator=(MappedBuffer &&other); + + bool isValid() const { return error_ == 0; } + int error() const { return error_; } + const std::vector &maps() const { return maps_; } + +protected: + MappedBuffer(); + + int error_; + std::vector maps_; + +private: + LIBCAMERA_DISABLE_COPY(MappedBuffer) +}; + +class MappedFrameBuffer : public MappedBuffer +{ +public: + MappedFrameBuffer(const FrameBuffer *buffer, int flags); +}; + +} /* namespace libcamera */ + +#endif /* __LIBCAMERA_INTERNAL_FRAMEBUFFER_H__ */ diff --git a/include/libcamera/internal/ipa_data_serializer.h b/include/libcamera/internal/ipa_data_serializer.h index 76325b1d..519093bd 100644 --- a/include/libcamera/internal/ipa_data_serializer.h +++ b/include/libcamera/internal/ipa_data_serializer.h @@ -16,8 +16,8 @@ #include -#include #include +#include #include #include diff --git a/include/libcamera/internal/meson.build b/include/libcamera/internal/meson.build index 16a76ebd..6d4eb7ed 100644 --- a/include/libcamera/internal/meson.build +++ b/include/libcamera/internal/meson.build @@ -11,7 +11,6 @@ libcamera_tracepoint_header = custom_target( libcamera_internal_headers = files([ 'bayer_format.h', - 'buffer.h', 'byte_stream_buffer.h', 'camera_controls.h', 'camera_sensor.h', @@ -23,6 +22,7 @@ libcamera_internal_headers = files([ 'device_enumerator_sysfs.h', 'device_enumerator_udev.h', 'formats.h', + 'framebuffer.h', 'ipa_manager.h', 'ipa_module.h', 'ipa_proxy.h', diff --git a/include/libcamera/internal/tracepoints/request.tp b/include/libcamera/internal/tracepoints/request.tp index 9c841b97..37d8c46f 100644 --- a/include/libcamera/internal/tracepoints/request.tp +++ b/include/libcamera/internal/tracepoints/request.tp @@ -5,7 +5,7 @@ * request.tp - Tracepoints for the request object */ -#include +#include #include TRACEPOINT_EVENT_CLASS( diff --git a/include/libcamera/internal/v4l2_videodevice.h b/include/libcamera/internal/v4l2_videodevice.h index a7c3d529..e767ec84 100644 --- a/include/libcamera/internal/v4l2_videodevice.h +++ b/include/libcamera/internal/v4l2_videodevice.h @@ -20,7 +20,7 @@ #include #include -#include +#include #include #include diff --git a/include/libcamera/ipa/ipa_interface.h b/include/libcamera/ipa/ipa_interface.h index 9a15c86b..1590584c 100644 --- a/include/libcamera/ipa/ipa_interface.h +++ b/include/libcamera/ipa/ipa_interface.h @@ -15,8 +15,8 @@ #include -#include #include +#include #include namespace libcamera { diff --git a/include/libcamera/meson.build b/include/libcamera/meson.build index e4d5c655..5b25ef84 100644 --- a/include/libcamera/meson.build +++ b/include/libcamera/meson.build @@ -1,12 +1,12 @@ # SPDX-License-Identifier: CC0-1.0 libcamera_public_headers = files([ - 'buffer.h', 'camera.h', 'camera_manager.h', 'compiler.h', 'controls.h', 'file_descriptor.h', + 'framebuffer.h', 'framebuffer_allocator.h', 'geometry.h', 'logging.h', diff --git a/include/libcamera/stream.h b/include/libcamera/stream.h index bb47c390..0c55e716 100644 --- a/include/libcamera/stream.h +++ b/include/libcamera/stream.h @@ -12,7 +12,7 @@ #include #include -#include +#include #include #include diff --git a/src/android/camera_device.h b/src/android/camera_device.h index d085a27f..089a6204 100644 --- a/src/android/camera_device.h +++ b/src/android/camera_device.h @@ -19,12 +19,12 @@ #include #include -#include #include +#include #include #include -#include "libcamera/internal/buffer.h" +#include "libcamera/internal/framebuffer.h" #include "camera_capabilities.h" #include "camera_metadata.h" diff --git a/src/android/camera_stream.h b/src/android/camera_stream.h index 8ecc6e34..629d9e00 100644 --- a/src/android/camera_stream.h +++ b/src/android/camera_stream.h @@ -13,13 +13,13 @@ #include -#include #include +#include #include #include #include -#include "libcamera/internal/buffer.h" +#include "libcamera/internal/framebuffer.h" class CameraDevice; class CameraMetadata; diff --git a/src/android/camera_worker.h b/src/android/camera_worker.h index 6e1aee4a..67ae50bd 100644 --- a/src/android/camera_worker.h +++ b/src/android/camera_worker.h @@ -12,8 +12,8 @@ #include #include -#include #include +#include #include #include diff --git a/src/android/jpeg/encoder.h b/src/android/jpeg/encoder.h index 28e7f92a..a28522f4 100644 --- a/src/android/jpeg/encoder.h +++ b/src/android/jpeg/encoder.h @@ -9,7 +9,7 @@ #include -#include +#include #include class Encoder diff --git a/src/android/jpeg/encoder_libjpeg.h b/src/android/jpeg/encoder_libjpeg.h index 838da772..14bf8922 100644 --- a/src/android/jpeg/encoder_libjpeg.h +++ b/src/android/jpeg/encoder_libjpeg.h @@ -9,8 +9,8 @@ #include "encoder.h" -#include "libcamera/internal/buffer.h" #include "libcamera/internal/formats.h" +#include "libcamera/internal/framebuffer.h" #include diff --git a/src/android/jpeg/post_processor_jpeg.h b/src/android/jpeg/post_processor_jpeg.h index 5d2d4ab2..5c399be9 100644 --- a/src/android/jpeg/post_processor_jpeg.h +++ b/src/android/jpeg/post_processor_jpeg.h @@ -13,7 +13,7 @@ #include -#include "libcamera/internal/buffer.h" +#include "libcamera/internal/framebuffer.h" class CameraDevice; diff --git a/src/android/jpeg/thumbnailer.h b/src/android/jpeg/thumbnailer.h index 4e9226c3..68cbf743 100644 --- a/src/android/jpeg/thumbnailer.h +++ b/src/android/jpeg/thumbnailer.h @@ -9,8 +9,8 @@ #include -#include "libcamera/internal/buffer.h" #include "libcamera/internal/formats.h" +#include "libcamera/internal/framebuffer.h" class Thumbnailer { diff --git a/src/android/mm/generic_camera_buffer.cpp b/src/android/mm/generic_camera_buffer.cpp index 326fdc06..166be36e 100644 --- a/src/android/mm/generic_camera_buffer.cpp +++ b/src/android/mm/generic_camera_buffer.cpp @@ -11,7 +11,7 @@ #include -#include "libcamera/internal/buffer.h" +#include "libcamera/internal/framebuffer.h" using namespace libcamera; diff --git a/src/android/post_processor.h b/src/android/post_processor.h index 547fda37..689f85d9 100644 --- a/src/android/post_processor.h +++ b/src/android/post_processor.h @@ -7,10 +7,10 @@ #ifndef __ANDROID_POST_PROCESSOR_H__ #define __ANDROID_POST_PROCESSOR_H__ -#include +#include #include -#include "libcamera/internal/buffer.h" +#include "libcamera/internal/framebuffer.h" #include "camera_buffer.h" diff --git a/src/cam/buffer_writer.h b/src/cam/buffer_writer.h index 47e26103..604ce870 100644 --- a/src/cam/buffer_writer.h +++ b/src/cam/buffer_writer.h @@ -10,7 +10,7 @@ #include #include -#include +#include class BufferWriter { diff --git a/src/cam/capture.h b/src/cam/capture.h index 59d13876..de478c98 100644 --- a/src/cam/capture.h +++ b/src/cam/capture.h @@ -11,8 +11,8 @@ #include #include -#include #include +#include #include #include #include diff --git a/src/ipa/ipu3/ipu3.cpp b/src/ipa/ipu3/ipu3.cpp index f43f8620..71698d36 100644 --- a/src/ipa/ipu3/ipu3.cpp +++ b/src/ipa/ipu3/ipu3.cpp @@ -13,14 +13,14 @@ #include -#include #include +#include #include #include #include #include -#include "libcamera/internal/buffer.h" +#include "libcamera/internal/framebuffer.h" #include "ipu3_agc.h" #include "ipu3_awb.h" diff --git a/src/ipa/raspberrypi/raspberrypi.cpp b/src/ipa/raspberrypi/raspberrypi.cpp index 4d09a84f..4ae81f35 100644 --- a/src/ipa/raspberrypi/raspberrypi.cpp +++ b/src/ipa/raspberrypi/raspberrypi.cpp @@ -18,17 +18,17 @@ #include #include -#include #include #include #include +#include #include #include #include #include #include -#include "libcamera/internal/buffer.h" +#include "libcamera/internal/framebuffer.h" #include "agc_algorithm.hpp" #include "agc_status.h" diff --git a/src/ipa/rkisp1/rkisp1.cpp b/src/ipa/rkisp1/rkisp1.cpp index cdfb4d13..b881d42e 100644 --- a/src/ipa/rkisp1/rkisp1.cpp +++ b/src/ipa/rkisp1/rkisp1.cpp @@ -17,8 +17,8 @@ #include -#include #include +#include #include #include #include diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp deleted file mode 100644 index e4c345d5..00000000 --- a/src/libcamera/buffer.cpp +++ /dev/null @@ -1,383 +0,0 @@ -/* SPDX-License-Identifier: LGPL-2.1-or-later */ -/* - * Copyright (C) 2019, Google Inc. - * - * buffer.cpp - Buffer handling - */ - -#include -#include "libcamera/internal/buffer.h" - -#include -#include -#include -#include - -#include - -/** - * \file libcamera/buffer.h - * \brief Buffer handling - * - * \file libcamera/internal/buffer.h - * \brief Internal buffer handling support - */ - -namespace libcamera { - -LOG_DEFINE_CATEGORY(Buffer) - -/** - * \struct FrameMetadata - * \brief Metadata related to a captured frame - * - * The FrameMetadata structure stores all metadata related to a captured frame, - * as stored in a FrameBuffer, such as capture status, timestamp and bytesused. - */ - -/** - * \enum FrameMetadata::Status - * \brief Define the frame completion status - * \var FrameMetadata::FrameSuccess - * The frame has been captured with success and contains valid data. All fields - * of the FrameMetadata structure are valid. - * \var FrameMetadata::FrameError - * An error occurred during capture of the frame. The frame data may be partly - * or fully invalid. The sequence and timestamp fields of the FrameMetadata - * structure is valid, the other fields may be invalid. - * \var FrameMetadata::FrameCancelled - * Capture stopped before the frame completed. The frame data is not valid. All - * fields of the FrameMetadata structure but the status field are invalid. - */ - -/** - * \struct FrameMetadata::Plane - * \brief Per-plane frame metadata - * - * Frames are stored in memory in one or multiple planes. The - * FrameMetadata::Plane structure stores per-plane metadata. - */ - -/** - * \var FrameMetadata::Plane::bytesused - * \brief Number of bytes occupied by the data in the plane, including line - * padding - * - * This value may vary per frame for compressed formats. For uncompressed - * formats it will be constant for all frames, but may be smaller than the - * FrameBuffer size. - */ - -/** - * \var FrameMetadata::status - * \brief Status of the frame - * - * The validity of other fields of the FrameMetadata structure depends on the - * status value. - */ - -/** - * \var FrameMetadata::sequence - * \brief Frame sequence number - * - * The sequence number is a monotonically increasing number assigned to the - * frames captured by the stream. The value is increased by one for each frame. - * Gaps in the sequence numbers indicate dropped frames. - */ - -/** - * \var FrameMetadata::timestamp - * \brief Time when the frame was captured - * - * The timestamp is expressed as a number of nanoseconds relative to the system - * clock since an unspecified time point. - * - * \todo Be more precise on what timestamps refer to. - */ - -/** - * \var FrameMetadata::planes - * \brief Array of per-plane metadata - */ - -/** - * \class FrameBuffer - * \brief Frame buffer data and its associated dynamic metadata - * - * The FrameBuffer class is the primary interface for applications, IPAs and - * pipeline handlers to interact with frame memory. It contains all the static - * and dynamic information to manage the whole life cycle of a frame capture, - * from buffer creation to consumption. - * - * The static information describes the memory planes that make a frame. The - * planes are specified when creating the FrameBuffer and are expressed as a set - * of dmabuf file descriptors and length. - * - * The dynamic information is grouped in a FrameMetadata instance. It is updated - * during the processing of a queued capture request, and is valid from the - * completion of the buffer as signaled by Camera::bufferComplete() until the - * FrameBuffer is either reused in a new request or deleted. - * - * The creator of a FrameBuffer (application, IPA or pipeline handler) may - * associate to it an integer cookie for any private purpose. The cookie may be - * set when creating the FrameBuffer, and updated at any time with setCookie(). - * The cookie is transparent to the libcamera core and shall only be set by the - * creator of the FrameBuffer. This mechanism supplements the Request cookie. - */ - -/** - * \struct FrameBuffer::Plane - * \brief A memory region to store a single plane of a frame - * - * Planar pixel formats use multiple memory regions to store the different - * colour components of a frame. The Plane structure describes such a memory - * region by a dmabuf file descriptor and a length. A FrameBuffer then - * contains one or multiple planes, depending on the pixel format of the - * frames it is meant to store. - * - * To support DMA access, planes are associated with dmabuf objects represented - * by FileDescriptor handles. The Plane class doesn't handle mapping of the - * memory to the CPU, but applications and IPAs may use the dmabuf file - * descriptors to map the plane memory with mmap() and access its contents. - * - * \todo Once we have a Kernel API which can express offsets within a plane - * this structure shall be extended to contain this information. See commit - * 83148ce8be55e for initial documentation of this feature. - */ - -/** - * \var FrameBuffer::Plane::fd - * \brief The dmabuf file descriptor - */ - -/** - * \var FrameBuffer::Plane::length - * \brief The plane length in bytes - */ - -/** - * \brief Construct a FrameBuffer with an array of planes - * \param[in] planes The frame memory planes - * \param[in] cookie Cookie - */ -FrameBuffer::FrameBuffer(const std::vector &planes, unsigned int cookie) - : planes_(planes), request_(nullptr), cookie_(cookie) -{ -} - -/** - * \fn FrameBuffer::planes() - * \brief Retrieve the static plane descriptors - * \return Array of plane descriptors - */ - -/** - * \fn FrameBuffer::request() - * \brief Retrieve the request this buffer belongs to - * - * The intended callers of this method are buffer completion handlers that - * need to associate a buffer to the request it belongs to. - * - * A FrameBuffer is associated to a request by Request::addBuffer() and the - * association is valid until the buffer completes. The returned request - * pointer is valid only during that interval. - * - * \return The Request the FrameBuffer belongs to, or nullptr if the buffer is - * not associated with a request - */ - -/** - * \fn FrameBuffer::setRequest() - * \brief Set the request this buffer belongs to - * \param[in] request Request to set - * - * For buffers added to requests by applications, this method is called by - * Request::addBuffer() or Request::reuse(). For buffers internal to pipeline - * handlers, it is called by the pipeline handlers themselves. - * - * \todo Shall be hidden from applications with a d-pointer design. - */ - -/** - * \fn FrameBuffer::metadata() - * \brief Retrieve the dynamic metadata - * \return Dynamic metadata for the frame contained in the buffer - */ - -/** - * \fn FrameBuffer::cookie() - * \brief Retrieve the cookie - * - * The cookie belongs to the creator of the FrameBuffer, which controls its - * lifetime and value. - * - * \sa setCookie() - * - * \return The cookie - */ - -/** - * \fn FrameBuffer::setCookie() - * \brief Set the cookie - * \param[in] cookie Cookie to set - * - * The cookie belongs to the creator of the FrameBuffer. Its value may be - * modified at any time with this method. Applications and IPAs shall not modify - * the cookie value of buffers they haven't created themselves. The libcamera - * core never modifies the buffer cookie. - */ - -/** - * \fn FrameBuffer::cancel() - * \brief Marks the buffer as cancelled - * - * If a buffer is not used by a request, it shall be marked as cancelled to - * indicate that the metadata is invalid. - */ - -/** - * \class MappedBuffer - * \brief Provide an interface to support managing memory mapped buffers - * - * The MappedBuffer interface provides access to a set of MappedPlanes which - * are available for access by the CPU. - * - * This class is not meant to be constructed directly, but instead derived - * classes should be used to implement the correct mapping of a source buffer. - * - * This allows treating CPU accessible memory through a generic interface - * regardless of whether it originates from a libcamera FrameBuffer or other - * source. - */ - -/** - * \typedef MappedBuffer::Plane - * \brief A mapped region of memory accessible to the CPU - * - * The MappedBuffer::Plane uses the Span interface to describe the mapped memory - * region. - */ - -/** - * \brief Construct an empty MappedBuffer - */ -MappedBuffer::MappedBuffer() - : error_(0) -{ -} - -/** - * \brief Move constructor, construct the MappedBuffer with the contents of \a - * other using move semantics - * \param[in] other The other MappedBuffer - * - * Moving a MappedBuffer moves the mappings contained in the \a other to the new - * MappedBuffer and invalidates the \a other. - * - * No mappings are unmapped or destroyed in this process. - */ -MappedBuffer::MappedBuffer(MappedBuffer &&other) -{ - *this = std::move(other); -} - -/** - * \brief Move assignment operator, replace the mappings with those of \a other -* \param[in] other The other MappedBuffer - * - * Moving a MappedBuffer moves the mappings contained in the \a other to the new - * MappedBuffer and invalidates the \a other. - * - * No mappings are unmapped or destroyed in this process. - */ -MappedBuffer &MappedBuffer::operator=(MappedBuffer &&other) -{ - error_ = other.error_; - maps_ = std::move(other.maps_); - other.error_ = -ENOENT; - - return *this; -} - -MappedBuffer::~MappedBuffer() -{ - for (Plane &map : maps_) - munmap(map.data(), map.size()); -} - -/** - * \fn MappedBuffer::isValid() - * \brief Check if the MappedBuffer instance is valid - * \return True if the MappedBuffer has valid mappings, false otherwise - */ - -/** - * \fn MappedBuffer::error() - * \brief Retrieve the map error status - * - * This function retrieves the error status from the MappedBuffer. - * The error status is a negative number as defined by errno.h. If - * no error occurred, this function returns 0. - * - * \return The map error code - */ - -/** - * \fn MappedBuffer::maps() - * \brief Retrieve the mapped planes - * - * This function retrieves the successfully mapped planes stored as a vector - * of Span to provide access to the mapped memory. - * - * \return A vector of the mapped planes - */ - -/** - * \var MappedBuffer::error_ - * \brief Stores the error value if present - * - * MappedBuffer derived classes shall set this to a negative value as defined - * by errno.h if an error occured during the mapping process. - */ - -/** - * \var MappedBuffer::maps_ - * \brief Stores the internal mapped planes - * - * MappedBuffer derived classes shall store the mappings they create in this - * vector which is parsed during destruct to unmap any memory mappings which - * completed successfully. - */ - -/** - * \class MappedFrameBuffer - * \brief Map a FrameBuffer using the MappedBuffer interface - */ - -/** - * \brief Map all planes of a FrameBuffer - * \param[in] buffer FrameBuffer to be mapped - * \param[in] flags Protection flags to apply to map - * - * Construct an object to map a frame buffer for CPU access. - * The flags are passed directly to mmap and should be either PROT_READ, - * PROT_WRITE, or a bitwise-or combination of both. - */ -MappedFrameBuffer::MappedFrameBuffer(const FrameBuffer *buffer, int flags) -{ - maps_.reserve(buffer->planes().size()); - - for (const FrameBuffer::Plane &plane : buffer->planes()) { - void *address = mmap(nullptr, plane.length, flags, - MAP_SHARED, plane.fd.fd(), 0); - if (address == MAP_FAILED) { - error_ = -errno; - LOG(Buffer, Error) << "Failed to mmap plane"; - break; - } - - maps_.emplace_back(static_cast(address), plane.length); - } -} - -} /* namespace libcamera */ diff --git a/src/libcamera/framebuffer.cpp b/src/libcamera/framebuffer.cpp new file mode 100644 index 00000000..4bde556c --- /dev/null +++ b/src/libcamera/framebuffer.cpp @@ -0,0 +1,383 @@ +/* SPDX-License-Identifier: LGPL-2.1-or-later */ +/* + * Copyright (C) 2019, Google Inc. + * + * framebuffer.cpp - Frame buffer handling + */ + +#include +#include "libcamera/internal/framebuffer.h" + +#include +#include +#include +#include + +#include + +/** + * \file libcamera/framebuffer.h + * \brief Frame buffer handling + * + * \file libcamera/internal/framebuffer.h + * \brief Internal frame buffer handling support + */ + +namespace libcamera { + +LOG_DEFINE_CATEGORY(Buffer) + +/** + * \struct FrameMetadata + * \brief Metadata related to a captured frame + * + * The FrameMetadata structure stores all metadata related to a captured frame, + * as stored in a FrameBuffer, such as capture status, timestamp and bytesused. + */ + +/** + * \enum FrameMetadata::Status + * \brief Define the frame completion status + * \var FrameMetadata::FrameSuccess + * The frame has been captured with success and contains valid data. All fields + * of the FrameMetadata structure are valid. + * \var FrameMetadata::FrameError + * An error occurred during capture of the frame. The frame data may be partly + * or fully invalid. The sequence and timestamp fields of the FrameMetadata + * structure is valid, the other fields may be invalid. + * \var FrameMetadata::FrameCancelled + * Capture stopped before the frame completed. The frame data is not valid. All + * fields of the FrameMetadata structure but the status field are invalid. + */ + +/** + * \struct FrameMetadata::Plane + * \brief Per-plane frame metadata + * + * Frames are stored in memory in one or multiple planes. The + * FrameMetadata::Plane structure stores per-plane metadata. + */ + +/** + * \var FrameMetadata::Plane::bytesused + * \brief Number of bytes occupied by the data in the plane, including line + * padding + * + * This value may vary per frame for compressed formats. For uncompressed + * formats it will be constant for all frames, but may be smaller than the + * FrameBuffer size. + */ + +/** + * \var FrameMetadata::status + * \brief Status of the frame + * + * The validity of other fields of the FrameMetadata structure depends on the + * status value. + */ + +/** + * \var FrameMetadata::sequence + * \brief Frame sequence number + * + * The sequence number is a monotonically increasing number assigned to the + * frames captured by the stream. The value is increased by one for each frame. + * Gaps in the sequence numbers indicate dropped frames. + */ + +/** + * \var FrameMetadata::timestamp + * \brief Time when the frame was captured + * + * The timestamp is expressed as a number of nanoseconds relative to the system + * clock since an unspecified time point. + * + * \todo Be more precise on what timestamps refer to. + */ + +/** + * \var FrameMetadata::planes + * \brief Array of per-plane metadata + */ + +/** + * \class FrameBuffer + * \brief Frame buffer data and its associated dynamic metadata + * + * The FrameBuffer class is the primary interface for applications, IPAs and + * pipeline handlers to interact with frame memory. It contains all the static + * and dynamic information to manage the whole life cycle of a frame capture, + * from buffer creation to consumption. + * + * The static information describes the memory planes that make a frame. The + * planes are specified when creating the FrameBuffer and are expressed as a set + * of dmabuf file descriptors and length. + * + * The dynamic information is grouped in a FrameMetadata instance. It is updated + * during the processing of a queued capture request, and is valid from the + * completion of the buffer as signaled by Camera::bufferComplete() until the + * FrameBuffer is either reused in a new request or deleted. + * + * The creator of a FrameBuffer (application, IPA or pipeline handler) may + * associate to it an integer cookie for any private purpose. The cookie may be + * set when creating the FrameBuffer, and updated at any time with setCookie(). + * The cookie is transparent to the libcamera core and shall only be set by the + * creator of the FrameBuffer. This mechanism supplements the Request cookie. + */ + +/** + * \struct FrameBuffer::Plane + * \brief A memory region to store a single plane of a frame + * + * Planar pixel formats use multiple memory regions to store the different + * colour components of a frame. The Plane structure describes such a memory + * region by a dmabuf file descriptor and a length. A FrameBuffer then + * contains one or multiple planes, depending on the pixel format of the + * frames it is meant to store. + * + * To support DMA access, planes are associated with dmabuf objects represented + * by FileDescriptor handles. The Plane class doesn't handle mapping of the + * memory to the CPU, but applications and IPAs may use the dmabuf file + * descriptors to map the plane memory with mmap() and access its contents. + * + * \todo Once we have a Kernel API which can express offsets within a plane + * this structure shall be extended to contain this information. See commit + * 83148ce8be55e for initial documentation of this feature. + */ + +/** + * \var FrameBuffer::Plane::fd + * \brief The dmabuf file descriptor + */ + +/** + * \var FrameBuffer::Plane::length + * \brief The plane length in bytes + */ + +/** + * \brief Construct a FrameBuffer with an array of planes + * \param[in] planes The frame memory planes + * \param[in] cookie Cookie + */ +FrameBuffer::FrameBuffer(const std::vector &planes, unsigned int cookie) + : planes_(planes), request_(nullptr), cookie_(cookie) +{ +} + +/** + * \fn FrameBuffer::planes() + * \brief Retrieve the static plane descriptors + * \return Array of plane descriptors + */ + +/** + * \fn FrameBuffer::request() + * \brief Retrieve the request this buffer belongs to + * + * The intended callers of this method are buffer completion handlers that + * need to associate a buffer to the request it belongs to. + * + * A FrameBuffer is associated to a request by Request::addBuffer() and the + * association is valid until the buffer completes. The returned request + * pointer is valid only during that interval. + * + * \return The Request the FrameBuffer belongs to, or nullptr if the buffer is + * not associated with a request + */ + +/** + * \fn FrameBuffer::setRequest() + * \brief Set the request this buffer belongs to + * \param[in] request Request to set + * + * For buffers added to requests by applications, this method is called by + * Request::addBuffer() or Request::reuse(). For buffers internal to pipeline + * handlers, it is called by the pipeline handlers themselves. + * + * \todo Shall be hidden from applications with a d-pointer design. + */ + +/** + * \fn FrameBuffer::metadata() + * \brief Retrieve the dynamic metadata + * \return Dynamic metadata for the frame contained in the buffer + */ + +/** + * \fn FrameBuffer::cookie() + * \brief Retrieve the cookie + * + * The cookie belongs to the creator of the FrameBuffer, which controls its + * lifetime and value. + * + * \sa setCookie() + * + * \return The cookie + */ + +/** + * \fn FrameBuffer::setCookie() + * \brief Set the cookie + * \param[in] cookie Cookie to set + * + * The cookie belongs to the creator of the FrameBuffer. Its value may be + * modified at any time with this method. Applications and IPAs shall not modify + * the cookie value of buffers they haven't created themselves. The libcamera + * core never modifies the buffer cookie. + */ + +/** + * \fn FrameBuffer::cancel() + * \brief Marks the buffer as cancelled + * + * If a buffer is not used by a request, it shall be marked as cancelled to + * indicate that the metadata is invalid. + */ + +/** + * \class MappedBuffer + * \brief Provide an interface to support managing memory mapped buffers + * + * The MappedBuffer interface provides access to a set of MappedPlanes which + * are available for access by the CPU. + * + * This class is not meant to be constructed directly, but instead derived + * classes should be used to implement the correct mapping of a source buffer. + * + * This allows treating CPU accessible memory through a generic interface + * regardless of whether it originates from a libcamera FrameBuffer or other + * source. + */ + +/** + * \typedef MappedBuffer::Plane + * \brief A mapped region of memory accessible to the CPU + * + * The MappedBuffer::Plane uses the Span interface to describe the mapped memory + * region. + */ + +/** + * \brief Construct an empty MappedBuffer + */ +MappedBuffer::MappedBuffer() + : error_(0) +{ +} + +/** + * \brief Move constructor, construct the MappedBuffer with the contents of \a + * other using move semantics + * \param[in] other The other MappedBuffer + * + * Moving a MappedBuffer moves the mappings contained in the \a other to the new + * MappedBuffer and invalidates the \a other. + * + * No mappings are unmapped or destroyed in this process. + */ +MappedBuffer::MappedBuffer(MappedBuffer &&other) +{ + *this = std::move(other); +} + +/** + * \brief Move assignment operator, replace the mappings with those of \a other +* \param[in] other The other MappedBuffer + * + * Moving a MappedBuffer moves the mappings contained in the \a other to the new + * MappedBuffer and invalidates the \a other. + * + * No mappings are unmapped or destroyed in this process. + */ +MappedBuffer &MappedBuffer::operator=(MappedBuffer &&other) +{ + error_ = other.error_; + maps_ = std::move(other.maps_); + other.error_ = -ENOENT; + + return *this; +} + +MappedBuffer::~MappedBuffer() +{ + for (Plane &map : maps_) + munmap(map.data(), map.size()); +} + +/** + * \fn MappedBuffer::isValid() + * \brief Check if the MappedBuffer instance is valid + * \return True if the MappedBuffer has valid mappings, false otherwise + */ + +/** + * \fn MappedBuffer::error() + * \brief Retrieve the map error status + * + * This function retrieves the error status from the MappedBuffer. + * The error status is a negative number as defined by errno.h. If + * no error occurred, this function returns 0. + * + * \return The map error code + */ + +/** + * \fn MappedBuffer::maps() + * \brief Retrieve the mapped planes + * + * This function retrieves the successfully mapped planes stored as a vector + * of Span to provide access to the mapped memory. + * + * \return A vector of the mapped planes + */ + +/** + * \var MappedBuffer::error_ + * \brief Stores the error value if present + * + * MappedBuffer derived classes shall set this to a negative value as defined + * by errno.h if an error occured during the mapping process. + */ + +/** + * \var MappedBuffer::maps_ + * \brief Stores the internal mapped planes + * + * MappedBuffer derived classes shall store the mappings they create in this + * vector which is parsed during destruct to unmap any memory mappings which + * completed successfully. + */ + +/** + * \class MappedFrameBuffer + * \brief Map a FrameBuffer using the MappedBuffer interface + */ + +/** + * \brief Map all planes of a FrameBuffer + * \param[in] buffer FrameBuffer to be mapped + * \param[in] flags Protection flags to apply to map + * + * Construct an object to map a frame buffer for CPU access. + * The flags are passed directly to mmap and should be either PROT_READ, + * PROT_WRITE, or a bitwise-or combination of both. + */ +MappedFrameBuffer::MappedFrameBuffer(const FrameBuffer *buffer, int flags) +{ + maps_.reserve(buffer->planes().size()); + + for (const FrameBuffer::Plane &plane : buffer->planes()) { + void *address = mmap(nullptr, plane.length, flags, + MAP_SHARED, plane.fd.fd(), 0); + if (address == MAP_FAILED) { + error_ = -errno; + LOG(Buffer, Error) << "Failed to mmap plane"; + break; + } + + maps_.emplace_back(static_cast(address), plane.length); + } +} + +} /* namespace libcamera */ diff --git a/src/libcamera/framebuffer_allocator.cpp b/src/libcamera/framebuffer_allocator.cpp index 86a57923..695073fd 100644 --- a/src/libcamera/framebuffer_allocator.cpp +++ b/src/libcamera/framebuffer_allocator.cpp @@ -11,8 +11,8 @@ #include -#include #include +#include #include #include "libcamera/internal/pipeline_handler.h" diff --git a/src/libcamera/meson.build b/src/libcamera/meson.build index 517e763d..4f085801 100644 --- a/src/libcamera/meson.build +++ b/src/libcamera/meson.build @@ -2,7 +2,6 @@ libcamera_sources = files([ 'bayer_format.cpp', - 'buffer.cpp', 'byte_stream_buffer.cpp', 'camera.cpp', 'camera_controls.cpp', @@ -17,6 +16,7 @@ libcamera_sources = files([ 'device_enumerator_sysfs.cpp', 'file_descriptor.cpp', 'formats.cpp', + 'framebuffer.cpp', 'framebuffer_allocator.cpp', 'geometry.cpp', 'ipa_controls.cpp', diff --git a/src/libcamera/pipeline/ipu3/frames.cpp b/src/libcamera/pipeline/ipu3/frames.cpp index d9a2249b..ce5ccbf1 100644 --- a/src/libcamera/pipeline/ipu3/frames.cpp +++ b/src/libcamera/pipeline/ipu3/frames.cpp @@ -7,7 +7,7 @@ #include "frames.h" -#include +#include #include #include "libcamera/internal/pipeline_handler.h" diff --git a/src/libcamera/pipeline/raspberrypi/raspberrypi.cpp b/src/libcamera/pipeline/raspberrypi/raspberrypi.cpp index 082eb1ee..4f1a5985 100644 --- a/src/libcamera/pipeline/raspberrypi/raspberrypi.cpp +++ b/src/libcamera/pipeline/raspberrypi/raspberrypi.cpp @@ -30,10 +30,10 @@ #include #include "libcamera/internal/bayer_format.h" -#include "libcamera/internal/buffer.h" #include "libcamera/internal/camera_sensor.h" #include "libcamera/internal/delayed_controls.h" #include "libcamera/internal/device_enumerator.h" +#include "libcamera/internal/framebuffer.h" #include "libcamera/internal/ipa_manager.h" #include "libcamera/internal/media_device.h" #include "libcamera/internal/pipeline_handler.h" diff --git a/src/libcamera/pipeline/rkisp1/rkisp1.cpp b/src/libcamera/pipeline/rkisp1/rkisp1.cpp index 00df4f0b..42911a8f 100644 --- a/src/libcamera/pipeline/rkisp1/rkisp1.cpp +++ b/src/libcamera/pipeline/rkisp1/rkisp1.cpp @@ -17,10 +17,10 @@ #include #include -#include #include #include #include +#include #include #include #include diff --git a/src/libcamera/pipeline/simple/converter.cpp b/src/libcamera/pipeline/simple/converter.cpp index 3baf78f9..b5e34c4c 100644 --- a/src/libcamera/pipeline/simple/converter.cpp +++ b/src/libcamera/pipeline/simple/converter.cpp @@ -14,7 +14,7 @@ #include #include -#include +#include #include #include diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp index 0ed172dc..c9928d44 100644 --- a/src/libcamera/pipeline_handler.cpp +++ b/src/libcamera/pipeline_handler.cpp @@ -12,9 +12,9 @@ #include #include -#include #include #include +#include #include "libcamera/internal/device_enumerator.h" #include "libcamera/internal/media_device.h" diff --git a/src/libcamera/request.cpp b/src/libcamera/request.cpp index 518384eb..5faf3c71 100644 --- a/src/libcamera/request.cpp +++ b/src/libcamera/request.cpp @@ -12,9 +12,9 @@ #include -#include #include #include +#include #include #include "libcamera/internal/camera_controls.h" diff --git a/src/qcam/dng_writer.h b/src/qcam/dng_writer.h index bf44c879..20905f37 100644 --- a/src/qcam/dng_writer.h +++ b/src/qcam/dng_writer.h @@ -10,9 +10,9 @@ #ifdef HAVE_TIFF #define HAVE_DNG -#include #include #include +#include #include using namespace libcamera; diff --git a/src/qcam/main_window.h b/src/qcam/main_window.h index 27131461..85d56ce4 100644 --- a/src/qcam/main_window.h +++ b/src/qcam/main_window.h @@ -18,10 +18,10 @@ #include #include -#include #include #include #include +#include #include #include #include diff --git a/src/qcam/viewfinder.h b/src/qcam/viewfinder.h index e33dc452..46747c22 100644 --- a/src/qcam/viewfinder.h +++ b/src/qcam/viewfinder.h @@ -11,8 +11,8 @@ #include #include -#include #include +#include struct MappedBuffer { void *memory; diff --git a/src/qcam/viewfinder_gl.h b/src/qcam/viewfinder_gl.h index bce94c87..4a0f8ca5 100644 --- a/src/qcam/viewfinder_gl.h +++ b/src/qcam/viewfinder_gl.h @@ -21,8 +21,8 @@ #include #include -#include #include +#include #include "viewfinder.h" diff --git a/src/qcam/viewfinder_qt.h b/src/qcam/viewfinder_qt.h index d7554288..501c72a7 100644 --- a/src/qcam/viewfinder_qt.h +++ b/src/qcam/viewfinder_qt.h @@ -14,8 +14,8 @@ #include #include -#include #include +#include #include #include "format_converter.h" diff --git a/src/v4l2/v4l2_camera.h b/src/v4l2/v4l2_camera.h index dbe0573b..a095f4e2 100644 --- a/src/v4l2/v4l2_camera.h +++ b/src/v4l2/v4l2_camera.h @@ -14,9 +14,9 @@ #include -#include #include #include +#include #include using namespace libcamera; diff --git a/test/mapped-buffer.cpp b/test/mapped-buffer.cpp index 5de8201e..c9479194 100644 --- a/test/mapped-buffer.cpp +++ b/test/mapped-buffer.cpp @@ -9,7 +9,7 @@ #include -#include "libcamera/internal/buffer.h" +#include "libcamera/internal/framebuffer.h" #include "camera_test.h" #include "test.h" diff --git a/test/v4l2_subdevice/v4l2_subdevice_test.h b/test/v4l2_subdevice/v4l2_subdevice_test.h index 00c6399d..e981abf7 100644 --- a/test/v4l2_subdevice/v4l2_subdevice_test.h +++ b/test/v4l2_subdevice/v4l2_subdevice_test.h @@ -8,7 +8,7 @@ #ifndef __LIBCAMERA_V4L2_SUBDEVICE_TEST_H__ #define __LIBCAMERA_V4L2_SUBDEVICE_TEST_H__ -#include +#include #include "libcamera/internal/device_enumerator.h" #include "libcamera/internal/media_device.h" diff --git a/test/v4l2_videodevice/buffer_sharing.cpp b/test/v4l2_videodevice/buffer_sharing.cpp index 91b3e4a0..6af96a98 100644 --- a/test/v4l2_videodevice/buffer_sharing.cpp +++ b/test/v4l2_videodevice/buffer_sharing.cpp @@ -12,7 +12,7 @@ #include -#include +#include #include #include diff --git a/test/v4l2_videodevice/capture_async.cpp b/test/v4l2_videodevice/capture_async.cpp index f12c8bef..805cb610 100644 --- a/test/v4l2_videodevice/capture_async.cpp +++ b/test/v4l2_videodevice/capture_async.cpp @@ -7,7 +7,7 @@ #include -#include +#include #include #include diff --git a/test/v4l2_videodevice/v4l2_m2mdevice.cpp b/test/v4l2_videodevice/v4l2_m2mdevice.cpp index fe4b3cc6..ebf3e245 100644 --- a/test/v4l2_videodevice/v4l2_m2mdevice.cpp +++ b/test/v4l2_videodevice/v4l2_m2mdevice.cpp @@ -7,7 +7,7 @@ #include -#include +#include #include #include diff --git a/test/v4l2_videodevice/v4l2_videodevice_test.h b/test/v4l2_videodevice/v4l2_videodevice_test.h index 21054561..d46540d4 100644 --- a/test/v4l2_videodevice/v4l2_videodevice_test.h +++ b/test/v4l2_videodevice/v4l2_videodevice_test.h @@ -9,7 +9,7 @@ #include -#include +#include #include "libcamera/internal/camera_sensor.h" #include "libcamera/internal/device_enumerator.h" -- cgit v1.2.1