1 .. -*- coding: utf-8; mode: rst -*-
3 .. _VIDIOC_DECODER_CMD:
5 ************************************************
6 ioctl VIDIOC_DECODER_CMD, VIDIOC_TRY_DECODER_CMD
7 ************************************************
12 VIDIOC_DECODER_CMD - VIDIOC_TRY_DECODER_CMD - Execute an decoder command
18 .. cpp:function:: int ioctl( int fd, int request, struct v4l2_decoder_cmd *argp )
25 File descriptor returned by :ref:`open() <func-open>`.
28 VIDIOC_DECODER_CMD, VIDIOC_TRY_DECODER_CMD
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
44 The ``cmd`` field must contain the command code. Some commands use the
45 ``flags`` field for additional information.
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
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.
55 These ioctls are optional, not all drivers may support them. They were
56 introduced in Linux 3.3.
61 .. flat-table:: struct v4l2_decoder_cmd
75 - The decoder command, see :ref:`decoder-cmds`.
85 - Flags to go with the command. If no flags are defined for this
86 command, drivers and applications must set this field to zero.
106 - Structure containing additional data for the
107 ``V4L2_DEC_CMD_START`` command.
117 - Playback speed and direction. The playback speed is defined as
118 ``speed``/1000 of the normal speed. So 1000 is normal playback.
119 Negative numbers denote reverse playback, so -1000 does reverse
120 playback at normal speed. Speeds -1, 0 and 1 have special
121 meanings: speed 0 is shorthand for 1000 (normal playback). A speed
122 of 1 steps just one frame forward, a speed of -1 steps just one
133 - Format restrictions. This field is set by the driver, not the
134 application. Possible values are ``V4L2_DEC_START_FMT_NONE`` if
135 there are no format restrictions or ``V4L2_DEC_START_FMT_GOP`` if
136 the decoder operates on full GOPs (*Group Of Pictures*). This is
137 usually the case for reverse playback: the decoder needs full
138 GOPs, which it can then play in reverse order. So to implement
139 reverse playback the application must feed the decoder the last
140 GOP in the video file, then the GOP before that, etc. etc.
150 - Structure containing additional data for the ``V4L2_DEC_CMD_STOP``
161 - Stop playback at this ``pts`` or immediately if the playback is
162 already past that timestamp. Leave to 0 if you want to stop after
163 the last frame was decoded.
183 - Reserved for future extensions. Drivers and applications must set
190 .. flat-table:: Decoder Commands
198 - ``V4L2_DEC_CMD_START``
202 - Start the decoder. When the decoder is already running or paused,
203 this command will just change the playback speed. That means that
204 calling ``V4L2_DEC_CMD_START`` when the decoder was paused will
205 *not* resume the decoder. You have to explicitly call
206 ``V4L2_DEC_CMD_RESUME`` for that. This command has one flag:
207 ``V4L2_DEC_CMD_START_MUTE_AUDIO``. If set, then audio will be
208 muted when playing back at a non-standard speed.
212 - ``V4L2_DEC_CMD_STOP``
216 - Stop the decoder. When the decoder is already stopped, this
217 command does nothing. This command has two flags: if
218 ``V4L2_DEC_CMD_STOP_TO_BLACK`` is set, then the decoder will set
219 the picture to black after it stopped decoding. Otherwise the last
220 image will repeat. mem2mem decoders will stop producing new frames
221 altogether. They will send a ``V4L2_EVENT_EOS`` event when the
222 last frame has been decoded and all frames are ready to be
223 dequeued and will set the ``V4L2_BUF_FLAG_LAST`` buffer flag on
224 the last buffer of the capture queue to indicate there will be no
225 new buffers produced to dequeue. This buffer may be empty,
226 indicated by the driver setting the ``bytesused`` field to 0. Once
227 the ``V4L2_BUF_FLAG_LAST`` flag was set, the
228 :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore,
229 but return an ``EPIPE`` error code. If
230 ``V4L2_DEC_CMD_STOP_IMMEDIATELY`` is set, then the decoder stops
231 immediately (ignoring the ``pts`` value), otherwise it will keep
232 decoding until timestamp >= pts or until the last of the pending
233 data from its internal buffers was decoded.
237 - ``V4L2_DEC_CMD_PAUSE``
241 - Pause the decoder. When the decoder has not been started yet, the
242 driver will return an ``EPERM`` error code. When the decoder is
243 already paused, this command does nothing. This command has one
244 flag: if ``V4L2_DEC_CMD_PAUSE_TO_BLACK`` is set, then set the
245 decoder output to black when paused.
249 - ``V4L2_DEC_CMD_RESUME``
253 - Resume decoding after a PAUSE command. When the decoder has not
254 been started yet, the driver will return an ``EPERM`` error code. When
255 the decoder is already running, this command does nothing. No
256 flags are defined for this command.
262 On success 0 is returned, on error -1 and the ``errno`` variable is set
263 appropriately. The generic error codes are described at the
264 :ref:`Generic Error Codes <gen-errors>` chapter.
267 The ``cmd`` field is invalid.
270 The application sent a PAUSE or RESUME command when the decoder was