Documentation/DocBook/media/v4l/media-types.xml

   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_CONN_TEST</constant></entry>
  61             <entry>Connector for a test generator.</entry>
  62           </row>
  63           <row>
  64             <entry><constant>MEDIA_ENT_F_CAM_SENSOR</constant></entry>
  65             <entry>Camera video sensor entity.</entry>
  66           </row>
  67           <row>
  68             <entry><constant>MEDIA_ENT_F_FLASH</constant></entry>
  69             <entry>Flash controller entity.</entry>
  70           </row>
  71           <row>
  72             <entry><constant>MEDIA_ENT_F_LENS</constant></entry>
  73             <entry>Lens controller entity.</entry>
  74           </row>
  75           <row>
  76             <entry><constant>MEDIA_ENT_F_ATV_DECODER</constant></entry>
  77             <entry>Analog video decoder, the basic function of the video decoder
  78             is to accept analogue video from a wide variety of sources such as
  79             broadcast, DVD players, cameras and video cassette recorders, in
  80             either NTSC, PAL, SECAM or HD format, separating the stream
  81             into its component parts, luminance and chrominance, and output
  82             it in some digital video standard, with appropriate timing
  83             signals.</entry>
  84           </row>
  85           <row>
  86             <entry><constant>MEDIA_ENT_F_TUNER</constant></entry>
  87             <entry>Digital TV, analog TV, radio and/or software radio tuner,
  88                    with consists on a PLL tuning stage that converts radio
  89                    frequency (RF) signal into an Intermediate Frequency (IF).
  90                    Modern tuners have internally IF-PLL decoders for audio
  91                    and video, but older models have those stages implemented
  92                    on separate entities.
  93             </entry>
  94           </row>
  95           <row>
  96             <entry><constant>MEDIA_ENT_F_IF_VID_DECODER</constant></entry>
  97             <entry>IF-PLL video decoder. It receives the IF from a PLL
  98                    and decodes the analog TV video signal. This is commonly
  99                    found on some very old analog tuners, like Philips MK3
 100                    designs. They all contain a tda9887 (or some software
 101                    compatible similar chip, like tda9885). Those devices
 102                    use a different I2C address than the tuner PLL.
 103             </entry>
 104           </row>
 105           <row>
 106             <entry><constant>MEDIA_ENT_F_IF_AUD_DECODER</constant></entry>
 107             <entry>IF-PLL sound decoder. It receives the IF from a PLL
 108                    and decodes the analog TV audio signal. This is commonly
 109                    found on some very old analog hardware, like Micronas
 110                    msp3400, Philips tda9840, tda985x, etc. Those devices
 111                    use a different I2C address than the tuner PLL and
 112                    should be controlled together with the IF-PLL video
 113                    decoder.
 114             </entry>
 115           </row>
 116         </tbody>
 117       </tgroup>
 118     </table>
 119
 120     <table frame="none" pgwide="1" id="media-entity-flag">
 121       <title>Media entity flags</title>
 122       <tgroup cols="2">
 123         <colspec colname="c1"/>
 124         <colspec colname="c2"/>
 125         <tbody valign="top">
 126           <row>
 127             <entry><constant>MEDIA_ENT_FL_DEFAULT</constant></entry>
 128             <entry>Default entity for its type. Used to discover the default
 129             audio, VBI and video devices, the default camera sensor, ...</entry>
 130           </row>
 131           <row>
 132             <entry><constant>MEDIA_ENT_FL_CONNECTOR</constant></entry>
 133             <entry>The entity represents a data conector</entry>
 134           </row>
 135         </tbody>
 136       </tgroup>
 137     </table>
 138
 139     <table frame="none" pgwide="1" id="media-intf-type">
 140       <title>Media interface types</title>
 141       <tgroup cols="3">
 142         <colspec colname="c1"/>
 143         <colspec colname="c2"/>
 144         <colspec colname="c3"/>
 145         <tbody valign="top">
 146           <row>
 147             <entry><constant>MEDIA_INTF_T_DVB_FE</constant></entry>
 148             <entry>Device node interface for the Digital TV frontend</entry>
 149             <entry>typically, /dev/dvb/adapter?/frontend?</entry>
 150           </row>
 151           <row>
 152             <entry><constant>MEDIA_INTF_T_DVB_DEMUX</constant></entry>
 153             <entry>Device node interface for the Digital TV demux</entry>
 154             <entry>typically, /dev/dvb/adapter?/demux?</entry>
 155           </row>
 156           <row>
 157             <entry><constant>MEDIA_INTF_T_DVB_DVR</constant></entry>
 158             <entry>Device node interface for the Digital TV DVR</entry>
 159             <entry>typically, /dev/dvb/adapter?/dvr?</entry>
 160           </row>
 161           <row>
 162             <entry><constant>MEDIA_INTF_T_DVB_CA</constant></entry>
 163             <entry>Device node interface for the Digital TV Conditional Access</entry>
 164             <entry>typically, /dev/dvb/adapter?/ca?</entry>
 165           </row>
 166           <row>
 167             <entry><constant>MEDIA_INTF_T_DVB_FE</constant></entry>
 168             <entry>Device node interface for the Digital TV network control</entry>
 169             <entry>typically, /dev/dvb/adapter?/net?</entry>
 170           </row>
 171           <row>
 172             <entry><constant>MEDIA_INTF_T_V4L_VIDEO</constant></entry>
 173             <entry>Device node interface for video (V4L)</entry>
 174             <entry>typically, /dev/video?</entry>
 175           </row>
 176           <row>
 177             <entry><constant>MEDIA_INTF_T_V4L_VBI</constant></entry>
 178             <entry>Device node interface for VBI (V4L)</entry>
 179             <entry>typically, /dev/vbi?</entry>
 180           </row>
 181           <row>
 182             <entry><constant>MEDIA_INTF_T_V4L_RADIO</constant></entry>
 183             <entry>Device node interface for radio (V4L)</entry>
 184             <entry>typically, /dev/vbi?</entry>
 185           </row>
 186           <row>
 187             <entry><constant>MEDIA_INTF_T_V4L_SUBDEV</constant></entry>
 188             <entry>Device node interface for a V4L subdevice</entry>
 189             <entry>typically, /dev/v4l-subdev?</entry>
 190           </row>
 191           <row>
 192             <entry><constant>MEDIA_INTF_T_V4L_SWRADIO</constant></entry>
 193             <entry>Device node interface for Software Defined Radio (V4L)</entry>
 194             <entry>typically, /dev/swradio?</entry>
 195           </row>
 196         </tbody>
 197       </tgroup>
 198     </table>
 199
 200     <table frame="none" pgwide="1" id="media-pad-flag">
 201       <title>Media pad flags</title>
 202       <tgroup cols="2">
 203         <colspec colname="c1"/>
 204         <colspec colname="c2"/>
 205         <tbody valign="top">
 206           <row>
 207             <entry><constant>MEDIA_PAD_FL_SINK</constant></entry>
 208             <entry>Input pad, relative to the entity. Input pads sink data and
 209             are targets of links.</entry>
 210           </row>
 211           <row>
 212             <entry><constant>MEDIA_PAD_FL_SOURCE</constant></entry>
 213             <entry>Output pad, relative to the entity. Output pads source data
 214             and are origins of links.</entry>
 215           </row>
 216           <row>
 217             <entry><constant>MEDIA_PAD_FL_MUST_CONNECT</constant></entry>
 218             <entry>If this flag is set and the pad is linked to any other
 219             pad, then at least one of those links must be enabled for the
 220             entity to be able to stream. There could be temporary reasons
 221             (e.g. device configuration dependent) for the pad to need
 222             enabled links even when this flag isn't set; the absence of the
 223             flag doesn't imply there is none.</entry>
 224           </row>
 225         </tbody>
 226       </tgroup>
 227     </table>
 228
 229     <para>One and only one of <constant>MEDIA_PAD_FL_SINK</constant> and
 230     <constant>MEDIA_PAD_FL_SOURCE</constant> must be set for every pad.</para>
 231
 232     <table frame="none" pgwide="1" id="media-link-flag">
 233       <title>Media link flags</title>
 234       <tgroup cols="2">
 235         <colspec colname="c1"/>
 236         <colspec colname="c2"/>
 237         <tbody valign="top">
 238           <row>
 239             <entry><constant>MEDIA_LNK_FL_ENABLED</constant></entry>
 240             <entry>The link is enabled and can be used to transfer media data.
 241             When two or more links target a sink pad, only one of them can be
 242             enabled at a time.</entry>
 243           </row>
 244           <row>
 245             <entry><constant>MEDIA_LNK_FL_IMMUTABLE</constant></entry>
 246             <entry>The link enabled state can't be modified at runtime. An
 247             immutable link is always enabled.</entry>
 248           </row>
 249           <row>
 250             <entry><constant>MEDIA_LNK_FL_DYNAMIC</constant></entry>
 251             <entry>The link enabled state can be modified during streaming. This
 252             flag is set by drivers and is read-only for applications.</entry>
 253           </row>
 254           <row>
 255             <entry><constant>MEDIA_LNK_FL_LINK_TYPE</constant></entry>
 256             <entry><para>This is a bitmask that defines the type of the link.
 257                    Currently, two types of links are supported:</para>
 258             <para><constant>MEDIA_LNK_FL_DATA_LINK</constant>
 259             if the link is between two pads</para>
 260             <para><constant>MEDIA_LNK_FL_INTERFACE_LINK</constant>
 261             if the link is between an interface and an entity</para></entry>
 262           </row>
 263         </tbody>
 264       </tgroup>
 265     </table>
 266
 267 </section>