src/modules/alsa/mixer/paths/analog-output.conf.common

   1 # This file is part of PulseAudio.
   2 #
   3 # PulseAudio is free software; you can redistribute it and/or modify
   4 # it under the terms of the GNU Lesser General Public License as
   5 # published by the Free Software Foundation; either version 2.1 of the
   6 # License, or (at your option) any later version.
   7 #
   8 # PulseAudio is distributed in the hope that it will be useful, but
   9 # WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11 # General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public License
  14 # along with PulseAudio; if not, write to the Free Software Foundation,
  15 # Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  16
  17 ; Common part of all paths
  18
  19 ; So here's generally how mixer paths are used by PA: PA goes through
  20 ; a mixer path file from top to bottom and checks if a mixer element
  21 ; described therein exists. If so it is added to the list of mixer
  22 ; elements PA will control, keeping the order it read them in. If a
  23 ; mixer element described here has set the required= or
  24 ; required-absent= directives a path might not be accepted as valid
  25 ; and is ignored in its entirety (see below). However usually if a
  26 ; element listed here is missing this one element is ignored but not
  27 ; the entire path.
  28 ;
  29 ; When a device shall be muted/unmuted *all* elements listed in a path
  30 ; file with "switch = mute" will be toggled.
  31 ;
  32 ; When a device shall change its volume, PA will got through the list
  33 ; of all elements with "volume = merge" and set the volume on the
  34 ; first element. If that element does not support dB volumes, this is
  35 ; where the story ends. If it does support dB volumes, PA divides the
  36 ; requested volume by the volume that was set on this element, and
  37 ; then go on to the next element with "volume = merge" and then set
  38 ; that there, and so on.  That way the first volume element in the
  39 ; path will be the one that does the 'biggest' part of the overall
  40 ; volume adjustment, with the remaining elements usually being set to
  41 ; some value next to 0dB. This logic makes sure we get the full range
  42 ; over all volume sliders and a very high granularity of volumes
  43 ; already in hardware.
  44 ;
  45 ; All switches and enumerations set to "select" are exposed via the
  46 ; "port" functionality of sinks/sources. Basically every possible
  47 ; switch setting and every possible enumeration setting will be
  48 ; combined and made into a "port". So make sure you don't list too
  49 ; many switches/enums for exposing, because the number of ports might
  50 ; rise exponentially.
  51 ;
  52 ; Only one path can be selected at a time. All paths that are valid
  53 ; for an audio device will be exposed as "port" for the sink/source.
  54
  55
  56 ; [General]
  57 ; priority = ...                         # Priority for this path
  58 ; description = ...
  59 ;
  60 ; [Option ...:...]                       # For each option of an enumeration or switch element
  61 ;                                        # that shall be exposed as a sink/source port. Needs to
  62 ;                                        # be named after the Element, followed by a colon, followed
  63 ;                                        # by the option name, resp. on/off if the element is a switch.
  64 ; name = ...                             # Logical name to use in the path identifier
  65 ; priority = ...                         # Priority if this is made into a device port
  66 ; required = ignore | enumeration | any            # In this element, this option must exist or the path will be invalid. ("any" is an alias for "enumeration".)
  67 ; required-any = ignore | enumeration | any        # In this element, either this or another option must exist (or an element)
  68 ; required-absent = ignore | enumeration | any     # In this element, this option must not exist or the path will be invalid
  69 ;
  70 ; [Element ...]                          # For each element that we shall control
  71 ; required = ignore | switch | volume | enumeration | any     # If set, require this element to be of this kind and available,
  72 ;                                                             # otherwise don't consider this path valid for the card
  73 ; required-any = ignore | switch | volume | enumeration | any # If set, at least one of the elements with required-any in this
  74 ;                                                             # path must be present, otherwise this path is invalid for the card
  75 ; required-absent = ignore | switch | volume                  # If set, require this element to not be of this kind and not
  76 ;                                                             # available, otherwise don't consider this path valid for the card
  77 ;
  78 ; switch = ignore | mute | off | on | select                  # What to do with this switch: ignore it, make it follow mute status,
  79 ;                                                             # always set it to off, always to on, or make it selectable as port.
  80 ;                                                             # If set to 'select' you need to define an Option section for on
  81 ;                                                             # and off
  82 ; volume = ignore | merge | off | zero   # What to do with this volume: ignore it, merge it into the device
  83 ;                                        # volume slider, always set it to the lowest value possible, or always
  84 ;                                        # set it to 0 dB (for whatever that means)
  85 ; volume-limit = <volume step>           # Limit the maximum volume by disabling the volume steps above <volume step>.
  86 ; enumeration = ignore | select          # What to do with this enumeration, ignore it or make it selectable
  87 ;                                        # via device ports. If set to 'select' you need to define an Option section
  88 ;                                        # for each of the items you want to expose
  89 ; direction = playback | capture         # Is this relevant only for playback or capture? If not set this will implicitly be
  90 ;                                        # set the direction of the PCM device is opened as. Generally this doesn't need to be set
  91 ;                                        # unless you have a broken driver that has playback controls marked for capture or vice
  92 ;                                        # versa
  93 ; direction-try-other = no | yes         # If the element does not supported what is requested, try the other direction, too?
  94 ;
  95 ; override-map.1 = ...                   # Override the channel mask of the mixer control if the control only exposes a single channel
  96 ; override-map.2 = ...                   # Override the channel masks of the mixer control if the control only exposes two channels
  97 ;                                        # Override maps should list for each element channel which high-level channels it controls via a
  98 ;                                        # channel mask. A channel mask may either be the name of a single channel, or the words "all-left",
  99 ;                                        # "all-right", "all-center", "all-front", "all-rear", and "all" to encode a specific subset of
 100 ;                                        # channels in a mask
 101
 102 [Element PCM]
 103 switch = mute
 104 volume = merge
 105 override-map.1 = all
 106 override-map.2 = all-left,all-right
 107
 108 [Element External Amplifier]
 109 switch = select
 110
 111 [Option External Amplifier:on]
 112 name = output-amplifier-on
 113 priority = 10
 114
 115 [Option External Amplifier:off]
 116 name = output-amplifier-off
 117 priority = 0
 118
 119 [Element Bass Boost]
 120 switch = select
 121
 122 [Option Bass Boost:on]
 123 name = output-bass-boost-on
 124 priority = 0
 125
 126 [Option Bass Boost:off]
 127 name = output-bass-boost-off
 128 priority = 10
 129
 130 ;;; 'Analog Output'
 131
 132 [Element Analog Output]
 133 enumeration = select
 134
 135 [Option Analog Output:Speakers]
 136 name = output-speaker
 137 priority = 10
 138
 139 [Option Analog Output:Headphones]
 140 name = output-headphones
 141 priority = 9
 142
 143 [Option Analog Output:FP Headphones]
 144 name = output-headphones
 145 priority = 8