Merge PR Jas-SinghFSU#1139: blacklist MPRIS players

lika85456 · lika85456 · commit aece4e5d714d · 2026-02-03T13:48:18.000+01:00
diff --git a/src/components/bar/modules/media/index.tsx b/src/components/bar/modules/media/index.tsx
@@ -9,6 +9,7 @@ import options from 'src/configuration';
 import { runAsyncCommand } from '../../utils/input/commandExecutor';
 import { throttledScrollHandler } from '../../utils/input/throttle';
 import { openDropdownMenu } from '../../utils/menu';
+import { filterPlayers } from 'src/lib/shared/media';
 
 const mprisService = AstalMpris.get_default();
 const {
@@ -22,15 +23,22 @@ const {
     scrollDown,
     format,
 } = options.bar.media;
+const { ignore } = options.menus.media;
 
 const isVis = Variable(!show_active_only.get());
 
-Variable.derive([bind(show_active_only), bind(mprisService, 'players')], (showActive, players) => {
-    isVis.set(!showActive || players?.length > 0);
-});
+Variable.derive(
+    [bind(show_active_only), bind(mprisService, 'players'), bind(ignore)],
+    (showActive, players, ignoredApps) => {
+        const filteredPlayers = filterPlayers(players, ignoredApps);
+        isVis.set(!showActive || filteredPlayers?.length > 0);
+    },
+);
 
 const Media = (): BarBoxChild => {
-    activePlayer.set(mprisService.get_players()[0]);
+    const allPlayers = mprisService.get_players();
+    const filteredPlayers = filterPlayers(allPlayers, ignore.get());
+    activePlayer.set(filteredPlayers[0]);
 
     const songIcon = Variable('');
 
diff --git a/src/components/menus/media/components/controls/Players.tsx b/src/components/menus/media/components/controls/Players.tsx
@@ -1,24 +1,34 @@
-import { bind } from 'astal';
+import { bind, Variable } from 'astal';
 import { Astal, Gtk, Widget } from 'astal/gtk3';
 import { getNextPlayer, getPreviousPlayer } from './helpers';
 import AstalMpris from 'gi://AstalMpris?version=0.1';
 import { isPrimaryClick } from 'src/lib/events/mouse';
+import options from 'src/configuration';
+import { filterPlayers } from 'src/lib/shared/media';
 
 const mprisService = AstalMpris.get_default();
 
 export const PreviousPlayer = (): JSX.Element => {
-    const className = bind(mprisService, 'players').as((players) => {
-        const isDisabled = players.length <= 1 ? 'disabled' : 'enabled';
+    const { ignore } = options.menus.media;
 
-        return `media-indicator-control-button ${isDisabled}`;
-    });
+    const className = Variable.derive(
+        [bind(mprisService, 'players'), bind(ignore)],
+        (players: AstalMpris.Player[], ignoredApps: string[]) => {
+            const filteredPlayers = filterPlayers(players, ignoredApps);
+            const isDisabled = filteredPlayers.length <= 1 ? 'disabled' : 'enabled';
+
+            return `media-indicator-control-button ${isDisabled}`;
+        },
+    );
 
     const onClick = (_: Widget.Button, event: Astal.ClickEvent): void => {
         if (!isPrimaryClick(event)) {
             return;
         }
 
-        const isDisabled = mprisService.get_players().length <= 1;
+        const allPlayers = mprisService.get_players();
+        const filteredPlayers = filterPlayers(allPlayers, ignore.get());
+        const isDisabled = filteredPlayers.length <= 1;
 
         if (!isDisabled) {
             getPreviousPlayer();
@@ -27,40 +37,54 @@ export const PreviousPlayer = (): JSX.Element => {
 
     return (
         <button
-            className={className}
+            className={className()}
             halign={Gtk.Align.CENTER}
             hasTooltip
             tooltipText={'Previous Player'}
             onClick={onClick}
+            onDestroy={() => {
+                className.drop();
+            }}
         >
             <label label={'󰅁'} />
         </button>
     );
 };
 
 export const NextPlayer = (): JSX.Element => {
-    const className = bind(mprisService, 'players').as((players) => {
-        const isDisabled = players.length <= 1 ? 'disabled' : 'enabled';
-        return `media-indicator-control-button ${isDisabled}`;
-    });
+    const { ignore } = options.menus.media;
+
+    const className = Variable.derive(
+        [bind(mprisService, 'players'), bind(ignore)],
+        (players: AstalMpris.Player[], ignoredApps: string[]) => {
+            const filteredPlayers = filterPlayers(players, ignoredApps);
+            const isDisabled = filteredPlayers.length <= 1 ? 'disabled' : 'enabled';
+            return `media-indicator-control-button ${isDisabled}`;
+        },
+    );
     const onClick = (_: Widget.Button, event: Astal.ClickEvent): void => {
         if (!isPrimaryClick(event)) {
             return;
         }
 
-        const isDisabled = mprisService.get_players().length <= 1;
+        const allPlayers = mprisService.get_players();
+        const filteredPlayers = filterPlayers(allPlayers, ignore.get());
+        const isDisabled = filteredPlayers.length <= 1;
 
         if (!isDisabled) {
             getNextPlayer();
         }
     };
     return (
         <button
-            className={className}
+            className={className()}
             halign={Gtk.Align.CENTER}
             hasTooltip
             tooltipText={'Next Player'}
             onClick={onClick}
+            onDestroy={() => {
+                className.drop();
+            }}
         >
             <label label={'󰅂'} />
         </button>
diff --git a/src/components/menus/media/components/controls/helpers.ts b/src/components/menus/media/components/controls/helpers.ts
@@ -2,6 +2,8 @@ import AstalMpris from 'gi://AstalMpris?version=0.1';
 import icons2 from 'src/lib/icons/icons';
 import { activePlayer } from 'src/services/media';
 import { PlaybackIconMap } from './types';
+import options from 'src/configuration';
+import { filterPlayers } from 'src/lib/shared/media';
 
 const mprisService = AstalMpris.get_default();
 
@@ -75,7 +77,7 @@ export const isShuffleActive = (status: AstalMpris.Shuffle): string => {
 /**
  * Sets the next active player.
  *
- * This function sets the next player in the `mprisService.players` array as the active player.
+ * This function sets the next player in the filtered players array as the active player.
  * If there is only one player, it sets that player as the active player.
  *
  * @returns void
@@ -87,22 +89,26 @@ export const getNextPlayer = (): void => {
         return;
     }
 
-    const currentPlayerIndex = mprisService
-        .get_players()
-        .findIndex((player) => player.busName === currentPlayer.busName);
-    const totalPlayers = mprisService.get_players().length;
+    const { ignore } = options.menus.media;
+    const allPlayers = mprisService.get_players();
+    const filteredPlayers = filterPlayers(allPlayers, ignore.get());
+
+    const currentPlayerIndex = filteredPlayers.findIndex(
+        (player) => player.busName === currentPlayer.busName,
+    );
+    const totalPlayers = filteredPlayers.length;
 
     if (totalPlayers === 1) {
-        return activePlayer.set(mprisService.get_players()[0]);
+        return activePlayer.set(filteredPlayers[0]);
     }
 
-    return activePlayer.set(mprisService.get_players()[(currentPlayerIndex + 1) % totalPlayers]);
+    return activePlayer.set(filteredPlayers[(currentPlayerIndex + 1) % totalPlayers]);
 };
 
 /**
  * Sets the previous active player.
  *
- * This function sets the previous player in the `mprisService.players` array as the active player.
+ * This function sets the previous player in the filtered players array as the active player.
  * If there is only one player, it sets that player as the active player.
  *
  * @returns void
@@ -114,16 +120,18 @@ export const getPreviousPlayer = (): void => {
         return;
     }
 
-    const currentPlayerIndex = mprisService
-        .get_players()
-        .findIndex((player) => player.busName === currentPlayer.busName);
-    const totalPlayers = mprisService.get_players().length;
+    const { ignore } = options.menus.media;
+    const allPlayers = mprisService.get_players();
+    const filteredPlayers = filterPlayers(allPlayers, ignore.get());
+
+    const currentPlayerIndex = filteredPlayers.findIndex(
+        (player) => player.busName === currentPlayer.busName,
+    );
+    const totalPlayers = filteredPlayers.length;
 
     if (totalPlayers === 1) {
-        return activePlayer.set(mprisService.get_players()[0]);
+        return activePlayer.set(filteredPlayers[0]);
     }
 
-    return activePlayer.set(
-        mprisService.get_players()[(currentPlayerIndex - 1 + totalPlayers) % totalPlayers],
-    );
+    return activePlayer.set(filteredPlayers[(currentPlayerIndex - 1 + totalPlayers) % totalPlayers]);
 };
diff --git a/src/components/settings/pages/config/menus/media.tsx b/src/components/settings/pages/config/menus/media.tsx
@@ -8,6 +8,18 @@ export const MediaMenuSettings = (): JSX.Element => {
         <scrollable name={'Media Menu'} vscroll={Gtk.PolicyType.AUTOMATIC}>
             <box className="bar-theme-page paged-container" vertical>
                 <Header title="Media" />
+                <Option
+                    opt={options.menus.media.preferredPlayer}
+                    title="Preferred Player"
+                    subtitle="Identity name of the player to prioritize. Use 'hyprpanel mprisPlayers' to see available players with identities"
+                    type="string"
+                />
+                <Option
+                    opt={options.menus.media.ignore}
+                    title="Ignored Applications"
+                    subtitle="MPRIS clients to hide from the media player"
+                    type="object"
+                />
                 <Option opt={options.menus.media.hideAuthor} title="Hide Author" type="boolean" />
                 <Option opt={options.menus.media.hideAlbum} title="Hide Album" type="boolean" />
                 <Option opt={options.menus.media.displayTime} title="Display Time Info" type="boolean" />
diff --git a/src/configuration/modules/config/menus/media/index.ts b/src/configuration/modules/config/menus/media/index.ts
@@ -1,6 +1,8 @@
 import { opt } from 'src/lib/options';
 
 export default {
+    ignore: opt<string[]>([]),
+    preferredPlayer: opt<string>(''),
     hideAuthor: opt(false),
     hideAlbum: opt(false),
     displayTime: opt(false),
diff --git a/src/lib/shared/media/index.ts b/src/lib/shared/media/index.ts
@@ -0,0 +1,45 @@
+import AstalMpris from 'gi://AstalMpris?version=0.1';
+
+const normalizeName = (name: string): string => name.toLowerCase().replace(/\s+/g, '_');
+
+/**
+ * Checks if a media player should be ignored based on the filter list.
+ *
+ * This function determines whether the provided MPRIS player should be filtered out
+ * by checking the identity property.
+ *
+ * @param player The MPRIS player to check.
+ * @param filter Array of identity names to ignore (e.g., ["Brave", "TIDAL Hi-Fi", "Zaap"]).
+ *
+ * @returns True if the player should be ignored, false otherwise.
+ */
+export const isPlayerIgnored = (player: AstalMpris.Player | null | undefined, filter: string[]): boolean => {
+    if (!player) {
+        return false;
+    }
+
+    const playerFilters = new Set(filter.map(normalizeName));
+
+    const identity = player.identity || '';
+    const normalizedIdentity = normalizeName(identity);
+
+    return playerFilters.has(normalizedIdentity);
+};
+
+/**
+ * Filters a list of MPRIS players based on the ignore list.
+ *
+ * This function removes players from the list that match entries in the filter array.
+ *
+ * @param players Array of MPRIS players to filter.
+ * @param filter Array of application names to ignore.
+ *
+ * @returns Filtered array of players.
+ */
+export const filterPlayers = (players: AstalMpris.Player[], filter: string[]): AstalMpris.Player[] => {
+    const filteredPlayers = players.filter((player: AstalMpris.Player) => {
+        return !isPlayerIgnored(player, filter);
+    });
+
+    return filteredPlayers;
+};
diff --git a/src/services/cli/commander/commands/modules/media/index.ts b/src/services/cli/commander/commands/modules/media/index.ts
@@ -120,4 +120,32 @@ export const mediaCommands: Command[] = [
             }
         },
     },
+    {
+        name: 'mprisPlayers',
+        aliases: ['mpl'],
+        description: 'Lists all detected MPRIS players with their identity names.',
+        category: 'Media',
+        args: [],
+        handler: (): string => {
+            try {
+                const players = mprisService.get_players();
+
+                if (players.length === 0) {
+                    return 'No MPRIS players detected';
+                }
+
+                const playerList = players
+                    .map((player, index) => {
+                        const identity = player.identity || 'Unknown';
+                        const busName = player.busName || 'Unknown';
+                        return `${index + 1}. ${identity}\n   Bus: ${busName}`;
+                    })
+                    .join('\n\n');
+
+                return `Detected MPRIS Players:\n\n${playerList}\n\nUse the identity names in the ignore list (Settings > Media Menu > Ignored Applications)`;
+            } catch (error) {
+                errorHandler(error);
+            }
+        },
+    },
 ];
diff --git a/src/services/media/index.ts b/src/services/media/index.ts
