Show a patch.

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

{
    "id": 22115,
    "url": "https://patchwork.libcamera.org/api/patches/22115/?format=api",
    "web_url": "https://patchwork.libcamera.org/patch/22115/",
    "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": "<20241127092632.3145984-5-chenghaoyang@chromium.org>",
    "date": "2024-11-27T09:25:54",
    "name": "[v2,4/9] android: Migrate StreamBuffer::internalBuffer to Camera3RequestDescriptor",
    "commit_ref": null,
    "pull_url": null,
    "state": "new",
    "archived": false,
    "hash": "7c22a7a42c6af11ea6a2cc507e97cfafd51b29b5",
    "submitter": {
        "id": 117,
        "url": "https://patchwork.libcamera.org/api/people/117/?format=api",
        "name": "Cheng-Hao Yang",
        "email": "chenghaoyang@chromium.org"
    },
    "delegate": null,
    "mbox": "https://patchwork.libcamera.org/patch/22115/mbox/",
    "series": [
        {
            "id": 4828,
            "url": "https://patchwork.libcamera.org/api/series/4828/?format=api",
            "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4828",
            "date": "2024-11-27T09:25:50",
            "name": "Signal metadataAvailable and Android partial result",
            "version": 2,
            "mbox": "https://patchwork.libcamera.org/series/4828/mbox/"
        }
    ],
    "comments": "https://patchwork.libcamera.org/api/patches/22115/comments/",
    "check": "pending",
    "checks": "https://patchwork.libcamera.org/api/patches/22115/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 1563DC3213\n\tfor <parsemail@patchwork.libcamera.org>;\n\tWed, 27 Nov 2024 09:26:54 +0000 (UTC)",
            "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id C8D07660C2;\n\tWed, 27 Nov 2024 10:26:53 +0100 (CET)",
            "from mail-ot1-x32c.google.com (mail-ot1-x32c.google.com\n\t[IPv6:2607:f8b0:4864:20::32c])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 366F9660BF\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 27 Nov 2024 10:26:45 +0100 (CET)",
            "by mail-ot1-x32c.google.com with SMTP id\n\t46e09a7af769-71d554dedc6so1265692a34.1\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 27 Nov 2024 01:26:45 -0800 (PST)",
            "from chenghaoyang-low.c.googlers.com.com\n\t(27.247.221.35.bc.googleusercontent.com. [35.221.247.27])\n\tby smtp.gmail.com with ESMTPSA id\n\t41be03b00d2f7-7fbcbfc41f9sm8693027a12.8.2024.11.27.01.26.42\n\t(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n\tWed, 27 Nov 2024 01:26:43 -0800 (PST)"
        ],
        "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=chromium.org header.i=@chromium.org\n\theader.b=\"UmKjDph6\"; dkim-atps=neutral",
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=chromium.org; s=google; t=1732699604; x=1733304404;\n\tdarn=lists.libcamera.org; \n\th=content-transfer-encoding:mime-version:references:in-reply-to\n\t:message-id:date:subject:cc:to:from:from:to:cc:subject:date\n\t:message-id:reply-to;\n\tbh=kAnvO/uH9Pu56foWQBN126UILV1EQphGGewh74RvqyA=;\n\tb=UmKjDph6ERLdz627fzUkmT78sMMZ9meLpNAUzER4wH8WNhwYlzsaVQgcpmZkMpw5JS\n\twuG1QY+erYOdt5mskt4jRV/icqm/ciFzBdvJQ4ydosHjdbATUoKy6Np7bZg6m5msHul8\n\tXE601k+KPKHqLpMKHL6yJ0xPN21J9YmzbAZhI=",
        "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20230601; t=1732699604; x=1733304404;\n\th=content-transfer-encoding:mime-version:references:in-reply-to\n\t:message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc\n\t:subject:date:message-id:reply-to;\n\tbh=kAnvO/uH9Pu56foWQBN126UILV1EQphGGewh74RvqyA=;\n\tb=eEoSicBijKLrG8bB1D2goZ/RvdiUqDZpj4SsjsYvSH1FsqNUcoZsKv6wOlQJO8WTN1\n\tNrwARhV4H1pJpEVtsweoQtx7D5aQVORWQcTvfHDWbBbRXWJLoyZwjZfaVuEqdaPrU2TQ\n\tivrFVu0UJbzkyRlp2pQSyOcGMEV5CIJjhEKixFc102MfecIR9H10St8AEqsDvj1x4Y2f\n\tmEG2dQpyraUDog0/vMyNrlurI0r8C0y4kfWJKW2HXvpXzdEnrNrjWpKZg07WsROEdr9t\n\ts480NT5mwvZ3c7Pnh4q4Fz73z5LzwyaJKAz3W3PmKaKF2BKKo4CR7Ngzmt0q4Vv5zV05\n\txCCw==",
        "X-Gm-Message-State": "AOJu0Ywt1aeE+72Xf1A0Je2oMLYqJPl/o4y991CRWPOs37Jfvvu3EvgR\n\tNDAkJK0jRv9rWtPVz9HYHozMoJgBVsQhkZGrTMTQBUR5dombWRsKsORJtv82+I7swPajEKacPCY\n\t=",
        "X-Gm-Gg": "ASbGncsMqFwSPW8QBoGwQ8vu5ALpvNcfaIfcWGMO/c5i5yjMNLD9W7y3wEjmwR1MGhw\n\t2YH7YbLpt2TMQefyNAf1QDmv1W90Q2umTgjlhnq/kCnB9YroKw5sVkN5SeZRmQX2oU+qFX+7POy\n\tOxvbL7dEQODLWGgZ8u8nDvHLfx/Z4VwNo8fDPndE/hMEV6T7jlmShR2ROgI9g6h72ZOa77lwHQf\n\t1Ats8rNWnoF3OPAPa8WisPb78TnxVCARiMO0dhLcW0pgqjjg6XKGWVxPIeN/DcRcYsVWhB8weRE\n\tDHPfKpGVI2N138Roix1XK5ukmiw5JqprwT0zi36PvdIZK1nEbqvfOw==",
        "X-Google-Smtp-Source": "AGHT+IG1POox6Chy0wKAmoDBhSATg6WuLQ0htCvG79teD0c8dDEKe60LndYub7JwDianEcpKTyKzzQ==",
        "X-Received": "by 2002:a05:6830:258a:b0:71d:5a17:75c6 with SMTP id\n\t46e09a7af769-71d65d2a90fmr2240309a34.29.1732699603649; \n\tWed, 27 Nov 2024 01:26:43 -0800 (PST)",
        "From": "Harvey Yang <chenghaoyang@chromium.org>",
        "To": "libcamera-devel@lists.libcamera.org",
        "Cc": "Harvey Yang <chenghaoyang@chromium.org>,\n\tHan-Lin Chen <hanlinchen@chromium.org>",
        "Subject": "[PATCH v2 4/9] android: Migrate StreamBuffer::internalBuffer to\n\tCamera3RequestDescriptor",
        "Date": "Wed, 27 Nov 2024 09:25:54 +0000",
        "Message-ID": "<20241127092632.3145984-5-chenghaoyang@chromium.org>",
        "X-Mailer": "git-send-email 2.47.0.338.g60cca15819-goog",
        "In-Reply-To": "<20241127092632.3145984-1-chenghaoyang@chromium.org>",
        "References": "<20241127092632.3145984-1-chenghaoyang@chromium.org>",
        "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": "Previously there's a potential issue in StreamBuffer::internalBuffer's\nlifetime, when more than one streams depend on the same internal buffer.\n\nThis patch fixes the issue by returning the buffer when the whole\nCamera3RequestDescriptor is destructed.\n\nSigned-off-by: Han-Lin Chen <hanlinchen@chromium.org>\nCo-developed-by: Harvey Yang <chenghaoyang@chromium.org>\nSigned-off-by: Harvey Yang <chenghaoyang@chromium.org>\n---\n src/android/camera_device.cpp  | 63 +++++++++++++++++++---------------\n src/android/camera_request.cpp | 13 ++++---\n src/android/camera_request.h   |  3 +-\n 3 files changed, 46 insertions(+), 33 deletions(-)",
    "diff": "diff --git a/src/android/camera_device.cpp b/src/android/camera_device.cpp\nindex 11613fac9..62f724041 100644\n--- a/src/android/camera_device.cpp\n+++ b/src/android/camera_device.cpp\n@@ -967,9 +967,10 @@ int CameraDevice::processCaptureRequest(camera3_capture_request_t *camera3Reques\n \t * to a libcamera stream. Streams of type Mapped will be handled later.\n \t *\n \t * Collect the CameraStream associated to each requested capture stream.\n-\t * Since requestedStreams is an std:map<>, no duplications can happen.\n+\t * Since requestedDirectBuffers is an std:map<>, no duplications can\n+\t * happen.\n \t */\n-\tstd::map<CameraStream *, libcamera::FrameBuffer *> requestedBuffers;\n+\tstd::map<CameraStream *, libcamera::FrameBuffer *> requestedDirectBuffers;\n \tfor (const auto &[i, buffer] : utils::enumerate(descriptor->buffers_)) {\n \t\tCameraStream *cameraStream = buffer.stream;\n \t\tcamera3_stream_t *camera3Stream = cameraStream->camera3Stream();\n@@ -1009,7 +1010,7 @@ int CameraDevice::processCaptureRequest(camera3_capture_request_t *camera3Reques\n \t\t\tframeBuffer = buffer.frameBuffer.get();\n \t\t\tacquireFence = std::move(buffer.fence);\n \n-\t\t\trequestedBuffers[cameraStream] = frameBuffer;\n+\t\t\trequestedDirectBuffers[cameraStream] = frameBuffer;\n \t\t\tLOG(HAL, Debug) << ss.str() << \" (direct)\";\n \t\t\tbreak;\n \n@@ -1018,14 +1019,17 @@ int CameraDevice::processCaptureRequest(camera3_capture_request_t *camera3Reques\n \t\t\t * Get the frame buffer from the CameraStream internal\n \t\t\t * buffer pool.\n \t\t\t *\n-\t\t\t * The buffer has to be returned to the CameraStream\n-\t\t\t * once it has been processed.\n+\t\t\t * The buffer will be returned to the CameraStream when\n+\t\t\t * the request is destructed.\n \t\t\t */\n \t\t\tframeBuffer = cameraStream->getBuffer();\n-\t\t\tbuffer.internalBuffer = frameBuffer;\n \t\t\tbuffer.srcBuffer = frameBuffer;\n \n-\t\t\trequestedBuffers[cameraStream] = frameBuffer;\n+\t\t\t/*\n+\t\t\t * Track the allocated internal buffers, which will be\n+\t\t\t * recycled when the descriptor destroyed.\n+\t\t\t * */\n+\t\t\tdescriptor->internalBuffers_[cameraStream] = frameBuffer;\n \t\t\tLOG(HAL, Debug) << ss.str() << \" (internal)\";\n \n \t\t\tdescriptor->pendingStreamsToProcess_.insert(\n@@ -1079,24 +1083,41 @@ int CameraDevice::processCaptureRequest(camera3_capture_request_t *camera3Reques\n \t\t * post-processing. No need to recycle the buffer since it's\n \t\t * owned by Android.\n \t\t */\n-\t\tauto iterDirectBuffer = requestedBuffers.find(sourceStream);\n-\t\tif (iterDirectBuffer != requestedBuffers.end()) {\n+\t\tauto iterDirectBuffer = requestedDirectBuffers.find(sourceStream);\n+\t\tif (iterDirectBuffer != requestedDirectBuffers.end()) {\n \t\t\tbuffer.srcBuffer = iterDirectBuffer->second;\n \t\t\tcontinue;\n \t\t}\n \n \t\t/*\n-\t\t * If that's not the case, we need to add a buffer to the request\n-\t\t * for this stream.\n+\t\t * If that's not the case, we use an internal buffer allocated\n+\t\t * from the source stream.\n+\t\t *\n+\t\t * If an internal buffer has been requested for the source\n+\t\t * stream before, we should reuse it.\n+\t\t */\n+\t\tauto iterInternalBuffer = descriptor->internalBuffers_.find(sourceStream);\n+\t\tif (iterInternalBuffer != descriptor->internalBuffers_.end()) {\n+\t\t\tbuffer.srcBuffer = iterInternalBuffer->second;\n+\t\t\tcontinue;\n+\t\t}\n+\n+\t\t/*\n+\t\t * Otherwise, we need to create an internal buffer to the\n+\t\t * request for the source stream. Get the frame buffer from the\n+\t\t * source stream's internal buffer pool.\n+\t\t *\n+\t\t * The buffer will be returned to the CameraStream when the\n+\t\t * request is destructed.\n \t\t */\n-\t\tFrameBuffer *frameBuffer = cameraStream->getBuffer();\n-\t\tbuffer.internalBuffer = frameBuffer;\n+\t\tFrameBuffer *frameBuffer = sourceStream->getBuffer();\n \t\tbuffer.srcBuffer = frameBuffer;\n \n \t\tdescriptor->request_->addBuffer(sourceStream->stream(),\n \t\t\t\t\t\tframeBuffer, nullptr);\n \n-\t\trequestedBuffers[sourceStream] = frameBuffer;\n+\t\t/* Track the allocated internal buffer. */\n+\t\tdescriptor->internalBuffers_[sourceStream] = frameBuffer;\n \t}\n \n \t/*\n@@ -1256,13 +1277,6 @@ void CameraDevice::requestComplete(Request *request)\n \t\tif (ret) {\n \t\t\tsetBufferStatus(*buffer, StreamBuffer::Status::Error);\n \t\t\tdescriptor->pendingStreamsToProcess_.erase(stream);\n-\n-\t\t\t/*\n-\t\t\t * If the framebuffer is internal to CameraStream return\n-\t\t\t * it back now that we're done processing it.\n-\t\t\t */\n-\t\t\tif (buffer->internalBuffer)\n-\t\t\t\tstream->putBuffer(buffer->internalBuffer);\n \t\t}\n \t}\n \n@@ -1381,13 +1395,6 @@ void CameraDevice::streamProcessingComplete(StreamBuffer *streamBuffer,\n {\n \tsetBufferStatus(*streamBuffer, status);\n \n-\t/*\n-\t * If the framebuffer is internal to CameraStream return it back now\n-\t * that we're done processing it.\n-\t */\n-\tif (streamBuffer->internalBuffer)\n-\t\tstreamBuffer->stream->putBuffer(streamBuffer->internalBuffer);\n-\n \tCamera3RequestDescriptor *request = streamBuffer->request;\n \n \t{\ndiff --git a/src/android/camera_request.cpp b/src/android/camera_request.cpp\nindex 52a3ac1f7..a9240a83c 100644\n--- a/src/android/camera_request.cpp\n+++ b/src/android/camera_request.cpp\n@@ -10,6 +10,7 @@\n #include <libcamera/base/span.h>\n \n #include \"camera_buffer.h\"\n+#include \"camera_stream.h\"\n \n using namespace libcamera;\n \n@@ -138,7 +139,14 @@ Camera3RequestDescriptor::Camera3RequestDescriptor(\n \trequest_ = camera->createRequest(reinterpret_cast<uint64_t>(this));\n }\n \n-Camera3RequestDescriptor::~Camera3RequestDescriptor() = default;\n+Camera3RequestDescriptor::~Camera3RequestDescriptor()\n+{\n+\t/*\n+\t * Recycle the allocated internal buffer back to its source stream.\n+\t */\n+\tfor (auto &[sourceStream, frameBuffer] : internalBuffers_)\n+\t\tsourceStream->putBuffer(frameBuffer);\n+}\n \n /**\n  * \\class StreamBuffer\n@@ -166,9 +174,6 @@ Camera3RequestDescriptor::~Camera3RequestDescriptor() = default;\n  * \\var StreamBuffer::status\n  * \\brief Track the status of the buffer\n  *\n- * \\var StreamBuffer::internalBuffer\n- * \\brief Pointer to a buffer internally handled by CameraStream (if any)\n- *\n  * \\var StreamBuffer::srcBuffer\n  * \\brief Pointer to the source frame buffer used for post-processing\n  *\ndiff --git a/src/android/camera_request.h b/src/android/camera_request.h\nindex 335f1985d..6b2a00795 100644\n--- a/src/android/camera_request.h\n+++ b/src/android/camera_request.h\n@@ -49,7 +49,6 @@ public:\n \tstd::unique_ptr<HALFrameBuffer> frameBuffer;\n \tlibcamera::UniqueFD fence;\n \tStatus status = Status::Success;\n-\tlibcamera::FrameBuffer *internalBuffer = nullptr;\n \tconst libcamera::FrameBuffer *srcBuffer = nullptr;\n \tstd::unique_ptr<CameraBuffer> dstBuffer;\n \tCamera3RequestDescriptor *request;\n@@ -85,6 +84,8 @@ public:\n \tstd::unique_ptr<libcamera::Request> request_;\n \tstd::unique_ptr<CameraMetadata> resultMetadata_;\n \n+\tstd::map<CameraStream *, libcamera::FrameBuffer *> internalBuffers_;\n+\n \tbool complete_ = false;\n \tStatus status_ = Status::Success;\n \n",
    "prefixes": [
        "v2",
        "4/9"
    ]
}