libempathy-gtk/empathy-sound-manager.c

   1 /*
   2  * empathy-sound-manager.c - Various sound related utility functions.
   3  * Copyright (C) 2009-2010 Collabora Ltd.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18  */
  19
  20 #include "config.h"
  21 #include "empathy-sound-manager.h"
  22
  23 #include <glib/gi18n-lib.h>
  24
  25 #include "empathy-gsettings.h"
  26 #include "empathy-presence-manager.h"
  27 #include "empathy-utils.h"
  28
  29 #define DEBUG_FLAG EMPATHY_DEBUG_OTHER
  30 #include "empathy-debug.h"
  31
  32 typedef struct {
  33   EmpathySound sound_id;
  34   const char * event_ca_id;
  35   const char * event_ca_description;
  36   const char * key;
  37 } EmpathySoundEntry;
  38
  39 typedef struct {
  40   GtkWidget *widget;
  41   gint sound_id;
  42   guint play_interval;
  43   guint replay_timeout_id;
  44   EmpathySoundManager *self;
  45 } EmpathyRepeatableSound;
  46
  47 /* NOTE: these entries MUST be in the same order than EmpathySound enum */
  48 static EmpathySoundEntry sound_entries[LAST_EMPATHY_SOUND] = {
  49   { EMPATHY_SOUND_MESSAGE_INCOMING, "message-new-instant",
  50     N_("Received an instant message"), EMPATHY_PREFS_SOUNDS_INCOMING_MESSAGE } ,
  51   { EMPATHY_SOUND_MESSAGE_OUTGOING, "message-sent-instant",
  52     N_("Sent an instant message"), EMPATHY_PREFS_SOUNDS_OUTGOING_MESSAGE } ,
  53   { EMPATHY_SOUND_CONVERSATION_NEW, "message-new-instant",
  54     N_("Incoming chat request"), EMPATHY_PREFS_SOUNDS_NEW_CONVERSATION },
  55   { EMPATHY_SOUND_CONTACT_CONNECTED, "service-login",
  56     N_("Contact connected"), EMPATHY_PREFS_SOUNDS_CONTACT_LOGIN },
  57   { EMPATHY_SOUND_CONTACT_DISCONNECTED, "service-logout",
  58     N_("Contact disconnected"), EMPATHY_PREFS_SOUNDS_CONTACT_LOGOUT },
  59   { EMPATHY_SOUND_ACCOUNT_CONNECTED, "service-login",
  60     N_("Connected to server"), EMPATHY_PREFS_SOUNDS_SERVICE_LOGIN },
  61   { EMPATHY_SOUND_ACCOUNT_DISCONNECTED, "service-logout",
  62     N_("Disconnected from server"), EMPATHY_PREFS_SOUNDS_SERVICE_LOGOUT },
  63   { EMPATHY_SOUND_PHONE_INCOMING, "phone-incoming-call",
  64     N_("Incoming voice call"), NULL },
  65   { EMPATHY_SOUND_PHONE_OUTGOING, "phone-outgoing-calling",
  66     N_("Outgoing voice call"), NULL },
  67   { EMPATHY_SOUND_PHONE_HANGUP, "phone-hangup",
  68     N_("Voice call ended"), NULL },
  69 };
  70
  71 G_DEFINE_TYPE (EmpathySoundManager, empathy_sound_manager, G_TYPE_OBJECT)
  72
  73 struct _EmpathySoundManagerPrivate
  74 {
  75   /* A hash table containing currently repeating sounds. The format is the
  76    * following:
  77    * Key: An EmpathySound
  78    * Value : The EmpathyRepeatableSound associated with that EmpathySound. */
  79   GHashTable *repeating_sounds;
  80   GSettings *gsettings_sound;
  81 };
  82
  83 static void
  84 empathy_sound_manager_dispose (GObject *object)
  85 {
  86   EmpathySoundManager *self = (EmpathySoundManager *) object;
  87
  88   tp_clear_pointer (&self->priv->repeating_sounds, g_hash_table_unref);
  89   tp_clear_object (&self->priv->gsettings_sound);
  90
  91   G_OBJECT_CLASS (empathy_sound_manager_parent_class)->dispose (object);
  92 }
  93
  94 static void
  95 empathy_sound_manager_class_init (EmpathySoundManagerClass *cls)
  96 {
  97   GObjectClass *object_class = G_OBJECT_CLASS (cls);
  98
  99   object_class->dispose = empathy_sound_manager_dispose;
 100
 101   g_type_class_add_private (cls, sizeof (EmpathySoundManagerPrivate));
 102 }
 103
 104 static void
 105 empathy_sound_widget_destroyed_cb (GtkWidget *widget,
 106     gpointer user_data)
 107 {
 108   EmpathyRepeatableSound *repeatable_sound = user_data;
 109
 110   /* The sound must be stopped... If it is waiting for replay, remove
 111    * it from hash table to cancel. Otherwise playing_finished_cb will be
 112    * called with an error. */
 113   if (repeatable_sound->replay_timeout_id != 0)
 114     {
 115       g_hash_table_remove (repeatable_sound->self->priv->repeating_sounds,
 116           GINT_TO_POINTER (repeatable_sound->sound_id));
 117     }
 118 }
 119
 120 static void
 121 repeating_sounds_item_delete (gpointer data)
 122 {
 123   EmpathyRepeatableSound *repeatable_sound = data;
 124
 125   if (repeatable_sound->replay_timeout_id != 0)
 126     g_source_remove (repeatable_sound->replay_timeout_id);
 127
 128   if (repeatable_sound->widget != NULL)
 129     {
 130       g_signal_handlers_disconnect_by_func (repeatable_sound->widget,
 131           empathy_sound_widget_destroyed_cb, repeatable_sound);
 132     }
 133
 134   g_object_unref (repeatable_sound->self);
 135
 136   g_slice_free (EmpathyRepeatableSound, repeatable_sound);
 137 }
 138
 139 static void
 140 empathy_sound_manager_init (EmpathySoundManager *self)
 141 {
 142   self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
 143       EMPATHY_TYPE_SOUND_MANAGER, EmpathySoundManagerPrivate);
 144
 145   self->priv->repeating_sounds = g_hash_table_new_full (NULL, NULL,
 146       NULL, repeating_sounds_item_delete);
 147
 148   self->priv->gsettings_sound = g_settings_new (EMPATHY_PREFS_SOUNDS_SCHEMA);
 149 }
 150
 151 EmpathySoundManager *
 152 empathy_sound_manager_dup_singleton (void)
 153 {
 154   static EmpathySoundManager *manager = NULL;
 155
 156   if (G_LIKELY (manager != NULL))
 157       return g_object_ref (manager);
 158
 159   manager = g_object_new (EMPATHY_TYPE_SOUND_MANAGER, NULL);
 160
 161   g_object_add_weak_pointer (G_OBJECT (manager), (gpointer *) &manager);
 162   return manager;
 163 }
 164
 165 static gboolean
 166 empathy_check_available_state (void)
 167 {
 168   TpConnectionPresenceType presence;
 169   EmpathyPresenceManager *presence_mgr;
 170
 171   presence_mgr = empathy_presence_manager_dup_singleton ();
 172   presence = empathy_presence_manager_get_state (presence_mgr);
 173   g_object_unref (presence_mgr);
 174
 175   if (presence != TP_CONNECTION_PRESENCE_TYPE_AVAILABLE &&
 176     presence != TP_CONNECTION_PRESENCE_TYPE_UNSET)
 177     return FALSE;
 178
 179   return TRUE;
 180 }
 181
 182 static gboolean
 183 empathy_sound_pref_is_enabled (EmpathySoundManager *self,
 184     EmpathySound sound_id)
 185 {
 186   EmpathySoundEntry *entry;
 187
 188   entry = &(sound_entries[sound_id]);
 189   g_return_val_if_fail (entry->sound_id == sound_id, FALSE);
 190
 191   if (entry->key == NULL)
 192     return TRUE;
 193
 194   if (! g_settings_get_boolean (self->priv->gsettings_sound,
 195       EMPATHY_PREFS_SOUNDS_ENABLED))
 196     return FALSE;
 197
 198   if (!empathy_check_available_state ())
 199     {
 200       if (g_settings_get_boolean (self->priv->gsettings_sound,
 201             EMPATHY_PREFS_SOUNDS_DISABLED_AWAY))
 202         return FALSE;
 203     }
 204
 205   return g_settings_get_boolean (self->priv->gsettings_sound, entry->key);
 206 }
 207
 208 /**
 209  * empathy_sound_manager_stop:
 210  * @self: a #EmpathySoundManager
 211  * @sound_id: The #EmpathySound to stop playing.
 212  *
 213  * Stop playing a sound. If it has been stated in loop with
 214  * empathy_sound_start_playing(), it will also stop replaying.
 215  */
 216 void
 217 empathy_sound_manager_stop (EmpathySoundManager *self,
 218     EmpathySound sound_id)
 219 {
 220   EmpathySoundEntry *entry;
 221   EmpathyRepeatableSound *repeatable_sound;
 222
 223   g_return_if_fail (sound_id < LAST_EMPATHY_SOUND);
 224
 225   entry = &(sound_entries[sound_id]);
 226   g_return_if_fail (entry->sound_id == sound_id);
 227
 228   repeatable_sound = g_hash_table_lookup (self->priv->repeating_sounds,
 229       GINT_TO_POINTER (sound_id));
 230   if (repeatable_sound != NULL)
 231     {
 232       /* The sound must be stopped... If it is waiting for replay, remove
 233        * it from hash table to cancel. Otherwise we'll cancel the sound
 234        * being played. */
 235       if (repeatable_sound->replay_timeout_id != 0)
 236         {
 237           g_hash_table_remove (self->priv->repeating_sounds,
 238               GINT_TO_POINTER (sound_id));
 239           return;
 240         }
 241     }
 242
 243   ca_context_cancel (ca_gtk_context_get (), entry->sound_id);
 244 }
 245
 246 static gboolean
 247 empathy_sound_play_internal (GtkWidget *widget, EmpathySound sound_id,
 248   ca_finish_callback_t callback, gpointer user_data)
 249 {
 250   EmpathySoundEntry *entry;
 251   ca_context *c;
 252   ca_proplist *p = NULL;
 253
 254   entry = &(sound_entries[sound_id]);
 255   g_return_val_if_fail (entry->sound_id == sound_id, FALSE);
 256
 257   c = ca_gtk_context_get ();
 258   ca_context_cancel (c, entry->sound_id);
 259
 260   DEBUG ("Play sound \"%s\" (%s)",
 261          entry->event_ca_id,
 262          entry->event_ca_description);
 263
 264   if (ca_proplist_create (&p) < 0)
 265     goto failed;
 266
 267   if (ca_proplist_sets (p, CA_PROP_EVENT_ID, entry->event_ca_id) < 0)
 268     goto failed;
 269
 270   if (ca_proplist_sets (p, CA_PROP_EVENT_DESCRIPTION,
 271           gettext (entry->event_ca_description)) < 0)
 272     goto failed;
 273
 274   if (widget != NULL)
 275     {
 276       if (ca_gtk_proplist_set_for_widget (p, widget) < 0)
 277         goto failed;
 278     }
 279
 280   ca_context_play_full (ca_gtk_context_get (), entry->sound_id, p, callback,
 281       user_data);
 282
 283   ca_proplist_destroy (p);
 284
 285   return TRUE;
 286
 287 failed:
 288   if (p != NULL)
 289     ca_proplist_destroy (p);
 290
 291   return FALSE;
 292 }
 293
 294 /**
 295  * empathy_sound_manager_play_full:
 296  * @self: a #EmpathySoundManager
 297  * @widget: The #GtkWidget from which the sound is originating.
 298  * @sound_id: The #EmpathySound to play.
 299  * @callback: The #ca_finish_callback_t function that will be called when the
 300  *            sound  has stopped playing.
 301  * @user_data: user data to pass to the function.
 302  *
 303  * Plays a sound.
 304  *
 305  * Returns %TRUE if the sound has successfully started playing, otherwise
 306  * returning %FALSE and @callback won't be called.
 307  *
 308  * This function returns %FALSE if the sound is already playing in loop using
 309  * %empathy_sound_start_playing.
 310  *
 311  * This function returns %FALSE if the sound is disabled in empathy preferences.
 312  *
 313  * Return value: %TRUE if the sound has successfully started playing, %FALSE
 314  *               otherwise.
 315  */
 316 gboolean
 317 empathy_sound_manager_play_full (EmpathySoundManager *self,
 318     GtkWidget *widget,
 319     EmpathySound sound_id,
 320     ca_finish_callback_t callback,
 321     gpointer user_data)
 322 {
 323   g_return_val_if_fail (widget == NULL || GTK_IS_WIDGET (widget), FALSE);
 324   g_return_val_if_fail (sound_id < LAST_EMPATHY_SOUND, FALSE);
 325
 326   if (!empathy_sound_pref_is_enabled (self, sound_id))
 327     return FALSE;
 328
 329   /* The sound might already be playing repeatedly. If it's the case, we
 330    * immediadely return since there's no need to make it play again */
 331   if (g_hash_table_lookup (self->priv->repeating_sounds,
 332         GINT_TO_POINTER (sound_id)) != NULL)
 333     return FALSE;
 334
 335   return empathy_sound_play_internal (widget, sound_id, callback, user_data);
 336 }
 337
 338 /**
 339  * empathy_sound_manager_play:
 340  * @self: a #EmpathySoundManager
 341  * @widget: The #GtkWidget from which the sound is originating.
 342  * @sound_id: The #EmpathySound to play.
 343  *
 344  * Plays a sound. See %empathy_sound_manager_play_full for details.'
 345  *
 346  * Return value: %TRUE if the sound has successfully started playing, %FALSE
 347  *               otherwise.
 348  */
 349 gboolean
 350 empathy_sound_manager_play (EmpathySoundManager *self,
 351     GtkWidget *widget,
 352     EmpathySound sound_id)
 353 {
 354   g_return_val_if_fail (widget == NULL || GTK_IS_WIDGET (widget), FALSE);
 355   g_return_val_if_fail (sound_id < LAST_EMPATHY_SOUND, FALSE);
 356
 357   return empathy_sound_manager_play_full (self, widget, sound_id, NULL, NULL);
 358 }
 359
 360 static void playing_finished_cb (ca_context *c, guint id, int error_code,
 361   gpointer user_data);
 362
 363 static gboolean
 364 playing_timeout_cb (gpointer data)
 365 {
 366   EmpathyRepeatableSound *repeatable_sound = data;
 367   gboolean playing;
 368
 369   repeatable_sound->replay_timeout_id = 0;
 370
 371   playing = empathy_sound_play_internal (repeatable_sound->widget,
 372       repeatable_sound->sound_id, playing_finished_cb, data);
 373
 374   if (!playing)
 375     {
 376       DEBUG ("Failed to replay sound, stop repeating");
 377       g_hash_table_remove (repeatable_sound->self->priv->repeating_sounds,
 378           GINT_TO_POINTER (repeatable_sound->sound_id));
 379     }
 380
 381   return FALSE;
 382 }
 383
 384 static void
 385 playing_finished_cb (ca_context *c, guint id, int error_code,
 386   gpointer user_data)
 387 {
 388   EmpathyRepeatableSound *repeatable_sound = user_data;
 389
 390   if (error_code != CA_SUCCESS)
 391     {
 392       DEBUG ("Error: %s", ca_strerror (error_code));
 393       g_hash_table_remove (repeatable_sound->self->priv->repeating_sounds,
 394           GINT_TO_POINTER (repeatable_sound->sound_id));
 395       return;
 396     }
 397
 398   repeatable_sound->replay_timeout_id = g_timeout_add (
 399       repeatable_sound->play_interval, playing_timeout_cb, user_data);
 400 }
 401
 402 /**
 403  * empathy_sound_manager_start_playing:
 404  * @self: a #EmpathySoundManager
 405  * @widget: The #GtkWidget from which the sound is originating.
 406  * @sound_id: The #EmpathySound to play.
 407  * @timeout_before_replay: The amount of time, in milliseconds, between two
 408  *                         consecutive play.
 409  *
 410  * Start playing a sound in loop. To stop the sound, call empathy_call_stop ()
 411  * by passing it the same @sound_id. Note that if you start playing a sound
 412  * multiple times, you'll have to call %empathy_sound_stop the same number of
 413  * times.
 414  *
 415  * Return value: %TRUE if the sound has successfully started playing.
 416  */
 417 gboolean
 418 empathy_sound_manager_start_playing (EmpathySoundManager *self,
 419     GtkWidget *widget,
 420     EmpathySound sound_id,
 421     guint timeout_before_replay)
 422 {
 423   EmpathyRepeatableSound *repeatable_sound;
 424   gboolean playing = FALSE;
 425
 426   g_return_val_if_fail (widget == NULL || GTK_IS_WIDGET (widget), FALSE);
 427   g_return_val_if_fail (sound_id < LAST_EMPATHY_SOUND, FALSE);
 428
 429   if (!empathy_sound_pref_is_enabled (self, sound_id))
 430     return FALSE;
 431
 432   if (g_hash_table_lookup (self->priv->repeating_sounds,
 433                GINT_TO_POINTER (sound_id)) != NULL)
 434     {
 435       /* The sound is already playing in loop. No need to continue. */
 436       return FALSE;
 437     }
 438
 439   repeatable_sound = g_slice_new0 (EmpathyRepeatableSound);
 440   repeatable_sound->widget = widget;
 441   repeatable_sound->sound_id = sound_id;
 442   repeatable_sound->play_interval = timeout_before_replay;
 443   repeatable_sound->replay_timeout_id = 0;
 444   repeatable_sound->self = g_object_ref (self);
 445
 446   g_hash_table_insert (self->priv->repeating_sounds, GINT_TO_POINTER (sound_id),
 447       repeatable_sound);
 448
 449   if (widget != NULL)
 450     {
 451       g_signal_connect (G_OBJECT (widget), "destroy",
 452           G_CALLBACK (empathy_sound_widget_destroyed_cb),
 453           repeatable_sound);
 454     }
 455
 456   playing = empathy_sound_play_internal (widget, sound_id, playing_finished_cb,
 457         repeatable_sound);
 458
 459   if (!playing)
 460       g_hash_table_remove (self->priv->repeating_sounds,
 461           GINT_TO_POINTER (sound_id));
 462
 463   return playing;
 464 }