libcamera v0.3.1
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 <queue>
12#include <set>
13#include <string>
14#include <sys/types.h>
15#include <vector>
16
18
19#include <libcamera/controls.h>
20#include <libcamera/stream.h>
21
23
24namespace libcamera {
25
26class Camera;
27class CameraConfiguration;
28class CameraManager;
29class DeviceEnumerator;
30class DeviceMatch;
31class FrameBuffer;
32class MediaDevice;
33class PipelineHandler;
34class Request;
35
36class PipelineHandler : public std::enable_shared_from_this<PipelineHandler>,
37 public Object
38{
39public:
41 virtual ~PipelineHandler();
42
43 virtual bool match(DeviceEnumerator *enumerator) = 0;
45 const DeviceMatch &dm);
46
47 bool acquire(Camera *camera);
48 void release(Camera *camera);
49
50 virtual std::unique_ptr<CameraConfiguration> generateConfiguration(Camera *camera,
51 Span<const StreamRole> roles) = 0;
52 virtual int configure(Camera *camera, CameraConfiguration *config) = 0;
53
54 virtual int exportFrameBuffers(Camera *camera, Stream *stream,
55 std::vector<std::unique_ptr<FrameBuffer>> *buffers) = 0;
56
57 virtual int start(Camera *camera, const ControlList *controls) = 0;
58 void stop(Camera *camera);
59 bool hasPendingRequests(const Camera *camera) const;
60
61 void registerRequest(Request *request);
62 void queueRequest(Request *request);
63
64 bool completeBuffer(Request *request, FrameBuffer *buffer);
65 void completeRequest(Request *request);
66
67 std::string configurationFile(const std::string &subdir,
68 const std::string &name) const;
69
70 const char *name() const { return name_; }
71
72protected:
73 void registerCamera(std::shared_ptr<Camera> camera);
75
76 virtual int queueRequestDevice(Camera *camera, Request *request) = 0;
77 virtual void stopDevice(Camera *camera) = 0;
78
79 virtual bool acquireDevice(Camera *camera);
80 virtual void releaseDevice(Camera *camera);
81
83
84private:
85 void unlockMediaDevices();
86
87 void mediaDeviceDisconnected(MediaDevice *media);
88 virtual void disconnect();
89
90 void doQueueRequest(Request *request);
91 void doQueueRequests();
92
93 std::vector<std::shared_ptr<MediaDevice>> mediaDevices_;
94 std::vector<std::weak_ptr<Camera>> cameras_;
95
96 std::queue<Request *> waitingRequests_;
97
98 const char *name_;
99 unsigned int useCount_;
100
101 friend class PipelineHandlerFactoryBase;
102};
103
105{
106public:
107 PipelineHandlerFactoryBase(const char *name);
108 virtual ~PipelineHandlerFactoryBase() = default;
109
110 std::shared_ptr<PipelineHandler> create(CameraManager *manager) const;
111
112 const std::string &name() const { return name_; }
113
114 static std::vector<PipelineHandlerFactoryBase *> &factories();
115 static const PipelineHandlerFactoryBase *getFactoryByName(const std::string &name);
116
117private:
118 static void registerType(PipelineHandlerFactoryBase *factory);
119
120 virtual std::unique_ptr<PipelineHandler>
121 createInstance(CameraManager *manager) const = 0;
122
123 std::string name_;
124};
125
126template<typename _PipelineHandler>
128{
129public:
134
135 std::unique_ptr<PipelineHandler>
136 createInstance(CameraManager *manager) const override
137 {
138 return std::make_unique<_PipelineHandler>(manager);
139 }
140};
141
142#define REGISTER_PIPELINE_HANDLER(handler, name) \
143 static PipelineHandlerFactory<handler> global_##handler##Factory(name);
144
145} /* namespace libcamera */
Hold configuration for streams of the camera.
Definition camera.h:60
Provide access and manage all cameras in the system.
Definition camera_manager.h:24
Camera device.
Definition camera.h:115
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
Base object to support automatic signal disconnection.
Definition object.h:25
Base class for pipeline handler factories.
Definition pipeline_handler.h:105
const std::string & name() const
Retrieve the factory name.
Definition pipeline_handler.h:112
static const PipelineHandlerFactoryBase * getFactoryByName(const std::string &name)
Return the factory for the pipeline handler with name name.
Definition pipeline_handler.cpp:835
PipelineHandlerFactoryBase(const char *name)
Construct a pipeline handler factory base.
Definition pipeline_handler.cpp:774
static std::vector< PipelineHandlerFactoryBase * > & factories()
Retrieve the list of all pipeline handler factories.
Definition pipeline_handler.cpp:819
std::shared_ptr< PipelineHandler > create(CameraManager *manager) const
Create an instance of the PipelineHandler corresponding to the factory.
Definition pipeline_handler.cpp:787
Registration of PipelineHandler classes and creation of instances.
Definition pipeline_handler.h:128
PipelineHandlerFactory(const char *name)
Construct a pipeline handler factory.
Definition pipeline_handler.h:130
std::unique_ptr< PipelineHandler > createInstance(CameraManager *manager) const override
Create an instance of the PipelineHandler corresponding to the factory.
Definition pipeline_handler.h:136
Create and manage cameras based on a set of media devices.
Definition pipeline_handler.h:38
virtual void stopDevice(Camera *camera)=0
Stop capturing from all running streams.
void hotplugMediaDevice(MediaDevice *media)
Enable hotplug handling for a media device.
Definition pipeline_handler.cpp:683
const char * name() const
Retrieve the pipeline handler name.
Definition pipeline_handler.h:70
CameraManager * manager_
The Camera manager associated with the pipeline handler.
Definition pipeline_handler.h:82
PipelineHandler(CameraManager *manager)
Construct a PipelineHandler instance.
Definition pipeline_handler.cpp:71
void completeRequest(Request *request)
Signal request completion.
Definition pipeline_handler.cpp:553
virtual void releaseDevice(Camera *camera)
Release resources associated with this camera.
Definition pipeline_handler.cpp:255
virtual int queueRequestDevice(Camera *camera, Request *request)=0
Queue a request to the device.
bool acquire(Camera *camera)
Acquire exclusive access to the pipeline handler for the process.
Definition pipeline_handler.cpp:166
std::string configurationFile(const std::string &subdir, const std::string &name) const
Retrieve the absolute path to a platform configuration file.
Definition pipeline_handler.cpp:590
virtual bool acquireDevice(Camera *camera)
Acquire resources associated with this camera.
Definition pipeline_handler.cpp:234
virtual bool match(DeviceEnumerator *enumerator)=0
Match media devices and create camera instances.
MediaDevice * acquireMediaDevice(DeviceEnumerator *enumerator, const DeviceMatch &dm)
Search and acquire a MediaDevice matching a device pattern.
Definition pipeline_handler.cpp:131
void registerCamera(std::shared_ptr< Camera > camera)
Register a camera to the camera manager and pipeline handler.
Definition pipeline_handler.cpp:637
void registerRequest(Request *request)
Register a request for use by the pipeline handler.
Definition pipeline_handler.cpp:414
virtual int start(Camera *camera, const ControlList *controls)=0
Start capturing from a group of streams.
void queueRequest(Request *request)
Queue a request.
Definition pipeline_handler.cpp:446
bool hasPendingRequests(const Camera *camera) const
Determine if the camera has any requests pending.
Definition pipeline_handler.cpp:401
void stop(Camera *camera)
Stop capturing from all running streams and cancel pending requests.
Definition pipeline_handler.cpp:362
virtual int exportFrameBuffers(Camera *camera, Stream *stream, std::vector< std::unique_ptr< FrameBuffer > > *buffers)=0
Allocate and export buffers for stream.
virtual std::unique_ptr< CameraConfiguration > generateConfiguration(Camera *camera, Span< const StreamRole > roles)=0
Generate a camera configuration for a specified camera.
bool completeBuffer(Request *request, FrameBuffer *buffer)
Complete a buffer for a request.
Definition pipeline_handler.cpp:532
virtual int configure(Camera *camera, CameraConfiguration *config)=0
Configure a group of streams for capture.
void release(Camera *camera)
Release exclusive access to the pipeline handler.
Definition pipeline_handler.cpp:204
A frame capture request.
Definition request.h:31
Video stream for a camera.
Definition stream.h:75
Framework to manage controls related to an object.
IPA Proxy.
Top-level libcamera namespace.
Definition backtrace.h:17
Base object to support automatic signal disconnection.
Video stream for a Camera.