Patch Detail
Show a patch.
GET /api/patches/23497/?format=api
{ "id": 23497, "url": "https://patchwork.libcamera.org/api/patches/23497/?format=api", "web_url": "https://patchwork.libcamera.org/patch/23497/", "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": "<20250606164156.1442682-17-barnabas.pocze@ideasonboard.com>", "date": "2025-06-06T16:41:49", "name": "[RFC,v1,16/23] guides: pipeline_handler: Document PipelineHandler::metadataAvailable", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": false, "hash": "35bf673b302fb19db354aaabb42a70e329d441d0", "submitter": { "id": 216, "url": "https://patchwork.libcamera.org/api/people/216/?format=api", "name": "Barnabás Pőcze", "email": "barnabas.pocze@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/23497/mbox/", "series": [ { "id": 5210, "url": "https://patchwork.libcamera.org/api/series/5210/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=5210", "date": "2025-06-06T16:41:33", "name": "libcamera: Add `MetadataList`", "version": 1, "mbox": "https://patchwork.libcamera.org/series/5210/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/23497/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/23497/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 60C7BC332D\n\tfor <parsemail@patchwork.libcamera.org>;\n\tFri, 6 Jun 2025 16:42:49 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id CB4D168DC9;\n\tFri, 6 Jun 2025 18:42:48 +0200 (CEST)", "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 6CD3D68DD0\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 6 Jun 2025 18:42:19 +0200 (CEST)", "from pb-laptop.local (185.182.215.79.nat.pool.zt.hu\n\t[185.182.215.79])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id E79496DC;\n\tFri, 6 Jun 2025 18:42:14 +0200 (CEST)" ], "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"O3tCDzf2\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1749228135;\n\tbh=5tsQOQ4pRrQ2k22MlYaRs2MsmppIelQld7OjJgwPHsg=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=O3tCDzf2D1C3ch1+vZw5N87WnbQ0GSwZyqkdbihdNy+piXcVDl5E4fFeOzpFOqUJb\n\tsuXzrZ/iEwggThcJoVRAps6h0HzSUnoqWEwJAPymKPJKOmUSLpq94uVaKujK5SwURY\n\tk4vhN60NzVclwdeewenRDMRwBzVOTpylXNvvMTiI=", "From": "=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= <barnabas.pocze@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Cc": "Jacopo Mondi <jacopo.mondi@ideasonboard.com>", "Subject": "[RFC PATCH v1 16/23] guides: pipeline_handler: Document\n\tPipelineHandler::metadataAvailable", "Date": "Fri, 6 Jun 2025 18:41:49 +0200", "Message-ID": "<20250606164156.1442682-17-barnabas.pocze@ideasonboard.com>", "X-Mailer": "git-send-email 2.49.0", "In-Reply-To": "<20250606164156.1442682-1-barnabas.pocze@ideasonboard.com>", "References": "<20250606164156.1442682-1-barnabas.pocze@ideasonboard.com>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=UTF-8", "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": "From: Jacopo Mondi <jacopo.mondi@ideasonboard.com>\n\nDocument the new available helpers to accumulate metadata results in\nRequest::metadata and notify applications about metadata availability.\n\nSigned-off-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>\nSigned-off-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>\n---\nOriginal: https://patchwork.libcamera.org/patch/22230/\n---\n Documentation/guides/pipeline-handler.rst | 26 ++++++++++++++++-------\n 1 file changed, 18 insertions(+), 8 deletions(-)", "diff": "diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst\nindex 0d5df7269..2b5e8414d 100644\n--- a/Documentation/guides/pipeline-handler.rst\n+++ b/Documentation/guides/pipeline-handler.rst\n@@ -1425,18 +1425,28 @@ classes documentation.\n .. _libcamera Signal and Slot: https://libcamera.org/api-html/classlibcamera_1_1Signal.html#details\n \n In order to notify applications about the availability of new frames and data,\n-the ``Camera`` device exposes two ``Signals`` to which applications can connect\n-to be notified of frame completion events. The ``bufferComplete`` signal serves\n-to report to applications the completion event of a single ``Stream`` part of a\n-``Request``, while the ``requestComplete`` signal notifies the completion of all\n-the ``Streams`` and data submitted as part of a request. This mechanism allows\n+the ``Camera`` device exposes three ``Signals`` to which applications can\n+connect to be notified of frame completion and metadata availability events.\n+\n+The ``metadataAvailable`` signal serves to notify about the availability of\n+metadata and accumulates metadata results in the list of metadata associated\n+with a ``Request``. The ``bufferComplete`` signal serves to report to\n+applications the completion event of a single ``Stream`` part of a ``Request``,\n+while the ``requestComplete`` signal notifies the completion of all the\n+``Streams`` and data submitted as part of a request. This mechanism allows\n implementation of partial request completion, which allows an application to\n inspect completed buffers associated with the single streams without waiting for\n all of them to be ready.\n \n-The ``bufferComplete`` and ``requestComplete`` signals are emitted by the\n-``Camera`` device upon notifications received from the pipeline handler, which\n-tracks the buffers and request completion status.\n+The ``metadataAvailable``, ``bufferComplete`` and ``requestComplete`` signals\n+are emitted by the ``Camera`` device upon notifications received from the\n+pipeline handler, which tracks the metadata, buffers and request completion\n+status.\n+\n+Metadata availability is signalled by the pipeline handlers by calling the\n+PipelineHandler base class ``metadataAvailable`` function. This function\n+notifies applications about metadata availability and accumulates metadata\n+results in the ``Request::metadata()`` list.\n \n The single buffer completion notification is implemented by pipeline handlers by\n `connecting`_ the ``bufferReady`` signal of the capture devices they have queued\n", "prefixes": [ "RFC", "v1", "16/23" ] }