From patchwork Sat Dec 29 03:28:52 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Niklas_S=C3=B6derlund?= X-Patchwork-Id: 103 Return-Path: Received: from bin-mail-out-05.binero.net (bin-mail-out-05.binero.net [195.74.38.228]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 4970860B49 for ; Sat, 29 Dec 2018 04:29:58 +0100 (CET) X-Halon-ID: fcb5f40b-0b19-11e9-911a-0050569116f7 Authorized-sender: niklas@soderlund.pp.se Received: from bismarck.berto.se (unknown [89.233.230.99]) by bin-vsp-out-03.atm.binero.net (Halon) with ESMTPA id fcb5f40b-0b19-11e9-911a-0050569116f7; Sat, 29 Dec 2018 04:29:45 +0100 (CET) From: =?utf-8?q?Niklas_S=C3=B6derlund?= To: libcamera-devel@lists.libcamera.org Date: Sat, 29 Dec 2018 04:28:52 +0100 Message-Id: <20181229032855.26249-10-niklas.soderlund@ragnatech.se> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20181229032855.26249-1-niklas.soderlund@ragnatech.se> References: <20181229032855.26249-1-niklas.soderlund@ragnatech.se> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v2 09/12] libcamera: pipeline_handler: add PipelineHandler class X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 29 Dec 2018 03:29:58 -0000 Provide a PipelineHandler which represents a handler for one or more media devices and provider of one or more cameras. Signed-off-by: Niklas Söderlund Reviewed-by: Laurent Pinchart --- src/libcamera/include/pipeline_handler.h | 62 ++++++++++ src/libcamera/meson.build | 2 + src/libcamera/pipeline_handler.cpp | 138 +++++++++++++++++++++++ 3 files changed, 202 insertions(+) create mode 100644 src/libcamera/include/pipeline_handler.h create mode 100644 src/libcamera/pipeline_handler.cpp diff --git a/src/libcamera/include/pipeline_handler.h b/src/libcamera/include/pipeline_handler.h new file mode 100644 index 0000000000000000..a7805a01e1c779bd --- /dev/null +++ b/src/libcamera/include/pipeline_handler.h @@ -0,0 +1,62 @@ +/* SPDX-License-Identifier: LGPL-2.1-or-later */ +/* + * Copyright (C) 2018, Google Inc. + * + * pipeline_handler.h - Pipeline handler infrastructure + */ +#ifndef __LIBCAMERA_PIPELINE_HANDLER_H__ +#define __LIBCAMERA_PIPELINE_HANDLER_H__ + +#include +#include +#include + +#include + +namespace libcamera { + +class DeviceEnumerator; +class PipelineHandlerFactory; + +class PipelineHandler +{ +public: + virtual ~PipelineHandler() { }; + + virtual bool match(DeviceEnumerator *enumerator) = 0; + + virtual unsigned int count() = 0; + virtual Camera *camera(unsigned int id) = 0; +}; + +class PipelineHandlerFactory +{ +public: + virtual ~PipelineHandlerFactory() { }; + + virtual PipelineHandler *create() = 0; + + static void registerType(const std::string &name, PipelineHandlerFactory *factory); + static PipelineHandler *create(const std::string &name, DeviceEnumerator *enumerator); + static void handlers(std::vector &handlers); + +private: + static std::map ®istry(); +}; + +#define REGISTER_PIPELINE_HANDLER(handler) \ + class handler##Factory : public PipelineHandlerFactory { \ + public: \ + handler##Factory() \ + { \ + PipelineHandlerFactory::registerType(#handler, this); \ + } \ + virtual PipelineHandler *create() { \ + return new handler(); \ + } \ + }; \ + static handler##Factory global_##handler##Factory; + +} /* namespace libcamera */ + +#endif /* __LIBCAMERA_PIPELINE_HANDLER_H__ */ diff --git a/src/libcamera/meson.build b/src/libcamera/meson.build index 581da1aa78ebb3ba..0db648dd3e37156e 100644 --- a/src/libcamera/meson.build +++ b/src/libcamera/meson.build @@ -3,11 +3,13 @@ libcamera_sources = files([ 'device_enumerator.cpp', 'log.cpp', 'main.cpp', + 'pipeline_handler.cpp', ]) libcamera_headers = files([ 'include/device_enumerator.h', 'include/log.h', + 'include/pipeline_handler.h', 'include/utils.h', ]) diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp new file mode 100644 index 0000000000000000..b6e28216a6636faf --- /dev/null +++ b/src/libcamera/pipeline_handler.cpp @@ -0,0 +1,138 @@ +/* SPDX-License-Identifier: LGPL-2.1-or-later */ +/* + * Copyright (C) 2018, Google Inc. + * + * pipeline_handler.cpp - Pipeline handler infrastructure + */ + +#include "device_enumerator.h" +#include "log.h" +#include "pipeline_handler.h" + +/** + * \file pipeline_handler.h + * \brief Create pipelines and cameras from one or more media device + * + * Each pipeline supported by libcamera needs to be backed by a pipeline + * handler implementation which describes the one or many media devices + * needed for a pipeline to function properly. + * + * The pipeline handler is responsible to find all media devices it requires + * to operate and once it retrieves them create all the camera devices + * it is able to support with the that set of devices. + * + * To make it a bit less bit complicated to write pipe line handlers a + * macro REGISTER_PIPELINE_HANDLER() is provided which allows a pipeline + * handler implementation to register itself with the library with ease. + */ + +namespace libcamera { + + +/** + * \class PipelineHandler + * \brief Find a set of media devices and provide cameras + * + * The responsibility of a PipelineHandler is to describe all media + * devices it would need in order to provide cameras to the system. + */ + +/** + * \class PipelineHandlerFactory + * \brief Keep a registry and create instances of available pipeline handlers + * + * The responsibility of the PipelineHandlerFactory is to keep a list + * of all pipelines in the system. Each pipeline handler should register + * it self with the factory using the REGISTER_PIPELINE_HANDLER() macro. + */ + +/** + * \brief Add a pipeline handler to the global list + * + * \param[in] name Name of the pipeline handler to add + * \param[in] factory Factory to use to construct the pipeline + * + * The caller is responsible to guarantee the uniqueness of the pipeline name. + */ +void PipelineHandlerFactory::registerType(const std::string &name, PipelineHandlerFactory *factory) +{ + std::map &factories = registry(); + + if (factories.count(name)) { + LOG(Error) << "Registering '" << name << "' pipeline twice"; + return; + } + + factories[name] = factory; +} + +/** + * \brief Create a new pipeline handler and try to match it + * + * \param[in] name Name of the pipeline handler to try + * \param[in] enumerator Numerator to to search for a match for the handler + * + * Search \a enumerator for a match for a pipeline handler named \a name. + * + * \return Pipeline handler if a match was found else nullptr + */ +PipelineHandler *PipelineHandlerFactory::create(const std::string &name, DeviceEnumerator *enumerator) +{ + std::map &factories = registry(); + + auto it = factories.find(name); + if (it == factories.end()) { + LOG(Error) << "Trying to create non-existing pipeline handler " << name; + return nullptr; + } + + PipelineHandler *pipe; + + pipe = it->second->create(); + + if (pipe->match(enumerator)) + return pipe; + + delete pipe; + return nullptr; +} + +/** + * \brief List all names of handlers from the global list + * + * \param[out] handlers Names of all handlers registered with the global list + */ +void PipelineHandlerFactory::handlers(std::vector &handlers) +{ + std::map &factories = registry(); + + for (auto const &handler : factories) + handlers.push_back(handler.first); +} + +/** + * \brief Static global list of pipeline handlers + * + * It might seem odd to hide the static map inside a function. + * This is needed to make sure the list is created before anyone + * tries to access it and creating problems at link time. + * + * \return Global list of pipeline handlers + */ +std::map &PipelineHandlerFactory::registry() +{ + static std::map factories; + return factories; +} + +/** + * \def REGISTER_PIPELINE_HANDLER + * \brief Register a pipeline handler with the global list + * + * \param[in] handler Class name of PipelineHandler subclass to register + * + * Register a specifc pipline handler with the global list and make it + * avaiable to try and match devices for libcamera. + */ + +} /* namespace libcamera */