libcamera v0.0.0+3240-f2a18172-dirty (2022-05-13T19:42:47+00:00)
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#ifndef __LIBCAMERA_INTERNAL_PIPELINE_HANDLER_H__
8#define __LIBCAMERA_INTERNAL_PIPELINE_HANDLER_H__
9
10#include <memory>
11#include <set>
12#include <string>
13#include <sys/types.h>
14#include <vector>
15
17
18#include <libcamera/controls.h>
19#include <libcamera/stream.h>
20
22
23namespace libcamera {
24
25class Camera;
26class CameraConfiguration;
27class CameraManager;
28class DeviceEnumerator;
29class DeviceMatch;
30class FrameBuffer;
31class MediaDevice;
32class PipelineHandler;
33class Request;
34
35class PipelineHandler : public std::enable_shared_from_this<PipelineHandler>,
36 public Object
37{
38public:
40 virtual ~PipelineHandler();
41
42 virtual bool match(DeviceEnumerator *enumerator) = 0;
44 const DeviceMatch &dm);
45
46 bool lock();
47 void unlock();
48
50 const StreamRoles &roles) = 0;
51 virtual int configure(Camera *camera, CameraConfiguration *config) = 0;
52
53 virtual int exportFrameBuffers(Camera *camera, Stream *stream,
54 std::vector<std::unique_ptr<FrameBuffer>> *buffers) = 0;
55
56 virtual int start(Camera *camera, const ControlList *controls) = 0;
57 virtual void stop(Camera *camera) = 0;
58 bool hasPendingRequests(const Camera *camera) const;
59
60 void queueRequest(Request *request);
61
62 bool completeBuffer(Request *request, FrameBuffer *buffer);
63 void completeRequest(Request *request);
64
65 const char *name() const { return name_; }
66
67protected:
68 void registerCamera(std::shared_ptr<Camera> camera);
70
71 virtual int queueRequestDevice(Camera *camera, Request *request) = 0;
72
74
75private:
76 void mediaDeviceDisconnected(MediaDevice *media);
77 virtual void disconnect();
78
79 std::vector<std::shared_ptr<MediaDevice>> mediaDevices_;
80 std::vector<std::weak_ptr<Camera>> cameras_;
81
82 const char *name_;
83
84 friend class PipelineHandlerFactory;
85};
86
88{
89public:
90 PipelineHandlerFactory(const char *name);
91 virtual ~PipelineHandlerFactory() = default;
92
93 std::shared_ptr<PipelineHandler> create(CameraManager *manager);
94
95 const std::string &name() const { return name_; }
96
97 static void registerType(PipelineHandlerFactory *factory);
98 static std::vector<PipelineHandlerFactory *> &factories();
99
100private:
101 virtual PipelineHandler *createInstance(CameraManager *manager) = 0;
102
103 std::string name_;
104};
105
106#define REGISTER_PIPELINE_HANDLER(handler) \
107class handler##Factory final : public PipelineHandlerFactory \
108{ \
109public: \
110 handler##Factory() : PipelineHandlerFactory(#handler) {} \
111 \
112private: \
113 PipelineHandler *createInstance(CameraManager *manager) \
114 { \
115 return new handler(manager); \
116 } \
117}; \
118static handler##Factory global_##handler##Factory;
119
120} /* namespace libcamera */
121
122#endif /* __LIBCAMERA_INTERNAL_PIPELINE_HANDLER_H__ */
Hold configuration for streams of the camera.
Definition: camera.h:32
Provide access and manage all cameras in the system.
Definition: camera_manager.h:24
Camera device.
Definition: camera.h:77
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
Registration of PipelineHandler classes and creation of instances.
Definition: pipeline_handler.h:88
std::shared_ptr< PipelineHandler > create(CameraManager *manager)
Create an instance of the PipelineHandler corresponding to the factory.
Definition: pipeline_handler.cpp:555
const std::string & name() const
Retrieve the factory name.
Definition: pipeline_handler.h:95
static void registerType(PipelineHandlerFactory *factory)
Add a pipeline handler class to the registry.
Definition: pipeline_handler.cpp:575
static std::vector< PipelineHandlerFactory * > & factories()
Retrieve the list of all pipeline handler factories.
Definition: pipeline_handler.cpp:586
PipelineHandlerFactory(const char *name)
Construct a pipeline handler factory.
Definition: pipeline_handler.cpp:542
Create and manage cameras based on a set of media devices.
Definition: pipeline_handler.h:37
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:449
PipelineHandler(CameraManager *manager)
Construct a PipelineHandler instance.
Definition: pipeline_handler.cpp:64
void completeRequest(Request *request)
Signal request completion.
Definition: pipeline_handler.cpp:382
void unlock()
Unlock all media devices acquired by the pipeline.
Definition: pipeline_handler.cpp:173
const char * name() const
Retrieve the pipeline handler name.
Definition: pipeline_handler.h:65
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:124
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:151
virtual int configure(Camera *camera, CameraConfiguration *config)=0
Configure a group of streams for capture.
virtual void stop(Camera *camera)=0
Stop capturing from all running streams.
void registerCamera(std::shared_ptr< Camera > camera)
Register a camera to the camera manager and pipeline handler.
Definition: pipeline_handler.cpp:410
void queueRequest(Request *request)
Queue a request.
Definition: pipeline_handler.cpp:310
bool hasPendingRequests(const Camera *camera) const
Determine if the camera has any requests pending.
Definition: pipeline_handler.cpp:288
bool completeBuffer(Request *request, FrameBuffer *buffer)
Complete a buffer for a request.
Definition: pipeline_handler.cpp:361
CameraManager * manager_
The Camera manager associated with the pipeline handler.
Definition: pipeline_handler.h:73
A frame capture request.
Definition: request.h:29
Video stream for a camera.
Definition: stream.h:71
Framework to manage controls related to an object.
IPA Proxy.
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:68
Base object to support automatic signal disconnection.
Video stream for a Camera.