diff options
| -rw-r--r-- | v4l2-spec/Makefile | 71 | ||||
| -rw-r--r-- | v4l2-spec/compat.sgml | 3 | ||||
| -rw-r--r-- | v4l2-spec/controls.sgml | 100 |
3 files changed, 79 insertions, 95 deletions
diff --git a/v4l2-spec/Makefile b/v4l2-spec/Makefile index 7e81936a0..50de7cf44 100644 --- a/v4l2-spec/Makefile +++ b/v4l2-spec/Makefile @@ -213,10 +213,32 @@ ENUMS = \ v4l2_buf_type \ v4l2_colorspace \ v4l2_ctrl_type \ + v4l2_exposure_auto_type \ v4l2_field \ v4l2_frmivaltypes \ v4l2_frmsizetypes \ v4l2_memory \ + v4l2_mpeg_audio_ac3_bitrate \ + v4l2_mpeg_audio_crc \ + v4l2_mpeg_audio_emphasis \ + v4l2_mpeg_audio_encoding \ + v4l2_mpeg_audio_l1_bitrate \ + v4l2_mpeg_audio_l2_bitrate \ + v4l2_mpeg_audio_l3_bitrate \ + v4l2_mpeg_audio_mode \ + v4l2_mpeg_audio_mode_extension \ + v4l2_mpeg_audio_sampling_freq \ + v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type \ + v4l2_mpeg_cx2341x_video_luma_spatial_filter_type \ + v4l2_mpeg_cx2341x_video_median_filter_type \ + v4l2_mpeg_cx2341x_video_spatial_filter_mode \ + v4l2_mpeg_cx2341x_video_temporal_filter_mode \ + v4l2_mpeg_stream_type \ + v4l2_mpeg_stream_vbi_fmt \ + v4l2_mpeg_video_aspect \ + v4l2_mpeg_video_bitrate_mode \ + v4l2_mpeg_video_encoding \ + v4l2_power_line_frequency \ v4l2_priority \ v4l2_tuner_type \ @@ -293,61 +315,22 @@ ESCAPE = \ # Generate references to these structs in videodev2.h.sgml. DOCUMENTED = \ + -e "s/\(enum *\)v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1<link linkend=\"\2\">v4l2_mpeg_cx2341x_video_\2<\/link>/g" \ -e "s/\(\(enum\|struct\) *\)\(v4l2_[a-zA-Z0-9_]*\)/\1<link linkend=\"\3\">\3<\/link>/g" \ -e "s/\(V4L2_PIX_FMT_[A-Z0-9_]\+\) /<link linkend=\"\1\">\1<\/link> /g" \ -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" -# We don't generate references to these structs in videodev2.h.sgml -# because they are undocumented. -UNDOCUMENTED = \ - $(shell for i in \ - v4l2_bitrate \ - v4l2_bitrate_mode \ - v4l2_chip_ident_old \ - v4l2_exposure_auto_type \ - v4l2_mpeg_aspectratio \ - v4l2_mpeg_aspectratio \ - v4l2_mpeg_audio_crc \ - v4l2_mpeg_audio_emphasis \ - v4l2_mpeg_audio_encoding \ - v4l2_mpeg_audio_l1_bitrate \ - v4l2_mpeg_audio_l2_bitrate \ - v4l2_mpeg_audio_l3_bitrate \ - v4l2_mpeg_audio_ac3_bitrate \ - v4l2_mpeg_audio_mode \ - v4l2_mpeg_audio_mode_extension \ - v4l2_mpeg_audio_sampling_freq \ - v4l2_mpeg_audiotype \ - v4l2_mpeg_compression \ - v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type \ - v4l2_mpeg_cx2341x_video_luma_spatial_filter_type \ - v4l2_mpeg_cx2341x_video_median_filter_type \ - v4l2_mpeg_cx2341x_video_spatial_filter_mode \ - v4l2_mpeg_cx2341x_video_temporal_filter_mode \ - v4l2_mpeg_stream_type \ - v4l2_mpeg_stream_vbi_fmt \ - v4l2_mpeg_streamtype \ - v4l2_mpeg_streamtype \ - v4l2_mpeg_video_aspect \ - v4l2_mpeg_video_bitrate_mode \ - v4l2_mpeg_video_encoding \ - v4l2_mpeg_videotype \ - v4l2_mpeg_videotype \ - v4l2_power_line_frequency \ - v4l2_prio_state \ - ; do echo "-e \"s/ *$$i/\\\\ $$i/g\""; done) - capture.c.sgml: ../v4l2-apps/test/capture_example.c Makefile echo "<programlisting>" > $@ expand --tabs=8 < $< | \ - sed $(ESCAPE) $(UNDOCUMENTED) $(DOCUMENTED) | \ + sed $(ESCAPE) $(DOCUMENTED) | \ sed 's/i\.e\./&ie;/' >> $@ echo "</programlisting>" >> $@ videodev2.h.sgml: ../linux/include/linux/videodev2.h Makefile echo "<programlisting>" > $@ expand --tabs=8 < $< | \ - sed $(ESCAPE) $(UNDOCUMENTED) $(DOCUMENTED) | \ + sed $(ESCAPE) $(DOCUMENTED) | \ sed 's/i\.e\./&ie;/' >> $@ echo "</programlisting>" >> $@ @@ -400,7 +383,7 @@ entities.sgml: Makefile done echo -e "\n<!-- Enums -->" >>$@ for ident in $(ENUMS) ; do \ - entity=`echo $$ident | tr _ -` ; \ + entity=`echo $$ident | sed -e "s/v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1/" | tr _ -` ; \ echo "<!ENTITY $$entity \"enum <link" \ "linkend='$$entity'>$$ident</link>\">" >>$@ ; \ done @@ -443,7 +426,7 @@ indices.sgml: Makefile "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \ done for ident in $(ENUMS) ; do \ - id=`echo $$ident | tr _ -` ; \ + id=`echo $$ident | sed -e "s/v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1/" | tr _ -`; \ echo "<indexentry><primaryie>enum <link" \ "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \ done diff --git a/v4l2-spec/compat.sgml b/v4l2-spec/compat.sgml index 4f5bf1c8e..8c3177b22 100644 --- a/v4l2-spec/compat.sgml +++ b/v4l2-spec/compat.sgml @@ -2265,7 +2265,8 @@ video encoding.</para> <listitem> <para>The <constant>VIDIOC_G_CHIP_IDENT</constant> ioctl was renamed to <constant>VIDIOC_G_CHIP_IDENT_OLD</constant> and &VIDIOC-DBG-G-CHIP-IDENT; -was introduced in its place.</para> +was introduced in its place. The old struct <structname>v4l2_chip_ident</structname> +was renamed to <structname id=v4l2-chip-ident-old>v4l2_chip_ident_old</structname>.</para> </listitem> <listitem> <para>The pixel formats diff --git a/v4l2-spec/controls.sgml b/v4l2-spec/controls.sgml index 9a2982edb..0df57dcf7 100644 --- a/v4l2-spec/controls.sgml +++ b/v4l2-spec/controls.sgml @@ -222,11 +222,11 @@ control is deprecated. New drivers and applications should use the <constant>V4L2_CID_TILT_RELATIVE</constant> and <constant>V4L2_CID_TILT_RESET</constant> instead.</entry> </row> - <row> + <row id="v4l2-power-line-frequency"> <entry><constant>V4L2_CID_POWER_LINE_FREQUENCY</constant></entry> - <entry>integer</entry> + <entry>enum</entry> <entry>Enables a power line frequency filter to avoid -flicker. Possible values are: +flicker. Possible values for <constant>enum v4l2_power_line_frequency</constant> are: <constant>V4L2_CID_POWER_LINE_FREQUENCY_DISABLED</constant> (0), <constant>V4L2_CID_POWER_LINE_FREQUENCY_50HZ</constant> (1) and <constant>V4L2_CID_POWER_LINE_FREQUENCY_60HZ</constant> (2).</entry> @@ -615,9 +615,9 @@ description of this control class. This description can be used as the caption of a Tab page in a GUI, for example.</entry> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-stream-type"> <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_TYPE</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_stream_type</entry> </row><row><entry spanname="descr">The MPEG-1, -2 or -4 output stream type. One cannot assume anything here. Each hardware MPEG encoder tends to support different subsets of the available MPEG @@ -696,9 +696,9 @@ PES</entry> PES</entry> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-stream-vbi-fmt"> <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_VBI_FMT</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_stream_vbi_fmt</entry> </row><row><entry spanname="descr">Some cards can embed VBI data (⪚ Closed Caption, Teletext) into the MPEG stream. This control selects whether VBI data should be embedded, and if so, what @@ -722,9 +722,9 @@ in the kernel sources in the file <filename>Documentation/video4linux/cx2341x/RE </entrytbl> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-audio-sampling-freq"> <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_audio_sampling_freq</entry> </row><row><entry spanname="descr">MPEG Audio sampling frequency. Possible values are:</entry> </row> @@ -747,9 +747,9 @@ frequency. Possible values are:</entry> </entrytbl> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-audio-encoding"> <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_ENCODING</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_audio_encoding</entry> </row><row><entry spanname="descr">MPEG Audio encoding. Possible values are:</entry> </row> @@ -780,9 +780,9 @@ Possible values are:</entry> </entrytbl> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-audio-l1-bitrate"> <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L1_BITRATE</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_audio_l1_bitrate</entry> </row><row><entry spanname="descr">MPEG-1/2 Layer I bitrate. Possible values are:</entry> </row> @@ -848,9 +848,9 @@ Possible values are:</entry> </entrytbl> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-audio-l2-bitrate"> <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L2_BITRATE</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_audio_l2_bitrate</entry> </row><row><entry spanname="descr">MPEG-1/2 Layer II bitrate. Possible values are:</entry> </row> @@ -917,9 +917,9 @@ Possible values are:</entry> </entrytbl> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-audio-l3-bitrate"> <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L3_BITRATE</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_audio_l3_bitrate</entry> </row><row><entry spanname="descr">MPEG-1/2 Layer III bitrate. Possible values are:</entry> </row> @@ -992,9 +992,9 @@ Possible values are:</entry> </row><row><entry spanname="descr">AAC bitrate in bits per second.</entry> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-audio-ac3-bitrate"> <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_AC3_BITRATE</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_audio_ac3_bitrate</entry> </row><row><entry spanname="descr">AC-3 bitrate. Possible values are:</entry> </row> @@ -1081,9 +1081,9 @@ Possible values are:</entry> </entrytbl> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-audio-mode"> <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MODE</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_audio_mode</entry> </row><row><entry spanname="descr">MPEG Audio mode. Possible values are:</entry> </row> @@ -1110,9 +1110,9 @@ Possible values are:</entry> </entrytbl> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-audio-mode-extension"> <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MODE_EXTENSION</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_audio_mode_extension</entry> </row><row><entry spanname="descr">Joint Stereo audio mode extension. In Layer I and II they indicate which subbands are in intensity stereo. All other subbands are coded in stereo. Layer @@ -1142,9 +1142,9 @@ are:</entry> </entrytbl> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-audio-emphasis"> <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_EMPHASIS</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_audio_emphasis</entry> </row><row><entry spanname="descr">Audio Emphasis. Possible values are:</entry> </row> @@ -1167,9 +1167,9 @@ Possible values are:</entry> </entrytbl> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-audio-crc"> <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_CRC</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_audio_crc</entry> </row><row><entry spanname="descr">CRC method. Possible values are:</entry> </row> @@ -1190,16 +1190,16 @@ values are:</entry> <row><entry></entry></row> <row> <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MUTE</constant> </entry> - <entry>bool</entry> + <entry>boolean</entry> </row><row><entry spanname="descr">Mutes the audio when capturing. This is not done by muting audio hardware, which can still produce a slight hiss, but in the encoder itself, guaranteeing a fixed and reproducable audio bitstream. 0 = unmuted, 1 = muted.</entry> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-video-encoding"> <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_ENCODING</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_video_encoding</entry> </row><row><entry spanname="descr">MPEG Video encoding method. Possible values are:</entry> </row> @@ -1222,9 +1222,9 @@ method. Possible values are:</entry> </entrytbl> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-video-aspect"> <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_ASPECT</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_video_aspect</entry> </row><row><entry spanname="descr">Video aspect. Possible values are:</entry> </row> @@ -1263,21 +1263,21 @@ Possible values are:</entry> <row><entry></entry></row> <row> <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_GOP_CLOSURE</constant> </entry> - <entry>bool</entry> + <entry>boolean</entry> </row><row><entry spanname="descr">GOP closure (default 1)</entry> </row> <row><entry></entry></row> <row> <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_PULLDOWN</constant> </entry> - <entry>bool</entry> + <entry>boolean</entry> </row><row><entry spanname="descr">Enable 3:2 pulldown (default 0)</entry> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-video-bitrate-mode"> <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE_MODE</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_video_bitrate_mode</entry> </row><row><entry spanname="descr">Video bitrate mode. Possible values are:</entry> </row> @@ -1321,7 +1321,7 @@ frame, skip this many subsequent frames (default 0).</entry> <row><entry></entry></row> <row> <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MUTE</constant> </entry> - <entry>bool</entry> + <entry>boolean</entry> </row> <row><entry spanname="descr">"Mutes" the video to a fixed color when capturing. This is useful for testing, to produce a @@ -1387,9 +1387,9 @@ CX23416 MPEG encoding chips.</para> </thead> <tbody valign="top"> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-cx2341x-video-spatial-filter-mode"> <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_cx2341x_video_spatial_filter_mode</entry> </row><row><entry spanname="descr">Sets the Spatial Filter mode (default <constant>MANUAL</constant>). Possible values are:</entry> @@ -1416,9 +1416,9 @@ are:</entry> Spatial Filter. 0 = off, 15 = maximum. (Default is 0.)</entry> </row> <row><entry></entry></row> - <row> + <row id="luma-spatial-filter-type"> <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type</entry> </row><row><entry spanname="descr">Select the algorithm to use for the Luma Spatial Filter (default <constant>1D_HOR</constant>). Possible values:</entry> @@ -1451,9 +1451,9 @@ non-separable</entry> </entrytbl> </row> <row><entry></entry></row> - <row> + <row id="chroma-spatial-filter-type"> <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type</entry> </row><row><entry spanname="descr">Select the algorithm for the Chroma Spatial Filter (default <constant>1D_HOR</constant>). Possible values are:</entry> @@ -1473,9 +1473,9 @@ Possible values are:</entry> </entrytbl> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-cx2341x-video-temporal-filter-mode"> <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_cx2341x_video_temporal_filter_mode</entry> </row><row><entry spanname="descr">Sets the Temporal Filter mode (default <constant>MANUAL</constant>). Possible values are:</entry> @@ -1503,9 +1503,9 @@ Temporal Filter. 0 = off, 31 = maximum. (Default is 8 for full-scale capturing and 0 for scaled capturing.)</entry> </row> <row><entry></entry></row> - <row> + <row id="v4l2-mpeg-cx2341x-video-median-filter-type"> <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE</constant> </entry> - <entry>enum</entry> + <entry>enum v4l2_mpeg_cx2341x_video_median_filter_type</entry> </row><row><entry spanname="descr">Median Filter Type (default <constant>OFF</constant>). Possible values are:</entry> </row> @@ -1566,7 +1566,7 @@ the chroma median filter is enabled (default 255)</entry> <row><entry></entry></row> <row> <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS</constant> </entry> - <entry>bool</entry> + <entry>boolean</entry> </row> <row><entry spanname="descr">The CX2341X MPEG encoder can insert one empty MPEG-2 PES packet into the stream between every @@ -1615,9 +1615,9 @@ description of this control class.</entry> </row> <row><entry></entry></row> - <row> + <row id="v4l2-exposure-auto-type"> <entry spanname="id"><constant>V4L2_CID_EXPOSURE_AUTO</constant> </entry> - <entry>integer</entry> + <entry>enum v4l2_exposure_auto_type</entry> </row><row><entry spanname="descr">Enables automatic adjustments of the exposure time and/or iris aperture. The effect of manual changes of the exposure time or iris aperture while these |