[{"id":3130,"web_url":"https://patchwork.libcamera.org/comment/3130/","msgid":"<20191121124036.kvqmxbljxdowhtfp@uno.localdomain>","date":"2019-11-21T12:40:36","subject":"Re: [libcamera-devel] [PATCH v2 08/10] libcamera: pipeline: Rework\n\tPipelineHandler::queueRequest()","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"content":"Hi Niklas,\n\nOn Wed, Nov 20, 2019 at 02:55:04AM +0100, Niklas Söderlund wrote:\n> Expecting a pipeline handler implementation of queueRequest() to call\n> the base class queueRequest() at the correct point have lead to\n\ns/have/has\n\n> different behaviors between the pipelines.\n>\n> Fix this by splitting queueRequest() into a base class implementation\n> which handles the bookkeeping and a new queueRequestHardware() that is\n> to be implemented by pipeline handlers and only deals with committing the\n> request to the hardware.\n>\n> Signed-off-by: Niklas Söderlund \n> ---\n> src/libcamera/include/pipeline_handler.h | 4 ++-\n> src/libcamera/pipeline/ipu3/ipu3.cpp | 6 ++--\n> src/libcamera/pipeline/rkisp1/rkisp1.cpp | 7 ++---\n> src/libcamera/pipeline/uvcvideo.cpp | 6 ++--\n> src/libcamera/pipeline/vimc.cpp | 6 ++--\n> src/libcamera/pipeline_handler.cpp | 35 +++++++++++++++++-------\n> 6 files changed, 37 insertions(+), 27 deletions(-)\n>\n> diff --git a/src/libcamera/include/pipeline_handler.h b/src/libcamera/include/pipeline_handler.h\n> index 241af58beec0eb13..ad7d08e681d0f28e 100644\n> --- a/src/libcamera/include/pipeline_handler.h\n> +++ b/src/libcamera/include/pipeline_handler.h\n> @@ -78,7 +78,7 @@ public:\n> \tvirtual int start(Camera *camera) = 0;\n> \tvirtual void stop(Camera *camera) = 0;\n>\n> -\tvirtual int queueRequest(Camera *camera, Request *request);\n> +\tint queueRequest(Camera *camera, Request *request);\n>\n> \tbool completeBuffer(Camera *camera, Request *request, Buffer *buffer);\n> \tvoid completeRequest(Camera *camera, Request *request);\n> @@ -90,6 +90,8 @@ protected:\n> \t\t\t std::unique_ptr data);\n> \tvoid hotplugMediaDevice(MediaDevice *media);\n>\n> +\tvirtual int queueRequestHardware(Camera *camera, Request *request) = 0;\n> +\n> \tCameraData *cameraData(const Camera *camera);\n>\n> \tCameraManager *manager_;\n> diff --git a/src/libcamera/pipeline/ipu3/ipu3.cpp b/src/libcamera/pipeline/ipu3/ipu3.cpp\n> index 1c5fccf694289ae9..ad223d9101bdc6ed 100644\n> --- a/src/libcamera/pipeline/ipu3/ipu3.cpp\n> +++ b/src/libcamera/pipeline/ipu3/ipu3.cpp\n> @@ -220,7 +220,7 @@ public:\n> \tint start(Camera *camera) override;\n> \tvoid stop(Camera *camera) override;\n>\n> -\tint queueRequest(Camera *camera, Request *request) override;\n> +\tint queueRequestHardware(Camera *camera, Request *request) override;\n>\n> \tbool match(DeviceEnumerator *enumerator) override;\n>\n> @@ -756,7 +756,7 @@ void PipelineHandlerIPU3::stop(Camera *camera)\n> \tdata->rawBuffers_.clear();\n> }\n>\n> -int PipelineHandlerIPU3::queueRequest(Camera *camera, Request *request)\n> +int PipelineHandlerIPU3::queueRequestHardware(Camera *camera, Request *request)\n> {\n> \tint error = 0;\n>\n> @@ -769,8 +769,6 @@ int PipelineHandlerIPU3::queueRequest(Camera *camera, Request *request)\n> \t\t\terror = ret;\n> \t}\n>\n> -\tPipelineHandler::queueRequest(camera, request);\n> -\n> \treturn error;\n> }\n>\n> diff --git a/src/libcamera/pipeline/rkisp1/rkisp1.cpp b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n> index b21cf92435e7bbc9..f5d19dc047aa5a31 100644\n> --- a/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n> +++ b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n> @@ -184,7 +184,7 @@ public:\n> \tint start(Camera *camera) override;\n> \tvoid stop(Camera *camera) override;\n>\n> -\tint queueRequest(Camera *camera, Request *request) override;\n> +\tint queueRequestHardware(Camera *camera, Request *request) override;\n>\n> \tbool match(DeviceEnumerator *enumerator) override;\n>\n> @@ -810,13 +810,12 @@ void PipelineHandlerRkISP1::stop(Camera *camera)\n> \tactiveCamera_ = nullptr;\n> }\n>\n> -int PipelineHandlerRkISP1::queueRequest(Camera *camera, Request *request)\n> +int PipelineHandlerRkISP1::queueRequestHardware(Camera *camera,\n> +\t\t\t\t\t\tRequest *request)\n> {\n> \tRkISP1CameraData *data = cameraData(camera);\n> \tStream *stream = &data->stream_;\n>\n> -\tPipelineHandler::queueRequest(camera, request);\n> -\n> \tRkISP1FrameInfo *info = data->frameInfo_.create(data->frame_, request,\n> \t\t\t\t\t\t\tstream);\n> \tif (!info)\n> diff --git a/src/libcamera/pipeline/uvcvideo.cpp b/src/libcamera/pipeline/uvcvideo.cpp\n> index 45448d6f8c05ddf5..76c2d377fb160ce4 100644\n> --- a/src/libcamera/pipeline/uvcvideo.cpp\n> +++ b/src/libcamera/pipeline/uvcvideo.cpp\n> @@ -72,7 +72,7 @@ public:\n> \tint start(Camera *camera) override;\n> \tvoid stop(Camera *camera) override;\n>\n> -\tint queueRequest(Camera *camera, Request *request) override;\n> +\tint queueRequestHardware(Camera *camera, Request *request) override;\n>\n> \tbool match(DeviceEnumerator *enumerator) override;\n>\n> @@ -262,7 +262,7 @@ int PipelineHandlerUVC::processControls(UVCCameraData *data, Request *request)\n> \treturn ret;\n> }\n>\n> -int PipelineHandlerUVC::queueRequest(Camera *camera, Request *request)\n> +int PipelineHandlerUVC::queueRequestHardware(Camera *camera, Request *request)\n> {\n> \tUVCCameraData *data = cameraData(camera);\n> \tBuffer *buffer = request->findBuffer(&data->stream_);\n> @@ -281,8 +281,6 @@ int PipelineHandlerUVC::queueRequest(Camera *camera, Request *request)\n> \tif (ret < 0)\n> \t\treturn ret;\n>\n> -\tPipelineHandler::queueRequest(camera, request);\n> -\n> \treturn 0;\n> }\n>\n> diff --git a/src/libcamera/pipeline/vimc.cpp b/src/libcamera/pipeline/vimc.cpp\n> index e6ab6a0858247549..13f5a3aca697f566 100644\n> --- a/src/libcamera/pipeline/vimc.cpp\n> +++ b/src/libcamera/pipeline/vimc.cpp\n> @@ -90,7 +90,7 @@ public:\n> \tint start(Camera *camera) override;\n> \tvoid stop(Camera *camera) override;\n>\n> -\tint queueRequest(Camera *camera, Request *request) override;\n> +\tint queueRequestHardware(Camera *camera, Request *request) override;\n>\n> \tbool match(DeviceEnumerator *enumerator) override;\n>\n> @@ -323,7 +323,7 @@ int PipelineHandlerVimc::processControls(VimcCameraData *data, Request *request)\n> \treturn ret;\n> }\n>\n> -int PipelineHandlerVimc::queueRequest(Camera *camera, Request *request)\n> +int PipelineHandlerVimc::queueRequestHardware(Camera *camera, Request *request)\n> {\n> \tVimcCameraData *data = cameraData(camera);\n> \tBuffer *buffer = request->findBuffer(&data->stream_);\n> @@ -342,8 +342,6 @@ int PipelineHandlerVimc::queueRequest(Camera *camera, Request *request)\n> \tif (ret < 0)\n> \t\treturn ret;\n>\n> -\tPipelineHandler::queueRequest(camera, request);\n> -\n> \treturn 0;\n> }\n>\n> diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp\n> index 4349ca8957e403fe..c9e348b98da7b736 100644\n> --- a/src/libcamera/pipeline_handler.cpp\n> +++ b/src/libcamera/pipeline_handler.cpp\n> @@ -345,27 +345,42 @@ const ControlInfoMap &PipelineHandler::controls(Camera *camera)\n> * \\param[in] request The request to queue\n> *\n> * This method queues a capture request to the pipeline handler for processing.\n> - * The request contains a set of buffers associated with streams and a set of\n> - * parameters. The pipeline handler shall program the device to ensure that the\n> - * parameters will be applied to the frames captured in the buffers provided in\n> - * the request.\n> - *\n> - * Pipeline handlers shall override this method. The base implementation in the\n> - * PipelineHandler class keeps track of queued requests in order to ensure\n> - * completion of all requests when the pipeline handler is stopped with stop().\n> - * Requests completion shall be signalled by the pipeline handler using the\n> + * The method keeps track of queued requests in order to ensure completion of\n> + * all requests when the pipeline handler is stopped with stop(). Requests\n> + * completion shall be signalled by the pipeline handler using the\n> * completeRequest() method.\n> *\n> * \\return 0 on success or a negative error code otherwise\n> */\n> int PipelineHandler::queueRequest(Camera *camera, Request *request)\n> {\n> +\tint ret;\n> +\n> \tCameraData *data = cameraData(camera);\n> \tdata->queuedRequests_.push_back(request);\n\nBefore this patch, the Request was added to the queuedRequests_ vector\n-after- the pipeline handler specific implementation was called.\n\nHere you're inverting the behaviour, maybe it's intended.\n\nOtherwise couldn't you simply call queueRequestHardware() and append\nthe Request -after- it successfully returns, to maintain the original\nbehaviour ?\n\n>\n> -\treturn 0;\n> +\tret = queueRequestHardware(camera, request);\n> +\tif (ret)\n> +\t\tdata->queuedRequests_.remove(request);\n> +\n> +\treturn ret;\n> }\n>\n> +/**\n> + * \\fn PipelineHandler::queueRequestHardware()\n> + * \\brief Queue a request to the hardware\n> + * \\param[in] camera The camera to queue the request to\n> + * \\param[in] request The request to queue\n\nrequest or Request ?\n\n> + *\n> + * This method queues a capture request to the hardware for processing. The\n\nwe generally use 'operation' not 'method'\nAlthough, in all this class 'method' is used\n\nconfused...\n\n> + * request contains a set of buffers associated with streams and a set of\n\nHere I would use 'Request' and 'Stream instances', although I just\nnoticed this comment was already in this form before this patch.\n\nThanks\n j\n\n> + * parameters. The pipeline handler shall program the device to ensure that the\n> + * parameters will be applied to the frames captured in the buffers provided in\n> + * the request.\n> + *\n> + * \\return 0 on success or a negative error code otherwise\n> + */\n> +\n> /**\n> * \\brief Complete a buffer for a request\n> * \\param[in] camera The camera the request belongs to\n> --\n> 2.24.0\n>\n> _______________________________________________\n> libcamera-devel mailing list\n> libcamera-devel@lists.libcamera.org\n> https://lists.libcamera.org/listinfo/libcamera-devel","headers":{"Return-Path":"","Received":["from relay12.mail.gandi.net (relay12.mail.gandi.net\n\t[217.70.178.232])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id D77B960C22\n\tfor ;\n\tThu, 21 Nov 2019 13:38:32 +0100 (CET)","from uno.localdomain (93-34-114-233.ip49.fastwebnet.it\n\t[93.34.114.233]) (Authenticated sender: jacopo@jmondi.org)\n\tby relay12.mail.gandi.net (Postfix) with ESMTPSA id 53803200008;\n\tThu, 21 Nov 2019 12:38:32 +0000 (UTC)"],"Date":"Thu, 21 Nov 2019 13:40:36 +0100","From":"Jacopo Mondi ","To":"Niklas =?utf-8?q?S=C3=B6derlund?= ","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20191121124036.kvqmxbljxdowhtfp@uno.localdomain>","References":"<20191120015506.362440-1-niklas.soderlund@ragnatech.se>\n\t<20191120015506.362440-9-niklas.soderlund@ragnatech.se>","MIME-Version":"1.0","Content-Type":"multipart/signed; micalg=pgp-sha256;\n\tprotocol=\"application/pgp-signature\"; boundary=\"tnljftcujk4wbsil\"","Content-Disposition":"inline","In-Reply-To":"<20191120015506.362440-9-niklas.soderlund@ragnatech.se>","User-Agent":"NeoMutt/20180716","Subject":"Re: [libcamera-devel] [PATCH v2 08/10] libcamera: pipeline: Rework\n\tPipelineHandler::queueRequest()","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Thu, 21 Nov 2019 12:38:33 -0000"}}]