^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) .. _fm-rx-controls:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) *****************************
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) FM Receiver Control Reference
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) *****************************
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) The FM Receiver (FM_RX) class includes controls for common features of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) FM Reception capable devices.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) .. _fm-rx-control-id:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) FM_RX Control IDs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) =================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) ``V4L2_CID_FM_RX_CLASS (class)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) The FM_RX class descriptor. Calling
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) :ref:`VIDIOC_QUERYCTRL` for this control will
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) return a description of this control class.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) ``V4L2_CID_RDS_RECEPTION (boolean)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) Enables/disables RDS reception by the radio tuner
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) ``V4L2_CID_RDS_RX_PTY (integer)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) Gets RDS Programme Type field. This encodes up to 31 pre-defined
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) programme types.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) ``V4L2_CID_RDS_RX_PS_NAME (string)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) Gets the Programme Service name (PS_NAME). It is intended for
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) static display on a receiver. It is the primary aid to listeners in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) programme service identification and selection. In Annex E of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) :ref:`iec62106`, the RDS specification, there is a full
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) description of the correct character encoding for Programme Service
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) name strings. Also from RDS specification, PS is usually a single
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) eight character text. However, it is also possible to find receivers
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) which can scroll strings sized as 8 x N characters. So, this control
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) must be configured with steps of 8 characters. The result is it must
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) always contain a string with size multiple of 8.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) ``V4L2_CID_RDS_RX_RADIO_TEXT (string)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) Gets the Radio Text info. It is a textual description of what is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) being broadcasted. RDS Radio Text can be applied when broadcaster
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) wishes to transmit longer PS names, programme-related information or
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) any other text. In these cases, RadioText can be used in addition to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) ``V4L2_CID_RDS_RX_PS_NAME``. The encoding for Radio Text strings is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) also fully described in Annex E of :ref:`iec62106`. The length of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) Radio Text strings depends on which RDS Block is being used to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) transmit it, either 32 (2A block) or 64 (2B block). However, it is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) also possible to find receivers which can scroll strings sized as 32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) x N or 64 x N characters. So, this control must be configured with
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) steps of 32 or 64 characters. The result is it must always contain a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) string with size multiple of 32 or 64.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) ``V4L2_CID_RDS_RX_TRAFFIC_ANNOUNCEMENT (boolean)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) If set, then a traffic announcement is in progress.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) ``V4L2_CID_RDS_RX_TRAFFIC_PROGRAM (boolean)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) If set, then the tuned programme carries traffic announcements.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) ``V4L2_CID_RDS_RX_MUSIC_SPEECH (boolean)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) If set, then this channel broadcasts music. If cleared, then it
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) broadcasts speech. If the transmitter doesn't make this distinction,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) then it will be set.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) ``V4L2_CID_TUNE_DEEMPHASIS``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) (enum)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) enum v4l2_deemphasis -
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) Configures the de-emphasis value for reception. A de-emphasis filter
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) is applied to the broadcast to accentuate the high audio
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) frequencies. Depending on the region, a time constant of either 50
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) or 75 useconds is used. The enum v4l2_deemphasis defines possible
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) values for de-emphasis. Here they are:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) .. flat-table::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) :header-rows: 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) :stub-columns: 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) * - ``V4L2_DEEMPHASIS_DISABLED``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) - No de-emphasis is applied.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) * - ``V4L2_DEEMPHASIS_50_uS``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) - A de-emphasis of 50 uS is used.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) * - ``V4L2_DEEMPHASIS_75_uS``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) - A de-emphasis of 75 uS is used.