Patch Detail
Show a patch.
GET /api/1.1/patches/13949/?format=api
{ "id": 13949, "url": "https://patchwork.libcamera.org/api/1.1/patches/13949/?format=api", "web_url": "https://patchwork.libcamera.org/patch/13949/", "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": "<20210927111149.692004-4-umang.jain@ideasonboard.com>", "date": "2021-09-27T11:11:49", "name": "[libcamera-devel,v1,3/3] android: camera_device: Send capture results by inspecting the queue", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": false, "hash": "b3bbef4cfff6d741450cf7a2b26d8835dd479494", "submitter": { "id": 86, "url": "https://patchwork.libcamera.org/api/1.1/people/86/?format=api", "name": "Umang Jain", "email": "umang.jain@ideasonboard.com" }, "delegate": { "id": 12, "url": "https://patchwork.libcamera.org/api/1.1/users/12/?format=api", "username": "uajain", "first_name": "Umang", "last_name": "Jain", "email": "umang.jain@ideasonboard.com" }, "mbox": "https://patchwork.libcamera.org/patch/13949/mbox/", "series": [ { "id": 2573, "url": "https://patchwork.libcamera.org/api/1.1/series/2573/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=2573", "date": "2021-09-27T11:11:46", "name": "Camera3RequestDescriptors std::map => deque", "version": 1, "mbox": "https://patchwork.libcamera.org/series/2573/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/13949/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/13949/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 AEFF0BDC71\n\tfor <parsemail@patchwork.libcamera.org>;\n\tMon, 27 Sep 2021 11:12:08 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 7D25969194;\n\tMon, 27 Sep 2021 13:12:08 +0200 (CEST)", "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 4C6BB69189\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 27 Sep 2021 13:12:07 +0200 (CEST)", "from perceval.ideasonboard.com (unknown [103.251.226.181])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 41DCCB91;\n\tMon, 27 Sep 2021 13:12:06 +0200 (CEST)" ], "Authentication-Results": "lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"hqCRcSw9\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1632741127;\n\tbh=1Y74fNA3FIRKv/gtppG0GlVz69CrLvnUd1i6MHx+zI0=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=hqCRcSw9mo5dblIBJtkvlShNrS7JLp4YjqiuKUmaXaGsdEFylA8c29hrp4AMnmg7W\n\tqDQhpnArggJc7MOqL00/MQTJdDSoBipsTQvdpp0vq7/7Kd09rfZNfw3wdtuaEYWIxZ\n\t6Zj1QpA41cQU1nDn02FfRwFj10AvpDUfqiCAH6n4=", "From": "Umang Jain <umang.jain@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Date": "Mon, 27 Sep 2021 16:41:49 +0530", "Message-Id": "<20210927111149.692004-4-umang.jain@ideasonboard.com>", "X-Mailer": "git-send-email 2.31.1", "In-Reply-To": "<20210927111149.692004-1-umang.jain@ideasonboard.com>", "References": "<20210927111149.692004-1-umang.jain@ideasonboard.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[libcamera-devel] [PATCH v1 3/3] android: camera_device: Send\n\tcapture results by inspecting the queue", "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": "There is a possibility that an out-of-order completion of capture\nrequest happens by calling process_capture_result() directly on error\npaths. The framework expects that errors should be notified as soon as\npossible, but the request completion order should remain intact.\nAn existing instance of this is abortRequest(), which sends the capture\nresults on flushing state, without considering order-of-completion.\n\nSince, we have a queue of Camera3RequestDescriptor tracking each\ncapture request placed by framework to libcamera HAL, we should be only\nsending back capture results from a single location, by inspecting\nthe queue. As per the patch, this now happens in\nCameraDevice::sendCaptureResults().\n\nEach descriptor is now equipped with its own status to denote whether\nthe capture request is complete and ready to send back to the framework\nor need to be waited upon. This ensures that the order of completion is\nrespected for the requests.\n\nSigned-off-by: Umang Jain <umang.jain@ideasonboard.com>\n---\n src/android/camera_device.cpp | 46 ++++++++++++++++++++++++++---------\n src/android/camera_device.h | 15 +++++++++++-\n 2 files changed, 49 insertions(+), 12 deletions(-)", "diff": "diff --git a/src/android/camera_device.cpp b/src/android/camera_device.cpp\nindex b0b7f4fd..8e2d22c5 100644\n--- a/src/android/camera_device.cpp\n+++ b/src/android/camera_device.cpp\n@@ -240,6 +240,8 @@ CameraDevice::Camera3RequestDescriptor::Camera3RequestDescriptor(\n \t/* Clone the controls associated with the camera3 request. */\n \tsettings_ = CameraMetadata(camera3Request->settings);\n \n+\tstatus_ = Status::Pending;\n+\n \t/*\n \t * Create the CaptureRequest, stored as a unique_ptr<> to tie its\n \t * lifetime to the descriptor.\n@@ -859,11 +861,12 @@ int CameraDevice::processControls(Camera3RequestDescriptor *descriptor)\n \treturn 0;\n }\n \n-void CameraDevice::abortRequest(camera3_capture_request_t *request)\n+void CameraDevice::abortRequest(Camera3RequestDescriptor *descriptor,\n+\t\t\t\tcamera3_capture_request_t *request)\n {\n \tnotifyError(request->frame_number, nullptr, CAMERA3_MSG_ERROR_REQUEST);\n \n-\tcamera3_capture_result_t result = {};\n+\tcamera3_capture_result_t &result = descriptor->captureResult_;\n \tresult.num_output_buffers = request->num_output_buffers;\n \tresult.frame_number = request->frame_number;\n \tresult.partial_result = 0;\n@@ -877,7 +880,8 @@ void CameraDevice::abortRequest(camera3_capture_request_t *request)\n \t}\n \tresult.output_buffers = resultBuffers.data();\n \n-\tcallbacks_->process_capture_result(callbacks_, &result);\n+\tdescriptor->status_ = Camera3RequestDescriptor::Status::Error;\n+\tsendCaptureResults();\n }\n \n bool CameraDevice::isValidRequest(camera3_capture_request_t *camera3Request) const\n@@ -1045,13 +1049,19 @@ int CameraDevice::processCaptureRequest(camera3_capture_request_t *camera3Reques\n \t\treturn ret;\n \n \t/*\n-\t * If flush is in progress abort the request. If the camera has been\n-\t * stopped we have to re-start it to be able to process the request.\n+\t * If flush is in progress push the descriptor in the queue and abort\n+\t * the request. If the camera has been stopped we have to re-start it to\n+\t * be able to process the request.\n \t */\n \tMutexLocker stateLock(stateMutex_);\n \n \tif (state_ == State::Flushing) {\n-\t\tabortRequest(camera3Request);\n+\t\tdescriptor->status_ = Camera3RequestDescriptor::Status::Error;\n+\t\t{\n+\t\t\tMutexLocker descriptorsLock(descriptorsMutex_);\n+\t\t\tdescriptors_.push_back(std::move(descriptor));\n+\t\t}\n+\t\tabortRequest(descriptors_.back().get(), camera3Request);\n \t\treturn 0;\n \t}\n \n@@ -1099,7 +1109,7 @@ void CameraDevice::requestComplete(Request *request)\n \t\treturn;\n \t}\n \n-\tcamera3_capture_result_t captureResult = {};\n+\tcamera3_capture_result_t &captureResult = descriptor->captureResult_;\n \tcaptureResult.frame_number = descriptor->frameNumber_;\n \tcaptureResult.num_output_buffers = descriptor->buffers_.size();\n \tcaptureResult.output_buffers = descriptor->buffers_.data();\n@@ -1138,9 +1148,9 @@ void CameraDevice::requestComplete(Request *request)\n \t\t\tbuffer.acquire_fence = -1;\n \t\t\tbuffer.status = CAMERA3_BUFFER_STATUS_ERROR;\n \t\t}\n-\t\tcallbacks_->process_capture_result(callbacks_, &captureResult);\n \n-\t\tdescriptors_.pop_front();\n+\t\tdescriptor->status_ = Camera3RequestDescriptor::Status::Error;\n+\t\tsendCaptureResults();\n \t\treturn;\n \t}\n \n@@ -1217,9 +1227,23 @@ void CameraDevice::requestComplete(Request *request)\n \tcaptureResult.partial_result = 1;\n \n \tcaptureResult.result = resultMetadata->get();\n-\tcallbacks_->process_capture_result(callbacks_, &captureResult);\n+\tdescriptor->status_ = Camera3RequestDescriptor::Status::Success;\n+\tsendCaptureResults();\n+}\n \n-\tdescriptors_.pop_front();\n+void CameraDevice::sendCaptureResults()\n+{\n+\tMutexLocker lock(descriptorsMutex_);\n+\twhile (!descriptors_.empty() && !descriptors_.front()->isPending()) {\n+\t\tstd::unique_ptr<Camera3RequestDescriptor> descriptor =\n+\t\t\tstd::move(descriptors_.front());\n+\t\tdescriptors_.pop_front();\n+\n+\t\tlock.unlock();\n+\t\tcallbacks_->process_capture_result(callbacks_,\n+\t\t\t\t\t\t &(descriptor->captureResult_));\n+\t\tlock.lock();\n+\t}\n }\n \n std::string CameraDevice::logPrefix() const\ndiff --git a/src/android/camera_device.h b/src/android/camera_device.h\nindex 5889a0e7..545cb9b4 100644\n--- a/src/android/camera_device.h\n+++ b/src/android/camera_device.h\n@@ -74,17 +74,28 @@ private:\n \tCameraDevice(unsigned int id, std::shared_ptr<libcamera::Camera> camera);\n \n \tstruct Camera3RequestDescriptor {\n+\t\tenum class Status {\n+\t\t\tPending,\n+\t\t\tSuccess,\n+\t\t\tError,\n+\t\t};\n+\n \t\tCamera3RequestDescriptor() = default;\n \t\t~Camera3RequestDescriptor() = default;\n \t\tCamera3RequestDescriptor(libcamera::Camera *camera,\n \t\t\t\t\t const camera3_capture_request_t *camera3Request);\n \t\tCamera3RequestDescriptor &operator=(Camera3RequestDescriptor &&) = default;\n+\t\tbool isPending() const { return status_ == Status::Pending; }\n \n \t\tuint32_t frameNumber_ = 0;\n \t\tstd::vector<camera3_stream_buffer_t> buffers_;\n \t\tstd::vector<std::unique_ptr<libcamera::FrameBuffer>> frameBuffers_;\n \t\tCameraMetadata settings_;\n \t\tstd::unique_ptr<CaptureRequest> request_;\n+\n+\t\tcamera3_capture_result_t captureResult_ = {};\n+\t\tlibcamera::FrameBuffer *internalBuffer_;\n+\t\tStatus status_;\n \t};\n \n \tenum class State {\n@@ -99,12 +110,14 @@ private:\n \tcreateFrameBuffer(const buffer_handle_t camera3buffer,\n \t\t\t libcamera::PixelFormat pixelFormat,\n \t\t\t const libcamera::Size &size);\n-\tvoid abortRequest(camera3_capture_request_t *request);\n+\tvoid abortRequest(Camera3RequestDescriptor *descriptor,\n+\t\t\t camera3_capture_request_t *request);\n \tbool isValidRequest(camera3_capture_request_t *request) const;\n \tvoid notifyShutter(uint32_t frameNumber, uint64_t timestamp);\n \tvoid notifyError(uint32_t frameNumber, camera3_stream_t *stream,\n \t\t\t camera3_error_msg_code code);\n \tint processControls(Camera3RequestDescriptor *descriptor);\n+\tvoid sendCaptureResults();\n \tstd::unique_ptr<CameraMetadata> getResultMetadata(\n \t\tconst Camera3RequestDescriptor *descriptor) const;\n \n", "prefixes": [ "libcamera-devel", "v1", "3/3" ] }