Based on kernel version 4.7.2. Page generated on 2016-08-22 22:45 EST.
1 <section id="media-controller-types"> 2 <title>Types and flags used to represent the media graph elements</title> 3 4 <table frame="none" pgwide="1" id="media-entity-type"> 5 <title>Media entity types</title> 6 <tgroup cols="2"> 7 <colspec colname="c1"/> 8 <colspec colname="c2"/> 9 <tbody valign="top"> 10 <row> 11 <entry><constant>MEDIA_ENT_F_UNKNOWN</constant> and <constant>MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN</constant></entry> 12 <entry>Unknown entity. That generally indicates that 13 a driver didn't initialize properly the entity, with is a Kernel bug</entry> 14 </row> 15 <row> 16 <entry><constant>MEDIA_ENT_F_IO_V4L</constant></entry> 17 <entry>Data streaming input and/or output entity.</entry> 18 </row> 19 <row> 20 <entry><constant>MEDIA_ENT_F_IO_VBI</constant></entry> 21 <entry>V4L VBI streaming input or output entity</entry> 22 </row> 23 <row> 24 <entry><constant>MEDIA_ENT_F_IO_SWRADIO</constant></entry> 25 <entry>V4L Software Digital Radio (SDR) streaming input or output entity</entry> 26 </row> 27 <row> 28 <entry><constant>MEDIA_ENT_F_IO_DTV</constant></entry> 29 <entry>DVB Digital TV streaming input or output entity</entry> 30 </row> 31 <row> 32 <entry><constant>MEDIA_ENT_F_DTV_DEMOD</constant></entry> 33 <entry>Digital TV demodulator entity.</entry> 34 </row> 35 <row> 36 <entry><constant>MEDIA_ENT_F_TS_DEMUX</constant></entry> 37 <entry>MPEG Transport stream demux entity. Could be implemented on hardware or in Kernelspace by the Linux DVB subsystem.</entry> 38 </row> 39 <row> 40 <entry><constant>MEDIA_ENT_F_DTV_CA</constant></entry> 41 <entry>Digital TV Conditional Access module (CAM) entity</entry> 42 </row> 43 <row> 44 <entry><constant>MEDIA_ENT_F_DTV_NET_DECAP</constant></entry> 45 <entry>Digital TV network ULE/MLE desencapsulation entity. Could be implemented on hardware or in Kernelspace</entry> 46 </row> 47 <row> 48 <entry><constant>MEDIA_ENT_F_CONN_RF</constant></entry> 49 <entry>Connector for a Radio Frequency (RF) signal.</entry> 50 </row> 51 <row> 52 <entry><constant>MEDIA_ENT_F_CONN_SVIDEO</constant></entry> 53 <entry>Connector for a S-Video signal.</entry> 54 </row> 55 <row> 56 <entry><constant>MEDIA_ENT_F_CONN_COMPOSITE</constant></entry> 57 <entry>Connector for a RGB composite signal.</entry> 58 </row> 59 <row> 60 <entry><constant>MEDIA_ENT_F_CAM_SENSOR</constant></entry> 61 <entry>Camera video sensor entity.</entry> 62 </row> 63 <row> 64 <entry><constant>MEDIA_ENT_F_FLASH</constant></entry> 65 <entry>Flash controller entity.</entry> 66 </row> 67 <row> 68 <entry><constant>MEDIA_ENT_F_LENS</constant></entry> 69 <entry>Lens controller entity.</entry> 70 </row> 71 <row> 72 <entry><constant>MEDIA_ENT_F_ATV_DECODER</constant></entry> 73 <entry>Analog video decoder, the basic function of the video decoder 74 is to accept analogue video from a wide variety of sources such as 75 broadcast, DVD players, cameras and video cassette recorders, in 76 either NTSC, PAL, SECAM or HD format, separating the stream 77 into its component parts, luminance and chrominance, and output 78 it in some digital video standard, with appropriate timing 79 signals.</entry> 80 </row> 81 <row> 82 <entry><constant>MEDIA_ENT_F_TUNER</constant></entry> 83 <entry>Digital TV, analog TV, radio and/or software radio tuner, 84 with consists on a PLL tuning stage that converts radio 85 frequency (RF) signal into an Intermediate Frequency (IF). 86 Modern tuners have internally IF-PLL decoders for audio 87 and video, but older models have those stages implemented 88 on separate entities. 89 </entry> 90 </row> 91 <row> 92 <entry><constant>MEDIA_ENT_F_IF_VID_DECODER</constant></entry> 93 <entry>IF-PLL video decoder. It receives the IF from a PLL 94 and decodes the analog TV video signal. This is commonly 95 found on some very old analog tuners, like Philips MK3 96 designs. They all contain a tda9887 (or some software 97 compatible similar chip, like tda9885). Those devices 98 use a different I2C address than the tuner PLL. 99 </entry> 100 </row> 101 <row> 102 <entry><constant>MEDIA_ENT_F_IF_AUD_DECODER</constant></entry> 103 <entry>IF-PLL sound decoder. It receives the IF from a PLL 104 and decodes the analog TV audio signal. This is commonly 105 found on some very old analog hardware, like Micronas 106 msp3400, Philips tda9840, tda985x, etc. Those devices 107 use a different I2C address than the tuner PLL and 108 should be controlled together with the IF-PLL video 109 decoder. 110 </entry> 111 </row> 112 <row> 113 <entry><constant>MEDIA_ENT_F_AUDIO_CAPTURE</constant></entry> 114 <entry>Audio Capture Function Entity.</entry> 115 </row> 116 <row> 117 <entry><constant>MEDIA_ENT_F_AUDIO_PLAYBACK</constant></entry> 118 <entry>Audio Playback Function Entity.</entry> 119 </row> 120 <row> 121 <entry><constant>MEDIA_ENT_F_AUDIO_MIXER</constant></entry> 122 <entry>Audio Mixer Function Entity.</entry> 123 </row> 124 </tbody> 125 </tgroup> 126 </table> 127 128 <table frame="none" pgwide="1" id="media-entity-flag"> 129 <title>Media entity flags</title> 130 <tgroup cols="2"> 131 <colspec colname="c1"/> 132 <colspec colname="c2"/> 133 <tbody valign="top"> 134 <row> 135 <entry><constant>MEDIA_ENT_FL_DEFAULT</constant></entry> 136 <entry>Default entity for its type. Used to discover the default 137 audio, VBI and video devices, the default camera sensor, ...</entry> 138 </row> 139 <row> 140 <entry><constant>MEDIA_ENT_FL_CONNECTOR</constant></entry> 141 <entry>The entity represents a data conector</entry> 142 </row> 143 </tbody> 144 </tgroup> 145 </table> 146 147 <table frame="none" pgwide="1" id="media-intf-type"> 148 <title>Media interface types</title> 149 <tgroup cols="3"> 150 <colspec colname="c1"/> 151 <colspec colname="c2"/> 152 <colspec colname="c3"/> 153 <tbody valign="top"> 154 <row> 155 <entry><constant>MEDIA_INTF_T_DVB_FE</constant></entry> 156 <entry>Device node interface for the Digital TV frontend</entry> 157 <entry>typically, /dev/dvb/adapter?/frontend?</entry> 158 </row> 159 <row> 160 <entry><constant>MEDIA_INTF_T_DVB_DEMUX</constant></entry> 161 <entry>Device node interface for the Digital TV demux</entry> 162 <entry>typically, /dev/dvb/adapter?/demux?</entry> 163 </row> 164 <row> 165 <entry><constant>MEDIA_INTF_T_DVB_DVR</constant></entry> 166 <entry>Device node interface for the Digital TV DVR</entry> 167 <entry>typically, /dev/dvb/adapter?/dvr?</entry> 168 </row> 169 <row> 170 <entry><constant>MEDIA_INTF_T_DVB_CA</constant></entry> 171 <entry>Device node interface for the Digital TV Conditional Access</entry> 172 <entry>typically, /dev/dvb/adapter?/ca?</entry> 173 </row> 174 <row> 175 <entry><constant>MEDIA_INTF_T_DVB_FE</constant></entry> 176 <entry>Device node interface for the Digital TV network control</entry> 177 <entry>typically, /dev/dvb/adapter?/net?</entry> 178 </row> 179 <row> 180 <entry><constant>MEDIA_INTF_T_V4L_VIDEO</constant></entry> 181 <entry>Device node interface for video (V4L)</entry> 182 <entry>typically, /dev/video?</entry> 183 </row> 184 <row> 185 <entry><constant>MEDIA_INTF_T_V4L_VBI</constant></entry> 186 <entry>Device node interface for VBI (V4L)</entry> 187 <entry>typically, /dev/vbi?</entry> 188 </row> 189 <row> 190 <entry><constant>MEDIA_INTF_T_V4L_RADIO</constant></entry> 191 <entry>Device node interface for radio (V4L)</entry> 192 <entry>typically, /dev/vbi?</entry> 193 </row> 194 <row> 195 <entry><constant>MEDIA_INTF_T_V4L_SUBDEV</constant></entry> 196 <entry>Device node interface for a V4L subdevice</entry> 197 <entry>typically, /dev/v4l-subdev?</entry> 198 </row> 199 <row> 200 <entry><constant>MEDIA_INTF_T_V4L_SWRADIO</constant></entry> 201 <entry>Device node interface for Software Defined Radio (V4L)</entry> 202 <entry>typically, /dev/swradio?</entry> 203 </row> 204 <row> 205 <entry><constant>MEDIA_INTF_T_ALSA_PCM_CAPTURE</constant></entry> 206 <entry>Device node interface for ALSA PCM Capture</entry> 207 <entry>typically, /dev/snd/pcmC?D?c</entry> 208 </row> 209 <row> 210 <entry><constant>MEDIA_INTF_T_ALSA_PCM_PLAYBACK</constant></entry> 211 <entry>Device node interface for ALSA PCM Playback</entry> 212 <entry>typically, /dev/snd/pcmC?D?p</entry> 213 </row> 214 <row> 215 <entry><constant>MEDIA_INTF_T_ALSA_CONTROL</constant></entry> 216 <entry>Device node interface for ALSA Control</entry> 217 <entry>typically, /dev/snd/controlC?</entry> 218 </row> 219 <row> 220 <entry><constant>MEDIA_INTF_T_ALSA_COMPRESS</constant></entry> 221 <entry>Device node interface for ALSA Compress</entry> 222 <entry>typically, /dev/snd/compr?</entry> 223 </row> 224 <row> 225 <entry><constant>MEDIA_INTF_T_ALSA_RAWMIDI</constant></entry> 226 <entry>Device node interface for ALSA Raw MIDI</entry> 227 <entry>typically, /dev/snd/midi?</entry> 228 </row> 229 <row> 230 <entry><constant>MEDIA_INTF_T_ALSA_HWDEP</constant></entry> 231 <entry>Device node interface for ALSA Hardware Dependent</entry> 232 <entry>typically, /dev/snd/hwC?D?</entry> 233 </row> 234 <row> 235 <entry><constant>MEDIA_INTF_T_ALSA_SEQUENCER</constant></entry> 236 <entry>Device node interface for ALSA Sequencer</entry> 237 <entry>typically, /dev/snd/seq</entry> 238 </row> 239 <row> 240 <entry><constant>MEDIA_INTF_T_ALSA_TIMER</constant></entry> 241 <entry>Device node interface for ALSA Timer</entry> 242 <entry>typically, /dev/snd/timer</entry> 243 </row> 244 </tbody> 245 </tgroup> 246 </table> 247 248 <table frame="none" pgwide="1" id="media-pad-flag"> 249 <title>Media pad flags</title> 250 <tgroup cols="2"> 251 <colspec colname="c1"/> 252 <colspec colname="c2"/> 253 <tbody valign="top"> 254 <row> 255 <entry><constant>MEDIA_PAD_FL_SINK</constant></entry> 256 <entry>Input pad, relative to the entity. Input pads sink data and 257 are targets of links.</entry> 258 </row> 259 <row> 260 <entry><constant>MEDIA_PAD_FL_SOURCE</constant></entry> 261 <entry>Output pad, relative to the entity. Output pads source data 262 and are origins of links.</entry> 263 </row> 264 <row> 265 <entry><constant>MEDIA_PAD_FL_MUST_CONNECT</constant></entry> 266 <entry>If this flag is set and the pad is linked to any other 267 pad, then at least one of those links must be enabled for the 268 entity to be able to stream. There could be temporary reasons 269 (e.g. device configuration dependent) for the pad to need 270 enabled links even when this flag isn't set; the absence of the 271 flag doesn't imply there is none.</entry> 272 </row> 273 </tbody> 274 </tgroup> 275 </table> 276 277 <para>One and only one of <constant>MEDIA_PAD_FL_SINK</constant> and 278 <constant>MEDIA_PAD_FL_SOURCE</constant> must be set for every pad.</para> 279 280 <table frame="none" pgwide="1" id="media-link-flag"> 281 <title>Media link flags</title> 282 <tgroup cols="2"> 283 <colspec colname="c1"/> 284 <colspec colname="c2"/> 285 <tbody valign="top"> 286 <row> 287 <entry><constant>MEDIA_LNK_FL_ENABLED</constant></entry> 288 <entry>The link is enabled and can be used to transfer media data. 289 When two or more links target a sink pad, only one of them can be 290 enabled at a time.</entry> 291 </row> 292 <row> 293 <entry><constant>MEDIA_LNK_FL_IMMUTABLE</constant></entry> 294 <entry>The link enabled state can't be modified at runtime. An 295 immutable link is always enabled.</entry> 296 </row> 297 <row> 298 <entry><constant>MEDIA_LNK_FL_DYNAMIC</constant></entry> 299 <entry>The link enabled state can be modified during streaming. This 300 flag is set by drivers and is read-only for applications.</entry> 301 </row> 302 <row> 303 <entry><constant>MEDIA_LNK_FL_LINK_TYPE</constant></entry> 304 <entry><para>This is a bitmask that defines the type of the link. 305 Currently, two types of links are supported:</para> 306 <para><constant>MEDIA_LNK_FL_DATA_LINK</constant> 307 if the link is between two pads</para> 308 <para><constant>MEDIA_LNK_FL_INTERFACE_LINK</constant> 309 if the link is between an interface and an entity</para></entry> 310 </row> 311 </tbody> 312 </tgroup> 313 </table> 314 315 </section>
