Show a patch.

GET /api/patches/2798/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 2798,
    "url": "https://patchwork.libcamera.org/api/patches/2798/?format=api",
    "web_url": "https://patchwork.libcamera.org/patch/2798/",
    "project": {
        "id": 1,
        "url": "https://patchwork.libcamera.org/api/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": "<20200206185247.202233-6-jacopo@jmondi.org>",
    "date": "2020-02-06T18:52:45",
    "name": "[libcamera-devel,v2,5/7] libcamera: camera_sensor: Break out properties initialization",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": false,
    "hash": "0682fb6ccb40efd4351a3b5e65937cf1fce09213",
    "submitter": {
        "id": 3,
        "url": "https://patchwork.libcamera.org/api/people/3/?format=api",
        "name": "Jacopo Mondi",
        "email": "jacopo@jmondi.org"
    },
    "delegate": null,
    "mbox": "https://patchwork.libcamera.org/patch/2798/mbox/",
    "series": [
        {
            "id": 664,
            "url": "https://patchwork.libcamera.org/api/series/664/?format=api",
            "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=664",
            "date": "2020-02-06T18:52:40",
            "name": "Camera sensor factory",
            "version": 2,
            "mbox": "https://patchwork.libcamera.org/series/664/mbox/"
        }
    ],
    "comments": "https://patchwork.libcamera.org/api/patches/2798/comments/",
    "check": "pending",
    "checks": "https://patchwork.libcamera.org/api/patches/2798/checks/",
    "tags": {},
    "headers": {
        "Return-Path": "<jacopo@jmondi.org>",
        "Received": [
            "from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net\n\t[217.70.183.199])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 96B6660966\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu,  6 Feb 2020 19:50:20 +0100 (CET)",
            "from uno.lan (93-34-114-233.ip49.fastwebnet.it [93.34.114.233])\n\t(Authenticated sender: jacopo@jmondi.org)\n\tby relay9-d.mail.gandi.net (Postfix) with ESMTPSA id 6A790FF802\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu,  6 Feb 2020 18:50:20 +0000 (UTC)"
        ],
        "X-Originating-IP": "93.34.114.233",
        "From": "Jacopo Mondi <jacopo@jmondi.org>",
        "To": "libcamera-devel@lists.libcamera.org",
        "Date": "Thu,  6 Feb 2020 19:52:45 +0100",
        "Message-Id": "<20200206185247.202233-6-jacopo@jmondi.org>",
        "X-Mailer": "git-send-email 2.24.1",
        "In-Reply-To": "<20200206185247.202233-1-jacopo@jmondi.org>",
        "References": "<20200206185247.202233-1-jacopo@jmondi.org>",
        "MIME-Version": "1.0",
        "Content-Transfer-Encoding": "8bit",
        "Subject": "[libcamera-devel] [PATCH v2 5/7] libcamera: camera_sensor: Break\n\tout properties initialization",
        "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>",
        "X-List-Received-Date": "Thu, 06 Feb 2020 18:50:20 -0000"
    },
    "content": "Refactor the CameraSensor properties initialization to a dedicated virtual\nfunction that derived classes could subclass to register sensor-specific\nproperties values.\n\nWhile at it, move documentation of the properties() method to match the\ndeclaration order in the class definition.\n\nSigned-off-by: Jacopo Mondi <jacopo@jmondi.org>\n---\n src/libcamera/camera_sensor.cpp       | 114 +++++++++++++++-----------\n src/libcamera/include/camera_sensor.h |   5 +-\n 2 files changed, 71 insertions(+), 48 deletions(-)",
    "diff": "diff --git a/src/libcamera/camera_sensor.cpp b/src/libcamera/camera_sensor.cpp\nindex 06d10295a80e..08b2d2acdbfc 100644\n--- a/src/libcamera/camera_sensor.cpp\n+++ b/src/libcamera/camera_sensor.cpp\n@@ -64,7 +64,7 @@ LOG_DEFINE_CATEGORY(CameraSensor);\n  * Once constructed the instance must be initialized with init().\n  */\n CameraSensor::CameraSensor(const MediaEntity *entity)\n-\t: entity_(entity), properties_(properties::properties)\n+\t: properties_(properties::properties), entity_(entity)\n {\n \tsubdev_ = new V4L2Subdevice(entity);\n }\n@@ -106,45 +106,6 @@ int CameraSensor::init()\n \tif (ret < 0)\n \t\treturn ret;\n \n-\t/* Retrieve and store the camera sensor properties. */\n-\tconst ControlInfoMap &controls = subdev_->controls();\n-\tint32_t propertyValue;\n-\n-\t/* Camera Location: default is front location. */\n-\tconst auto &locationControl = controls.find(V4L2_CID_CAMERA_SENSOR_LOCATION);\n-\tif (locationControl != controls.end()) {\n-\t\tint32_t v4l2Location =\n-\t\t\tlocationControl->second.def().get<int32_t>();\n-\n-\t\tswitch (v4l2Location) {\n-\t\tdefault:\n-\t\t\tLOG(CameraSensor, Warning)\n-\t\t\t\t<< \"Unsupported camera location \"\n-\t\t\t\t<< v4l2Location << \", setting to Front\";\n-\t\t\t/* Fall-through */\n-\t\tcase V4L2_LOCATION_FRONT:\n-\t\t\tpropertyValue = properties::CameraLocationFront;\n-\t\t\tbreak;\n-\t\tcase V4L2_LOCATION_BACK:\n-\t\t\tpropertyValue = properties::CameraLocationBack;\n-\t\t\tbreak;\n-\t\tcase V4L2_LOCATION_EXTERNAL:\n-\t\t\tpropertyValue = properties::CameraLocationExternal;\n-\t\t\tbreak;\n-\t\t}\n-\t} else {\n-\t\tpropertyValue = properties::CameraLocationFront;\n-\t}\n-\tproperties_.set(properties::Location, propertyValue);\n-\n-\t/* Camera Rotation: default is 0 degrees. */\n-\tconst auto &rotationControl = controls.find(V4L2_CID_CAMERA_SENSOR_ROTATION);\n-\tif (rotationControl != controls.end())\n-\t\tpropertyValue = rotationControl->second.def().get<int32_t>();\n-\telse\n-\t\tpropertyValue = 0;\n-\tproperties_.set(properties::Rotation, propertyValue);\n-\n \t/* Enumerate and cache media bus codes and sizes. */\n \tconst ImageFormats formats = subdev_->formats(0);\n \tif (formats.isEmpty()) {\n@@ -175,6 +136,62 @@ int CameraSensor::init()\n \tstd::sort(mbusCodes_.begin(), mbusCodes_.end());\n \tstd::sort(sizes_.begin(), sizes_.end());\n \n+\treturn initProperties(subdev_->controls());\n+}\n+\n+/**\n+ * \\brief Initialize the camera sensor properties\n+ * \\param[in] controlMap The map of control information provided by the sensor\n+ *\n+ * This method initializes the camera sensor properties, by inspecting the\n+ * control information reported by the sensor media entity in \\a controlMap.\n+ * For each supported standard V4L2 control reported by the sensor, a libcamera\n+ * property is created and registered in the list of properties supported by the\n+ * sensor.\n+ *\n+ * Derived classes are free to override this method to register sensor specific\n+ * properties as they like, by inspecting custom controls or by adding\n+ * properties with pre-defined values, and eventually call this base class\n+ * implementation to register standard ones.\n+ *\n+ * \\return 0 on success, a negative error code otherwise\n+ */\n+int CameraSensor::initProperties(const ControlInfoMap &controlMap)\n+{\n+\tint32_t propertyValue;\n+\n+\t/* Camera Location: default is front location. */\n+\tconst auto &locationControl = controlMap.find(V4L2_CID_CAMERA_SENSOR_LOCATION);\n+\tif (locationControl != controlMap.end()) {\n+\t\tint32_t v4l2Location =\n+\t\t\tlocationControl->second.def().get<int32_t>();\n+\t\tswitch (v4l2Location) {\n+\t\tcase V4L2_LOCATION_EXTERNAL:\n+\t\t\tpropertyValue = properties::CameraLocationExternal;\n+\t\t\tbreak;\n+\t\tcase V4L2_LOCATION_FRONT:\n+\t\t\tpropertyValue = properties::CameraLocationFront;\n+\t\t\tbreak;\n+\t\tcase V4L2_LOCATION_BACK:\n+\t\t\tpropertyValue = properties::CameraLocationBack;\n+\t\t\tbreak;\n+\t\tdefault:\n+\t\t\tLOG(CameraSensor, Error)\n+\t\t\t\t<< \"Unsupported camera location: \" << v4l2Location;\n+\t\t\treturn -EINVAL;\n+\t\t}\n+\t} else {\n+\t\tpropertyValue = properties::CameraLocationFront;\n+\t}\n+\tproperties_.set(properties::Location, propertyValue);\n+\n+\t/* Camera Rotation: default is 0 degrees. */\n+\tpropertyValue = 0;\n+\tconst auto &rotationControl = controlMap.find(V4L2_CID_CAMERA_SENSOR_ROTATION);\n+\tif (rotationControl != controlMap.end())\n+\t\tpropertyValue = rotationControl->second.def().get<int32_t>();\n+\tproperties_.set(properties::Rotation, propertyValue);\n+\n \treturn 0;\n }\n \n@@ -340,12 +357,6 @@ int CameraSensor::getControls(ControlList *ctrls)\n \treturn subdev_->getControls(ctrls);\n }\n \n-/**\n- * \\fn CameraSensor::properties()\n- * \\brief Retrieve the camera sensor properties\n- * \\return The list of camera sensor properties\n- */\n-\n /**\n  * \\brief Write controls to the sensor\n  * \\param[in] ctrls The list of controls to write\n@@ -376,6 +387,17 @@ int CameraSensor::setControls(ControlList *ctrls)\n \treturn subdev_->setControls(ctrls);\n }\n \n+/**\n+ * \\fn CameraSensor::properties()\n+ * \\brief Retrieve the camera sensor properties\n+ * \\return The list of camera sensor properties\n+ */\n+\n+/**\n+ * \\var CameraSensor::properties_\n+ * \\brief The list of camera sensor properties\n+ */\n+\n std::string CameraSensor::logPrefix() const\n {\n \treturn \"'\" + subdev_->entity()->name() + \"'\";\ndiff --git a/src/libcamera/include/camera_sensor.h b/src/libcamera/include/camera_sensor.h\nindex 2f4a0cc8ad3f..87d3516aaae7 100644\n--- a/src/libcamera/include/camera_sensor.h\n+++ b/src/libcamera/include/camera_sensor.h\n@@ -34,6 +34,7 @@ public:\n \tCameraSensor &operator=(const CameraSensor &) = delete;\n \n \tint init();\n+\tvirtual int initProperties(const ControlInfoMap &controlMap);\n \n \tconst MediaEntity *entity() const { return entity_; }\n \tconst std::vector<unsigned int> &mbusCodes() const { return mbusCodes_; }\n@@ -51,6 +52,8 @@ public:\n \tconst ControlList &properties() const { return properties_; }\n \n protected:\n+\tControlList properties_;\n+\n \tfriend class CameraSensorFactory;\n \texplicit CameraSensor(const MediaEntity *entity);\n \tstd::string logPrefix() const;\n@@ -61,8 +64,6 @@ private:\n \n \tstd::vector<unsigned int> mbusCodes_;\n \tstd::vector<Size> sizes_;\n-\n-\tControlList properties_;\n };\n \n class CameraSensorFactory\n",
    "prefixes": [
        "libcamera-devel",
        "v2",
        "5/7"
    ]
}