xref: /OK3568_Linux_fs/kernel/Documentation/sound/designs/control-names.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun===========================
2*4882a593SmuzhiyunStandard ALSA Control Names
3*4882a593Smuzhiyun===========================
4*4882a593Smuzhiyun
5*4882a593SmuzhiyunThis document describes standard names of mixer controls.
6*4882a593Smuzhiyun
7*4882a593SmuzhiyunStandard Syntax
8*4882a593Smuzhiyun---------------
9*4882a593SmuzhiyunSyntax: [LOCATION] SOURCE [CHANNEL] [DIRECTION] FUNCTION
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun
12*4882a593SmuzhiyunDIRECTION
13*4882a593Smuzhiyun~~~~~~~~~
14*4882a593Smuzhiyun================	===============
15*4882a593Smuzhiyun<nothing>		both directions
16*4882a593SmuzhiyunPlayback		one direction
17*4882a593SmuzhiyunCapture			one direction
18*4882a593SmuzhiyunBypass Playback		one direction
19*4882a593SmuzhiyunBypass Capture		one direction
20*4882a593Smuzhiyun================	===============
21*4882a593Smuzhiyun
22*4882a593SmuzhiyunFUNCTION
23*4882a593Smuzhiyun~~~~~~~~
24*4882a593Smuzhiyun========	=================================
25*4882a593SmuzhiyunSwitch		on/off switch
26*4882a593SmuzhiyunVolume		amplifier
27*4882a593SmuzhiyunRoute		route control, hardware specific
28*4882a593Smuzhiyun========	=================================
29*4882a593Smuzhiyun
30*4882a593SmuzhiyunCHANNEL
31*4882a593Smuzhiyun~~~~~~~
32*4882a593Smuzhiyun============	==================================================
33*4882a593Smuzhiyun<nothing>	channel independent, or applies to all channels
34*4882a593SmuzhiyunFront		front left/right channels
35*4882a593SmuzhiyunSurround	rear left/right in 4.0/5.1 surround
36*4882a593SmuzhiyunCLFE		C/LFE channels
37*4882a593SmuzhiyunCenter		center cannel
38*4882a593SmuzhiyunLFE		LFE channel
39*4882a593SmuzhiyunSide		side left/right for 7.1 surround
40*4882a593Smuzhiyun============	==================================================
41*4882a593Smuzhiyun
42*4882a593SmuzhiyunLOCATION (Physical location of source)
43*4882a593Smuzhiyun~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
44*4882a593Smuzhiyun============	=====================
45*4882a593SmuzhiyunFront		front position
46*4882a593SmuzhiyunRear		rear position
47*4882a593SmuzhiyunDock		on docking station
48*4882a593SmuzhiyunInternal	internal
49*4882a593Smuzhiyun============	=====================
50*4882a593Smuzhiyun
51*4882a593SmuzhiyunSOURCE
52*4882a593Smuzhiyun~~~~~~
53*4882a593Smuzhiyun===================	=================================================
54*4882a593SmuzhiyunMaster
55*4882a593SmuzhiyunMaster Mono
56*4882a593SmuzhiyunHardware Master
57*4882a593SmuzhiyunSpeaker			internal speaker
58*4882a593SmuzhiyunBass Speaker		internal LFE speaker
59*4882a593SmuzhiyunHeadphone
60*4882a593SmuzhiyunLine Out
61*4882a593SmuzhiyunBeep			beep generator
62*4882a593SmuzhiyunPhone
63*4882a593SmuzhiyunPhone Input
64*4882a593SmuzhiyunPhone Output
65*4882a593SmuzhiyunSynth
66*4882a593SmuzhiyunFM
67*4882a593SmuzhiyunMic
68*4882a593SmuzhiyunHeadset Mic		mic part of combined headset jack - 4-pin
69*4882a593Smuzhiyun			headphone + mic
70*4882a593SmuzhiyunHeadphone Mic		mic part of either/or - 3-pin headphone or mic
71*4882a593SmuzhiyunLine			input only, use "Line Out" for output
72*4882a593SmuzhiyunCD
73*4882a593SmuzhiyunVideo
74*4882a593SmuzhiyunZoom Video
75*4882a593SmuzhiyunAux
76*4882a593SmuzhiyunPCM
77*4882a593SmuzhiyunPCM Pan
78*4882a593SmuzhiyunLoopback
79*4882a593SmuzhiyunAnalog Loopback		D/A -> A/D loopback
80*4882a593SmuzhiyunDigital Loopback	playback -> capture loopback -
81*4882a593Smuzhiyun			without analog path
82*4882a593SmuzhiyunMono
83*4882a593SmuzhiyunMono Output
84*4882a593SmuzhiyunMulti
85*4882a593SmuzhiyunADC
86*4882a593SmuzhiyunWave
87*4882a593SmuzhiyunMusic
88*4882a593SmuzhiyunI2S
89*4882a593SmuzhiyunIEC958
90*4882a593SmuzhiyunHDMI
91*4882a593SmuzhiyunSPDIF			output only
92*4882a593SmuzhiyunSPDIF In
93*4882a593SmuzhiyunDigital In
94*4882a593SmuzhiyunHDMI/DP			either HDMI or DisplayPort
95*4882a593Smuzhiyun===================	=================================================
96*4882a593Smuzhiyun
97*4882a593SmuzhiyunExceptions (deprecated)
98*4882a593Smuzhiyun-----------------------
99*4882a593Smuzhiyun
100*4882a593Smuzhiyun=====================================	=======================
101*4882a593Smuzhiyun[Analogue|Digital] Capture Source
102*4882a593Smuzhiyun[Analogue|Digital] Capture Switch	aka input gain switch
103*4882a593Smuzhiyun[Analogue|Digital] Capture Volume	aka input gain volume
104*4882a593Smuzhiyun[Analogue|Digital] Playback Switch	aka output gain switch
105*4882a593Smuzhiyun[Analogue|Digital] Playback Volume	aka output gain volume
106*4882a593SmuzhiyunTone Control - Switch
107*4882a593SmuzhiyunTone Control - Bass
108*4882a593SmuzhiyunTone Control - Treble
109*4882a593Smuzhiyun3D Control - Switch
110*4882a593Smuzhiyun3D Control - Center
111*4882a593Smuzhiyun3D Control - Depth
112*4882a593Smuzhiyun3D Control - Wide
113*4882a593Smuzhiyun3D Control - Space
114*4882a593Smuzhiyun3D Control - Level
115*4882a593SmuzhiyunMic Boost [(?dB)]
116*4882a593Smuzhiyun=====================================	=======================
117*4882a593Smuzhiyun
118*4882a593SmuzhiyunPCM interface
119*4882a593Smuzhiyun-------------
120*4882a593Smuzhiyun
121*4882a593Smuzhiyun===================	========================================
122*4882a593SmuzhiyunSample Clock Source	{ "Word", "Internal", "AutoSync" }
123*4882a593SmuzhiyunClock Sync Status	{ "Lock", "Sync", "No Lock" }
124*4882a593SmuzhiyunExternal Rate		external capture rate
125*4882a593SmuzhiyunCapture Rate		capture rate taken from external source
126*4882a593Smuzhiyun===================	========================================
127*4882a593Smuzhiyun
128*4882a593SmuzhiyunIEC958 (S/PDIF) interface
129*4882a593Smuzhiyun-------------------------
130*4882a593Smuzhiyun
131*4882a593Smuzhiyun============================================	======================================
132*4882a593SmuzhiyunIEC958 [...] [Playback|Capture] Switch		turn on/off the IEC958 interface
133*4882a593SmuzhiyunIEC958 [...] [Playback|Capture] Volume		digital volume control
134*4882a593SmuzhiyunIEC958 [...] [Playback|Capture] Default		default or global value - read/write
135*4882a593SmuzhiyunIEC958 [...] [Playback|Capture] Mask		consumer and professional mask
136*4882a593SmuzhiyunIEC958 [...] [Playback|Capture] Con Mask	consumer mask
137*4882a593SmuzhiyunIEC958 [...] [Playback|Capture] Pro Mask	professional mask
138*4882a593SmuzhiyunIEC958 [...] [Playback|Capture] PCM Stream	the settings assigned to a PCM stream
139*4882a593SmuzhiyunIEC958 Q-subcode [Playback|Capture] Default	Q-subcode bits
140*4882a593Smuzhiyun
141*4882a593SmuzhiyunIEC958 Preamble [Playback|Capture] Default	burst preamble words (4*16bits)
142*4882a593Smuzhiyun============================================	======================================
143