diff options
author | Arun Kumar K <arun.kk@samsung.com> | 2013-07-09 00:24:41 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <m.chehab@samsung.com> | 2013-08-18 06:13:36 -0400 |
commit | bc9028e1d38419f9249cb0d1285e290be7e67223 (patch) | |
tree | 4ecf9541eefea087369060b678a3f56fdd8b6c41 /Documentation/DocBook | |
parent | d1e9b7c12b745af715101578a677e4a6b16c09e4 (diff) |
[media] V4L: Add VP8 encoder controls
This patch adds new V4L controls for VP8 encoding.
Signed-off-by: Kiran AVND <avnd.kiran@samsung.com>
Signed-off-by: Arun Kumar K <arun.kk@samsung.com>
Acked-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Kamil Debski <k.debski@samsung.com>
Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r-- | Documentation/DocBook/media/v4l/controls.xml | 168 |
1 files changed, 163 insertions, 5 deletions
diff --git a/Documentation/DocBook/media/v4l/controls.xml b/Documentation/DocBook/media/v4l/controls.xml index c2fc9ec1417e..7a3b49b3cc3b 100644 --- a/Documentation/DocBook/media/v4l/controls.xml +++ b/Documentation/DocBook/media/v4l/controls.xml | |||
@@ -722,17 +722,22 @@ for more details.</para> | |||
722 | </section> | 722 | </section> |
723 | 723 | ||
724 | <section id="mpeg-controls"> | 724 | <section id="mpeg-controls"> |
725 | <title>MPEG Control Reference</title> | 725 | <title>Codec Control Reference</title> |
726 | 726 | ||
727 | <para>Below all controls within the MPEG control class are | 727 | <para>Below all controls within the Codec control class are |
728 | described. First the generic controls, then controls specific for | 728 | described. First the generic controls, then controls specific for |
729 | certain hardware.</para> | 729 | certain hardware.</para> |
730 | 730 | ||
731 | <para>Note: These controls are applicable to all codecs and | ||
732 | not just MPEG. The defines are prefixed with V4L2_CID_MPEG/V4L2_MPEG | ||
733 | as the controls were originally made for MPEG codecs and later | ||
734 | extended to cover all encoding formats.</para> | ||
735 | |||
731 | <section> | 736 | <section> |
732 | <title>Generic MPEG Controls</title> | 737 | <title>Generic Codec Controls</title> |
733 | 738 | ||
734 | <table pgwide="1" frame="none" id="mpeg-control-id"> | 739 | <table pgwide="1" frame="none" id="mpeg-control-id"> |
735 | <title>MPEG Control IDs</title> | 740 | <title>Codec Control IDs</title> |
736 | <tgroup cols="4"> | 741 | <tgroup cols="4"> |
737 | <colspec colname="c1" colwidth="1*" /> | 742 | <colspec colname="c1" colwidth="1*" /> |
738 | <colspec colname="c2" colwidth="6*" /> | 743 | <colspec colname="c2" colwidth="6*" /> |
@@ -752,7 +757,7 @@ certain hardware.</para> | |||
752 | <row> | 757 | <row> |
753 | <entry spanname="id"><constant>V4L2_CID_MPEG_CLASS</constant> </entry> | 758 | <entry spanname="id"><constant>V4L2_CID_MPEG_CLASS</constant> </entry> |
754 | <entry>class</entry> | 759 | <entry>class</entry> |
755 | </row><row><entry spanname="descr">The MPEG class | 760 | </row><row><entry spanname="descr">The Codec class |
756 | descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a | 761 | descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a |
757 | description of this control class. This description can be used as the | 762 | description of this control class. This description can be used as the |
758 | caption of a Tab page in a GUI, for example.</entry> | 763 | caption of a Tab page in a GUI, for example.</entry> |
@@ -3009,6 +3014,159 @@ in by the application. 0 = do not insert, 1 = insert packets.</entry> | |||
3009 | </tgroup> | 3014 | </tgroup> |
3010 | </table> | 3015 | </table> |
3011 | </section> | 3016 | </section> |
3017 | |||
3018 | <section> | ||
3019 | <title>VPX Control Reference</title> | ||
3020 | |||
3021 | <para>The VPX controls include controls for encoding parameters | ||
3022 | of VPx video codec.</para> | ||
3023 | |||
3024 | <table pgwide="1" frame="none" id="vpx-control-id"> | ||
3025 | <title>VPX Control IDs</title> | ||
3026 | |||
3027 | <tgroup cols="4"> | ||
3028 | <colspec colname="c1" colwidth="1*" /> | ||
3029 | <colspec colname="c2" colwidth="6*" /> | ||
3030 | <colspec colname="c3" colwidth="2*" /> | ||
3031 | <colspec colname="c4" colwidth="6*" /> | ||
3032 | <spanspec namest="c1" nameend="c2" spanname="id" /> | ||
3033 | <spanspec namest="c2" nameend="c4" spanname="descr" /> | ||
3034 | <thead> | ||
3035 | <row> | ||
3036 | <entry spanname="id" align="left">ID</entry> | ||
3037 | <entry align="left">Type</entry> | ||
3038 | </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry> | ||
3039 | </row> | ||
3040 | </thead> | ||
3041 | <tbody valign="top"> | ||
3042 | <row><entry></entry></row> | ||
3043 | |||
3044 | <row><entry></entry></row> | ||
3045 | <row id="v4l2-vpx-num-partitions"> | ||
3046 | <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS</constant></entry> | ||
3047 | <entry>enum v4l2_vp8_num_partitions</entry> | ||
3048 | </row> | ||
3049 | <row><entry spanname="descr">The number of token partitions to use in VP8 encoder. | ||
3050 | Possible values are:</entry> | ||
3051 | </row> | ||
3052 | <row> | ||
3053 | <entrytbl spanname="descr" cols="2"> | ||
3054 | <tbody valign="top"> | ||
3055 | <row> | ||
3056 | <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_1_PARTITION</constant></entry> | ||
3057 | <entry>1 coefficient partition</entry> | ||
3058 | </row> | ||
3059 | <row> | ||
3060 | <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_2_PARTITIONS</constant></entry> | ||
3061 | <entry>2 coefficient partitions</entry> | ||
3062 | </row> | ||
3063 | <row> | ||
3064 | <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_4_PARTITIONS</constant></entry> | ||
3065 | <entry>4 coefficient partitions</entry> | ||
3066 | </row> | ||
3067 | <row> | ||
3068 | <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_8_PARTITIONS</constant></entry> | ||
3069 | <entry>8 coefficient partitions</entry> | ||
3070 | </row> | ||
3071 | </tbody> | ||
3072 | </entrytbl> | ||
3073 | </row> | ||
3074 | |||
3075 | <row><entry></entry></row> | ||
3076 | <row> | ||
3077 | <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_IMD_DISABLE_4X4</constant></entry> | ||
3078 | <entry>boolean</entry> | ||
3079 | </row> | ||
3080 | <row><entry spanname="descr">Setting this prevents intra 4x4 mode in the intra mode decision.</entry> | ||
3081 | </row> | ||
3082 | |||
3083 | <row><entry></entry></row> | ||
3084 | <row id="v4l2-vpx-num-ref-frames"> | ||
3085 | <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES</constant></entry> | ||
3086 | <entry>enum v4l2_vp8_num_ref_frames</entry> | ||
3087 | </row> | ||
3088 | <row><entry spanname="descr">The number of reference pictures for encoding P frames. | ||
3089 | Possible values are:</entry> | ||
3090 | </row> | ||
3091 | <row> | ||
3092 | <entrytbl spanname="descr" cols="2"> | ||
3093 | <tbody valign="top"> | ||
3094 | <row> | ||
3095 | <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_1_REF_FRAME</constant></entry> | ||
3096 | <entry>Last encoded frame will be searched</entry> | ||
3097 | </row> | ||
3098 | <row> | ||
3099 | <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_2_REF_FRAME</constant></entry> | ||
3100 | <entry>Two frames will be searched among the last encoded frame, the golden frame | ||
3101 | and the alternate reference (altref) frame. The encoder implementation will decide which two are chosen.</entry> | ||
3102 | </row> | ||
3103 | <row> | ||
3104 | <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_3_REF_FRAME</constant></entry> | ||
3105 | <entry>The last encoded frame, the golden frame and the altref frame will be searched.</entry> | ||
3106 | </row> | ||
3107 | </tbody> | ||
3108 | </entrytbl> | ||
3109 | </row> | ||
3110 | |||
3111 | <row><entry></entry></row> | ||
3112 | <row> | ||
3113 | <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_FILTER_LEVEL</constant></entry> | ||
3114 | <entry>integer</entry> | ||
3115 | </row> | ||
3116 | <row><entry spanname="descr">Indicates the loop filter level. The adjustment of the loop | ||
3117 | filter level is done via a delta value against a baseline loop filter value.</entry> | ||
3118 | </row> | ||
3119 | |||
3120 | <row><entry></entry></row> | ||
3121 | <row> | ||
3122 | <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_FILTER_SHARPNESS</constant></entry> | ||
3123 | <entry>integer</entry> | ||
3124 | </row> | ||
3125 | <row><entry spanname="descr">This parameter affects the loop filter. Anything above | ||
3126 | zero weakens the deblocking effect on the loop filter.</entry> | ||
3127 | </row> | ||
3128 | |||
3129 | <row><entry></entry></row> | ||
3130 | <row> | ||
3131 | <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD</constant></entry> | ||
3132 | <entry>integer</entry> | ||
3133 | </row> | ||
3134 | <row><entry spanname="descr">Sets the refresh period for the golden frame. The period is defined | ||
3135 | in number of frames. For a value of 'n', every nth frame starting from the first key frame will be taken as a golden frame. | ||
3136 | For eg. for encoding sequence of 0, 1, 2, 3, 4, 5, 6, 7 where the golden frame refresh period is set as 4, the frames | ||
3137 | 0, 4, 8 etc will be taken as the golden frames as frame 0 is always a key frame.</entry> | ||
3138 | </row> | ||
3139 | |||
3140 | <row><entry></entry></row> | ||
3141 | <row id="v4l2-vpx-golden-frame-sel"> | ||
3142 | <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL</constant></entry> | ||
3143 | <entry>enum v4l2_vp8_golden_frame_sel</entry> | ||
3144 | </row> | ||
3145 | <row><entry spanname="descr">Selects the golden frame for encoding. | ||
3146 | Possible values are:</entry> | ||
3147 | </row> | ||
3148 | <row> | ||
3149 | <entrytbl spanname="descr" cols="2"> | ||
3150 | <tbody valign="top"> | ||
3151 | <row> | ||
3152 | <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_PREV</constant></entry> | ||
3153 | <entry>Use the (n-2)th frame as a golden frame, current frame index being 'n'.</entry> | ||
3154 | </row> | ||
3155 | <row> | ||
3156 | <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_REF_PERIOD</constant></entry> | ||
3157 | <entry>Use the previous specific frame indicated by | ||
3158 | V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD as a golden frame.</entry> | ||
3159 | </row> | ||
3160 | </tbody> | ||
3161 | </entrytbl> | ||
3162 | </row> | ||
3163 | |||
3164 | <row><entry></entry></row> | ||
3165 | </tbody> | ||
3166 | </tgroup> | ||
3167 | </table> | ||
3168 | |||
3169 | </section> | ||
3012 | </section> | 3170 | </section> |
3013 | 3171 | ||
3014 | <section id="camera-controls"> | 3172 | <section id="camera-controls"> |