-
Notifications
You must be signed in to change notification settings - Fork 36
/
Copy pathvolume
executable file
·1410 lines (1195 loc) · 41.1 KB
/
volume
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/bin/bash
#
# i3-volume
#
# Volume control and volume notifications.
#
# Dependencies:
# awk (POSIX compatible)
# pulseaudio-utils - if using PulseAudio
# alsa-utils - if using amixer
#
# Copyright (c) 2016 Beau Hastings. All rights reserved.
# License: GNU General Public License v2
#
# Author: Beau Hastings <[email protected]>
# URL: https://github.com/hastinbe/i3-volume
# Wiki: https://github.com/hastinbe/i3-volume/wiki/
define_helpers() {
empty() {
[[ -z $1 ]]
}
not_empty() {
[[ -n $1 ]]
}
isset() {
[[ -v $1 ]]
}
command_exists() {
command -v "$1" >/dev/null 2>&1;
}
error() {
echo "$COLOR_RED$*$COLOR_RESET"
}
has_color() {
[ "$(tput colors)" -ge 8 ] &>/dev/null && [ -t 1 ]
}
# Converts milliseconds to seconds.
#
# Arguments:
# milliseconds (integer) An integer in milliseconds
ms_to_secs() {
# divide by 1000 and round up to nearest integer using 'bc' command
echo "scale=0; (${1} + 999) / 1000" | bc
}
is_command_hookable() {
! [[ ${POST_HOOK_EXEMPT_COMMANDS[*]} =~ $1 ]]
}
has_capability() {
[[ "${NOTIFY_CAPS[*]}" =~ $1 ]]
}
max() {
echo $(( $1 > $2 ? $1 : $2 ))
}
}
define_notify() {
# Display a notification indicating muted or current volume.
notify_volume() {
local -r vol=$(get_volume)
local icon
local summary
local body=""
if is_muted; then
summary="Volume muted"
if $USE_FULLCOLOR_ICONS; then
icon=${ICONS[0]}
else
icon=${ICONS_SYMBOLIC[0]}
fi
else
printf -v summary "Volume %3s%%" "$vol"
icon=$(get_volume_icon "$vol")
if $SHOW_VOLUME_PROGRESS; then
local -r progress=$(progress_bar "$vol")
if has_capability body && [[ $PROGRESS_PLACEMENT == body ]]; then
body="$progress"
else
summary="$summary $progress"
fi
fi
fi
case "$NOTIFICATION_METHOD" in
xosd ) notify_volume_xosd "$vol" "$summary $body" ;;
herbe ) notify_volume_herbe "$summary $body" ;;
volnoti ) notify_volume_volnoti "$vol" ;;
kosd ) notify_volume_kosd "$vol" ;;
* ) notify_volume_libnotify "$vol" "$icon" "$summary" "$body" ;;
esac
}
list_notification_methods() {
local source="${BASH_SOURCE[0]}"
awk -W posix -v source="$source" '
match($0, / +notify_volume_([[:alnum:]]+)\(\)/) {
print substr($0, RSTART + 18, RLENGTH - 18) > "/dev/stdout"
}
' "$source" || exit "$EX_USAGE"
exit "$EX_OK"
}
setup_notification_icons() {
if not_empty "$SYMBOLIC_ICON_SUFFIX"; then
apply_symbolic_icon_suffix
fi
}
show_volume_notification() {
$DISPLAY_NOTIFICATIONS || return
if empty "$NOTIFICATION_METHOD"; then
load_notify_server_info
NOTIFICATION_METHOD=$NOTIFY_SERVER
fi
setup_notification_icons
notify_volume
}
# Loads notification system information via DBus
load_notify_server_info() {
command_exists dbus-send || return
IFS=$'\t' read -r NOTIFY_SERVER _ _ _ < <(dbus-send --print-reply --dest=org.freedesktop.Notifications /org/freedesktop/Notifications org.freedesktop.Notifications.GetServerInformation | awk 'BEGIN { ORS="\t" }; match($0, /^ string ".*"/) {print substr($0, RSTART+11, RLENGTH-12)}')
}
# Load notification system capabilities via DBus
load_notify_server_caps() {
command_exists dbus-send || return
IFS= read -r -d '' -a NOTIFY_CAPS < <(dbus-send --print-reply=literal --dest="${DBUS_NAME}" "${DBUS_PATH}" "${DBUS_IFAC_FDN}.GetCapabilities" | awk 'RS=" " { if (NR > 2) print $1 }')
}
# Send notifcation for libnotify-compatible notification daemons.
#
# Arguments:
# Volume (integer) An integer indicating the volume.
# Icon (string) Icon to display.
# Summary (string) Notification summary.
# Body (string) Notification body. (optional)
notify_volume_libnotify() {
local -r vol=$1
local -r icon=$2
local -r summary=$3
local -r body=${*:4}
local args=(
'-t' "$EXPIRES"
)
local hints=(
# Replaces previous notification in some notification servers
'string:synchronous:volume'
# Replaces previous notification in NotifyOSD
'string:x-canonical-private-synchronous:volume'
)
local executable
# If we're not drawing our own progress bar, allow the notification daemon to draw its own (if supported)
$SHOW_VOLUME_PROGRESS || hints+=( "int:value:$vol" )
# (( ${#NOTIFY_CAPS[@]} < 1 )) && load_notify_server_caps
[[ ${#NOTIFY_CAPS[@]} -lt 1 ]] && load_notify_server_caps
if has_capability icon-static || has_capability icon-multi; then
# haskell-notification-daemon (aka deadd-notification-center) does not support -i|--icon, but supports string:image-path
args+=( '-i' "$icon" )
hints+=( "string:image-path:$icon" )
fi
$PLAY_SOUND && has_capability sound && hints+=( "string:sound-name:audio-volume-change" )
if [[ $NOTIFICATION_METHOD == "dunst" ]]; then
hints+=( "string:x-dunst-stack-tag:volume" )
if ! isset NO_NOTIFY_COLOR; then
if is_muted; then
hints+=( "string:fgcolor:$COLOR_MUTED" )
else
hints+=( "string:fgcolor:$(volume_color "$vol")" )
fi
fi
fi
if $USE_DUNSTIFY; then
executable="${NOTIFY_PATH:+${NOTIFY_PATH%/}/}dunstify"
args+=( '-r' 1000 )
# Transient notifications will bypass the idle_threshold setting.
# Should be boolean, but Notify-OSD doesn't support boolean yet. Dunst checks
# for int and bool with transient so lets play nice with both servers.
hints+=( "int:transient:1" )
elif isset USE_NOTIFY_SEND_PY; then
executable="${NOTIFY_PATH:+${NOTIFY_PATH%/}/}notify-send.py"
# Replaces previous notification, but leaves itself running in the bg to work
args+=( --replaces-process volume )
# By-pass the server's persistence capability, if it should exist
hints+=( "boolean:transient:true" )
# Prefix all hints with --hint to work with notify-send.py
hints=( "${hints[@]/#/--hint }" )
else
executable="${NOTIFY_PATH:+${NOTIFY_PATH%/}/}notify-send"
fi
command_exists "$executable" || {
error "$executable not found. Please install it or set NOTIFY_PATH to the correct path."
exit "$EX_UNAVAILABLE"
}
read -ra hints <<< "${hints[@]/#/-h }"
"$executable" "${hints[@]}" "${args[@]}" "$summary" "$body" &
}
# Send notification to XOSD.
#
# Arguments:
# Volume (integer) An integer indicating the volume.
# Text (string) Notification text.
notify_volume_xosd() {
local -r vol=$1
local -r text=${*:2}
local percentage
local executable
if is_muted; then
color=$COLOR_MUTED
percentage=0
else
color=$(volume_color "$vol")
percentage=$vol
fi
executable="${XOSD_PATH:+${XOSD_PATH%/}/}osd_cat"
command_exists "$executable" || {
error "$executable not found. Please install it or set XOSD_PATH to the correct path."
exit "$EX_UNAVAILABLE"
}
"$executable" \
--align center \
-b percentage \
-P "$percentage" \
-d "$(ms_to_secs "$EXPIRES")" \
-p top \
-A center \
-c "$color" \
-T "$text" \
-O 2 \
-u "$COLOR_XOSD_OUTLINE" & disown
}
# Send notification to herbe.
#
# Arguments:
# Text (string) Notification text.
#
# Note: a patch with a notify-send script for herbe, not in the current version at this
# time but would make this irrelevant. See https://github.com/dudik/herbe/pull/10
notify_volume_herbe() {
local -r text=$*
local executable
# Dismiss existing/pending notifications to prevent queuing
pkill -SIGUSR1 herbe
executable="${HERBE_PATH:+${HERBE_PATH%/}/}herbe"
command_exists "$executable" || {
error "$executable not found. Please install it or set HERBE_PATH to the correct path."
exit "$EX_UNAVAILABLE"
}
"$executable" "$text" & disown
}
# Send notification to volnoti.
#
# Arguments:
# Volume (integer) An integer indicating the volume.
notify_volume_volnoti() {
local -r vol=$1
local executable
executable="${VOLNOTI_PATH:+${VOLNOTI_PATH%/}/}volnoti-show"
command_exists "$executable" || {
error "$executable not found. Please install it or set VOLNOTI_PATH to the correct path."
exit "$EX_UNAVAILABLE"
}
if is_muted; then
"$executable" -m "$vol"
else
"$executable" "$vol"
fi
}
# Send notification to KOSD.
#
# Arguments:
# Volume (integer) An integer indicating the volume.
notify_volume_kosd() {
local -r vol=$1
local muted=0
if is_muted; then
muted=1
fi
qdbus org.kde.kded /modules/kosd showVolume "$vol" "$muted"
}
}
define_output_formats() {
# Outputs the current volume in the default format.
output_volume_default() {
if is_muted; then
echo MUTE
else
echo "$(get_volume)%"
fi
}
# Outputs the current volume using a custom format string.
#
# Format options:
# %v = volume percentage or "MUTE" when muted
# %s = sink name (PulseAudio only)
# %c = card (alsamixer only)
# %m = mixer (alsamixer only)
# %p = volume progress bar
# %P = active port description (PulseAudio only)
# %i = volume icon
output_volume_custom() {
local -r vol=$(get_volume)
local -r format=${1//\%v/$vol%}
local string=${format//\%s/$SINK}
string=${string//\%c/$CARD}
string=${string//\%m/$MIXER}
string=${string//\%p/$(progress_bar "$vol")}
string=${string//\%P/$(pa_get_active_port_description "$SINK")}
string=${string//\%i/$(get_volume_emoji "$vol")}
if is_muted; then
echo -ne "${string//\%v/MUTE}"
else
echo -ne "$string"
fi
}
# Outputs the current volume for i3blocks.
output_volume_i3blocks() {
local short_text
local full_text
local -r port=$(pa_get_active_port_description "$SINK")
if is_muted; then
short_text="<span color=\"$COLOR_MUTED\">MUTE</span>\n"
full_text="<span color=\"$COLOR_TEXT\">$port</span> $short_text"
else
local -r vol=$(get_volume)
local -r color=$(volume_color "$vol")
short_text="<span color=\"$color\">${vol}%</span>\n"
full_text="<span color=\"$COLOR_TEXT\">$port</span> $short_text"
if isset MAX_VOLUME && (( vol > MAX_VOLUME )); then
EXITCODE=$EX_URGENT
fi
fi
echo -ne "$full_text$short_text"
}
# Outputs the current volume for xob.
output_volume_xob() {
local -ir vol=$(get_volume)
if is_muted; then
echo "${vol}!"
else
echo "$vol"
fi
}
}
define_commands() {
# Increase volume relative to current volume.
#
# Arguments:
# Step (integer) Percentage to increase by.
# Max Volume (optional) (integer|percentage) Maximum volume limit.
increase_volume() {
local step=${1:?$(error 'Step is required')}
local -r max_volume=$2
if not_empty "$max_volume"; then
local -r vol=$(get_volume)
if (( vol + step > max_volume )); then
# Instead of doing nothing, step to max_volume
step=$( max "0" "$(( max_volume - vol ))" )
fi
fi
if $USE_AMIXER; then
amixer_increase_volume "$CARD" "$step"
else
pa_increase_volume "$SINK" "$step"
fi
}
# Decrease volume relative to current volume.
#
# Arguments:
# Step (integer) Percentage to decrease by.
decrease_volume() {
local -r step=${1:?$(error 'Step is required')}
if $USE_AMIXER; then
amixer_decrease_volume "$CARD" "$step"
else
pa_decrease_volume "$SINK" "$step"
fi
}
# Set volume.
#
# Arguments:
# Volume (integer|linear factor|percentage|decibel)
# Max Volume (optional) (integer|percentage) Maximum volume limit.
set_volume() {
local -r vol=${1:?$(error 'Volume is required')}
local -r max_volume=$2
if not_empty "$max_volume" && (( vol > max_volume )); then
return
fi
if $USE_AMIXER; then
amixer_set_volume "${vol}%" "$CARD"
else
pa_set_volume "$SINK" "${vol}%"
fi
}
toggle_mute() {
if $USE_AMIXER; then
amixer_toggle_mute "$CARD"
else
pa_toggle_mute "$SINK"
fi
}
# Outputs the current volume.
#
# Arguments
# Output method (string) Method to use to output volume.
output_volume() {
local -r for=${1:?$(error 'Output method is required')}
case "$for" in
i3blocks ) output_volume_i3blocks ;;
xob ) output_volume_xob ;;
default ) output_volume_default ;;
* ) output_volume_custom "$*" ;;
esac
}
list_output_formats() {
awk -W posix 'match($0,/ +output_volume_([[:alnum:]]+)\(\)/) {print substr($0, RSTART + 18, RLENGTH - 20)}' "${BASH_SOURCE[0]}" || exit "$EX_USAGE"
exit "$EX_OK"
}
usage() {
cat <<- EOF 1>&2
${COLOR_YELLOW}Usage:${COLOR_RESET} $0 [<options>] <command> [<args>]
Control volume and related notifications.
${COLOR_YELLOW}Commands:${COLOR_RESET}
${COLOR_GREEN}up <value>${COLOR_RESET} increase volume
${COLOR_GREEN}down <value>${COLOR_RESET} decrease volume
${COLOR_GREEN}set <value>${COLOR_RESET} set volume
${COLOR_GREEN}mute${COLOR_RESET} toggle mute
${COLOR_GREEN}listen${COLOR_RESET} listen for changes to a PulseAudio sink
${COLOR_GREEN}output <format>${COLOR_RESET} output volume in a supported format
custom format substitutions:
%v = volume
%s = sink name (PulseAudio only)
%c = card (alsamixer only)
%m = mixer (alsamixer only)
%p = volume progress bar
%i = volume icon/emoji
%P = active port description (PulseAudio only)
examples:
"Volume is %v" = Volume is 50%
"%i %v %p \n" = 奔 50% ██████████
${COLOR_GREEN}outputs${COLOR_RESET} show available output formats
${COLOR_GREEN}notifications${COLOR_RESET} show available notification methods
${COLOR_GREEN}help${COLOR_RESET} display help
${COLOR_YELLOW}Options:${COLOR_RESET}
${COLOR_GREEN}-a${COLOR_RESET} use amixer
${COLOR_GREEN}-n${COLOR_RESET} enable notifications
${COLOR_GREEN}-C${COLOR_RESET} use libcanberra for playing event sounds
${COLOR_GREEN}-P${COLOR_RESET} play sound for volume changes
${COLOR_GREEN}-j <muted,high,low,medium>${COLOR_RESET} specify custom volume emojis as a comma separated list
${COLOR_GREEN}-t <process_name>${COLOR_RESET} process name of status bar (${COLOR_MAGENTA}requires -u${COLOR_RESET})
${COLOR_GREEN}-u <signal>${COLOR_RESET} signal to update status bar (${COLOR_MAGENTA}requires -t${COLOR_RESET})
${COLOR_GREEN}-x <value>${COLOR_RESET} maximum volume
${COLOR_GREEN}-X <value>${COLOR_RESET} maximum amplification; if supported (${COLOR_MAGENTA}default: 2${COLOR_RESET})
${COLOR_GREEN}-h${COLOR_RESET} display help
${COLOR_YELLOW}amixer Options:${COLOR_RESET}
${COLOR_GREEN}-c <card>${COLOR_RESET} card number to control
${COLOR_GREEN}-m <mixer>${COLOR_RESET} set mixer (${COLOR_MAGENTA}default: Master${COLOR_RESET})
${COLOR_YELLOW}PulseAudio Options:${COLOR_RESET}
${COLOR_GREEN}-s <sink>${COLOR_RESET} symbolic name of sink
${COLOR_YELLOW}Notification Options:${COLOR_RESET}
${COLOR_GREEN}-N <method>${COLOR_RESET} notification method (${COLOR_MAGENTA}default: libnotify${COLOR_RESET})
${COLOR_GREEN}-p${COLOR_RESET} enable progress bar
${COLOR_GREEN}-L <placement>${COLOR_RESET} progress bar placement (${COLOR_MAGENTA}default: summary${COLOR_RESET}; ${COLOR_MAGENTA}requires -p${COLOR_RESET})
placements:
body
summary
${COLOR_GREEN}-e <expires>${COLOR_RESET} expiration time of notifications in ms
${COLOR_GREEN}-l${COLOR_RESET} use fullcolor instead of symbolic icons
${COLOR_GREEN}-S <suffix>${COLOR_RESET} append suffix to symbolic icon names
${COLOR_GREEN}-y${COLOR_RESET} use dunstify (${COLOR_MAGENTA}default: notify-send${COLOR_RESET})
${COLOR_YELLOW}Environment Variables:${COLOR_RESET}
${COLOR_CYAN}XOSD_PATH${COLOR_RESET} path to osd_cat
${COLOR_CYAN}HERBE_PATH${COLOR_RESET} path to herbe
${COLOR_CYAN}VOLNOTI_PATH${COLOR_RESET} path to volnoti-show
${COLOR_CYAN}CANBERRA_PATH${COLOR_RESET} path to canberra-gtk-play
${COLOR_CYAN}NOTIFY_PATH${COLOR_RESET} path to command that sends notifications
${COLOR_CYAN}NO_NOTIFY_COLOR${COLOR_RESET} flag to disable colors in notifications
${COLOR_CYAN}USE_NOTIFY_SEND_PY${COLOR_RESET} flag to use notify-send.py instead of notify-send
EOF
exit "$EX_USAGE"
}
}
# Get the volume as a percentage.
get_volume() {
if $USE_AMIXER; then
amixer_get_volume "$CARD" "$MIXER"
else
pa_get_volume "$SINK"
fi
}
is_muted() {
if $USE_AMIXER; then
amixer_is_muted "$CARD"
return $?
else
pa_is_muted "$SINK"
return $?
fi
}
# Gets an icon for the provided volume.
#
# Arguments:
# Volume (integer) An integer indicating the volume.
#
# Returns:
# The volume icon name.
get_volume_icon() {
local -r vol=${1:?$(error 'Volume is required')}
local icon
if $USE_FULLCOLOR_ICONS; then
if (( vol >= 70 )); then icon=${ICONS[1]}
elif (( vol >= 40 )); then icon=${ICONS[3]}
elif (( vol > 0 )); then icon=${ICONS[2]}
else icon=${ICONS[2]}
fi
else
# Get overamplified icon if available, otherwise default to high volume icon
if (( vol > 100 )); then icon=${ICONS_SYMBOLIC[4]:-${ICONS_SYMBOLIC[1]}}
elif (( vol >= 70 )); then icon=${ICONS_SYMBOLIC[1]}
elif (( vol >= 40 )); then icon=${ICONS_SYMBOLIC[3]}
elif (( vol > 0 )); then icon=${ICONS_SYMBOLIC[2]}
else icon=${ICONS_SYMBOLIC[2]}
fi
fi
echo "$icon"
}
# Gets an emoji for the provided volume.
#
# Arguments:
# Volume (integer) An integer indicating the volume.
#
# Returns:
# The volume emoji.
get_volume_emoji() {
local -r vol=${1:?$(error 'Volume is required')}
local icon
if is_muted; then
icon=${ICONS_EMOJI[0]}
else
if (( vol >= 70 )); then icon=${ICONS_EMOJI[1]}
elif (( vol >= 40 )); then icon=${ICONS_EMOJI[3]}
elif (( vol > 0 )); then icon=${ICONS_EMOJI[2]}
else icon=${ICONS_EMOJI[2]}
fi
fi
echo "$icon"
}
# Updates the status line.
#
# Arguments:
# signal (string) The signal used to update the status line.
# proc (string) The name of the status line process.
update_statusline() {
local -r signal=${1:?$(error 'Signal is required')}
local -r proc=${2:?$(error 'Process name is required')}
pkill "-$signal" "$proc"
}
# Generates a progress bar for the provided value.
#
# Arguments:
# Percentage (integer) Percentage of progress.
# Maximum (integer) Maximum percentage. (default: 100)
# Divisor (integer) For calculating the ratio of blocks to progress (default: 5)
#
# Returns:
# The progress bar.
progress_bar() {
local -r percent=${1:?$(error 'Percentage is required')}
local -r max_percent=${2:-100}
local -r divisor=${3:-5}
local -r normalized=$(( percent > max_percent ? max_percent : percent ))
local -r progress=$(( normalized / divisor ))
printf -v bar "%*s" $progress ""
echo "${bar// /█}"
}
apply_symbolic_icon_suffix() {
for i in "${!ICONS_SYMBOLIC[@]}"; do
ICONS_SYMBOLIC[i]="${ICONS_SYMBOLIC[i]}${SYMBOLIC_ICON_SUFFIX}"
done
}
# Get color for the given volume
#
# Arguments:
# $1 - The volume
volume_color() {
local -ir vol=${1:?$(error 'A volume is required')}
if $USE_AMIXER; then
amixer_volume_color "$vol"
else
pa_volume_color "$vol"
fi
}
# Updates the status bars
#
# Returns
# 0 when no problem occurred
# 1 when one $of signal or $statusline are set but not both
update_statusbar() {
if not_empty "$SIGNAL"; then
if empty "$STATUSLINE"; then
return 1
fi
update_statusline "$SIGNAL" "$STATUSLINE"
else
if not_empty "$STATUSLINE"; then
return 1
fi
fi
return 0
}
setup_audio() {
if $USE_AMIXER; then
setup_amixer
else
setup_pulseaudio
fi
}
# All PulseAudio functions are defined here
define_pulseaudio_functions() {
# Executes `pactl list sinks` or return its output if called previously
pa_list_sinks() {
if [[ $COMMAND == "listen" ]] || empty "$PA_LIST_SINKS"; then
PA_LIST_SINKS=$(pactl list sinks)
fi
echo "$PA_LIST_SINKS"
}
pa_invalidate_cache() {
PA_LIST_SINKS=""
}
pa_get_sink_active_port() {
local -r sink=${1:?$(error 'Sink name is required')}
awk -W posix -v sink="$sink" '
/^[ \t]+Name:/ { insink = ($2 == sink) }
/^[ \t]+Active Port:/ && insink { print $3 }
' <<< "$(pa_list_sinks)"
}
pa_get_active_port_description() {
local -r sink=${1:?$(error 'Sink name is required')}
local -r port=$(pa_get_sink_active_port "$sink")
echo "${PORT_ALIASES[$port]:-${SINK_PORTS[$port]}}"
}
# Load the sink's ports.
#
# Arguments
# Sink name (string) Symbolic name of sink.
pa_load_sink_ports() {
local -r sink=${1:?$(error 'Sink name is required')}
while IFS=: read -r name description; do
SINK_PORTS["$name"]="$description"
done < <(pa_list_sinks | awk -W posix -v sink="$sink" \
'/^[ \t]+Name: / {insink = ($2 == sink)}
/^[ \t]+Ports:/ {inport = insink}
/^[ \t]+[[:print:]]+: [[:print:]]+ \(/ && inport {
start=index($0, ": ")+2;
end=index($0, "(");
len=end-start;
desc=substr($0, start, len)
sub(/[ ]+$/, "", desc)
print $1 desc
}')
}
# Get the index of a sink name.
#
# Arguments
# Sink name (string) Symbolic name of sink.
pa_get_sink_index() {
local -r sink=${1:?$(error 'Sink name is required')}
pa_list_sinks | \
awk -W posix -v sink="$sink" \
'/^Sink #/{gsub("#", ""); idx = $2}
/^[ \t]+Name: / && $2 == sink {print idx; exit}'
}
# Get the volume as a percentage.
#
# Arguments
# Sink name (string) Symbolic name of sink.
pa_get_volume() {
local -r sink=${1:?$(error 'Sink name is required')}
pactl get-sink-volume "$sink" | \
awk -W posix '/^Volume: / {gsub("%,?", ""); print $5; exit}'
}
# Get the base volume as a percentage.
#
# Arguments
# Sink name (string) Symbolic name of sink.
pa_get_base_volume() {
local -r sink=${1:?$(error 'Sink name is required')}
pa_list_sinks | \
awk -W posix -v sink="$sink" \
'/^[ \t]+Name: / {insink = ($2 == sink)}
/^[ \t]+Base Volume: / && insink {gsub("%", ""); print $5; exit}'
}
# Increase volume relative to current volume using pulseaudio.
#
# Arguments:
# Sink name (string) Symbolic name of sink.
# Step (integer) Percentage to increase by.
pa_increase_volume() {
local -r sink=$1
local -r step=${2:=-5}
pa_set_volume "$sink" "+${step}%"
}
# Decrease volume relative to current volume using pulseaudio.
#
# Arguments:
# Sink name (string) Symbolic name of sink.
# Step (integer|percentage) Percentage to decrease by.
pa_decrease_volume() {
local -r sink=$1
local -r step=${2:=-5}
pa_set_volume "$sink" "-${step}%"
}
# Set volume using pulseaudio.
#
# Arguments:
# Sink name (string) Symbolic name of sink.
# Volume (integer|linear factor|percentage|decibel)
pa_set_volume() {
local -r sink=${1:?$(error 'Sink name is required')}
local -r vol=${2:?$(error 'Volume is required')}
pa_invalidate_cache
pactl set-sink-volume "$sink" "$vol"
}
# Toggle mute using pulseaudio.
#
# Arguments:
# Sink name (string) Symbolic name of sink.
pa_toggle_mute() {
local -r sink=${1:?$(error 'Sink name is required')}
pa_invalidate_cache
pactl set-sink-mute "$sink" toggle
}
# Check if sink is muted.
#
# Arguments:
# Sink name (string) Symbolic name of sink.
#
# Returns:
# 0 when true, 1 when false.
pa_is_muted() {
local -r sink=${1:?$(error 'Sink name is required')}
pa_list_sinks | \
awk -W posix -v sink="$sink" \
'/^[ \t]+Name: / {insink = ($2 == sink)}
/^[ \t]+Mute: / && insink && $2 ~ /^yes$/ { exitcode=1 }; END { exit !exitcode }'
}
# Get the flags of the PulseAudio sink.
#
# Arguments
# Sink name (string) Symbolic name of sink.
pa_get_sink_flags() {
local -r sink=${1:?$(error 'Sink name is required')}
pa_list_sinks | \
awk -W posix -v sink="$sink" \
'/^[ \t]+Name: / {insink = ($2 == sink)}
/^[ \t]+Flags: / && insink { for(i = 2; i <= NF; ++i) printf $i FS; exit}'
}
# Get color for the given volume for PulseAudio
#
# Arguments:
# $1 - The volume
pa_volume_color() {
local -ir vol=${1:?$(error 'A volume is required')}
if (( vol >= PA_VOLUME_MUTED && vol < PA_BASE_VOLUME )); then
echo "$COLOR_MUTED_TO_BASE"
elif (( vol >= PA_BASE_VOLUME && vol <= PA_VOLUME_NORM )); then
echo "$COLOR_BASE_TO_NORM"
elif (( vol > PA_VOLUME_NORM && vol <= MAX_VOLUME )); then
echo "$COLOR_NORM_TO_MAX"
else
echo "$COLOR_OTHER"
fi
}
# Listens for PulseAudio events
#
# Arguments:
# Output (optional) (string) An output mode. When set, outputs volume in the output mode format.
listen() {
local -r output=$*
local -r index=$(pa_get_sink_index "$SINK")
# Output volume so statusbars have something to display before any event occurs
not_empty "$output" && output_volume "$output"
while IFS= read -r; do
show_volume_notification
update_statusbar
play_volume_changed
not_empty "$output" && output_volume "$output"
done < <(pactl subscribe | stdbuf -oL grep -e "Event 'change' on sink #$index")
}
# Play a sound file.
#
# Arguments:
# Sound file (string)
pa_play() {
local -r file=$1
command_exists paplay || {
error "paplay is not installed or not in \$PATH"
return 1
}
paplay -d "$SINK" "$file" &
}
}
# Register PulseAudio related functions and settings
setup_pulseaudio() {
define_pulseaudio_functions
PA_LIST_SINKS=$(pactl list sinks) || exit 1
if empty "$SINK"; then
SINK="$(pactl get-default-sink)"
fi
(( ${#SINK_PORTS[@]} < 1 )) && pa_load_sink_ports "$SINK"
# Determine a max volume when it's not specified
if ! isset MAX_VOLUME; then
read -ra SINK_FLAGS < <(pa_get_sink_flags "$SINK")
PA_BASE_VOLUME=$(pa_get_base_volume "$SINK")
# Does the sink support digital (software) amplification?
if [[ "${SINK_FLAGS[*]}" =~ "DECIBEL_VOLUME" ]]; then
MAX_VOLUME=$((PA_VOLUME_NORM * MAX_AMPLIFICATION))
else
MAX_VOLUME=$PA_VOLUME_NORM
fi
fi
}
# All amixer functions are defined here
define_amixer_functions() {
# Get the volume as a percentage.
#
# Arguments
# Card (integer) Card number to control.
# Mixer (string) Name of the mixer.
amixer_get_volume() {
local -r card=$1
local -r mixer=${2:-Master}
amixer ${card:+-c "$card" --} sget "$mixer" | \
awk -W posix -F'[][]' '/dB/ { gsub("%", ""); print $2 }'
}
# Increase volume relative to current volume using amixer.
#
# Arguments:
# Card (integer) Card number to control.
# Step (integer) Percentage to increase by.
amixer_increase_volume() {
local -r card=$1
local -r step=${2:=-5}
amixer_set_volume "${step}%+" "$card"
}
# Decrease volume relative to current volume using amixer.
#
# Arguments:
# Card (integer) Card number to control.
# Step (integer) Percentage to decrease by.
amixer_decrease_volume() {
local -r card=$1
local -r step=${2:=-5}
amixer_set_volume "${step}%-" "$card"