Documentation/media/uapi/v4l/vidioc-query-dv-timings.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_QUERY_DV_TIMINGS:
   4
   5 *****************************
   6 ioctl VIDIOC_QUERY_DV_TIMINGS
   7 *****************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_QUERY_DV_TIMINGS - VIDIOC_SUBDEV_QUERY_DV_TIMINGS - Sense the DV preset received by the current input
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, VIDIOC_QUERY_DV_TIMINGS, struct v4l2_dv_timings *argp )
  19     :name: VIDIOC_QUERY_DV_TIMINGS
  20
  21 .. c:function:: int ioctl( int fd, VIDIOC_SUBDEV_QUERY_DV_TIMINGS, struct v4l2_dv_timings *argp )
  22     :name: VIDIOC_SUBDEV_QUERY_DV_TIMINGS
  23
  24
  25 Arguments
  26 =========
  27
  28 ``fd``
  29     File descriptor returned by :ref:`open() <func-open>`.
  30
  31 ``argp``
  32     Pointer to struct :c:type:`v4l2_dv_timings`.
  33
  34
  35 Description
  36 ===========
  37
  38 The hardware may be able to detect the current DV timings automatically,
  39 similar to sensing the video standard. To do so, applications call
  40 :ref:`VIDIOC_QUERY_DV_TIMINGS` with a pointer to a struct
  41 :c:type:`v4l2_dv_timings`. Once the hardware detects
  42 the timings, it will fill in the timings structure.
  43
  44 .. note::
  45
  46    Drivers shall *not* switch timings automatically if new
  47    timings are detected. Instead, drivers should send the
  48    ``V4L2_EVENT_SOURCE_CHANGE`` event (if they support this) and expect
  49    that userspace will take action by calling :ref:`VIDIOC_QUERY_DV_TIMINGS`.
  50    The reason is that new timings usually mean different buffer sizes as
  51    well, and you cannot change buffer sizes on the fly. In general,
  52    applications that receive the Source Change event will have to call
  53    :ref:`VIDIOC_QUERY_DV_TIMINGS`, and if the detected timings are valid they
  54    will have to stop streaming, set the new timings, allocate new buffers
  55    and start streaming again.
  56
  57 If the timings could not be detected because there was no signal, then
  58 ENOLINK is returned. If a signal was detected, but it was unstable and
  59 the receiver could not lock to the signal, then ``ENOLCK`` is returned. If
  60 the receiver could lock to the signal, but the format is unsupported
  61 (e.g. because the pixelclock is out of range of the hardware
  62 capabilities), then the driver fills in whatever timings it could find
  63 and returns ``ERANGE``. In that case the application can call
  64 :ref:`VIDIOC_DV_TIMINGS_CAP` to compare the
  65 found timings with the hardware's capabilities in order to give more
  66 precise feedback to the user.
  67
  68
  69 Return Value
  70 ============
  71
  72 On success 0 is returned, on error -1 and the ``errno`` variable is set
  73 appropriately. The generic error codes are described at the
  74 :ref:`Generic Error Codes <gen-errors>` chapter.
  75
  76 ENODATA
  77     Digital video timings are not supported for this input or output.
  78
  79 ENOLINK
  80     No timings could be detected because no signal was found.
  81
  82 ENOLCK
  83     The signal was unstable and the hardware could not lock on to it.
  84
  85 ERANGE
  86     Timings were found, but they are out of range of the hardware
  87     capabilities.