From 25d9eecfc68df3251dc96008aaa4cd7c81900da6 Mon Sep 17 00:00:00 2001 From: streetturtle Date: Fri, 19 Mar 2021 20:49:00 -0400 Subject: [volume] BREAKING CHANGE - new widget instead of old ones Having three widgets for volume led to a problem of code duplication - same logic was duplicated three times. However when an issue was discovered and fixed, it was fixed in only one of three widgets. So I decided to create a volume widget from scratch, adding new features, such as selecting input/output, better responsiveness, easily customizable widget ui (bar, text, icon, icon and text, arc). Should close #199, #198, #185, #182, #47, #122, #183. --- experiments/volume/README.md | 112 ------- .../volume/icons/audio-volume-high-symbolic.svg | 88 ------ .../volume/icons/audio-volume-low-symbolic.svg | 88 ------ .../volume/icons/audio-volume-medium-symbolic.svg | 88 ------ .../volume/icons/audio-volume-muted-symbolic.svg | 88 ------ experiments/volume/screenshots/variations.png | Bin 9153 -> 0 bytes .../volume/screenshots/volume-sink-sources.png | Bin 74043 -> 0 bytes experiments/volume/utils.lua | 105 ------- experiments/volume/volume-2.svg | 1 - experiments/volume/volume.lua | 218 -------------- experiments/volume/widgets/arc-widget.lua | 46 --- .../volume/widgets/horizontal-bar-widget.lua | 58 ---- .../volume/widgets/icon-and-text-widget.lua | 59 ---- experiments/volume/widgets/icon-widget.lua | 46 --- experiments/volume/widgets/vertical-bar-widget.lua | 64 ---- volume-widget/README.md | 159 +++++----- volume-widget/audio-volume-muted-symbolic.png | Bin 435 -> 0 bytes volume-widget/audio-volume-muted-symbolic.svg | 88 ------ volume-widget/audio-volume-muted-symbolic_new.svg | 81 ----- volume-widget/audio-volume-muted-symbolic_red.png | Bin 450 -> 0 bytes volume-widget/audio-volume-muted-symbolic_red.svg | 88 ------ volume-widget/icons/audio-volume-high-symbolic.svg | 88 ++++++ volume-widget/icons/audio-volume-low-symbolic.svg | 88 ++++++ .../icons/audio-volume-medium-symbolic.svg | 88 ++++++ .../icons/audio-volume-muted-symbolic.svg | 88 ++++++ volume-widget/screenshots/variations.png | Bin 0 -> 9153 bytes volume-widget/screenshots/volume-sink-sources.png | Bin 0 -> 74043 bytes volume-widget/utils.lua | 105 +++++++ volume-widget/vol-widget-1.png | Bin 824 -> 0 bytes volume-widget/volume-2.svg | 1 + volume-widget/volume.lua | 329 ++++++++++++--------- volume-widget/widgets/arc-widget.lua | 46 +++ volume-widget/widgets/horizontal-bar-widget.lua | 58 ++++ volume-widget/widgets/icon-and-text-widget.lua | 59 ++++ volume-widget/widgets/icon-widget.lua | 46 +++ volume-widget/widgets/vertical-bar-widget.lua | 64 ++++ volumearc-widget/README.md | 69 ----- volumearc-widget/custom.png | Bin 9424 -> 0 bytes volumearc-widget/out.gif | Bin 7288 -> 0 bytes volumearc-widget/volumearc.lua | 140 --------- volumebar-widget/README.md | 85 ------ volumebar-widget/custom.png | Bin 9126 -> 0 bytes volumebar-widget/out.gif | Bin 5983 -> 0 bytes volumebar-widget/volumebar.lua | 87 ------ 44 files changed, 994 insertions(+), 1924 deletions(-) delete mode 100644 experiments/volume/README.md delete mode 100644 experiments/volume/icons/audio-volume-high-symbolic.svg delete mode 100644 experiments/volume/icons/audio-volume-low-symbolic.svg delete mode 100644 experiments/volume/icons/audio-volume-medium-symbolic.svg delete mode 100644 experiments/volume/icons/audio-volume-muted-symbolic.svg delete mode 100644 experiments/volume/screenshots/variations.png delete mode 100644 experiments/volume/screenshots/volume-sink-sources.png delete mode 100644 experiments/volume/utils.lua delete mode 100644 experiments/volume/volume-2.svg delete mode 100644 experiments/volume/volume.lua delete mode 100644 experiments/volume/widgets/arc-widget.lua delete mode 100644 experiments/volume/widgets/horizontal-bar-widget.lua delete mode 100644 experiments/volume/widgets/icon-and-text-widget.lua delete mode 100644 experiments/volume/widgets/icon-widget.lua delete mode 100644 experiments/volume/widgets/vertical-bar-widget.lua delete mode 100644 volume-widget/audio-volume-muted-symbolic.png delete mode 100644 volume-widget/audio-volume-muted-symbolic.svg delete mode 100644 volume-widget/audio-volume-muted-symbolic_new.svg delete mode 100644 volume-widget/audio-volume-muted-symbolic_red.png delete mode 100644 volume-widget/audio-volume-muted-symbolic_red.svg create mode 100644 volume-widget/icons/audio-volume-high-symbolic.svg create mode 100644 volume-widget/icons/audio-volume-low-symbolic.svg create mode 100644 volume-widget/icons/audio-volume-medium-symbolic.svg create mode 100644 volume-widget/icons/audio-volume-muted-symbolic.svg create mode 100644 volume-widget/screenshots/variations.png create mode 100644 volume-widget/screenshots/volume-sink-sources.png create mode 100644 volume-widget/utils.lua delete mode 100644 volume-widget/vol-widget-1.png create mode 100644 volume-widget/volume-2.svg create mode 100644 volume-widget/widgets/arc-widget.lua create mode 100644 volume-widget/widgets/horizontal-bar-widget.lua create mode 100644 volume-widget/widgets/icon-and-text-widget.lua create mode 100644 volume-widget/widgets/icon-widget.lua create mode 100644 volume-widget/widgets/vertical-bar-widget.lua delete mode 100644 volumearc-widget/README.md delete mode 100644 volumearc-widget/custom.png delete mode 100644 volumearc-widget/out.gif delete mode 100644 volumearc-widget/volumearc.lua delete mode 100644 volumebar-widget/README.md delete mode 100644 volumebar-widget/custom.png delete mode 100644 volumebar-widget/out.gif delete mode 100644 volumebar-widget/volumebar.lua diff --git a/experiments/volume/README.md b/experiments/volume/README.md deleted file mode 100644 index 973bb49..0000000 --- a/experiments/volume/README.md +++ /dev/null @@ -1,112 +0,0 @@ -# Volume widget - -Volume widget based on [amixer](https://linux.die.net/man/1/amixer) (is used for controlling the audio volume) and [pacmd](https://linux.die.net/man/1/pacmd) (is used for selecting a sink/source). Also, the widget provides an easy way to customize how it looks, following types are supported out-of-the-box: - -![types](./screenshots/variations.png) - -From left to right: `horizontal_bar`, `vertical_bar`, `icon`, `icon_and_text`, `arc` - -A right-click on the widget opens a popup where you can choose a sink/source: -![sink-sources](./screenshots/volume-sink-sources.png) - -### Features - - - switch between sinks/sources by right clicking on the widget; - - more responsive than previous versions of volume widget, which were refreshed once a second; - - 5 predefined customizable looks; - -## Installation - -Clone the repo under **~/.config/awesome/** and add widget in **rc.lua**: - -```lua -local volume_widget = require('awesome-wm-widgets.experiments.volume.volume') -... -s.mytasklist, -- Middle widget - { -- Right widgets - layout = wibox.layout.fixed.horizontal, - ... - -- default - volume_widget(), - -- customized - volume_widget{ - type = 'arc' - }, -``` - -### Shortcuts - -To improve responsiveness of the widget when volume level is changed by a shortcut use corresponding methods of the widget: - -```lua -awful.key({ modkey }, "]", function() volume_widget:inc() end), -awful.key({ modkey }, "[", function() volume_widget:dec() end), -awful.key({ modkey }, "\\", function() volume_widget:toggle() end), -``` - -## Customization - -It is possible to customize the widget by providing a table with all or some of the following config parameters: - -### Generic parameter - -| Name | Default | Description | -|---|---|---| -| `type`| `icon_and_text`| Widget type, one of `horizontal_bar`, `vertical_bar`, `icon`, `icon_and_text`, `arc` | - -Depending on the chosen widget type add parameters from the corresponding section below: - -#### `icon` parameters - -| Name | Default | Description | -|---|---|---| -| `icon_dir`| `./icons`| Path to the folder with icons | - -_Note:_ if you are changing icons, the folder should contain following .svg images: - - audio-volume-high-symbolic - - audio-volume-medium-symbolic - - audio-volume-low-symbolic - - audio-volume-muted-symbolic - -#### `icon_and_text` parameters - -| Name | Default | Description | -|---|---|---| -| `icon_dir`| `./icons`| Path to the folder with icons | -| `font` | `beautiful.font` | Font name and size, like `Play 12` | - -#### `arc` parameters - -| Name | Default | Description | -|---|---|---| -| `thickness` | 2 | Thickness of the arc | -| `main_color` | `beautiful.fg_color` | Color of the arc | -| `bg_color` | `#ffffff11` | Color of the arc's background | -| `mute_color` | `beautiful.fg_urgent` | Color of the arc when mute | -| `size` | 18 | Size of the widget | - -#### `horizontal_bar` parameters - -| Name | Default | Description | -|---|---|---| -| `main_color` | `beautiful.fg_normal` | Color of the bar | -| `mute_color` | `beautiful.fg_urgent` | Color of the bar when mute | -| `bg_color` | `'#ffffff11'` | Color of the bar's background | -| `width` | `50` | The bar width | -| `margins` | `10` | Top and bottom margins (if your wibar is 22 px high, bar will be 2 px = 22 - 2*10) | -| `shape` | `'bar'` | [gears.shape](https://awesomewm.org/doc/api/libraries/gears.shape.html), could be `octogon`, `hexagon`, `powerline`, etc | -| `with_icon` | `true` | Show volume icon| - -_Note:_ I didn't figure out how does the `forced_height` property of progressbar widget work (maybe it doesn't work at all), thus there is a workaround with margins. - -#### `vertical_bar` parameters - -| Name | Default | Description | -|---|---|---| -| `main_color` | `beautiful.fg_normal` | Color of the bar | -| `mute_color` | `beautiful.fg_urgent` | Color of the bar when mute | -| `bg_color` | `'#ffffff11'` | Color of the bar's background | -| `width` | `10` | The bar width | -| `margins` | `20` | Top and bottom margins (if your wibar is 22 px high, bar will be 2 px = 22 - 2*10) | -| `shape` | `'bar'` | [gears.shape](https://awesomewm.org/doc/api/libraries/gears.shape.html), could be `octogon`, `hexagon`, `powerline`, etc | -| `with_icon` | `true` | Show volume icon| diff --git a/experiments/volume/icons/audio-volume-high-symbolic.svg b/experiments/volume/icons/audio-volume-high-symbolic.svg deleted file mode 100644 index 985c107..0000000 --- a/experiments/volume/icons/audio-volume-high-symbolic.svg +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - image/svg+xml - - - - - - - - - - - - - - - diff --git a/experiments/volume/icons/audio-volume-low-symbolic.svg b/experiments/volume/icons/audio-volume-low-symbolic.svg deleted file mode 100644 index 7eb4531..0000000 --- a/experiments/volume/icons/audio-volume-low-symbolic.svg +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - image/svg+xml - - - - - - - - - - - - - - - diff --git a/experiments/volume/icons/audio-volume-medium-symbolic.svg b/experiments/volume/icons/audio-volume-medium-symbolic.svg deleted file mode 100644 index 11e44fe..0000000 --- a/experiments/volume/icons/audio-volume-medium-symbolic.svg +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - image/svg+xml - - - - - - - - - - - - - - - diff --git a/experiments/volume/icons/audio-volume-muted-symbolic.svg b/experiments/volume/icons/audio-volume-muted-symbolic.svg deleted file mode 100644 index e577d05..0000000 --- a/experiments/volume/icons/audio-volume-muted-symbolic.svg +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - image/svg+xml - - - - - - - - - - - - - - - diff --git a/experiments/volume/screenshots/variations.png b/experiments/volume/screenshots/variations.png deleted file mode 100644 index 21d7ead..0000000 Binary files a/experiments/volume/screenshots/variations.png and /dev/null differ diff --git a/experiments/volume/screenshots/volume-sink-sources.png b/experiments/volume/screenshots/volume-sink-sources.png deleted file mode 100644 index 7d010bc..0000000 Binary files a/experiments/volume/screenshots/volume-sink-sources.png and /dev/null differ diff --git a/experiments/volume/utils.lua b/experiments/volume/utils.lua deleted file mode 100644 index 417a666..0000000 --- a/experiments/volume/utils.lua +++ /dev/null @@ -1,105 +0,0 @@ - - -local utils = {} - -local function split(string_to_split, separator) - if separator == nil then separator = "%s" end - local t = {} - - for str in string.gmatch(string_to_split, "([^".. separator .."]+)") do - table.insert(t, str) - end - - return t -end - -function utils.extract_sinks_and_sources(pacmd_output) - local sinks = {} - local sources = {} - local device - local properties - local ports - local in_sink = false - local in_source = false - local in_device = false - local in_properties = false - local in_ports = false - for line in pacmd_output:gmatch("[^\r\n]+") do - if string.match(line, 'source%(s%) available.') then - in_sink = false - in_source = true - end - if string.match(line, 'sink%(s%) available.') then - in_sink = true - in_source = false - end - - if string.match(line, 'index:') then - in_device = true - in_properties = false - device = { - id = line:match(': (%d+)'), - is_default = string.match(line, '*') ~= nil - } - if in_sink then - table.insert(sinks, device) - elseif in_source then - table.insert(sources, device) - end - end - - if string.match(line, '^\tproperties:') then - in_device = false - in_properties = true - properties = {} - device['properties'] = properties - end - - if string.match(line, 'ports:') then - in_device = false - in_properties = false - in_ports = true - ports = {} - device['ports'] = ports - end - - if string.match(line, 'active port:') then - in_device = false - in_properties = false - in_ports = false - device['active_port'] = line:match(': (.+)'):gsub('<',''):gsub('>','') - end - - if in_device then - local t = split(line, ': ') - local key = t[1]:gsub('\t+', ''):lower() - local value = t[2]:gsub('^<', ''):gsub('>$', '') - device[key] = value - end - - if in_properties then - local t = split(line, '=') - local key = t[1]:gsub('\t+', ''):gsub('%.', '_'):gsub('-', '_'):gsub(':', ''):gsub("%s+$", "") - local value - if t[2] == nil then - value = t[2] - else - value = t[2]:gsub('"', ''):gsub("^%s+", ""):gsub(' Analog Stereo', '') - end - properties[key] = value - end - - if in_ports then - local t = split(line, ': ') - local key = t[1] - if key ~= nil then - key = key:gsub('\t+', '') - end - ports[key] = t[2] - end - end - - return sinks, sources -end - -return utils \ No newline at end of file diff --git a/experiments/volume/volume-2.svg b/experiments/volume/volume-2.svg deleted file mode 100644 index 10f1c67..0000000 --- a/experiments/volume/volume-2.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/experiments/volume/volume.lua b/experiments/volume/volume.lua deleted file mode 100644 index 7bdda1c..0000000 --- a/experiments/volume/volume.lua +++ /dev/null @@ -1,218 +0,0 @@ -------------------------------------------------- --- The Ultimate Volume Widget for Awesome Window Manager --- More details could be found here: --- https://github.com/streetturtle/awesome-wm-widgets/tree/master/volume-widget - --- @author Pavel Makhov --- @copyright 2020 Pavel Makhov -------------------------------------------------- - -local awful = require("awful") -local wibox = require("wibox") -local spawn = require("awful.spawn") -local gears = require("gears") -local beautiful = require("beautiful") -local watch = require("awful.widget.watch") -local utils = require("awesome-wm-widgets.experiments.volume.utils") - - -local LIST_DEVICES_CMD = [[sh -c "pacmd list-sinks; pacmd list-sources"]] -local GET_VOLUME_CMD = 'amixer -D pulse sget Master' -local INC_VOLUME_CMD = 'amixer -D pulse sset Master 5%+' -local DEC_VOLUME_CMD = 'amixer -D pulse sset Master 5%-' -local TOG_VOLUME_CMD = 'amixer -D pulse sset Master toggle' - - -local widget_types = { - icon_and_text = require("awesome-wm-widgets.experiments.volume.widgets.icon-and-text-widget"), - icon = require("awesome-wm-widgets.experiments.volume.widgets.icon-widget"), - arc = require("awesome-wm-widgets.experiments.volume.widgets.arc-widget"), - horizontal_bar = require("awesome-wm-widgets.experiments.volume.widgets.horizontal-bar-widget"), - vertical_bar = require("awesome-wm-widgets.experiments.volume.widgets.vertical-bar-widget") -} -local volume = {} - -local rows = { layout = wibox.layout.fixed.vertical } - -local popup = awful.popup{ - bg = beautiful.bg_normal, - ontop = true, - visible = false, - shape = gears.shape.rounded_rect, - border_width = 1, - border_color = beautiful.bg_focus, - maximum_width = 400, - offset = { y = 5 }, - widget = {} -} - -local function build_main_line(device) - if device.active_port ~= nil and device.ports[device.active_port] ~= nil then - return device.properties.device_description .. ' · ' .. device.ports[device.active_port] - else - return device.properties.device_description - end -end - -local function build_rows(devices, on_checkbox_click, device_type) - local device_rows = { layout = wibox.layout.fixed.vertical } - for _, device in pairs(devices) do - - local checkbox = wibox.widget { - checked = device.is_default, - color = beautiful.bg_normal, - paddings = 2, - shape = gears.shape.circle, - forced_width = 20, - forced_height = 20, - check_color = beautiful.fg_urgent, - widget = wibox.widget.checkbox - } - - checkbox:connect_signal("button::press", function() - spawn.easy_async(string.format([[sh -c 'pacmd set-default-%s "%s"']], device_type, device.name), function() - on_checkbox_click() - end) - end) - - local row = wibox.widget { - { - { - { - checkbox, - valign = 'center', - layout = wibox.container.place, - }, - { - { - text = build_main_line(device), - align = 'left', - widget = wibox.widget.textbox - }, - left = 10, - layout = wibox.container.margin - }, - spacing = 8, - layout = wibox.layout.align.horizontal - }, - margins = 4, - layout = wibox.container.margin - }, - bg = beautiful.bg_normal, - widget = wibox.container.background - } - - row:connect_signal("mouse::enter", function(c) c:set_bg(beautiful.bg_focus) end) - row:connect_signal("mouse::leave", function(c) c:set_bg(beautiful.bg_normal) end) - - local old_cursor, old_wibox - row:connect_signal("mouse::enter", function() - local wb = mouse.current_wibox - old_cursor, old_wibox = wb.cursor, wb - wb.cursor = "hand1" - end) - row:connect_signal("mouse::leave", function() - if old_wibox then - old_wibox.cursor = old_cursor - old_wibox = nil - end - end) - - row:connect_signal("button::press", function() - spawn.easy_async(string.format([[sh -c 'pacmd set-default-%s "%s"']], device_type, device.name), function() - on_checkbox_click() - end) - end) - - table.insert(device_rows, row) - end - - return device_rows -end - -local function build_header_row(text) - return wibox.widget{ - { - markup = "" .. text .. "", - align = 'center', - widget = wibox.widget.textbox - }, - bg = beautiful.bg_normal, - widget = wibox.container.background - } -end - -local function rebuild_popup() - spawn.easy_async(LIST_DEVICES_CMD, function(stdout) - - local sinks, sources = utils.extract_sinks_and_sources(stdout) - - for i = 0, #rows do rows[i]=nil end - - table.insert(rows, build_header_row("SINKS")) - table.insert(rows, build_rows(sinks, function() rebuild_popup() end, "sink")) - table.insert(rows, build_header_row("SOURCES")) - table.insert(rows, build_rows(sources, function() rebuild_popup() end, "source")) - - popup:setup(rows) - end) -end - - -local function worker(user_args) - - local args = user_args or {} - - local widget_type = args.widget_type - local refresh_rate = args.refresh_rate or 1 - - if widget_types[widget_type] == nil then - volume.widget = widget_types['icon_and_text'].get_widget(user_args.icon_and_text_args) - else - volume.widget = widget_types[widget_type].get_widget(args) - end - - local function update_graphic(widget, stdout) - local mute = string.match(stdout, "%[(o%D%D?)%]") -- \[(o\D\D?)\] - [on] or [off] - if mute == 'off' then widget:mute() - elseif mute == 'on' then widget:unmute() - end - local volume_level = string.match(stdout, "(%d?%d?%d)%%") -- (\d?\d?\d)\%) - volume_level = string.format("% 3d", volume_level) - widget:set_volume_level(volume_level) - end - - function volume:inc() - spawn.easy_async(INC_VOLUME_CMD, function(stdout) update_graphic(volume.widget, stdout) end) - end - - function volume:dec() - spawn.easy_async(DEC_VOLUME_CMD, function(stdout) update_graphic(volume.widget, stdout) end) - end - - function volume:toggle() - spawn.easy_async(TOG_VOLUME_CMD, function(stdout) update_graphic(volume.widget, stdout) end) - end - - volume.widget:buttons( - awful.util.table.join( - awful.button({}, 3, function() - if popup.visible then - popup.visible = not popup.visible - else - rebuild_popup() - popup:move_next_to(mouse.current_widget_geometry) - end - end), - awful.button({}, 4, function() volume:inc() end), - awful.button({}, 5, function() volume:dec() end), - awful.button({}, 1, function() volume:toggle() end) - ) - ) - - watch(GET_VOLUME_CMD, refresh_rate, update_graphic, volume.widget) - - return volume.widget -end - -return setmetatable(volume, { __call = function(_, ...) return worker(...) end }) diff --git a/experiments/volume/widgets/arc-widget.lua b/experiments/volume/widgets/arc-widget.lua deleted file mode 100644 index b6c9d22..0000000 --- a/experiments/volume/widgets/arc-widget.lua +++ /dev/null @@ -1,46 +0,0 @@ -local wibox = require("wibox") -local beautiful = require('beautiful') - -local ICON_DIR = os.getenv("HOME") .. '/.config/awesome/awesome-wm-widgets/experiments/volume/icons/' - -local widget = {} - -function widget.get_widget(widgets_args) - local args = widgets_args or {} - - local thickness = args.thickness or 2 - local main_color = args.main_color or beautiful.fg_color - local bg_color = args.bg_color or '#ffffff11' - local mute_color = args.mute_color or beautiful.fg_urgent - local size = args.size or 18 - - return wibox.widget { - { - id = "icon", - image = ICON_DIR .. 'audio-volume-high-symbolic.svg', - resize = true, - widget = wibox.widget.imagebox, - }, - max_value = 100, - thickness = thickness, - start_angle = 4.71238898, -- 2pi*3/4 - forced_height = size, - forced_width = size, - bg = bg_color, - paddings = 2, - widget = wibox.container.arcchart, - set_volume_level = function(self, new_value) - self.value = new_value - end, - mute = function(self) - self.colors = { mute_color } - end, - unmute = function(self) - self.colors = { main_color } - end - } - -end - - -return widget \ No newline at end of file diff --git a/experiments/volume/widgets/horizontal-bar-widget.lua b/experiments/volume/widgets/horizontal-bar-widget.lua deleted file mode 100644 index 1a1c8a4..0000000 --- a/experiments/volume/widgets/horizontal-bar-widget.lua +++ /dev/null @@ -1,58 +0,0 @@ -local wibox = require("wibox") -local beautiful = require('beautiful') -local gears = require("gears") - -local ICON_DIR = os.getenv("HOME") .. '/.config/awesome/awesome-wm-widgets/experiments/volume/icons/' - -local widget = {} - -function widget.get_widget(widgets_args) - local args = widgets_args or {} - - local main_color = args.main_color or beautiful.fg_normal - local mute_color = args.mute_color or beautiful.fg_urgent - local bg_color = args.bg_color or '#ffffff11' - local width = args.width or 50 - local margins = args.margins or 10 - local shape = args.shape or 'bar' - local with_icon = args.with_icon == true and true or false - - local bar = wibox.widget { - { - { - id = "icon", - image = ICON_DIR .. 'audio-volume-high-symbolic.svg', - resize = false, - widget = wibox.widget.imagebox, - }, - valign = 'center', - visible = with_icon, - layout = wibox.container.place, - }, - { - id = 'bar', - max_value = 100, - forced_width = width, - color = main_color, - margins = { top = margins, bottom = margins }, - background_color = bg_color, - shape = gears.shape[shape], - widget = wibox.widget.progressbar, - }, - spacing = 4, - layout = wibox.layout.fixed.horizontal, - set_volume_level = function(self, new_value) - self:get_children_by_id('bar')[1]:set_value(tonumber(new_value)) - end, - mute = function(self) - self:get_children_by_id('bar')[1]:set_color(mute_color) - end, - unmute = function(self) - self:get_children_by_id('bar')[1]:set_color(main_color) - end - } - - return bar -end - -return widget diff --git a/experiments/volume/widgets/icon-and-text-widget.lua b/experiments/volume/widgets/icon-and-text-widget.lua deleted file mode 100644 index 0ee8d16..0000000 --- a/experiments/volume/widgets/icon-and-text-widget.lua +++ /dev/null @@ -1,59 +0,0 @@ -local wibox = require("wibox") -local beautiful = require('beautiful') - -local widget = {} - -local ICON_DIR = os.getenv("HOME") .. '/.config/awesome/awesome-wm-widgets/experiments/volume/icons/' - -function widget.get_widget(widgets_args) - local args = widgets_args or {} - - local font = args.font or beautiful.font - local icon_dir = args.icon_dir or ICON_DIR - - return wibox.widget { - { - { - id = "icon", - resize = false, - widget = wibox.widget.imagebox, - }, - valign = 'center', - layout = wibox.container.place - }, - { - id = 'txt', - font = font, - widget = wibox.widget.textbox - }, - layout = wibox.layout.fixed.horizontal, - set_volume_level = function(self, new_value) - self:get_children_by_id('txt')[1]:set_text(new_value) - local volume_icon_name - if self.is_muted then - volume_icon_name = 'audio-volume-muted-symbolic' - else - local new_value_num = tonumber(new_value) - if (new_value_num >= 0 and new_value_num < 33) then - volume_icon_name="audio-volume-low-symbolic" - elseif (new_value_num < 66) then - volume_icon_name="audio-volume-medium-symbolic" - else - volume_icon_name="audio-volume-high-symbolic" - end - end - self:get_children_by_id('icon')[1]:set_image(icon_dir .. volume_icon_name .. '.svg') - end, - mute = function(self) - self.is_muted = true - self:get_children_by_id('icon')[1]:set_image(icon_dir .. 'audio-volume-muted-symbolic.svg') - end, - unmute = function(self) - self.is_muted = false - end - } - -end - - -return widget \ No newline at end of file diff --git a/experiments/volume/widgets/icon-widget.lua b/experiments/volume/widgets/icon-widget.lua deleted file mode 100644 index f2aca26..0000000 --- a/experiments/volume/widgets/icon-widget.lua +++ /dev/null @@ -1,46 +0,0 @@ -local wibox = require("wibox") - -local widget = {} - -local ICON_DIR = os.getenv("HOME") .. '/.config/awesome/awesome-wm-widgets/experiments/volume/icons/' - -function widget.get_widget(widgets_args) - local args = widgets_args or {} - - local icon_dir = args.icon_dir or ICON_DIR - - return wibox.widget { - { - id = "icon", - resize = false, - widget = wibox.widget.imagebox, - }, - valign = 'center', - layout = wibox.container.place, - set_volume_level = function(self, new_value) - local volume_icon_name - if self.is_muted then - volume_icon_name = 'audio-volume-muted-symbolic' - else - local new_value_num = tonumber(new_value) - if (new_value_num >= 0 and new_value_num < 33) then - volume_icon_name="audio-volume-low-symbolic" - elseif (new_value_num < 66) then - volume_icon_name="audio-volume-medium-symbolic" - else - volume_icon_name="audio-volume-high-symbolic" - end - end - self:get_children_by_id('icon')[1]:set_image(icon_dir .. volume_icon_name .. '.svg') - end, - mute = function(self) - self.is_muted = true - self:get_children_by_id('icon')[1]:set_image(icon_dir .. 'audio-volume-muted-symbolic.svg') - end, - unmute = function(self) - self.is_muted = false - end - } -end - -return widget \ No newline at end of file diff --git a/experiments/volume/widgets/vertical-bar-widget.lua b/experiments/volume/widgets/vertical-bar-widget.lua deleted file mode 100644 index 82f4b8a..0000000 --- a/experiments/volume/widgets/vertical-bar-widget.lua +++ /dev/null @@ -1,64 +0,0 @@ -local wibox = require("wibox") -local beautiful = require('beautiful') -local gears = require("gears") - -local ICON_DIR = os.getenv("HOME") .. '/.config/awesome/awesome-wm-widgets/experiments/volume/icons/' - -local widget = {} - -function widget.get_widget(widgets_args) - local args = widgets_args or {} - - local main_color = args.main_color or beautiful.fg_normal - local mute_color = args.mute_color or beautiful.fg_urgent - local bg_color = args.bg_color or '#ffffff11' - local width = args.width or 10 - local margins = args.height or 2 - local shape = args.shape or 'bar' - local with_icon = args.with_icon == true and true or false - - local bar = wibox.widget { - { - { - id = "icon", - image = ICON_DIR .. 'audio-volume-high-symbolic.svg', - resize = false, - widget = wibox.widget.imagebox, - }, - valign = 'center', - visible = with_icon, - layout = wibox.container.place, - }, - { - { - id = 'bar', - max_value = 100, - forced_width = width, - forced_height = 5, - margins = { top = margins, bottom = margins }, - color = main_color, - background_color = bg_color, - shape = gears.shape[shape], - widget = wibox.widget.progressbar, - }, - forced_width = width, - direction = 'east', - layout = wibox.container.rotate, - }, - spacing = 4, - layout = wibox.layout.fixed.horizontal, - set_volume_level = function(self, new_value) - self:get_children_by_id('bar')[1]:set_value(tonumber(new_value)) - end, - mute = function(self) - self:get_children_by_id('bar')[1]:set_color(mute_color) - end, - unmute = function(self) - self:get_children_by_id('bar')[1]:set_color(main_color) - end - } - - return bar -end - -return widget diff --git a/volume-widget/README.md b/volume-widget/README.md index aebcf98..d08b795 100644 --- a/volume-widget/README.md +++ b/volume-widget/README.md @@ -1,109 +1,112 @@ # Volume widget -Simple and easy-to-install widget for Awesome Window Manager which shows the sound level: ![Volume Widget](./vol-widget-1.png) +Volume widget based on [amixer](https://linux.die.net/man/1/amixer) (is used for controlling the audio volume) and [pacmd](https://linux.die.net/man/1/pacmd) (is used for selecting a sink/source). Also, the widget provides an easy way to customize how it looks, following types are supported out-of-the-box: -Note that widget uses the Arc icon theme, so it should be [installed](https://github.com/horst3180/arc-icon-theme#installation) first under **/usr/share/icons/Arc/** folder. +![types](screenshots/variations.png) -## Customization +From left to right: `horizontal_bar`, `vertical_bar`, `icon`, `icon_and_text`, `arc` -It is possible to customize widget by providing a table with all or some of the following config parameters: +A right-click on the widget opens a popup where you can choose a sink/source: +![sink-sources](screenshots/volume-sink-sources.png) -| Name | Default | Description | -|---|---|---| -| `volume_audio_controller`| `pulse` | audio device | -| `display_notification` | `false` | Display a notification on mouseover and keypress | -| `notification_position` | `top_right`| The notification position | -| `delta` | 5 | The volume +/- percentage | +### Features -## Installation + - switch between sinks/sources by right clicking on the widget; + - more responsive than previous versions of volume widget, which were refreshed once a second; + - 5 predefined customizable looks; -- clone/copy **volume.lua** file; +## Installation -- include `volume.lua` and add volume widget to your wibox in rc.lua: +Clone the repo under **~/.config/awesome/** and add widget in **rc.lua**: ```lua -local volume_widget = require("awesome-wm-widgets.volume-widget.volume") -local volume_widget_widget = volume_widget({display_notification = true}) +local volume_widget = require('awesome-wm-widgets.volume-widget.volume') ... - s.mytasklist, -- Middle widget - { -- Right widgets - ... - volume_widget_widget, - ... - +s.mytasklist, -- Middle widget + { -- Right widgets + layout = wibox.layout.fixed.horizontal, + ... + -- default + volume_widget(), + -- customized + volume_widget{ + type = 'arc' + }, ``` -### Control volume -To mute/unmute click on the widget. To increase/decrease volume scroll up or down when mouse cursor is over the widget. +### Shortcuts -If you want to control volume level by keyboard shortcuts add following lines in shortcut section of the **rc.lua**: -IF you have notification activated, a notification will pop-up on key press +To improve responsiveness of the widget when volume level is changed by a shortcut use corresponding methods of the widget: ```lua --- Key bindings -globalkeys = gears.table.join( - awful.key( - {}, - 'XF86AudioRaiseVolume', - volume_widget.raise, - {description = 'volume up', group = 'hotkeys'} - ), - awful.key( - {}, - 'XF86AudioLowerVolume', - volume_widget.lower, - {description = 'volume down', group = 'hotkeys'} - ), - awful.key( - {}, - 'XF86AudioMute', - volume_widget.toggle, - {description = 'toggle mute', group = 'hotkeys'} - ), +awful.key({ modkey }, "]", function() volume_widget:inc() end), +awful.key({ modkey }, "[", function() volume_widget:dec() end), +awful.key({ modkey }, "\\", function() volume_widget:toggle() end), ``` -### Icons +## Customization -- _Optional step._ In Arc icon theme the muted audio level icon (![Volume-widget](./audio-volume-muted-symbolic.png)) looks like 0 level icon, which could be a bit misleading. - So I decided to use original muted icon for low audio level, and the same icon, but colored in red for muted audio level. Fortunately icons are in svg format, so you can easily recolor them with `sed`, so it would look like this (![Volume Widget](./audio-volume-muted-symbolic_red.png)): +It is possible to customize the widget by providing a table with all or some of the following config parameters: - ```bash - cd /usr/share/icons/Arc/status/symbolic && - sudo cp audio-volume-muted-symbolic.svg audio-volume-muted-symbolic_red.svg && - sudo sed -i 's/bebebe/ed4737/g' ./audio-volume-muted-symbolic_red.svg - ``` +### Generic parameter -### Pulse or ALSA only +| Name | Default | Description | +|---|---|---| +| `type`| `icon_and_text`| Widget type, one of `horizontal_bar`, `vertical_bar`, `icon`, `icon_and_text`, `arc` | -Try running this command: +Depending on the chosen widget type add parameters from the corresponding section below: -```bash -amixer -D pulse sget Master -``` +#### `icon` parameters -If that prints something like this, then the default setting of 'pulse' is probably fine: +| Name | Default | Description | +|---|---|---| +| `icon_dir`| `./icons`| Path to the folder with icons | -``` -Simple mixer control 'Master',0 - Capabilities: pvolume pvolume-joined pswitch pswitch-joined - Playback channels: Mono - Limits: Playback 0 - 64 - Mono: Playback 64 [100%] [0.00dB] [on] +_Note:_ if you are changing icons, the folder should contain following .svg images: + - audio-volume-high-symbolic + - audio-volume-medium-symbolic + - audio-volume-low-symbolic + - audio-volume-muted-symbolic -``` +#### `icon_and_text` parameters -If it prints something like this: +| Name | Default | Description | +|---|---|---| +| `icon_dir`| `./icons`| Path to the folder with icons | +| `font` | `beautiful.font` | Font name and size, like `Play 12` | -```bash -$ amixer -D pulse sget Master -ALSA lib pulse.c:243:(pulse_connect) PulseAudio: Unable to connect: Connection refused +#### `arc` parameters -amixer: Mixer attach pulse error: Connection refused -``` -then set `volume_audio_controller` to `alsa_only` in widget constructor: +| Name | Default | Description | +|---|---|---| +| `thickness` | 2 | Thickness of the arc | +| `main_color` | `beautiful.fg_color` | Color of the arc | +| `bg_color` | `#ffffff11` | Color of the arc's background | +| `mute_color` | `beautiful.fg_urgent` | Color of the arc when mute | +| `size` | 18 | Size of the widget | -```lua -volume_widget({ - volume_audio_controller = 'alsa_only' -}) -``` +#### `horizontal_bar` parameters + +| Name | Default | Description | +|---|---|---| +| `main_color` | `beautiful.fg_normal` | Color of the bar | +| `mute_color` | `beautiful.fg_urgent` | Color of the bar when mute | +| `bg_color` | `'#ffffff11'` | Color of the bar's background | +| `width` | `50` | The bar width | +| `margins` | `10` | Top and bottom margins (if your wibar is 22 px high, bar will be 2 px = 22 - 2*10) | +| `shape` | `'bar'` | [gears.shape](https://awesomewm.org/doc/api/libraries/gears.shape.html), could be `octogon`, `hexagon`, `powerline`, etc | +| `with_icon` | `true` | Show volume icon| + +_Note:_ I didn't figure out how does the `forced_height` property of progressbar widget work (maybe it doesn't work at all), thus there is a workaround with margins. + +#### `vertical_bar` parameters + +| Name | Default | Description | +|---|---|---| +| `main_color` | `beautiful.fg_normal` | Color of the bar | +| `mute_color` | `beautiful.fg_urgent` | Color of the bar when mute | +| `bg_color` | `'#ffffff11'` | Color of the bar's background | +| `width` | `10` | The bar width | +| `margins` | `20` | Top and bottom margins (if your wibar is 22 px high, bar will be 2 px = 22 - 2*10) | +| `shape` | `'bar'` | [gears.shape](https://awesomewm.org/doc/api/libraries/gears.shape.html), could be `octogon`, `hexagon`, `powerline`, etc | +| `with_icon` | `true` | Show volume icon| diff --git a/volume-widget/audio-volume-muted-symbolic.png b/volume-widget/audio-volume-muted-symbolic.png deleted file mode 100644 index b9dffd6..0000000 Binary files a/volume-widget/audio-volume-muted-symbolic.png and /dev/null differ diff --git a/volume-widget/audio-volume-muted-symbolic.svg b/volume-widget/audio-volume-muted-symbolic.svg deleted file mode 100644 index e577d05..0000000 --- a/volume-widget/audio-volume-muted-symbolic.svg +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - image/svg+xml - - - - - - - - - - - - - - - diff --git a/volume-widget/audio-volume-muted-symbolic_new.svg b/volume-widget/audio-volume-muted-symbolic_new.svg deleted file mode 100644 index 504c146..0000000 --- a/volume-widget/audio-volume-muted-symbolic_new.svg +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - image/svg+xml - - - - - - - - - - - - - - diff --git a/volume-widget/audio-volume-muted-symbolic_red.png b/volume-widget/audio-volume-muted-symbolic_red.png deleted file mode 100644 index f47807d..0000000 Binary files a/volume-widget/audio-volume-muted-symbolic_red.png and /dev/null differ diff --git a/volume-widget/audio-volume-muted-symbolic_red.svg b/volume-widget/audio-volume-muted-symbolic_red.svg deleted file mode 100644 index d42c2ba..0000000 --- a/volume-widget/audio-volume-muted-symbolic_red.svg +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - image/svg+xml - - - - - - - - - - - - - - - diff --git a/volume-widget/icons/audio-volume-high-symbolic.svg b/volume-widget/icons/audio-volume-high-symbolic.svg new file mode 100644 index 0000000..985c107 --- /dev/null +++ b/volume-widget/icons/audio-volume-high-symbolic.svg @@ -0,0 +1,88 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + diff --git a/volume-widget/icons/audio-volume-low-symbolic.svg b/volume-widget/icons/audio-volume-low-symbolic.svg new file mode 100644 index 0000000..7eb4531 --- /dev/null +++ b/volume-widget/icons/audio-volume-low-symbolic.svg @@ -0,0 +1,88 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + diff --git a/volume-widget/icons/audio-volume-medium-symbolic.svg b/volume-widget/icons/audio-volume-medium-symbolic.svg new file mode 100644 index 0000000..11e44fe --- /dev/null +++ b/volume-widget/icons/audio-volume-medium-symbolic.svg @@ -0,0 +1,88 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + diff --git a/volume-widget/icons/audio-volume-muted-symbolic.svg b/volume-widget/icons/audio-volume-muted-symbolic.svg new file mode 100644 index 0000000..e577d05 --- /dev/null +++ b/volume-widget/icons/audio-volume-muted-symbolic.svg @@ -0,0 +1,88 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + diff --git a/volume-widget/screenshots/variations.png b/volume-widget/screenshots/variations.png new file mode 100644 index 0000000..21d7ead Binary files /dev/null and b/volume-widget/screenshots/variations.png differ diff --git a/volume-widget/screenshots/volume-sink-sources.png b/volume-widget/screenshots/volume-sink-sources.png new file mode 100644 index 0000000..7d010bc Binary files /dev/null and b/volume-widget/screenshots/volume-sink-sources.png differ diff --git a/volume-widget/utils.lua b/volume-widget/utils.lua new file mode 100644 index 0000000..417a666 --- /dev/null +++ b/volume-widget/utils.lua @@ -0,0 +1,105 @@ + + +local utils = {} + +local function split(string_to_split, separator) + if separator == nil then separator = "%s" end + local t = {} + + for str in string.gmatch(string_to_split, "([^".. separator .."]+)") do + table.insert(t, str) + end + + return t +end + +function utils.extract_sinks_and_sources(pacmd_output) + local sinks = {} + local sources = {} + local device + local properties + local ports + local in_sink = false + local in_source = false + local in_device = false + local in_properties = false + local in_ports = false + for line in pacmd_output:gmatch("[^\r\n]+") do + if string.match(line, 'source%(s%) available.') then + in_sink = false + in_source = true + end + if string.match(line, 'sink%(s%) available.') then + in_sink = true + in_source = false + end + + if string.match(line, 'index:') then + in_device = true + in_properties = false + device = { + id = line:match(': (%d+)'), + is_default = string.match(line, '*') ~= nil + } + if in_sink then + table.insert(sinks, device) + elseif in_source then + table.insert(sources, device) + end + end + + if string.match(line, '^\tproperties:') then + in_device = false + in_properties = true + properties = {} + device['properties'] = properties + end + + if string.match(line, 'ports:') then + in_device = false + in_properties = false + in_ports = true + ports = {} + device['ports'] = ports + end + + if string.match(line, 'active port:') then + in_device = false + in_properties = false + in_ports = false + device['active_port'] = line:match(': (.+)'):gsub('<',''):gsub('>','') + end + + if in_device then + local t = split(line, ': ') + local key = t[1]:gsub('\t+', ''):lower() + local value = t[2]:gsub('^<', ''):gsub('>$', '') + device[key] = value + end + + if in_properties then + local t = split(line, '=') + local key = t[1]:gsub('\t+', ''):gsub('%.', '_'):gsub('-', '_'):gsub(':', ''):gsub("%s+$", "") + local value + if t[2] == nil then + value = t[2] + else + value = t[2]:gsub('"', ''):gsub("^%s+", ""):gsub(' Analog Stereo', '') + end + properties[key] = value + end + + if in_ports then + local t = split(line, ': ') + local key = t[1] + if key ~= nil then + key = key:gsub('\t+', '') + end + ports[key] = t[2] + end + end + + return sinks, sources +end + +return utils \ No newline at end of file diff --git a/volume-widget/vol-widget-1.png b/volume-widget/vol-widget-1.png deleted file mode 100644 index 6f09cce..0000000 Binary files a/volume-widget/vol-widget-1.png and /dev/null differ diff --git a/volume-widget/volume-2.svg b/volume-widget/volume-2.svg new file mode 100644 index 0000000..10f1c67 --- /dev/null +++ b/volume-widget/volume-2.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/volume-widget/volume.lua b/volume-widget/volume.lua index cb8c21d..59f0a7a 100644 --- a/volume-widget/volume.lua +++ b/volume-widget/volume.lua @@ -1,181 +1,216 @@ ------------------------------------------------- --- Volume Widget for Awesome Window Manager --- Shows the current volume level +-- The Ultimate Volume Widget for Awesome Window Manager -- More details could be found here: -- https://github.com/streetturtle/awesome-wm-widgets/tree/master/volume-widget --- @author Pavel Makhov, Aurélien Lajoie --- @copyright 2018 Pavel Makhov +-- @author Pavel Makhov +-- @copyright 2020 Pavel Makhov ------------------------------------------------- +local awful = require("awful") local wibox = require("wibox") local spawn = require("awful.spawn") -local naughty = require("naughty") -local gfs = require("gears.filesystem") -local dpi = require('beautiful').xresources.apply_dpi - -local PATH_TO_ICONS = "/usr/share/icons/Arc/status/symbolic/" -local volume_icon_name="audio-volume-high-symbolic" -local GET_VOLUME_CMD = 'amixer sget Master' - -local volume = { - device = '', - display_notification = false, - display_notification_onClick = true, - notification = nil, - delta = 5 -} +local gears = require("gears") +local beautiful = require("beautiful") +local watch = require("awful.widget.watch") +local utils = require("awesome-wm-widgets.volume-widget.utils") -function volume:toggle() - volume:_cmd('amixer ' .. volume.device .. ' sset Master toggle') -end -function volume:raise() - volume:_cmd('amixer ' .. volume.device .. ' sset Master ' .. tostring(volume.delta) .. '%+') -end -function volume:lower() - volume:_cmd('amixer ' .. volume.device .. ' sset Master ' .. tostring(volume.delta) .. '%-') -end +local LIST_DEVICES_CMD = [[sh -c "pacmd list-sinks; pacmd list-sources"]] +local GET_VOLUME_CMD = 'amixer -D pulse sget Master' +local INC_VOLUME_CMD = 'amixer -D pulse sset Master 5%+' +local DEC_VOLUME_CMD = 'amixer -D pulse sset Master 5%-' +local TOG_VOLUME_CMD = 'amixer -D pulse sset Master toggle' ---{{{ Icon and notification update - --------------------------------------------------- --- Set the icon and return the message to display --- base on sound level and mute --------------------------------------------------- -local function parse_output(stdout) - local level = string.match(stdout, "(%d?%d?%d)%%") - if stdout:find("%[off%]") then - volume_icon_name="audio-volume-muted-symbolic_red" - return level.."% Mute" - end - level = tonumber(string.format("% 3d", level)) - - if (level >= 0 and level < 25) then - volume_icon_name="audio-volume-muted-symbolic" - elseif (level < 50) then - volume_icon_name="audio-volume-low-symbolic" - elseif (level < 75) then - volume_icon_name="audio-volume-medium-symbolic" + +local widget_types = { + icon_and_text = require("awesome-wm-widgets.volume-widget.widgets.icon-and-text-widget"), + icon = require("awesome-wm-widgets.volume-widget.widgets.icon-widget"), + arc = require("awesome-wm-widgets.volume-widget.widgets.arc-widget"), + horizontal_bar = require("awesome-wm-widgets.volume-widget.widgets.horizontal-bar-widget"), + vertical_bar = require("awesome-wm-widgets.volume-widget.widgets.vertical-bar-widget") +} +local volume = {} + +local rows = { layout = wibox.layout.fixed.vertical } + +local popup = awful.popup{ + bg = beautiful.bg_normal, + ontop = true, + visible = false, + shape = gears.shape.rounded_rect, + border_width = 1, + border_color = beautiful.bg_focus, + maximum_width = 400, + offset = { y = 5 }, + widget = {} +} + +local function build_main_line(device) + if device.active_port ~= nil and device.ports[device.active_port] ~= nil then + return device.properties.device_description .. ' · ' .. device.ports[device.active_port] else - volume_icon_name="audio-volume-high-symbolic" + return device.properties.device_description end - return level.."%" end --------------------------------------------------------- ---Update the icon and the notification if needed --------------------------------------------------------- -local function update_graphic(widget, stdout, _, _, _) - local txt = parse_output(stdout) - widget.image = PATH_TO_ICONS .. volume_icon_name .. ".svg" - if (volume.display_notification or volume.display_notification_onClick) then - volume.notification.iconbox.image = PATH_TO_ICONS .. volume_icon_name .. ".svg" - naughty.replace_text(volume.notification, "Volume", txt) - end -end +local function build_rows(devices, on_checkbox_click, device_type) + local device_rows = { layout = wibox.layout.fixed.vertical } + for _, device in pairs(devices) do + + local checkbox = wibox.widget { + checked = device.is_default, + color = beautiful.bg_normal, + paddings = 2, + shape = gears.shape.circle, + forced_width = 20, + forced_height = 20, + check_color = beautiful.fg_urgent, + widget = wibox.widget.checkbox + } + + checkbox:connect_signal("button::press", function() + spawn.easy_async(string.format([[sh -c 'pacmd set-default-%s "%s"']], device_type, device.name), function() + on_checkbox_click() + end) + end) -local function notif(msg, keep) - if (volume.display_notification or (keep and volume.display_notification_onClick)) then - naughty.destroy(volume.notification) - volume.notification= naughty.notify{ - text = msg, - icon=PATH_TO_ICONS .. volume_icon_name .. ".svg", - icon_size = dpi(16), - title = "Volume", - position = volume.position, - timeout = keep and 0 or 2, hover_timeout = 0.5, - width = 200, - screen = mouse.screen + local row = wibox.widget { + { + { + { + checkbox, + valign = 'center', + layout = wibox.container.place, + }, + { + { + text = build_main_line(device), + align = 'left', + widget = wibox.widget.textbox + }, + left = 10, + layout = wibox.container.margin + }, + spacing = 8, + layout = wibox.layout.align.horizontal + }, + margins = 4, + layout = wibox.container.margin + }, + bg = beautiful.bg_normal, + widget = wibox.container.background } + + row:connect_signal("mouse::enter", function(c) c:set_bg(beautiful.bg_focus) end) + row:connect_signal("mouse::leave", function(c) c:set_bg(beautiful.bg_normal) end) + + local old_cursor, old_wibox + row:connect_signal("mouse::enter", function() + local wb = mouse.current_wibox + old_cursor, old_wibox = wb.cursor, wb + wb.cursor = "hand1" + end) + row:connect_signal("mouse::leave", function() + if old_wibox then + old_wibox.cursor = old_cursor + old_wibox = nil + end + end) + + row:connect_signal("button::press", function() + spawn.easy_async(string.format([[sh -c 'pacmd set-default-%s "%s"']], device_type, device.name), function() + on_checkbox_click() + end) + end) + + table.insert(device_rows, row) end + + return device_rows +end + +local function build_header_row(text) + return wibox.widget{ + { + markup = "" .. text .. "", + align = 'center', + widget = wibox.widget.textbox + }, + bg = beautiful.bg_normal, + widget = wibox.container.background + } +end + +local function rebuild_popup() + spawn.easy_async(LIST_DEVICES_CMD, function(stdout) + + local sinks, sources = utils.extract_sinks_and_sources(stdout) + + for i = 0, #rows do rows[i]=nil end + + table.insert(rows, build_header_row("SINKS")) + table.insert(rows, build_rows(sinks, function() rebuild_popup() end, "sink")) + table.insert(rows, build_header_row("SOURCES")) + table.insert(rows, build_rows(sources, function() rebuild_popup() end, "source")) + + popup:setup(rows) + end) end ---}}} local function worker(user_args) ---{{{ Args + local args = user_args or {} - local volume_audio_controller = args.volume_audio_controller or 'pulse' - volume.display_notification = args.display_notification or false - volume.display_notification_onClick = args.display_notification_onClick or true - volume.position = args.notification_position or "top_right" - if volume_audio_controller == 'pulse' then - volume.device = '-D pulse' - end - volume.delta = args.delta or 5 - GET_VOLUME_CMD = 'amixer ' .. volume.device.. ' sget Master' ---}}} ---{{{ Check for icon path - if not gfs.dir_readable(PATH_TO_ICONS) then - naughty.notify{ - title = "Volume Widget", - text = "Folder with icons doesn't exist: " .. PATH_TO_ICONS, - preset = naughty.config.presets.critical - } - return + local widget_type = args.widget_type + local refresh_rate = args.refresh_rate or 1 + + if widget_types[widget_type] == nil then + volume.widget = widget_types['icon_and_text'].get_widget(user_args.icon_and_text_args) + else + volume.widget = widget_types[widget_type].get_widget(args) end ---}}} ---{{{ Widget creation - volume.widget = wibox.widget { - { - id = "icon", - image = PATH_TO_ICONS .. "audio-volume-muted-symbolic.svg", - resize = false, - widget = wibox.widget.imagebox, - }, - margins = 3, - layout = wibox.container.margin, - set_image = function(self, path) - self.icon.image = path + + local function update_graphic(widget, stdout) + local mute = string.match(stdout, "%[(o%D%D?)%]") -- \[(o\D\D?)\] - [on] or [off] + if mute == 'off' then widget:mute() + elseif mute == 'on' then widget:unmute() end - } ---}}} ---{{{ Spawn functions - function volume:_cmd(cmd) - notif("") - spawn.easy_async(cmd, function(stdout, stderr, exitreason, exitcode) - update_graphic(volume.widget, stdout, stderr, exitreason, exitcode) - end) + local volume_level = string.match(stdout, "(%d?%d?%d)%%") -- (\d?\d?\d)\%) + volume_level = string.format("% 3d", volume_level) + widget:set_volume_level(volume_level) end - local function show() - spawn.easy_async(GET_VOLUME_CMD, function(stdout, _, _, _) - local txt = parse_output(stdout) - notif(txt, true) - end - ) + function volume:inc() + spawn.easy_async(INC_VOLUME_CMD, function(stdout) update_graphic(volume.widget, stdout) end) end ---}}} ---{{{ Mouse event - --[[ allows control volume level by: - - clicking on the widget to mute/unmute - - scrolling when cursor is over the widget - ]] - volume.widget:connect_signal("button::press", function(_,_,_,button) - if (button == 4) then volume.raise() - elseif (button == 5) then volume.lower() - elseif (button == 1) then volume.toggle() - end - end) - if volume.display_notification then - volume.widget:connect_signal("mouse::enter", function() show() end) - volume.widget:connect_signal("mouse::leave", function() naughty.destroy(volume.notification) end) - elseif volume.display_notification_onClick then - volume.widget:connect_signal("button::press", function(_,_,_,button) - if (button == 3) then show() end - end) - volume.widget:connect_signal("mouse::leave", function() naughty.destroy(volume.notification) end) + + function volume:dec() + spawn.easy_async(DEC_VOLUME_CMD, function(stdout) update_graphic(volume.widget, stdout) end) end ---}}} ---{{{ Set initial icon - spawn.easy_async(GET_VOLUME_CMD, function(stdout) - parse_output(stdout) - volume.widget.image = PATH_TO_ICONS .. volume_icon_name .. ".svg" - end) ---}}} + function volume:toggle() + spawn.easy_async(TOG_VOLUME_CMD, function(stdout) update_graphic(volume.widget, stdout) end) + end + + volume.widget:buttons( + awful.util.table.join( + awful.button({}, 3, function() + if popup.visible then + popup.visible = not popup.visible + else + rebuild_popup() + popup:move_next_to(mouse.current_widget_geometry) + end + end), + awful.button({}, 4, function() volume:inc() end), + awful.button({}, 5, function() volume:dec() end), + awful.button({}, 1, function() volume:toggle() end) + ) + ) + + watch(GET_VOLUME_CMD, refresh_rate, update_graphic, volume.widget) return volume.widget end diff --git a/volume-widget/widgets/arc-widget.lua b/volume-widget/widgets/arc-widget.lua new file mode 100644 index 0000000..b512f12 --- /dev/null +++ b/volume-widget/widgets/arc-widget.lua @@ -0,0 +1,46 @@ +local wibox = require("wibox") +local beautiful = require('beautiful') + +local ICON_DIR = os.getenv("HOME") .. '/.config/awesome/awesome-wm-widgets/volume-widget/icons/' + +local widget = {} + +function widget.get_widget(widgets_args) + local args = widgets_args or {} + + local thickness = args.thickness or 2 + local main_color = args.main_color or beautiful.fg_color + local bg_color = args.bg_color or '#ffffff11' + local mute_color = args.mute_color or beautiful.fg_urgent + local size = args.size or 18 + + return wibox.widget { + { + id = "icon", + image = ICON_DIR .. 'audio-volume-high-symbolic.svg', + resize = true, + widget = wibox.widget.imagebox, + }, + max_value = 100, + thickness = thickness, + start_angle = 4.71238898, -- 2pi*3/4 + forced_height = size, + forced_width = size, + bg = bg_color, + paddings = 2, + widget = wibox.container.arcchart, + set_volume_level = function(self, new_value) + self.value = new_value + end, + mute = function(self) + self.colors = { mute_color } + end, + unmute = function(self) + self.colors = { main_color } + end + } + +end + + +return widget \ No newline at end of file diff --git a/volume-widget/widgets/horizontal-bar-widget.lua b/volume-widget/widgets/horizontal-bar-widget.lua new file mode 100644 index 0000000..be1f38d --- /dev/null +++ b/volume-widget/widgets/horizontal-bar-widget.lua @@ -0,0 +1,58 @@ +local wibox = require("wibox") +local beautiful = require('beautiful') +local gears = require("gears") + +local ICON_DIR = os.getenv("HOME") .. '/.config/awesome/awesome-wm-widgets/volume-widget/icons/' + +local widget = {} + +function widget.get_widget(widgets_args) + local args = widgets_args or {} + + local main_color = args.main_color or beautiful.fg_normal + local mute_color = args.mute_color or beautiful.fg_urgent + local bg_color = args.bg_color or '#ffffff11' + local width = args.width or 50 + local margins = args.margins or 10 + local shape = args.shape or 'bar' + local with_icon = args.with_icon == true and true or false + + local bar = wibox.widget { + { + { + id = "icon", + image = ICON_DIR .. 'audio-volume-high-symbolic.svg', + resize = false, + widget = wibox.widget.imagebox, + }, + valign = 'center', + visible = with_icon, + layout = wibox.container.place, + }, + { + id = 'bar', + max_value = 100, + forced_width = width, + color = main_color, + margins = { top = margins, bottom = margins }, + background_color = bg_color, + shape = gears.shape[shape], + widget = wibox.widget.progressbar, + }, + spacing = 4, + layout = wibox.layout.fixed.horizontal, + set_volume_level = function(self, new_value) + self:get_children_by_id('bar')[1]:set_value(tonumber(new_value)) + end, + mute = function(self) + self:get_children_by_id('bar')[1]:set_color(mute_color) + end, + unmute = function(self) + self:get_children_by_id('bar')[1]:set_color(main_color) + end + } + + return bar +end + +return widget diff --git a/volume-widget/widgets/icon-and-text-widget.lua b/volume-widget/widgets/icon-and-text-widget.lua new file mode 100644 index 0000000..b1a2793 --- /dev/null +++ b/volume-widget/widgets/icon-and-text-widget.lua @@ -0,0 +1,59 @@ +local wibox = require("wibox") +local beautiful = require('beautiful') + +local widget = {} + +local ICON_DIR = os.getenv("HOME") .. '/.config/awesome/awesome-wm-widgets/volume-widget/icons/' + +function widget.get_widget(widgets_args) + local args = widgets_args or {} + + local font = args.font or beautiful.font + local icon_dir = args.icon_dir or ICON_DIR + + return wibox.widget { + { + { + id = "icon", + resize = false, + widget = wibox.widget.imagebox, + }, + valign = 'center', + layout = wibox.container.place + }, + { + id = 'txt', + font = font, + widget = wibox.widget.textbox + }, + layout = wibox.layout.fixed.horizontal, + set_volume_level = function(self, new_value) + self:get_children_by_id('txt')[1]:set_text(new_value) + local volume_icon_name + if self.is_muted then + volume_icon_name = 'audio-volume-muted-symbolic' + else + local new_value_num = tonumber(new_value) + if (new_value_num >= 0 and new_value_num < 33) then + volume_icon_name="audio-volume-low-symbolic" + elseif (new_value_num < 66) then + volume_icon_name="audio-volume-medium-symbolic" + else + volume_icon_name="audio-volume-high-symbolic" + end + end + self:get_children_by_id('icon')[1]:set_image(icon_dir .. volume_icon_name .. '.svg') + end, + mute = function(self) + self.is_muted = true + self:get_children_by_id('icon')[1]:set_image(icon_dir .. 'audio-volume-muted-symbolic.svg') + end, + unmute = function(self) + self.is_muted = false + end + } + +end + + +return widget \ No newline at end of file diff --git a/volume-widget/widgets/icon-widget.lua b/volume-widget/widgets/icon-widget.lua new file mode 100644 index 0000000..cc39a3d --- /dev/null +++ b/volume-widget/widgets/icon-widget.lua @@ -0,0 +1,46 @@ +local wibox = require("wibox") + +local widget = {} + +local ICON_DIR = os.getenv("HOME") .. '/.config/awesome/awesome-wm-widgets/volume-widget/icons/' + +function widget.get_widget(widgets_args) + local args = widgets_args or {} + + local icon_dir = args.icon_dir or ICON_DIR + + return wibox.widget { + { + id = "icon", + resize = false, + widget = wibox.widget.imagebox, + }, + valign = 'center', + layout = wibox.container.place, + set_volume_level = function(self, new_value) + local volume_icon_name + if self.is_muted then + volume_icon_name = 'audio-volume-muted-symbolic' + else + local new_value_num = tonumber(new_value) + if (new_value_num >= 0 and new_value_num < 33) then + volume_icon_name="audio-volume-low-symbolic" + elseif (new_value_num < 66) then + volume_icon_name="audio-volume-medium-symbolic" + else + volume_icon_name="audio-volume-high-symbolic" + end + end + self:get_children_by_id('icon')[1]:set_image(icon_dir .. volume_icon_name .. '.svg') + end, + mute = function(self) + self.is_muted = true + self:get_children_by_id('icon')[1]:set_image(icon_dir .. 'audio-volume-muted-symbolic.svg') + end, + unmute = function(self) + self.is_muted = false + end + } +end + +return widget \ No newline at end of file diff --git a/volume-widget/widgets/vertical-bar-widget.lua b/volume-widget/widgets/vertical-bar-widget.lua new file mode 100644 index 0000000..6f32b50 --- /dev/null +++ b/volume-widget/widgets/vertical-bar-widget.lua @@ -0,0 +1,64 @@ +local wibox = require("wibox") +local beautiful = require('beautiful') +local gears = require("gears") + +local ICON_DIR = os.getenv("HOME") .. '/.config/awesome/awesome-wm-widgets/volume-widget/icons/' + +local widget = {} + +function widget.get_widget(widgets_args) + local args = widgets_args or {} + + local main_color = args.main_color or beautiful.fg_normal + local mute_color = args.mute_color or beautiful.fg_urgent + local bg_color = args.bg_color or '#ffffff11' + local width = args.width or 10 + local margins = args.height or 2 + local shape = args.shape or 'bar' + local with_icon = args.with_icon == true and true or false + + local bar = wibox.widget { + { + { + id = "icon", + image = ICON_DIR .. 'audio-volume-high-symbolic.svg', + resize = false, + widget = wibox.widget.imagebox, + }, + valign = 'center', + visible = with_icon, + layout = wibox.container.place, + }, + { + { + id = 'bar', + max_value = 100, + forced_width = width, + forced_height = 5, + margins = { top = margins, bottom = margins }, + color = main_color, + background_color = bg_color, + shape = gears.shape[shape], + widget = wibox.widget.progressbar, + }, + forced_width = width, + direction = 'east', + layout = wibox.container.rotate, + }, + spacing = 4, + layout = wibox.layout.fixed.horizontal, + set_volume_level = function(self, new_value) + self:get_children_by_id('bar')[1]:set_value(tonumber(new_value)) + end, + mute = function(self) + self:get_children_by_id('bar')[1]:set_color(mute_color) + end, + unmute = function(self) + self:get_children_by_id('bar')[1]:set_color(main_color) + end + } + + return bar +end + +return widget diff --git a/volumearc-widget/README.md b/volumearc-widget/README.md deleted file mode 100644 index 496797e..0000000 --- a/volumearc-widget/README.md +++ /dev/null @@ -1,69 +0,0 @@ -# Volumearc widget - -Almost the same as [volumebar widget](https://github.com/streetturtle/awesome-wm-widgets/tree/master/volumebar-widget), but using [arcchart](https://awesomewm.org/doc/api/classes/wibox.container.arcchart.html): - -![screenshot](./out.gif) - -Supports - - scroll up - increase volume, - - scroll down - decrease volume, - - left click - mute/unmute. - -## Customization - -It is possible to customize widget by providing a table with all or some of the following config parameters: - -| Name | Default | Description | -|---|---|---| -| `main_color` | `beautiful.fg_normal` | Color of the arc | -| `bg_color` | `#ffffff11` | Color of the arc's background | -| `mute_color` | `beautiful.fg_urgent` | Color of the arc when mute | -| `path_to_icon` | /usr/share/icons/Arc/status/symbolic/audio-volume-muted-symbolic.svg | Path to the icon | -| `thickness` | 2 | The arc thickness | -| `height` | `beautiful.fg_normal` | Widget height | -| `timeout` | 1 | How often in seconds the widget refreshes | -| `get_volume_cmd` | `amixer -D pulse sget Master` | Get current volume level | -| `inc_volume_cmd` | `amixer -D pulse sset Master 5%+` | Increase volume level | -| `dec_volume_cmd` | `amixer -D pulse sset Master 5%-` | Decrease volume level | -| `tog_volume_cmd` | `amixer -D pulse sset Master toggle` | Mute / unmute | -| `button_press` | `function(_, _, _, button) end` | Overwrite the 'button\_press' signal for this widget | - -### Example: - -```lua -volumearc_widget({ - main_color = '#af13f7', - mute_color = '#ff0000', - thickness = 5, - height = 25, - button_press = function(_, _, _, button) -- Overwrites the button press behaviour to open pavucontrol when clicked - if (button == 1) then awful.spawn('pavucontrol --tab=3', false) - end - end -}) -``` - -The config above results in the following widget: - -![custom](./custom.png) - -## Installation - -1. Clone this repo under **~/.config/awesome/** - - ```bash - git clone https://github.com/streetturtle/awesome-wm-widgets.git ~/.config/awesome/awesome-wm-widgets - ``` - -1. Require volumearc widget at the beginning of **rc.lua**: - -```lua -local volumearc_widget = require("awesome-wm-widgets.volumearc-widget.volumearc") -... -s.mytasklist, -- Middle widget - { -- Right widgets - layout = wibox.layout.fixed.horizontal, - ... - volumearc_widget(), - ... -``` diff --git a/volumearc-widget/custom.png b/volumearc-widget/custom.png deleted file mode 100644 index f187345..0000000 Binary files a/volumearc-widget/custom.png and /dev/null differ diff --git a/volumearc-widget/out.gif b/volumearc-widget/out.gif deleted file mode 100644 index 61fa486..0000000 Binary files a/volumearc-widget/out.gif and /dev/null differ diff --git a/volumearc-widget/volumearc.lua b/volumearc-widget/volumearc.lua deleted file mode 100644 index b104ad3..0000000 --- a/volumearc-widget/volumearc.lua +++ /dev/null @@ -1,140 +0,0 @@ -------------------------------------------------- --- Volume Arc Widget for Awesome Window Manager --- Shows the current volume level --- More details could be found here: --- https://github.com/streetturtle/awesome-wm-widgets/tree/master/volumearc-widget - --- @author Pavel Makhov --- @copyright 2018 Pavel Makhov -------------------------------------------------- - -local awful = require("awful") -local beautiful = require("beautiful") -local spawn = require("awful.spawn") -local watch = require("awful.widget.watch") -local wibox = require("wibox") -local gears = require("gears") - -local GET_VOLUME_CMD = 'amixer -D pulse sget Master' -local INC_VOLUME_CMD = 'amixer -q -D pulse sset Master 5%+' -local DEC_VOLUME_CMD = 'amixer -q -D pulse sset Master 5%-' -local TOG_VOLUME_CMD = 'amixer -q -D pulse sset Master toggle' - -local PATH_TO_ICON = "/usr/share/icons/Arc/status/symbolic/audio-volume-muted-symbolic.svg" - -local widget = {} - -local popup = awful.popup{ - ontop = true, - visible = false, - shape = gears.shape.rounded_rect, - border_width = 1, - border_color = beautiful.bg_focus, - maximum_width = 400, - offset = { y = 5 }, - widget = {} -} -local rows = { - { widget = wibox.widget.textbox }, - layout = wibox.layout.fixed.vertical, -} -local function worker(user_args) - - local args = user_args or {} - - local main_color = args.main_color or beautiful.fg_color - local bg_color = args.bg_color or '#ffffff11' - local mute_color = args.mute_color or beautiful.fg_urgent - local path_to_icon = args.path_to_icon or PATH_TO_ICON - local thickness = args.thickness or 2 - local margins = args.height or 18 - local timeout = args.timeout or 1 - - local get_volume_cmd = args.get_volume_cmd or GET_VOLUME_CMD - local inc_volume_cmd = args.inc_volume_cmd or INC_VOLUME_CMD - local dec_volume_cmd = args.dec_volume_cmd or DEC_VOLUME_CMD - local tog_volume_cmd = args.tog_volume_cmd or TOG_VOLUME_CMD - - local icon = { - id = "icon", - image = path_to_icon, - resize = true, - widget = wibox.widget.imagebox, - } - - local volumearc = wibox.widget { - icon, - max_value = 1, - thickness = thickness, - start_angle = 4.71238898, -- 2pi*3/4 - forced_height = margins, - forced_width = margins, - bg = bg_color, - paddings = 2, - widget = wibox.container.arcchart - } - - local update_graphic = function(widget, stdout, _, _, _) - local mute = "on" - local volume = 0 - if not (stdout == nil or stdout == '') then - mute = string.match(stdout, "%[(o%D%D?)%]") -- \[(o\D\D?)\] - [on] or [off] - volume = string.match(tostring(stdout), "(%d?%d?%d)%%") -- (\d?\d?\d)\%) - volume = tonumber(string.format("% 3d", volume)) - end - widget.value = volume / 100; - widget.colors = mute == 'off' - and { mute_color } - or { main_color } - end - - local button_press = args.button_press or function(_, _, _, button) - if (button == 4) then awful.spawn(inc_volume_cmd, false) - elseif (button == 5) then awful.spawn(dec_volume_cmd, false) - elseif (button == 1) then awful.spawn(tog_volume_cmd, false) - end - - spawn.easy_async(get_volume_cmd, function(stdout, stderr, exitreason, exitcode) - update_graphic(volumearc, stdout, stderr, exitreason, exitcode) - end) - end - volumearc:connect_signal("button::press", button_press) - - local rebuild_widget = function(stdout) - for i = 0, #rows do rows[i]=nil end - - for line in stdout:gmatch("[^\r\n]+") do - - local row = wibox.widget { - text = line, - widget = wibox.widget.textbox - } - table.insert(rows, row) - end - - popup:setup(rows) - end - - volumearc:buttons( - awful.util.table.join( - awful.button({}, 3, function() - if popup.visible then - popup.visible = not popup.visible - else - spawn.easy_async([[bash -c "cat /proc/asound/cards"]], function(stdout, stderr) - rebuild_widget(stdout, stderr) - popup:move_next_to(mouse.current_widget_geometry) - end) - end - end) - ) - ) - - - - watch(get_volume_cmd, timeout, update_graphic, volumearc) - - return volumearc -end - -return setmetatable(widget, { __call = function(_, ...) return worker(...) end }) diff --git a/volumebar-widget/README.md b/volumebar-widget/README.md deleted file mode 100644 index 305b254..0000000 --- a/volumebar-widget/README.md +++ /dev/null @@ -1,85 +0,0 @@ -# Volumebar widget - -Almost the same as volume widget, but more minimalistic: - -![screenshot](./out.gif) - -Supports - - scroll up - increase volume, - - scroll down - decrease volume, - - left click - mute/unmute. - -## Customization - -It is possible to customize widget by providing a table with all or some of the following config parameters: - -| Name | Default | Description | -|---|---|---| -| `main_color` | `beautiful.fg_normal` | Color of the bar | -| `bg_color` | `#ffffff11` | Color of the bar's background | -| `mute_color` | `beautiful.fg_urgent` | Color of the bar when mute | -| `width` | 50 | The bar width | -| `shape` | `bar` | [gears.shape](https://awesomewm.org/doc/api/libraries/gears.shape.html), could be `octogon`, `hexagon`, `powerline`, etc | -| `margins` | `10` | Top and bottom margin (if your wibar is 22 px high, bar will be 2 px (22 - 2*10)) | -| `timeout` | 1 | How often in seconds the widget refreshes | -| `get_volume_cmd` | `amixer -D pulse sget Master` | Get current volume level | -| `inc_volume_cmd` | `amixer -D pulse sset Master 5%+` | Increase volume level | -| `dec_volume_cmd` | `amixer -D pulse sset Master 5%-` | Decrease volume level | -| `tog_volume_cmd` | `amixer -D pulse sset Master toggle` | Mute / unmute | - -### Example: - - ```lua - volumebar_widget({ - main_color = '#af13f7', - mute_color = '#ff0000', - width = 80, - shape = 'rounded_bar', - margins = 8 -}) - ``` - -Above config results in following widget: - -![custom](./custom.png) - - -## Installation - -1. Clone this repo under **~/.config/awesome/** - - ```bash - git clone https://github.com/streetturtle/awesome-wm-widgets.git ~/.config/awesome/ - ``` - -1. Require volumebar widget at the beginning of **rc.lua**: - - ```lua - local volumebar_widget = require("awesome-wm-widgets.volumebar-widget.volumebar") - ``` - -1. Add widget to the tasklist: - - ```lua - s.mytasklist, -- Middle widget - { -- Right widgets - layout = wibox.layout.fixed.horizontal, - ... - --[[default]] - volumebar_widget(), - --[[or customized]] - volumebar_widget({ - main_color = '#af13f7', - mute_color = '#ff0000', - width = 80, - shape = 'rounded_bar', -- octogon, hexagon, powerline, etc - -- bar's height = wibar's height minus 2x margins - margins = 8 - }), - - ... - ``` - -## Troubleshooting - -If the bar is not showing up, try to decrease top or bottom margin - widget uses hardcoded margins for vertical alignment, so if your wibox is too small then bar is simply hidden by the margins. diff --git a/volumebar-widget/custom.png b/volumebar-widget/custom.png deleted file mode 100644 index d86143b..0000000 Binary files a/volumebar-widget/custom.png and /dev/null differ diff --git a/volumebar-widget/out.gif b/volumebar-widget/out.gif deleted file mode 100644 index 16653c8..0000000 Binary files a/volumebar-widget/out.gif and /dev/null differ diff --git a/volumebar-widget/volumebar.lua b/volumebar-widget/volumebar.lua deleted file mode 100644 index e7ee64d..0000000 --- a/volumebar-widget/volumebar.lua +++ /dev/null @@ -1,87 +0,0 @@ -------------------------------------------------- --- Volume Bar Widget for Awesome Window Manager --- Shows the current volume level --- More details could be found here: --- https://github.com/streetturtle/awesome-wm-widgets/tree/master/volumebar-widget - --- @author Pavel Makhov --- @copyright 2018 Pavel Makhov -------------------------------------------------- - -local awful = require("awful") -local beautiful = require("beautiful") -local gears = require("gears") -local spawn = require("awful.spawn") -local watch = require("awful.widget.watch") -local wibox = require("wibox") - -local GET_VOLUME_CMD = 'amixer -D pulse sget Master' -local INC_VOLUME_CMD = 'amixer -D pulse sset Master 5%+' -local DEC_VOLUME_CMD = 'amixer -D pulse sset Master 5%-' -local TOG_VOLUME_CMD = 'amixer -D pulse sset Master toggle' - -local widget = {} - -local function worker(user_args) - - local args = user_args or {} - - local main_color = args.main_color or beautiful.fg_normal - local mute_color = args.mute_color or beautiful.fg_urgent - local bg_color = args.bg_color or '#ffffff11' - local width = args.width or 50 - local shape = args.shape or 'bar' - local margins = args.margins or 10 - local timeout = args.timeout or 1 - - local get_volume_cmd = args.get_volume_cmd or GET_VOLUME_CMD - local inc_volume_cmd = args.inc_volume_cmd or INC_VOLUME_CMD - local dec_volume_cmd = args.dec_volume_cmd or DEC_VOLUME_CMD - local tog_volume_cmd = args.tog_volume_cmd or TOG_VOLUME_CMD - - local volumebar_widget = wibox.widget { - max_value = 1, - forced_width = width, - color = main_color, - background_color = bg_color, - shape = gears.shape[shape], - margins = { - top = margins, - bottom = margins, - }, - widget = wibox.widget.progressbar - } - - local update_graphic = function(_, stdout, _, _, _) - local mute = string.match(stdout, "%[(o%D%D?)%]") -- \[(o\D\D?)\] - [on] or [off] - local volume = string.match(stdout, "(%d?%d?%d)%%") -- (\d?\d?\d)\%) - volume = tonumber(string.format("% 3d", volume)) - - widget.value = volume / 100; - widget.color = mute == "off" - and mute_color - or main_color - - end - - volumebar_widget:connect_signal("button::press", function(_, _, _, button) - if (button == 4) then - awful.spawn(inc_volume_cmd) - elseif (button == 5) then - awful.spawn(dec_volume_cmd) - elseif (button == 1) then - awful.spawn(tog_volume_cmd) - end - - spawn.easy_async(get_volume_cmd, function(stdout, stderr, exitreason, exitcode) - update_graphic(volumebar_widget, stdout, stderr, exitreason, exitcode) - end) - end) - - watch(get_volume_cmd, timeout, update_graphic, volumebar_widget) - - return volumebar_widget -end - -return setmetatable(widget, { __call = function(_, ...) return worker(...) end }) - -- cgit v1.2.3