{"id":2589,"url":"https://patchwork.libcamera.org/api/patches/2589/?format=json","web_url":"https://patchwork.libcamera.org/patch/2589/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20200112010212.2609025-8-niklas.soderlund@ragnatech.se>","date":"2020-01-12T01:01:47","name":"[libcamera-devel,v4,07/32] libcamera: buffer: Add FrameMetadata container for metadata information","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"a34e47792649a177dd4d1effdabe1dd11f2ceb89","submitter":{"id":5,"url":"https://patchwork.libcamera.org/api/people/5/?format=json","name":"Niklas Söderlund","email":"niklas.soderlund@ragnatech.se"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/2589/mbox/","series":[{"id":617,"url":"https://patchwork.libcamera.org/api/series/617/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=617","date":"2020-01-12T01:01:40","name":"libcamera: Rework buffer API","version":4,"mbox":"https://patchwork.libcamera.org/series/617/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/2589/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/2589/checks/","tags":{},"headers":{"Return-Path":"","Received":["from vsp-unauthed02.binero.net (vsp-unauthed02.binero.net\n\t[195.74.38.227])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id DC94A606E6\n\tfor ;\n\tSun, 12 Jan 2020 02:03:03 +0100 (CET)","from bismarck.berto.se (p54ac5d7b.dip0.t-ipconnect.de\n\t[84.172.93.123]) by bin-vsp-out-02.atm.binero.net (Halon) with ESMTPA\n\tid 46c8ceb6-34d7-11ea-b6d8-005056917f90;\n\tSun, 12 Jan 2020 02:03:00 +0100 (CET)"],"X-Halon-ID":"46c8ceb6-34d7-11ea-b6d8-005056917f90","Authorized-sender":"niklas@soderlund.pp.se","From":"=?utf-8?q?Niklas_S=C3=B6derlund?= ","To":"libcamera-devel@lists.libcamera.org","Date":"Sun, 12 Jan 2020 02:01:47 +0100","Message-Id":"<20200112010212.2609025-8-niklas.soderlund@ragnatech.se>","X-Mailer":"git-send-email 2.24.1","In-Reply-To":"<20200112010212.2609025-1-niklas.soderlund@ragnatech.se>","References":"<20200112010212.2609025-1-niklas.soderlund@ragnatech.se>","MIME-Version":"1.0","Content-Type":"text/plain; charset=UTF-8","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH v4 07/32] libcamera: buffer: Add\n\tFrameMetadata container for metadata information","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Sun, 12 Jan 2020 01:03:04 -0000"},"content":"With the introduction of FrameBuffer objects, the metadata information\nrelated to captured frames will not be stored directly in the frame\nbuffer object. Add a new FrameMetadata class to hold this information.\n\nSigned-off-by: Niklas Söderlund \nReviewed-by: Jacopo Mondi \nReviewed-by: Laurent Pinchart \n---\n* Changes since v3\n- Update comment for FrameMetadata::FrameCancelled\n\n* Changes since v2\n- Clarify documentation for values in enum FrameMetadata::Status members.\n- Improved documentation.\n- Added todo to improve FrameMetadata::timestamp descripton.\n\n* Changes since v1:\n- Rename BufferInfo to FrameMetadata\n- Rename prefix for BufferInfo::Status s/Buffer/Frame/\n- Make FrameMetadata a struct with public data members instead of a\n class with accessors methods.\n- Dropped FrameMetadata::update()\n- Documentation updates\n---\n include/libcamera/buffer.h | 17 +++++++++\n src/libcamera/buffer.cpp | 73 ++++++++++++++++++++++++++++++++++++++\n 2 files changed, 90 insertions(+)","diff":"diff --git a/include/libcamera/buffer.h b/include/libcamera/buffer.h\nindex 80602124f24be4a0..0b95e41a2dd205b2 100644\n--- a/include/libcamera/buffer.h\n+++ b/include/libcamera/buffer.h\n@@ -16,6 +16,23 @@ namespace libcamera {\n class Request;\n class Stream;\n \n+struct FrameMetadata {\n+\tenum Status {\n+\t\tFrameSuccess,\n+\t\tFrameError,\n+\t\tFrameCancelled,\n+\t};\n+\n+\tstruct Plane {\n+\t\tunsigned int bytesused;\n+\t};\n+\n+\tStatus status;\n+\tunsigned int sequence;\n+\tuint64_t timestamp;\n+\tstd::vector planes;\n+};\n+\n class Plane final\n {\n public:\ndiff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp\nindex 5305e3c391da6a69..360eb26cb4ca4906 100644\n--- a/src/libcamera/buffer.cpp\n+++ b/src/libcamera/buffer.cpp\n@@ -23,6 +23,79 @@ namespace libcamera {\n \n LOG_DEFINE_CATEGORY(Buffer)\n \n+/**\n+ * \\struct FrameMetadata\n+ * \\brief Metadata related to a captured frame\n+ *\n+ * The FrameMetadata structure stores all metadata related to a captured frame,\n+ * as stored in a FrameBuffer, such as capture status, timestamp and bytesused.\n+ */\n+\n+/**\n+ * \\enum FrameMetadata::Status\n+ * \\brief Define the frame completion status\n+ * \\var FrameMetadata::FrameSuccess\n+ * The frame has been captured with success and contains valid data. All fields\n+ * of the FrameMetadata structure are valid.\n+ * \\var FrameMetadata::FrameError\n+ * An error occurred during capture of the frame. The frame data may be partly\n+ * or fully invalid. The sequence and timestamp fields of the FrameMetadata\n+ * structure is valid, the other fields may be invalid.\n+ * \\var FrameMetadata::FrameCancelled\n+ * Capture stopped before the frame completed. The frame data is not valid. All\n+ * fields of the FrameMetadata structure but the status field are invalid.\n+ */\n+\n+/**\n+ * \\struct FrameMetadata::Plane\n+ * \\brief Per-plane frame metadata\n+ *\n+ * Frames are stored in memory in one or multiple planes. The\n+ * FrameMetadata::Plane structure stores per-plane metadata.\n+ */\n+\n+/**\n+ * \\var FrameMetadata::Plane::bytesused\n+ * \\brief Number of bytes occupied by the data in the plane, including line\n+ * padding\n+ *\n+ * This value may vary per frame for compressed formats. For uncompressed\n+ * formats it will be constant for all frames, but may be smaller than the\n+ * FrameBuffer size.\n+ */\n+\n+/**\n+ * \\var FrameMetadata::status\n+ * \\brief Status of the frame\n+ *\n+ * The validity of other fields of the FrameMetadata structure depends on the\n+ * status value.\n+ */\n+\n+/**\n+ * \\var FrameMetadata::sequence\n+ * \\brief Frame sequence number\n+ *\n+ * The sequence number is a monotonically increasing number assigned to the\n+ * frames captured by the stream. The value is increased by one for each frame.\n+ * Gaps in the sequence numbers indicate dropped frames.\n+ */\n+\n+/**\n+ * \\var FrameMetadata::timestamp\n+ * \\brief Time when the frame was captured\n+ *\n+ * The timestamp is expressed as a number of nanoseconds relative to the system\n+ * clock since an unspecified time point.\n+ *\n+ * \\todo Be more precise on what timestamps refer to.\n+ */\n+\n+/**\n+ * \\var FrameMetadata::planes\n+ * \\brief Array of per-plane metadata\n+ */\n+\n /**\n * \\class Plane\n * \\brief A memory region to store a single plane of a frame\n","prefixes":["libcamera-devel","v4","07/32"]}