About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / DocBook / media / v4l / vidioc-enum-dv-presets.xml




Custom Search

Based on kernel version 3.9. Page generated on 2013-05-02 23:04 EST.

1	<refentry id="vidioc-enum-dv-presets">
2	  <refmeta>
3	    <refentrytitle>ioctl VIDIOC_ENUM_DV_PRESETS</refentrytitle>
4	    &manvol;
5	  </refmeta>
6	
7	  <refnamediv>
8	    <refname>VIDIOC_ENUM_DV_PRESETS</refname>
9	    <refpurpose>Enumerate supported Digital Video presets</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_enum_preset *<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_ENUM_DV_PRESETS</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	    <para>This ioctl is <emphasis role="bold">deprecated</emphasis>.
52	    New drivers and applications should use &VIDIOC-ENUM-DV-TIMINGS; instead.
53	    </para>
54	
55	    <para>To query the attributes of a DV preset, applications initialize the
56	<structfield>index</structfield> field and zero the reserved array of &v4l2-dv-enum-preset;
57	and call the <constant>VIDIOC_ENUM_DV_PRESETS</constant> ioctl with a pointer to this
58	structure. Drivers fill the rest of the structure or return an
59	&EINVAL; when the index is out of bounds. To enumerate all DV Presets supported,
60	applications shall begin at index zero, incrementing by one until the
61	driver returns <errorcode>EINVAL</errorcode>. Drivers may enumerate a
62	different set of DV presets after switching the video input or
63	output.</para>
64	
65	    <table pgwide="1" frame="none" id="v4l2-dv-enum-preset">
66	      <title>struct <structname>v4l2_dv_enum_presets</structname></title>
67	      <tgroup cols="3">
68		&cs-str;
69		<tbody valign="top">
70		  <row>
71		    <entry>__u32</entry>
72		    <entry><structfield>index</structfield></entry>
73		    <entry>Number of the DV preset, set by the
74	application.</entry>
75		  </row>
76		  <row>
77		    <entry>__u32</entry>
78		    <entry><structfield>preset</structfield></entry>
79		    <entry>This field identifies one of the DV preset values listed in <xref linkend="v4l2-dv-presets-vals"/>.</entry>
80		  </row>
81		  <row>
82		    <entry>__u8</entry>
83		    <entry><structfield>name</structfield>[24]</entry>
84		    <entry>Name of the preset, a NUL-terminated ASCII string, for example: "720P-60", "1080I-60". This information is
85	intended for the user.</entry>
86		  </row>
87		  <row>
88		    <entry>__u32</entry>
89		    <entry><structfield>width</structfield></entry>
90		    <entry>Width of the active video in pixels for the DV preset.</entry>
91		  </row>
92		  <row>
93		    <entry>__u32</entry>
94		    <entry><structfield>height</structfield></entry>
95		    <entry>Height of the active video in lines for the DV preset.</entry>
96		  </row>
97		  <row>
98		    <entry>__u32</entry>
99		    <entry><structfield>reserved</structfield>[4]</entry>
100		    <entry>Reserved for future extensions. Drivers must set the array to zero.</entry>
101		  </row>
102		</tbody>
103	      </tgroup>
104	    </table>
105	
106	    <table pgwide="1" frame="none" id="v4l2-dv-presets-vals">
107	      <title>struct <structname>DV Presets</structname></title>
108	      <tgroup cols="3">
109		&cs-str;
110		<tbody valign="top">
111		  <row>
112		    <entry>Preset</entry>
113		    <entry>Preset value</entry>
114		    <entry>Description</entry>
115		  </row>
116		  <row>
117		    <entry></entry>
118		    <entry></entry>
119		    <entry></entry>
120		  </row>
121		  <row>
122		    <entry>V4L2_DV_INVALID</entry>
123		    <entry>0</entry>
124		    <entry>Invalid preset value.</entry>
125		  </row>
126		  <row>
127		    <entry>V4L2_DV_480P59_94</entry>
128		    <entry>1</entry>
129		    <entry>720x480 progressive video at 59.94 fps as per BT.1362.</entry>
130		  </row>
131		  <row>
132		    <entry>V4L2_DV_576P50</entry>
133		    <entry>2</entry>
134		    <entry>720x576 progressive video at 50 fps as per BT.1362.</entry>
135		  </row>
136		  <row>
137		    <entry>V4L2_DV_720P24</entry>
138		    <entry>3</entry>
139		    <entry>1280x720 progressive video at 24 fps as per SMPTE 296M.</entry>
140		  </row>
141		  <row>
142		    <entry>V4L2_DV_720P25</entry>
143		    <entry>4</entry>
144		    <entry>1280x720 progressive video at 25 fps as per SMPTE 296M.</entry>
145		  </row>
146		  <row>
147		    <entry>V4L2_DV_720P30</entry>
148		    <entry>5</entry>
149		    <entry>1280x720 progressive video at 30 fps as per SMPTE 296M.</entry>
150		  </row>
151		  <row>
152		    <entry>V4L2_DV_720P50</entry>
153		    <entry>6</entry>
154		    <entry>1280x720 progressive video at 50 fps as per SMPTE 296M.</entry>
155		  </row>
156		  <row>
157		    <entry>V4L2_DV_720P59_94</entry>
158		    <entry>7</entry>
159		    <entry>1280x720 progressive video at 59.94 fps as per SMPTE 274M.</entry>
160		  </row>
161		  <row>
162		    <entry>V4L2_DV_720P60</entry>
163		    <entry>8</entry>
164		    <entry>1280x720 progressive video at 60 fps as per SMPTE 274M/296M.</entry>
165		  </row>
166		  <row>
167		    <entry>V4L2_DV_1080I29_97</entry>
168		    <entry>9</entry>
169		    <entry>1920x1080 interlaced video at 29.97 fps as per BT.1120/SMPTE 274M.</entry>
170		  </row>
171		  <row>
172		    <entry>V4L2_DV_1080I30</entry>
173		    <entry>10</entry>
174		    <entry>1920x1080 interlaced video at 30 fps as per BT.1120/SMPTE 274M.</entry>
175		  </row>
176		  <row>
177		    <entry>V4L2_DV_1080I25</entry>
178		    <entry>11</entry>
179		    <entry>1920x1080 interlaced video at 25 fps as per BT.1120.</entry>
180		  </row>
181		  <row>
182		    <entry>V4L2_DV_1080I50</entry>
183		    <entry>12</entry>
184		    <entry>1920x1080 interlaced video at 50 fps as per SMPTE 296M.</entry>
185		  </row>
186		  <row>
187		    <entry>V4L2_DV_1080I60</entry>
188		    <entry>13</entry>
189		    <entry>1920x1080 interlaced video at 60 fps as per SMPTE 296M.</entry>
190		  </row>
191		  <row>
192		    <entry>V4L2_DV_1080P24</entry>
193		    <entry>14</entry>
194		    <entry>1920x1080 progressive video at 24 fps as per SMPTE 296M.</entry>
195		  </row>
196		  <row>
197		    <entry>V4L2_DV_1080P25</entry>
198		    <entry>15</entry>
199		    <entry>1920x1080 progressive video at 25 fps as per SMPTE 296M.</entry>
200		  </row>
201		  <row>
202		    <entry>V4L2_DV_1080P30</entry>
203		    <entry>16</entry>
204		    <entry>1920x1080 progressive video at 30 fps as per SMPTE 296M.</entry>
205		  </row>
206		  <row>
207		    <entry>V4L2_DV_1080P50</entry>
208		    <entry>17</entry>
209		    <entry>1920x1080 progressive video at 50 fps as per BT.1120.</entry>
210		  </row>
211		  <row>
212		    <entry>V4L2_DV_1080P60</entry>
213		    <entry>18</entry>
214		    <entry>1920x1080 progressive video at 60 fps as per BT.1120.</entry>
215		  </row>
216		</tbody>
217	      </tgroup>
218	    </table>
219	  </refsect1>
220	
221	  <refsect1>
222	    &return-value;
223	
224	    <variablelist>
225	      <varlistentry>
226		<term><errorcode>EINVAL</errorcode></term>
227		<listitem>
228		  <para>The &v4l2-dv-enum-preset; <structfield>index</structfield>
229	is out of bounds.</para>
230		</listitem>
231	      </varlistentry>
232	      <varlistentry>
233		<term><errorcode>ENODATA</errorcode></term>
234		<listitem>
235		  <para>Digital video presets are not supported for this input or output.</para>
236		</listitem>
237	      </varlistentry>
238	    </variablelist>
239	  </refsect1>
240	</refentry>
Hide Line Numbers
About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Information is copyright its respective author. All material is available from the Linux Kernel Source distributed under a GPL License. This page is provided as a free service by mjmwired.net.