X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/219dc95cf771d5ba07aa19a3b33002a649682060..5c739b23f0192923e4485b9eb503a6d0b9aeb5c3:/disobedience/control.c diff --git a/disobedience/control.c b/disobedience/control.c index 1d05167..8e1391e 100644 --- a/disobedience/control.c +++ b/disobedience/control.c @@ -1,6 +1,6 @@ /* * This file is part of DisOrder. - * Copyright (C) 2006, 2007 Richard Kettlewell + * Copyright (C) 2006-2008 Richard Kettlewell * * 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 @@ -22,28 +22,22 @@ */ #include "disobedience.h" +#include "mixer.h" /* Forward declarations ---------------------------------------------------- */ -WT(adjustment); -WT(hscale); -WT(hbox); -WT(tooltips); -WT(button); -WT(image); -WT(label); -WT(vbox); - struct icon; -static void update_pause(const struct icon *); -static void update_play(const struct icon *); -static void update_scratch(const struct icon *); -static void update_random_enable(const struct icon *); -static void update_random_disable(const struct icon *); -static void update_enable(const struct icon *); -static void update_disable(const struct icon *); static void clicked_icon(GtkButton *, gpointer); +static void clicked_menu(GtkMenuItem *, gpointer userdata); +static void toggled_menu(GtkCheckMenuItem *, gpointer userdata); + +static int enable_rtp(disorder_eclient *c, + disorder_eclient_no_response *completed, + void *v); +static int disable_rtp(disorder_eclient *c, + disorder_eclient_no_response *completed, + void *v); static double left(double v, double b); static double right(double v, double b); @@ -54,54 +48,181 @@ static void volume_adjusted(GtkAdjustment *a, gpointer user_data); static gchar *format_volume(GtkScale *scale, gdouble value); static gchar *format_balance(GtkScale *scale, gdouble value); +static void icon_changed(const char *event, + void *evendata, + void *callbackdata); +static void volume_changed(const char *event, + void *eventdata, + void *callbackdata); + /* Control bar ------------------------------------------------------------- */ -/** @brief Guard against feedback loop in volume control */ -static int suppress_set_volume; +/** @brief Guard against feedback */ +int suppress_actions = 1; /** @brief Definition of an icon * - * The design here is rather mad: rather than changing the image displayed by - * icons according to their state, we flip the visibility of pairs of icons. + * We have two kinds of icon: + * - action icons, which just do something but don't have a state as such + * - toggle icons, which toggle between two states ("on" and "off"). + * + * The scratch button is an action icon; currently all the others are toggle + * icons. + * + * (All icons can be sensitive or insensitive, separately to the above.) */ struct icon { - /** @brief Filename for image */ - const char *icon; + /** @brief Filename for 'on' image */ + const char *icon_on; + + /** @brief Text for 'on' tooltip */ + const char *tip_on; + + /** @brief Filename for 'off' image or NULL for an action icon */ + const char *icon_off; + + /** @brief Text for 'off tooltip */ + const char *tip_off; + + /** @brief Associated menu item or NULL */ + const char *menuitem; + + /** @brief Events that change this icon, separated by spaces */ + const char *events; + + /** @brief @ref eclient.h function to call to go from off to on + * + * For action buttons, this should be NULL. + */ + int (*action_go_on)(disorder_eclient *c, + disorder_eclient_no_response *completed, + void *v); + + /** @brief @ref eclient.h function to call to go from on to off + * + * For action buttons, this action is used. + */ + int (*action_go_off)(disorder_eclient *c, + disorder_eclient_no_response *completed, + void *v); + + /** @brief Get button state + * @return 1 for on, 0 for off + */ + int (*on)(void); + + /** @brief Get button sensitivity + * @return 1 for sensitive, 0 for insensitive + * + * Can be NULL for always sensitive. + */ + int (*sensitive)(void); + + /** @brief Pointer to button */ + GtkWidget *button; - /** @brief Text for tooltip */ - const char *tip; + /** @brief Pointer to menu item */ + GtkWidget *item; - /** @brief Called when button is clicked (activated) */ - void (*clicked)(GtkButton *button, gpointer userdata); + GtkWidget *image_on; + GtkWidget *image_off; +}; - /** @brief Called to update button when state may have changed */ - void (*update)(const struct icon *i); +static int pause_resume_on(void) { + return !(last_state & DISORDER_TRACK_PAUSED); +} - /** @brief @ref eclient.h function to call */ - int (*action)(disorder_eclient *c, - disorder_eclient_no_response *completed, - void *v); +static int pause_resume_sensitive(void) { + return !!(last_state & DISORDER_PLAYING) + && (last_rights & RIGHT_PAUSE); +} - /** @brief Pointer to button */ - GtkWidget *button; -}; +static int scratch_sensitive(void) { + return !!(last_state & DISORDER_PLAYING) + && right_scratchable(last_rights, config->username, playing_track); +} + +static int random_sensitive(void) { + return !!(last_rights & RIGHT_GLOBAL_PREFS); +} + +static int random_enabled(void) { + return !!(last_state & DISORDER_RANDOM_ENABLED); +} + +static int playing_sensitive(void) { + return !!(last_rights & RIGHT_GLOBAL_PREFS); +} + +static int playing_enabled(void) { + return !!(last_state & DISORDER_PLAYING_ENABLED); +} + +static int rtp_enabled(void) { + return rtp_is_running; +} + +static int rtp_sensitive(void) { + return rtp_supported; +} /** @brief Table of all icons */ static struct icon icons[] = { - { "pause.png", "Pause playing track", clicked_icon, update_pause, - disorder_eclient_pause, 0 }, - { "play.png", "Resume playing track", clicked_icon, update_play, - disorder_eclient_resume, 0 }, - { "cross.png", "Cancel playing track", clicked_icon, update_scratch, - disorder_eclient_scratch_playing, 0 }, - { "random.png", "Enable random play", clicked_icon, update_random_enable, - disorder_eclient_random_enable, 0 }, - { "randomcross.png", "Disable random play", clicked_icon, update_random_disable, - disorder_eclient_random_disable, 0 }, - { "notes.png", "Enable play", clicked_icon, update_enable, - disorder_eclient_enable, 0 }, - { "notescross.png", "Disable play", clicked_icon, update_disable, - disorder_eclient_disable, 0 }, + { + icon_on: "pause32.png", + tip_on: "Pause playing track", + icon_off: "play32.png", + tip_off: "Resume playing track", + menuitem: "/Control/Playing", + on: pause_resume_on, + sensitive: pause_resume_sensitive, + action_go_on: disorder_eclient_resume, + action_go_off: disorder_eclient_pause, + events: "pause-changed playing-changed rights-changed", + }, + { + icon_on: "cross32.png", + tip_on: "Cancel playing track", + menuitem: "/Control/Scratch", + sensitive: scratch_sensitive, + action_go_off: disorder_eclient_scratch_playing, + events: "playing-track-changed rights-changed", + }, + { + icon_on: "randomenabled32.png", + tip_on: "Disable random play", + icon_off: "randomdisabled32.png", + tip_off: "Enable random play", + menuitem: "/Control/Random play", + on: random_enabled, + sensitive: random_sensitive, + action_go_on: disorder_eclient_random_enable, + action_go_off: disorder_eclient_random_disable, + events: "random-changed rights-changed", + }, + { + icon_on: "playenabled32.png", + tip_on: "Disable play", + icon_off: "playdisabled32.png", + tip_off: "Enable play", + on: playing_enabled, + sensitive: playing_sensitive, + action_go_on: disorder_eclient_enable, + action_go_off: disorder_eclient_disable, + events: "enabled-changed rights-changed", + }, + { + icon_on: "rtpenabled32.png", + tip_on: "Stop playing network stream", + icon_off: "rtpdisabled32.png", + tip_off: "Play network stream", + menuitem: "/Control/Network player", + on: rtp_enabled, + sensitive: rtp_sensitive, + action_go_on: enable_rtp, + action_go_off: disable_rtp, + events: "rtp-changed", + }, }; /** @brief Count of icons */ @@ -109,170 +230,202 @@ static struct icon icons[] = { static GtkAdjustment *volume_adj; static GtkAdjustment *balance_adj; - -/** @brief Called whenever last_state changes in any way */ -static void control_monitor(void attribute((unused)) *u) { - int n; - - D(("control_monitor")); - for(n = 0; n < NICONS; ++n) - icons[n].update(&icons[n]); -} +static GtkWidget *volume_widget; +static GtkWidget *balance_widget; /** @brief Create the control bar */ GtkWidget *control_widget(void) { GtkWidget *hbox = gtk_hbox_new(FALSE, 1), *vbox; - GtkWidget *content; - GdkPixbuf *pb; - GtkWidget *v, *b; - GtkTooltips *tips = gtk_tooltips_new(); int n; - NW(hbox); - NW(tooltips); D(("control_widget")); + assert(mainmenufactory); /* ordering must be right */ for(n = 0; n < NICONS; ++n) { - NW(button); + /* Create the button */ icons[n].button = gtk_button_new(); - if((pb = find_image(icons[n].icon))) { - NW(image); - content = gtk_image_new_from_pixbuf(pb); - } else { - NW(label); - content = gtk_label_new(icons[n].icon); + gtk_widget_set_style(icons[n].button, tool_style); + icons[n].image_on = gtk_image_new_from_pixbuf(find_image(icons[n].icon_on)); + gtk_widget_set_style(icons[n].image_on, tool_style); + g_object_ref(icons[n].image_on); + /* If it's a toggle icon, create the 'off' half too */ + if(icons[n].icon_off) { + icons[n].image_off = gtk_image_new_from_pixbuf(find_image(icons[n].icon_off)); + gtk_widget_set_style(icons[n].image_off, tool_style); + g_object_ref(icons[n].image_off); } - gtk_container_add(GTK_CONTAINER(icons[n].button), content); - gtk_tooltips_set_tip(tips, icons[n].button, icons[n].tip, ""); g_signal_connect(G_OBJECT(icons[n].button), "clicked", - G_CALLBACK(icons[n].clicked), &icons[n]); + G_CALLBACK(clicked_icon), &icons[n]); /* pop the icon in a vbox so it doesn't get vertically stretch if there are * taller things in the control bar */ - NW(vbox); vbox = gtk_vbox_new(FALSE, 0); gtk_box_pack_start(GTK_BOX(vbox), icons[n].button, TRUE, FALSE, 0); gtk_box_pack_start(GTK_BOX(hbox), vbox, FALSE, FALSE, 0); + if(icons[n].menuitem) { + /* Find the menu item */ + icons[n].item = gtk_item_factory_get_widget(mainmenufactory, + icons[n].menuitem); + if(icons[n].icon_off) + g_signal_connect(G_OBJECT(icons[n].item), "toggled", + G_CALLBACK(toggled_menu), &icons[n]); + else + g_signal_connect(G_OBJECT(icons[n].item), "activate", + G_CALLBACK(clicked_menu), &icons[n]); + } + /* Make sure the icon is updated when relevant things changed */ + char **events = split(icons[n].events, 0, 0, 0, 0); + while(*events) + event_register(*events++, icon_changed, &icons[n]); + event_register("connected-changed", icon_changed, &icons[n]); } /* create the adjustments for the volume control */ - NW(adjustment); volume_adj = GTK_ADJUSTMENT(gtk_adjustment_new(0, 0, goesupto, goesupto / 20, goesupto / 20, 0)); - NW(adjustment); balance_adj = GTK_ADJUSTMENT(gtk_adjustment_new(0, -1, 1, 0.2, 0.2, 0)); /* the volume control */ - NW(hscale); - v = gtk_hscale_new(volume_adj); - NW(hscale); - b = gtk_hscale_new(balance_adj); - gtk_scale_set_digits(GTK_SCALE(v), 10); - gtk_scale_set_digits(GTK_SCALE(b), 10); - gtk_widget_set_size_request(v, 192, -1); - gtk_widget_set_size_request(b, 192, -1); - gtk_tooltips_set_tip(tips, v, "Volume", ""); - gtk_tooltips_set_tip(tips, b, "Balance", ""); - gtk_box_pack_start(GTK_BOX(hbox), v, FALSE, TRUE, 0); - gtk_box_pack_start(GTK_BOX(hbox), b, FALSE, TRUE, 0); + volume_widget = gtk_hscale_new(volume_adj); + balance_widget = gtk_hscale_new(balance_adj); + gtk_widget_set_style(volume_widget, tool_style); + gtk_widget_set_style(balance_widget, tool_style); + gtk_scale_set_digits(GTK_SCALE(volume_widget), 10); + gtk_scale_set_digits(GTK_SCALE(balance_widget), 10); + gtk_widget_set_size_request(volume_widget, 192, -1); + gtk_widget_set_size_request(balance_widget, 192, -1); + gtk_tooltips_set_tip(tips, volume_widget, "Volume", ""); + gtk_tooltips_set_tip(tips, balance_widget, "Balance", ""); + gtk_box_pack_start(GTK_BOX(hbox), volume_widget, FALSE, TRUE, 0); + gtk_box_pack_start(GTK_BOX(hbox), balance_widget, FALSE, TRUE, 0); /* space updates rather than hammering the server */ - gtk_range_set_update_policy(GTK_RANGE(v), GTK_UPDATE_DELAYED); - gtk_range_set_update_policy(GTK_RANGE(b), GTK_UPDATE_DELAYED); + gtk_range_set_update_policy(GTK_RANGE(volume_widget), GTK_UPDATE_DELAYED); + gtk_range_set_update_policy(GTK_RANGE(balance_widget), GTK_UPDATE_DELAYED); /* notice when the adjustments are changed */ g_signal_connect(G_OBJECT(volume_adj), "value-changed", G_CALLBACK(volume_adjusted), 0); g_signal_connect(G_OBJECT(balance_adj), "value-changed", G_CALLBACK(volume_adjusted), 0); /* format the volume/balance values ourselves */ - g_signal_connect(G_OBJECT(v), "format-value", + g_signal_connect(G_OBJECT(volume_widget), "format-value", G_CALLBACK(format_volume), 0); - g_signal_connect(G_OBJECT(b), "format-value", + g_signal_connect(G_OBJECT(balance_widget), "format-value", G_CALLBACK(format_balance), 0); - register_monitor(control_monitor, 0, -1UL); + event_register("volume-changed", volume_changed, 0); + event_register("rtp-changed", volume_changed, 0); return hbox; } /** @brief Update the volume control when it changes */ -void volume_update(void) { +static void volume_changed(const char attribute((unused)) *event, + void attribute((unused)) *eventdata, + void attribute((unused)) *callbackdata) { double l, r; - - D(("volume_update")); - l = volume_l / 100.0; - r = volume_r / 100.0; - ++suppress_set_volume; - gtk_adjustment_set_value(volume_adj, volume(l, r) * goesupto); - gtk_adjustment_set_value(balance_adj, balance(l, r)); - --suppress_set_volume; + gboolean volume_supported; + + D(("volume_changed")); + ++suppress_actions; + /* Only display volume/balance controls if they will work */ + if(!rtp_supported + || (rtp_supported && mixer_supported(DEFAULT_BACKEND))) + volume_supported = TRUE; + else + volume_supported = FALSE; + /* TODO: if the server doesn't know how to set the volume [but isn't using + * network play] then we should have volume_supported = FALSE */ + if(volume_supported) { + gtk_widget_show(volume_widget); + gtk_widget_show(balance_widget); + l = volume_l / 100.0; + r = volume_r / 100.0; + gtk_adjustment_set_value(volume_adj, volume(l, r) * goesupto); + gtk_adjustment_set_value(balance_adj, balance(l, r)); + } else { + gtk_widget_hide(volume_widget); + gtk_widget_hide(balance_widget); + } + --suppress_actions; } /** @brief Update the state of one of the control icons - * @param icon Target icon - * @param visible True if this version of the button should be visible - * @param usable True if the button is currently usable - * - * Several of the icons, rather bizarrely, come in pairs: for instance exactly - * one of the play and pause buttons is supposed to be visible at any given - * moment. - * - * @p usable need not take into account server availability, that is done - * automatically. */ -static void update_icon(const struct icon *icon, - int visible, int usable) { +static void icon_changed(const char attribute((unused)) *event, + void attribute((unused)) *evendata, + void *callbackdata) { + //fprintf(stderr, "icon_changed (%s)\n", event); + const struct icon *const icon = callbackdata; + int on = icon->on ? icon->on() : 1; + int sensitive = icon->sensitive ? icon->sensitive() : 1; + //fprintf(stderr, "sensitive->%d\n", sensitive); + GtkWidget *child, *newchild; + + ++suppress_actions; /* If the connection is down nothing is ever usable */ if(!(last_state & DISORDER_CONNECTED)) - usable = 0; - (visible ? gtk_widget_show : gtk_widget_hide)(icon->button); - /* Only both updating usability if the button is visible */ - if(visible) - gtk_widget_set_sensitive(icon->button, usable); -} - -static void update_pause(const struct icon *icon) { - const int visible = !(last_state & DISORDER_TRACK_PAUSED); - const int usable = !!(last_state & DISORDER_PLAYING); /* TODO: might be a lie */ - update_icon(icon, visible, usable); -} - -static void update_play(const struct icon *icon) { - const int visible = !!(last_state & DISORDER_TRACK_PAUSED); - const int usable = !!(last_state & DISORDER_PLAYING); - update_icon(icon, visible, usable); -} - -static void update_scratch(const struct icon *icon) { - const int visible = 1; - const int usable = !!(last_state & DISORDER_PLAYING); - update_icon(icon, visible, usable); + sensitive = 0; + //fprintf(stderr, "(checked connected) sensitive->%d\n", sensitive); + /* Replace the child */ + newchild = on ? icon->image_on : icon->image_off; + child = gtk_bin_get_child(GTK_BIN(icon->button)); + if(child != newchild) { + if(child) + gtk_container_remove(GTK_CONTAINER(icon->button), child); + gtk_container_add(GTK_CONTAINER(icon->button), newchild); + gtk_widget_show(newchild); + } + /* If you disable play or random play NOT via the icon (for instance, via the + * edit menu or via a completely separate command line invocation) then the + * icon shows up as insensitive. Hover the mouse over it and the correct + * state is immediately displayed. sensitive and GTK_WIDGET_SENSITIVE show + * it to be in the correct state, so I think this is may be a GTK+ bug. */ + if(icon->tip_on) + gtk_tooltips_set_tip(tips, icon->button, + on ? icon->tip_on : icon->tip_off, ""); + gtk_widget_set_sensitive(icon->button, sensitive); + /* Icons with an associated menu item */ + if(icon->item) { + if(icon->icon_off) + gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(icon->item), on); + gtk_widget_set_sensitive(icon->item, sensitive); + } + --suppress_actions; } -static void update_random_enable(const struct icon *icon) { - const int visible = !(last_state & DISORDER_RANDOM_ENABLED); - const int usable = 1; - update_icon(icon, visible, usable); +static void icon_action_completed(void attribute((unused)) *v, + const char *err) { + if(err) + popup_protocol_error(0, err); } -static void update_random_disable(const struct icon *icon) { - const int visible = !!(last_state & DISORDER_RANDOM_ENABLED); - const int usable = 1; - update_icon(icon, visible, usable); -} +static void clicked_icon(GtkButton attribute((unused)) *button, + gpointer userdata) { + const struct icon *icon = userdata; -static void update_enable(const struct icon *icon) { - const int visible = !(last_state & DISORDER_PLAYING_ENABLED); - const int usable = 1; - update_icon(icon, visible, usable); + if(suppress_actions) + return; + if(!icon->on || icon->on()) + icon->action_go_off(client, icon_action_completed, 0); + else + icon->action_go_on(client, icon_action_completed, 0); } -static void update_disable(const struct icon *icon) { - const int visible = !!(last_state & DISORDER_PLAYING_ENABLED); - const int usable = 1; - update_icon(icon, visible, usable); +static void clicked_menu(GtkMenuItem attribute((unused)) *menuitem, + gpointer userdata) { + clicked_icon(NULL, userdata); } -static void clicked_icon(GtkButton attribute((unused)) *button, +static void toggled_menu(GtkCheckMenuItem attribute((unused)) *menuitem, gpointer userdata) { - const struct icon *icon = userdata; + clicked_icon(NULL, userdata); +} - icon->action(client, 0, 0); +/** @brief Called when a volume command completes */ +static void volume_completed(void attribute((unused)) *v, + const char *err, + int attribute((unused)) l, + int attribute((unused)) r) { + if(err) + popup_protocol_error(0, err); + /* We don't set the UI's notion of the volume here, it is set from the log + * regardless of the reason it changed */ } /** @brief Called when the volume has been adjusted */ @@ -281,7 +434,7 @@ static void volume_adjusted(GtkAdjustment attribute((unused)) *a, double v = gtk_adjustment_get_value(volume_adj) / goesupto; double b = gtk_adjustment_get_value(balance_adj); - if(suppress_set_volume) + if(suppress_actions) /* This is the result of an update from the server, not a change from the * user. Don't feedback! */ return; @@ -291,10 +444,14 @@ static void volume_adjusted(GtkAdjustment attribute((unused)) *a, b = nearbyint(5 * b) / 5; /* Set the volume. We don't want a reply, we'll get the actual new volume * from the log. */ - disorder_eclient_volume(client, 0, - nearbyint(left(v, b) * 100), - nearbyint(right(v, b) * 100), - 0); + if(rtp_supported) { + int l = nearbyint(left(v, b) * 100), r = nearbyint(right(v, b) * 100); + mixer_control(DEFAULT_BACKEND, &l, &r, 1); + } else + disorder_eclient_volume(client, volume_completed, + nearbyint(left(v, b) * 100), + nearbyint(right(v, b) * 100), + 0); } /** @brief Formats the volume value */ @@ -380,6 +537,30 @@ static double balance(double l, double r) { return 0; } +/** @brief Called to enable RTP play + * + * Rather odd signature is to fit in with the other icons which all call @ref + * lib/eclient.h functions. + */ +static int enable_rtp(disorder_eclient attribute((unused)) *c, + disorder_eclient_no_response attribute((unused)) *completed, + void attribute((unused)) *v) { + start_rtp(); + return 0; +} + +/** @brief Called to disable RTP play + * + * Rather odd signature is to fit in with the other icons which all call @ref + * lib/eclient.h functions. + */ +static int disable_rtp(disorder_eclient attribute((unused)) *c, + disorder_eclient_no_response attribute((unused)) *completed, + void attribute((unused)) *v) { + stop_rtp(); + return 0; +} + /* Local Variables: c-basic-offset:2