Documentation/media/uapi/dvb/video-set-format.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _VIDEO_SET_FORMAT:
  11
  12 ================
  13 VIDEO_SET_FORMAT
  14 ================
  15
  16 Name
  17 ----
  18
  19 VIDEO_SET_FORMAT
  20
  21 .. attention:: This ioctl is deprecated.
  22
  23 Synopsis
  24 --------
  25
  26 .. c:function:: int ioctl(fd, VIDEO_SET_FORMAT, video_format_t format)
  27     :name: VIDEO_SET_FORMAT
  28
  29
  30 Arguments
  31 ---------
  32
  33 .. flat-table::
  34     :header-rows:  0
  35     :stub-columns: 0
  36
  37
  38     -  .. row 1
  39
  40        -  int fd
  41
  42        -  File descriptor returned by a previous call to open().
  43
  44     -  .. row 2
  45
  46        -  int request
  47
  48        -  Equals VIDEO_SET_FORMAT for this command.
  49
  50     -  .. row 3
  51
  52        -  video_format_t format
  53
  54        -  video format of TV as defined in section ??.
  55
  56
  57 Description
  58 -----------
  59
  60 This ioctl sets the screen format (aspect ratio) of the connected output
  61 device (TV) so that the output of the decoder can be adjusted
  62 accordingly.
  63
  64 .. c:type:: video_format_t
  65
  66 .. code-block:: c
  67
  68         typedef enum {
  69                 VIDEO_FORMAT_4_3,     /* Select 4:3 format */
  70                 VIDEO_FORMAT_16_9,    /* Select 16:9 format. */
  71                 VIDEO_FORMAT_221_1    /* 2.21:1 */
  72         } video_format_t;
  73
  74 Return Value
  75 ------------
  76
  77 On success 0 is returned, on error -1 and the ``errno`` variable is set
  78 appropriately. The generic error codes are described at the
  79 :ref:`Generic Error Codes <gen-errors>` chapter.
  80
  81
  82
  83 .. flat-table::
  84     :header-rows:  0
  85     :stub-columns: 0
  86
  87
  88     -  .. row 1
  89
  90        -  ``EINVAL``
  91
  92        -  format is not a valid video format.