From 86fa7300fa915060e25257b41d8ebb514dd55435 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Barnab=C3=A1s=20P=C5=91cze?= Date: Tue, 9 May 2023 23:07:57 +0000 Subject: libcamera: camera: Take span of StreamRole instead of vector MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change the parameter type of `generateConfiguration()` from `const std::vector&` to `libcamera::Span`. A span is almost always preferable to a const vector ref because it does not force dynamic allocation when none are needed, and it allows any contiguous container to be used. A new overload is added that accepts an initializer list so that cam->generateConfiguration({ ... }) keeps working. There is no API break since a span can be constructed from a vector and the initializer list overload takes care of the initializer lists, but this change causes an ABI break. Signed-off-by: Barnabás Pőcze Reviewed-by: Kieran Bingham Reviewed-by: Laurent Pinchart [Kieran: Apply checkstyle fixups] Signed-off-by: Kieran Bingham --- Documentation/guides/pipeline-handler.rst | 4 ++-- include/libcamera/camera.h | 12 +++++++++++- include/libcamera/internal/pipeline_handler.h | 2 +- src/libcamera/camera.cpp | 8 +++++++- src/libcamera/pipeline/imx8-isi/imx8-isi.cpp | 4 ++-- src/libcamera/pipeline/ipu3/ipu3.cpp | 4 ++-- src/libcamera/pipeline/rkisp1/rkisp1.cpp | 4 ++-- src/libcamera/pipeline/rpi/common/pipeline_base.cpp | 2 +- src/libcamera/pipeline/rpi/common/pipeline_base.h | 2 +- src/libcamera/pipeline/simple/simple.cpp | 4 ++-- src/libcamera/pipeline/uvcvideo/uvcvideo.cpp | 4 ++-- src/libcamera/pipeline/vimc/vimc.cpp | 4 ++-- src/py/libcamera/py_main.cpp | 5 ++++- 13 files changed, 39 insertions(+), 20 deletions(-) diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst index 57644534..10b9c75c 100644 --- a/Documentation/guides/pipeline-handler.rst +++ b/Documentation/guides/pipeline-handler.rst @@ -203,7 +203,7 @@ implementations for the overridden class members. PipelineHandlerVivid(CameraManager *manager); CameraConfiguration *generateConfiguration(Camera *camera, - const StreamRoles &roles) override; + Span roles) override; int configure(Camera *camera, CameraConfiguration *config) override; int exportFrameBuffers(Camera *camera, Stream *stream, @@ -223,7 +223,7 @@ implementations for the overridden class members. } CameraConfiguration *PipelineHandlerVivid::generateConfiguration(Camera *camera, - const StreamRoles &roles) + Span roles) { return nullptr; } diff --git a/include/libcamera/camera.h b/include/libcamera/camera.h index 5bb06584..004bc894 100644 --- a/include/libcamera/camera.h +++ b/include/libcamera/camera.h @@ -7,6 +7,7 @@ #pragma once +#include #include #include #include @@ -105,7 +106,16 @@ public: const ControlList &properties() const; const std::set &streams() const; - std::unique_ptr generateConfiguration(const StreamRoles &roles = {}); + + std::unique_ptr + generateConfiguration(Span roles = {}); + + std::unique_ptr + generateConfiguration(std::initializer_list roles) + { + return generateConfiguration(Span(roles.begin(), roles.end())); + } + int configure(CameraConfiguration *config); std::unique_ptr createRequest(uint64_t cookie = 0); diff --git a/include/libcamera/internal/pipeline_handler.h b/include/libcamera/internal/pipeline_handler.h index 4c4dfe62..c96944f4 100644 --- a/include/libcamera/internal/pipeline_handler.h +++ b/include/libcamera/internal/pipeline_handler.h @@ -49,7 +49,7 @@ public: void release(Camera *camera); virtual std::unique_ptr generateConfiguration(Camera *camera, - const StreamRoles &roles) = 0; + Span roles) = 0; virtual int configure(Camera *camera, CameraConfiguration *config) = 0; virtual int exportFrameBuffers(Camera *camera, Stream *stream, diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp index 3e252f3b..0eecee76 100644 --- a/src/libcamera/camera.cpp +++ b/src/libcamera/camera.cpp @@ -937,7 +937,7 @@ const std::set &Camera::streams() const * \return A CameraConfiguration if the requested roles can be satisfied, or a * null pointer otherwise. */ -std::unique_ptr Camera::generateConfiguration(const StreamRoles &roles) +std::unique_ptr Camera::generateConfiguration(Span roles) { Private *const d = _d(); @@ -970,6 +970,12 @@ std::unique_ptr Camera::generateConfiguration(const StreamR return config; } +/** + * \fn std::unique_ptr \ + * Camera::generateConfiguration(std::initializer_list roles) + * \overload + */ + /** * \brief Configure the camera prior to capture * \param[in] config The camera configurations to setup diff --git a/src/libcamera/pipeline/imx8-isi/imx8-isi.cpp b/src/libcamera/pipeline/imx8-isi/imx8-isi.cpp index 449d9012..9bdfff0b 100644 --- a/src/libcamera/pipeline/imx8-isi/imx8-isi.cpp +++ b/src/libcamera/pipeline/imx8-isi/imx8-isi.cpp @@ -104,7 +104,7 @@ public: bool match(DeviceEnumerator *enumerator) override; std::unique_ptr - generateConfiguration(Camera *camera, const StreamRoles &roles) override; + generateConfiguration(Camera *camera, Span roles) override; int configure(Camera *camera, CameraConfiguration *config) override; int exportFrameBuffers(Camera *camera, Stream *stream, @@ -739,7 +739,7 @@ StreamConfiguration PipelineHandlerISI::generateRawConfiguration(Camera *camera) std::unique_ptr PipelineHandlerISI::generateConfiguration(Camera *camera, - const StreamRoles &roles) + Span roles) { ISICameraData *data = cameraData(camera); std::unique_ptr config = diff --git a/src/libcamera/pipeline/ipu3/ipu3.cpp b/src/libcamera/pipeline/ipu3/ipu3.cpp index 355cb0cb..a81c817a 100644 --- a/src/libcamera/pipeline/ipu3/ipu3.cpp +++ b/src/libcamera/pipeline/ipu3/ipu3.cpp @@ -135,7 +135,7 @@ public: PipelineHandlerIPU3(CameraManager *manager); std::unique_ptr generateConfiguration(Camera *camera, - const StreamRoles &roles) override; + Span roles) override; int configure(Camera *camera, CameraConfiguration *config) override; int exportFrameBuffers(Camera *camera, Stream *stream, @@ -390,7 +390,7 @@ PipelineHandlerIPU3::PipelineHandlerIPU3(CameraManager *manager) } std::unique_ptr -PipelineHandlerIPU3::generateConfiguration(Camera *camera, const StreamRoles &roles) +PipelineHandlerIPU3::generateConfiguration(Camera *camera, Span roles) { IPU3CameraData *data = cameraData(camera); std::unique_ptr config = diff --git a/src/libcamera/pipeline/rkisp1/rkisp1.cpp b/src/libcamera/pipeline/rkisp1/rkisp1.cpp index 91a3c607..6efa79f2 100644 --- a/src/libcamera/pipeline/rkisp1/rkisp1.cpp +++ b/src/libcamera/pipeline/rkisp1/rkisp1.cpp @@ -148,7 +148,7 @@ public: PipelineHandlerRkISP1(CameraManager *manager); std::unique_ptr generateConfiguration(Camera *camera, - const StreamRoles &roles) override; + Span roles) override; int configure(Camera *camera, CameraConfiguration *config) override; int exportFrameBuffers(Camera *camera, Stream *stream, @@ -611,7 +611,7 @@ PipelineHandlerRkISP1::PipelineHandlerRkISP1(CameraManager *manager) std::unique_ptr PipelineHandlerRkISP1::generateConfiguration(Camera *camera, - const StreamRoles &roles) + Span roles) { RkISP1CameraData *data = cameraData(camera); diff --git a/src/libcamera/pipeline/rpi/common/pipeline_base.cpp b/src/libcamera/pipeline/rpi/common/pipeline_base.cpp index df748292..d438bdb6 100644 --- a/src/libcamera/pipeline/rpi/common/pipeline_base.cpp +++ b/src/libcamera/pipeline/rpi/common/pipeline_base.cpp @@ -381,7 +381,7 @@ V4L2DeviceFormat PipelineHandlerBase::toV4L2DeviceFormat(const V4L2VideoDevice * } std::unique_ptr -PipelineHandlerBase::generateConfiguration(Camera *camera, const StreamRoles &roles) +PipelineHandlerBase::generateConfiguration(Camera *camera, Span roles) { CameraData *data = cameraData(camera); std::unique_ptr config = diff --git a/src/libcamera/pipeline/rpi/common/pipeline_base.h b/src/libcamera/pipeline/rpi/common/pipeline_base.h index 6b19b56c..f648e810 100644 --- a/src/libcamera/pipeline/rpi/common/pipeline_base.h +++ b/src/libcamera/pipeline/rpi/common/pipeline_base.h @@ -214,7 +214,7 @@ public: BayerFormat::Packing packingReq); std::unique_ptr - generateConfiguration(Camera *camera, const StreamRoles &roles) override; + generateConfiguration(Camera *camera, Span roles) override; int configure(Camera *camera, CameraConfiguration *config) override; int exportFrameBuffers(Camera *camera, libcamera::Stream *stream, diff --git a/src/libcamera/pipeline/simple/simple.cpp b/src/libcamera/pipeline/simple/simple.cpp index 050285fd..7495587c 100644 --- a/src/libcamera/pipeline/simple/simple.cpp +++ b/src/libcamera/pipeline/simple/simple.cpp @@ -316,7 +316,7 @@ public: SimplePipelineHandler(CameraManager *manager); std::unique_ptr generateConfiguration(Camera *camera, - const StreamRoles &roles) override; + Span roles) override; int configure(Camera *camera, CameraConfiguration *config) override; int exportFrameBuffers(Camera *camera, Stream *stream, @@ -1044,7 +1044,7 @@ SimplePipelineHandler::SimplePipelineHandler(CameraManager *manager) } std::unique_ptr -SimplePipelineHandler::generateConfiguration(Camera *camera, const StreamRoles &roles) +SimplePipelineHandler::generateConfiguration(Camera *camera, Span roles) { SimpleCameraData *data = cameraData(camera); std::unique_ptr config = diff --git a/src/libcamera/pipeline/uvcvideo/uvcvideo.cpp b/src/libcamera/pipeline/uvcvideo/uvcvideo.cpp index 277465b7..38f48a5d 100644 --- a/src/libcamera/pipeline/uvcvideo/uvcvideo.cpp +++ b/src/libcamera/pipeline/uvcvideo/uvcvideo.cpp @@ -75,7 +75,7 @@ public: PipelineHandlerUVC(CameraManager *manager); std::unique_ptr generateConfiguration(Camera *camera, - const StreamRoles &roles) override; + Span roles) override; int configure(Camera *camera, CameraConfiguration *config) override; int exportFrameBuffers(Camera *camera, Stream *stream, @@ -180,7 +180,7 @@ PipelineHandlerUVC::PipelineHandlerUVC(CameraManager *manager) std::unique_ptr PipelineHandlerUVC::generateConfiguration(Camera *camera, - const StreamRoles &roles) + Span roles) { UVCCameraData *data = cameraData(camera); std::unique_ptr config = diff --git a/src/libcamera/pipeline/vimc/vimc.cpp b/src/libcamera/pipeline/vimc/vimc.cpp index 204f5ad7..00e6f4c6 100644 --- a/src/libcamera/pipeline/vimc/vimc.cpp +++ b/src/libcamera/pipeline/vimc/vimc.cpp @@ -85,7 +85,7 @@ public: PipelineHandlerVimc(CameraManager *manager); std::unique_ptr generateConfiguration(Camera *camera, - const StreamRoles &roles) override; + Span roles) override; int configure(Camera *camera, CameraConfiguration *config) override; int exportFrameBuffers(Camera *camera, Stream *stream, @@ -191,7 +191,7 @@ PipelineHandlerVimc::PipelineHandlerVimc(CameraManager *manager) std::unique_ptr PipelineHandlerVimc::generateConfiguration(Camera *camera, - const StreamRoles &roles) + Span roles) { VimcCameraData *data = cameraData(camera); std::unique_ptr config = diff --git a/src/py/libcamera/py_main.cpp b/src/py/libcamera/py_main.cpp index 5a5f1a37..01fb15a9 100644 --- a/src/py/libcamera/py_main.cpp +++ b/src/py/libcamera/py_main.cpp @@ -208,7 +208,10 @@ PYBIND11_MODULE(_libcamera, m) }) /* Keep the camera alive, as StreamConfiguration contains a Stream* */ - .def("generate_configuration", &Camera::generateConfiguration, py::keep_alive<0, 1>()) + .def("generate_configuration", [](Camera &self, const std::vector &roles) { + return self.generateConfiguration(roles); + }, py::keep_alive<0, 1>()) + .def("configure", [](Camera &self, CameraConfiguration *config) { int ret = self.configure(config); if (ret) -- cgit v1.2.1