Added wireplumber mixer widget

.github/workflows/ci.yaml

@@ -9,7 +9,7 @@ jobs:
     steps:
       - run: echo 'http://dl-cdn.alpinelinux.org/alpine/v3.22/community' > /etc/apk/repositories
       - run: echo 'http://dl-cdn.alpinelinux.org/alpine/v3.22/main' >> /etc/apk/repositories
-      - run: apk --no-cache add git g++ binutils pkgconf meson ninja musl-dev gtkmm4-dev vala gobject-introspection gobject-introspection-dev pulseaudio-dev libdbusmenu-glib-dev alsa-lib-dev yyjson-dev
+      - run: apk --no-cache add git g++ binutils pkgconf meson ninja musl-dev gtkmm4-dev vala gobject-introspection gobject-introspection-dev pulseaudio-dev wireplumber-dev libdbusmenu-glib-dev alsa-lib-dev yyjson-dev
       - run: echo 'http://dl-cdn.alpinelinux.org/alpine/edge/testing' >> /etc/apk/repositories
       - run: echo 'http://dl-cdn.alpinelinux.org/alpine/edge/main' >> /etc/apk/repositories
       - run: apk --no-cache add wayland-protocols wayfire-dev gtk4-layer-shell-dev gtk4-layer-shell

meson.build

@@ -21,6 +21,7 @@ wfconfig = dependency('wf-config', version: '>=0.7.0') #TODO fallback submodule
 epoxy = dependency('epoxy')
 gtklayershell = dependency('gtk4-layer-shell-0', fallback: ['gtk4-layer-shell'])
 libpulse = dependency('libpulse', required: get_option('pulse'))
+wireplumber = dependency('wireplumber-0.5', required: get_option('wireplumber'))
 dbusmenu_gtk = dependency('dbusmenu-glib-0.4')
 libgvc = subproject('gvc', default_options: ['static=true'], required: get_option('pulse'))
 xkbregistry = dependency('xkbregistry')
@@ -35,6 +36,10 @@ if libpulse.found()
 	add_project_arguments('-DHAVE_PULSE=1', language: 'cpp')
 endif
 
+if wireplumber.found()
+	add_project_arguments('-DHAVE_WIREPLUMBER=1', language: 'cpp')
+endif
+
 needs_libinotify = ['freebsd', 'dragonfly'].contains(host_machine.system())
 libinotify = dependency('libinotify', required: needs_libinotify)
 

meson_options.txt

@@ -4,9 +4,15 @@ option(
     value: 'auto',
     description: 'Build pulseaudio volume widget',
 )
+option(
+    'wireplumber',
+    type: 'feature',
+    value: 'auto',
+    description: 'Build wireplumber and mixer widget',
+)
 option(
     'wayland-logout',
     type: 'boolean',
     value: true,
     description: 'Install wayland-logout',
-)
+)

metadata/panel.xml

@@ -249,6 +249,105 @@
 	</option>
 	</group>
 	<group>
+	<_short>Audio mixer (wireplumber)</_short>
+	<option name="wp_quick_target_choice" type="string">
+		<_short>Quick action target</_short>
+		<_long>Which audio control will be the target of the quick actions (scrolling and muting on the widget)</_long>
+		<default>default_sink</default>
+		<desc>
+			<value>default_sink</value>
+			<_name>Default sink</_name>
+		</desc>
+		<desc>
+			<value>default_source</value>
+			<_name>Default source</_name>
+		</desc>
+		<desc>
+			<value>last_change</value>
+			<_name>Last changed volume</_name>
+		</desc>
+	</option>
+	<option name="wp_popup_on_change" type="bool">
+		<_short>Pop up on change</_short>
+		<_long>Whether to show a popup with the new values upon a change to the quick action target</_long>
+		<default>true</default>
+	</option>
+	<option name="wp_display_timeout" type="double">
+		<_short>Display timeout</_short>
+		<default>2.5</default>
+		<min>0</min>
+	</option>
+	<option name="wp_slider_length" type="int">
+		<_short>Slider length</_short>
+		<default>300</default>
+		<min>1</min>
+	</option>
+	<option name="wp_scroll_sensitivity" type="double">
+		<_short>Scroll sensitivity</_short>
+		<default>1</default>
+		<min>0</min>
+	</option>
+	<option name="wp_invert_scroll" type="bool">
+		<_short>Invert scroll</_short>
+		<_long>Inverts which scroll direction raises and lowers volume</_long>
+		<default>false</default>
+	</option>
+	<option name="wp_icons_on_left" type="bool">
+		<_short>Icons on left</_short>
+		<_long>Displays the mute and set default icon on the left</_long>
+		<default>false</default>
+	</option>
+	<option name="wp_left_click_action" type="string">
+		<_short>Left click action</_short>
+		<default>show_mixer</default>
+		<desc>
+			<value>show_mixer</value>
+			<_name>Show full mixer</_name>
+		</desc>
+		<desc>
+			<value>show_quick_target</value>
+			<_name>Show quick action target</_name>
+		</desc>
+	</option>
+	<option name="wp_middle_click_action" type="string">
+		<_short>Middle click action</_short>
+		<default>mute_quick_target</default>
+		<desc>
+			<value>show_mixer</value>
+			<_name>Show full mixer</_name>
+		</desc>
+		<desc>
+			<value>show_quick_target</value>
+			<_name>Show quick action target</_name>
+		</desc>
+		<desc>
+			<value>mute_quick_target</value>
+			<_name>Mute quick action target</_name>
+		</desc>
+	</option>
+	<option name="wp_right_click_action" type="string">
+		<_short>Right click action</_short>
+		<default>show_quick_target</default>
+		<desc>
+			<value>show_mixer</value>
+			<_name>Show full mixer</_name>
+		</desc>
+		<desc>
+			<value>show_quick_target</value>
+			<_name>Show quick action target</_name>
+		</desc>
+		<desc>
+			<value>mute_quick_target</value>
+			<_name>Mute quick action target</_name>
+		</desc>
+	</option>
+	<option name="wp_icon_size" type="int">
+		<_short>Icon size</_short>
+		<default>32</default>
+		<min>1</min>
+	</option>
+	</group>
+	<group>
 	<_short>Notifications</_short>
 	<option name="notifications_autohide_timeout" type="double">
 		<_short>Notifications Display Timeout</_short>

src/panel/meson.build

@@ -35,8 +35,25 @@ deps = [
 ]
 
 if libpulse.found()
-  widget_sources += 'widgets/volume.cpp'
+  widget_sources += [
+    'widgets/volume.cpp',
+    'widgets/volume-level.cpp',
+  ]
   deps += [libpulse, libgvc]
+else
+  message('Pulse not found, volume widget will not be available.')
+endif
+
+if wireplumber.found()
+  widget_sources += [
+    'widgets/wp-mixer/wp-mixer.cpp',
+    'widgets/wp-mixer/wf-wp-control.cpp',
+    'widgets/wp-mixer/wp-common.cpp',
+    'widgets/volume-level.cpp',
+  ]
+  deps += wireplumber
+else
+  message('Wireplumber not found, mixer widget will not be available.')
 endif
 
 executable(

src/panel/panel.cpp

@@ -26,6 +26,9 @@
 #ifdef HAVE_PULSE
     #include "widgets/volume.hpp"
 #endif
+#ifdef HAVE_WIREPLUMBER
+    #include "widgets/wp-mixer/wp-mixer.hpp"
+#endif
 #include "widgets/window-list/window-list.hpp"
 #include "widgets/notifications/notification-center.hpp"
 #include "widgets/tray/tray.hpp"
@@ -160,12 +163,21 @@ class WayfirePanel::impl
 #ifdef HAVE_PULSE
             return Widget(new WayfireVolume());
 #else
-    #warning "Pulse not found, volume widget will not be available."
             std::cerr << "Built without pulse support, volume widget "
                          " is not available." << std::endl;
 #endif
         }
 
+        if (name == "wp-mixer")
+        {
+#ifdef HAVE_WIREPLUMBER
+            return Widget(new WayfireWpMixer());
+#else
+            std::cerr << "Built without wireplumber support, mixer widget "
+                         " is not available." << std::endl;
+#endif
+        }
+
         if (name == "window-list")
         {
             return Widget(new WayfireWindowList(output));
@@ -363,6 +375,7 @@ void WayfirePanelApp::on_activate()
     new CssFromConfigInt("panel/battery_icon_size", ".battery image{-gtk-icon-size:", "px;}");
     new CssFromConfigInt("panel/network_icon_size", ".network{-gtk-icon-size:", "px;}");
     new CssFromConfigInt("panel/volume_icon_size", ".volume{-gtk-icon-size:", "px;}");
+    new CssFromConfigInt("panel/wp_icon_size", ".wireplumber{-gtk-icon-size:", "px;}");
     new CssFromConfigInt("panel/notifications_icon_size", ".notification-center{-gtk-icon-size:", "px;}");
     new CssFromConfigInt("panel/tray_icon_size", ".tray-button{-gtk-icon-size:", "px;}");
     new CssFromConfigString("panel/background_color", ".wf-panel{background-color:", ";}");

src/panel/widgets/volume-level.cpp

@@ -0,0 +1,42 @@
+#include <map>
+
+#include "volume-level.hpp"
+
+enum VolumeLevel
+{
+    VOLUME_LEVEL_MUTE = 0,
+    VOLUME_LEVEL_LOW,
+    VOLUME_LEVEL_MED,
+    VOLUME_LEVEL_HIGH,
+    VOLUME_LEVEL_OOR, /* Out of range */
+};
+
+const std::map<VolumeLevel, std::string> volume_icons = {
+    {VOLUME_LEVEL_MUTE, "audio-volume-muted"},
+    {VOLUME_LEVEL_LOW, "audio-volume-low"},
+    {VOLUME_LEVEL_MED, "audio-volume-medium"},
+    {VOLUME_LEVEL_HIGH, "audio-volume-high"},
+    {VOLUME_LEVEL_OOR, "emblem-unreadable"},
+};
+
+// volume is expected to be from 0 to 1
+std::string volume_icon_for(double volume)
+{
+    double max = 1.0;
+    auto third = max / 3;
+    if (volume == 0)
+    {
+        return volume_icons.at(VOLUME_LEVEL_MUTE);
+    } else if ((volume > 0) && (volume <= third))
+    {
+        return volume_icons.at(VOLUME_LEVEL_LOW);
+    } else if ((volume > third) && (volume <= (third * 2)))
+    {
+        return volume_icons.at(VOLUME_LEVEL_MED);
+    } else if ((volume > (third * 2)) && (volume <= max))
+    {
+        return volume_icons.at(VOLUME_LEVEL_HIGH);
+    }
+
+    return volume_icons.at(VOLUME_LEVEL_OOR);
+}

src/panel/widgets/volume-level.hpp

@@ -0,0 +1,6 @@
+#pragma once
+
+#include <string>
+
+// helper in common for volume and wireplumber widgets icons handling
+std::string volume_icon_for(double volume);

src/panel/widgets/volume.cpp

@@ -2,98 +2,17 @@
 #include <glibmm.h>
 #include "volume.hpp"
 
-WayfireVolumeScale::WayfireVolumeScale()
-{
-    value_changed = this->signal_value_changed().connect([=] ()
-    {
-        this->current_volume.animate(this->get_value(), this->get_value());
-        if (this->user_changed_callback)
-        {
-            this->user_changed_callback();
-        }
-    });
-}
-
-WayfireVolumeScale::~WayfireVolumeScale()
-{
-    value_changed.disconnect();
-}
-
-void WayfireVolumeScale::set_target_value(double value)
-{
-    this->current_volume.animate(value);
-    add_tick_callback(sigc::mem_fun(*this, &WayfireVolumeScale::update_animation));
-}
-
-gboolean WayfireVolumeScale::update_animation(Glib::RefPtr<Gdk::FrameClock> frame_clock)
-{
-    value_changed.block();
-    this->set_value(this->current_volume);
-    value_changed.unblock();
-    // Once we've finished fading, stop this callback
-    return this->current_volume.running() ? G_SOURCE_CONTINUE : G_SOURCE_REMOVE;
-}
-
-double WayfireVolumeScale::get_target_value() const
-{
-    return this->current_volume.end;
-}
-
-void WayfireVolumeScale::set_user_changed_callback(
-    std::function<void()> callback)
-{
-    this->user_changed_callback = callback;
-}
-
-enum VolumeLevel
-{
-    VOLUME_LEVEL_MUTE = 0,
-    VOLUME_LEVEL_LOW,
-    VOLUME_LEVEL_MED,
-    VOLUME_LEVEL_HIGH,
-    VOLUME_LEVEL_OOR, /* Out of range */
-};
-
-static VolumeLevel get_volume_level(pa_volume_t volume, pa_volume_t max)
-{
-    auto third = max / 3;
-    if (volume == 0)
-    {
-        return VOLUME_LEVEL_MUTE;
-    } else if ((volume > 0) && (volume <= third))
-    {
-        return VOLUME_LEVEL_LOW;
-    } else if ((volume > third) && (volume <= (third * 2)))
-    {
-        return VOLUME_LEVEL_MED;
-    } else if ((volume > (third * 2)) && (volume <= max))
-    {
-        return VOLUME_LEVEL_HIGH;
-    }
-
-    return VOLUME_LEVEL_OOR;
-}
+#include "volume-level.hpp"
 
 void WayfireVolume::update_icon()
 {
-    VolumeLevel current =
-        get_volume_level(volume_scale.get_target_value(), max_norm);
-
     if (gvc_stream && gvc_mixer_stream_get_is_muted(gvc_stream))
     {
-        main_image.set_from_icon_name("audio-volume-muted");
+        main_image.set_from_icon_name(volume_icon_for(0)); // mute
         return;
     }
 
-    std::map<VolumeLevel, std::string> icon_name_from_state = {
-        {VOLUME_LEVEL_MUTE, "audio-volume-muted"},
-        {VOLUME_LEVEL_LOW, "audio-volume-low"},
-        {VOLUME_LEVEL_MED, "audio-volume-medium"},
-        {VOLUME_LEVEL_HIGH, "audio-volume-high"},
-        {VOLUME_LEVEL_OOR, "audio-volume-muted"},
-    };
-
-    main_image.set_from_icon_name(icon_name_from_state.at(current));
+    main_image.set_from_icon_name(volume_icon_for(volume_scale.get_target_value() / (double)max_norm));
 }
 
 bool WayfireVolume::on_popover_timeout(int timer)
@@ -197,8 +116,7 @@ void WayfireVolume::on_default_sink_changed()
     volume_scale.set_increments(max_norm * scroll_sensitivity,
         max_norm * scroll_sensitivity * 2);
 
-    /* Finally, update the displayed volume. However, do not show the
-     * popup */
+    /* Finally, update the displayed volume. However, do not show the popup */
     set_volume(gvc_mixer_stream_get_volume(gvc_stream), VOLUME_FLAG_NO_ACTION);
 }