vidioc-encoder-cmd.rst 5.0 KB
Newer Older
1 2
.. -*- coding: utf-8; mode: rst -*-

3
.. _VIDIOC_ENCODER_CMD:
4 5 6 7 8

************************************************
ioctl VIDIOC_ENCODER_CMD, VIDIOC_TRY_ENCODER_CMD
************************************************

9 10
NAME
====
11

12
VIDIOC_ENCODER_CMD - VIDIOC_TRY_ENCODER_CMD - Execute an encoder command
13

14
SYNOPSIS
15 16
========

17
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_encoder_cmd *argp )
18

19 20

ARGUMENTS
21 22 23 24 25 26 27 28 29 30 31
=========

``fd``
    File descriptor returned by :ref:`open() <func-open>`.

``request``
    VIDIOC_ENCODER_CMD, VIDIOC_TRY_ENCODER_CMD

``argp``


32
DESCRIPTION
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
===========

These ioctls control an audio/video (usually MPEG-) encoder.
``VIDIOC_ENCODER_CMD`` sends a command to the encoder,
``VIDIOC_TRY_ENCODER_CMD`` can be used to try a command without actually
executing it.

To send a command applications must initialize all fields of a struct
:ref:`v4l2_encoder_cmd <v4l2-encoder-cmd>` and call
``VIDIOC_ENCODER_CMD`` or ``VIDIOC_TRY_ENCODER_CMD`` with a pointer to
this structure.

The ``cmd`` field must contain the command code. The ``flags`` field is
currently only used by the STOP command and contains one bit: If the
``V4L2_ENC_CMD_STOP_AT_GOP_END`` flag is set, encoding will continue
until the end of the current *Group Of Pictures*, otherwise it will stop
immediately.

51
A :ref:`read() <func-read>` or :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>`
52
call sends an implicit START command to the encoder if it has not been
53
started yet. After a STOP command, :ref:`read() <func-read>` calls will read
54
the remaining data buffered by the driver. When the buffer is empty,
55
:ref:`read() <func-read>` will return zero and the next :ref:`read() <func-read>`
56 57
call will restart the encoder.

58
A :ref:`close() <func-close>` or :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>`
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
call of a streaming file descriptor sends an implicit immediate STOP to
the encoder, and all buffered data is discarded.

These ioctls are optional, not all drivers may support them. They were
introduced in Linux 2.6.21.


.. _v4l2-encoder-cmd:

.. flat-table:: struct v4l2_encoder_cmd
    :header-rows:  0
    :stub-columns: 0
    :widths:       1 1 2


    -  .. row 1

       -  __u32

       -  ``cmd``

       -  The encoder command, see :ref:`encoder-cmds`.

    -  .. row 2

       -  __u32

       -  ``flags``

       -  Flags to go with the command, see :ref:`encoder-flags`. If no
89 90
	  flags are defined for this command, drivers and applications must
	  set this field to zero.
91 92 93 94 95 96 97 98

    -  .. row 3

       -  __u32

       -  ``data``\ [8]

       -  Reserved for future extensions. Drivers and applications must set
99
	  the array to zero.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117



.. _encoder-cmds:

.. flat-table:: Encoder Commands
    :header-rows:  0
    :stub-columns: 0
    :widths:       3 1 4


    -  .. row 1

       -  ``V4L2_ENC_CMD_START``

       -  0

       -  Start the encoder. When the encoder is already running or paused,
118
	  this command does nothing. No flags are defined for this command.
119 120 121 122 123 124 125 126

    -  .. row 2

       -  ``V4L2_ENC_CMD_STOP``

       -  1

       -  Stop the encoder. When the ``V4L2_ENC_CMD_STOP_AT_GOP_END`` flag
127 128 129 130 131 132 133 134 135 136 137 138
	  is set, encoding will continue until the end of the current *Group
	  Of Pictures*, otherwise encoding will stop immediately. When the
	  encoder is already stopped, this command does nothing. mem2mem
	  encoders will send a ``V4L2_EVENT_EOS`` event when the last frame
	  has been encoded and all frames are ready to be dequeued and will
	  set the ``V4L2_BUF_FLAG_LAST`` buffer flag on the last buffer of
	  the capture queue to indicate there will be no new buffers
	  produced to dequeue. This buffer may be empty, indicated by the
	  driver setting the ``bytesused`` field to 0. Once the
	  ``V4L2_BUF_FLAG_LAST`` flag was set, the
	  :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore,
	  but return an ``EPIPE`` error code.
139 140 141 142 143 144 145 146

    -  .. row 3

       -  ``V4L2_ENC_CMD_PAUSE``

       -  2

       -  Pause the encoder. When the encoder has not been started yet, the
147 148 149
	  driver will return an ``EPERM`` error code. When the encoder is
	  already paused, this command does nothing. No flags are defined
	  for this command.
150 151 152 153 154 155 156 157

    -  .. row 4

       -  ``V4L2_ENC_CMD_RESUME``

       -  3

       -  Resume encoding after a PAUSE command. When the encoder has not
158 159 160
	  been started yet, the driver will return an ``EPERM`` error code. When
	  the encoder is already running, this command does nothing. No
	  flags are defined for this command.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178



.. _encoder-flags:

.. flat-table:: Encoder Command Flags
    :header-rows:  0
    :stub-columns: 0
    :widths:       3 1 4


    -  .. row 1

       -  ``V4L2_ENC_CMD_STOP_AT_GOP_END``

       -  0x0001

       -  Stop encoding at the end of the current *Group Of Pictures*,
179
	  rather than immediately.
180 181


182
RETURN VALUE
183 184 185 186 187 188 189 190 191 192 193 194
============

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.

EINVAL
    The ``cmd`` field is invalid.

EPERM
    The application sent a PAUSE or RESUME command when the encoder was
    not running.