{"id":2451,"url":"https://patchwork.libcamera.org/api/1.1/patches/2451/?format=json","web_url":"https://patchwork.libcamera.org/patch/2451/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/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":"<20191230120510.938333-2-niklas.soderlund@ragnatech.se>","date":"2019-12-30T12:04:46","name":"[libcamera-devel,v2,01/25] libcamera: buffer: Add FrameMetadata container for metadata information","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"7c08bbf6e3857de22f34fff29984e1cbffd1e056","submitter":{"id":5,"url":"https://patchwork.libcamera.org/api/1.1/people/5/?format=json","name":"Niklas Söderlund","email":"niklas.soderlund@ragnatech.se"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/2451/mbox/","series":[{"id":593,"url":"https://patchwork.libcamera.org/api/1.1/series/593/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=593","date":"2019-12-30T12:04:45","name":"libcamera: Rework buffer API","version":2,"mbox":"https://patchwork.libcamera.org/series/593/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/2451/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/2451/checks/","tags":{},"headers":{"Return-Path":"<niklas.soderlund@ragnatech.se>","Received":["from bin-mail-out-05.binero.net (bin-mail-out-05.binero.net\n\t[195.74.38.228])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 3AAE86046B\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 30 Dec 2019 13:05:50 +0100 (CET)","from bismarck.berto.se (p4fca2fd0.dip0.t-ipconnect.de\n\t[79.202.47.208]) by bin-vsp-out-01.atm.binero.net (Halon) with ESMTPA\n\tid b7b22477-2afc-11ea-a00b-005056917a89;\n\tMon, 30 Dec 2019 13:05:49 +0100 (CET)"],"X-Halon-ID":"b7b22477-2afc-11ea-a00b-005056917a89","Authorized-sender":"niklas@soderlund.pp.se","From":"=?utf-8?q?Niklas_S=C3=B6derlund?= <niklas.soderlund@ragnatech.se>","To":"libcamera-devel@lists.libcamera.org","Date":"Mon, 30 Dec 2019 13:04:46 +0100","Message-Id":"<20191230120510.938333-2-niklas.soderlund@ragnatech.se>","X-Mailer":"git-send-email 2.24.1","In-Reply-To":"<20191230120510.938333-1-niklas.soderlund@ragnatech.se>","References":"<20191230120510.938333-1-niklas.soderlund@ragnatech.se>","MIME-Version":"1.0","Content-Type":"text/plain; charset=UTF-8","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH v2 01/25] 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":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","X-List-Received-Date":"Mon, 30 Dec 2019 12:05:50 -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 <niklas.soderlund@ragnatech.se>\nReviewed-by: Jacopo Mondi <jacopo@jmondi.org>\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   | 62 ++++++++++++++++++++++++++++++++++++++\n 2 files changed, 79 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<Plane> planes;\n+};\n+\n class Plane final\n {\n public:\ndiff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp\nindex 960eeb8f7d193ddd..7673b96f29728a24 100644\n--- a/src/libcamera/buffer.cpp\n+++ b/src/libcamera/buffer.cpp\n@@ -23,6 +23,68 @@ 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 or memory size.\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 and metadata\n+ * \\var FrameMetadata::FrameError\n+ * The frame has been captured with an error and doesn't contain valid metadata\n+ * \\var FrameMetadata::FrameCancelled\n+ * The frame has been cancelled and doesn't contain valid metadata\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 FrameInfo::Plane\n+ * structure stores per-plane metadata for each plane.\n+ */\n+\n+/**\n+ * \\var FrameMetadata::Plane::bytesused\n+ * \\brief Number of bytes occupied by the data in the plane\n+ */\n+\n+/**\n+ * \\var FrameMetadata::status\n+ * \\brief Status of the frame\n+ *\n+ * Values in the container are only valid when the status is\n+ * FrameMetadata::FrameSuccess.\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+ * buffer processed by the stream. Gaps in the sequence numbers indicate\n+ * 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+\n+/**\n+ * \\var FrameMetadata::planes\n+ * \\brief Array holding plane specific metadata\n+ */\n+\n /**\n  * \\class Plane\n  * \\brief A memory region to store a single plane of a frame\n","prefixes":["libcamera-devel","v2","01/25"]}