/
volatile.py
executable file
·442 lines (351 loc) · 12.1 KB
/
volatile.py
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
#!/usr/bin/env python
#
# volatile: ALSA / PulseAudio status icon and volume control
# https://github.com/gavinhungry/volatile
#
import alsaaudio
import getopt
import gi
import signal
import sys
import threading
from pulsectl import Pulse, _pulsectl as pulsectl
import warnings
warnings.filterwarnings('ignore', category=DeprecationWarning)
gi.require_version('Gtk', '3.0')
from gi.repository import GLib, Gtk, Gdk
class Volatile:
def __init__(self,
headphones_icon_always, headset_icon_always,
reverse, maxvol, vicons
):
self.HEADPHONES_ICON_ALWAYS = headphones_icon_always
self.HEADSET_ICON_ALWAYS = headset_icon_always
self.REVERSE_SCROLL = reverse
self.MAX_VOLUME = maxvol
self.VOLATILE_ICONS = vicons
self.TIMER = None
self.PANEL_HEIGHT = 34 # in pixels, negative if panel is on bottom
self.SLIDER_WIDTH = 240 # in pixels
self.SLIDER_HEIGHT = 30 # in pixels, adjust if the widget doesn't fit
self.SCROLL_BY = 2 # increase to scroll "faster"
self.VOLUME_MULTIPLIER = float(100) / self.MAX_VOLUME
self.LEVEL_WIDTH = 200
self.LEVEL_HEIGHT = 10
self.LEVEL_PADDING = 8
self.LEVEL_TIMEOUT = 2 # seconds
self.LEVEL_OPACITY = 0.75
if self.REVERSE_SCROLL:
self.SCROLL_BY *= -1
# these should be arguments or environment variables
self.HEADPHONES_SINK_NAME_SUBSTRING = 'BTD_600'
self.HEADSET_SINK_NAME_SUBSTRING = 'SteelSeries'
self.init_gtk()
self.init_pulse()
self.init_mixer()
self.init_pulse_watcher()
self.update(True)
self.icon.set_visible(True)
signal.signal(signal.SIGINT, self.quit)
Gtk.main()
def quit(self, sig, frame):
self.pulse.event_listen_stop()
Gtk.main_quit()
# create the icon, slider and containing window
def init_gtk(self):
self.icon = Gtk.StatusIcon()
self.icon.connect('activate', self.toggle_slider_window)
self.icon.connect('popup-menu', self.toggle_mute)
self.icon.connect('scroll-event', self.on_scroll)
self.headphones_icon = Gtk.StatusIcon()
self.headphones_icon.set_from_icon_name('headphones')
self.headphones_icon.set_title('volatile-headphones')
self.headphones_icon.set_tooltip_text('Headphones')
self.headset_icon = Gtk.StatusIcon()
self.headset_icon.set_from_icon_name('headset')
self.headset_icon.set_title('volatile-headset')
self.headset_icon.set_tooltip_text('Headset')
self.screen = Gdk.Screen.get_default()
self.slider = Gtk.HScale()
self.slider.set_can_focus(False)
self.slider.set_size_request(self.SLIDER_WIDTH, self.SLIDER_HEIGHT)
self.slider.set_range(0, 100)
self.slider.set_increments(self.SCROLL_BY, self.SCROLL_BY * 2)
self.slider.set_draw_value(0)
self.slider.connect('value-changed', self.on_slide)
self.slider_window = Gtk.Window()
self.slider_window.set_skip_taskbar_hint(True)
self.slider_window.set_skip_pager_hint(True)
self.slider_window.set_decorated(False)
self.slider_window.set_resizable(False)
self.slider_window.set_keep_above(True)
self.slider_window.set_role('volatile')
self.slider_window.connect('focus-out-event', self.on_slider_focus_out)
self.slider_frame = Gtk.Frame()
self.slider_frame.add(self.slider)
self.slider_window.add(self.slider_frame)
self.slider_window.set_accept_focus(False)
self.level = Gtk.LevelBar()
self.level.set_can_focus(False)
self.level.set_size_request(self.LEVEL_WIDTH, self.LEVEL_HEIGHT)
self.level.set_max_value(100)
self.level.set_margin_start(self.LEVEL_PADDING)
self.level.set_margin_end(self.LEVEL_PADDING)
self.level.set_margin_top(self.LEVEL_PADDING)
self.level.set_margin_bottom(self.LEVEL_PADDING)
self.level_window = Gtk.Window()
self.level_window.set_skip_taskbar_hint(True)
self.level_window.set_skip_pager_hint(True)
self.level_window.set_decorated(False)
self.level_window.set_resizable(False)
self.level_window.set_keep_above(True)
self.level_window.set_role('volatile-level')
self.level_window.stick()
self.level_frame = Gtk.Frame()
self.level_frame.add(self.level)
self.level_window.add(self.level_frame)
self.level_window.set_accept_focus(False)
context = self.level_window.get_style_context()
self.window_bgcolor = context.get_background_color(Gtk.StateFlags.NORMAL)
if self.LEVEL_OPACITY < 1.0:
if self.screen.is_composited():
# http://www.kcjengr.com/programing/2017/11/02/transparent-gtk-window.html
self.level_window.set_visual(self.screen.get_rgba_visual())
self.level_window.set_app_paintable(True)
self.level_window.connect('draw', self.draw_level)
else:
self.level_window.set_opacity(self.LEVEL_OPACITY)
css_provider = Gtk.CssProvider()
css_provider.load_from_data(b'''
levelbar > trough {
padding: 0;
}
levelbar > trough > block.filled {
border: 1px solid rgba(255, 255, 255, 0.1);
border-right: none;
}
levelbar > trough > block.filled.muted {
background-color: rgba(255, 255, 255, 0.15);
border: none;
}
''')
Gtk.StyleContext().add_provider_for_screen(
self.screen,
css_provider,
Gtk.STYLE_PROVIDER_PRIORITY_APPLICATION
)
# paint transparent background (supports compositing/blur)
def draw_level(self, widget, context):
context.set_source_rgba(
self.window_bgcolor.red,
self.window_bgcolor.green,
self.window_bgcolor.blue,
self.LEVEL_OPACITY
)
context.paint()
def init_pulse(self):
self.pulse = Pulse('volatile')
sink_name = self.pulse.server_info().default_sink_name
self.is_headphones = self.HEADPHONES_SINK_NAME_SUBSTRING in sink_name
self.is_headset = self.HEADSET_SINK_NAME_SUBSTRING in sink_name
self.sink_description = self.pulse.get_sink_by_name(sink_name).description
# define mixer and start watch
def init_mixer(self):
try:
self.mixer = alsaaudio.Mixer('Master', device='pulse')
self.init_pulse()
except alsaaudio.ALSAAudioError:
print >> sys.stderr, 'Could not initialize mixer'
sys.exit(2)
fd, _eventmask = self.mixer.polldescriptors()[0]
self.tag = GLib.io_add_watch(fd, GLib.IOCondition.IN, self.watch)
def reinit_mixer(self):
GLib.source_remove(self.tag)
self.init_mixer()
def on_pulse_event(self, e):
# e.t._value
self.reinit_mixer()
def pulse_watcher(self):
self.pulse = Pulse('event-printer')
self.pulse.event_mask_set('module')
self.pulse.event_callback_set(self.on_pulse_event)
self.pulse.event_listen()
def init_pulse_watcher(self):
self.pulsectl_t = threading.Thread(target=self.pulse_watcher)
self.pulsectl_t.start()
#
def show_slider_window(self):
if self.slider_window.get_property('visible'):
return
self.slider_window.set_position(Gtk.WindowPosition.MOUSE)
self.slider_window.move(
self.slider_window.get_position()[0],
self.PANEL_HEIGHT
)
self.slider_window.show_all()
self.slider_window.present()
#
def hide_slider_window(self):
self.slider_window.hide()
#
def toggle_slider_window(self, widget):
if self.slider_window.get_property('visible'):
self.hide_slider_window()
else:
self.show_slider_window()
#
def show_level_window(self):
if self.level_window.get_property('visible'):
return
self.level_window.set_position(Gtk.WindowPosition.CENTER)
self.level_window.move(
((self.screen.get_width() - self.LEVEL_WIDTH) / 2) - self.LEVEL_PADDING,
1480
)
self.level_window.show_all()
self.level_window.present()
#
def show_level_window_with_timeout(self):
self.show_level_window()
if self.TIMER != None:
self.TIMER.cancel()
self.TIMER = threading.Timer(
self.LEVEL_TIMEOUT,
self.hide_level_window
)
self.TIMER.start()
#
def hide_level_window(self):
self.level_window.hide()
#
def toggle_level_window(self):
if self.level_window.get_property('visible'):
self.hide_level_window()
else:
self.show_level_window()
# toggle current mute state
def toggle_mute(self, widget, button, time):
mute = not self.mixer.getmute()[0]
self.mixer.setmute(mute)
self.update()
#
def clamp(self, value, min = 0, max = 100):
if value > max:
return max
if value < min:
return min
return int(round(value))
#
def level_to_volume(self, level):
volume = level / self.VOLUME_MULTIPLIER
return self.clamp(volume, 0, self.MAX_VOLUME)
#
def volume_to_level(self, volume):
level = volume * self.VOLUME_MULTIPLIER
return self.clamp(level, 0, 100)
#
def get_level(self):
volume = self.mixer.getvolume()[0]
return self.volume_to_level(volume)
#
def set_level(self, level):
volume = self.level_to_volume(level)
self.mixer.setvolume(volume)
self.update()
# event handler for the HScale being dragged
def on_slide(self, widget):
level = widget.get_value()
self.set_level(level)
# event handler for scrolling while hovering the icon
def on_scroll(self, widget, event):
level = self.get_level()
if event.direction == Gdk.ScrollDirection.DOWN:
self.set_level(level - (self.SCROLL_BY))
elif event.direction == Gdk.ScrollDirection.UP:
self.set_level(level + (self.SCROLL_BY))
#
def on_slider_focus_out(self, widget, event):
self.hide_slider_window()
#
def watch(self, fd, cond):
self.mixer.handleevents()
self.update()
return True
#
def set_icon(self, icon_name):
_icon_name = 'volatile-' + icon_name if self.VOLATILE_ICONS else icon_name
self.icon.set_from_icon_name(_icon_name)
# updates the global mixer, moves slider/level and updates icon
def update(self, no_level = False):
level = self.get_level()
muted = self.mixer.getmute()[0]
if self.is_headphones:
self.headphones_icon.set_from_icon_name('headphones')
self.headphones_icon.set_tooltip_text(self.sink_description)
else:
self.headphones_icon.set_from_icon_name('headphones-inactive')
self.headphones_icon.set_tooltip_text('Headphones disconnected')
self.headphones_icon.set_visible(
self.is_headphones or self.HEADPHONES_ICON_ALWAYS
)
if self.is_headset:
self.headset_icon.set_from_icon_name('headset')
self.headset_icon.set_tooltip_text(self.sink_description)
else:
self.headset_icon.set_from_icon_name('headset-inactive')
self.headset_icon.set_tooltip_text('Headset disconnected')
self.headset_icon.set_visible(
self.is_headset or self.HEADSET_ICON_ALWAYS
)
self.slider.set_sensitive(not muted)
if muted:
self.level.add_offset_value('muted', 100)
else:
self.level.remove_offset_value('muted')
self.slider.set_value(level)
self.level.set_value(level)
if not no_level:
self.show_level_window_with_timeout()
if muted:
self.set_icon('audio-volume-muted')
elif level <= 15:
self.set_icon('audio-volume-off')
elif level <= 40:
self.set_icon('audio-volume-low')
elif level <= 65:
self.set_icon('audio-volume-medium')
else:
self.set_icon('audio-volume-high')
tooltip_text = "Volume: {0}%".format(level)
if muted:
tooltip_text += ' (muted)'
self.icon.set_tooltip_text(tooltip_text)
if __name__ == '__main__':
try:
args, _ = getopt.getopt(sys.argv[1:], 'hHrm:v', [
'headphones-icon-always', 'headset-icon-always', 'reverse-scroll',
'max-volume=', 'volatile-icons'
])
except getopt.GetoptError as err:
print >> sys.stderr, err
sys.exit(1)
headphones_icon_always = False
headset_icon_always = False
reverse = False
maxvol = 100
vicons = False
for arg, val in args:
if arg in ('-h', '--headphones-icon-always'):
headphones_icon_always = True
if arg in ('-H', '--headset-icon-always'):
headset_icon_always = True
if arg in ('-r', '--reverse-scroll'):
reverse = True
if arg in ('-m', '--max-volume'):
maxvol = min(100, max(0, int(val)))
if arg in ('-v', '--volatile-icons'):
vicons = True
volatile = Volatile(
headphones_icon_always, headset_icon_always,
reverse, maxvol, vicons
)