Documentation/media/uapi/v4l/vidioc-g-fmt.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_G_FMT:
   4
   5 ************************************************
   6 ioctl VIDIOC_G_FMT, VIDIOC_S_FMT, VIDIOC_TRY_FMT
   7 ************************************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_G_FMT - VIDIOC_S_FMT - VIDIOC_TRY_FMT - Get or set the data format, try a format
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, struct v4l2_format *argp )
  19
  20
  21 Arguments
  22 =========
  23
  24 ``fd``
  25     File descriptor returned by :ref:`open() <func-open>`.
  26
  27 ``request``
  28     VIDIOC_G_FMT, VIDIOC_S_FMT, VIDIOC_TRY_FMT
  29
  30 ``argp``
  31
  32
  33 Description
  34 ===========
  35
  36 These ioctls are used to negotiate the format of data (typically image
  37 format) exchanged between driver and application.
  38
  39 To query the current parameters applications set the ``type`` field of a
  40 struct :ref:`struct v4l2_format <v4l2-format>` to the respective buffer (stream)
  41 type. For example video capture devices use
  42 ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` or
  43 ``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE``. When the application calls the
  44 :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl with a pointer to this structure the driver fills
  45 the respective member of the ``fmt`` union. In case of video capture
  46 devices that is either the struct
  47 :ref:`v4l2_pix_format <v4l2-pix-format>` ``pix`` or the struct
  48 :ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` ``pix_mp``
  49 member. When the requested buffer type is not supported drivers return
  50 an ``EINVAL`` error code.
  51
  52 To change the current format parameters applications initialize the
  53 ``type`` field and all fields of the respective ``fmt`` union member.
  54 For details see the documentation of the various devices types in
  55 :ref:`devices`. Good practice is to query the current parameters
  56 first, and to modify only those parameters not suitable for the
  57 application. When the application calls the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl with
  58 a pointer to a :ref:`struct v4l2_format <v4l2-format>` structure the driver
  59 checks and adjusts the parameters against hardware abilities. Drivers
  60 should not return an error code unless the ``type`` field is invalid,
  61 this is a mechanism to fathom device capabilities and to approach
  62 parameters acceptable for both the application and driver. On success
  63 the driver may program the hardware, allocate resources and generally
  64 prepare for data exchange. Finally the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl returns
  65 the current format parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does. Very simple,
  66 inflexible devices may even ignore all input and always return the
  67 default parameters. However all V4L2 devices exchanging data with the
  68 application must implement the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
  69 ioctl. When the requested buffer type is not supported drivers return an
  70 EINVAL error code on a :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` attempt. When I/O is already in
  71 progress or the resource is not available for other reasons drivers
  72 return the ``EBUSY`` error code.
  73
  74 The :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl is equivalent to :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` with one
  75 exception: it does not change driver state. It can also be called at any
  76 time, never returning ``EBUSY``. This function is provided to negotiate
  77 parameters, to learn about hardware limitations, without disabling I/O
  78 or possibly time consuming hardware preparations. Although strongly
  79 recommended drivers are not required to implement this ioctl.
  80
  81 The format as returned by :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` must be identical to what
  82 :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` returns for the same input or output.
  83
  84
  85 .. _v4l2-format:
  86
  87 .. tabularcolumns::  |p{1.2cm}|p{4.3cm}|p{3.0cm}|p{9.0cm}|
  88
  89 .. flat-table:: struct v4l2_format
  90     :header-rows:  0
  91     :stub-columns: 0
  92
  93
  94     -  .. row 1
  95
  96        -  __u32
  97
  98        -  ``type``
  99
 100        -
 101        -  Type of the data stream, see :ref:`v4l2-buf-type`.
 102
 103     -  .. row 2
 104
 105        -  union
 106
 107        -  ``fmt``
 108
 109     -  .. row 3
 110
 111        -
 112        -  struct :ref:`v4l2_pix_format <v4l2-pix-format>`
 113
 114        -  ``pix``
 115
 116        -  Definition of an image format, see :ref:`pixfmt`, used by video
 117           capture and output devices.
 118
 119     -  .. row 4
 120
 121        -
 122        -  struct :ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>`
 123
 124        -  ``pix_mp``
 125
 126        -  Definition of an image format, see :ref:`pixfmt`, used by video
 127           capture and output devices that support the
 128           :ref:`multi-planar version of the API <planar-apis>`.
 129
 130     -  .. row 5
 131
 132        -
 133        -  struct :ref:`v4l2_window <v4l2-window>`
 134
 135        -  ``win``
 136
 137        -  Definition of an overlaid image, see :ref:`overlay`, used by
 138           video overlay devices.
 139
 140     -  .. row 6
 141
 142        -
 143        -  struct :ref:`v4l2_vbi_format <v4l2-vbi-format>`
 144
 145        -  ``vbi``
 146
 147        -  Raw VBI capture or output parameters. This is discussed in more
 148           detail in :ref:`raw-vbi`. Used by raw VBI capture and output
 149           devices.
 150
 151     -  .. row 7
 152
 153        -
 154        -  struct :ref:`v4l2_sliced_vbi_format <v4l2-sliced-vbi-format>`
 155
 156        -  ``sliced``
 157
 158        -  Sliced VBI capture or output parameters. See :ref:`sliced` for
 159           details. Used by sliced VBI capture and output devices.
 160
 161     -  .. row 8
 162
 163        -
 164        -  struct :ref:`v4l2_sdr_format <v4l2-sdr-format>`
 165
 166        -  ``sdr``
 167
 168        -  Definition of a data format, see :ref:`pixfmt`, used by SDR
 169           capture and output devices.
 170
 171     -  .. row 9
 172
 173        -
 174        -  __u8
 175
 176        -  ``raw_data``\ [200]
 177
 178        -  Place holder for future extensions.
 179
 180
 181 Return Value
 182 ============
 183
 184 On success 0 is returned, on error -1 and the ``errno`` variable is set
 185 appropriately. The generic error codes are described at the
 186 :ref:`Generic Error Codes <gen-errors>` chapter.
 187
 188 EINVAL
 189     The struct :ref:`v4l2_format <v4l2-format>` ``type`` field is
 190     invalid or the requested buffer type not supported.