/*
* Copyright 2013 Canonical Ltd.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*
* Authors:
* Lars Uebernickel
*/
public class SoundMenu: Object
{
public enum DisplayFlags {
NONE = 0,
SHOW_MUTE = 1,
HIDE_INACTIVE_PLAYERS = 2,
HIDE_PLAYERS = 4
}
public SoundMenu (string? settings_action, DisplayFlags flags) {
/* A sound menu always has at least two sections: the volume section (this.volume_section)
* at the start of the menu, and the settings section at the end. Between those two,
* it has a dynamic amount of player sections, one for each registered player.
*/
this.volume_section = new Menu ();
if ((flags & DisplayFlags.SHOW_MUTE) != 0)
volume_section.append (_("Mute"), "indicator.mute");
volume_section.append_item (this.create_slider_menu_item (_("Volume"), "indicator.volume(0)", 0.0, 1.0, 0.01,
"audio-volume-low-zero-panel",
"audio-volume-high-panel"));
this.menu = new Menu ();
this.menu.append_section (null, volume_section);
if (settings_action != null) {
settings_shown = true;
this.menu.append (_("Sound Settingsā¦"), settings_action);
}
var root_item = new MenuItem (null, "indicator.root");
root_item.set_attribute ("x-canonical-type", "s", "com.canonical.indicator.root");
root_item.set_attribute ("x-canonical-scroll-action", "s", "indicator.scroll");
root_item.set_attribute ("x-canonical-secondary-action", "s", "indicator.mute");
root_item.set_submenu (this.menu);
this.root = new Menu ();
root.append_item (root_item);
this.hide_players = (flags & DisplayFlags.HIDE_PLAYERS) != 0;
this.hide_inactive = (flags & DisplayFlags.HIDE_INACTIVE_PLAYERS) != 0;
this.notify_handlers = new HashTable (direct_hash, direct_equal);
}
public void export (DBusConnection connection, string object_path) {
try {
connection.export_menu_model (object_path, this.root);
} catch (Error e) {
critical ("%s", e.message);
}
}
public bool show_mic_volume {
get {
return this.mic_volume_shown;
}
set {
if (value && !this.mic_volume_shown) {
var slider = this.create_slider_menu_item (_("Microphone Volume"), "indicator.mic-volume", 0.0, 1.0, 0.01,
"audio-input-microphone-low-zero-panel",
"audio-input-microphone-high-panel");
volume_section.append_item (slider);
this.mic_volume_shown = true;
}
else if (!value && this.mic_volume_shown) {
/* TODO: Make smarter */
this.volume_section.remove (this.volume_section.get_n_items () -1);
this.mic_volume_shown = false;
}
}
}
public bool show_high_volume_warning {
get {
return this.high_volume_warning_shown;
}
set {
if (value && !this.high_volume_warning_shown) {
var item = new MenuItem(_("High volume can damage your hearing."), null);
volume_section.append_item (item);
this.high_volume_warning_shown = true;
}
else if (!value && this.high_volume_warning_shown) {
/* TODO: Make smarter */
this.volume_section.remove (this.volume_section.get_n_items () -1);
this.high_volume_warning_shown = false;
}
}
}
public void add_player (MediaPlayer player) {
if (this.notify_handlers.contains (player))
return;
if (player.is_running || !this.hide_inactive)
this.insert_player_section (player);
this.update_playlists (player);
var handler_id = player.notify["is-running"].connect ( () => {
if (player.is_running)
if (this.find_player_section(player) == -1)
this.insert_player_section (player);
else
if (this.hide_inactive)
this.remove_player_section (player);
this.update_playlists (player);
});
this.notify_handlers.insert (player, handler_id);
player.playlists_changed.connect (this.update_playlists);
}
public void remove_player (MediaPlayer player) {
this.remove_player_section (player);
var id = this.notify_handlers.lookup(player);
if (id != 0) {
player.disconnect(id);
}
player.playlists_changed.disconnect (this.update_playlists);
/* this'll drop our ref to it */
this.notify_handlers.remove (player);
}
public Menu root;
public Menu menu;
Menu volume_section;
bool mic_volume_shown;
bool settings_shown = false;
bool high_volume_warning_shown = false;
bool hide_inactive;
bool hide_players = false;
HashTable notify_handlers;
/* returns the position in this.menu of the section that's associated with @player */
int find_player_section (MediaPlayer player) {
debug("Looking for player: %s", player.id);
string action_name = @"indicator.$(player.id)";
int n = this.menu.get_n_items ();
for (int i = 0; i < n; i++) {
var section = this.menu.get_item_link (i, Menu.LINK_SECTION);
if (section == null) continue;
string action;
section.get_item_attribute (0, "action", "s", out action);
if (action == action_name)
return i;
}
debug("Unable to find section for player: %s", player.id);
return -1;
}
void insert_player_section (MediaPlayer player) {
if (this.hide_players)
return;
var section = new Menu ();
Icon icon;
debug("Adding section for player: %s (%s)", player.id, player.is_running ? "running" : "not running");
icon = player.icon;
if (icon == null)
icon = new ThemedIcon.with_default_fallbacks ("application-default-icon");
var player_item = new MenuItem (player.name, "indicator." + player.id);
player_item.set_attribute ("x-canonical-type", "s", "com.canonical.unity.media-player");
if (icon != null)
player_item.set_attribute_value ("icon", icon.serialize ());
section.append_item (player_item);
var playback_item = new MenuItem (null, null);
playback_item.set_attribute ("x-canonical-type", "s", "com.canonical.unity.playback-item");
playback_item.set_attribute ("x-canonical-play-action", "s", "indicator.play." + player.id);
playback_item.set_attribute ("x-canonical-next-action", "s", "indicator.next." + player.id);
playback_item.set_attribute ("x-canonical-previous-action", "s", "indicator.previous." + player.id);
section.append_item (playback_item);
/* Add new players to the end of the player sections, just before the settings */
if (settings_shown) {
this.menu.insert_section (this.menu.get_n_items () -1, null, section);
} else {
this.menu.append_section (null, section);
}
}
void remove_player_section (MediaPlayer player) {
if (this.hide_players)
return;
int index = this.find_player_section (player);
if (index >= 0)
this.menu.remove (index);
}
void update_playlists (MediaPlayer player) {
int index = find_player_section (player);
if (index < 0)
return;
var player_section = this.menu.get_item_link (index, Menu.LINK_SECTION) as Menu;
/* if a section has three items, the playlists menu is in it */
if (player_section.get_n_items () == 3)
player_section.remove (2);
if (!player.is_running)
return;
var count = player.get_n_playlists ();
if (count == 0)
return;
var playlists_section = new Menu ();
for (int i = 0; i < count; i++) {
var playlist_id = player.get_playlist_id (i);
playlists_section.append (player.get_playlist_name (i),
@"indicator.play-playlist.$(player.id)::$playlist_id");
}
var submenu = new Menu ();
submenu.append_section (null, playlists_section);
player_section.append_submenu (_("Choose Playlist"), submenu);
}
MenuItem create_slider_menu_item (string label, string action, double min, double max, double step, string min_icon_name, string max_icon_name) {
var min_icon = new ThemedIcon.with_default_fallbacks (min_icon_name);
var max_icon = new ThemedIcon.with_default_fallbacks (max_icon_name);
var slider = new MenuItem (label, action);
slider.set_attribute ("x-canonical-type", "s", "com.canonical.unity.slider");
slider.set_attribute_value ("min-icon", min_icon.serialize ());
slider.set_attribute_value ("max-icon", max_icon.serialize ());
slider.set_attribute ("min-value", "d", min);
slider.set_attribute ("max-value", "d", max);
slider.set_attribute ("step", "d", step);
return slider;
}
}