Documentation/media/uapi/v4l/pixfmt-meta-vivid.rst

   1 .. This file is dual-licensed: you can use it either under the terms
   2 .. of the GPL 2.0 or the GFDL 1.1+ license, at your option. Note that this
   3 .. dual licensing only applies to this file, and not this project as a
   4 .. whole.
   5 ..
   6 .. a) This file is free software; you can redistribute it and/or
   7 ..    modify it under the terms of the GNU General Public License as
   8 ..    published by the Free Software Foundation version 2 of
   9 ..    the License.
  10 ..
  11 ..    This file is distributed in the hope that it will be useful,
  12 ..    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ..    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ..    GNU General Public License for more details.
  15 ..
  16 .. Or, alternatively,
  17 ..
  18 .. b) Permission is granted to copy, distribute and/or modify this
  19 ..    document under the terms of the GNU Free Documentation License,
  20 ..    Version 1.1 or any later version published by the Free Software
  21 ..    Foundation, with no Invariant Sections, no Front-Cover Texts
  22 ..    and no Back-Cover Texts. A copy of the license is included at
  23 ..    Documentation/media/uapi/fdl-appendix.rst.
  24 ..
  25 .. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections
  26
  27 .. _v4l2-meta-fmt-vivid:
  28
  29 *******************************
  30 V4L2_META_FMT_VIVID ('VIVD')
  31 *******************************
  32
  33 VIVID Metadata Format
  34
  35
  36 Description
  37 ===========
  38
  39 This describes metadata format used by the vivid driver.
  40
  41 It sets Brightness, Saturation, Contrast and Hue, each of which maps to
  42 corresponding controls of the vivid driver with respect to the range and default values.
  43
  44 It contains the following fields:
  45
  46 .. flat-table:: VIVID Metadata
  47     :widths: 1 4
  48     :header-rows:  1
  49     :stub-columns: 0
  50
  51     * - Field
  52       - Description
  53     * - u16 brightness;
  54       - Image brightness, the value is in the range 0 to 255, with the default value as 128.
  55     * - u16 contrast;
  56       - Image contrast, the value is in the range 0 to 255, with the default value as 128.
  57     * - u16 saturation;
  58       - Image color saturation, the value is in the range 0 to 255, with the default value as 128.
  59     * - s16 hue;
  60       - Image color balance, the value is in the range -128 to 128, with the default value as 0.