Documentation/media/uapi/dvb/dmx-get-stc.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _DMX_GET_STC:
  11
  12 ===========
  13 DMX_GET_STC
  14 ===========
  15
  16 Name
  17 ----
  18
  19 DMX_GET_STC
  20
  21
  22 Synopsis
  23 --------
  24
  25 .. c:function:: int ioctl( int fd, DMX_GET_STC, struct dmx_stc *stc)
  26     :name: DMX_GET_STC
  27
  28 Arguments
  29 ---------
  30
  31 ``fd``
  32     File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
  33
  34 ``stc``
  35     Pointer to :c:type:`dmx_stc` where the stc data is to be stored.
  36
  37
  38 Description
  39 -----------
  40
  41 This ioctl call returns the current value of the system time counter
  42 (which is driven by a PES filter of type :c:type:`DMX_PES_PCR <dmx_ts_pes>`).
  43 Some hardware supports more than one STC, so you must specify which one by
  44 setting the :c:type:`num <dmx_stc>` field of stc before the ioctl (range 0...n).
  45 The result is returned in form of a ratio with a 64 bit numerator
  46 and a 32 bit denominator, so the real 90kHz STC value is
  47 ``stc->stc / stc->base``.
  48
  49
  50 Return Value
  51 ------------
  52
  53 On success 0 is returned.
  54
  55 On error -1 is returned, and the ``errno`` variable is set
  56 appropriately.
  57
  58 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
  59
  60 .. flat-table::
  61     :header-rows:  0
  62     :stub-columns: 0
  63     :widths: 1 16
  64
  65     -  .. row 1
  66
  67        -  ``EINVAL``
  68
  69        -  Invalid stc number.
  70
  71
  72 The generic error codes are described at the
  73 :ref:`Generic Error Codes <gen-errors>` chapter.