]> git.madduck.net Git - etc/awesome.git/blobdiff - widget/pulsebar.lua

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Merge pull request #439 from gregflynn/201908_gf_customize_pulsebar_notification_char...
[etc/awesome.git] / widget / pulsebar.lua
index caaffdc0a9bee9c2d1fb73d5209d80e03b9fe998..51290f8cd9f84ef01213cd8b7f7d7b6d563d0326 100644 (file)
@@ -1,85 +1,87 @@
-
 --[[
 --[[
-                                                  
-     Licensed under GNU General Public License v2 
-      * (c) 2013, Luke Bonham                     
-      * (c) 2013, Rman                            
-                                                  
+
+     Licensed under GNU General Public License v2
+      * (c) 2013, Luca CPZ
+      * (c) 2013, Rman
+
 --]]
 
 --]]
 
-local helpers      = require("lain.helpers")
-local awful        = require("awful")
-local naughty      = require("naughty")
-local wibox        = require("wibox")
-local math         = { modf   = math.modf }
-local string       = { format = string.format,
-                       gmatch = string.gmatch,
-                       match  = string.match,
-                       rep    = string.rep }
-local type         = type
-local tonumber     = tonumber
-local setmetatable = setmetatable
-
--- Pulseaudio volume bar
--- lain.widget.pulsebar
-local pulsebar = {
-    colors = {
-        background = "#000000",
-        mute       = "#EB8F8F",
-        unmute     = "#A4CE8A"
-    },
+local helpers  = require("lain.helpers")
+local awful    = require("awful")
+local naughty  = require("naughty")
+local wibox    = require("wibox")
+local math     = math
+local string   = string
+local type     = type
+local tonumber = tonumber
 
 
-    _current_level = 0,
-    _muted         = false
-}
+-- PulseAudio volume bar
+-- lain.widget.pulsebar
 
 local function factory(args)
 
 local function factory(args)
+    local pulsebar = {
+        colors = {
+            background = "#000000",
+            mute       = "#EB8F8F",
+            unmute     = "#A4CE8A"
+        },
+
+        _current_level = 0,
+        _mute          = "no",
+        device         = "N/A"
+    }
+
     local args       = args or {}
     local timeout    = args.timeout or 5
     local settings   = args.settings or function() end
     local width      = args.width or 63
     local args       = args or {}
     local timeout    = args.timeout or 5
     local settings   = args.settings or function() end
     local width      = args.width or 63
-    local height     = args.heigth or 1
+    local height     = args.height or 1
+    local margins    = args.margins or 1
+    local paddings   = args.paddings or 1
     local ticks      = args.ticks or false
     local ticks_size = args.ticks_size or 7
     local ticks      = args.ticks or false
     local ticks_size = args.ticks_size or 7
-    local vertical   = args.vertical or false
-    local scallback  = args.scallback
+    local tick       = args.tick or "|"
+    local tick_pre   = args.tick_pre or "["
+    local tick_post  = args.tick_post or "]"
+    local tick_none  = args.tick_none or " "
 
 
-    pulsebar.cmd           = args.cmd or "pacmd list-sinks | sed -n -e '0,/*/d' -e '/base volume/d' -e '/volume:/p' -e '/muted:/p' -e '/device\\.string/p'"
-    pulsebar.sink          = args.sink or 0
-    pulsebar.colors        = args.colors or pulsebar.colors
-    pulsebar.followtag     = args.followtag or false
-    pulsebar.notifications = args.notification_preset
+    pulsebar.colors              = args.colors or pulsebar.colors
+    pulsebar.followtag           = args.followtag or false
+    pulsebar.notification_preset = args.notification_preset
+    pulsebar.devicetype          = args.devicetype or "sink"
+    pulsebar.cmd                 = args.cmd or "pacmd list-" .. pulsebar.devicetype .. "s | sed -n -e '/*/,$!d' -e '/index/p' -e '/base volume/d' -e '/volume:/p' -e '/muted:/p' -e '/device\\.string/p'"
 
     if not pulsebar.notification_preset then
 
     if not pulsebar.notification_preset then
-        pulsebar.notification_preset      = {}
-        pulsebar.notification_preset.font = "Monospace 10"
+        pulsebar.notification_preset = {
+            font = "Monospace 10"
+        }
     end
 
     pulsebar.bar = wibox.widget {
     end
 
     pulsebar.bar = wibox.widget {
-        forced_height    = height,
-        forced_width     = width,
         color            = pulsebar.colors.unmute,
         background_color = pulsebar.colors.background,
         color            = pulsebar.colors.unmute,
         background_color = pulsebar.colors.background,
-        margins          = 1,
-        paddings         = 1,
+        forced_height    = height,
+        forced_width     = width,
+        margins          = margins,
+        paddings         = paddings,
         ticks            = ticks,
         ticks_size       = ticks_size,
         widget           = wibox.widget.progressbar,
         ticks            = ticks,
         ticks_size       = ticks_size,
         widget           = wibox.widget.progressbar,
-        layout           = vertical and wibox.container.rotate
     }
 
     pulsebar.tooltip = awful.tooltip({ objects = { pulsebar.bar } })
 
     function pulsebar.update(callback)
     }
 
     pulsebar.tooltip = awful.tooltip({ objects = { pulsebar.bar } })
 
     function pulsebar.update(callback)
-        if scallback then pulseaudio.cmd = scallback() end
-
-        helpers.async({ awful.util.shell, "-c", pulsebar.cmd }, function(s)
+        helpers.async({ awful.util.shell, "-c", type(pulsebar.cmd) == "string" and pulsebar.cmd or pulsebar.cmd() },
+        function(s)
             volume_now = {
             volume_now = {
-                index = string.match(s, "index: (%S+)") or "N/A",
-                sink  = string.match(s, "device.string = \"(%S+)\"") or "N/A",
-                muted = string.match(s, "muted: (%S+)") or "N/A"
+                index  = string.match(s, "index: (%S+)") or "N/A",
+                device = string.match(s, "device.string = \"(%S+)\"") or "N/A",
+                muted  = string.match(s, "muted: (%S+)") or "N/A"
             }
 
             }
 
+            pulsebar.device = volume_now.index
+
             local ch = 1
             volume_now.channel = {}
             for v in string.gmatch(s, ":.-(%d+)%%") do
             local ch = 1
             volume_now.channel = {}
             for v in string.gmatch(s, ":.-(%d+)%%") do
@@ -93,16 +95,18 @@ local function factory(args)
             local volu = volume_now.left
             local mute = volume_now.muted
 
             local volu = volume_now.left
             local mute = volume_now.muted
 
-            if (volu and volu ~= pulsebar._current_level) or (mute and mute ~= pulsebar._muted) then
-                pulsebar._current_level = volu
+            if volu:match("N/A") or mute:match("N/A") then return end
+
+            if volu ~= pulsebar._current_level or mute ~= pulsebar._mute then
+                pulsebar._current_level = tonumber(volu)
                 pulsebar.bar:set_value(pulsebar._current_level / 100)
                 pulsebar.bar:set_value(pulsebar._current_level / 100)
-                if (not mute and volu == 0) or mute == "yes" then
-                    pulsebar._muted = true
-                    pulsebar.tooltip:set_text ("[Muted]")
+                if pulsebar._current_level == 0 or mute == "yes" then
+                    pulsebar._mute = mute
+                    pulsebar.tooltip:set_text ("[muted]")
                     pulsebar.bar.color = pulsebar.colors.mute
                 else
                     pulsebar.bar.color = pulsebar.colors.mute
                 else
-                    pulsebar._muted = false
-                    pulsebar.tooltip:set_text(string.format("%s: %s", pulsebar.sink, volu))
+                    pulsebar._mute = "no"
+                    pulsebar.tooltip:set_text(string.format("%s %s: %s", pulsebar.devicetype, pulsebar.device, volu))
                     pulsebar.bar.color = pulsebar.colors.unmute
                 end
 
                     pulsebar.bar.color = pulsebar.colors.unmute
                 end
 
@@ -117,15 +121,34 @@ local function factory(args)
         pulsebar.update(function()
             local preset = pulsebar.notification_preset
 
         pulsebar.update(function()
             local preset = pulsebar.notification_preset
 
-            if pulsebar._muted then
-                preset.title = string.format("Sink %s - Muted", pulsebar.sink)
-            else
-                preset.title = string.format("%s - %s%%", pulsebar.sink, pulsebar._current_level)
+            preset.title = string.format("%s %s - %s%%", pulsebar.devicetype, pulsebar.device, pulsebar._current_level)
+
+            if pulsebar._mute == "yes" then
+                preset.title = preset.title .. " muted"
+            end
+
+            -- tot is the maximum number of ticks to display in the notification
+            -- fallback: default horizontal wibox height
+            local wib, tot = awful.screen.focused().mywibox, 20
+
+            -- if we can grab mywibox, tot is defined as its height if
+            -- horizontal, or width otherwise
+            if wib then
+                if wib.position == "left" or wib.position == "right" then
+                    tot = wib.width
+                else
+                    tot = wib.height
+                end
             end
 
             end
 
-            int = math.modf((pulsebar._current_level / 100) * awful.screen.focused().mywibox.height)
-            preset.text = string.format("[%s%s]", string.rep("|", int),
-                          string.rep(" ", awful.screen.focused().mywibox.height - int))
+            int = math.modf((pulsebar._current_level / 100) * tot)
+            preset.text = string.format(
+                "%s%s%s%s",
+                tick_pre,
+                string.rep(tick, int),
+                string.rep(tick_none, tot - int),
+                tick_post
+            )
 
             if pulsebar.followtag then preset.screen = awful.screen.focused() end
 
 
             if pulsebar.followtag then preset.screen = awful.screen.focused() end
 
@@ -140,9 +163,9 @@ local function factory(args)
         end)
     end
 
         end)
     end
 
-    helpers.newtimer(string.format("pulsebar-%s", pulsebar.sink), timeout, pulsebar.update)
+    helpers.newtimer(string.format("pulsebar-%s-%s", pulsebar.devicetype, pulsebar.device), timeout, pulsebar.update)
 
     return pulsebar
 end
 
 
     return pulsebar
 end
 
-return setmetatable(pulsebar, { __call = function(_, ...) return factory(...) end })
+return factory