libcamera v0.0.3
Supporting cameras in Linux since 2019
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.h - Pipeline handler infrastructure
6 */
7
8#pragma once
9
10#include <memory>
11#include <queue>
12#include <set>
13#include <string>
14#include <sys/types.h>
15#include <vector>
16
19
20#include <libcamera/controls.h>
21#include <libcamera/stream.h>
22
24
25namespace libcamera {
26
27class Camera;
28class CameraConfiguration;
29class CameraManager;
30class DeviceEnumerator;
31class DeviceMatch;
32class FrameBuffer;
33class MediaDevice;
34class PipelineHandler;
35class Request;
36
37class PipelineHandler : public std::enable_shared_from_this<PipelineHandler>,
38 public Object
39{
40public:
42 virtual ~PipelineHandler();
43
44 virtual bool match(DeviceEnumerator *enumerator) = 0;
46 const DeviceMatch &dm);
47
48 bool acquire();
49 void release(Camera *camera);
50
51 virtual std::unique_ptr<CameraConfiguration> generateConfiguration(Camera *camera,
52 const StreamRoles &roles) = 0;
53 virtual int configure(Camera *camera, CameraConfiguration *config) = 0;
54
55 virtual int exportFrameBuffers(Camera *camera, Stream *stream,
56 std::vector<std::unique_ptr<FrameBuffer>> *buffers) = 0;
57
58 virtual int start(Camera *camera, const ControlList *controls) = 0;
59 void stop(Camera *camera);
60 bool hasPendingRequests(const Camera *camera) const;
61
62 void registerRequest(Request *request);
63 void queueRequest(Request *request);
64
65 bool completeBuffer(Request *request, FrameBuffer *buffer);
66 void completeRequest(Request *request);
67
68 const char *name() const { return name_; }
69
70protected:
71 void registerCamera(std::shared_ptr<Camera> camera);
73
74 virtual int queueRequestDevice(Camera *camera, Request *request) = 0;
75 virtual void stopDevice(Camera *camera) = 0;
76
77 virtual void releaseDevice(Camera *camera);
78
80
81private:
82 void unlockMediaDevices();
83
84 void mediaDeviceDisconnected(MediaDevice *media);
85 virtual void disconnect();
86
87 void doQueueRequest(Request *request);
88 void doQueueRequests();
89
90 std::vector<std::shared_ptr<MediaDevice>> mediaDevices_;
91 std::vector<std::weak_ptr<Camera>> cameras_;
92
93 std::queue<Request *> waitingRequests_;
94
95 const char *name_;
96
97 Mutex lock_;
98 unsigned int useCount_ LIBCAMERA_TSA_GUARDED_BY(lock_);
99
100 friend class PipelineHandlerFactoryBase;
101};
102
104{
105public:
106 PipelineHandlerFactoryBase(const char *name);
107 virtual ~PipelineHandlerFactoryBase() = default;
108
109 std::shared_ptr<PipelineHandler> create(CameraManager *manager) const;
110
111 const std::string &name() const { return name_; }
112
113 static std::vector<PipelineHandlerFactoryBase *> &factories();
114
115private:
116 static void registerType(PipelineHandlerFactoryBase *factory);
117
118 virtual std::unique_ptr<PipelineHandler>
119 createInstance(CameraManager *manager) const = 0;
120
121 std::string name_;
122};
123
124template<typename _PipelineHandler>
126{
127public:
130 {
131 }
132
133 std::unique_ptr<PipelineHandler>
134 createInstance(CameraManager *manager) const override
135 {
136 return std::make_unique<_PipelineHandler>(manager);
137 }
138};
139
140#define REGISTER_PIPELINE_HANDLER(handler) \
141static PipelineHandlerFactory<handler> global_##handler##Factory(#handler);
142
143} /* namespace libcamera */
Hold configuration for streams of the camera.
Definition: camera.h:33
Provide access and manage all cameras in the system.
Definition: camera_manager.h:24
Camera device.
Definition: camera.h:87
Associate a list of ControlId with their values for an object.
Definition: controls.h:350
Enumerate, store and search media devices.
Definition: device_enumerator.h:35
Description of a media device search pattern.
Definition: device_enumerator.h:21
Frame buffer data and its associated dynamic metadata.
Definition: framebuffer.h:50
The MediaDevice represents a Media Controller device with its full graph of connected objects.
Definition: media_device.h:26
std::mutex wrapper with clang thread safety annotation
Definition: mutex.h:122
Base object to support automatic signal disconnection.
Definition: object.h:25
Base class for pipeline handler factories.
Definition: pipeline_handler.h:104
const std::string & name() const
Retrieve the factory name.
Definition: pipeline_handler.h:111
PipelineHandlerFactoryBase(const char *name)
Construct a pipeline handler factory base.
Definition: pipeline_handler.cpp:676
static std::vector< PipelineHandlerFactoryBase * > & factories()
Retrieve the list of all pipeline handler factories.
Definition: pipeline_handler.cpp:721
std::shared_ptr< PipelineHandler > create(CameraManager *manager) const
Create an instance of the PipelineHandler corresponding to the factory.
Definition: pipeline_handler.cpp:689
Registration of PipelineHandler classes and creation of instances.
Definition: pipeline_handler.h:126
PipelineHandlerFactory(const char *name)
Construct a pipeline handler factory.
Definition: pipeline_handler.h:128
std::unique_ptr< PipelineHandler > createInstance(CameraManager *manager) const override
Create an instance of the PipelineHandler corresponding to the factory.
Definition: pipeline_handler.h:134
Create and manage cameras based on a set of media devices.
Definition: pipeline_handler.h:39
virtual int queueRequestDevice(Camera *camera, Request *request)=0
Queue a request to the device.
bool acquire()
Acquire exclusive access to the pipeline handler for the process.
Definition: pipeline_handler.cpp:164
void hotplugMediaDevice(MediaDevice *media)
Enable hotplug handling for a media device.
Definition: pipeline_handler.cpp:585
virtual void stopDevice(Camera *camera)=0
Stop capturing from all running streams.
PipelineHandler(CameraManager *manager)
Construct a PipelineHandler instance.
Definition: pipeline_handler.cpp:69
void completeRequest(Request *request)
Signal request completion.
Definition: pipeline_handler.cpp:518
const char * name() const
Retrieve the pipeline handler name.
Definition: pipeline_handler.h:68
virtual void releaseDevice(Camera *camera)
Release resources associated with this camera.
Definition: pipeline_handler.cpp:220
virtual int start(Camera *camera, const ControlList *controls)=0
Start capturing from a group of streams.
MediaDevice * acquireMediaDevice(DeviceEnumerator *enumerator, const DeviceMatch &dm)
Search and acquire a MediaDevice matching a device pattern.
Definition: pipeline_handler.cpp:129
virtual std::unique_ptr< CameraConfiguration > generateConfiguration(Camera *camera, const StreamRoles &roles)=0
Generate a camera configuration for a specified camera.
virtual bool match(DeviceEnumerator *enumerator)=0
Match media devices and create camera instances.
virtual int exportFrameBuffers(Camera *camera, Stream *stream, std::vector< std::unique_ptr< FrameBuffer > > *buffers)=0
Allocate and export buffers for stream.
virtual int configure(Camera *camera, CameraConfiguration *config)=0
Configure a group of streams for capture.
void registerCamera(std::shared_ptr< Camera > camera)
Register a camera to the camera manager and pipeline handler.
Definition: pipeline_handler.cpp:546
void registerRequest(Request *request)
Register a request for use by the pipeline handler.
Definition: pipeline_handler.cpp:379
void queueRequest(Request *request)
Queue a request.
Definition: pipeline_handler.cpp:411
bool hasPendingRequests(const Camera *camera) const
Determine if the camera has any requests pending.
Definition: pipeline_handler.cpp:366
void stop(Camera *camera)
Stop capturing from all running streams and cancel pending requests.
Definition: pipeline_handler.cpp:327
bool completeBuffer(Request *request, FrameBuffer *buffer)
Complete a buffer for a request.
Definition: pipeline_handler.cpp:497
CameraManager * manager_
The Camera manager associated with the pipeline handler.
Definition: pipeline_handler.h:79
void release(Camera *camera)
Release exclusive access to the pipeline handler.
Definition: pipeline_handler.cpp:200
A frame capture request.
Definition: request.h:31
Video stream for a camera.
Definition: stream.h:77
Framework to manage controls related to an object.
IPA Proxy.
Mutex classes with clang thread safety annotation.
const ControlIdMap controls
List of all supported libcamera controls.
Definition: control_ids.cpp:1303
Top-level libcamera namespace.
Definition: backtrace.h:17
std::vector< StreamRole > StreamRoles
A vector of StreamRole.
Definition: stream.h:72
Base object to support automatic signal disconnection.
Video stream for a Camera.