diff options
Diffstat (limited to 'Documentation/DocBook/media/v4l/controls.xml')
-rw-r--r-- | Documentation/DocBook/media/v4l/controls.xml | 714 |
1 files changed, 692 insertions, 22 deletions
diff --git a/Documentation/DocBook/media/v4l/controls.xml b/Documentation/DocBook/media/v4l/controls.xml index b84f25e9cc8..676bc46f9c5 100644 --- a/Documentation/DocBook/media/v4l/controls.xml +++ b/Documentation/DocBook/media/v4l/controls.xml | |||
@@ -285,18 +285,92 @@ minimum value disables backlight compensation.</entry> | |||
285 | <row id="v4l2-colorfx"> | 285 | <row id="v4l2-colorfx"> |
286 | <entry><constant>V4L2_CID_COLORFX</constant></entry> | 286 | <entry><constant>V4L2_CID_COLORFX</constant></entry> |
287 | <entry>enum</entry> | 287 | <entry>enum</entry> |
288 | <entry>Selects a color effect. Possible values for | 288 | <entry>Selects a color effect. The following values are defined: |
289 | <constant>enum v4l2_colorfx</constant> are: | 289 | </entry> |
290 | <constant>V4L2_COLORFX_NONE</constant> (0), | 290 | </row><row> |
291 | <constant>V4L2_COLORFX_BW</constant> (1), | 291 | <entry></entry> |
292 | <constant>V4L2_COLORFX_SEPIA</constant> (2), | 292 | <entry></entry> |
293 | <constant>V4L2_COLORFX_NEGATIVE</constant> (3), | 293 | <entrytbl spanname="descr" cols="2"> |
294 | <constant>V4L2_COLORFX_EMBOSS</constant> (4), | 294 | <tbody valign="top"> |
295 | <constant>V4L2_COLORFX_SKETCH</constant> (5), | 295 | <row> |
296 | <constant>V4L2_COLORFX_SKY_BLUE</constant> (6), | 296 | <entry><constant>V4L2_COLORFX_NONE</constant> </entry> |
297 | <constant>V4L2_COLORFX_GRASS_GREEN</constant> (7), | 297 | <entry>Color effect is disabled.</entry> |
298 | <constant>V4L2_COLORFX_SKIN_WHITEN</constant> (8) and | 298 | </row> |
299 | <constant>V4L2_COLORFX_VIVID</constant> (9).</entry> | 299 | <row> |
300 | <entry><constant>V4L2_COLORFX_ANTIQUE</constant> </entry> | ||
301 | <entry>An aging (old photo) effect.</entry> | ||
302 | </row> | ||
303 | <row> | ||
304 | <entry><constant>V4L2_COLORFX_ART_FREEZE</constant> </entry> | ||
305 | <entry>Frost color effect.</entry> | ||
306 | </row> | ||
307 | <row> | ||
308 | <entry><constant>V4L2_COLORFX_AQUA</constant> </entry> | ||
309 | <entry>Water color, cool tone.</entry> | ||
310 | </row> | ||
311 | <row> | ||
312 | <entry><constant>V4L2_COLORFX_BW</constant> </entry> | ||
313 | <entry>Black and white.</entry> | ||
314 | </row> | ||
315 | <row> | ||
316 | <entry><constant>V4L2_COLORFX_EMBOSS</constant> </entry> | ||
317 | <entry>Emboss, the highlights and shadows replace light/dark boundaries | ||
318 | and low contrast areas are set to a gray background.</entry> | ||
319 | </row> | ||
320 | <row> | ||
321 | <entry><constant>V4L2_COLORFX_GRASS_GREEN</constant> </entry> | ||
322 | <entry>Grass green.</entry> | ||
323 | </row> | ||
324 | <row> | ||
325 | <entry><constant>V4L2_COLORFX_NEGATIVE</constant> </entry> | ||
326 | <entry>Negative.</entry> | ||
327 | </row> | ||
328 | <row> | ||
329 | <entry><constant>V4L2_COLORFX_SEPIA</constant> </entry> | ||
330 | <entry>Sepia tone.</entry> | ||
331 | </row> | ||
332 | <row> | ||
333 | <entry><constant>V4L2_COLORFX_SKETCH</constant> </entry> | ||
334 | <entry>Sketch.</entry> | ||
335 | </row> | ||
336 | <row> | ||
337 | <entry><constant>V4L2_COLORFX_SKIN_WHITEN</constant> </entry> | ||
338 | <entry>Skin whiten.</entry> | ||
339 | </row> | ||
340 | <row> | ||
341 | <entry><constant>V4L2_COLORFX_SKY_BLUE</constant> </entry> | ||
342 | <entry>Sky blue.</entry> | ||
343 | </row> | ||
344 | <row> | ||
345 | <entry><constant>V4L2_COLORFX_SOLARIZATION</constant> </entry> | ||
346 | <entry>Solarization, the image is partially reversed in tone, | ||
347 | only color values above or below a certain threshold are inverted. | ||
348 | </entry> | ||
349 | </row> | ||
350 | <row> | ||
351 | <entry><constant>V4L2_COLORFX_SILHOUETTE</constant> </entry> | ||
352 | <entry>Silhouette (outline).</entry> | ||
353 | </row> | ||
354 | <row> | ||
355 | <entry><constant>V4L2_COLORFX_VIVID</constant> </entry> | ||
356 | <entry>Vivid colors.</entry> | ||
357 | </row> | ||
358 | <row> | ||
359 | <entry><constant>V4L2_COLORFX_SET_CBCR</constant> </entry> | ||
360 | <entry>The Cb and Cr chroma components are replaced by fixed | ||
361 | coefficients determined by <constant>V4L2_CID_COLORFX_CBCR</constant> | ||
362 | control.</entry> | ||
363 | </row> | ||
364 | </tbody> | ||
365 | </entrytbl> | ||
366 | </row> | ||
367 | <row> | ||
368 | <entry><constant>V4L2_CID_COLORFX_CBCR</constant></entry> | ||
369 | <entry>integer</entry> | ||
370 | <entry>Determines the Cb and Cr coefficients for <constant>V4L2_COLORFX_SET_CBCR</constant> | ||
371 | color effect. Bits [7:0] of the supplied 32 bit value are interpreted as | ||
372 | Cr component, bits [15:8] as Cb component and bits [31:16] must be zero. | ||
373 | </entry> | ||
300 | </row> | 374 | </row> |
301 | <row> | 375 | <row> |
302 | <entry><constant>V4L2_CID_ROTATE</constant></entry> | 376 | <entry><constant>V4L2_CID_ROTATE</constant></entry> |
@@ -2023,7 +2097,7 @@ Possible values are:</entry> | |||
2023 | <entry>integer</entry> | 2097 | <entry>integer</entry> |
2024 | </row> | 2098 | </row> |
2025 | <row><entry spanname="descr">Cyclic intra macroblock refresh. This is the number of continuous macroblocks | 2099 | <row><entry spanname="descr">Cyclic intra macroblock refresh. This is the number of continuous macroblocks |
2026 | refreshed every frame. Each frame a succesive set of macroblocks is refreshed until the cycle completes and starts from the | 2100 | refreshed every frame. Each frame a successive set of macroblocks is refreshed until the cycle completes and starts from the |
2027 | top of the frame. Applicable to H264, H263 and MPEG4 encoder.</entry> | 2101 | top of the frame. Applicable to H264, H263 and MPEG4 encoder.</entry> |
2028 | </row> | 2102 | </row> |
2029 | 2103 | ||
@@ -2183,7 +2257,7 @@ Applicable to the MPEG4 and H264 encoders.</entry> | |||
2183 | <entry>integer</entry> | 2257 | <entry>integer</entry> |
2184 | </row> | 2258 | </row> |
2185 | <row><entry spanname="descr">The Video Buffer Verifier size in kilobytes, it is used as a limitation of frame skip. | 2259 | <row><entry spanname="descr">The Video Buffer Verifier size in kilobytes, it is used as a limitation of frame skip. |
2186 | The VBV is defined in the standard as a mean to verify that the produced stream will be succesfully decoded. | 2260 | The VBV is defined in the standard as a mean to verify that the produced stream will be successfully decoded. |
2187 | The standard describes it as "Part of a hypothetical decoder that is conceptually connected to the | 2261 | The standard describes it as "Part of a hypothetical decoder that is conceptually connected to the |
2188 | output of the encoder. Its purpose is to provide a constraint on the variability of the data rate that an | 2262 | output of the encoder. Its purpose is to provide a constraint on the variability of the data rate that an |
2189 | encoder or editing process may produce.". | 2263 | encoder or editing process may produce.". |
@@ -2196,7 +2270,7 @@ Applicable to the MPEG1, MPEG2, MPEG4 encoders.</entry> | |||
2196 | <entry>integer</entry> | 2270 | <entry>integer</entry> |
2197 | </row> | 2271 | </row> |
2198 | <row><entry spanname="descr">The Coded Picture Buffer size in kilobytes, it is used as a limitation of frame skip. | 2272 | <row><entry spanname="descr">The Coded Picture Buffer size in kilobytes, it is used as a limitation of frame skip. |
2199 | The CPB is defined in the H264 standard as a mean to verify that the produced stream will be succesfully decoded. | 2273 | The CPB is defined in the H264 standard as a mean to verify that the produced stream will be successfully decoded. |
2200 | Applicable to the H264 encoder.</entry> | 2274 | Applicable to the H264 encoder.</entry> |
2201 | </row> | 2275 | </row> |
2202 | 2276 | ||
@@ -2775,6 +2849,51 @@ remain constant.</entry> | |||
2775 | <row><entry></entry></row> | 2849 | <row><entry></entry></row> |
2776 | 2850 | ||
2777 | <row> | 2851 | <row> |
2852 | <entry spanname="id"><constant>V4L2_CID_EXPOSURE_BIAS</constant> </entry> | ||
2853 | <entry>integer menu</entry> | ||
2854 | </row><row><entry spanname="descr"> Determines the automatic | ||
2855 | exposure compensation, it is effective only when <constant>V4L2_CID_EXPOSURE_AUTO</constant> | ||
2856 | control is set to <constant>AUTO</constant>, <constant>SHUTTER_PRIORITY </constant> | ||
2857 | or <constant>APERTURE_PRIORITY</constant>. | ||
2858 | It is expressed in terms of EV, drivers should interpret the values as 0.001 EV | ||
2859 | units, where the value 1000 stands for +1 EV. | ||
2860 | <para>Increasing the exposure compensation value is equivalent to decreasing | ||
2861 | the exposure value (EV) and will increase the amount of light at the image | ||
2862 | sensor. The camera performs the exposure compensation by adjusting absolute | ||
2863 | exposure time and/or aperture.</para></entry> | ||
2864 | </row> | ||
2865 | <row><entry></entry></row> | ||
2866 | |||
2867 | <row id="v4l2-exposure-metering"> | ||
2868 | <entry spanname="id"><constant>V4L2_CID_EXPOSURE_METERING</constant> </entry> | ||
2869 | <entry>enum v4l2_exposure_metering</entry> | ||
2870 | </row><row><entry spanname="descr">Determines how the camera measures | ||
2871 | the amount of light available for the frame exposure. Possible values are:</entry> | ||
2872 | </row> | ||
2873 | <row> | ||
2874 | <entrytbl spanname="descr" cols="2"> | ||
2875 | <tbody valign="top"> | ||
2876 | <row> | ||
2877 | <entry><constant>V4L2_EXPOSURE_METERING_AVERAGE</constant> </entry> | ||
2878 | <entry>Use the light information coming from the entire frame | ||
2879 | and average giving no weighting to any particular portion of the metered area. | ||
2880 | </entry> | ||
2881 | </row> | ||
2882 | <row> | ||
2883 | <entry><constant>V4L2_EXPOSURE_METERING_CENTER_WEIGHTED</constant> </entry> | ||
2884 | <entry>Average the light information coming from the entire frame | ||
2885 | giving priority to the center of the metered area.</entry> | ||
2886 | </row> | ||
2887 | <row> | ||
2888 | <entry><constant>V4L2_EXPOSURE_METERING_SPOT</constant> </entry> | ||
2889 | <entry>Measure only very small area at the center of the frame.</entry> | ||
2890 | </row> | ||
2891 | </tbody> | ||
2892 | </entrytbl> | ||
2893 | </row> | ||
2894 | <row><entry></entry></row> | ||
2895 | |||
2896 | <row> | ||
2778 | <entry spanname="id"><constant>V4L2_CID_PAN_RELATIVE</constant> </entry> | 2897 | <entry spanname="id"><constant>V4L2_CID_PAN_RELATIVE</constant> </entry> |
2779 | <entry>integer</entry> | 2898 | <entry>integer</entry> |
2780 | </row><row><entry spanname="descr">This control turns the | 2899 | </row><row><entry spanname="descr">This control turns the |
@@ -2857,13 +2976,107 @@ negative values towards infinity. This is a write-only control.</entry> | |||
2857 | <row> | 2976 | <row> |
2858 | <entry spanname="id"><constant>V4L2_CID_FOCUS_AUTO</constant> </entry> | 2977 | <entry spanname="id"><constant>V4L2_CID_FOCUS_AUTO</constant> </entry> |
2859 | <entry>boolean</entry> | 2978 | <entry>boolean</entry> |
2860 | </row><row><entry spanname="descr">Enables automatic focus | 2979 | </row><row><entry spanname="descr">Enables continuous automatic |
2861 | adjustments. The effect of manual focus adjustments while this feature | 2980 | focus adjustments. The effect of manual focus adjustments while this feature |
2862 | is enabled is undefined, drivers should ignore such requests.</entry> | 2981 | is enabled is undefined, drivers should ignore such requests.</entry> |
2863 | </row> | 2982 | </row> |
2864 | <row><entry></entry></row> | 2983 | <row><entry></entry></row> |
2865 | 2984 | ||
2866 | <row> | 2985 | <row> |
2986 | <entry spanname="id"><constant>V4L2_CID_AUTO_FOCUS_START</constant> </entry> | ||
2987 | <entry>button</entry> | ||
2988 | </row><row><entry spanname="descr">Starts single auto focus process. | ||
2989 | The effect of setting this control when <constant>V4L2_CID_FOCUS_AUTO</constant> | ||
2990 | is set to <constant>TRUE</constant> (1) is undefined, drivers should ignore | ||
2991 | such requests.</entry> | ||
2992 | </row> | ||
2993 | <row><entry></entry></row> | ||
2994 | |||
2995 | <row> | ||
2996 | <entry spanname="id"><constant>V4L2_CID_AUTO_FOCUS_STOP</constant> </entry> | ||
2997 | <entry>button</entry> | ||
2998 | </row><row><entry spanname="descr">Aborts automatic focusing | ||
2999 | started with <constant>V4L2_CID_AUTO_FOCUS_START</constant> control. It is | ||
3000 | effective only when the continuous autofocus is disabled, that is when | ||
3001 | <constant>V4L2_CID_FOCUS_AUTO</constant> control is set to <constant>FALSE | ||
3002 | </constant> (0).</entry> | ||
3003 | </row> | ||
3004 | <row><entry></entry></row> | ||
3005 | |||
3006 | <row id="v4l2-auto-focus-status"> | ||
3007 | <entry spanname="id"> | ||
3008 | <constant>V4L2_CID_AUTO_FOCUS_STATUS</constant> </entry> | ||
3009 | <entry>bitmask</entry> | ||
3010 | </row> | ||
3011 | <row><entry spanname="descr">The automatic focus status. This is a read-only | ||
3012 | control.</entry> | ||
3013 | </row> | ||
3014 | <row> | ||
3015 | <entrytbl spanname="descr" cols="2"> | ||
3016 | <tbody valign="top"> | ||
3017 | <row> | ||
3018 | <entry><constant>V4L2_AUTO_FOCUS_STATUS_IDLE</constant> </entry> | ||
3019 | <entry>Automatic focus is not active.</entry> | ||
3020 | </row> | ||
3021 | <row> | ||
3022 | <entry><constant>V4L2_AUTO_FOCUS_STATUS_BUSY</constant> </entry> | ||
3023 | <entry>Automatic focusing is in progress.</entry> | ||
3024 | </row> | ||
3025 | <row> | ||
3026 | <entry><constant>V4L2_AUTO_FOCUS_STATUS_REACHED</constant> </entry> | ||
3027 | <entry>Focus has been reached.</entry> | ||
3028 | </row> | ||
3029 | <row> | ||
3030 | <entry><constant>V4L2_AUTO_FOCUS_STATUS_FAILED</constant> </entry> | ||
3031 | <entry>Automatic focus has failed, the driver will not | ||
3032 | transition from this state until another action is | ||
3033 | performed by an application.</entry> | ||
3034 | </row> | ||
3035 | </tbody> | ||
3036 | </entrytbl> | ||
3037 | </row> | ||
3038 | <row><entry spanname="descr"> | ||
3039 | Setting <constant>V4L2_LOCK_FOCUS</constant> lock bit of the <constant>V4L2_CID_3A_LOCK | ||
3040 | </constant> control may stop updates of the <constant>V4L2_CID_AUTO_FOCUS_STATUS</constant> | ||
3041 | control value.</entry> | ||
3042 | </row> | ||
3043 | <row><entry></entry></row> | ||
3044 | |||
3045 | <row id="v4l2-auto-focus-range"> | ||
3046 | <entry spanname="id"> | ||
3047 | <constant>V4L2_CID_AUTO_FOCUS_RANGE</constant> </entry> | ||
3048 | <entry>enum v4l2_auto_focus_range</entry> | ||
3049 | </row> | ||
3050 | <row><entry spanname="descr">Determines auto focus distance range | ||
3051 | for which lens may be adjusted. </entry> | ||
3052 | </row> | ||
3053 | <row> | ||
3054 | <entrytbl spanname="descr" cols="2"> | ||
3055 | <tbody valign="top"> | ||
3056 | <row> | ||
3057 | <entry><constant>V4L2_AUTO_FOCUS_RANGE_AUTO</constant> </entry> | ||
3058 | <entry>The camera automatically selects the focus range.</entry> | ||
3059 | </row> | ||
3060 | <row> | ||
3061 | <entry><constant>V4L2_AUTO_FOCUS_RANGE_NORMAL</constant> </entry> | ||
3062 | <entry>Normal distance range, limited for best automatic focus | ||
3063 | performance.</entry> | ||
3064 | </row> | ||
3065 | <row> | ||
3066 | <entry><constant>V4L2_AUTO_FOCUS_RANGE_MACRO</constant> </entry> | ||
3067 | <entry>Macro (close-up) auto focus. The camera will | ||
3068 | use its minimum possible distance for auto focus.</entry> | ||
3069 | </row> | ||
3070 | <row> | ||
3071 | <entry><constant>V4L2_AUTO_FOCUS_RANGE_INFINITY</constant> </entry> | ||
3072 | <entry>The lens is set to focus on an object at infinite distance.</entry> | ||
3073 | </row> | ||
3074 | </tbody> | ||
3075 | </entrytbl> | ||
3076 | </row> | ||
3077 | <row><entry></entry></row> | ||
3078 | |||
3079 | <row> | ||
2867 | <entry spanname="id"><constant>V4L2_CID_ZOOM_ABSOLUTE</constant> </entry> | 3080 | <entry spanname="id"><constant>V4L2_CID_ZOOM_ABSOLUTE</constant> </entry> |
2868 | <entry>integer</entry> | 3081 | <entry>integer</entry> |
2869 | </row><row><entry spanname="descr">Specify the objective lens | 3082 | </row><row><entry spanname="descr">Specify the objective lens |
@@ -2932,6 +3145,295 @@ camera sensor on or off, or specify its strength. Such band-stop filters can | |||
2932 | be used, for example, to filter out the fluorescent light component.</entry> | 3145 | be used, for example, to filter out the fluorescent light component.</entry> |
2933 | </row> | 3146 | </row> |
2934 | <row><entry></entry></row> | 3147 | <row><entry></entry></row> |
3148 | |||
3149 | <row id="v4l2-auto-n-preset-white-balance"> | ||
3150 | <entry spanname="id"><constant>V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE</constant> </entry> | ||
3151 | <entry>enum v4l2_auto_n_preset_white_balance</entry> | ||
3152 | </row><row><entry spanname="descr">Sets white balance to automatic, | ||
3153 | manual or a preset. The presets determine color temperature of the light as | ||
3154 | a hint to the camera for white balance adjustments resulting in most accurate | ||
3155 | color representation. The following white balance presets are listed in order | ||
3156 | of increasing color temperature.</entry> | ||
3157 | </row> | ||
3158 | <row> | ||
3159 | <entrytbl spanname="descr" cols="2"> | ||
3160 | <tbody valign="top"> | ||
3161 | <row> | ||
3162 | <entry><constant>V4L2_WHITE_BALANCE_MANUAL</constant> </entry> | ||
3163 | <entry>Manual white balance.</entry> | ||
3164 | </row> | ||
3165 | <row> | ||
3166 | <entry><constant>V4L2_WHITE_BALANCE_AUTO</constant> </entry> | ||
3167 | <entry>Automatic white balance adjustments.</entry> | ||
3168 | </row> | ||
3169 | <row> | ||
3170 | <entry><constant>V4L2_WHITE_BALANCE_INCANDESCENT</constant> </entry> | ||
3171 | <entry>White balance setting for incandescent (tungsten) lighting. | ||
3172 | It generally cools down the colors and corresponds approximately to 2500...3500 K | ||
3173 | color temperature range.</entry> | ||
3174 | </row> | ||
3175 | <row> | ||
3176 | <entry><constant>V4L2_WHITE_BALANCE_FLUORESCENT</constant> </entry> | ||
3177 | <entry>White balance preset for fluorescent lighting. | ||
3178 | It corresponds approximately to 4000...5000 K color temperature.</entry> | ||
3179 | </row> | ||
3180 | <row> | ||
3181 | <entry><constant>V4L2_WHITE_BALANCE_FLUORESCENT_H</constant> </entry> | ||
3182 | <entry>With this setting the camera will compensate for | ||
3183 | fluorescent H lighting.</entry> | ||
3184 | </row> | ||
3185 | <row> | ||
3186 | <entry><constant>V4L2_WHITE_BALANCE_HORIZON</constant> </entry> | ||
3187 | <entry>White balance setting for horizon daylight. | ||
3188 | It corresponds approximately to 5000 K color temperature.</entry> | ||
3189 | </row> | ||
3190 | <row> | ||
3191 | <entry><constant>V4L2_WHITE_BALANCE_DAYLIGHT</constant> </entry> | ||
3192 | <entry>White balance preset for daylight (with clear sky). | ||
3193 | It corresponds approximately to 5000...6500 K color temperature.</entry> | ||
3194 | </row> | ||
3195 | <row> | ||
3196 | <entry><constant>V4L2_WHITE_BALANCE_FLASH</constant> </entry> | ||
3197 | <entry>With this setting the camera will compensate for the flash | ||
3198 | light. It slightly warms up the colors and corresponds roughly to 5000...5500 K | ||
3199 | color temperature.</entry> | ||
3200 | </row> | ||
3201 | <row> | ||
3202 | <entry><constant>V4L2_WHITE_BALANCE_CLOUDY</constant> </entry> | ||
3203 | <entry>White balance preset for moderately overcast sky. | ||
3204 | This option corresponds approximately to 6500...8000 K color temperature | ||
3205 | range.</entry> | ||
3206 | </row> | ||
3207 | <row> | ||
3208 | <entry><constant>V4L2_WHITE_BALANCE_SHADE</constant> </entry> | ||
3209 | <entry>White balance preset for shade or heavily overcast | ||
3210 | sky. It corresponds approximately to 9000...10000 K color temperature. | ||
3211 | </entry> | ||
3212 | </row> | ||
3213 | </tbody> | ||
3214 | </entrytbl> | ||
3215 | </row> | ||
3216 | <row><entry></entry></row> | ||
3217 | |||
3218 | <row id="v4l2-wide-dynamic-range"> | ||
3219 | <entry spanname="id"><constant>V4L2_CID_WIDE_DYNAMIC_RANGE</constant></entry> | ||
3220 | <entry>boolean</entry> | ||
3221 | </row> | ||
3222 | <row> | ||
3223 | <entry spanname="descr">Enables or disables the camera's wide dynamic | ||
3224 | range feature. This feature allows to obtain clear images in situations where | ||
3225 | intensity of the illumination varies significantly throughout the scene, i.e. | ||
3226 | there are simultaneously very dark and very bright areas. It is most commonly | ||
3227 | realized in cameras by combining two subsequent frames with different exposure | ||
3228 | times. <footnote id="ctypeconv"><para> This control may be changed to a menu | ||
3229 | control in the future, if more options are required.</para></footnote></entry> | ||
3230 | </row> | ||
3231 | <row><entry></entry></row> | ||
3232 | |||
3233 | <row id="v4l2-image-stabilization"> | ||
3234 | <entry spanname="id"><constant>V4L2_CID_IMAGE_STABILIZATION</constant></entry> | ||
3235 | <entry>boolean</entry> | ||
3236 | </row> | ||
3237 | <row> | ||
3238 | <entry spanname="descr">Enables or disables image stabilization. | ||
3239 | <footnoteref linkend="ctypeconv"/></entry> | ||
3240 | </row> | ||
3241 | <row><entry></entry></row> | ||
3242 | |||
3243 | <row> | ||
3244 | <entry spanname="id"><constant>V4L2_CID_ISO_SENSITIVITY</constant> </entry> | ||
3245 | <entry>integer menu</entry> | ||
3246 | </row><row><entry spanname="descr">Determines ISO equivalent of an | ||
3247 | image sensor indicating the sensor's sensitivity to light. The numbers are | ||
3248 | expressed in arithmetic scale, as per <xref linkend="iso12232" /> standard, | ||
3249 | where doubling the sensor sensitivity is represented by doubling the numerical | ||
3250 | ISO value. Applications should interpret the values as standard ISO values | ||
3251 | multiplied by 1000, e.g. control value 800 stands for ISO 0.8. Drivers will | ||
3252 | usually support only a subset of standard ISO values. The effect of setting | ||
3253 | this control while the <constant>V4L2_CID_ISO_SENSITIVITY_AUTO</constant> | ||
3254 | control is set to a value other than <constant>V4L2_CID_ISO_SENSITIVITY_MANUAL | ||
3255 | </constant> is undefined, drivers should ignore such requests.</entry> | ||
3256 | </row> | ||
3257 | <row><entry></entry></row> | ||
3258 | |||
3259 | <row id="v4l2-iso-sensitivity-auto-type"> | ||
3260 | <entry spanname="id"><constant>V4L2_CID_ISO_SENSITIVITY_AUTO</constant> </entry> | ||
3261 | <entry>enum v4l2_iso_sensitivity_type</entry> | ||
3262 | </row><row><entry spanname="descr">Enables or disables automatic ISO | ||
3263 | sensitivity adjustments.</entry> | ||
3264 | </row> | ||
3265 | <row> | ||
3266 | <entrytbl spanname="descr" cols="2"> | ||
3267 | <tbody valign="top"> | ||
3268 | <row> | ||
3269 | <entry><constant>V4L2_CID_ISO_SENSITIVITY_MANUAL</constant> </entry> | ||
3270 | <entry>Manual ISO sensitivity.</entry> | ||
3271 | </row> | ||
3272 | <row> | ||
3273 | <entry><constant>V4L2_CID_ISO_SENSITIVITY_AUTO</constant> </entry> | ||
3274 | <entry>Automatic ISO sensitivity adjustments.</entry> | ||
3275 | </row> | ||
3276 | </tbody> | ||
3277 | </entrytbl> | ||
3278 | </row> | ||
3279 | <row><entry></entry></row> | ||
3280 | |||
3281 | <row id="v4l2-scene-mode"> | ||
3282 | <entry spanname="id"><constant>V4L2_CID_SCENE_MODE</constant> </entry> | ||
3283 | <entry>enum v4l2_scene_mode</entry> | ||
3284 | </row><row><entry spanname="descr">This control allows to select | ||
3285 | scene programs as the camera automatic modes optimized for common shooting | ||
3286 | scenes. Within these modes the camera determines best exposure, aperture, | ||
3287 | focusing, light metering, white balance and equivalent sensitivity. The | ||
3288 | controls of those parameters are influenced by the scene mode control. | ||
3289 | An exact behavior in each mode is subject to the camera specification. | ||
3290 | |||
3291 | <para>When the scene mode feature is not used, this control should be set to | ||
3292 | <constant>V4L2_SCENE_MODE_NONE</constant> to make sure the other possibly | ||
3293 | related controls are accessible. The following scene programs are defined: | ||
3294 | </para> | ||
3295 | </entry> | ||
3296 | </row> | ||
3297 | <row> | ||
3298 | <entrytbl spanname="descr" cols="2"> | ||
3299 | <tbody valign="top"> | ||
3300 | <row> | ||
3301 | <entry><constant>V4L2_SCENE_MODE_NONE</constant> </entry> | ||
3302 | <entry>The scene mode feature is disabled.</entry> | ||
3303 | </row> | ||
3304 | <row> | ||
3305 | <entry><constant>V4L2_SCENE_MODE_BACKLIGHT</constant> </entry> | ||
3306 | <entry>Backlight. Compensates for dark shadows when light is | ||
3307 | coming from behind a subject, also by automatically turning | ||
3308 | on the flash.</entry> | ||
3309 | </row> | ||
3310 | <row> | ||
3311 | <entry><constant>V4L2_SCENE_MODE_BEACH_SNOW</constant> </entry> | ||
3312 | <entry>Beach and snow. This mode compensates for all-white or | ||
3313 | bright scenes, which tend to look gray and low contrast, when camera's automatic | ||
3314 | exposure is based on an average scene brightness. To compensate, this mode | ||
3315 | automatically slightly overexposes the frames. The white balance may also be | ||
3316 | adjusted to compensate for the fact that reflected snow looks bluish rather | ||
3317 | than white.</entry> | ||
3318 | </row> | ||
3319 | <row> | ||
3320 | <entry><constant>V4L2_SCENE_MODE_CANDLELIGHT</constant> </entry> | ||
3321 | <entry>Candle light. The camera generally raises the ISO | ||
3322 | sensitivity and lowers the shutter speed. This mode compensates for relatively | ||
3323 | close subject in the scene. The flash is disabled in order to preserve the | ||
3324 | ambiance of the light.</entry> | ||
3325 | </row> | ||
3326 | <row> | ||
3327 | <entry><constant>V4L2_SCENE_MODE_DAWN_DUSK</constant> </entry> | ||
3328 | <entry>Dawn and dusk. Preserves the colors seen in low | ||
3329 | natural light before dusk and after down. The camera may turn off the flash, | ||
3330 | and automatically focus at infinity. It will usually boost saturation and | ||
3331 | lower the shutter speed.</entry> | ||
3332 | </row> | ||
3333 | <row> | ||
3334 | <entry><constant>V4L2_SCENE_MODE_FALL_COLORS</constant> </entry> | ||
3335 | <entry>Fall colors. Increases saturation and adjusts white | ||
3336 | balance for color enhancement. Pictures of autumn leaves get saturated reds | ||
3337 | and yellows.</entry> | ||
3338 | </row> | ||
3339 | <row> | ||
3340 | <entry><constant>V4L2_SCENE_MODE_FIREWORKS</constant> </entry> | ||
3341 | <entry>Fireworks. Long exposure times are used to capture | ||
3342 | the expanding burst of light from a firework. The camera may invoke image | ||
3343 | stabilization.</entry> | ||
3344 | </row> | ||
3345 | <row> | ||
3346 | <entry><constant>V4L2_SCENE_MODE_LANDSCAPE</constant> </entry> | ||
3347 | <entry>Landscape. The camera may choose a small aperture to | ||
3348 | provide deep depth of field and long exposure duration to help capture detail | ||
3349 | in dim light conditions. The focus is fixed at infinity. Suitable for distant | ||
3350 | and wide scenery.</entry> | ||
3351 | </row> | ||
3352 | <row> | ||
3353 | <entry><constant>V4L2_SCENE_MODE_NIGHT</constant> </entry> | ||
3354 | <entry>Night, also known as Night Landscape. Designed for low | ||
3355 | light conditions, it preserves detail in the dark areas without blowing out bright | ||
3356 | objects. The camera generally sets itself to a medium-to-high ISO sensitivity, | ||
3357 | with a relatively long exposure time, and turns flash off. As such, there will be | ||
3358 | increased image noise and the possibility of blurred image.</entry> | ||
3359 | </row> | ||
3360 | <row> | ||
3361 | <entry><constant>V4L2_SCENE_MODE_PARTY_INDOOR</constant> </entry> | ||
3362 | <entry>Party and indoor. Designed to capture indoor scenes | ||
3363 | that are lit by indoor background lighting as well as the flash. The camera | ||
3364 | usually increases ISO sensitivity, and adjusts exposure for the low light | ||
3365 | conditions.</entry> | ||
3366 | </row> | ||
3367 | <row> | ||
3368 | <entry><constant>V4L2_SCENE_MODE_PORTRAIT</constant> </entry> | ||
3369 | <entry>Portrait. The camera adjusts the aperture so that the | ||
3370 | depth of field is reduced, which helps to isolate the subject against a smooth | ||
3371 | background. Most cameras recognize the presence of faces in the scene and focus | ||
3372 | on them. The color hue is adjusted to enhance skin tones. The intensity of the | ||
3373 | flash is often reduced.</entry> | ||
3374 | </row> | ||
3375 | <row> | ||
3376 | <entry><constant>V4L2_SCENE_MODE_SPORTS</constant> </entry> | ||
3377 | <entry>Sports. Significantly increases ISO and uses a fast | ||
3378 | shutter speed to freeze motion of rapidly-moving subjects. Increased image | ||
3379 | noise may be seen in this mode.</entry> | ||
3380 | </row> | ||
3381 | <row> | ||
3382 | <entry><constant>V4L2_SCENE_MODE_SUNSET</constant> </entry> | ||
3383 | <entry>Sunset. Preserves deep hues seen in sunsets and | ||
3384 | sunrises. It bumps up the saturation.</entry> | ||
3385 | </row> | ||
3386 | <row> | ||
3387 | <entry><constant>V4L2_SCENE_MODE_TEXT</constant> </entry> | ||
3388 | <entry>Text. It applies extra contrast and sharpness, it is | ||
3389 | typically a black-and-white mode optimized for readability. Automatic focus | ||
3390 | may be switched to close-up mode and this setting may also involve some | ||
3391 | lens-distortion correction.</entry> | ||
3392 | </row> | ||
3393 | </tbody> | ||
3394 | </entrytbl> | ||
3395 | </row> | ||
3396 | <row><entry></entry></row> | ||
3397 | |||
3398 | <row> | ||
3399 | <entry spanname="id"><constant>V4L2_CID_3A_LOCK</constant></entry> | ||
3400 | <entry>bitmask</entry> | ||
3401 | </row> | ||
3402 | <row> | ||
3403 | <entry spanname="descr">This control locks or unlocks the automatic | ||
3404 | focus, exposure and white balance. The automatic adjustments can be paused | ||
3405 | independently by setting the corresponding lock bit to 1. The camera then retains | ||
3406 | the settings until the lock bit is cleared. The following lock bits are defined: | ||
3407 | </entry> | ||
3408 | </row> | ||
3409 | <row> | ||
3410 | <entrytbl spanname="descr" cols="2"> | ||
3411 | <tbody valign="top"> | ||
3412 | <row> | ||
3413 | <entry><constant>V4L2_LOCK_EXPOSURE</constant></entry> | ||
3414 | <entry>Automatic exposure adjustments lock.</entry> | ||
3415 | </row> | ||
3416 | <row> | ||
3417 | <entry><constant>V4L2_LOCK_WHITE_BALANCE</constant></entry> | ||
3418 | <entry>Automatic white balance adjustments lock.</entry> | ||
3419 | </row> | ||
3420 | <row> | ||
3421 | <entry><constant>V4L2_LOCK_FOCUS</constant></entry> | ||
3422 | <entry>Automatic focus lock.</entry> | ||
3423 | </row> | ||
3424 | </tbody> | ||
3425 | </entrytbl> | ||
3426 | </row> | ||
3427 | <row><entry spanname="descr"> | ||
3428 | When a given algorithm is not enabled, drivers should ignore requests | ||
3429 | to lock it and should return no error. An example might be an application | ||
3430 | setting bit <constant>V4L2_LOCK_WHITE_BALANCE</constant> when the | ||
3431 | <constant>V4L2_CID_AUTO_WHITE_BALANCE</constant> control is set to | ||
3432 | <constant>FALSE</constant>. The value of this control may be changed | ||
3433 | by exposure, white balance or focus controls.</entry> | ||
3434 | </row> | ||
3435 | <row><entry></entry></row> | ||
3436 | |||
2935 | </tbody> | 3437 | </tbody> |
2936 | </tgroup> | 3438 | </tgroup> |
2937 | </table> | 3439 | </table> |
@@ -3476,7 +3978,7 @@ interface and may change in the future.</para> | |||
3476 | <entry spanname="id"><constant>V4L2_CID_JPEG_CHROMA_SUBSAMPLING</constant></entry> | 3978 | <entry spanname="id"><constant>V4L2_CID_JPEG_CHROMA_SUBSAMPLING</constant></entry> |
3477 | <entry>menu</entry> | 3979 | <entry>menu</entry> |
3478 | </row> | 3980 | </row> |
3479 | <row id="jpeg-chroma-subsampling-control"> | 3981 | <row id="v4l2-jpeg-chroma-subsampling"> |
3480 | <entry spanname="descr">The chroma subsampling factors describe how | 3982 | <entry spanname="descr">The chroma subsampling factors describe how |
3481 | each component of an input image is sampled, in respect to maximum | 3983 | each component of an input image is sampled, in respect to maximum |
3482 | sample rate in each spatial dimension. See <xref linkend="itu-t81"/>, | 3984 | sample rate in each spatial dimension. See <xref linkend="itu-t81"/>, |
@@ -3486,7 +3988,7 @@ interface and may change in the future.</para> | |||
3486 | from RGB to Y'CbCr color space. | 3988 | from RGB to Y'CbCr color space. |
3487 | </entry> | 3989 | </entry> |
3488 | </row> | 3990 | </row> |
3489 | <row> | 3991 | <row id = "v4l2-jpeg-chroma-subsampling"> |
3490 | <entrytbl spanname="descr" cols="2"> | 3992 | <entrytbl spanname="descr" cols="2"> |
3491 | <tbody valign="top"> | 3993 | <tbody valign="top"> |
3492 | <row> | 3994 | <row> |
@@ -3538,12 +4040,12 @@ interface and may change in the future.</para> | |||
3538 | </entry> | 4040 | </entry> |
3539 | </row> | 4041 | </row> |
3540 | <row id="jpeg-quality-control"> | 4042 | <row id="jpeg-quality-control"> |
3541 | <entry spanname="id"><constant>V4L2_CID_JPEG_COMPRESION_QUALITY</constant></entry> | 4043 | <entry spanname="id"><constant>V4L2_CID_JPEG_COMPRESSION_QUALITY</constant></entry> |
3542 | <entry>integer</entry> | 4044 | <entry>integer</entry> |
3543 | </row> | 4045 | </row> |
3544 | <row> | 4046 | <row> |
3545 | <entry spanname="descr"> | 4047 | <entry spanname="descr"> |
3546 | <constant>V4L2_CID_JPEG_COMPRESION_QUALITY</constant> control | 4048 | <constant>V4L2_CID_JPEG_COMPRESSION_QUALITY</constant> control |
3547 | determines trade-off between image quality and size. | 4049 | determines trade-off between image quality and size. |
3548 | It provides simpler method for applications to control image quality, | 4050 | It provides simpler method for applications to control image quality, |
3549 | without a need for direct reconfiguration of luminance and chrominance | 4051 | without a need for direct reconfiguration of luminance and chrominance |
@@ -3551,7 +4053,7 @@ interface and may change in the future.</para> | |||
3551 | 4053 | ||
3552 | In cases where a driver uses quantization tables configured directly | 4054 | In cases where a driver uses quantization tables configured directly |
3553 | by an application, using interfaces defined elsewhere, <constant> | 4055 | by an application, using interfaces defined elsewhere, <constant> |
3554 | V4L2_CID_JPEG_COMPRESION_QUALITY</constant> control should be set | 4056 | V4L2_CID_JPEG_COMPRESSION_QUALITY</constant> control should be set |
3555 | by driver to 0. | 4057 | by driver to 0. |
3556 | 4058 | ||
3557 | <para>The value range of this control is driver-specific. Only | 4059 | <para>The value range of this control is driver-specific. Only |
@@ -3599,4 +4101,172 @@ interface and may change in the future.</para> | |||
3599 | to <xref linkend="itu-t81"/>, <xref linkend="jfif"/>, | 4101 | to <xref linkend="itu-t81"/>, <xref linkend="jfif"/>, |
3600 | <xref linkend="w3c-jpeg-jfif"/>.</para> | 4102 | <xref linkend="w3c-jpeg-jfif"/>.</para> |
3601 | </section> | 4103 | </section> |
4104 | |||
4105 | <section id="image-source-controls"> | ||
4106 | <title>Image Source Control Reference</title> | ||
4107 | |||
4108 | <note> | ||
4109 | <title>Experimental</title> | ||
4110 | |||
4111 | <para>This is an <link | ||
4112 | linkend="experimental">experimental</link> interface and may | ||
4113 | change in the future.</para> | ||
4114 | </note> | ||
4115 | |||
4116 | <para> | ||
4117 | The Image Source control class is intended for low-level | ||
4118 | control of image source devices such as image sensors. The | ||
4119 | devices feature an analogue to digital converter and a bus | ||
4120 | transmitter to transmit the image data out of the device. | ||
4121 | </para> | ||
4122 | |||
4123 | <table pgwide="1" frame="none" id="image-source-control-id"> | ||
4124 | <title>Image Source Control IDs</title> | ||
4125 | |||
4126 | <tgroup cols="4"> | ||
4127 | <colspec colname="c1" colwidth="1*" /> | ||
4128 | <colspec colname="c2" colwidth="6*" /> | ||
4129 | <colspec colname="c3" colwidth="2*" /> | ||
4130 | <colspec colname="c4" colwidth="6*" /> | ||
4131 | <spanspec namest="c1" nameend="c2" spanname="id" /> | ||
4132 | <spanspec namest="c2" nameend="c4" spanname="descr" /> | ||
4133 | <thead> | ||
4134 | <row> | ||
4135 | <entry spanname="id" align="left">ID</entry> | ||
4136 | <entry align="left">Type</entry> | ||
4137 | </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry> | ||
4138 | </row> | ||
4139 | </thead> | ||
4140 | <tbody valign="top"> | ||
4141 | <row><entry></entry></row> | ||
4142 | <row> | ||
4143 | <entry spanname="id"><constant>V4L2_CID_IMAGE_SOURCE_CLASS</constant></entry> | ||
4144 | <entry>class</entry> | ||
4145 | </row> | ||
4146 | <row> | ||
4147 | <entry spanname="descr">The IMAGE_SOURCE class descriptor.</entry> | ||
4148 | </row> | ||
4149 | <row> | ||
4150 | <entry spanname="id"><constant>V4L2_CID_VBLANK</constant></entry> | ||
4151 | <entry>integer</entry> | ||
4152 | </row> | ||
4153 | <row> | ||
4154 | <entry spanname="descr">Vertical blanking. The idle period | ||
4155 | after every frame during which no image data is produced. | ||
4156 | The unit of vertical blanking is a line. Every line has | ||
4157 | length of the image width plus horizontal blanking at the | ||
4158 | pixel rate defined by | ||
4159 | <constant>V4L2_CID_PIXEL_RATE</constant> control in the | ||
4160 | same sub-device.</entry> | ||
4161 | </row> | ||
4162 | <row> | ||
4163 | <entry spanname="id"><constant>V4L2_CID_HBLANK</constant></entry> | ||
4164 | <entry>integer</entry> | ||
4165 | </row> | ||
4166 | <row> | ||
4167 | <entry spanname="descr">Horizontal blanking. The idle | ||
4168 | period after every line of image data during which no | ||
4169 | image data is produced. The unit of horizontal blanking is | ||
4170 | pixels.</entry> | ||
4171 | </row> | ||
4172 | <row> | ||
4173 | <entry spanname="id"><constant>V4L2_CID_ANALOGUE_GAIN</constant></entry> | ||
4174 | <entry>integer</entry> | ||
4175 | </row> | ||
4176 | <row> | ||
4177 | <entry spanname="descr">Analogue gain is gain affecting | ||
4178 | all colour components in the pixel matrix. The gain | ||
4179 | operation is performed in the analogue domain before A/D | ||
4180 | conversion. | ||
4181 | </entry> | ||
4182 | </row> | ||
4183 | <row><entry></entry></row> | ||
4184 | </tbody> | ||
4185 | </tgroup> | ||
4186 | </table> | ||
4187 | |||
4188 | </section> | ||
4189 | |||
4190 | <section id="image-process-controls"> | ||
4191 | <title>Image Process Control Reference</title> | ||
4192 | |||
4193 | <note> | ||
4194 | <title>Experimental</title> | ||
4195 | |||
4196 | <para>This is an <link | ||
4197 | linkend="experimental">experimental</link> interface and may | ||
4198 | change in the future.</para> | ||
4199 | </note> | ||
4200 | |||
4201 | <para> | ||
4202 | The Image Source control class is intended for low-level control of | ||
4203 | image processing functions. Unlike | ||
4204 | <constant>V4L2_CID_IMAGE_SOURCE_CLASS</constant>, the controls in | ||
4205 | this class affect processing the image, and do not control capturing | ||
4206 | of it. | ||
4207 | </para> | ||
4208 | |||
4209 | <table pgwide="1" frame="none" id="image-process-control-id"> | ||
4210 | <title>Image Source Control IDs</title> | ||
4211 | |||
4212 | <tgroup cols="4"> | ||
4213 | <colspec colname="c1" colwidth="1*" /> | ||
4214 | <colspec colname="c2" colwidth="6*" /> | ||
4215 | <colspec colname="c3" colwidth="2*" /> | ||
4216 | <colspec colname="c4" colwidth="6*" /> | ||
4217 | <spanspec namest="c1" nameend="c2" spanname="id" /> | ||
4218 | <spanspec namest="c2" nameend="c4" spanname="descr" /> | ||
4219 | <thead> | ||
4220 | <row> | ||
4221 | <entry spanname="id" align="left">ID</entry> | ||
4222 | <entry align="left">Type</entry> | ||
4223 | </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry> | ||
4224 | </row> | ||
4225 | </thead> | ||
4226 | <tbody valign="top"> | ||
4227 | <row><entry></entry></row> | ||
4228 | <row> | ||
4229 | <entry spanname="id"><constant>V4L2_CID_IMAGE_PROC_CLASS</constant></entry> | ||
4230 | <entry>class</entry> | ||
4231 | </row> | ||
4232 | <row> | ||
4233 | <entry spanname="descr">The IMAGE_PROC class descriptor.</entry> | ||
4234 | </row> | ||
4235 | <row> | ||
4236 | <entry spanname="id"><constant>V4L2_CID_LINK_FREQ</constant></entry> | ||
4237 | <entry>integer menu</entry> | ||
4238 | </row> | ||
4239 | <row> | ||
4240 | <entry spanname="descr">Data bus frequency. Together with the | ||
4241 | media bus pixel code, bus type (clock cycles per sample), the | ||
4242 | data bus frequency defines the pixel rate | ||
4243 | (<constant>V4L2_CID_PIXEL_RATE</constant>) in the | ||
4244 | pixel array (or possibly elsewhere, if the device is not an | ||
4245 | image sensor). The frame rate can be calculated from the pixel | ||
4246 | clock, image width and height and horizontal and vertical | ||
4247 | blanking. While the pixel rate control may be defined elsewhere | ||
4248 | than in the subdev containing the pixel array, the frame rate | ||
4249 | cannot be obtained from that information. This is because only | ||
4250 | on the pixel array it can be assumed that the vertical and | ||
4251 | horizontal blanking information is exact: no other blanking is | ||
4252 | allowed in the pixel array. The selection of frame rate is | ||
4253 | performed by selecting the desired horizontal and vertical | ||
4254 | blanking. The unit of this control is Hz. </entry> | ||
4255 | </row> | ||
4256 | <row> | ||
4257 | <entry spanname="id"><constant>V4L2_CID_PIXEL_RATE</constant></entry> | ||
4258 | <entry>64-bit integer</entry> | ||
4259 | </row> | ||
4260 | <row> | ||
4261 | <entry spanname="descr">Pixel rate in the source pads of | ||
4262 | the subdev. This control is read-only and its unit is | ||
4263 | pixels / second. | ||
4264 | </entry> | ||
4265 | </row> | ||
4266 | <row><entry></entry></row> | ||
4267 | </tbody> | ||
4268 | </tgroup> | ||
4269 | </table> | ||
4270 | |||
4271 | </section> | ||
3602 | </section> | 4272 | </section> |