Show a patch.

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

{
    "id": 1375,
    "url": "https://patchwork.libcamera.org/api/patches/1375/?format=api",
    "web_url": "https://patchwork.libcamera.org/patch/1375/",
    "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": "<20190606205654.9311-4-kieran.bingham@ideasonboard.com>",
    "date": "2019-06-06T20:56:52",
    "name": "[libcamera-devel,RFC,3/5] libcamera: pipeline: Add readControls(), writeControl() interfaces",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": false,
    "hash": "7aca346ce30ba53e915d1abb424b7ac6491218c6",
    "submitter": {
        "id": 4,
        "url": "https://patchwork.libcamera.org/api/people/4/?format=api",
        "name": "Kieran Bingham",
        "email": "kieran.bingham@ideasonboard.com"
    },
    "delegate": null,
    "mbox": "https://patchwork.libcamera.org/patch/1375/mbox/",
    "series": [
        {
            "id": 340,
            "url": "https://patchwork.libcamera.org/api/series/340/?format=api",
            "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=340",
            "date": "2019-06-06T20:56:49",
            "name": "Libcamera Controls",
            "version": 1,
            "mbox": "https://patchwork.libcamera.org/series/340/mbox/"
        }
    ],
    "comments": "https://patchwork.libcamera.org/api/patches/1375/comments/",
    "check": "pending",
    "checks": "https://patchwork.libcamera.org/api/patches/1375/checks/",
    "tags": {},
    "headers": {
        "Return-Path": "<kieran.bingham@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 C881860BB7\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu,  6 Jun 2019 22:56:58 +0200 (CEST)",
            "from localhost.localdomain\n\t(cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 6399ED87;\n\tThu,  6 Jun 2019 22:56:58 +0200 (CEST)"
        ],
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1559854618;\n\tbh=jB7fjuFM07QGwg1K2Vzb0MDgOJEvI0E6GIBudIfQw+A=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=WEc0BuIrxd/1vtV0qtD0zCZ2EYy9FDxqDggcx6CePwKt32GcNHpreuQoTK0Fg/vqb\n\tz6AOGFxocGjIuCSu4Cdd29749Tdk7UG1OpiqdfG2t2IedKwXPL7ccPuLkNyMBTR9u2\n\tXBBoJMVTkQycVR7cHOD7U9iIGuuTya4UuA7gLdUQ=",
        "From": "Kieran Bingham <kieran.bingham@ideasonboard.com>",
        "To": "LibCamera Devel <libcamera-devel@lists.libcamera.org>",
        "Date": "Thu,  6 Jun 2019 21:56:52 +0100",
        "Message-Id": "<20190606205654.9311-4-kieran.bingham@ideasonboard.com>",
        "X-Mailer": "git-send-email 2.20.1",
        "In-Reply-To": "<20190606205654.9311-1-kieran.bingham@ideasonboard.com>",
        "References": "<20190606205654.9311-1-kieran.bingham@ideasonboard.com>",
        "MIME-Version": "1.0",
        "Content-Transfer-Encoding": "8bit",
        "Subject": "[libcamera-devel] [RFC PATCH 3/5] libcamera: pipeline: Add\n\treadControls(), writeControl() interfaces",
        "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, 06 Jun 2019 20:56:59 -0000"
    },
    "content": "Pipeline handlers must implement functions to handle controls as part of\ntheir interface.\n\nExtend the pipeline handler interface to declare this requirement and\nimplement basic control functionality in the currently supported\nPipelineHandlers\n---\n src/libcamera/include/pipeline_handler.h |   3 +\n src/libcamera/pipeline/ipu3/ipu3.cpp     |  19 ++++\n src/libcamera/pipeline/raspberrypi.cpp   | 108 ++++++++++++++++++-\n src/libcamera/pipeline/rkisp1/rkisp1.cpp |  19 ++++\n src/libcamera/pipeline/uvcvideo.cpp      | 127 ++++++++++++++++++++++-\n src/libcamera/pipeline/vimc.cpp          |  19 ++++\n 6 files changed, 293 insertions(+), 2 deletions(-)",
    "diff": "diff --git a/src/libcamera/include/pipeline_handler.h b/src/libcamera/include/pipeline_handler.h\nindex 7da6df1ab2a0..4e306d964bff 100644\n--- a/src/libcamera/include/pipeline_handler.h\n+++ b/src/libcamera/include/pipeline_handler.h\n@@ -72,6 +72,9 @@ public:\n \tvirtual int start(Camera *camera) = 0;\n \tvirtual void stop(Camera *camera);\n \n+\tvirtual int readControls(Camera *camera, Request *request) = 0;\n+\tvirtual int writeControls(Camera *camera, Request *request) = 0;\n+\n \tvirtual int queueRequest(Camera *camera, Request *request);\n \n \tbool completeBuffer(Camera *camera, Request *request, Buffer *buffer);\ndiff --git a/src/libcamera/pipeline/ipu3/ipu3.cpp b/src/libcamera/pipeline/ipu3/ipu3.cpp\nindex 11e25e276c81..811a7c85bfc8 100644\n--- a/src/libcamera/pipeline/ipu3/ipu3.cpp\n+++ b/src/libcamera/pipeline/ipu3/ipu3.cpp\n@@ -213,6 +213,9 @@ public:\n \tint start(Camera *camera) override;\n \tvoid stop(Camera *camera) override;\n \n+\tint readControls(Camera *camera, Request *request) override;\n+\tint writeControls(Camera *camera, Request *request) override;\n+\n \tint queueRequest(Camera *camera, Request *request) override;\n \n \tbool match(DeviceEnumerator *enumerator) override;\n@@ -812,6 +815,22 @@ void PipelineHandlerIPU3::stop(Camera *camera)\n \tPipelineHandler::stop(camera);\n }\n \n+int PipelineHandlerIPU3::readControls(Camera *camera, Request *request)\n+{\n+\tLOG(IPU3, Error)\n+\t\t<< \"NOT IMPLEMENTED\";\n+\n+\treturn -EINVAL;\n+}\n+\n+int PipelineHandlerIPU3::writeControls(Camera *camera, Request *request)\n+{\n+\tLOG(IPU3, Error)\n+\t\t<< \"NOT IMPLEMENTED\";\n+\n+\treturn -EINVAL;\n+}\n+\n int PipelineHandlerIPU3::queueRequest(Camera *camera, Request *request)\n {\n \tint error = 0;\ndiff --git a/src/libcamera/pipeline/raspberrypi.cpp b/src/libcamera/pipeline/raspberrypi.cpp\nindex d6749eaae759..337554501c82 100644\n--- a/src/libcamera/pipeline/raspberrypi.cpp\n+++ b/src/libcamera/pipeline/raspberrypi.cpp\n@@ -15,6 +15,7 @@\n #include \"media_device.h\"\n #include \"pipeline_handler.h\"\n #include \"utils.h\"\n+#include \"v4l2_controls.h\"\n #include \"v4l2_device.h\"\n \n namespace libcamera {\n@@ -77,6 +78,9 @@ public:\n \tint start(Camera *camera) override;\n \tvoid stop(Camera *camera) override;\n \n+\tint writeControls(Camera *camera, Request *request);\n+\tint readControls(Camera *camera, Request *request);\n+\n \tint queueRequest(Camera *camera, Request *request) override;\n \n \tbool match(DeviceEnumerator *enumerator) override;\n@@ -293,6 +297,94 @@ void PipelineHandlerRPi::stop(Camera *camera)\n \tPipelineHandler::stop(camera);\n }\n \n+int PipelineHandlerRPi::writeControls(Camera *camera, Request *request)\n+{\n+\tRPiCameraData *data = cameraData(camera);\n+\n+\tstd::vector<V4L2Control *> controls;\n+\n+\tfor (Control c : request->controls()) {\n+\t\tif (c.value().isWrite()) {\n+\t\t\tswitch (c.id()) {\n+\t\t\tcase ManualGain:\n+\t\t\t\tbreak;\n+\t\t\tcase ManualExposure:\n+\t\t\t\tbreak;\n+\t\t\tdefault:\n+\t\t\t\tLOG(RPI, Error)\n+\t\t\t\t\t<< \"Unhandled write control\";\n+\t\t\t\tbreak;\n+\t\t\t}\n+\t\t}\n+\t}\n+\n+\t/* Perhaps setControls could accept an empty vector/list as success? */\n+\tif (!controls.empty())\n+\t\treturn data->unicam_->setControls(controls);\n+\n+\treturn 0;\n+}\n+\n+/* This is becoming horrible. How can we improve this\n+ * - Iterate reqeust controls to find controls to read\n+ * - Add those to a new list\n+ * - Query the device for that list to get controls\n+ * - iterate returned list\n+ * \t- For each control, search for corresponding control in request\n+ * \t- Set control value to return value.\n+ * \t- Return list.\n+ * \t- Check for any values that were not updated?\n+ */\n+int PipelineHandlerRPi::readControls(Camera *camera, Request *request)\n+{\n+\tRPiCameraData *data = cameraData(camera);\n+\tstd::vector<unsigned int> controlIDs;\n+\tstd::vector<V4L2Control *> controls;\n+\n+\tfor (Control c : request->controls()) {\n+\t\tif (c.value().isRead()) {\n+\t\t\tLOG(RPI, Error) << \"Read Control: \" << c;\n+\n+\t\t\tswitch (c.id()) {\n+\t\t\tcase ManualGain:\n+\t\t\t\tcontrolIDs.push_back(V4L2_CID_ANALOGUE_GAIN);\n+\t\t\t\tbreak;\n+\t\t\tcase ManualExposure:\n+\t\t\t\tcontrolIDs.push_back(V4L2_CID_EXPOSURE);\n+\t\t\t\tbreak;\n+\t\t\tdefault:\n+\t\t\t\tLOG(RPI, Error)\n+\t\t\t\t\t<< \"Unhandled write control\";\n+\t\t\t\tbreak;\n+\t\t\t}\n+\t\t}\n+\t}\n+\n+\t/* Perhaps setControls could accept an empty vector/list as success? */\n+\tif (controlIDs.empty())\n+\t\treturn 0;\n+\n+\tcontrols = data->unicam_->getControls(controlIDs);\n+\tif (controls.empty())\n+\t\treturn -ENODATA;\n+\n+\tfor (V4L2Control *ctrl : controls) {\n+\t\tswitch(ctrl->id()) {\n+\t\tcase V4L2_CID_ANALOGUE_GAIN:\n+\t\t\t//Control gain(ManualGain); //= request->controls().find(ManualGain);\n+\t\t\tauto it = request->controls().find(ManualGain);\n+\t\t\tControl gain = *it;\n+\n+\t\t\t//V4L2IntControl *c = static_cast<V4L2IntControl *>(ctrl);\n+\t\t\tgain.value().set(0x88);\n+\n+\t\t\tbreak;\n+\t\t}\n+\t}\n+\n+\treturn 0;\n+}\n+\n int PipelineHandlerRPi::queueRequest(Camera *camera, Request *request)\n {\n \tRPiCameraData *data = cameraData(camera);\n@@ -304,7 +396,15 @@ int PipelineHandlerRPi::queueRequest(Camera *camera, Request *request)\n \t\treturn -ENOENT;\n \t}\n \n-\tint ret = data->isp_.capture->queueBuffer(buffer);\n+\t/*\n+\t * Handle 'set' controls first\n+\t * Todo: Validate ordering and timing.\n+\t */\n+\tint ret = writeControls(camera, request);\n+\tif (ret < 0)\n+\t\treturn ret;\n+\n+\tret = data->isp_.capture->queueBuffer(buffer);\n \tif (ret < 0)\n \t\treturn ret;\n \n@@ -394,6 +494,12 @@ void RPiCameraData::ispCaptureReady(Buffer *buffer)\n \tRequest *request = queuedRequests_.front();\n \n \tpipe_->completeBuffer(camera_, request, buffer);\n+\n+\tint ret = pipe_->readControls(camera_, request);\n+\tif (ret < 0)\n+\t\tLOG(RPI, Error)\n+\t\t\t<< \"Failed to read controls. No way to pass error\";\n+\n \tpipe_->completeRequest(camera_, request);\n }\n \ndiff --git a/src/libcamera/pipeline/rkisp1/rkisp1.cpp b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\nindex 9b3eea2f6dd3..d618d9c34a22 100644\n--- a/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n+++ b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n@@ -88,6 +88,9 @@ public:\n \tint start(Camera *camera) override;\n \tvoid stop(Camera *camera) override;\n \n+\tint readControls(Camera *camera, Request *request) override;\n+\tint writeControls(Camera *camera, Request *request) override;\n+\n \tint queueRequest(Camera *camera, Request *request) override;\n \n \tbool match(DeviceEnumerator *enumerator) override;\n@@ -359,6 +362,22 @@ void PipelineHandlerRkISP1::stop(Camera *camera)\n \tactiveCamera_ = nullptr;\n }\n \n+int PipelineHandlerRkISP1::readControls(Camera *camera, Request *request)\n+{\n+\tLOG(RkISP1, Error)\n+\t\t<< \"NOT IMPLEMENTED\";\n+\n+\treturn -EINVAL;\n+}\n+\n+int PipelineHandlerRkISP1::writeControls(Camera *camera, Request *request)\n+{\n+\tLOG(RkISP1, Error)\n+\t\t<< \"NOT IMPLEMENTED\";\n+\n+\treturn -EINVAL;\n+}\n+\n int PipelineHandlerRkISP1::queueRequest(Camera *camera, Request *request)\n {\n \tRkISP1CameraData *data = cameraData(camera);\ndiff --git a/src/libcamera/pipeline/uvcvideo.cpp b/src/libcamera/pipeline/uvcvideo.cpp\nindex e2d02c0dafb8..216fbe237827 100644\n--- a/src/libcamera/pipeline/uvcvideo.cpp\n+++ b/src/libcamera/pipeline/uvcvideo.cpp\n@@ -14,6 +14,7 @@\n #include \"media_device.h\"\n #include \"pipeline_handler.h\"\n #include \"utils.h\"\n+#include \"v4l2_controls.h\"\n #include \"v4l2_device.h\"\n \n namespace libcamera {\n@@ -73,6 +74,9 @@ public:\n \tint start(Camera *camera) override;\n \tvoid stop(Camera *camera) override;\n \n+\tint readControls(Camera *camera, Request *request) override;\n+\tint writeControls(Camera *camera, Request *request) override;\n+\n \tint queueRequest(Camera *camera, Request *request) override;\n \n \tbool match(DeviceEnumerator *enumerator) override;\n@@ -252,6 +256,117 @@ void PipelineHandlerUVC::stop(Camera *camera)\n \tPipelineHandler::stop(camera);\n }\n \n+int PipelineHandlerUVC::writeControls(Camera *camera, Request *request)\n+{\n+\tUVCCameraData *data = cameraData(camera);\n+\n+\tstd::vector<V4L2Control *> controls;\n+\n+\tfor (Control c : request->controls()) {\n+\t\tif (c.value().isWrite()) {\n+\t\t\tswitch (c.id()) {\n+\t\t\tcase ManualBrightness:\n+\t\t\t\tcontrols.emplace_back(new V4L2IntControl(V4L2_CID_BRIGHTNESS, c.value().getInt()));\n+\t\t\t\tbreak;\n+\n+\t\t\tcase IpaAwbEnable:\n+\t\t\tcase ManualGain:\n+\t\t\tcase ManualExposure:\n+\t\t\t\tbreak;\n+\t\t\tdefault:\n+\t\t\t\tLOG(UVC, Error)\n+\t\t\t\t\t<< \"Unhandled write control\";\n+\t\t\t\tbreak;\n+\t\t\t}\n+\t\t}\n+\t}\n+\n+\t/* Perhaps setControls could accept an empty vector/list as success? */\n+\tif (!controls.empty()) {\n+\t\tint ret = data->video_->setControls(controls);\n+\n+\t\t/* It would be nice to avoid the need to manually delete\n+\t\t * the controls */\n+\t\tfor (V4L2Control *c : controls)\n+\t\t\tdelete c;\n+\n+\t\treturn ret;\n+\t}\n+\n+\n+\treturn 0;\n+}\n+\n+int PipelineHandlerUVC::readControls(Camera *camera, Request *request)\n+{\n+\tUVCCameraData *data = cameraData(camera);\n+\tstd::vector<unsigned int> controlIDs;\n+\tstd::vector<V4L2Control *> controls;\n+\n+\tfor (Control c : request->controls()) {\n+\t\tif (c.value().isRead()) {\n+\t\t\tLOG(UVC, Error) << \"Read Control: \" << c;\n+\n+\t\t\tswitch (c.id()) {\n+\t\t\tcase ManualBrightness:\n+\t\t\t\tcontrolIDs.push_back(V4L2_CID_BRIGHTNESS);\n+\t\t\t\tbreak;\n+\t\t\tcase ManualGain:\n+\t\t\t\tcontrolIDs.push_back(V4L2_CID_ANALOGUE_GAIN);\n+\t\t\t\tbreak;\n+\t\t\tcase ManualExposure:\n+\t\t\t\tcontrolIDs.push_back(V4L2_CID_EXPOSURE);\n+\t\t\t\tbreak;\n+\t\t\tdefault:\n+\t\t\t\tLOG(UVC, Error)\n+\t\t\t\t\t<< \"Unhandled write control\";\n+\t\t\t\tbreak;\n+\t\t\t}\n+\t\t}\n+\t}\n+\n+\t/* Perhaps setControls could accept an empty vector/list as success? */\n+\tif (controlIDs.empty())\n+\t\treturn 0;\n+\n+\tcontrols = data->video_->getControls(controlIDs);\n+\tif (controls.empty())\n+\t\treturn -ENODATA;\n+\n+\tfor (V4L2Control *ctrl : controls) {\n+\t\tswitch (ctrl->id()) {\n+\t\tcase V4L2_CID_BRIGHTNESS: {\n+\t\t\tControl bright = *request->controls().find(ManualBrightness);\n+\t\t\t/* RFC:\n+\t\t\t * If the iterator doesn't find the control ^\n+\t\t\t * then it causes a segfault, so this is really nasty...\n+\t\t\t * and where just a map might be better - (ornot?) as it\n+\t\t\t * will create the object at that key.\n+\t\t\t * Now , that *shouldn't* happen (we should only look\n+\t\t\t * for controls that were given to us in this\n+\t\t\t * function ... but\n+\t\t\t */\n+\t\t\tV4L2IntControl *vc = static_cast<V4L2IntControl *>(ctrl);\n+\t\t\tbright.value().set(vc->value());\n+\n+\t\t\tLOG(UVC, Debug) << \"Setting Brightness: \" << bright;\n+\n+\t\t\tbreak;\n+\t\t}\n+\t\tcase V4L2_CID_ANALOGUE_GAIN: {\n+\t\t\tControl gain = *request->controls().find(ManualGain);\n+\t\t\tV4L2IntControl *vc = static_cast<V4L2IntControl *>(ctrl);\n+\t\t\tgain.value().set(vc->value());\n+\t\t\tbreak;\n+\t\t}\n+\t\tdefault:\n+\t\t\tLOG(UVC, Warning) << \"Unhandled V4L2 Control ID\";\n+\t\t}\n+\t}\n+\n+\treturn 0;\n+}\n+\n int PipelineHandlerUVC::queueRequest(Camera *camera, Request *request)\n {\n \tUVCCameraData *data = cameraData(camera);\n@@ -263,7 +378,11 @@ int PipelineHandlerUVC::queueRequest(Camera *camera, Request *request)\n \t\treturn -ENOENT;\n \t}\n \n-\tint ret = data->video_->queueBuffer(buffer);\n+\tint ret = writeControls(camera, request);\n+\tif (ret < 0)\n+\t\treturn ret;\n+\n+\tret = data->video_->queueBuffer(buffer);\n \tif (ret < 0)\n \t\treturn ret;\n \n@@ -317,6 +436,12 @@ void UVCCameraData::bufferReady(Buffer *buffer)\n \tRequest *request = queuedRequests_.front();\n \n \tpipe_->completeBuffer(camera_, request, buffer);\n+\n+\tint ret = pipe_->readControls(camera_, request);\n+\tif (ret < 0)\n+\t\tLOG(UVC, Error)\n+\t\t\t<< \"Failed to read controls. No way to pass error\";\n+\n \tpipe_->completeRequest(camera_, request);\n }\n \ndiff --git a/src/libcamera/pipeline/vimc.cpp b/src/libcamera/pipeline/vimc.cpp\nindex 0e4eede351d8..9ecce48c0b12 100644\n--- a/src/libcamera/pipeline/vimc.cpp\n+++ b/src/libcamera/pipeline/vimc.cpp\n@@ -67,6 +67,9 @@ public:\n \tint start(Camera *camera) override;\n \tvoid stop(Camera *camera) override;\n \n+\tint readControls(Camera *camera, Request *request) override;\n+\tint writeControls(Camera *camera, Request *request) override;\n+\n \tint queueRequest(Camera *camera, Request *request) override;\n \n \tbool match(DeviceEnumerator *enumerator) override;\n@@ -210,6 +213,22 @@ void PipelineHandlerVimc::stop(Camera *camera)\n \tPipelineHandler::stop(camera);\n }\n \n+int PipelineHandlerVimc::readControls(Camera *camera, Request *request)\n+{\n+\tLOG(VIMC, Error)\n+\t\t<< \"NOT IMPLEMENTED\";\n+\n+\treturn -EINVAL;\n+}\n+\n+int PipelineHandlerVimc::writeControls(Camera *camera, Request *request)\n+{\n+\tLOG(VIMC, Error)\n+\t\t<< \"NOT IMPLEMENTED\";\n+\n+\treturn -EINVAL;\n+}\n+\n int PipelineHandlerVimc::queueRequest(Camera *camera, Request *request)\n {\n \tVimcCameraData *data = cameraData(camera);\n",
    "prefixes": [
        "libcamera-devel",
        "RFC",
        "3/5"
    ]
}