Documentation/DocBook/media/v4l/vidioc-dv-timings-cap.xml

   1 <refentry id="vidioc-dv-timings-cap">
   2   <refmeta>
   3     <refentrytitle>ioctl VIDIOC_DV_TIMINGS_CAP</refentrytitle>
   4     &manvol;
   5   </refmeta>
   6
   7   <refnamediv>
   8     <refname>VIDIOC_DV_TIMINGS_CAP</refname>
   9     <refpurpose>The capabilities of the Digital Video receiver/transmitter</refpurpose>
  10   </refnamediv>
  11
  12   <refsynopsisdiv>
  13     <funcsynopsis>
  14       <funcprototype>
  15         <funcdef>int <function>ioctl</function></funcdef>
  16         <paramdef>int <parameter>fd</parameter></paramdef>
  17         <paramdef>int <parameter>request</parameter></paramdef>
  18         <paramdef>struct v4l2_dv_timings_cap *<parameter>argp</parameter></paramdef>
  19       </funcprototype>
  20     </funcsynopsis>
  21   </refsynopsisdiv>
  22
  23   <refsect1>
  24     <title>Arguments</title>
  25
  26     <variablelist>
  27       <varlistentry>
  28         <term><parameter>fd</parameter></term>
  29         <listitem>
  30           <para>&fd;</para>
  31         </listitem>
  32       </varlistentry>
  33       <varlistentry>
  34         <term><parameter>request</parameter></term>
  35         <listitem>
  36           <para>VIDIOC_DV_TIMINGS_CAP</para>
  37         </listitem>
  38       </varlistentry>
  39       <varlistentry>
  40         <term><parameter>argp</parameter></term>
  41         <listitem>
  42           <para></para>
  43         </listitem>
  44       </varlistentry>
  45     </variablelist>
  46   </refsect1>
  47
  48   <refsect1>
  49     <title>Description</title>
  50
  51     <note>
  52       <title>Experimental</title>
  53       <para>This is an <link linkend="experimental"> experimental </link>
  54       interface and may change in the future.</para>
  55     </note>
  56
  57     <para>To query the capabilities of the DV receiver/transmitter applications can call
  58 this ioctl and the driver will fill in the structure. Note that drivers may return
  59 different values after switching the video input or output.</para>
  60
  61     <table pgwide="1" frame="none" id="v4l2-bt-timings-cap">
  62       <title>struct <structname>v4l2_bt_timings_cap</structname></title>
  63       <tgroup cols="3">
  64         &cs-str;
  65         <tbody valign="top">
  66           <row>
  67             <entry>__u32</entry>
  68             <entry><structfield>min_width</structfield></entry>
  69             <entry>Minimum width of the active video in pixels.</entry>
  70           </row>
  71           <row>
  72             <entry>__u32</entry>
  73             <entry><structfield>max_width</structfield></entry>
  74             <entry>Maximum width of the active video in pixels.</entry>
  75           </row>
  76           <row>
  77             <entry>__u32</entry>
  78             <entry><structfield>min_height</structfield></entry>
  79             <entry>Minimum height of the active video in lines.</entry>
  80           </row>
  81           <row>
  82             <entry>__u32</entry>
  83             <entry><structfield>max_height</structfield></entry>
  84             <entry>Maximum height of the active video in lines.</entry>
  85           </row>
  86           <row>
  87             <entry>__u64</entry>
  88             <entry><structfield>min_pixelclock</structfield></entry>
  89             <entry>Minimum pixelclock frequency in Hz.</entry>
  90           </row>
  91           <row>
  92             <entry>__u64</entry>
  93             <entry><structfield>max_pixelclock</structfield></entry>
  94             <entry>Maximum pixelclock frequency in Hz.</entry>
  95           </row>
  96           <row>
  97             <entry>__u32</entry>
  98             <entry><structfield>standards</structfield></entry>
  99             <entry>The video standard(s) supported by the hardware.
 100             See <xref linkend="dv-bt-standards"/> for a list of standards.</entry>
 101           </row>
 102           <row>
 103             <entry>__u32</entry>
 104             <entry><structfield>capabilities</structfield></entry>
 105             <entry>Several flags giving more information about the capabilities.
 106             See <xref linkend="dv-bt-cap-capabilities"/> for a description of the flags.
 107             </entry>
 108           </row>
 109           <row>
 110             <entry>__u32</entry>
 111             <entry><structfield>reserved</structfield>[16]</entry>
 112             <entry>Reserved for future extensions. Drivers must set the array to zero.</entry>
 113           </row>
 114         </tbody>
 115       </tgroup>
 116     </table>
 117
 118     <table pgwide="1" frame="none" id="v4l2-dv-timings-cap">
 119       <title>struct <structname>v4l2_dv_timings_cap</structname></title>
 120       <tgroup cols="4">
 121         &cs-str;
 122         <tbody valign="top">
 123           <row>
 124             <entry>__u32</entry>
 125             <entry><structfield>type</structfield></entry>
 126             <entry>Type of DV timings as listed in <xref linkend="dv-timing-types"/>.</entry>
 127           </row>
 128           <row>
 129             <entry>__u32</entry>
 130             <entry><structfield>reserved</structfield>[3]</entry>
 131             <entry>Reserved for future extensions. Drivers must set the array to zero.</entry>
 132           </row>
 133           <row>
 134             <entry>union</entry>
 135             <entry><structfield></structfield></entry>
 136             <entry></entry>
 137           </row>
 138           <row>
 139             <entry></entry>
 140             <entry>&v4l2-bt-timings-cap;</entry>
 141             <entry><structfield>bt</structfield></entry>
 142             <entry>BT.656/1120 timings capabilities of the hardware.</entry>
 143           </row>
 144           <row>
 145             <entry></entry>
 146             <entry>__u32</entry>
 147             <entry><structfield>raw_data</structfield>[32]</entry>
 148             <entry></entry>
 149           </row>
 150         </tbody>
 151       </tgroup>
 152     </table>
 153
 154     <table pgwide="1" frame="none" id="dv-bt-cap-capabilities">
 155       <title>DV BT Timing capabilities</title>
 156       <tgroup cols="2">
 157         &cs-str;
 158         <tbody valign="top">
 159           <row>
 160             <entry>Flag</entry>
 161             <entry>Description</entry>
 162           </row>
 163           <row>
 164             <entry></entry>
 165             <entry></entry>
 166           </row>
 167           <row>
 168             <entry>V4L2_DV_BT_CAP_INTERLACED</entry>
 169             <entry>Interlaced formats are supported.
 170             </entry>
 171           </row>
 172           <row>
 173             <entry>V4L2_DV_BT_CAP_PROGRESSIVE</entry>
 174             <entry>Progressive formats are supported.
 175             </entry>
 176           </row>
 177           <row>
 178             <entry>V4L2_DV_BT_CAP_REDUCED_BLANKING</entry>
 179             <entry>CVT/GTF specific: the timings can make use of reduced blanking (CVT)
 180 or the 'Secondary GTF' curve (GTF).
 181             </entry>
 182           </row>
 183           <row>
 184             <entry>V4L2_DV_BT_CAP_CUSTOM</entry>
 185             <entry>Can support non-standard timings, i.e. timings not belonging to the
 186 standards set in the <structfield>standards</structfield> field.
 187             </entry>
 188           </row>
 189         </tbody>
 190       </tgroup>
 191     </table>
 192   </refsect1>
 193
 194   <refsect1>
 195     &return-value;
 196   </refsect1>
 197 </refentry>
 198
 199 <!--
 200 Local Variables:
 201 mode: sgml
 202 sgml-parent-document: "v4l2.sgml"
 203 indent-tabs-mode: nil
 204 End:
 205 -->