Documentation/media/uapi/v4l/vidioc-decoder-cmd.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_DECODER_CMD:
   4
   5 ************************************************
   6 ioctl VIDIOC_DECODER_CMD, VIDIOC_TRY_DECODER_CMD
   7 ************************************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_DECODER_CMD - VIDIOC_TRY_DECODER_CMD - Execute an decoder command
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, struct v4l2_decoder_cmd *argp )
  19
  20
  21 Arguments
  22 =========
  23
  24 ``fd``
  25     File descriptor returned by :ref:`open() <func-open>`.
  26
  27 ``request``
  28     VIDIOC_DECODER_CMD, VIDIOC_TRY_DECODER_CMD
  29
  30 ``argp``
  31
  32
  33 Description
  34 ===========
  35
  36 These ioctls control an audio/video (usually MPEG-) decoder.
  37 ``VIDIOC_DECODER_CMD`` sends a command to the decoder,
  38 ``VIDIOC_TRY_DECODER_CMD`` can be used to try a command without actually
  39 executing it. To send a command applications must initialize all fields
  40 of a struct :ref:`v4l2_decoder_cmd <v4l2-decoder-cmd>` and call
  41 ``VIDIOC_DECODER_CMD`` or ``VIDIOC_TRY_DECODER_CMD`` with a pointer to
  42 this structure.
  43
  44 The ``cmd`` field must contain the command code. Some commands use the
  45 ``flags`` field for additional information.
  46
  47 A :ref:`write() <func-write>` or :ref:`VIDIOC_STREAMON`
  48 call sends an implicit START command to the decoder if it has not been
  49 started yet.
  50
  51 A :ref:`close() <func-close>` or :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>`
  52 call of a streaming file descriptor sends an implicit immediate STOP
  53 command to the decoder, and all buffered data is discarded.
  54
  55 These ioctls are optional, not all drivers may support them. They were
  56 introduced in Linux 3.3.
  57
  58
  59 .. _v4l2-decoder-cmd:
  60
  61 .. cssclass:: longtable
  62
  63 .. tabularcolumns:: |p{1.1cm}|p{2.4cm}|p{1.2cm}|p{1.6cm}|p{10.6cm}|
  64
  65 .. flat-table:: struct v4l2_decoder_cmd
  66     :header-rows:  0
  67     :stub-columns: 0
  68     :widths: 11 24 12 16 106
  69
  70
  71     -  .. row 1
  72
  73        -  __u32
  74
  75        -  ``cmd``
  76
  77        -
  78        -
  79        -  The decoder command, see :ref:`decoder-cmds`.
  80
  81     -  .. row 2
  82
  83        -  __u32
  84
  85        -  ``flags``
  86
  87        -
  88        -
  89        -  Flags to go with the command. If no flags are defined for this
  90           command, drivers and applications must set this field to zero.
  91
  92     -  .. row 3
  93
  94        -  union
  95
  96        -  (anonymous)
  97
  98        -
  99        -
 100        -
 101
 102     -  .. row 4
 103
 104        -
 105        -  struct
 106
 107        -  ``start``
 108
 109        -
 110        -  Structure containing additional data for the
 111           ``V4L2_DEC_CMD_START`` command.
 112
 113     -  .. row 5
 114
 115        -
 116        -
 117        -  __s32
 118
 119        -  ``speed``
 120
 121        -  Playback speed and direction. The playback speed is defined as
 122           ``speed``/1000 of the normal speed. So 1000 is normal playback.
 123           Negative numbers denote reverse playback, so -1000 does reverse
 124           playback at normal speed. Speeds -1, 0 and 1 have special
 125           meanings: speed 0 is shorthand for 1000 (normal playback). A speed
 126           of 1 steps just one frame forward, a speed of -1 steps just one
 127           frame back.
 128
 129     -  .. row 6
 130
 131        -
 132        -
 133        -  __u32
 134
 135        -  ``format``
 136
 137        -  Format restrictions. This field is set by the driver, not the
 138           application. Possible values are ``V4L2_DEC_START_FMT_NONE`` if
 139           there are no format restrictions or ``V4L2_DEC_START_FMT_GOP`` if
 140           the decoder operates on full GOPs (*Group Of Pictures*). This is
 141           usually the case for reverse playback: the decoder needs full
 142           GOPs, which it can then play in reverse order. So to implement
 143           reverse playback the application must feed the decoder the last
 144           GOP in the video file, then the GOP before that, etc. etc.
 145
 146     -  .. row 7
 147
 148        -
 149        -  struct
 150
 151        -  ``stop``
 152
 153        -
 154        -  Structure containing additional data for the ``V4L2_DEC_CMD_STOP``
 155           command.
 156
 157     -  .. row 8
 158
 159        -
 160        -
 161        -  __u64
 162
 163        -  ``pts``
 164
 165        -  Stop playback at this ``pts`` or immediately if the playback is
 166           already past that timestamp. Leave to 0 if you want to stop after
 167           the last frame was decoded.
 168
 169     -  .. row 9
 170
 171        -
 172        -  struct
 173
 174        -  ``raw``
 175
 176        -
 177        -
 178
 179     -  .. row 10
 180
 181        -
 182        -
 183        -  __u32
 184
 185        -  ``data``\ [16]
 186
 187        -  Reserved for future extensions. Drivers and applications must set
 188           the array to zero.
 189
 190
 191
 192 .. _decoder-cmds:
 193
 194 .. tabularcolumns:: |p{5.6cm}|p{0.6cm}|p{11.3cm}|
 195
 196 .. flat-table:: Decoder Commands
 197     :header-rows:  0
 198     :stub-columns: 0
 199     :widths: 56 6 113
 200
 201
 202     -  .. row 1
 203
 204        -  ``V4L2_DEC_CMD_START``
 205
 206        -  0
 207
 208        -  Start the decoder. When the decoder is already running or paused,
 209           this command will just change the playback speed. That means that
 210           calling ``V4L2_DEC_CMD_START`` when the decoder was paused will
 211           *not* resume the decoder. You have to explicitly call
 212           ``V4L2_DEC_CMD_RESUME`` for that. This command has one flag:
 213           ``V4L2_DEC_CMD_START_MUTE_AUDIO``. If set, then audio will be
 214           muted when playing back at a non-standard speed.
 215
 216     -  .. row 2
 217
 218        -  ``V4L2_DEC_CMD_STOP``
 219
 220        -  1
 221
 222        -  Stop the decoder. When the decoder is already stopped, this
 223           command does nothing. This command has two flags: if
 224           ``V4L2_DEC_CMD_STOP_TO_BLACK`` is set, then the decoder will set
 225           the picture to black after it stopped decoding. Otherwise the last
 226           image will repeat. mem2mem decoders will stop producing new frames
 227           altogether. They will send a ``V4L2_EVENT_EOS`` event when the
 228           last frame has been decoded and all frames are ready to be
 229           dequeued and will set the ``V4L2_BUF_FLAG_LAST`` buffer flag on
 230           the last buffer of the capture queue to indicate there will be no
 231           new buffers produced to dequeue. This buffer may be empty,
 232           indicated by the driver setting the ``bytesused`` field to 0. Once
 233           the ``V4L2_BUF_FLAG_LAST`` flag was set, the
 234           :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore,
 235           but return an ``EPIPE`` error code. If
 236           ``V4L2_DEC_CMD_STOP_IMMEDIATELY`` is set, then the decoder stops
 237           immediately (ignoring the ``pts`` value), otherwise it will keep
 238           decoding until timestamp >= pts or until the last of the pending
 239           data from its internal buffers was decoded.
 240
 241     -  .. row 3
 242
 243        -  ``V4L2_DEC_CMD_PAUSE``
 244
 245        -  2
 246
 247        -  Pause the decoder. When the decoder has not been started yet, the
 248           driver will return an ``EPERM`` error code. When the decoder is
 249           already paused, this command does nothing. This command has one
 250           flag: if ``V4L2_DEC_CMD_PAUSE_TO_BLACK`` is set, then set the
 251           decoder output to black when paused.
 252
 253     -  .. row 4
 254
 255        -  ``V4L2_DEC_CMD_RESUME``
 256
 257        -  3
 258
 259        -  Resume decoding after a PAUSE command. When the decoder has not
 260           been started yet, the driver will return an ``EPERM`` error code. When
 261           the decoder is already running, this command does nothing. No
 262           flags are defined for this command.
 263
 264
 265 Return Value
 266 ============
 267
 268 On success 0 is returned, on error -1 and the ``errno`` variable is set
 269 appropriately. The generic error codes are described at the
 270 :ref:`Generic Error Codes <gen-errors>` chapter.
 271
 272 EINVAL
 273     The ``cmd`` field is invalid.
 274
 275 EPERM
 276     The application sent a PAUSE or RESUME command when the decoder was
 277     not running.