Refactor to promote config via --args

marioortizmanero · Oct 17, 2020 · 505b8ca · 505b8ca
1 parent 36b8b6e
commit 505b8ca
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 77 deletions.
diff --git a/README.md b/README.md
@@ -24,68 +24,16 @@ load-module module-stream-restore restore_device=false
 At a minimum, bash version 4 is required to run the script. You can check your bash version by running `bash --version`.
 
 
-## Configuration
-
-You can change the script configuration at the beginning of the file:
-
-| Name                   |  Values                  | Description |
-| ---------------------- | :----------------------: | ----------- |
-| `OSD`                  | `"yes"` / `"no"`         | Will display an OSD message when changing volume if set to true. |
-| `INC`                  | Numerical                | Sets the increment/decrease that each volume up/down will perform. |
-| `MAX_VOL`              | Numerical                | Maximum volume. |
-| `AUTOSYNC`             | `"yes"` / `"no"`         | Will automatically sync all program volumes with the volume of your current sink (output) whenever you change the volume. This is useful if you manage multiple outputs and have issues with the app volumes becoming out of sync with the output. |
-| `VOLUME_ICONS`         | Bash array with i        cons like `( "🔉" "🔊" )`\* | Icons used for the volume, ordered by sound level. The volume levels are divided by the number of icons inside it. For example, if you are using 4 icons and `MAX_VOL` is 100, they will show up in order when the volume is lower than 25, 50, 75 and 100. This is useful because some fonts only have 2 volume icons, while others can have up to 4. |
-| `MUTED_ICON`           | String\*                 | Icon used for the muted volume. |
-| `MUTED_COLOR`          | String ([polybar color](https://github.com/polybar/polybar/wiki/Formatting#foreground-color-f))   | Color used when the audio is muted. |
-| `NOTIFICATIONS`        | `"yes"` / `"no"`         | Sends a notification when the sink is changed. |
-| `SINK_ICON`            | String\*                 | Icon always displayed to the left of the sink names. |
-| `SINK_BLACKLIST`       | Bash array               | A blacklist for whenever sinks are switched. Use `pactl list sinks short` to see all active sink names. |
-| `SINK_NICKNAMES`       | Bash associative array   | Maps the PulseAudio sink names to human-readable nicknames. Use `pactl list sinks short` to obtain the active sinks names. If unconfigured, `Sink #N` is used instead. Custom icons\* for the sinks can be added here if `SINK_ICON` is set to `""`. |
-| `SINK_NICKNAME_PROP`   | String                   | Property (see `pacmd list-sinks`) to use for sink nicknames, where not explicitly set in `SINK_NICKNAMES`. |
-
-\*Check the [Useful icons](#useful-icons) section for examples.
-
-Alternatively, these can be set via command-line arguments, such as:
-```ini
-[module/pulseaudio-control]
-type = custom/script
-exec = "polybar-pulseaudio-control --vol-max=150 --vol-icons='🔈 ,🔉 ,🔊 ' --sink-name-from-prop=device.description --osd"
-```
-
-refer to `polybar-pulseaudio-control help` for a full listing of the available options and their defaults.
-
-
-## Module
-
-The example from the screenshot can:
-
-* Raise and decrease the volume on mousewheel scroll
-* Mute the audio on left click
-* Switch between devices on mousewheel click
-* Open `pavucontrol` on right click
+## Usage
 
+`polybar-pulseaudio-control` is expected to be invoked from a [polybar](//github.com/polybar/polybar) module:
 ```ini
 [module/pulseaudio-control]
 type = custom/script
-tail = true
-label=%output%
-format-underline = ${colors.blue}
-
-exec = ~/.config/polybar/scripts/pulseaudio-control.bash listen
-click-right = exec pavucontrol &
-click-left = ~/.config/polybar/scripts/pulseaudio-control.bash togmute
-click-middle = ~/.config/polybar/scripts/pulseaudio-control.bash next-sink
-scroll-up = ~/.config/polybar/scripts/pulseaudio-control.bash up
-scroll-down = ~/.config/polybar/scripts/pulseaudio-control.bash down
-label-padding = 2
-label-foreground = ${colors.foreground}
+exec = polybar-pulseaudio-control [option...] <action>
 ```
 
-*Note that you will have to change the paths above to where your script is saved. You might want to change or remove the colors and labels, too.*
-
-## Usage
-
-Here are all the available actions, in case you want to modify the module above, or want to use it for different reasons:
+where `action`, and (optionally) `option`s are as specified in `polybar-pulseaudio-control help`:
 
 ```
 Options: (defaults)
@@ -115,16 +63,47 @@ Actions:
                       the be the same as the current sink's volume
 ```
 
+See the [Module](#module) section for a concrete example, or the [Useful icons](#useful-icons) section for example icons.
+
+
+## Module
+
+The example from the screenshot can:
+
+* Raise and decrease the volume on mousewheel scroll
+* Mute the audio on left click
+* Switch between devices on mousewheel click
+* Open `pavucontrol` on right click
+
+```ini
+[module/pulseaudio-control]
+type = custom/script
+tail = true
+label=%output%
+format-underline = ${colors.blue}
+
+exec = "~/.config/polybar/scripts/pulseaudio-control.bash --vol-max=150 --vol-icons='🔈 ,🔉 ,🔊 ' --sink-name-from-prop=device.description --osd listen"
+click-right = exec pavucontrol &
+click-left = ~/.config/polybar/scripts/pulseaudio-control.bash togmute
+click-middle = ~/.config/polybar/scripts/pulseaudio-control.bash next-sink
+scroll-up = ~/.config/polybar/scripts/pulseaudio-control.bash up
+scroll-down = ~/.config/polybar/scripts/pulseaudio-control.bash down
+label-padding = 2
+label-foreground = ${colors.foreground}
+```
+
+*Note that you will have to change the paths above to where your script is saved. You might want to change or remove the colors and labels, too.*
+
 ## Useful icons
 
 Here's a list with some icons from different fonts you can copy-paste. Most have an space afterwards so that the module has a bit of spacing. They may appear bugged on your browser if the font isn't available there. Please add yours if they aren't in the list.
 
 | Font name                                       | Volumes               | Muted   | Sink icons             |
 | ----------------------------------------------- | :-------------------: | :-----: | :--------------------: |
-| [FontAwesome](https://fontawesome.com)          | `(" " " ")`         | `" "`  | `" "`, `" "`         |
-| [Material](https://material.io/resources/icons) | `(" " " " " ")`    | `" "`  | `" "`, `" "`, `" "` |
-| Emoji                                           | `("🔈 " "🔉 " "🔊 ")` | `"🔇 "` | `"🔈 "`, `"🎧"`        |
-| Emoji v2                                        | `("🕨 " "🕩 " "🕪 ")`    | `"🔇 "` | `"🕨 "`, `"🎧"`         |
+| [FontAwesome](https://fontawesome.com)          | `" , "`         | `" "`  | `" "` or `" "`         |
+| [Material](https://material.io/resources/icons) | `" , , "`    | `" "`  | `" "` or `" "` or `" "` |
+| Emoji                                           | `"🔈 ,🔉 ,🔊 "` | `"🔇 "` | `"🔈 "` or `"🎧"`        |
+| Emoji v2                                        | `"🕨 ,🕩 ,🕪 "`    | `"🔇 "` | `"🕨 "` or `"🎧"`         |
 
 Most of these can be used after downloading a [Nerd Font](https://www.nerdfonts.com/), or from your distro's repository.
 

diff --git a/pulseaudio-control.bash b/pulseaudio-control.bash
@@ -5,30 +5,24 @@
 # https://github.com/marioortizmanero/polybar-pulseaudio-control #
 ##################################################################
 
-# Script configuration (more info in the README)
-OSD="no"  # On Screen Display message for KDE if enabled
-INC=2  # Increment when lowering/rising the volume
-MAX_VOL=130  # Maximum volume
-AUTOSYNC="no"  # All programs have the same volume if enabled
-VOLUME_ICONS=( "# " "# " "# " )  # Volume icons array, from lower volume to higher
-MUTED_ICON="# "  # Muted volume icon
-MUTED_COLOR="%{F#6b6b6b}"  # Color when the audio is muted
-NOTIFICATIONS="no"  # Notifications when switching sinks if enabled
-SINK_ICON="# "  # Icon always shown to the left of the default sink names
-
-# Blacklist of PulseAudio sink names when switching between them. To obtain
-# the names of your active sinks, use `pactl list sinks short`.
+# Defaults for configurable values, expected to be set by command-line arguments
+OSD="no"
+INC=2
+MAX_VOL=130
+AUTOSYNC="no"
+VOLUME_ICONS=( "# " "# " "# " )
+MUTED_ICON="# "
+MUTED_COLOR="%{F#6b6b6b}"
+NOTIFICATIONS="no"
+SINK_ICON="# "
 SINK_BLACKLIST=(
     "alsa_output.usb-SinkYouDontUse-00.analog-stereo"
 )
-
-# Maps PulseAudio sink names to human-readable names
 declare -A SINK_NICKNAMES
 SINK_NICKNAMES["alsa_output.usb-SomeManufacturer_SomeUsbSoundcard-00.analog-stereo"]="External Soundcard"
-
-# PulseAudio device property for human-readable names where an explicit nickname not given
 SINK_NICKNAME_PROP=
 
+
 # Environment & global constants for the script
 LANGUAGE=en_US  # Some calls depend on English outputs of pactl
 END_COLOR="%{F-}"