libcamera: include/libcamera/internal/pipeline_handler.h Source File

libcamera v0.7.0 Supporting cameras in Linux since 2019

Loading...
Searching...
No Matches
pipeline_handler.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: LGPL-2.1-or-later */
2/*
3 * Copyright (C) 2018, Google Inc.
4 *
5 * Pipeline handler infrastructure
6 */
7
8#pragma once
9
10#include <memory>
11#include <string>
12#include <sys/types.h>
13#include <vector>
14
15#include <libcamera/base/object.h>
16
17#include <libcamera/controls.h>
18#include <libcamera/stream.h>
19
20namespace libcamera {
21
22class Camera;
23class CameraConfiguration;
24class CameraManager;
25class DeviceEnumerator;
26class DeviceMatch;
27class FrameBuffer;
28class MediaDevice;
29class PipelineHandler;
30class Request;
31
32 class PipelineHandler : public std::enable_shared_from_this<PipelineHandler>,
33 public Object
34{
35public:
36 PipelineHandler(CameraManager *manager,
37 unsigned int maxQueuedRequestsDevice = 32);
38 virtual ~PipelineHandler();
39
40 virtual bool match(DeviceEnumerator *enumerator) = 0;
41 std::shared_ptr<MediaDevice> acquireMediaDevice(DeviceEnumerator *enumerator,
42 const DeviceMatch &dm);
43
44 bool acquire(Camera *camera);
45 void release(Camera *camera);
46
47 virtual std::unique_ptr<CameraConfiguration> generateConfiguration(Camera *camera,
48 Span<const StreamRole> roles) = 0;
49 virtual int configure(Camera *camera, CameraConfiguration *config) = 0;
50
51 virtual int exportFrameBuffers(Camera *camera, Stream *stream,
52 std::vector<std::unique_ptr<FrameBuffer>> *buffers) = 0;
53
54 virtual int start(Camera *camera, const ControlList *controls) = 0;
55 void stop(Camera *camera);
56 bool hasPendingRequests(const Camera *camera) const;
57
58 void registerRequest(Request *request);
59 void queueRequest(Request *request);
60
61 bool completeBuffer(Request *request, FrameBuffer *buffer);
62 void completeRequest(Request *request);
63 void cancelRequest(Request *request);
64
65 std::string configurationFile(const std::string &subdir,
66 const std::string &name,
67 bool silent = false) const;
68
69 const char *name() const { return name_; }
70
71 CameraManager *cameraManager() const { return manager_; }
72
73protected:
74 void registerCamera(std::shared_ptr<Camera> camera);
75 void hotplugMediaDevice(std::shared_ptr<MediaDevice> media);
76 unsigned int useCount() const { return useCount_; }
77
78 virtual int queueRequestDevice(Camera *camera, Request *request) = 0;
79 virtual void stopDevice(Camera *camera) = 0;
80
81 virtual bool acquireDevice(Camera *camera);
82 virtual void releaseDevice(Camera *camera);
83
84 CameraManager *manager_;
85 const unsigned int maxQueuedRequestsDevice_;
86
87private:
88 void unlockMediaDevices();
89
90 void mediaDeviceDisconnected(std::shared_ptr<MediaDevice> media);
91 virtual void disconnect();
92
93 void doQueueRequest(Request *request);
94 void doQueueRequests(Camera *camera);
95
96 std::vector<std::shared_ptr<MediaDevice>> mediaDevices_;
97 std::vector<std::weak_ptr<Camera>> cameras_;
98
99 const char *name_;
100 unsigned int useCount_;
101
102 friend class PipelineHandlerFactoryBase;
103};
104
105 class PipelineHandlerFactoryBase
106{
107public:
108 PipelineHandlerFactoryBase(const char *name);
109 virtual ~PipelineHandlerFactoryBase() = default;
110
111 std::shared_ptr<PipelineHandler> create(CameraManager *manager) const;
112
113 const std::string &name() const { return name_; }
114
115 static std::vector<PipelineHandlerFactoryBase *> &factories();
116 static const PipelineHandlerFactoryBase *getFactoryByName(const std::string &name);
117
118private:
119 static void registerType(PipelineHandlerFactoryBase *factory);
120
121 virtual std::unique_ptr<PipelineHandler>
122 createInstance(CameraManager *manager) const = 0;
123
124 std::string name_;
125};
126
127template<typename _PipelineHandler>
128 class PipelineHandlerFactory final : public PipelineHandlerFactoryBase
129{
130public:
131 PipelineHandlerFactory(const char *name)
132 : PipelineHandlerFactoryBase(name)
133 {
134 }
135
136 std::unique_ptr<PipelineHandler>
137 createInstance(CameraManager *manager) const override
138 {
139 return std::make_unique<_PipelineHandler>(manager);
140 }
141};
142
143#define REGISTER_PIPELINE_HANDLER(handler, name) \
144 static PipelineHandlerFactory<handler> global_##handler##Factory(name);
145
146} /* namespace libcamera */
libcamera::CameraConfiguration
Hold configuration for streams of the camera.
Definition camera.h:60
libcamera::CameraManager
Provide access and manage all cameras in the system.
Definition camera_manager.h:25
libcamera::Camera
Camera device.
Definition camera.h:115
libcamera::ControlList
Associate a list of ControlId with their values for an object.
Definition controls.h:409
libcamera::DeviceEnumerator
Enumerate, store and search media devices.
Definition device_enumerator.h:38
libcamera::DeviceMatch
Description of a media device search pattern.
Definition device_enumerator.h:22
libcamera::FrameBuffer
Frame buffer data and its associated dynamic metadata.
Definition framebuffer.h:50
libcamera::MediaDevice
The MediaDevice represents a Media Controller device with its full graph of connected objects.
Definition media_device.h:28
libcamera::Object::Object
Object(Object *parent=nullptr)
Construct an Object instance.
Definition object.cpp:69
libcamera::PipelineHandlerFactoryBase
Base class for pipeline handler factories.
Definition pipeline_handler.h:106
libcamera::PipelineHandlerFactoryBase::name
const std::string & name() const
Retrieve the factory name.
Definition pipeline_handler.h:113
libcamera::PipelineHandlerFactoryBase::getFactoryByName
static const PipelineHandlerFactoryBase * getFactoryByName(const std::string &name)
Return the factory for the pipeline handler with name name.
Definition pipeline_handler.cpp:918
libcamera::PipelineHandlerFactoryBase::PipelineHandlerFactoryBase
PipelineHandlerFactoryBase(const char *name)
Construct a pipeline handler factory base.
Definition pipeline_handler.cpp:857
libcamera::PipelineHandlerFactoryBase::factories
static std::vector< PipelineHandlerFactoryBase * > & factories()
Retrieve the list of all pipeline handler factories.
Definition pipeline_handler.cpp:902
libcamera::PipelineHandlerFactoryBase::create
std::shared_ptr< PipelineHandler > create(CameraManager *manager) const
Create an instance of the PipelineHandler corresponding to the factory.
Definition pipeline_handler.cpp:870
libcamera::PipelineHandlerFactory::PipelineHandlerFactory
PipelineHandlerFactory(const char *name)
Construct a pipeline handler factory.
Definition pipeline_handler.h:131
libcamera::PipelineHandlerFactory::createInstance
std::unique_ptr< PipelineHandler > createInstance(CameraManager *manager) const override
Create an instance of the PipelineHandler corresponding to the factory.
Definition pipeline_handler.h:137
libcamera::PipelineHandler
Create and manage cameras based on a set of media devices.
Definition pipeline_handler.h:34
libcamera::PipelineHandler::stopDevice
virtual void stopDevice(Camera *camera)=0
Stop capturing from all running streams.
libcamera::PipelineHandler::hotplugMediaDevice
void hotplugMediaDevice(std::shared_ptr< MediaDevice > media)
Enable hotplug handling for a media device.
Definition pipeline_handler.cpp:739
libcamera::PipelineHandler::cameraManager
CameraManager * cameraManager() const
Retrieve the CameraManager that this pipeline handler belongs to.
Definition pipeline_handler.h:71
libcamera::PipelineHandler::configurationFile
std::string configurationFile(const std::string &subdir, const std::string &name, bool silent=false) const
Retrieve the absolute path to a platform configuration file.
Definition pipeline_handler.cpp:638
libcamera::PipelineHandler::name
const char * name() const
Retrieve the pipeline handler name.
Definition pipeline_handler.h:69
libcamera::PipelineHandler::manager_
CameraManager * manager_
The Camera manager associated with the pipeline handler.
Definition pipeline_handler.h:84
libcamera::PipelineHandler::completeRequest
void completeRequest(Request *request)
Signal request completion.
Definition pipeline_handler.cpp:584
libcamera::PipelineHandler::releaseDevice
virtual void releaseDevice(Camera *camera)
Release resources associated with this camera.
Definition pipeline_handler.cpp:260
libcamera::PipelineHandler::queueRequestDevice
virtual int queueRequestDevice(Camera *camera, Request *request)=0
Queue a request to the device.
libcamera::PipelineHandler::acquire
bool acquire(Camera *camera)
Acquire exclusive access to the pipeline handler for the process.
Definition pipeline_handler.cpp:171
libcamera::PipelineHandler::useCount
unsigned int useCount() const
Retrieve the pipeline handler's used camera count.
Definition pipeline_handler.h:76
libcamera::PipelineHandler::acquireDevice
virtual bool acquireDevice(Camera *camera)
Acquire resources associated with this camera.
Definition pipeline_handler.cpp:239
libcamera::PipelineHandler::match
virtual bool match(DeviceEnumerator *enumerator)=0
Match media devices and create camera instances.
libcamera::PipelineHandler::registerCamera
void registerCamera(std::shared_ptr< Camera > camera)
Register a camera to the camera manager and pipeline handler.
Definition pipeline_handler.cpp:688
libcamera::PipelineHandler::registerRequest
void registerRequest(Request *request)
Register a request for use by the pipeline handler.
Definition pipeline_handler.cpp:435
libcamera::PipelineHandler::start
virtual int start(Camera *camera, const ControlList *controls)=0
Start capturing from a group of streams.
libcamera::PipelineHandler::cancelRequest
void cancelRequest(Request *request)
Cancel request and signal its completion.
Definition pipeline_handler.cpp:613
libcamera::PipelineHandler::PipelineHandler
PipelineHandler(CameraManager *manager, unsigned int maxQueuedRequestsDevice=32)
Construct a PipelineHandler instance.
Definition pipeline_handler.cpp:72
libcamera::PipelineHandler::queueRequest
void queueRequest(Request *request)
Queue a request.
Definition pipeline_handler.cpp:469
libcamera::PipelineHandler::hasPendingRequests
bool hasPendingRequests(const Camera *camera) const
Determine if the camera has any requests pending.
Definition pipeline_handler.cpp:422
libcamera::PipelineHandler::stop
void stop(Camera *camera)
Stop capturing from all running streams and cancel pending requests.
Definition pipeline_handler.cpp:367
libcamera::PipelineHandler::exportFrameBuffers
virtual int exportFrameBuffers(Camera *camera, Stream *stream, std::vector< std::unique_ptr< FrameBuffer > > *buffers)=0
Allocate and export buffers for stream.
libcamera::PipelineHandler::generateConfiguration
virtual std::unique_ptr< CameraConfiguration > generateConfiguration(Camera *camera, Span< const StreamRole > roles)=0
Generate a camera configuration for a specified camera.
libcamera::PipelineHandler::maxQueuedRequestsDevice_
const unsigned int maxQueuedRequestsDevice_
The maximum number of requests the pipeline handler shall queue to the device.
Definition pipeline_handler.h:85
libcamera::PipelineHandler::completeBuffer
bool completeBuffer(Request *request, FrameBuffer *buffer)
Complete a buffer for a request.
Definition pipeline_handler.cpp:563
libcamera::PipelineHandler::acquireMediaDevice
std::shared_ptr< MediaDevice > acquireMediaDevice(DeviceEnumerator *enumerator, const DeviceMatch &dm)
Search and acquire a MediaDevice matching a device pattern.
Definition pipeline_handler.cpp:136
libcamera::PipelineHandler::configure
virtual int configure(Camera *camera, CameraConfiguration *config)=0
Configure a group of streams for capture.
libcamera::PipelineHandler::release
void release(Camera *camera)
Release exclusive access to the pipeline handler.
Definition pipeline_handler.cpp:209
libcamera::Request
A frame capture request.
Definition request.h:30
libcamera::Stream
Video stream for a camera.
Definition stream.h:76
controls.h
Framework to manage controls related to an object.
libcamera::controls
Namespace for libcamera controls.
Definition control_ids.h:22
libcamera
Top-level libcamera namespace.
Definition backtrace.h:17
object.h
Base object to support automatic signal disconnection.
stream.h
Video stream for a Camera.