{"id":356,"url":"https://patchwork.libcamera.org/api/1.1/patches/356/?format=json","web_url":"https://patchwork.libcamera.org/patch/356/","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":"<20190124101651.9993-2-laurent.pinchart@ideasonboard.com>","date":"2019-01-24T10:16:42","name":"[libcamera-devel,01/10] libcamera: pipeline_handler: Store the camera manager pointer","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"18cba5c21a83e4a9e62659aba96096d2fa2ed11f","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/1.1/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/356/mbox/","series":[{"id":125,"url":"https://patchwork.libcamera.org/api/1.1/series/125/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=125","date":"2019-01-24T10:16:41","name":"Hotplug support and object lifetime management","version":1,"mbox":"https://patchwork.libcamera.org/series/125/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/356/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/356/checks/","tags":{},"headers":{"Return-Path":"<laurent.pinchart@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 6424360C78\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu, 24 Jan 2019 11:16:57 +0100 (CET)","from pendragon.bb.dnainternet.fi\n\t(dfj612yhrgyx302h3jwwy-3.rev.dnainternet.fi\n\t[IPv6:2001:14ba:21f5:5b00:ce28:277f:58d7:3ca4])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id D02B72F6;\n\tThu, 24 Jan 2019 11:16:56 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1548325017;\n\tbh=assAIgFS7yxI5tahqSAH/spUZDdGW1KgSnrmxsr4QNs=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=HfOyU+Ol4vF6mcQ96Lp0dQr+WXo7hzWs1f0if5SuINkbtsoE6mJ1FYZ53fmRJpelH\n\tYFgmA6f/3Drr79s+BAPx6crwfYLLWA3Ix4z2KDag9ojCkzNr3tC5TdrqeMtl4p5EuP\n\tYhJrmPKNoR0cXswSrAR2gAMCI6XL36mtWL5Yoc9c=","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"libcamera-devel@lists.libcamera.org","Date":"Thu, 24 Jan 2019 12:16:42 +0200","Message-Id":"<20190124101651.9993-2-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.19.2","In-Reply-To":"<20190124101651.9993-1-laurent.pinchart@ideasonboard.com>","References":"<20190124101651.9993-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH 01/10] libcamera: pipeline_handler: Store\n\tthe camera manager pointer","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":"Thu, 24 Jan 2019 10:16:57 -0000"},"content":"Instead of passing the camera manager pointer to the match() function,\nand later to more PipelineHandler functions, store it in the\nPipelineHandler::manager_ member variable at construction time and\naccess it from there.\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n src/libcamera/camera_manager.cpp         |  4 +--\n src/libcamera/include/pipeline_handler.h | 20 ++++++++-----\n src/libcamera/pipeline/ipu3/ipu3.cpp     | 18 ++++++------\n src/libcamera/pipeline/uvcvideo.cpp      | 12 ++++----\n src/libcamera/pipeline/vimc.cpp          | 12 ++++----\n src/libcamera/pipeline_handler.cpp       | 36 ++++++++++++++++++++----\n 6 files changed, 66 insertions(+), 36 deletions(-)","diff":"diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp\nindex 4ea7ed44cc31..14410d4dcda7 100644\n--- a/src/libcamera/camera_manager.cpp\n+++ b/src/libcamera/camera_manager.cpp\n@@ -98,8 +98,8 @@ int CameraManager::start()\n \t\t * all pipelines it can provide.\n \t\t */\n \t\twhile (1) {\n-\t\t\tPipelineHandler *pipe = factory->create();\n-\t\t\tif (!pipe->match(this, enumerator_.get())) {\n+\t\t\tPipelineHandler *pipe = factory->create(this);\n+\t\t\tif (!pipe->match(enumerator_.get())) {\n \t\t\t\tdelete pipe;\n \t\t\t\tbreak;\n \t\t\t}\ndiff --git a/src/libcamera/include/pipeline_handler.h b/src/libcamera/include/pipeline_handler.h\nindex b03217d5bff8..7bb07d1ec5c7 100644\n--- a/src/libcamera/include/pipeline_handler.h\n+++ b/src/libcamera/include/pipeline_handler.h\n@@ -19,9 +19,13 @@ class DeviceEnumerator;\n class PipelineHandler\n {\n public:\n-\tvirtual ~PipelineHandler() { };\n+\tPipelineHandler(CameraManager *manager);\n+\tvirtual ~PipelineHandler();\n \n-\tvirtual bool match(CameraManager *manager, DeviceEnumerator *enumerator) = 0;\n+\tvirtual bool match(DeviceEnumerator *enumerator) = 0;\n+\n+protected:\n+\tCameraManager *manager_;\n };\n \n class PipelineHandlerFactory\n@@ -30,7 +34,7 @@ public:\n \tPipelineHandlerFactory(const char *name);\n \tvirtual ~PipelineHandlerFactory() { };\n \n-\tvirtual PipelineHandler *create() = 0;\n+\tvirtual PipelineHandler *create(CameraManager *manager) = 0;\n \n \tconst std::string &name() const { return name_; }\n \n@@ -42,11 +46,13 @@ private:\n };\n \n #define REGISTER_PIPELINE_HANDLER(handler)\t\t\t\t\\\n-class handler##Factory : public PipelineHandlerFactory {\t\t\\\n+class handler##Factory : public PipelineHandlerFactory\t\t\t\\\n+{\t\t\t\t\t\t\t\t\t\\\n public:\t\t\t\t\t\t\t\t\t\\\n-\thandler##Factory() : PipelineHandlerFactory(#handler) { }\t\\\n-\tPipelineHandler *create() final {\t\t\t\t\\\n-\t\treturn new handler();\t\t\t\t\t\\\n+\thandler##Factory() : PipelineHandlerFactory(#handler) {}\t\\\n+\tPipelineHandler *create(CameraManager *manager) final\t\t\\\n+\t{\t\t\t\t\t\t\t\t\\\n+\t\treturn new handler(manager);\t\t\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;\ndiff --git a/src/libcamera/pipeline/ipu3/ipu3.cpp b/src/libcamera/pipeline/ipu3/ipu3.cpp\nindex 8cbc10acfbb5..589b3078f301 100644\n--- a/src/libcamera/pipeline/ipu3/ipu3.cpp\n+++ b/src/libcamera/pipeline/ipu3/ipu3.cpp\n@@ -23,20 +23,20 @@ LOG_DEFINE_CATEGORY(IPU3)\n class PipelineHandlerIPU3 : public PipelineHandler\n {\n public:\n-\tPipelineHandlerIPU3();\n+\tPipelineHandlerIPU3(CameraManager *manager);\n \t~PipelineHandlerIPU3();\n \n-\tbool match(CameraManager *manager, DeviceEnumerator *enumerator);\n+\tbool match(DeviceEnumerator *enumerator);\n \n private:\n \tMediaDevice *cio2_;\n \tMediaDevice *imgu_;\n \n-\tvoid registerCameras(CameraManager *manager);\n+\tvoid registerCameras();\n };\n \n-PipelineHandlerIPU3::PipelineHandlerIPU3()\n-\t: cio2_(nullptr), imgu_(nullptr)\n+PipelineHandlerIPU3::PipelineHandlerIPU3(CameraManager *manager)\n+\t: PipelineHandler(manager), cio2_(nullptr), imgu_(nullptr)\n {\n }\n \n@@ -52,7 +52,7 @@ PipelineHandlerIPU3::~PipelineHandlerIPU3()\n \timgu_ = nullptr;\n }\n \n-bool PipelineHandlerIPU3::match(CameraManager *manager, DeviceEnumerator *enumerator)\n+bool PipelineHandlerIPU3::match(DeviceEnumerator *enumerator)\n {\n \tDeviceMatch cio2_dm(\"ipu3-cio2\");\n \tcio2_dm.add(\"ipu3-csi2 0\");\n@@ -106,7 +106,7 @@ bool PipelineHandlerIPU3::match(CameraManager *manager, DeviceEnumerator *enumer\n \tif (cio2_->disableLinks())\n \t\tgoto error_close_cio2;\n \n-\tregisterCameras(manager);\n+\tregisterCameras();\n \n \tcio2_->close();\n \n@@ -127,7 +127,7 @@ error_release_mdev:\n  * media entity with function MEDIA_ENT_F_CAM_SENSOR) to one of the four\n  * CIO2 CSI-2 receivers.\n  */\n-void PipelineHandlerIPU3::registerCameras(CameraManager *manager)\n+void PipelineHandlerIPU3::registerCameras()\n {\n \t/*\n \t * For each CSI-2 receiver on the IPU3, create a Camera if an\n@@ -172,7 +172,7 @@ void PipelineHandlerIPU3::registerCameras(CameraManager *manager)\n \n \t\tstd::string cameraName = sensor->name() + \" \" + std::to_string(id);\n \t\tstd::shared_ptr<Camera> camera = Camera::create(cameraName);\n-\t\tmanager->addCamera(std::move(camera));\n+\t\tmanager_->addCamera(std::move(camera));\n \n \t\tLOG(IPU3, Info)\n \t\t\t<< \"Registered Camera[\" << numCameras << \"] \\\"\"\ndiff --git a/src/libcamera/pipeline/uvcvideo.cpp b/src/libcamera/pipeline/uvcvideo.cpp\nindex 3ba69da8b775..92b23da73901 100644\n--- a/src/libcamera/pipeline/uvcvideo.cpp\n+++ b/src/libcamera/pipeline/uvcvideo.cpp\n@@ -17,17 +17,17 @@ namespace libcamera {\n class PipelineHandlerUVC : public PipelineHandler\n {\n public:\n-\tPipelineHandlerUVC();\n+\tPipelineHandlerUVC(CameraManager *manager);\n \t~PipelineHandlerUVC();\n \n-\tbool match(CameraManager *manager, DeviceEnumerator *enumerator);\n+\tbool match(DeviceEnumerator *enumerator);\n \n private:\n \tMediaDevice *dev_;\n };\n \n-PipelineHandlerUVC::PipelineHandlerUVC()\n-\t: dev_(nullptr)\n+PipelineHandlerUVC::PipelineHandlerUVC(CameraManager *manager)\n+\t: PipelineHandler(manager), dev_(nullptr)\n {\n }\n \n@@ -37,7 +37,7 @@ PipelineHandlerUVC::~PipelineHandlerUVC()\n \t\tdev_->release();\n }\n \n-bool PipelineHandlerUVC::match(CameraManager *manager, DeviceEnumerator *enumerator)\n+bool PipelineHandlerUVC::match(DeviceEnumerator *enumerator)\n {\n \tDeviceMatch dm(\"uvcvideo\");\n \n@@ -49,7 +49,7 @@ bool PipelineHandlerUVC::match(CameraManager *manager, DeviceEnumerator *enumera\n \tdev_->acquire();\n \n \tstd::shared_ptr<Camera> camera = Camera::create(dev_->model());\n-\tmanager->addCamera(std::move(camera));\n+\tmanager_->addCamera(std::move(camera));\n \n \treturn true;\n }\ndiff --git a/src/libcamera/pipeline/vimc.cpp b/src/libcamera/pipeline/vimc.cpp\nindex 82b9237a3d7d..f12d007cd956 100644\n--- a/src/libcamera/pipeline/vimc.cpp\n+++ b/src/libcamera/pipeline/vimc.cpp\n@@ -17,17 +17,17 @@ namespace libcamera {\n class PipeHandlerVimc : public PipelineHandler\n {\n public:\n-\tPipeHandlerVimc();\n+\tPipeHandlerVimc(CameraManager *manager);\n \t~PipeHandlerVimc();\n \n-\tbool match(CameraManager *manager, DeviceEnumerator *enumerator);\n+\tbool match(DeviceEnumerator *enumerator);\n \n private:\n \tMediaDevice *dev_;\n };\n \n-PipeHandlerVimc::PipeHandlerVimc()\n-\t: dev_(nullptr)\n+PipeHandlerVimc::PipeHandlerVimc(CameraManager *manager)\n+\t: PipelineHandler(manager), dev_(nullptr)\n {\n }\n \n@@ -37,7 +37,7 @@ PipeHandlerVimc::~PipeHandlerVimc()\n \t\tdev_->release();\n }\n \n-bool PipeHandlerVimc::match(CameraManager *manager, DeviceEnumerator *enumerator)\n+bool PipeHandlerVimc::match(DeviceEnumerator *enumerator)\n {\n \tDeviceMatch dm(\"vimc\");\n \n@@ -65,7 +65,7 @@ bool PipeHandlerVimc::match(CameraManager *manager, DeviceEnumerator *enumerator\n \t * object is modeled.\n \t */\n \tstd::shared_ptr<Camera> camera = Camera::create(\"Dummy VIMC Camera\");\n-\tmanager->addCamera(std::move(camera));\n+\tmanager_->addCamera(std::move(camera));\n \n \treturn true;\n }\ndiff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp\nindex c24feeafc503..45788487b5c0 100644\n--- a/src/libcamera/pipeline_handler.cpp\n+++ b/src/libcamera/pipeline_handler.cpp\n@@ -34,18 +34,30 @@ LOG_DEFINE_CATEGORY(Pipeline)\n  * with the pipelines it supports and creates corresponding Camera devices.\n  */\n \n+/**\n+ * \\brief Construct a PipelineHandler instance\n+ * \\param[in] manager The camera manager\n+ */\n+PipelineHandler::PipelineHandler(CameraManager *manager)\n+\t: manager_(manager)\n+{\n+}\n+\n+PipelineHandler::~PipelineHandler()\n+{\n+}\n+\n /**\n  * \\fn PipelineHandler::match(DeviceEnumerator *enumerator)\n  * \\brief Match media devices and create camera instances\n- * \\param manager The camera manager\n  * \\param enumerator The enumerator providing all media devices found in the\n  * system\n  *\n  * This function is the main entry point of the pipeline handler. It is called\n- * by the camera manager with the \\a manager and \\a enumerator passed as\n- * arguments. It shall acquire from the \\a enumerator all the media devices it\n- * needs for a single pipeline, create one or multiple Camera instances and\n- * register them with the \\a manager.\n+ * by the camera manager with the \\a enumerator passed as an argument. It shall\n+ * acquire from the \\a enumerator all the media devices it needs for a single\n+ * pipeline, create one or multiple Camera instances and register them with the\n+ * camera manager.\n  *\n  * If all media devices needed by the pipeline handler are found, they must all\n  * be acquired by a call to MediaDevice::acquire(). This function shall then\n@@ -66,6 +78,15 @@ LOG_DEFINE_CATEGORY(Pipeline)\n  * created, or false otherwise\n  */\n \n+/**\n+ * \\var PipelineHandler::manager_\n+ * \\brief The Camera manager associated with the pipeline handler\n+ *\n+ * The camera manager pointer is stored in the pipeline handler for the\n+ * convenience of pipeline handler implementations. It remains valid and\n+ * constant for the whole lifetime of the pipeline handler.\n+ */\n+\n /**\n  * \\class PipelineHandlerFactory\n  * \\brief Registration of PipelineHandler classes and creation of instances\n@@ -96,8 +117,11 @@ PipelineHandlerFactory::PipelineHandlerFactory(const char *name)\n /**\n  * \\fn PipelineHandlerFactory::create()\n  * \\brief Create an instance of the PipelineHandler corresponding to the factory\n+ * \\param[in] manager The camera manager\n  *\n- * This virtual function is implemented by the REGISTER_PIPELINE_HANDLER() macro.\n+ * This virtual function is implemented by the REGISTER_PIPELINE_HANDLER()\n+ * macro. It creates a pipeline handler instance associated with the camera\n+ * \\a manager.\n  *\n  * \\return a pointer to a newly constructed instance of the PipelineHandler\n  * subclass corresponding to the factory\n","prefixes":["libcamera-devel","01/10"]}