Documentation/userspace-api/media/dvb/video-command.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.video
   3
   4 .. _VIDEO_COMMAND:
   5
   6 =============
   7 VIDEO_COMMAND
   8 =============
   9
  10 Name
  11 ----
  12
  13 VIDEO_COMMAND
  14
  15 .. attention:: This ioctl is deprecated.
  16
  17 Synopsis
  18 --------
  19
  20 .. c:macro:: VIDEO_COMMAND
  21
  22 ``int ioctl(int fd, VIDEO_COMMAND, struct video_command *cmd)``
  23
  24 Arguments
  25 ---------
  26
  27 .. flat-table::
  28     :header-rows:  0
  29     :stub-columns: 0
  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_COMMAND for this command.
  42
  43     -  .. row 3
  44
  45        -  struct video_command \*cmd
  46
  47        -  Commands the decoder.
  48
  49 Description
  50 -----------
  51
  52 This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
  53 this ioctl has been replaced by the
  54 :ref:`VIDIOC_DECODER_CMD` ioctl.
  55
  56 This ioctl commands the decoder. The ``video_command`` struct is a
  57 subset of the ``v4l2_decoder_cmd`` struct, so refer to the
  58 :ref:`VIDIOC_DECODER_CMD` documentation for
  59 more information.
  60
  61 .. c:type:: video_command
  62
  63 .. code-block:: c
  64
  65         /* The structure must be zeroed before use by the application
  66         This ensures it can be extended safely in the future. */
  67         struct video_command {
  68                 __u32 cmd;
  69                 __u32 flags;
  70                 union {
  71                         struct {
  72                                 __u64 pts;
  73                         } stop;
  74
  75                         struct {
  76                                 /* 0 or 1000 specifies normal speed,
  77                                 1 specifies forward single stepping,
  78                                 -1 specifies backward single stepping,
  79                                 >1: playback at speed/1000 of the normal speed,
  80                                 <-1: reverse playback at (-speed/1000) of the normal speed. */
  81                                 __s32 speed;
  82                                 __u32 format;
  83                         } play;
  84
  85                         struct {
  86                                 __u32 data[16];
  87                         } raw;
  88                 };
  89         };
  90
  91 Return Value
  92 ------------
  93
  94 On success 0 is returned, on error -1 and the ``errno`` variable is set
  95 appropriately. The generic error codes are described at the
  96 :ref:`Generic Error Codes <gen-errors>` chapter.