{"id":1320,"url":"https://patchwork.libcamera.org/api/patches/1320/?format=json","web_url":"https://patchwork.libcamera.org/patch/1320/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/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":"<20190527223540.21855-3-paul.elder@ideasonboard.com>","date":"2019-05-27T22:35:34","name":"[libcamera-devel,2/8] libcamera: pipeline: add name, major version, and minor version","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"2fcc416188a8f9553f0da50c92a7ba84d5faca6e","submitter":{"id":17,"url":"https://patchwork.libcamera.org/api/people/17/?format=json","name":"Paul Elder","email":"paul.elder@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/1320/mbox/","series":[{"id":330,"url":"https://patchwork.libcamera.org/api/series/330/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=330","date":"2019-05-27T22:35:32","name":"Add IPAManager and IPAInterface","version":1,"mbox":"https://patchwork.libcamera.org/series/330/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/1320/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/1320/checks/","tags":{},"headers":{"Return-Path":"<paul.elder@ideasonboard.com>","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 0D25A60E47\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 28 May 2019 00:35:49 +0200 (CEST)","from localhost.localdomain (unknown [96.44.9.117])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 596F5D85;\n\tTue, 28 May 2019 00:35:48 +0200 (CEST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1558996548;\n\tbh=u6oPlq3xg+eYiuGUReIHLLWPjGZ0xy7YeOBDiBWA/l0=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=LX/34vf+BWiIjfEZzCx+Yul9JNBvVLRytEEZsqikLI4g+HP/R6EDZziXYDuw5Q1sL\n\tTHf9vBcadScF/MK2XcnKDuOVZO+5qIeOQ8kwnxqWBUlqaB5++a2/X0S9gh5nqCxcHu\n\tZzPULcUlcLohK5pQG53NPIfbGykwT7QXLGN43a5k=","From":"Paul Elder <paul.elder@ideasonboard.com>","To":"libcamera-devel@lists.libcamera.org","Date":"Mon, 27 May 2019 18:35:34 -0400","Message-Id":"<20190527223540.21855-3-paul.elder@ideasonboard.com>","X-Mailer":"git-send-email 2.20.1","In-Reply-To":"<20190527223540.21855-1-paul.elder@ideasonboard.com>","References":"<20190527223540.21855-1-paul.elder@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel]  [PATCH 2/8] libcamera: pipeline: add name,\n\tmajor version, and minor version","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","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>","X-List-Received-Date":"Mon, 27 May 2019 22:35:49 -0000"},"content":"In order to match an IPA module with a pipeline handler, the pipeline\nhandler must have a name and a major and minor version. Add these to\nPipelineHandler as functions, so that they can be automatically defined\nby REGISTER_PIPELINE_HANDLER. Also update documentation accordingly.\n\nSigned-off-by: Paul Elder <paul.elder@ideasonboard.com>\n---\n src/libcamera/include/pipeline_handler.h | 20 ++++++++++++++++++--\n src/libcamera/pipeline/ipu3/ipu3.cpp     |  6 +++++-\n src/libcamera/pipeline/rkisp1/rkisp1.cpp |  6 +++++-\n src/libcamera/pipeline/uvcvideo.cpp      |  6 +++++-\n src/libcamera/pipeline/vimc.cpp          |  6 +++++-\n src/libcamera/pipeline_handler.cpp       | 20 ++++++++++++++++++++\n 6 files changed, 58 insertions(+), 6 deletions(-)","diff":"diff --git a/src/libcamera/include/pipeline_handler.h b/src/libcamera/include/pipeline_handler.h\nindex 7da6df1..7963e7a 100644\n--- a/src/libcamera/include/pipeline_handler.h\n+++ b/src/libcamera/include/pipeline_handler.h\n@@ -77,6 +77,10 @@ public:\n \tbool completeBuffer(Camera *camera, Request *request, Buffer *buffer);\n \tvoid completeRequest(Camera *camera, Request *request);\n \n+\tvirtual const char *name() = 0;\n+\tvirtual int majorVersion() = 0;\n+\tvirtual int minorVersion() = 0;\n+\n protected:\n \tvoid registerCamera(std::shared_ptr<Camera> camera,\n \t\t\t    std::unique_ptr<CameraData> data);\n@@ -112,7 +116,7 @@ private:\n \tstd::string name_;\n };\n \n-#define REGISTER_PIPELINE_HANDLER(handler)\t\t\t\t\\\n+#define REGISTER_PIPELINE_HANDLER(handler, majorV, minorV)\t\t\\\n class handler##Factory final : public PipelineHandlerFactory\t\t\\\n {\t\t\t\t\t\t\t\t\t\\\n public:\t\t\t\t\t\t\t\t\t\\\n@@ -122,7 +126,19 @@ public:\t\t\t\t\t\t\t\t\t\\\n \t\treturn std::make_shared<handler>(manager);\t\t\\\n \t}\t\t\t\t\t\t\t\t\\\n };\t\t\t\t\t\t\t\t\t\\\n-static handler##Factory global_##handler##Factory;\n+static handler##Factory global_##handler##Factory;\t\t\t\\\n+const char *handler::name()\t\t\t\t\t\t\\\n+{\t\t\t\t\t\t\t\t\t\\\n+\treturn #handler;\t\t\t\t\t\t\\\n+}\t\t\t\t\t\t\t\t\t\\\n+int handler::majorVersion()\t\t\t\t\t\t\\\n+{\t\t\t\t\t\t\t\t\t\\\n+\treturn majorV;\t\t\t\t\t\t\t\\\n+}\t\t\t\t\t\t\t\t\t\\\n+int handler::minorVersion()\t\t\t\t\t\t\\\n+{\t\t\t\t\t\t\t\t\t\\\n+\treturn minorV;\t\t\t\t\t\t\t\\\n+}\n \n } /* namespace libcamera */\n \ndiff --git a/src/libcamera/pipeline/ipu3/ipu3.cpp b/src/libcamera/pipeline/ipu3/ipu3.cpp\nindex 05005c4..a1b06fe 100644\n--- a/src/libcamera/pipeline/ipu3/ipu3.cpp\n+++ b/src/libcamera/pipeline/ipu3/ipu3.cpp\n@@ -212,6 +212,10 @@ public:\n \n \tbool match(DeviceEnumerator *enumerator) override;\n \n+\tconst char *name() override;\n+\tint majorVersion() override;\n+\tint minorVersion() override;\n+\n private:\n \tIPU3CameraData *cameraData(const Camera *camera)\n \t{\n@@ -1452,6 +1456,6 @@ int CIO2Device::mediaBusToFormat(unsigned int code)\n \t}\n }\n \n-REGISTER_PIPELINE_HANDLER(PipelineHandlerIPU3);\n+REGISTER_PIPELINE_HANDLER(PipelineHandlerIPU3, 0, 1);\n \n } /* namespace libcamera */\ndiff --git a/src/libcamera/pipeline/rkisp1/rkisp1.cpp b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\nindex 9b3eea2..7042e7f 100644\n--- a/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n+++ b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n@@ -92,6 +92,10 @@ public:\n \n \tbool match(DeviceEnumerator *enumerator) override;\n \n+\tconst char *name() override;\n+\tint majorVersion() override;\n+\tint minorVersion() override;\n+\n private:\n \tRkISP1CameraData *cameraData(const Camera *camera)\n \t{\n@@ -499,6 +503,6 @@ void PipelineHandlerRkISP1::bufferReady(Buffer *buffer)\n \tcompleteRequest(activeCamera_, request);\n }\n \n-REGISTER_PIPELINE_HANDLER(PipelineHandlerRkISP1);\n+REGISTER_PIPELINE_HANDLER(PipelineHandlerRkISP1, 0, 1);\n \n } /* namespace libcamera */\ndiff --git a/src/libcamera/pipeline/uvcvideo.cpp b/src/libcamera/pipeline/uvcvideo.cpp\nindex 45260f3..27c731e 100644\n--- a/src/libcamera/pipeline/uvcvideo.cpp\n+++ b/src/libcamera/pipeline/uvcvideo.cpp\n@@ -68,6 +68,10 @@ public:\n \n \tbool match(DeviceEnumerator *enumerator) override;\n \n+\tconst char *name() override;\n+\tint majorVersion() override;\n+\tint minorVersion() override;\n+\n private:\n \tUVCCameraData *cameraData(const Camera *camera)\n \t{\n@@ -263,6 +267,6 @@ void UVCCameraData::bufferReady(Buffer *buffer)\n \tpipe_->completeRequest(camera_, request);\n }\n \n-REGISTER_PIPELINE_HANDLER(PipelineHandlerUVC);\n+REGISTER_PIPELINE_HANDLER(PipelineHandlerUVC, 0, 1);\n \n } /* namespace libcamera */\ndiff --git a/src/libcamera/pipeline/vimc.cpp b/src/libcamera/pipeline/vimc.cpp\nindex 0e4eede..d3ff527 100644\n--- a/src/libcamera/pipeline/vimc.cpp\n+++ b/src/libcamera/pipeline/vimc.cpp\n@@ -71,6 +71,10 @@ public:\n \n \tbool match(DeviceEnumerator *enumerator) override;\n \n+\tconst char *name() override;\n+\tint majorVersion() override;\n+\tint minorVersion() override;\n+\n private:\n \tVimcCameraData *cameraData(const Camera *camera)\n \t{\n@@ -274,6 +278,6 @@ void VimcCameraData::bufferReady(Buffer *buffer)\n \tpipe_->completeRequest(camera_, request);\n }\n \n-REGISTER_PIPELINE_HANDLER(PipelineHandlerVimc);\n+REGISTER_PIPELINE_HANDLER(PipelineHandlerVimc, 0, 1);\n \n } /* namespace libcamera */\ndiff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp\nindex dd56907..8f83307 100644\n--- a/src/libcamera/pipeline_handler.cpp\n+++ b/src/libcamera/pipeline_handler.cpp\n@@ -505,6 +505,24 @@ CameraData *PipelineHandler::cameraData(const Camera *camera)\n  * constant for the whole lifetime of the pipeline handler.\n  */\n \n+/**\n+ * \\fn PipelineHandler::name()\n+ * \\brief Retrieve the pipeline handler name\n+ * \\return The pipeline handler name\n+ */\n+\n+/**\n+ * \\fn PipelineHandler::majorVersion()\n+ * \\brief Retrieve the pipeline handler major version\n+ * \\return The pipeline handler major version\n+ */\n+\n+/**\n+ * \\fn PipelineHandler::minorVersion()\n+ * \\brief Retrieve the pipeline handler minor version\n+ * \\return The pipeline handler minor version\n+ */\n+\n /**\n  * \\class PipelineHandlerFactory\n  * \\brief Registration of PipelineHandler classes and creation of instances\n@@ -586,6 +604,8 @@ std::vector<PipelineHandlerFactory *> &PipelineHandlerFactory::factories()\n  * \\def REGISTER_PIPELINE_HANDLER\n  * \\brief Register a pipeline handler with the pipeline handler factory\n  * \\param[in] handler Class name of PipelineHandler derived class to register\n+ * \\param[in] majorV Major version of the PipelineHandler\n+ * \\param[in] minorV Minor version of the PipelineHandler\n  *\n  * Register a PipelineHandler subclass with the factory and make it available to\n  * try and match devices.\n","prefixes":["libcamera-devel","2/8"]}