Show a patch.

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

{
    "id": 2854,
    "url": "https://patchwork.libcamera.org/api/patches/2854/?format=api",
    "web_url": "https://patchwork.libcamera.org/patch/2854/",
    "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": "<20200218112752.3910410-6-jacopo@jmondi.org>",
    "date": "2020-02-18T11:27:50",
    "name": "[libcamera-devel,v3,5/7] libcamera: camera_sensor: Break out properties initialization",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": true,
    "hash": "308201fcd801b9bf0a7bd914570da2e789577d9f",
    "submitter": {
        "id": 3,
        "url": "https://patchwork.libcamera.org/api/people/3/?format=api",
        "name": "Jacopo Mondi",
        "email": "jacopo@jmondi.org"
    },
    "delegate": {
        "id": 15,
        "url": "https://patchwork.libcamera.org/api/users/15/?format=api",
        "username": "jmondi",
        "first_name": "Jacopo",
        "last_name": "Mondi",
        "email": "jacopo@jmondi.org"
    },
    "mbox": "https://patchwork.libcamera.org/patch/2854/mbox/",
    "series": [
        {
            "id": 685,
            "url": "https://patchwork.libcamera.org/api/series/685/?format=api",
            "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=685",
            "date": "2020-02-18T11:27:45",
            "name": "Camera sensor factory",
            "version": 3,
            "mbox": "https://patchwork.libcamera.org/series/685/mbox/"
        }
    ],
    "comments": "https://patchwork.libcamera.org/api/patches/2854/comments/",
    "check": "pending",
    "checks": "https://patchwork.libcamera.org/api/patches/2854/checks/",
    "tags": {},
    "headers": {
        "Return-Path": "<jacopo@jmondi.org>",
        "Received": [
            "from relay3-d.mail.gandi.net (relay3-d.mail.gandi.net\n\t[217.70.183.195])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id B9B7D61F60\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 18 Feb 2020 12:25:17 +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 relay3-d.mail.gandi.net (Postfix) with ESMTPSA id 5DF576000C;\n\tTue, 18 Feb 2020 11:25:17 +0000 (UTC)"
        ],
        "X-Originating-IP": "93.34.114.233",
        "From": "Jacopo Mondi <jacopo@jmondi.org>",
        "To": "libcamera-devel@lists.libcamera.org",
        "Date": "Tue, 18 Feb 2020 12:27:50 +0100",
        "Message-Id": "<20200218112752.3910410-6-jacopo@jmondi.org>",
        "X-Mailer": "git-send-email 2.25.0",
        "In-Reply-To": "<20200218112752.3910410-1-jacopo@jmondi.org>",
        "References": "<20200218112752.3910410-1-jacopo@jmondi.org>",
        "MIME-Version": "1.0",
        "Content-Transfer-Encoding": "8bit",
        "Subject": "[libcamera-devel] [PATCH v3 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": "Tue, 18 Feb 2020 11:25:18 -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 and make the properties_ and\nsubdev_ fields protected to allow subclasses access.\n\nSigned-off-by: Jacopo Mondi <jacopo@jmondi.org>\n---\n src/libcamera/camera_sensor.cpp       | 115 +++++++++++++++-----------\n src/libcamera/include/camera_sensor.h |   7 +-\n 2 files changed, 73 insertions(+), 49 deletions(-)",
    "diff": "diff --git a/src/libcamera/camera_sensor.cpp b/src/libcamera/camera_sensor.cpp\nindex fa577c62b97a..cc1a05bc029f 100644\n--- a/src/libcamera/camera_sensor.cpp\n+++ b/src/libcamera/camera_sensor.cpp\n@@ -51,7 +51,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@@ -93,45 +93,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@@ -162,6 +123,58 @@ int CameraSensor::init()\n \tstd::sort(mbusCodes_.begin(), mbusCodes_.end());\n \tstd::sort(sizes_.begin(), sizes_.end());\n \n+\treturn initProperties();\n+}\n+\n+/**\n+ * \\brief Initialize the camera sensor properties\n+ *\n+ * This method initializes the camera sensor properties, by inspecting the\n+ * control information reported by the sensor subdevice.\n+ *\n+ * Derived classes may override this method to register sensor-specific\n+ * properties if needed. If they do so, they shall call the base\n+ * initProperties() method to register standard properties.\n+ *\n+ * \\return 0 on success, a negative error code otherwise\n+ */\n+int CameraSensor::initProperties()\n+{\n+\tconst ControlInfoMap &controlMap = subdev_->controls();\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@@ -327,12 +340,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@@ -363,11 +370,27 @@ 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 std::string CameraSensor::logPrefix() const\n {\n \treturn \"'\" + subdev_->entity()->name() + \"'\";\n }\n \n+/**\n+ * \\var CameraSensor::properties_\n+ * \\brief The list of camera sensor properties\n+ */\n+\n+/**\n+ * \\var CameraSensor::subdev_\n+ * \\brief The camera sensor V4L2 subdevice\n+ */\n+\n /**\n  * \\class CameraSensorFactory\n  * \\brief Factory of camera sensors\ndiff --git a/src/libcamera/include/camera_sensor.h b/src/libcamera/include/camera_sensor.h\nindex 633955591b36..747c37e8b2e4 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();\n \n \tconst MediaEntity *entity() const { return entity_; }\n \tconst std::vector<unsigned int> &mbusCodes() const { return mbusCodes_; }\n@@ -53,14 +54,14 @@ public:\n protected:\n \tstd::string logPrefix() const;\n \n+\tControlList properties_;\n+\tV4L2Subdevice *subdev_;\n+\n private:\n \tconst MediaEntity *entity_;\n-\tV4L2Subdevice *subdev_;\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",
        "v3",
        "5/7"
    ]
}