Documentation/sound/designs/control-names.rst

   1 ===========================
   2 Standard ALSA Control Names
   3 ===========================
   4
   5 This document describes standard names of mixer controls.
   6
   7 Standard Syntax
   8 ---------------
   9 Syntax: [LOCATION] SOURCE [CHANNEL] [DIRECTION] FUNCTION
  10
  11
  12 DIRECTION
  13 ~~~~~~~~~
  14 ================        ===============
  15 <nothing>               both directions
  16 Playback                one direction
  17 Capture                 one direction
  18 Bypass Playback         one direction
  19 Bypass Capture          one direction
  20 ================        ===============
  21
  22 FUNCTION
  23 ~~~~~~~~
  24 ========        =================================
  25 Switch          on/off switch
  26 Volume          amplifier
  27 Route           route control, hardware specific
  28 ========        =================================
  29
  30 CHANNEL
  31 ~~~~~~~
  32 ============    ==================================================
  33 <nothing>       channel independent, or applies to all channels
  34 Front           front left/right channels
  35 Surround        rear left/right in 4.0/5.1 surround
  36 CLFE            C/LFE channels
  37 Center          center cannel
  38 LFE             LFE channel
  39 Side            side left/right for 7.1 surround
  40 ============    ==================================================
  41
  42 LOCATION (Physical location of source)
  43 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  44 ============    =====================
  45 Front           front position
  46 Rear            rear position
  47 Dock            on docking station
  48 Internal        internal
  49 ============    =====================
  50
  51 SOURCE
  52 ~~~~~~
  53 ===================     =================================================
  54 Master
  55 Master Mono
  56 Hardware Master
  57 Speaker                 internal speaker
  58 Bass Speaker            internal LFE speaker
  59 Headphone
  60 Line Out
  61 Beep                    beep generator
  62 Phone
  63 Phone Input
  64 Phone Output
  65 Synth
  66 FM
  67 Mic
  68 Headset Mic             mic part of combined headset jack - 4-pin
  69                         headphone + mic
  70 Headphone Mic           mic part of either/or - 3-pin headphone or mic
  71 Line                    input only, use "Line Out" for output
  72 CD
  73 Video
  74 Zoom Video
  75 Aux
  76 PCM
  77 PCM Pan
  78 Loopback
  79 Analog Loopback         D/A -> A/D loopback
  80 Digital Loopback        playback -> capture loopback -
  81                         without analog path
  82 Mono
  83 Mono Output
  84 Multi
  85 ADC
  86 Wave
  87 Music
  88 I2S
  89 IEC958
  90 HDMI
  91 SPDIF                   output only
  92 SPDIF In
  93 Digital In
  94 HDMI/DP                 either HDMI or DisplayPort
  95 ===================     =================================================
  96
  97 Exceptions (deprecated)
  98 -----------------------
  99
 100 =====================================   =======================
 101 [Analogue|Digital] Capture Source
 102 [Analogue|Digital] Capture Switch       aka input gain switch
 103 [Analogue|Digital] Capture Volume       aka input gain volume
 104 [Analogue|Digital] Playback Switch      aka output gain switch
 105 [Analogue|Digital] Playback Volume      aka output gain volume
 106 Tone Control - Switch
 107 Tone Control - Bass
 108 Tone Control - Treble
 109 3D Control - Switch
 110 3D Control - Center
 111 3D Control - Depth
 112 3D Control - Wide
 113 3D Control - Space
 114 3D Control - Level
 115 Mic Boost [(?dB)]
 116 =====================================   =======================
 117
 118 PCM interface
 119 -------------
 120
 121 ===================     ========================================
 122 Sample Clock Source     { "Word", "Internal", "AutoSync" }
 123 Clock Sync Status       { "Lock", "Sync", "No Lock" }
 124 External Rate           external capture rate
 125 Capture Rate            capture rate taken from external source
 126 ===================     ========================================
 127
 128 IEC958 (S/PDIF) interface
 129 -------------------------
 130
 131 ============================================    ======================================
 132 IEC958 [...] [Playback|Capture] Switch          turn on/off the IEC958 interface
 133 IEC958 [...] [Playback|Capture] Volume          digital volume control
 134 IEC958 [...] [Playback|Capture] Default         default or global value - read/write
 135 IEC958 [...] [Playback|Capture] Mask            consumer and professional mask
 136 IEC958 [...] [Playback|Capture] Con Mask        consumer mask
 137 IEC958 [...] [Playback|Capture] Pro Mask        professional mask
 138 IEC958 [...] [Playback|Capture] PCM Stream      the settings assigned to a PCM stream
 139 IEC958 Q-subcode [Playback|Capture] Default     Q-subcode bits
 140
 141 IEC958 Preamble [Playback|Capture] Default      burst preamble words (4*16bits)
 142 ============================================    ======================================