{"id":15142,"url":"https://patchwork.libcamera.org/api/1.1/patches/15142/?format=json","web_url":"https://patchwork.libcamera.org/patch/15142/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20211211165714.23067-8-jacopo@jmondi.org>","date":"2021-12-11T16:57:10","name":"[libcamera-devel,v6,07/11] libcamera: pipeline: Introduce stopDevice()","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"f862de8962efa394b98d40c2ebad9dca67a2d91b","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/1.1/people/3/?format=json","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/15142/mbox/","series":[{"id":2838,"url":"https://patchwork.libcamera.org/api/1.1/series/2838/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=2838","date":"2021-12-11T16:57:03","name":"libcamera: Add Fence support","version":6,"mbox":"https://patchwork.libcamera.org/series/2838/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/15142/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/15142/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 B1F94C324B\n\tfor <parsemail@patchwork.libcamera.org>;\n\tSat, 11 Dec 2021 16:56:37 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 52D61608A1;\n\tSat, 11 Dec 2021 17:56:37 +0100 (CET)","from relay7-d.mail.gandi.net (relay7-d.mail.gandi.net\n\t[217.70.183.200])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 617F3608E0\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tSat, 11 Dec 2021 17:56:30 +0100 (CET)","(Authenticated sender: jacopo@jmondi.org)\n\tby relay7-d.mail.gandi.net (Postfix) with ESMTPSA id BDEB920004;\n\tSat, 11 Dec 2021 16:56:29 +0000 (UTC)"],"From":"Jacopo Mondi <jacopo@jmondi.org>","To":"libcamera-devel@lists.libcamera.org","Date":"Sat, 11 Dec 2021 17:57:10 +0100","Message-Id":"<20211211165714.23067-8-jacopo@jmondi.org>","X-Mailer":"git-send-email 2.33.1","In-Reply-To":"<20211211165714.23067-1-jacopo@jmondi.org>","References":"<20211211165714.23067-1-jacopo@jmondi.org>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH v6 07/11] libcamera: pipeline: Introduce\n\tstopDevice()","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":"Since a queue of waiting Requests has been introduced, not all Requests\nqueued to the PipelineHandler are immediately queued to the device.\n\nAs a Camera can be stopped at any time, it is required to complete the\nwaiting requests after the ones queued to the device had been completed.\n\nIntroduce a pure virtual PipelineHandler::stopDevice() function to be\nimplemented by pipeline handlers and make the PipelineHandler::stop()\nfunction call it before completing pending requests.\n\nSigned-off-by: Jacopo Mondi <jacopo@jmondi.org>\nReviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n include/libcamera/internal/pipeline_handler.h |  3 +-\n src/libcamera/pipeline/ipu3/ipu3.cpp          |  4 +--\n .../pipeline/raspberrypi/raspberrypi.cpp      |  4 +--\n src/libcamera/pipeline/rkisp1/rkisp1.cpp      |  4 +--\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_handler.cpp            | 30 +++++++++++++++++--\n 8 files changed, 42 insertions(+), 15 deletions(-)","diff":"diff --git a/include/libcamera/internal/pipeline_handler.h b/include/libcamera/internal/pipeline_handler.h\nindex 6aa3378547ba..ec986a518b5c 100644\n--- a/include/libcamera/internal/pipeline_handler.h\n+++ b/include/libcamera/internal/pipeline_handler.h\n@@ -55,7 +55,7 @@ public:\n \t\t\t\t       std::vector<std::unique_ptr<FrameBuffer>> *buffers) = 0;\n \n \tvirtual int start(Camera *camera, const ControlList *controls) = 0;\n-\tvirtual void stop(Camera *camera) = 0;\n+\tvoid stop(Camera *camera);\n \tbool hasPendingRequests(const Camera *camera) const;\n \n \tvoid queueRequest(Request *request);\n@@ -70,6 +70,7 @@ protected:\n \tvoid hotplugMediaDevice(MediaDevice *media);\n \n \tvirtual int queueRequestDevice(Camera *camera, Request *request) = 0;\n+\tvirtual void stopDevice(Camera *camera) = 0;\n \n \tCameraManager *manager_;\n \ndiff --git a/src/libcamera/pipeline/ipu3/ipu3.cpp b/src/libcamera/pipeline/ipu3/ipu3.cpp\nindex 313220624aff..6c5617cd5bca 100644\n--- a/src/libcamera/pipeline/ipu3/ipu3.cpp\n+++ b/src/libcamera/pipeline/ipu3/ipu3.cpp\n@@ -139,7 +139,7 @@ public:\n \t\t\t       std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;\n \n \tint start(Camera *camera, const ControlList *controls) override;\n-\tvoid stop(Camera *camera) override;\n+\tvoid stopDevice(Camera *camera) override;\n \n \tint queueRequestDevice(Camera *camera, Request *request) override;\n \n@@ -803,7 +803,7 @@ error:\n \treturn ret;\n }\n \n-void PipelineHandlerIPU3::stop(Camera *camera)\n+void PipelineHandlerIPU3::stopDevice(Camera *camera)\n {\n \tIPU3CameraData *data = cameraData(camera);\n \tint ret = 0;\ndiff --git a/src/libcamera/pipeline/raspberrypi/raspberrypi.cpp b/src/libcamera/pipeline/raspberrypi/raspberrypi.cpp\nindex 86851ac467ad..9c171ceae1db 100644\n--- a/src/libcamera/pipeline/raspberrypi/raspberrypi.cpp\n+++ b/src/libcamera/pipeline/raspberrypi/raspberrypi.cpp\n@@ -298,7 +298,7 @@ public:\n \t\t\t       std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;\n \n \tint start(Camera *camera, const ControlList *controls) override;\n-\tvoid stop(Camera *camera) override;\n+\tvoid stopDevice(Camera *camera) override;\n \n \tint queueRequestDevice(Camera *camera, Request *request) override;\n \n@@ -943,7 +943,7 @@ int PipelineHandlerRPi::start(Camera *camera, const ControlList *controls)\n \treturn 0;\n }\n \n-void PipelineHandlerRPi::stop(Camera *camera)\n+void PipelineHandlerRPi::stopDevice(Camera *camera)\n {\n \tRPiCameraData *data = cameraData(camera);\n \ndiff --git a/src/libcamera/pipeline/rkisp1/rkisp1.cpp b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\nindex 36ef6a02ae90..8cca8a15a3c3 100644\n--- a/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n+++ b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n@@ -146,7 +146,7 @@ public:\n \t\t\t       std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;\n \n \tint start(Camera *camera, const ControlList *controls) override;\n-\tvoid stop(Camera *camera) override;\n+\tvoid stopDevice(Camera *camera) override;\n \n \tint queueRequestDevice(Camera *camera, Request *request) override;\n \n@@ -827,7 +827,7 @@ int PipelineHandlerRkISP1::start(Camera *camera, [[maybe_unused]] const ControlL\n \treturn ret;\n }\n \n-void PipelineHandlerRkISP1::stop(Camera *camera)\n+void PipelineHandlerRkISP1::stopDevice(Camera *camera)\n {\n \tRkISP1CameraData *data = cameraData(camera);\n \tint ret;\ndiff --git a/src/libcamera/pipeline/simple/simple.cpp b/src/libcamera/pipeline/simple/simple.cpp\nindex 701fb4be0b71..fdff4ebd5134 100644\n--- a/src/libcamera/pipeline/simple/simple.cpp\n+++ b/src/libcamera/pipeline/simple/simple.cpp\n@@ -279,7 +279,7 @@ public:\n \t\t\t       std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;\n \n \tint start(Camera *camera, const ControlList *controls) override;\n-\tvoid stop(Camera *camera) override;\n+\tvoid stopDevice(Camera *camera) override;\n \n \tbool match(DeviceEnumerator *enumerator) override;\n \n@@ -1036,7 +1036,7 @@ int SimplePipelineHandler::start(Camera *camera, [[maybe_unused]] const ControlL\n \treturn 0;\n }\n \n-void SimplePipelineHandler::stop(Camera *camera)\n+void SimplePipelineHandler::stopDevice(Camera *camera)\n {\n \tSimpleCameraData *data = cameraData(camera);\n \tV4L2VideoDevice *video = data->video_;\ndiff --git a/src/libcamera/pipeline/uvcvideo/uvcvideo.cpp b/src/libcamera/pipeline/uvcvideo/uvcvideo.cpp\nindex 264f5370cf32..40654a0bc40c 100644\n--- a/src/libcamera/pipeline/uvcvideo/uvcvideo.cpp\n+++ b/src/libcamera/pipeline/uvcvideo/uvcvideo.cpp\n@@ -74,7 +74,7 @@ public:\n \t\t\t       std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;\n \n \tint start(Camera *camera, const ControlList *controls) override;\n-\tvoid stop(Camera *camera) override;\n+\tvoid stopDevice(Camera *camera) override;\n \n \tint queueRequestDevice(Camera *camera, Request *request) override;\n \n@@ -250,7 +250,7 @@ int PipelineHandlerUVC::start(Camera *camera, [[maybe_unused]] const ControlList\n \treturn 0;\n }\n \n-void PipelineHandlerUVC::stop(Camera *camera)\n+void PipelineHandlerUVC::stopDevice(Camera *camera)\n {\n \tUVCCameraData *data = cameraData(camera);\n \tdata->video_->streamOff();\ndiff --git a/src/libcamera/pipeline/vimc/vimc.cpp b/src/libcamera/pipeline/vimc/vimc.cpp\nindex e453091da4b2..29960fe3f038 100644\n--- a/src/libcamera/pipeline/vimc/vimc.cpp\n+++ b/src/libcamera/pipeline/vimc/vimc.cpp\n@@ -91,7 +91,7 @@ public:\n \t\t\t       std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;\n \n \tint start(Camera *camera, const ControlList *controls) override;\n-\tvoid stop(Camera *camera) override;\n+\tvoid stopDevice(Camera *camera) override;\n \n \tint queueRequestDevice(Camera *camera, Request *request) override;\n \n@@ -359,7 +359,7 @@ int PipelineHandlerVimc::start(Camera *camera, [[maybe_unused]] const ControlLis\n \treturn 0;\n }\n \n-void PipelineHandlerVimc::stop(Camera *camera)\n+void PipelineHandlerVimc::stopDevice(Camera *camera)\n {\n \tVimcCameraData *data = cameraData(camera);\n \tdata->video_->streamOff();\ndiff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp\nindex 2374c2891c64..92b5e3ab07d8 100644\n--- a/src/libcamera/pipeline_handler.cpp\n+++ b/src/libcamera/pipeline_handler.cpp\n@@ -267,8 +267,7 @@ void PipelineHandler::unlock()\n  */\n \n /**\n- * \\fn PipelineHandler::stop()\n- * \\brief Stop capturing from all running streams\n+ * \\brief Stop capturing from all running streams and cancel pending requests\n  * \\param[in] camera The camera to stop\n  *\n  * This function stops capturing and processing requests immediately. All\n@@ -276,6 +275,33 @@ void PipelineHandler::unlock()\n  *\n  * \\context This function is called from the CameraManager thread.\n  */\n+void PipelineHandler::stop(Camera *camera)\n+{\n+\t/* Stop the pipeline handler and let the queued requests complete. */\n+\tstopDevice(camera);\n+\n+\t/* Cancel and signal as complete all waiting requests. */\n+\twhile (!waitingRequests_.empty()) {\n+\t\tRequest *request = waitingRequests_.front();\n+\t\twaitingRequests_.pop();\n+\n+\t\trequest->_d()->cancel();\n+\t\tcompleteRequest(request);\n+\t}\n+\n+\t/* Make sure no requests are pending. */\n+\tCamera::Private *data = camera->_d();\n+\tASSERT(data->queuedRequests_.empty());\n+}\n+\n+/**\n+ * \\fn PipelineHandler::stopDevice()\n+ * \\brief Stop capturing from all running streams\n+ * \\param[in] camera The camera to stop\n+ *\n+ * This function stops capturing and processing requests immediately. All\n+ * pending requests are cancelled and complete immediately in an error state.\n+ */\n \n /**\n  * \\brief Determine if the camera has any requests pending\n","prefixes":["libcamera-devel","v6","07/11"]}