Show a patch.

GET /api/patches/22232/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 22232,
    "url": "https://patchwork.libcamera.org/api/patches/22232/?format=api",
    "web_url": "https://patchwork.libcamera.org/patch/22232/",
    "project": {
        "id": 1,
        "url": "https://patchwork.libcamera.org/api/projects/1/?format=api",
        "name": "libcamera",
        "link_name": "libcamera",
        "list_id": "libcamera_core",
        "list_email": "libcamera-devel@lists.libcamera.org",
        "web_url": "",
        "scm_url": "",
        "webscm_url": ""
    },
    "msgid": "<20241206160747.97176-7-jacopo.mondi@ideasonboard.com>",
    "date": "2024-12-06T16:07:44",
    "name": "[6/8] libcamera: pipelines: Use the metadataAvailable() function",
    "commit_ref": null,
    "pull_url": null,
    "state": "new",
    "archived": false,
    "hash": "38540657a69e37282a576e64c0e5b5d4c358a299",
    "submitter": {
        "id": 143,
        "url": "https://patchwork.libcamera.org/api/people/143/?format=api",
        "name": "Jacopo Mondi",
        "email": "jacopo.mondi@ideasonboard.com"
    },
    "delegate": null,
    "mbox": "https://patchwork.libcamera.org/patch/22232/mbox/",
    "series": [
        {
            "id": 4858,
            "url": "https://patchwork.libcamera.org/api/series/4858/?format=api",
            "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4858",
            "date": "2024-12-06T16:07:38",
            "name": "libcamera: Support partial metadata completion",
            "version": 1,
            "mbox": "https://patchwork.libcamera.org/series/4858/mbox/"
        }
    ],
    "comments": "https://patchwork.libcamera.org/api/patches/22232/comments/",
    "check": "pending",
    "checks": "https://patchwork.libcamera.org/api/patches/22232/checks/",
    "tags": {},
    "headers": {
        "Return-Path": "<libcamera-devel-bounces@lists.libcamera.org>",
        "X-Original-To": "parsemail@patchwork.libcamera.org",
        "Delivered-To": "parsemail@patchwork.libcamera.org",
        "Received": [
            "from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id C650BBE173\n\tfor <parsemail@patchwork.libcamera.org>;\n\tFri,  6 Dec 2024 16:08:10 +0000 (UTC)",
            "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 750B367E29;\n\tFri,  6 Dec 2024 17:08:04 +0100 (CET)",
            "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 39DFA67E26\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri,  6 Dec 2024 17:07:57 +0100 (CET)",
            "from ideasonboard.com (93-61-96-190.ip145.fastwebnet.it\n\t[93.61.96.190])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 88C2E641;\n\tFri,  6 Dec 2024 17:07:27 +0100 (CET)"
        ],
        "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"jBU05jmS\"; dkim-atps=neutral",
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1733501247;\n\tbh=GsXDkO6QzTsxYoOVvulLLbpd/cOv5xJXwg2bazdYSs0=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=jBU05jmSwB2ofhf2Hnu3rUrww7BnJOamT/8PgZvp5CxiLNJr7VSBc5C4fB3BMhwpY\n\tFm+WOE1JV4vM8v04FPfJOUjeYpTz/X1aD+BP+GPzcwPsRMQZCdZuV2RQ77I3rGlG6Z\n\t4Z4QBpClhYw8Y7+RWAvQO1B8C8c7ZvwXsurcxbMk=",
        "From": "Jacopo Mondi <jacopo.mondi@ideasonboard.com>",
        "To": "libcamera-devel@lists.libcamera.org",
        "Cc": "Jacopo Mondi <jacopo.mondi@ideasonboard.com>,\n\tHarvey Yang <chenghaoyang@chromium.org>,\n\tHan-Lin Chen <hanlinchen@chromium.org>",
        "Subject": "[PATCH 6/8] libcamera: pipelines: Use the metadataAvailable()\n\tfunction",
        "Date": "Fri,  6 Dec 2024 17:07:44 +0100",
        "Message-ID": "<20241206160747.97176-7-jacopo.mondi@ideasonboard.com>",
        "X-Mailer": "git-send-email 2.47.1",
        "In-Reply-To": "<20241206160747.97176-1-jacopo.mondi@ideasonboard.com>",
        "References": "<20241206160747.97176-1-jacopo.mondi@ideasonboard.com>",
        "MIME-Version": "1.0",
        "Content-Transfer-Encoding": "8bit",
        "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>",
        "Errors-To": "libcamera-devel-bounces@lists.libcamera.org",
        "Sender": "\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"
    },
    "content": "In order to prepare to restrict access to the Request::metadata_\nlist, use the new PipelineHandler::metadataAvailable() function\nto notify the availability of metadata and accumulate them in\nthe Request::metadata_ list.\n\nSigned-off-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>\n---\n src/libcamera/pipeline/imx8-isi/imx8-isi.cpp       |  6 ++----\n src/libcamera/pipeline/ipu3/ipu3.cpp               | 14 +++++++-------\n src/libcamera/pipeline/rkisp1/rkisp1.cpp           |  8 ++++----\n .../pipeline/rpi/common/pipeline_base.cpp          | 12 ++++++------\n src/libcamera/pipeline/simple/simple.cpp           |  4 ++--\n src/libcamera/pipeline/uvcvideo/uvcvideo.cpp       |  4 ++--\n src/libcamera/pipeline/vimc/vimc.cpp               |  4 ++--\n src/libcamera/pipeline/virtual/virtual.cpp         |  3 ++-\n 8 files changed, 27 insertions(+), 28 deletions(-)",
    "diff": "diff --git a/src/libcamera/pipeline/imx8-isi/imx8-isi.cpp b/src/libcamera/pipeline/imx8-isi/imx8-isi.cpp\nindex 4e66b3368d5a..5588f4a05446 100644\n--- a/src/libcamera/pipeline/imx8-isi/imx8-isi.cpp\n+++ b/src/libcamera/pipeline/imx8-isi/imx8-isi.cpp\n@@ -1099,10 +1099,8 @@ void PipelineHandlerISI::bufferReady(FrameBuffer *buffer)\n \tRequest *request = buffer->request();\n \n \t/* Record the sensor's timestamp in the request metadata. */\n-\tControlList &metadata = request->metadata();\n-\tif (!metadata.contains(controls::SensorTimestamp.id()))\n-\t\tmetadata.set(controls::SensorTimestamp,\n-\t\t\t     buffer->metadata().timestamp);\n+\tmetadataAvailable(request, controls::SensorTimestamp,\n+\t\t\t  static_cast<int64_t>(buffer->metadata().timestamp));\n \n \tcompleteBuffer(request, buffer);\n \tif (request->hasPendingBuffers())\ndiff --git a/src/libcamera/pipeline/ipu3/ipu3.cpp b/src/libcamera/pipeline/ipu3/ipu3.cpp\nindex e31e3879dcc9..bf1119bea567 100644\n--- a/src/libcamera/pipeline/ipu3/ipu3.cpp\n+++ b/src/libcamera/pipeline/ipu3/ipu3.cpp\n@@ -1245,7 +1245,7 @@ void IPU3CameraData::metadataReady(unsigned int id, const ControlList &metadata)\n \t\treturn;\n \n \tRequest *request = info->request;\n-\trequest->metadata().merge(metadata);\n+\tpipe()->metadataAvailable(request, metadata);\n \n \tinfo->metadataProcessed = true;\n \tif (frameInfos_.tryComplete(info))\n@@ -1272,12 +1272,12 @@ void IPU3CameraData::imguOutputBufferReady(FrameBuffer *buffer)\n \n \tpipe()->completeBuffer(request, buffer);\n \n-\trequest->metadata().set(controls::draft::PipelineDepth, 3);\n+\tpipe()->metadataAvailable(request, controls::draft::PipelineDepth, 3);\n \t/* \\todo Actually apply the scaler crop region to the ImgU. */\n \tconst auto &scalerCrop = request->controls().get(controls::ScalerCrop);\n \tif (scalerCrop)\n \t\tcropRegion_ = *scalerCrop;\n-\trequest->metadata().set(controls::ScalerCrop, cropRegion_);\n+\tpipe()->metadataAvailable(request, controls::ScalerCrop, cropRegion_);\n \n \tif (frameInfos_.tryComplete(info))\n \t\tpipe()->completeRequest(request);\n@@ -1317,8 +1317,8 @@ void IPU3CameraData::cio2BufferReady(FrameBuffer *buffer)\n \t * \\todo The sensor timestamp should be better estimated by connecting\n \t * to the V4L2Device::frameStart signal.\n \t */\n-\trequest->metadata().set(controls::SensorTimestamp,\n-\t\t\t\tbuffer->metadata().timestamp);\n+\tpipe()->metadataAvailable(request, controls::SensorTimestamp,\n+\t\t\t\t  static_cast<int64_t>(buffer->metadata().timestamp));\n \n \tinfo->effectiveSensorControls = delayedCtrls_->get(buffer->metadata().sequence);\n \n@@ -1412,8 +1412,8 @@ void IPU3CameraData::frameStart(uint32_t sequence)\n \t\treturn;\n \t}\n \n-\trequest->metadata().set(controls::draft::TestPatternMode,\n-\t\t\t\t*testPatternMode);\n+\tpipe()->metadataAvailable(request, controls::draft::TestPatternMode,\n+\t\t\t\t  *testPatternMode);\n }\n \n REGISTER_PIPELINE_HANDLER(PipelineHandlerIPU3, \"ipu3\")\ndiff --git a/src/libcamera/pipeline/rkisp1/rkisp1.cpp b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\nindex 908724e20975..8c66f0fc11b4 100644\n--- a/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n+++ b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n@@ -431,7 +431,7 @@ void RkISP1CameraData::metadataReady(unsigned int frame, const ControlList &meta\n \tif (!info)\n \t\treturn;\n \n-\tinfo->request->metadata().merge(metadata);\n+\tpipe()->metadataAvailable(info->request, metadata);\n \tinfo->metadataProcessed = true;\n \n \tpipe()->tryCompleteRequest(info);\n@@ -1414,8 +1414,8 @@ void PipelineHandlerRkISP1::imageBufferReady(FrameBuffer *buffer)\n \t\t * \\todo The sensor timestamp should be better estimated by connecting\n \t\t * to the V4L2Device::frameStart signal.\n \t\t */\n-\t\trequest->metadata().set(controls::SensorTimestamp,\n-\t\t\t\t\tmetadata.timestamp);\n+\t\tmetadataAvailable(request, controls::SensorTimestamp,\n+\t\t\t\t  static_cast<int64_t>(metadata.timestamp));\n \n \t\tif (isRaw_) {\n \t\t\tconst ControlList &ctrls =\n@@ -1487,7 +1487,7 @@ void PipelineHandlerRkISP1::imageBufferReady(FrameBuffer *buffer)\n \t\tLOG(RkISP1, Error) << \"Cannot queue buffers to dewarper: \"\n \t\t\t\t   << strerror(-ret);\n \n-\trequest->metadata().set(controls::ScalerCrop, activeCrop_.value());\n+\tmetadataAvailable(request, controls::ScalerCrop, activeCrop_.value());\n }\n \n void PipelineHandlerRkISP1::dewarpBufferReady(FrameBuffer *buffer)\ndiff --git a/src/libcamera/pipeline/rpi/common/pipeline_base.cpp b/src/libcamera/pipeline/rpi/common/pipeline_base.cpp\nindex 6f278b29331a..8bfca6d2890d 100644\n--- a/src/libcamera/pipeline/rpi/common/pipeline_base.cpp\n+++ b/src/libcamera/pipeline/rpi/common/pipeline_base.cpp\n@@ -1234,7 +1234,7 @@ void CameraData::metadataReady(const ControlList &metadata)\n \t/* Add to the Request metadata buffer what the IPA has provided. */\n \t/* Last thing to do is to fill up the request metadata. */\n \tRequest *request = requestQueue_.front();\n-\trequest->metadata().merge(metadata);\n+\tpipe()->metadataAvailable(request, metadata);\n \n \t/*\n \t * Inform the sensor of the latest colour gains if it has the\n@@ -1507,8 +1507,8 @@ void CameraData::checkRequestCompleted()\n \n void CameraData::fillRequestMetadata(const ControlList &bufferControls, Request *request)\n {\n-\trequest->metadata().set(controls::SensorTimestamp,\n-\t\t\t\tbufferControls.get(controls::SensorTimestamp).value_or(0));\n+\tpipe()->metadataAvailable(request, controls::SensorTimestamp,\n+\t\t  static_cast<int64_t>(bufferControls.get(controls::SensorTimestamp).value_or(0)));\n \n \tif (cropParams_.size()) {\n \t\tstd::vector<Rectangle> crops;\n@@ -1516,10 +1516,10 @@ void CameraData::fillRequestMetadata(const ControlList &bufferControls, Request\n \t\tfor (auto const &[k, v] : cropParams_)\n \t\t\tcrops.push_back(scaleIspCrop(v.ispCrop));\n \n-\t\trequest->metadata().set(controls::ScalerCrop, crops[0]);\n+\t\tpipe()->metadataAvailable(request, controls::ScalerCrop, crops[0]);\n \t\tif (crops.size() > 1) {\n-\t\t\trequest->metadata().set(controls::rpi::ScalerCrops,\n-\t\t\t\t\t\tSpan<const Rectangle>(crops.data(), crops.size()));\n+\t\t\tpipe()->metadataAvailable(request, controls::rpi::ScalerCrops,\n+\t\t\t\t\t\t  Span<const Rectangle>(crops.data(), crops.size()));\n \t\t}\n \t}\n }\ndiff --git a/src/libcamera/pipeline/simple/simple.cpp b/src/libcamera/pipeline/simple/simple.cpp\nindex 8ac24e6e3423..0a68e454b3e4 100644\n--- a/src/libcamera/pipeline/simple/simple.cpp\n+++ b/src/libcamera/pipeline/simple/simple.cpp\n@@ -844,8 +844,8 @@ void SimpleCameraData::imageBufferReady(FrameBuffer *buffer)\n \t}\n \n \tif (request)\n-\t\trequest->metadata().set(controls::SensorTimestamp,\n-\t\t\t\t\tbuffer->metadata().timestamp);\n+\t\tpipe->metadataAvailable(request, controls::SensorTimestamp,\n+\t\t\t\t\tstatic_cast<int64_t>(buffer->metadata().timestamp));\n \n \t/*\n \t * Queue the captured and the request buffer to the converter or Software\ndiff --git a/src/libcamera/pipeline/uvcvideo/uvcvideo.cpp b/src/libcamera/pipeline/uvcvideo/uvcvideo.cpp\nindex 8c2c6baf3575..7fe607972a73 100644\n--- a/src/libcamera/pipeline/uvcvideo/uvcvideo.cpp\n+++ b/src/libcamera/pipeline/uvcvideo/uvcvideo.cpp\n@@ -752,8 +752,8 @@ void UVCCameraData::imageBufferReady(FrameBuffer *buffer)\n \tRequest *request = buffer->request();\n \n \t/* \\todo Use the UVC metadata to calculate a more precise timestamp */\n-\trequest->metadata().set(controls::SensorTimestamp,\n-\t\t\t\tbuffer->metadata().timestamp);\n+\tpipe()->metadataAvailable(request, controls::SensorTimestamp,\n+\t\t\t\t  static_cast<int64_t>(buffer->metadata().timestamp));\n \n \tpipe()->completeBuffer(request, buffer);\n \tpipe()->completeRequest(request);\ndiff --git a/src/libcamera/pipeline/vimc/vimc.cpp b/src/libcamera/pipeline/vimc/vimc.cpp\nindex 07273bd2b6c3..56b9d3c1ed69 100644\n--- a/src/libcamera/pipeline/vimc/vimc.cpp\n+++ b/src/libcamera/pipeline/vimc/vimc.cpp\n@@ -615,8 +615,8 @@ void VimcCameraData::imageBufferReady(FrameBuffer *buffer)\n \t}\n \n \t/* Record the sensor's timestamp in the request metadata. */\n-\trequest->metadata().set(controls::SensorTimestamp,\n-\t\t\t\tbuffer->metadata().timestamp);\n+\tpipe->metadataAvailable(request, controls::SensorTimestamp,\n+\t\t\t\tstatic_cast<int64_t>(buffer->metadata().timestamp));\n \n \tpipe->completeBuffer(request, buffer);\n \tpipe->completeRequest(request);\ndiff --git a/src/libcamera/pipeline/virtual/virtual.cpp b/src/libcamera/pipeline/virtual/virtual.cpp\nindex cec8a85bf22c..695e2650e10f 100644\n--- a/src/libcamera/pipeline/virtual/virtual.cpp\n+++ b/src/libcamera/pipeline/virtual/virtual.cpp\n@@ -317,7 +317,8 @@ int PipelineHandlerVirtual::queueRequestDevice([[maybe_unused]] Camera *camera,\n \t\tASSERT(found);\n \t}\n \n-\trequest->metadata().set(controls::SensorTimestamp, currentTimestamp());\n+\tmetadataAvailable(request, controls::SensorTimestamp,\n+\t\t\t  static_cast<int64_t>(currentTimestamp()));\n \tcompleteRequest(request);\n \n \treturn 0;\n",
    "prefixes": [
        "6/8"
    ]
}