libcamera v0.3.2
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 <string>
13#include <sys/types.h>
14#include <vector>
15
17
18#include <libcamera/controls.h>
19#include <libcamera/stream.h>
20
21namespace libcamera {
22
23class Camera;
24class CameraConfiguration;
25class CameraManager;
26class DeviceEnumerator;
27class DeviceMatch;
28class FrameBuffer;
29class MediaDevice;
30class PipelineHandler;
31class Request;
32
33class PipelineHandler : public std::enable_shared_from_this<PipelineHandler>,
34 public Object
35{
36public:
38 virtual ~PipelineHandler();
39
40 virtual bool match(DeviceEnumerator *enumerator) = 0;
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
64 std::string configurationFile(const std::string &subdir,
65 const std::string &name) const;
66
67 const char *name() const { return name_; }
68
70
71protected:
72 void registerCamera(std::shared_ptr<Camera> camera);
74
75 virtual int queueRequestDevice(Camera *camera, Request *request) = 0;
76 virtual void stopDevice(Camera *camera) = 0;
77
78 virtual bool acquireDevice(Camera *camera);
79 virtual void releaseDevice(Camera *camera);
80
82
83private:
84 void unlockMediaDevices();
85
86 void mediaDeviceDisconnected(MediaDevice *media);
87 virtual void disconnect();
88
89 void doQueueRequest(Request *request);
90 void doQueueRequests();
91
92 std::vector<std::shared_ptr<MediaDevice>> mediaDevices_;
93 std::vector<std::weak_ptr<Camera>> cameras_;
94
95 std::queue<Request *> waitingRequests_;
96
97 const char *name_;
98 unsigned int useCount_;
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 static const PipelineHandlerFactoryBase *getFactoryByName(const std::string &name);
115
116private:
117 static void registerType(PipelineHandlerFactoryBase *factory);
118
119 virtual std::unique_ptr<PipelineHandler>
120 createInstance(CameraManager *manager) const = 0;
121
122 std::string name_;
123};
124
125template<typename _PipelineHandler>
127{
128public:
133
134 std::unique_ptr<PipelineHandler>
135 createInstance(CameraManager *manager) const override
136 {
137 return std::make_unique<_PipelineHandler>(manager);
138 }
139};
140
141#define REGISTER_PIPELINE_HANDLER(handler, name) \
142 static PipelineHandlerFactory<handler> global_##handler##Factory(name);
143
144} /* 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:49
The MediaDevice represents a Media Controller device with its full graph of connected objects.
Definition media_device.h:25
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
static const PipelineHandlerFactoryBase * getFactoryByName(const std::string &name)
Return the factory for the pipeline handler with name name.
Definition pipeline_handler.cpp:841
PipelineHandlerFactoryBase(const char *name)
Construct a pipeline handler factory base.
Definition pipeline_handler.cpp:780
static std::vector< PipelineHandlerFactoryBase * > & factories()
Retrieve the list of all pipeline handler factories.
Definition pipeline_handler.cpp:825
std::shared_ptr< PipelineHandler > create(CameraManager *manager) const
Create an instance of the PipelineHandler corresponding to the factory.
Definition pipeline_handler.cpp:793
Registration of PipelineHandler classes and creation of instances.
Definition pipeline_handler.h:127
PipelineHandlerFactory(const char *name)
Construct a pipeline handler factory.
Definition pipeline_handler.h:129
std::unique_ptr< PipelineHandler > createInstance(CameraManager *manager) const override
Create an instance of the PipelineHandler corresponding to the factory.
Definition pipeline_handler.h:135
Create and manage cameras based on a set of media devices.
Definition pipeline_handler.h:35
virtual void stopDevice(Camera *camera)=0
Stop capturing from all running streams.
CameraManager * cameraManager() const
Retrieve the CameraManager that this pipeline handler belongs to.
Definition pipeline_handler.h:69
void hotplugMediaDevice(MediaDevice *media)
Enable hotplug handling for a media device.
Definition pipeline_handler.cpp:682
const char * name() const
Retrieve the pipeline handler name.
Definition pipeline_handler.h:67
CameraManager * manager_
The Camera manager associated with the pipeline handler.
Definition pipeline_handler.h:81
PipelineHandler(CameraManager *manager)
Construct a PipelineHandler instance.
Definition pipeline_handler.cpp:70
void completeRequest(Request *request)
Signal request completion.
Definition pipeline_handler.cpp:552
virtual void releaseDevice(Camera *camera)
Release resources associated with this camera.
Definition pipeline_handler.cpp:254
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:165
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:589
virtual bool acquireDevice(Camera *camera)
Acquire resources associated with this camera.
Definition pipeline_handler.cpp:233
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:130
void registerCamera(std::shared_ptr< Camera > camera)
Register a camera to the camera manager and pipeline handler.
Definition pipeline_handler.cpp:636
void registerRequest(Request *request)
Register a request for use by the pipeline handler.
Definition pipeline_handler.cpp:413
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:445
bool hasPendingRequests(const Camera *camera) const
Determine if the camera has any requests pending.
Definition pipeline_handler.cpp:400
void stop(Camera *camera)
Stop capturing from all running streams and cancel pending requests.
Definition pipeline_handler.cpp:361
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:531
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:203
A frame capture request.
Definition request.h:30
Video stream for a camera.
Definition stream.h:74
Framework to manage controls related to an object.
Top-level libcamera namespace.
Definition backtrace.h:17
Base object to support automatic signal disconnection.
Video stream for a Camera.