aboutsummaryrefslogtreecommitdiff
path: root/Documentation/DocBook/media/v4l/media-types.xml
blob: 0ee0f3386cdf3c7881e88546c03e5347c3e5e721 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
<section id="media-controller-types">
<title>Types and flags used to represent the media graph elements</title>

    <table frame="none" pgwide="1" id="media-entity-type">
      <title>Media entity types</title>
      <tgroup cols="2">
	<colspec colname="c1"/>
	<colspec colname="c2"/>
	<tbody valign="top">
	  <row>
	    <entry><constant>MEDIA_ENT_F_UNKNOWN</constant> and <constant>MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN</constant></entry>
	    <entry>Unknown entity. That generally indicates that
	    a driver didn't initialize properly the entity, with is a Kernel bug</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_IO_V4L</constant></entry>
	    <entry>Data streaming input and/or output entity.</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_IO_VBI</constant></entry>
	    <entry>V4L VBI streaming input or output entity</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_IO_SWRADIO</constant></entry>
	    <entry>V4L Software Digital Radio (SDR) streaming input or output entity</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_IO_DTV</constant></entry>
	    <entry>DVB Digital TV streaming input or output entity</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_DTV_DEMOD</constant></entry>
	    <entry>Digital TV demodulator entity.</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_TS_DEMUX</constant></entry>
	    <entry>MPEG Transport stream demux entity. Could be implemented on hardware or in Kernelspace by the Linux DVB subsystem.</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_DTV_CA</constant></entry>
	    <entry>Digital TV Conditional Access module (CAM) entity</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_DTV_NET_DECAP</constant></entry>
	    <entry>Digital TV network ULE/MLE desencapsulation entity. Could be implemented on hardware or in Kernelspace</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_CONN_RF</constant></entry>
	    <entry>Connector for a Radio Frequency (RF) signal.</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_CONN_SVIDEO</constant></entry>
	    <entry>Connector for a S-Video signal.</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_CONN_COMPOSITE</constant></entry>
	    <entry>Connector for a RGB composite signal.</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_CAM_SENSOR</constant></entry>
	    <entry>Camera video sensor entity.</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_FLASH</constant></entry>
	    <entry>Flash controller entity.</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_LENS</constant></entry>
	    <entry>Lens controller entity.</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_ATV_DECODER</constant></entry>
	    <entry>Analog video decoder, the basic function of the video decoder
	    is to accept analogue video from a wide variety of sources such as
	    broadcast, DVD players, cameras and video cassette recorders, in
	    either NTSC, PAL, SECAM or HD format, separating the stream
	    into its component parts, luminance and chrominance, and output
	    it in some digital video standard, with appropriate timing
	    signals.</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_F_TUNER</constant></entry>
	    <entry>Digital TV, analog TV, radio and/or software radio tuner.</entry>
	  </row>
	</tbody>
      </tgroup>
    </table>

    <table frame="none" pgwide="1" id="media-entity-flag">
      <title>Media entity flags</title>
      <tgroup cols="2">
	<colspec colname="c1"/>
	<colspec colname="c2"/>
	<tbody valign="top">
	  <row>
	    <entry><constant>MEDIA_ENT_FL_DEFAULT</constant></entry>
	    <entry>Default entity for its type. Used to discover the default
	    audio, VBI and video devices, the default camera sensor, ...</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_ENT_FL_CONNECTOR</constant></entry>
	    <entry>The entity represents a data conector</entry>
	  </row>
	</tbody>
      </tgroup>
    </table>

    <table frame="none" pgwide="1" id="media-intf-type">
      <title>Media interface types</title>
      <tgroup cols="3">
	<colspec colname="c1"/>
	<colspec colname="c2"/>
	<colspec colname="c3"/>
	<tbody valign="top">
	  <row>
	    <entry><constant>MEDIA_INTF_T_DVB_FE</constant></entry>
	    <entry>Device node interface for the Digital TV frontend</entry>
	    <entry>typically, /dev/dvb/adapter?/frontend?</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_INTF_T_DVB_DEMUX</constant></entry>
	    <entry>Device node interface for the Digital TV demux</entry>
	    <entry>typically, /dev/dvb/adapter?/demux?</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_INTF_T_DVB_DVR</constant></entry>
	    <entry>Device node interface for the Digital TV DVR</entry>
	    <entry>typically, /dev/dvb/adapter?/dvr?</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_INTF_T_DVB_CA</constant></entry>
	    <entry>Device node interface for the Digital TV Conditional Access</entry>
	    <entry>typically, /dev/dvb/adapter?/ca?</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_INTF_T_DVB_FE</constant></entry>
	    <entry>Device node interface for the Digital TV network control</entry>
	    <entry>typically, /dev/dvb/adapter?/net?</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_INTF_T_V4L_VIDEO</constant></entry>
	    <entry>Device node interface for video (V4L)</entry>
	    <entry>typically, /dev/video?</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_INTF_T_V4L_VBI</constant></entry>
	    <entry>Device node interface for VBI (V4L)</entry>
	    <entry>typically, /dev/vbi?</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_INTF_T_V4L_RADIO</constant></entry>
	    <entry>Device node interface for radio (V4L)</entry>
	    <entry>typically, /dev/vbi?</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_INTF_T_V4L_SUBDEV</constant></entry>
	    <entry>Device node interface for a V4L subdevice</entry>
	    <entry>typically, /dev/v4l-subdev?</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_INTF_T_V4L_SWRADIO</constant></entry>
	    <entry>Device node interface for Software Defined Radio (V4L)</entry>
	    <entry>typically, /dev/swradio?</entry>
	  </row>
	</tbody>
      </tgroup>
    </table>

    <table frame="none" pgwide="1" id="media-pad-flag">
      <title>Media pad flags</title>
      <tgroup cols="2">
	<colspec colname="c1"/>
	<colspec colname="c2"/>
	<tbody valign="top">
	  <row>
	    <entry><constant>MEDIA_PAD_FL_SINK</constant></entry>
	    <entry>Input pad, relative to the entity. Input pads sink data and
	    are targets of links.</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_PAD_FL_SOURCE</constant></entry>
	    <entry>Output pad, relative to the entity. Output pads source data
	    and are origins of links.</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_PAD_FL_MUST_CONNECT</constant></entry>
	    <entry>If this flag is set and the pad is linked to any other
	    pad, then at least one of those links must be enabled for the
	    entity to be able to stream. There could be temporary reasons
	    (e.g. device configuration dependent) for the pad to need
	    enabled links even when this flag isn't set; the absence of the
	    flag doesn't imply there is none.</entry>
	  </row>
	</tbody>
      </tgroup>
    </table>

    <para>One and only one of <constant>MEDIA_PAD_FL_SINK</constant> and
    <constant>MEDIA_PAD_FL_SOURCE</constant> must be set for every pad.</para>

    <table frame="none" pgwide="1" id="media-link-flag">
      <title>Media link flags</title>
      <tgroup cols="2">
	<colspec colname="c1"/>
	<colspec colname="c2"/>
	<tbody valign="top">
	  <row>
	    <entry><constant>MEDIA_LNK_FL_ENABLED</constant></entry>
	    <entry>The link is enabled and can be used to transfer media data.
	    When two or more links target a sink pad, only one of them can be
	    enabled at a time.</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_LNK_FL_IMMUTABLE</constant></entry>
	    <entry>The link enabled state can't be modified at runtime. An
	    immutable link is always enabled.</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_LNK_FL_DYNAMIC</constant></entry>
	    <entry>The link enabled state can be modified during streaming. This
	    flag is set by drivers and is read-only for applications.</entry>
	  </row>
	  <row>
	    <entry><constant>MEDIA_LNK_FL_LINK_TYPE</constant></entry>
	    <entry><para>This is a bitmask that defines the type of the link.
		   Currently, two types of links are supported:</para>
	    <para><constant>MEDIA_LNK_FL_DATA_LINK</constant>
	    if the link is between two pads</para>
	    <para><constant>MEDIA_LNK_FL_INTERFACE_LINK</constant>
	    if the link is between an interface and an entity</para></entry>
	  </row>
	</tbody>
      </tgroup>
    </table>

</section>