# pylint: disable=C0111,R0903 """Displays volume and mute status and controls for PulseAudio devices. Use wheel up and down to change volume, left click mutes, right click opens pavucontrol. !!! This module will eventually be deprecated (since it has bad performance and high CPU load) and be replaced with "pulsectl", which is a much better drop-in replacement !!! Aliases: pasink (use this to control output instead of input), pasource Parameters: * pulseaudio.autostart: If set to 'true' (default is 'false'), automatically starts the pulseaudio daemon if it is not running * pulseaudio.percent_change: How much to change volume by when scrolling on the module (default is 2%) * pulseaudio.limit: Upper limit for setting the volume (default is 0%, which means 'no limit') Note: If the left and right channels have different volumes, the limit might not be reached exactly. * pulseaudio.showbars: 1 for showing volume bars, requires --markup=pango; 0 for not showing volume bars (default) * pulseaudio.showdevicename: If set to 'true' (default is 'false'), the currently selected default device is shown. Per default, the sink/source name returned by "pactl list sinks short" is used as display name. As this name is usually not particularly nice (e.g "alsa_output.usb-Logitech_Logitech_USB_Headset-00.analog-stereo"), its possible to map the name to more a user friendly name. e.g to map "alsa_output.usb-Logitech_Logitech_USB_Headset-00.analog-stereo" to the name "Headset", add the following bumblebee-status config entry: pulseaudio.alsa_output.usb-Logitech_Logitech_USB_Headset-00.analog-stereo=Headset Furthermore its possible to specify individual (unicode) icons for all sinks/sources. e.g in order to use the icon 🎧 for the "alsa_output.usb-Logitech_Logitech_USB_Headset-00.analog-stereo" sink, add the following bumblebee-status config entry: pulseaudio.icon.alsa_output.usb-Logitech_Logitech_USB_Headset-00.analog-stereo=🎧 * Per default a left mouse button click mutes/unmutes the device. In case you want to open a dropdown menu to change the current default device add the following config entry to your bumblebee-status config: pulseaudio.left-click=select_default_device_popup Requires the following executable: * pulseaudio * pactl * pavucontrol """ import re import logging import functools import core.module import core.widget import core.input import util.cli import util.graph import util.format try: import util.popup except ImportError as e: logging.warning("Couldn't import util.popup: %s. Popups won't work!", e) class Module(core.module.Module): def __init__(self, config, theme, channel): super().__init__(config, theme, core.widget.Widget(self.display)) if util.format.asbool(self.parameter("autostart", False)): util.cli.execute("pulseaudio --start", ignore_errors=True) self._change = util.format.asint( self.parameter("percent_change", "2%").strip("%"), 0, 100 ) self._limit = util.format.asint(self.parameter("limit", "0%").strip("%"), 0) self._left = 0 self._right = 0 self._mono = 0 self._mute = False self._failed = False self._channel = channel self.__selected_default_device = None self._showbars = util.format.asbool(self.parameter("showbars", 0)) self.__show_device_name = util.format.asbool( self.parameter("showdevicename", False) ) self._patterns = [ {"expr": "Name:", "callback": (lambda line: False)}, { "expr": "Mute:", "callback": ( lambda line: self.mute(False if " no" in line.lower() else True) ), }, {"expr": "Volume:", "callback": self.getvolume}, ] core.input.register(self, button=core.input.RIGHT_MOUSE, cmd="pavucontrol") events = [ {"type": "mute", "action": self.toggle, "button": core.input.LEFT_MOUSE}, { "type": "volume", "action": self.increase_volume, "button": core.input.WHEEL_UP, }, { "type": "volume", "action": self.decrease_volume, "button": core.input.WHEEL_DOWN, }, ] for event in events: core.input.register(self, button=event["button"], cmd=event["action"]) def set_volume(self, amount): util.cli.execute( "pactl set-{}-{} @DEFAULT_{}@ {}".format( self._channel, "volume", self._channel.upper(), amount ) ) def increase_volume(self, event): if self._limit > 0: # we need to check the limit left = int(self._left) right = int(self._right) if ( left + self._change >= self._limit or right + self._change >= self._limit ): if left == right: # easy case, just set to limit self.set_volume("{}%".format(self._limit)) return else: # don't adjust anymore, since i don't know how to update only one channel return self.set_volume("+{}%".format(self._change)) def decrease_volume(self, event): self.set_volume("-{}%".format(self._change)) def toggle(self, event): util.cli.execute( "pactl set-{}-mute @DEFAULT_{}@ toggle".format( self._channel, self._channel.upper() ) ) def mute(self, value): self._mute = value def getvolume(self, line): if "mono" in line: m = re.search(r"mono:.*\s*\/\s*(\d+)%", line) if m: self._mono = m.group(1) self._left = 0 self._right = 0 else: m = re.search(r"left:.*\s*\/\s*(\d+)%.*right:.*\s*\/\s*(\d+)%", line) if m: self._mono = 0 self._left = m.group(1) self._right = m.group(2) def _default_device(self): output = util.cli.execute("pactl info") pattern = "Default {}: ".format("Sink" if self._channel == "sink" else "Source") for line in output.split("\n"): if line.startswith(pattern): return line.replace(pattern, "") logging.error("no pulseaudio device found") return "n/a" def display(self, widget): if self._failed == True: return "n/a" vol = None if int(self._mono) > 0: vol = "{}%".format(self._mono) if self._showbars: vol = "{} {}".format(vol, util.graph.hbar(float(self._mono))) elif self._left == self._right: vol = "{}%".format(self._left) if self._showbars: vol = "{} {}".format(vol, util.graph.hbar(float(self._left))) else: vol = "{}%/{}%".format(self._left, self._right) if self._showbars: vol = "{} {}{}".format( vol, util.graph.hbar(float(self._left)), util.graph.hbar(float(self._right)), ) output = vol if self.__show_device_name: friendly_name = self.parameter( self.__selected_default_device, self.__selected_default_device ) icon = self.parameter("icon." + self.__selected_default_device, "") output = ( icon + " " + friendly_name + " | " + vol if icon != "" else friendly_name + " | " + vol ) return output def update(self): try: self._failed = False channel = "sinks" if self._channel == "sink" else "sources" self.__selected_default_device = self._default_device() result = util.cli.execute("pactl list {}".format(channel)) found = False for line in result.split("\n"): if "Name: {}".format(self.__selected_default_device) in line: found = True continue if found is False: continue for pattern in self._patterns: if not pattern["expr"] in line: continue if pattern["callback"](line) is False and found == True: return except Exception as e: self._failed = True logging.exception(e) if util.format.asbool(self.parameter("autostart", False)): util.cli.execute("pulseaudio --start", ignore_errors=True) else: raise e def __on_sink_selected(self, sink_name): util.cli.execute("pactl set-default-{} {}".format(self._channel, sink_name)) def select_default_device_popup(self, widget): channel = "sinks" if self._channel == "sink" else "sources" result = util.cli.execute("pactl list {} short".format(channel)) menu = util.popup.menu() lines = result.splitlines() for line in lines: info = line.split("\t") try: friendly_name = self.parameter(info[1], info[1]) menu.add_menuitem( friendly_name, callback=functools.partial(self.__on_sink_selected, info[1]), ) except: logging.exception("Couldn't parse {}".format(channel)) pass menu.show(widget) def state(self, widget): if self._mute: return ["warning", "muted"] return ["unmuted"] # vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4