libcamera v0.0.0
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 lock();
49 void unlock();
50
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 queueRequest(Request *request);
63
64 bool completeBuffer(Request *request, FrameBuffer *buffer);
65 void completeRequest(Request *request);
66
67 const char *name() const { return name_; }
68
69protected:
70 void registerCamera(std::shared_ptr<Camera> camera);
72
73 virtual int queueRequestDevice(Camera *camera, Request *request) = 0;
74 virtual void stopDevice(Camera *camera) = 0;
75
77
78private:
79 void mediaDeviceDisconnected(MediaDevice *media);
80 virtual void disconnect();
81
82 void doQueueRequest(Request *request);
83 void doQueueRequests();
84
85 std::vector<std::shared_ptr<MediaDevice>> mediaDevices_;
86 std::vector<std::weak_ptr<Camera>> cameras_;
87
88 std::queue<Request *> waitingRequests_;
89
90 const char *name_;
91
92 Mutex lock_;
93 bool lockOwner_ LIBCAMERA_TSA_GUARDED_BY(lock_); /* *Not* ownership of lock_ */
94
95 friend class PipelineHandlerFactory;
96};
97
99{
100public:
101 PipelineHandlerFactory(const char *name);
102 virtual ~PipelineHandlerFactory() = default;
103
104 std::shared_ptr<PipelineHandler> create(CameraManager *manager);
105
106 const std::string &name() const { return name_; }
107
108 static void registerType(PipelineHandlerFactory *factory);
109 static std::vector<PipelineHandlerFactory *> &factories();
110
111private:
112 virtual PipelineHandler *createInstance(CameraManager *manager) = 0;
113
114 std::string name_;
115};
116
117#define REGISTER_PIPELINE_HANDLER(handler) \
118class handler##Factory final : public PipelineHandlerFactory \
119{ \
120public: \
121 handler##Factory() : PipelineHandlerFactory(#handler) {} \
122 \
123private: \
124 PipelineHandler *createInstance(CameraManager *manager) \
125 { \
126 return new handler(manager); \
127 } \
128}; \
129static handler##Factory global_##handler##Factory;
130
131} /* 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:349
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:120
Base object to support automatic signal disconnection.
Definition: object.h:25
Registration of PipelineHandler classes and creation of instances.
Definition: pipeline_handler.h:99
std::shared_ptr< PipelineHandler > create(CameraManager *manager)
Create an instance of the PipelineHandler corresponding to the factory.
Definition: pipeline_handler.cpp:646
const std::string & name() const
Retrieve the factory name.
Definition: pipeline_handler.h:106
static void registerType(PipelineHandlerFactory *factory)
Add a pipeline handler class to the registry.
Definition: pipeline_handler.cpp:666
static std::vector< PipelineHandlerFactory * > & factories()
Retrieve the list of all pipeline handler factories.
Definition: pipeline_handler.cpp:677
PipelineHandlerFactory(const char *name)
Construct a pipeline handler factory.
Definition: pipeline_handler.cpp:633
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.
void hotplugMediaDevice(MediaDevice *media)
Enable hotplug handling for a media device.
Definition: pipeline_handler.cpp:540
virtual void stopDevice(Camera *camera)=0
Stop capturing from all running streams.
PipelineHandler(CameraManager *manager)
Construct a PipelineHandler instance.
Definition: pipeline_handler.cpp:70
void completeRequest(Request *request)
Signal request completion.
Definition: pipeline_handler.cpp:473
void unlock()
Unlock all media devices acquired by the pipeline.
Definition: pipeline_handler.cpp:187
const char * name() const
Retrieve the pipeline handler name.
Definition: pipeline_handler.h:67
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:130
virtual 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.
bool lock()
Lock all media devices acquired by the pipeline.
Definition: pipeline_handler.cpp:157
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:501
void queueRequest(Request *request)
Queue a request.
Definition: pipeline_handler.cpp:363
bool hasPendingRequests(const Camera *camera) const
Determine if the camera has any requests pending.
Definition: pipeline_handler.cpp:335
void stop(Camera *camera)
Stop capturing from all running streams and cancel pending requests.
Definition: pipeline_handler.cpp:298
bool completeBuffer(Request *request, FrameBuffer *buffer)
Complete a buffer for a request.
Definition: pipeline_handler.cpp:452
CameraManager * manager_
The Camera manager associated with the pipeline handler.
Definition: pipeline_handler.h:76
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.
IPA Proxy.
Mutex classes with clang thread safety annotation.
const ControlIdMap controls
List of all supported libcamera controls.
Definition: control_ids.cpp:997
Top-level libcamera namespace.
Definition: backtrace.h:17
std::vector< StreamRole > StreamRoles
A vector of StreamRole.
Definition: stream.h:71
Base object to support automatic signal disconnection.
Video stream for a Camera.