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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDEO_SET_ATTRIBUTES:
   4
   5 ====================
   6 VIDEO_SET_ATTRIBUTES
   7 ====================
   8
   9 Name
  10 ----
  11
  12 VIDEO_SET_ATTRIBUTES
  13
  14 .. attention:: This ioctl is deprecated.
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int ioctl(fd, VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
  20     :name: VIDEO_SET_ATTRIBUTE
  21
  22
  23 Arguments
  24 ---------
  25
  26 .. flat-table::
  27     :header-rows:  0
  28     :stub-columns: 0
  29
  30
  31     -  .. row 1
  32
  33        -  int fd
  34
  35        -  File descriptor returned by a previous call to open().
  36
  37     -  .. row 2
  38
  39        -  int request
  40
  41        -  Equals VIDEO_SET_ATTRIBUTE for this command.
  42
  43     -  .. row 3
  44
  45        -  video_attributes_t vattr
  46
  47        -  video attributes according to section ??.
  48
  49
  50 Description
  51 -----------
  52
  53 This ioctl is intended for DVD playback and allows you to set certain
  54 information about the stream. Some hardware may not need this
  55 information, but the call also tells the hardware to prepare for DVD
  56 playback.
  57
  58 .. c:type:: video_attributes_t
  59
  60 .. code-block::c
  61
  62         typedef __u16 video_attributes_t;
  63         /*   bits: descr. */
  64         /*   15-14 Video compression mode (0=MPEG-1, 1=MPEG-2) */
  65         /*   13-12 TV system (0=525/60, 1=625/50) */
  66         /*   11-10 Aspect ratio (0=4:3, 3=16:9) */
  67         /*    9- 8 permitted display mode on 4:3 monitor (0=both, 1=only pan-sca */
  68         /*    7    line 21-1 data present in GOP (1=yes, 0=no) */
  69         /*    6    line 21-2 data present in GOP (1=yes, 0=no) */
  70         /*    5- 3 source resolution (0=720x480/576, 1=704x480/576, 2=352x480/57 */
  71         /*    2    source letterboxed (1=yes, 0=no) */
  72         /*    0    film/camera mode (0=camera, 1=film (625/50 only)) */
  73
  74
  75 Return Value
  76 ------------
  77
  78 On success 0 is returned, on error -1 and the ``errno`` variable is set
  79 appropriately. The generic error codes are described at the
  80 :ref:`Generic Error Codes <gen-errors>` chapter.
  81
  82
  83
  84 .. flat-table::
  85     :header-rows:  0
  86     :stub-columns: 0
  87
  88
  89     -  .. row 1
  90
  91        -  ``EINVAL``
  92
  93        -  input is not a valid attribute setting.