xref: /linux/Documentation/sound/designs/control-names.rst (revision 4f2c0a4acffbec01079c28f839422e64ddeff004)
15a481fe3STakashi Iwai===========================
25a481fe3STakashi IwaiStandard ALSA Control Names
35a481fe3STakashi Iwai===========================
45a481fe3STakashi Iwai
55a481fe3STakashi IwaiThis document describes standard names of mixer controls.
65a481fe3STakashi Iwai
75a481fe3STakashi IwaiStandard Syntax
85a481fe3STakashi Iwai---------------
95a481fe3STakashi IwaiSyntax: [LOCATION] SOURCE [CHANNEL] [DIRECTION] FUNCTION
105a481fe3STakashi Iwai
115a481fe3STakashi Iwai
125a481fe3STakashi IwaiDIRECTION
135a481fe3STakashi Iwai~~~~~~~~~
145a481fe3STakashi Iwai================	===============
155a481fe3STakashi Iwai<nothing>		both directions
165a481fe3STakashi IwaiPlayback		one direction
175a481fe3STakashi IwaiCapture			one direction
185a481fe3STakashi IwaiBypass Playback		one direction
195a481fe3STakashi IwaiBypass Capture		one direction
205a481fe3STakashi Iwai================	===============
215a481fe3STakashi Iwai
225a481fe3STakashi IwaiFUNCTION
235a481fe3STakashi Iwai~~~~~~~~
245a481fe3STakashi Iwai========	=================================
255a481fe3STakashi IwaiSwitch		on/off switch
265a481fe3STakashi IwaiVolume		amplifier
275a481fe3STakashi IwaiRoute		route control, hardware specific
285a481fe3STakashi Iwai========	=================================
295a481fe3STakashi Iwai
305a481fe3STakashi IwaiCHANNEL
315a481fe3STakashi Iwai~~~~~~~
325a481fe3STakashi Iwai============	==================================================
335a481fe3STakashi Iwai<nothing>	channel independent, or applies to all channels
345a481fe3STakashi IwaiFront		front left/right channels
355a481fe3STakashi IwaiSurround	rear left/right in 4.0/5.1 surround
365a481fe3STakashi IwaiCLFE		C/LFE channels
37*76f22f4dSSunrisepeakCenter		center channel
385a481fe3STakashi IwaiLFE		LFE channel
395a481fe3STakashi IwaiSide		side left/right for 7.1 surround
405a481fe3STakashi Iwai============	==================================================
415a481fe3STakashi Iwai
425a481fe3STakashi IwaiLOCATION (Physical location of source)
435a481fe3STakashi Iwai~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
445a481fe3STakashi Iwai============	=====================
455a481fe3STakashi IwaiFront		front position
465a481fe3STakashi IwaiRear		rear position
475a481fe3STakashi IwaiDock		on docking station
485a481fe3STakashi IwaiInternal	internal
495a481fe3STakashi Iwai============	=====================
505a481fe3STakashi Iwai
515a481fe3STakashi IwaiSOURCE
525a481fe3STakashi Iwai~~~~~~
535a481fe3STakashi Iwai===================	=================================================
545a481fe3STakashi IwaiMaster
555a481fe3STakashi IwaiMaster Mono
565a481fe3STakashi IwaiHardware Master
575a481fe3STakashi IwaiSpeaker			internal speaker
585a481fe3STakashi IwaiBass Speaker		internal LFE speaker
595a481fe3STakashi IwaiHeadphone
605a481fe3STakashi IwaiLine Out
615a481fe3STakashi IwaiBeep			beep generator
625a481fe3STakashi IwaiPhone
635a481fe3STakashi IwaiPhone Input
645a481fe3STakashi IwaiPhone Output
655a481fe3STakashi IwaiSynth
665a481fe3STakashi IwaiFM
675a481fe3STakashi IwaiMic
685a481fe3STakashi IwaiHeadset Mic		mic part of combined headset jack - 4-pin
695a481fe3STakashi Iwai			headphone + mic
705a481fe3STakashi IwaiHeadphone Mic		mic part of either/or - 3-pin headphone or mic
715a481fe3STakashi IwaiLine			input only, use "Line Out" for output
725a481fe3STakashi IwaiCD
735a481fe3STakashi IwaiVideo
745a481fe3STakashi IwaiZoom Video
755a481fe3STakashi IwaiAux
765a481fe3STakashi IwaiPCM
775a481fe3STakashi IwaiPCM Pan
785a481fe3STakashi IwaiLoopback
795a481fe3STakashi IwaiAnalog Loopback		D/A -> A/D loopback
805a481fe3STakashi IwaiDigital Loopback	playback -> capture loopback -
815a481fe3STakashi Iwai			without analog path
825a481fe3STakashi IwaiMono
835a481fe3STakashi IwaiMono Output
845a481fe3STakashi IwaiMulti
855a481fe3STakashi IwaiADC
865a481fe3STakashi IwaiWave
875a481fe3STakashi IwaiMusic
885a481fe3STakashi IwaiI2S
895a481fe3STakashi IwaiIEC958
905a481fe3STakashi IwaiHDMI
915a481fe3STakashi IwaiSPDIF			output only
925a481fe3STakashi IwaiSPDIF In
935a481fe3STakashi IwaiDigital In
945a481fe3STakashi IwaiHDMI/DP			either HDMI or DisplayPort
955a481fe3STakashi Iwai===================	=================================================
965a481fe3STakashi Iwai
975a481fe3STakashi IwaiExceptions (deprecated)
985a481fe3STakashi Iwai-----------------------
995a481fe3STakashi Iwai
1005a481fe3STakashi Iwai=====================================	=======================
1015a481fe3STakashi Iwai[Analogue|Digital] Capture Source
1025a481fe3STakashi Iwai[Analogue|Digital] Capture Switch	aka input gain switch
1035a481fe3STakashi Iwai[Analogue|Digital] Capture Volume	aka input gain volume
1045a481fe3STakashi Iwai[Analogue|Digital] Playback Switch	aka output gain switch
1055a481fe3STakashi Iwai[Analogue|Digital] Playback Volume	aka output gain volume
1065a481fe3STakashi IwaiTone Control - Switch
1075a481fe3STakashi IwaiTone Control - Bass
1085a481fe3STakashi IwaiTone Control - Treble
1095a481fe3STakashi Iwai3D Control - Switch
1105a481fe3STakashi Iwai3D Control - Center
1115a481fe3STakashi Iwai3D Control - Depth
1125a481fe3STakashi Iwai3D Control - Wide
1135a481fe3STakashi Iwai3D Control - Space
1145a481fe3STakashi Iwai3D Control - Level
1155a481fe3STakashi IwaiMic Boost [(?dB)]
1165a481fe3STakashi Iwai=====================================	=======================
1175a481fe3STakashi Iwai
1185a481fe3STakashi IwaiPCM interface
1195a481fe3STakashi Iwai-------------
1205a481fe3STakashi Iwai
1215a481fe3STakashi Iwai===================	========================================
1225a481fe3STakashi IwaiSample Clock Source	{ "Word", "Internal", "AutoSync" }
1235a481fe3STakashi IwaiClock Sync Status	{ "Lock", "Sync", "No Lock" }
1245a481fe3STakashi IwaiExternal Rate		external capture rate
1255a481fe3STakashi IwaiCapture Rate		capture rate taken from external source
1265a481fe3STakashi Iwai===================	========================================
1275a481fe3STakashi Iwai
1285a481fe3STakashi IwaiIEC958 (S/PDIF) interface
1295a481fe3STakashi Iwai-------------------------
1305a481fe3STakashi Iwai
1315a481fe3STakashi Iwai============================================	======================================
1325a481fe3STakashi IwaiIEC958 [...] [Playback|Capture] Switch		turn on/off the IEC958 interface
1335a481fe3STakashi IwaiIEC958 [...] [Playback|Capture] Volume		digital volume control
1345a481fe3STakashi IwaiIEC958 [...] [Playback|Capture] Default		default or global value - read/write
1355a481fe3STakashi IwaiIEC958 [...] [Playback|Capture] Mask		consumer and professional mask
1365a481fe3STakashi IwaiIEC958 [...] [Playback|Capture] Con Mask	consumer mask
1375a481fe3STakashi IwaiIEC958 [...] [Playback|Capture] Pro Mask	professional mask
1385a481fe3STakashi IwaiIEC958 [...] [Playback|Capture] PCM Stream	the settings assigned to a PCM stream
1395a481fe3STakashi IwaiIEC958 Q-subcode [Playback|Capture] Default	Q-subcode bits
1405a481fe3STakashi Iwai
1415a481fe3STakashi IwaiIEC958 Preamble [Playback|Capture] Default	burst preamble words (4*16bits)
1425a481fe3STakashi Iwai============================================	======================================
143