xref: /linux/Documentation/sound/designs/control-names.rst (revision 5a481fe309e79df2e713d7ea32175f121b251069)
1*5a481fe3STakashi Iwai===========================
2*5a481fe3STakashi IwaiStandard ALSA Control Names
3*5a481fe3STakashi Iwai===========================
4*5a481fe3STakashi Iwai
5*5a481fe3STakashi IwaiThis document describes standard names of mixer controls.
6*5a481fe3STakashi Iwai
7*5a481fe3STakashi IwaiStandard Syntax
8*5a481fe3STakashi Iwai---------------
9*5a481fe3STakashi IwaiSyntax: [LOCATION] SOURCE [CHANNEL] [DIRECTION] FUNCTION
10*5a481fe3STakashi Iwai
11*5a481fe3STakashi Iwai
12*5a481fe3STakashi IwaiDIRECTION
13*5a481fe3STakashi Iwai~~~~~~~~~
14*5a481fe3STakashi Iwai================	===============
15*5a481fe3STakashi Iwai<nothing>		both directions
16*5a481fe3STakashi IwaiPlayback		one direction
17*5a481fe3STakashi IwaiCapture			one direction
18*5a481fe3STakashi IwaiBypass Playback		one direction
19*5a481fe3STakashi IwaiBypass Capture		one direction
20*5a481fe3STakashi Iwai================	===============
21*5a481fe3STakashi Iwai
22*5a481fe3STakashi IwaiFUNCTION
23*5a481fe3STakashi Iwai~~~~~~~~
24*5a481fe3STakashi Iwai========	=================================
25*5a481fe3STakashi IwaiSwitch		on/off switch
26*5a481fe3STakashi IwaiVolume		amplifier
27*5a481fe3STakashi IwaiRoute		route control, hardware specific
28*5a481fe3STakashi Iwai========	=================================
29*5a481fe3STakashi Iwai
30*5a481fe3STakashi IwaiCHANNEL
31*5a481fe3STakashi Iwai~~~~~~~
32*5a481fe3STakashi Iwai============	==================================================
33*5a481fe3STakashi Iwai<nothing>	channel independent, or applies to all channels
34*5a481fe3STakashi IwaiFront		front left/right channels
35*5a481fe3STakashi IwaiSurround	rear left/right in 4.0/5.1 surround
36*5a481fe3STakashi IwaiCLFE		C/LFE channels
37*5a481fe3STakashi IwaiCenter		center cannel
38*5a481fe3STakashi IwaiLFE		LFE channel
39*5a481fe3STakashi IwaiSide		side left/right for 7.1 surround
40*5a481fe3STakashi Iwai============	==================================================
41*5a481fe3STakashi Iwai
42*5a481fe3STakashi IwaiLOCATION (Physical location of source)
43*5a481fe3STakashi Iwai~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
44*5a481fe3STakashi Iwai============	=====================
45*5a481fe3STakashi IwaiFront		front position
46*5a481fe3STakashi IwaiRear		rear position
47*5a481fe3STakashi IwaiDock		on docking station
48*5a481fe3STakashi IwaiInternal	internal
49*5a481fe3STakashi Iwai============	=====================
50*5a481fe3STakashi Iwai
51*5a481fe3STakashi IwaiSOURCE
52*5a481fe3STakashi Iwai~~~~~~
53*5a481fe3STakashi Iwai===================	=================================================
54*5a481fe3STakashi IwaiMaster
55*5a481fe3STakashi IwaiMaster Mono
56*5a481fe3STakashi IwaiHardware Master
57*5a481fe3STakashi IwaiSpeaker			internal speaker
58*5a481fe3STakashi IwaiBass Speaker		internal LFE speaker
59*5a481fe3STakashi IwaiHeadphone
60*5a481fe3STakashi IwaiLine Out
61*5a481fe3STakashi IwaiBeep			beep generator
62*5a481fe3STakashi IwaiPhone
63*5a481fe3STakashi IwaiPhone Input
64*5a481fe3STakashi IwaiPhone Output
65*5a481fe3STakashi IwaiSynth
66*5a481fe3STakashi IwaiFM
67*5a481fe3STakashi IwaiMic
68*5a481fe3STakashi IwaiHeadset Mic		mic part of combined headset jack - 4-pin
69*5a481fe3STakashi Iwai			headphone + mic
70*5a481fe3STakashi IwaiHeadphone Mic		mic part of either/or - 3-pin headphone or mic
71*5a481fe3STakashi IwaiLine			input only, use "Line Out" for output
72*5a481fe3STakashi IwaiCD
73*5a481fe3STakashi IwaiVideo
74*5a481fe3STakashi IwaiZoom Video
75*5a481fe3STakashi IwaiAux
76*5a481fe3STakashi IwaiPCM
77*5a481fe3STakashi IwaiPCM Pan
78*5a481fe3STakashi IwaiLoopback
79*5a481fe3STakashi IwaiAnalog Loopback		D/A -> A/D loopback
80*5a481fe3STakashi IwaiDigital Loopback	playback -> capture loopback -
81*5a481fe3STakashi Iwai			without analog path
82*5a481fe3STakashi IwaiMono
83*5a481fe3STakashi IwaiMono Output
84*5a481fe3STakashi IwaiMulti
85*5a481fe3STakashi IwaiADC
86*5a481fe3STakashi IwaiWave
87*5a481fe3STakashi IwaiMusic
88*5a481fe3STakashi IwaiI2S
89*5a481fe3STakashi IwaiIEC958
90*5a481fe3STakashi IwaiHDMI
91*5a481fe3STakashi IwaiSPDIF			output only
92*5a481fe3STakashi IwaiSPDIF In
93*5a481fe3STakashi IwaiDigital In
94*5a481fe3STakashi IwaiHDMI/DP			either HDMI or DisplayPort
95*5a481fe3STakashi Iwai===================	=================================================
96*5a481fe3STakashi Iwai
97*5a481fe3STakashi IwaiExceptions (deprecated)
98*5a481fe3STakashi Iwai-----------------------
99*5a481fe3STakashi Iwai
100*5a481fe3STakashi Iwai=====================================	=======================
101*5a481fe3STakashi Iwai[Analogue|Digital] Capture Source
102*5a481fe3STakashi Iwai[Analogue|Digital] Capture Switch	aka input gain switch
103*5a481fe3STakashi Iwai[Analogue|Digital] Capture Volume	aka input gain volume
104*5a481fe3STakashi Iwai[Analogue|Digital] Playback Switch	aka output gain switch
105*5a481fe3STakashi Iwai[Analogue|Digital] Playback Volume	aka output gain volume
106*5a481fe3STakashi IwaiTone Control - Switch
107*5a481fe3STakashi IwaiTone Control - Bass
108*5a481fe3STakashi IwaiTone Control - Treble
109*5a481fe3STakashi Iwai3D Control - Switch
110*5a481fe3STakashi Iwai3D Control - Center
111*5a481fe3STakashi Iwai3D Control - Depth
112*5a481fe3STakashi Iwai3D Control - Wide
113*5a481fe3STakashi Iwai3D Control - Space
114*5a481fe3STakashi Iwai3D Control - Level
115*5a481fe3STakashi IwaiMic Boost [(?dB)]
116*5a481fe3STakashi Iwai=====================================	=======================
117*5a481fe3STakashi Iwai
118*5a481fe3STakashi IwaiPCM interface
119*5a481fe3STakashi Iwai-------------
120*5a481fe3STakashi Iwai
121*5a481fe3STakashi Iwai===================	========================================
122*5a481fe3STakashi IwaiSample Clock Source	{ "Word", "Internal", "AutoSync" }
123*5a481fe3STakashi IwaiClock Sync Status	{ "Lock", "Sync", "No Lock" }
124*5a481fe3STakashi IwaiExternal Rate		external capture rate
125*5a481fe3STakashi IwaiCapture Rate		capture rate taken from external source
126*5a481fe3STakashi Iwai===================	========================================
127*5a481fe3STakashi Iwai
128*5a481fe3STakashi IwaiIEC958 (S/PDIF) interface
129*5a481fe3STakashi Iwai-------------------------
130*5a481fe3STakashi Iwai
131*5a481fe3STakashi Iwai============================================	======================================
132*5a481fe3STakashi IwaiIEC958 [...] [Playback|Capture] Switch		turn on/off the IEC958 interface
133*5a481fe3STakashi IwaiIEC958 [...] [Playback|Capture] Volume		digital volume control
134*5a481fe3STakashi IwaiIEC958 [...] [Playback|Capture] Default		default or global value - read/write
135*5a481fe3STakashi IwaiIEC958 [...] [Playback|Capture] Mask		consumer and professional mask
136*5a481fe3STakashi IwaiIEC958 [...] [Playback|Capture] Con Mask	consumer mask
137*5a481fe3STakashi IwaiIEC958 [...] [Playback|Capture] Pro Mask	professional mask
138*5a481fe3STakashi IwaiIEC958 [...] [Playback|Capture] PCM Stream	the settings assigned to a PCM stream
139*5a481fe3STakashi IwaiIEC958 Q-subcode [Playback|Capture] Default	Q-subcode bits
140*5a481fe3STakashi Iwai
141*5a481fe3STakashi IwaiIEC958 Preamble [Playback|Capture] Default	burst preamble words (4*16bits)
142*5a481fe3STakashi Iwai============================================	======================================
143