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_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.</entry>
  84           </row>
  85         </tbody>
  86       </tgroup>
  87     </table>
  88
  89     <table frame="none" pgwide="1" id="media-entity-flag">
  90       <title>Media entity flags</title>
  91       <tgroup cols="2">
  92         <colspec colname="c1"/>
  93         <colspec colname="c2"/>
  94         <tbody valign="top">
  95           <row>
  96             <entry><constant>MEDIA_ENT_FL_DEFAULT</constant></entry>
  97             <entry>Default entity for its type. Used to discover the default
  98             audio, VBI and video devices, the default camera sensor, ...</entry>
  99           </row>
 100           <row>
 101             <entry><constant>MEDIA_ENT_FL_CONNECTOR</constant></entry>
 102             <entry>The entity represents a data conector</entry>
 103           </row>
 104         </tbody>
 105       </tgroup>
 106     </table>
 107
 108     <table frame="none" pgwide="1" id="media-intf-type">
 109       <title>Media interface types</title>
 110       <tgroup cols="3">
 111         <colspec colname="c1"/>
 112         <colspec colname="c2"/>
 113         <colspec colname="c3"/>
 114         <tbody valign="top">
 115           <row>
 116             <entry><constant>MEDIA_INTF_T_DVB_FE</constant></entry>
 117             <entry>Device node interface for the Digital TV frontend</entry>
 118             <entry>typically, /dev/dvb/adapter?/frontend?</entry>
 119           </row>
 120           <row>
 121             <entry><constant>MEDIA_INTF_T_DVB_DEMUX</constant></entry>
 122             <entry>Device node interface for the Digital TV demux</entry>
 123             <entry>typically, /dev/dvb/adapter?/demux?</entry>
 124           </row>
 125           <row>
 126             <entry><constant>MEDIA_INTF_T_DVB_DVR</constant></entry>
 127             <entry>Device node interface for the Digital TV DVR</entry>
 128             <entry>typically, /dev/dvb/adapter?/dvr?</entry>
 129           </row>
 130           <row>
 131             <entry><constant>MEDIA_INTF_T_DVB_CA</constant></entry>
 132             <entry>Device node interface for the Digital TV Conditional Access</entry>
 133             <entry>typically, /dev/dvb/adapter?/ca?</entry>
 134           </row>
 135           <row>
 136             <entry><constant>MEDIA_INTF_T_DVB_FE</constant></entry>
 137             <entry>Device node interface for the Digital TV network control</entry>
 138             <entry>typically, /dev/dvb/adapter?/net?</entry>
 139           </row>
 140           <row>
 141             <entry><constant>MEDIA_INTF_T_V4L_VIDEO</constant></entry>
 142             <entry>Device node interface for video (V4L)</entry>
 143             <entry>typically, /dev/video?</entry>
 144           </row>
 145           <row>
 146             <entry><constant>MEDIA_INTF_T_V4L_VBI</constant></entry>
 147             <entry>Device node interface for VBI (V4L)</entry>
 148             <entry>typically, /dev/vbi?</entry>
 149           </row>
 150           <row>
 151             <entry><constant>MEDIA_INTF_T_V4L_RADIO</constant></entry>
 152             <entry>Device node interface for radio (V4L)</entry>
 153             <entry>typically, /dev/vbi?</entry>
 154           </row>
 155           <row>
 156             <entry><constant>MEDIA_INTF_T_V4L_SUBDEV</constant></entry>
 157             <entry>Device node interface for a V4L subdevice</entry>
 158             <entry>typically, /dev/v4l-subdev?</entry>
 159           </row>
 160           <row>
 161             <entry><constant>MEDIA_INTF_T_V4L_SWRADIO</constant></entry>
 162             <entry>Device node interface for Software Defined Radio (V4L)</entry>
 163             <entry>typically, /dev/swradio?</entry>
 164           </row>
 165         </tbody>
 166       </tgroup>
 167     </table>
 168
 169     <table frame="none" pgwide="1" id="media-pad-flag">
 170       <title>Media pad flags</title>
 171       <tgroup cols="2">
 172         <colspec colname="c1"/>
 173         <colspec colname="c2"/>
 174         <tbody valign="top">
 175           <row>
 176             <entry><constant>MEDIA_PAD_FL_SINK</constant></entry>
 177             <entry>Input pad, relative to the entity. Input pads sink data and
 178             are targets of links.</entry>
 179           </row>
 180           <row>
 181             <entry><constant>MEDIA_PAD_FL_SOURCE</constant></entry>
 182             <entry>Output pad, relative to the entity. Output pads source data
 183             and are origins of links.</entry>
 184           </row>
 185           <row>
 186             <entry><constant>MEDIA_PAD_FL_MUST_CONNECT</constant></entry>
 187             <entry>If this flag is set and the pad is linked to any other
 188             pad, then at least one of those links must be enabled for the
 189             entity to be able to stream. There could be temporary reasons
 190             (e.g. device configuration dependent) for the pad to need
 191             enabled links even when this flag isn't set; the absence of the
 192             flag doesn't imply there is none.</entry>
 193           </row>
 194         </tbody>
 195       </tgroup>
 196     </table>
 197
 198     <para>One and only one of <constant>MEDIA_PAD_FL_SINK</constant> and
 199     <constant>MEDIA_PAD_FL_SOURCE</constant> must be set for every pad.</para>
 200
 201     <table frame="none" pgwide="1" id="media-link-flag">
 202       <title>Media link flags</title>
 203       <tgroup cols="2">
 204         <colspec colname="c1"/>
 205         <colspec colname="c2"/>
 206         <tbody valign="top">
 207           <row>
 208             <entry><constant>MEDIA_LNK_FL_ENABLED</constant></entry>
 209             <entry>The link is enabled and can be used to transfer media data.
 210             When two or more links target a sink pad, only one of them can be
 211             enabled at a time.</entry>
 212           </row>
 213           <row>
 214             <entry><constant>MEDIA_LNK_FL_IMMUTABLE</constant></entry>
 215             <entry>The link enabled state can't be modified at runtime. An
 216             immutable link is always enabled.</entry>
 217           </row>
 218           <row>
 219             <entry><constant>MEDIA_LNK_FL_DYNAMIC</constant></entry>
 220             <entry>The link enabled state can be modified during streaming. This
 221             flag is set by drivers and is read-only for applications.</entry>
 222           </row>
 223           <row>
 224             <entry><constant>MEDIA_LNK_FL_LINK_TYPE</constant></entry>
 225             <entry><para>This is a bitmask that defines the type of the link.
 226                    Currently, two types of links are supported:</para>
 227             <para><constant>MEDIA_LNK_FL_DATA_LINK</constant>
 228             if the link is between two pads</para>
 229             <para><constant>MEDIA_LNK_FL_INTERFACE_LINK</constant>
 230             if the link is between an interface and an entity</para></entry>
 231           </row>
 232         </tbody>
 233       </tgroup>
 234     </table>
 235
 236 </section>