diff options
Diffstat (limited to 'experiments/volume')
| -rw-r--r-- | experiments/volume/README.md | 81 | ||||
| -rw-r--r-- | experiments/volume/screenshots/variations.png | bin | 0 -> 9153 bytes | |||
| -rw-r--r-- | experiments/volume/screenshots/volume-sink-sources.png | bin | 0 -> 74043 bytes | |||
| -rw-r--r-- | experiments/volume/utils.lua | 1 | ||||
| -rw-r--r-- | experiments/volume/volume.lua | 71 | ||||
| -rw-r--r-- | experiments/volume/widgets/arc-widget.lua | 21 | ||||
| -rw-r--r-- | experiments/volume/widgets/horizontal-bar-widget.lua | 58 | ||||
| -rw-r--r-- | experiments/volume/widgets/icon-and-text-widget.lua | 23 | ||||
| -rw-r--r-- | experiments/volume/widgets/icon-widget.lua | 15 | ||||
| -rw-r--r-- | experiments/volume/widgets/vertical-bar-widget.lua | 64 |
10 files changed, 280 insertions, 54 deletions
diff --git a/experiments/volume/README.md b/experiments/volume/README.md new file mode 100644 index 0000000..1210ced --- /dev/null +++ b/experiments/volume/README.md @@ -0,0 +1,81 @@ +# 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: + + + +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: + + +### 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 looks (check the screenshots below); + +## 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` | + +### `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/screenshots/variations.png b/experiments/volume/screenshots/variations.png Binary files differnew file mode 100644 index 0000000..21d7ead --- /dev/null +++ b/experiments/volume/screenshots/variations.png diff --git a/experiments/volume/screenshots/volume-sink-sources.png b/experiments/volume/screenshots/volume-sink-sources.png Binary files differnew file mode 100644 index 0000000..7d010bc --- /dev/null +++ b/experiments/volume/screenshots/volume-sink-sources.png diff --git a/experiments/volume/utils.lua b/experiments/volume/utils.lua index dcaeb84..417a666 100644 --- a/experiments/volume/utils.lua +++ b/experiments/volume/utils.lua @@ -1,5 +1,4 @@ -local json = require("json") local utils = {} diff --git a/experiments/volume/volume.lua b/experiments/volume/volume.lua index 9110a45..7daeb40 100644 --- a/experiments/volume/volume.lua +++ b/experiments/volume/volume.lua @@ -18,15 +18,17 @@ 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 -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 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") + 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_widget = wibox.widget{} @@ -58,17 +60,17 @@ local function build_rows(devices, on_checkbox_click, device_type) for _, device in pairs(devices) do local checkbox = wibox.widget { - checked = device.is_default, - color = beautiful.bg_normal, - paddings = 2, - shape = gears.shape.circle, + 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 + widget = wibox.widget.checkbox } - checkbox:connect_signal("button::press", function(c) + 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) @@ -105,19 +107,19 @@ local function build_rows(devices, on_checkbox_click, device_type) 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(c) + 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(c) + 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(c) + 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) @@ -158,16 +160,27 @@ local function rebuild_popup() end -local function worker(args) +local function worker(user_args) - local args = args or {} + 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() + volume_widget = widget_types['icon_and_text'].get_widget(user_args.icon_and_text_args) else - volume_widget = widget_types[widget_type].get_widget() + 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 = string.match(stdout, "(%d?%d?%d)%%") -- (\d?\d?\d)\%) + volume = string.format("% 3d", volume) + widget:set_volume_level(volume) end volume_widget:buttons( @@ -180,23 +193,19 @@ local function worker(args) popup:move_next_to(mouse.current_widget_geometry) end end), - awful.button({}, 4, function() awful.spawn(INC_VOLUME_CMD, false) end), - awful.button({}, 5, function() awful.spawn(DEC_VOLUME_CMD, false) end), - awful.button({}, 1, function() awful.spawn(TOG_VOLUME_CMD, false) end) + awful.button({}, 4, function() + spawn.easy_async(INC_VOLUME_CMD, function(stdout) update_graphic(volume_widget, stdout) end) + end), + awful.button({}, 5, function() + spawn.easy_async(DEC_VOLUME_CMD, function(stdout) update_graphic(volume_widget, stdout) end) + end), + awful.button({}, 1, function() + spawn.easy_async(TOG_VOLUME_CMD, function(stdout) update_graphic(volume_widget, stdout) end) + 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 volume_widget:mute() - elseif mute == 'on' then volume_widget:unmute() - end - local volume = string.match(stdout, "(%d?%d?%d)%%") -- (\d?\d?\d)\%) - volume = string.format("% 3d", volume) - widget:set_volume_level(volume) - end - - watch(GET_VOLUME_CMD, 1, update_graphic, volume_widget) + watch(GET_VOLUME_CMD, refresh_rate, update_graphic, volume_widget) return volume_widget end diff --git a/experiments/volume/widgets/arc-widget.lua b/experiments/volume/widgets/arc-widget.lua index d7a3b1f..b6c9d22 100644 --- a/experiments/volume/widgets/arc-widget.lua +++ b/experiments/volume/widgets/arc-widget.lua @@ -5,7 +5,14 @@ local ICON_DIR = os.getenv("HOME") .. '/.config/awesome/awesome-wm-widgets/exper local widget = {} -function widget.get_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 { { @@ -15,21 +22,21 @@ function widget.get_widget() widget = wibox.widget.imagebox, }, max_value = 100, - thickness = 2, + thickness = thickness, start_angle = 4.71238898, -- 2pi*3/4 - forced_height = 18, - forced_width = 18, - bg = '#ffffff11', + 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 = {'#BF616A'} + self.colors = { mute_color } end, unmute = function(self) - self.colors = {beautiful.fg_color} + self.colors = { main_color } end } diff --git a/experiments/volume/widgets/horizontal-bar-widget.lua b/experiments/volume/widgets/horizontal-bar-widget.lua new file mode 100644 index 0000000..1a1c8a4 --- /dev/null +++ b/experiments/volume/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/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 index 5517f11..74044fb 100644 --- a/experiments/volume/widgets/icon-and-text-widget.lua +++ b/experiments/volume/widgets/icon-and-text-widget.lua @@ -1,10 +1,15 @@ local wibox = require("wibox") +local beautiful = require('beautiful') local widget = {} -local WIDGET_DIR = os.getenv("HOME") .. '/.config/awesome/awesome-wm-widgets/experiments/volume/icons/' +local ICON_DIR = os.getenv("HOME") .. '/.config/awesome/awesome-wm-widgets/experiments/volume/icons/' -function widget.get_widget() +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 { { @@ -18,15 +23,15 @@ function widget.get_widget() }, { id = 'txt', + font = font, widget = wibox.widget.textbox }, layout = wibox.layout.fixed.horizontal, - is_muted = true, set_volume_level = function(self, new_value) self:get_children_by_id('txt')[1]:set_text(new_value) - local volume_icon_name = '' + local volume_icon_name if self.is_muted then - volume_icon_name = 'audio-volume-muted-symbolic.svg' + 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 @@ -37,16 +42,16 @@ function widget.get_widget() volume_icon_name="audio-volume-high-symbolic" end end - self:get_children_by_id('icon')[1]:set_image(WIDGET_DIR .. volume_icon_name .. '.svg') + self:get_children_by_id('icon')[1]:set_image(icon_dir .. volume_icon_name .. '.svg') end, mute = function(self) + print("called") self.is_muted = true - self:get_children_by_id('icon')[1]:set_image(WIDGET_DIR .. 'audio-volume-muted-symbolic.svg') + 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 } end diff --git a/experiments/volume/widgets/icon-widget.lua b/experiments/volume/widgets/icon-widget.lua index 2a20dde..f2aca26 100644 --- a/experiments/volume/widgets/icon-widget.lua +++ b/experiments/volume/widgets/icon-widget.lua @@ -2,9 +2,12 @@ local wibox = require("wibox") local widget = {} -local WIDGET_DIR = os.getenv("HOME") .. '/.config/awesome/awesome-wm-widgets/experiments/volume/icons/' +local ICON_DIR = os.getenv("HOME") .. '/.config/awesome/awesome-wm-widgets/experiments/volume/icons/' -function widget.get_widget() +function widget.get_widget(widgets_args) + local args = widgets_args or {} + + local icon_dir = args.icon_dir or ICON_DIR return wibox.widget { { @@ -15,9 +18,9 @@ function widget.get_widget() valign = 'center', layout = wibox.container.place, set_volume_level = function(self, new_value) - local volume_icon_name = '' + local volume_icon_name if self.is_muted then - volume_icon_name = 'audio-volume-muted-symbolic.svg' + 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 @@ -28,11 +31,11 @@ function widget.get_widget() volume_icon_name="audio-volume-high-symbolic" end end - self:get_children_by_id('icon')[1]:set_image(WIDGET_DIR .. volume_icon_name .. '.svg') + 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(WIDGET_DIR .. 'audio-volume-muted-symbolic.svg') + self:get_children_by_id('icon')[1]:set_image(icon_dir .. 'audio-volume-muted-symbolic.svg') end, unmute = function(self) self.is_muted = false diff --git a/experiments/volume/widgets/vertical-bar-widget.lua b/experiments/volume/widgets/vertical-bar-widget.lua new file mode 100644 index 0000000..82f4b8a --- /dev/null +++ b/experiments/volume/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/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 |
