libcamera: include/libcamera/internal/media_object.h Source File

libcamera v0.5.1 Supporting cameras in Linux since 2019

Loading...
Searching...
No Matches
media_object.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 * Media Device objects: entities, pads and links.
6 */
7
8#pragma once
9
10#include <string>
11#include <vector>
12
13#include <linux/media.h>
14
15#include <libcamera/base/class.h>
16
17namespace libcamera {
18
19class MediaDevice;
20class MediaEntity;
21class MediaPad;
22
23 class MediaObject
24{
25public:
26 MediaDevice *device() { return dev_; }
27 const MediaDevice *device() const { return dev_; }
28 unsigned int id() const { return id_; }
29
30protected:
31 friend class MediaDevice;
32
33 MediaObject(MediaDevice *dev, unsigned int id)
34 : dev_(dev), id_(id)
35 {
36 }
37 virtual ~MediaObject() = default;
38
39 MediaDevice *dev_;
40 unsigned int id_;
41};
42
43 class MediaLink : public MediaObject
44{
45public:
46 MediaPad *source() const { return source_; }
47 MediaPad *sink() const { return sink_; }
48 unsigned int flags() const { return flags_; }
49 int setEnabled(bool enable);
50
51 std::string toString() const;
52
53private:
54 LIBCAMERA_DISABLE_COPY_AND_MOVE(MediaLink)
55
56 friend class MediaDevice;
57
58 MediaLink(const struct media_v2_link *link,
59 MediaPad *source, MediaPad *sink);
60
61 MediaPad *source_;
62 MediaPad *sink_;
63 unsigned int flags_;
64};
65
66std::ostream &operator<<(std::ostream &out, const MediaLink &link);
67
68 class MediaPad : public MediaObject
69{
70public:
71 unsigned int index() const { return index_; }
72 MediaEntity *entity() const { return entity_; }
73 unsigned int flags() const { return flags_; }
74 const std::vector<MediaLink *> &links() const { return links_; }
75
76 void addLink(MediaLink *link);
77
78 std::string toString() const;
79
80private:
81 LIBCAMERA_DISABLE_COPY_AND_MOVE(MediaPad)
82
83 friend class MediaDevice;
84
85 MediaPad(const struct media_v2_pad *pad, MediaEntity *entity);
86
87 unsigned int index_;
88 MediaEntity *entity_;
89 unsigned int flags_;
90
91 std::vector<MediaLink *> links_;
92};
93
94std::ostream &operator<<(std::ostream &out, const MediaPad &pad);
95
96 class MediaEntity : public MediaObject
97{
98public:
99 enum class Type {
100 Invalid,
101 MediaEntity,
102 V4L2Subdevice,
103 V4L2VideoDevice,
104 };
105
106 const std::string &name() const { return name_; }
107 unsigned int function() const { return function_; }
108 unsigned int flags() const { return flags_; }
109 Type type() const { return type_; }
110 const std::string &deviceNode() const { return deviceNode_; }
111 unsigned int deviceMajor() const { return major_; }
112 unsigned int deviceMinor() const { return minor_; }
113
114 const std::vector<MediaPad *> &pads() const { return pads_; }
115 const std::vector<MediaEntity *> &ancillaryEntities() const { return ancillaryEntities_; }
116
117 const MediaPad *getPadByIndex(unsigned int index) const;
118 const MediaPad *getPadById(unsigned int id) const;
119
120 int setDeviceNode(const std::string &deviceNode);
121
122private:
123 LIBCAMERA_DISABLE_COPY_AND_MOVE(MediaEntity)
124
125 friend class MediaDevice;
126
127 MediaEntity(MediaDevice *dev, const struct media_v2_entity *entity,
128 const struct media_v2_interface *iface);
129
130 void addPad(MediaPad *pad);
131
132 void addAncillaryEntity(MediaEntity *ancillaryEntity);
133
134 std::string name_;
135 unsigned int function_;
136 unsigned int flags_;
137 Type type_;
138 std::string deviceNode_;
139 unsigned int major_;
140 unsigned int minor_;
141
142 std::vector<MediaPad *> pads_;
143 std::vector<MediaEntity *> ancillaryEntities_;
144};
145
146} /* namespace libcamera */
class.h
Utilities to help constructing class interfaces.
LIBCAMERA_DISABLE_COPY_AND_MOVE
#define LIBCAMERA_DISABLE_COPY_AND_MOVE(klass)
Disable copy and move construction and assignment of the klass.
Definition class.h:29
libcamera::MediaDevice
The MediaDevice represents a Media Controller device with its full graph of connected objects.
Definition media_device.h:25
libcamera::MediaEntity
The MediaEntity represents an entity in the media graph.
Definition media_object.h:97
libcamera::MediaEntity::ancillaryEntities
const std::vector< MediaEntity * > & ancillaryEntities() const
Retrieve all ancillary entities of the entity.
Definition media_object.h:115
libcamera::MediaEntity::type
Type type() const
Retrieve the entity's type.
Definition media_object.h:109
libcamera::MediaEntity::deviceNode
const std::string & deviceNode() const
Retrieve the entity's device node path, if any.
Definition media_object.h:110
libcamera::MediaEntity::flags
unsigned int flags() const
Retrieve the entity's flags.
Definition media_object.h:108
libcamera::MediaEntity::pads
const std::vector< MediaPad * > & pads() const
Retrieve all pads of the entity.
Definition media_object.h:114
libcamera::MediaEntity::getPadById
const MediaPad * getPadById(unsigned int id) const
Get a pad in this entity by its object id.
Definition media_object.cpp:399
libcamera::MediaEntity::Type
Type
The type of the interface exposed by the entity to userspace.
Definition media_object.h:99
libcamera::MediaEntity::Type::MediaEntity
@ MediaEntity
Plain media entity with no userspace interface.
Definition media_object.h:101
libcamera::MediaEntity::Type::Invalid
@ Invalid
Invalid or unsupported entity type.
Definition media_object.h:100
libcamera::MediaEntity::Type::V4L2Subdevice
@ V4L2Subdevice
V4L2 subdevice with a V4L2 subdev device node.
Definition media_object.h:102
libcamera::MediaEntity::Type::V4L2VideoDevice
@ V4L2VideoDevice
V4L2 video device with a V4L2 video device node.
Definition media_object.h:103
libcamera::MediaEntity::function
unsigned int function() const
Retrieve the entity's main function.
Definition media_object.h:107
libcamera::MediaEntity::getPadByIndex
const MediaPad * getPadByIndex(unsigned int index) const
Get a pad in this entity by its index.
Definition media_object.cpp:384
libcamera::MediaEntity::deviceMajor
unsigned int deviceMajor() const
Retrieve the major number of the interface associated with the entity.
Definition media_object.h:111
libcamera::MediaEntity::name
const std::string & name() const
Retrieve the entity name.
Definition media_object.h:106
libcamera::MediaEntity::deviceMinor
unsigned int deviceMinor() const
Retrieve the minor number of the interface associated with the entity.
Definition media_object.h:112
libcamera::MediaEntity::setDeviceNode
int setDeviceNode(const std::string &deviceNode)
Set the path to the device node for the associated interface.
Definition media_object.cpp:414
libcamera::MediaLink
The MediaLink represents a link between two pads in the media graph.
Definition media_object.h:44
libcamera::MediaLink::source
MediaPad * source() const
Retrieve the link's source pad.
Definition media_object.h:46
libcamera::MediaLink::sink
MediaPad * sink() const
Retrieve the link's sink pad.
Definition media_object.h:47
libcamera::MediaLink::setEnabled
int setEnabled(bool enable)
Enable or disable a link.
Definition media_object.cpp:122
libcamera::MediaLink::flags
unsigned int flags() const
Retrieve the link's flags.
Definition media_object.h:48
libcamera::MediaLink::toString
std::string toString() const
Generate a string representation of the MediaLink.
Definition media_object.cpp:153
libcamera::MediaObject
Base class for all media objects.
Definition media_object.h:24
libcamera::MediaObject::MediaObject
MediaObject(MediaDevice *dev, unsigned int id)
Construct a MediaObject part of the MediaDevice dev, identified by the id unique within the device.
Definition media_object.h:33
libcamera::MediaObject::dev_
MediaDevice * dev_
The media device the media object belongs to.
Definition media_object.h:39
libcamera::MediaObject::id
unsigned int id() const
Retrieve the media object id.
Definition media_object.h:28
libcamera::MediaObject::device
MediaDevice * device()
Retrieve the media device the media object belongs to.
Definition media_object.h:26
libcamera::MediaObject::device
const MediaDevice * device() const
Retrieve the media device the media object belongs to.
Definition media_object.h:27
libcamera::MediaObject::id_
unsigned int id_
The media object id.
Definition media_object.h:40
libcamera::MediaPad
The MediaPad represents a pad of an entity in the media graph.
Definition media_object.h:69
libcamera::MediaPad::flags
unsigned int flags() const
Retrieve the pad flags.
Definition media_object.h:73
libcamera::MediaPad::addLink
void addLink(MediaLink *link)
Add a new link to this pad.
Definition media_object.cpp:258
libcamera::MediaPad::entity
MediaEntity * entity() const
Retrieve the entity the pad belongs to.
Definition media_object.h:72
libcamera::MediaPad::links
const std::vector< MediaLink * > & links() const
Retrieve all links in the pad.
Definition media_object.h:74
libcamera::MediaPad::index
unsigned int index() const
Retrieve the pad index.
Definition media_object.h:71
libcamera::MediaPad::toString
std::string toString() const
Generate a string representation of the MediaPad.
Definition media_object.cpp:267
libcamera
Top-level libcamera namespace.
Definition backtrace.h:17
libcamera::operator<<
std::ostream & operator<<(std::ostream &out, const Point &p)
Insert a text representation of a Point into an output stream.
Definition geometry.cpp:91