Documentation/media/uapi/v4l/vidioc-enum-frameintervals.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_ENUM_FRAMEINTERVALS:
   4
   5 ********************************
   6 ioctl VIDIOC_ENUM_FRAMEINTERVALS
   7 ********************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_ENUM_FRAMEINTERVALS - Enumerate frame intervals
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmivalenum *argp )
  19
  20
  21 Arguments
  22 =========
  23
  24 ``fd``
  25     File descriptor returned by :ref:`open() <func-open>`.
  26
  27 ``request``
  28     VIDIOC_ENUM_FRAMEINTERVALS
  29
  30 ``argp``
  31     Pointer to a struct :ref:`v4l2_frmivalenum <v4l2-frmivalenum>`
  32     structure that contains a pixel format and size and receives a frame
  33     interval.
  34
  35
  36 Description
  37 ===========
  38
  39 This ioctl allows applications to enumerate all frame intervals that the
  40 device supports for the given pixel format and frame size.
  41
  42 The supported pixel formats and frame sizes can be obtained by using the
  43 :ref:`VIDIOC_ENUM_FMT` and
  44 :ref:`VIDIOC_ENUM_FRAMESIZES` functions.
  45
  46 The return value and the content of the ``v4l2_frmivalenum.type`` field
  47 depend on the type of frame intervals the device supports. Here are the
  48 semantics of the function for the different cases:
  49
  50 -  **Discrete:** The function returns success if the given index value
  51    (zero-based) is valid. The application should increase the index by
  52    one for each call until ``EINVAL`` is returned. The
  53    `v4l2_frmivalenum.type` field is set to
  54    `V4L2_FRMIVAL_TYPE_DISCRETE` by the driver. Of the union only
  55    the `discrete` member is valid.
  56
  57 -  **Step-wise:** The function returns success if the given index value
  58    is zero and ``EINVAL`` for any other index value. The
  59    ``v4l2_frmivalenum.type`` field is set to
  60    ``V4L2_FRMIVAL_TYPE_STEPWISE`` by the driver. Of the union only the
  61    ``stepwise`` member is valid.
  62
  63 -  **Continuous:** This is a special case of the step-wise type above.
  64    The function returns success if the given index value is zero and
  65    ``EINVAL`` for any other index value. The ``v4l2_frmivalenum.type``
  66    field is set to ``V4L2_FRMIVAL_TYPE_CONTINUOUS`` by the driver. Of
  67    the union only the ``stepwise`` member is valid and the ``step``
  68    value is set to 1.
  69
  70 When the application calls the function with index zero, it must check
  71 the ``type`` field to determine the type of frame interval enumeration
  72 the device supports. Only for the ``V4L2_FRMIVAL_TYPE_DISCRETE`` type
  73 does it make sense to increase the index value to receive more frame
  74 intervals.
  75
  76 .. note::
  77
  78    The order in which the frame intervals are returned has no
  79    special meaning. In particular does it not say anything about potential
  80    default frame intervals.
  81
  82 Applications can assume that the enumeration data does not change
  83 without any interaction from the application itself. This means that the
  84 enumeration data is consistent if the application does not perform any
  85 other ioctl calls while it runs the frame interval enumeration.
  86
  87 .. note::
  88
  89    **Frame intervals and frame rates:** The V4L2 API uses frame
  90    intervals instead of frame rates. Given the frame interval the frame
  91    rate can be computed as follows:
  92
  93    ::
  94
  95        frame_rate = 1 / frame_interval
  96
  97
  98 Structs
  99 =======
 100
 101 In the structs below, *IN* denotes a value that has to be filled in by
 102 the application, *OUT* denotes values that the driver fills in. The
 103 application should zero out all members except for the *IN* fields.
 104
 105
 106 .. _v4l2-frmival-stepwise:
 107
 108 .. flat-table:: struct v4l2_frmival_stepwise
 109     :header-rows:  0
 110     :stub-columns: 0
 111     :widths:       1 1 2
 112
 113
 114     -  .. row 1
 115
 116        -  struct :ref:`v4l2_fract <v4l2-fract>`
 117
 118        -  ``min``
 119
 120        -  Minimum frame interval [s].
 121
 122     -  .. row 2
 123
 124        -  struct :ref:`v4l2_fract <v4l2-fract>`
 125
 126        -  ``max``
 127
 128        -  Maximum frame interval [s].
 129
 130     -  .. row 3
 131
 132        -  struct :ref:`v4l2_fract <v4l2-fract>`
 133
 134        -  ``step``
 135
 136        -  Frame interval step size [s].
 137
 138
 139
 140 .. _v4l2-frmivalenum:
 141
 142 .. flat-table:: struct v4l2_frmivalenum
 143     :header-rows:  0
 144     :stub-columns: 0
 145
 146
 147     -  .. row 1
 148
 149        -  __u32
 150
 151        -  ``index``
 152
 153        -
 154        -  IN: Index of the given frame interval in the enumeration.
 155
 156     -  .. row 2
 157
 158        -  __u32
 159
 160        -  ``pixel_format``
 161
 162        -
 163        -  IN: Pixel format for which the frame intervals are enumerated.
 164
 165     -  .. row 3
 166
 167        -  __u32
 168
 169        -  ``width``
 170
 171        -
 172        -  IN: Frame width for which the frame intervals are enumerated.
 173
 174     -  .. row 4
 175
 176        -  __u32
 177
 178        -  ``height``
 179
 180        -
 181        -  IN: Frame height for which the frame intervals are enumerated.
 182
 183     -  .. row 5
 184
 185        -  __u32
 186
 187        -  ``type``
 188
 189        -
 190        -  OUT: Frame interval type the device supports.
 191
 192     -  .. row 6
 193
 194        -  union
 195
 196        -
 197        -
 198        -  OUT: Frame interval with the given index.
 199
 200     -  .. row 7
 201
 202        -
 203        -  struct :ref:`v4l2_fract <v4l2-fract>`
 204
 205        -  ``discrete``
 206
 207        -  Frame interval [s].
 208
 209     -  .. row 8
 210
 211        -
 212        -  struct :ref:`v4l2_frmival_stepwise <v4l2-frmival-stepwise>`
 213
 214        -  ``stepwise``
 215
 216        -
 217
 218     -  .. row 9
 219
 220        -  __u32
 221
 222        -  ``reserved[2]``
 223
 224        -
 225        -  Reserved space for future use. Must be zeroed by drivers and
 226           applications.
 227
 228
 229
 230 Enums
 231 =====
 232
 233
 234 .. _v4l2-frmivaltypes:
 235
 236 .. flat-table:: enum v4l2_frmivaltypes
 237     :header-rows:  0
 238     :stub-columns: 0
 239     :widths:       3 1 4
 240
 241
 242     -  .. row 1
 243
 244        -  ``V4L2_FRMIVAL_TYPE_DISCRETE``
 245
 246        -  1
 247
 248        -  Discrete frame interval.
 249
 250     -  .. row 2
 251
 252        -  ``V4L2_FRMIVAL_TYPE_CONTINUOUS``
 253
 254        -  2
 255
 256        -  Continuous frame interval.
 257
 258     -  .. row 3
 259
 260        -  ``V4L2_FRMIVAL_TYPE_STEPWISE``
 261
 262        -  3
 263
 264        -  Step-wise defined frame interval.
 265
 266
 267 Return Value
 268 ============
 269
 270 On success 0 is returned, on error -1 and the ``errno`` variable is set
 271 appropriately. The generic error codes are described at the
 272 :ref:`Generic Error Codes <gen-errors>` chapter.