media/v4l/vidioc-g-sliced-vbi-cap.rst

1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
13 VIDIOC_G_SLICED_VBI_CAP - Query sliced VBI capabilities
43    The ``type`` field was added, and the ioctl changed from read-only
44    to write-read, in Linux 2.6.19.
50 .. flat-table:: struct v4l2_sliced_vbi_cap
51     :header-rows:  0
52     :stub-columns: 0
55     * - __u16
56       - ``service_set``
57       - :cspan:`2` A set of all data services supported by the driver.
60     * - __u16
61       - ``service_lines``\ [2][24]
62       - :cspan:`2` Each element of this array contains a set of data
64 	scan line. Data services are defined in :ref:`vbi-services`.
65 	Array indices map to ITU-R line numbers\ [#f1]_ as follows:
66     * -
67       -
68       - Element
69       - 525 line systems
70       - 625 line systems
71     * -
72       -
73       - ``service_lines``\ [0][1]
74       - 1
75       - 1
76     * -
77       -
78       - ``service_lines``\ [0][23]
79       - 23
80       - 23
81     * -
82       -
83       - ``service_lines``\ [1][1]
84       - 264
85       - 314
86     * -
87       -
88       - ``service_lines``\ [1][23]
89       - 286
90       - 336
91     * -
92     * -
93       -
94       - :cspan:`2` The number of VBI lines the hardware can capture or
101     * -
102     * -
103       -
104       - :cspan:`2` Drivers must set ``service_lines`` [0][0] and
106     * - __u32
107       - ``type``
108       - Type of the data stream, see :c:type:`v4l2_buf_type`. Should be
111     * - __u32
112       - ``reserved``\ [3]
113       - :cspan:`2` This array is reserved for future extensions.
119    See also :ref:`vbi-525` and :ref:`vbi-625`.
127 .. _vbi-services:
129 .. flat-table:: Sliced VBI services
130     :header-rows:  1
131     :stub-columns: 0
134     * - Symbol
135       - Value
136       - Reference
137       - Lines, usually
138       - Payload
139     * - ``V4L2_SLICED_TELETEXT_B`` (Teletext System B)
140       - 0x0001
141       - :ref:`ets300706`,
144       - PAL/SECAM line 7-22, 320-335 (second field 7-22)
145       - Last 42 of the 45 byte Teletext packet, that is without clock
146 	run-in and framing code, lsb first transmitted.
147     * - ``V4L2_SLICED_VPS``
148       - 0x0400
149       - :ref:`ets300231`
150       - PAL line 16
151       - Byte number 3 to 15 according to Figure 9 of ETS 300 231, lsb
152 	first transmitted.
153     * - ``V4L2_SLICED_CAPTION_525``
154       - 0x1000
155       - :ref:`cea608`
156       - NTSC line 21, 284 (second field 21)
157       - Two bytes in transmission order, including parity bit, lsb first
159     * - ``V4L2_SLICED_WSS_625``
160       - 0x4000
161       - :ref:`en300294`,
164       - PAL/SECAM line 23
165       - See :ref:`v4l2-sliced-vbi-cap-wss-625-payload` below.
166     * - ``V4L2_SLICED_VBI_525``
167       - 0x1000
168       - :cspan:`2` Set of services applicable to 525 line systems.
169     * - ``V4L2_SLICED_VBI_625``
170       - 0x4401
171       - :cspan:`2` Set of services applicable to 625 line systems.
178 .. _v4l2-sliced-vbi-cap-wss-625-payload:
185 	    +-----+------------------+-----------------------+
187 	    +-----+--------+---------+-----------+-----------+
188 	    |     | msb    | lsb     | msb       | lsb       |
189 	    |     +-+-+-+--+--+-+-+--+--+-+--+---+---+--+-+--+
191 	    +-----+-+-+-+--+--+-+-+--+--+-+--+---+---+--+-+--+
197 On success 0 is returned, on error -1 and the ``errno`` variable is set
199 :ref:`Generic Error Codes <gen-errors>` chapter.