Show a patch.

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

{
    "id": 24785,
    "url": "https://patchwork.libcamera.org/api/1.1/patches/24785/?format=api",
    "web_url": "https://patchwork.libcamera.org/patch/24785/",
    "project": {
        "id": 1,
        "url": "https://patchwork.libcamera.org/api/1.1/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": "<20251024085130.995967-20-stefan.klug@ideasonboard.com>",
    "date": "2025-10-24T08:50:43",
    "name": "[v1,19/35] libipa: algorithm: Update docs",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": false,
    "hash": "6b80e01871ac8f226b26f76493a01567c53189e2",
    "submitter": {
        "id": 184,
        "url": "https://patchwork.libcamera.org/api/1.1/people/184/?format=api",
        "name": "Stefan Klug",
        "email": "stefan.klug@ideasonboard.com"
    },
    "delegate": null,
    "mbox": "https://patchwork.libcamera.org/patch/24785/mbox/",
    "series": [
        {
            "id": 5524,
            "url": "https://patchwork.libcamera.org/api/1.1/series/5524/?format=api",
            "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=5524",
            "date": "2025-10-24T08:50:24",
            "name": "rkisp1: pipeline rework for PFC",
            "version": 1,
            "mbox": "https://patchwork.libcamera.org/series/5524/mbox/"
        }
    ],
    "comments": "https://patchwork.libcamera.org/api/patches/24785/comments/",
    "check": "pending",
    "checks": "https://patchwork.libcamera.org/api/patches/24785/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 94957C3259\n\tfor <parsemail@patchwork.libcamera.org>;\n\tFri, 24 Oct 2025 08:52:36 +0000 (UTC)",
            "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 5AEED608D7;\n\tFri, 24 Oct 2025 10:52:36 +0200 (CEST)",
            "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 5C181608C7\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 24 Oct 2025 10:52:34 +0200 (CEST)",
            "from ideasonboard.com (unknown\n\t[IPv6:2a00:6020:448c:6c00:7edc:62f4:c118:1549])\n\tby perceval.ideasonboard.com (Postfix) with UTF8SMTPSA id D533B1AC5; \n\tFri, 24 Oct 2025 10:50:48 +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=\"UapTTehl\"; dkim-atps=neutral",
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1761295848;\n\tbh=R0HNYlAm9anXPL+QWSNQzkAwChXqdCez6wzkOG1DYqA=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=UapTTehlW3lzVtTtSE+3uxcwGtqW/tk9DWzsCrnX55IxrAVEWWDbbkyAGIdWIroB8\n\tT3OjQhknzhjgw6XbOiErXVKL+t+Jl3p+V0FF00zXIFd7AS7E/6wbVHYfm1icTLw8j8\n\t41lUV75qKBOF0nqGjKNuEx+14NiwKVo8yhOM1zi0=",
        "From": "Stefan Klug <stefan.klug@ideasonboard.com>",
        "To": "libcamera-devel@lists.libcamera.org",
        "Cc": "Stefan Klug <stefan.klug@ideasonboard.com>",
        "Subject": "[PATCH v1 19/35] libipa: algorithm: Update docs",
        "Date": "Fri, 24 Oct 2025 10:50:43 +0200",
        "Message-ID": "<20251024085130.995967-20-stefan.klug@ideasonboard.com>",
        "X-Mailer": "git-send-email 2.48.1",
        "In-Reply-To": "<20251024085130.995967-1-stefan.klug@ideasonboard.com>",
        "References": "<20251024085130.995967-1-stefan.klug@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": "Update the algorithm documentation to reflect the changed timing model.\n\nSigned-off-by: Stefan Klug <stefan.klug@ideasonboard.com>\n---\n src/ipa/libipa/algorithm.cpp | 28 ++++++++++++++--------------\n 1 file changed, 14 insertions(+), 14 deletions(-)",
    "diff": "diff --git a/src/ipa/libipa/algorithm.cpp b/src/ipa/libipa/algorithm.cpp\nindex 201efdfdba25..44b6bdfa6972 100644\n--- a/src/ipa/libipa/algorithm.cpp\n+++ b/src/ipa/libipa/algorithm.cpp\n@@ -76,11 +76,12 @@ namespace ipa {\n  *\n  * This function is called for each request queued to the camera. It provides\n  * the controls stored in the request to the algorithm. The \\a frame number\n- * is the Request sequence number and identifies the desired corresponding\n+ * is the sensor sequence number and identifies the desired corresponding\n  * frame to target for the controls to take effect.\n  *\n  * Algorithms shall read the applicable controls and store their value for later\n- * use during frame processing.\n+ * use during frame processing. All values that are already known shall be\n+ * updated in \\a frameContext.\n  */\n \n /**\n@@ -98,14 +99,18 @@ namespace ipa {\n  * Algorithms shall fill in the parameter structure fields appropriately to\n  * configure the ISP processing blocks that they are responsible for. This\n  * includes setting fields and flags that enable those processing blocks.\n+ *\n+ * Additionally \\a frameContext shall be updated with the most up to date values\n+ * from active state.\n  */\n \n /**\n  * \\fn Algorithm::process()\n  * \\brief Process ISP statistics, and run algorithm operations\n  * \\param[in] context The shared IPA context\n- * \\param[in] frame The frame context sequence number\n- * \\param[in] frameContext The current frame's context\n+ * \\param[in] frame The frame sequence number that produces the stats\n+ * \\param[in] frameContext The frame context for the frame that produced the\n+ * stats\n  * \\param[in] stats The IPA statistics and ISP results\n  * \\param[out] metadata Metadata for the frame, to be filled by the algorithm\n  *\n@@ -118,19 +123,14 @@ namespace ipa {\n  * computationally expensive calculations or operations must be handled\n  * asynchronously in a separate thread.\n  *\n- * Algorithms can store state in their respective IPAFrameContext structures,\n- * and reference state from the IPAFrameContext of other algorithms.\n- *\n- * \\todo Historical data may be required as part of the processing.\n- * Either the previous frame, or the IPAFrameContext state of the frame\n- * that generated the statistics for this operation may be required for\n- * some advanced algorithms to prevent oscillations or support control\n- * loops correctly. Only a single IPAFrameContext is available currently,\n- * and so any data stored may represent the results of the previously\n- * completed operations.\n+ * Algorithms shall update the active state. The frameContext shall *not* be\n+ * updated as that frame was already produced.\n  *\n  * Care shall be taken to ensure the ordering of access to the information\n  * such that the algorithms use up to date state as required.\n+ *\n+ * The \\a stats parameter can be null in which case ony the frame metadata shall\n+ * be filled.\n  */\n \n /**\n",
    "prefixes": [
        "v1",
        "19/35"
    ]
}