/* pidgin

*

* Pidgin is the legal property of its developers, whose names are too numerous

* to list here. Please refer to the COPYRIGHT file distributed with this

* source distribution.

*

* 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; either version 2 of the License, or

* (at your option) any later version.

*

* 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, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA

*

*/

#include "internal.h"

#include "pidgin.h"

#ifdef _WIN32

#include <windows.h>

#include <mmsystem.h>

#endif

#ifdef USE_GSTREAMER

# include <gst/gst.h>

#endif /* USE_GSTREAMER */

#include "debug.h"

#include "notify.h"

#include "prefs.h"

#include "sound.h"

#include "sound-theme.h"

#include "theme-manager.h"

#include "util.h"

#include "gtkconv.h"

#include "gtksound.h"

struct pidgin_sound_event {

char *label;

char *pref;

char *def;

};

static guint mute_login_sounds_timeout = 0;

static gboolean mute_login_sounds = FALSE;

#ifdef USE_GSTREAMER

static gboolean gst_init_failed;

#endif /* USE_GSTREAMER */

static const struct pidgin_sound_event sounds[PURPLE_NUM_SOUNDS] = {

{N_("Buddy logs in"), "login", "login.wav"},

{N_("Buddy logs out"), "logout", "logout.wav"},

{N_("Message received"), "im_recv", "receive.wav"},

{N_("Message received begins conversation"), "first_im_recv", "receive.wav"},

{N_("Message sent"), "send_im", "send.wav"},

{N_("Person enters chat"), "join_chat", "login.wav"},

{N_("Person leaves chat"), "left_chat", "logout.wav"},

{N_("You talk in chat"), "send_chat_msg", "send.wav"},

{N_("Others talk in chat"), "chat_msg_recv", "receive.wav"},

/* this isn't a terminator, it's the buddy pounce default sound event ;-) */

{NULL, "pounce_default", "alert.wav"},

{N_("Someone says your username in chat"), "nick_said", "alert.wav"},

{N_("Attention received"), "got_attention", "alert.wav"}

};

static gboolean

unmute_login_sounds_cb(gpointer data)

{

mute_login_sounds = FALSE;

mute_login_sounds_timeout = 0;

return FALSE;

}

static gboolean

chat_nick_matches_name(PurpleChatConversation *chat, const char *aname)

{

char *nick = NULL;

char *name = NULL;

gboolean ret = FALSE;

if (chat==NULL)

return ret;

nick = g_strdup(purple_normalize(purple_conversation_get_account(

PURPLE_CONVERSATION(chat)), purple_chat_conversation_get_nick(chat)));

name = g_strdup(purple_normalize(purple_conversation_get_account(

PURPLE_CONVERSATION(chat)), aname));

if (g_utf8_collate(nick, name) == 0)

ret = TRUE;

g_free(nick);

g_free(name);

return ret;

}

/*

* play a sound event for a conversation, honoring make_sound flag

* of conversation and checking for focus if conv_focus pref is set

*/

static void

play_conv_event(PurpleConversation *conv, PurpleSoundEventID event)

{

g_return_if_fail(event < PURPLE_NUM_SOUNDS);

/* If we should not play the sound for some reason, then exit early */

if (conv != NULL && PIDGIN_IS_PIDGIN_CONVERSATION(conv))

{

PidginConversation *gtkconv;

gboolean has_focus;

gtkconv = PIDGIN_CONVERSATION(conv);

has_focus = purple_conversation_has_focus(conv);

if (!gtkconv->make_sound ||

(has_focus && !purple_prefs_get_bool(PIDGIN_PREFS_ROOT "/sound/conv_focus")))

{

return;

}

}

purple_sound_play_event(event, conv ? purple_conversation_get_account(conv) : NULL);

}

static void

buddy_state_cb(PurpleBuddy *buddy, PurpleSoundEventID event)

{

purple_sound_play_event(event, purple_buddy_get_account(buddy));

}

static void

im_msg_received_cb(PurpleAccount *account, char *sender,

char *message, PurpleConversation *conv,

PurpleMessageFlags flags, PurpleSoundEventID event)

{

if (flags & PURPLE_MESSAGE_DELAYED || flags & PURPLE_MESSAGE_NOTIFY)

return;

if (conv==NULL)

purple_sound_play_event(PURPLE_SOUND_FIRST_RECEIVE, account);

else

play_conv_event(conv, event);

}

static void

im_msg_sent_cb(PurpleAccount *account, PurpleMessage *msg,

PurpleSoundEventID event)

{

PurpleConversation *conv = PURPLE_CONVERSATION(

purple_conversations_find_im_with_account(

purple_message_get_recipient(msg), account));

play_conv_event(conv, event);

}

static void

chat_user_join_cb(PurpleChatConversation *chat, const char *name,

PurpleChatUserFlags flags, gboolean new_arrival,

PurpleSoundEventID event)

{

if (new_arrival && !chat_nick_matches_name(chat, name))

play_conv_event(PURPLE_CONVERSATION(chat), event);

}

static void

chat_user_left_cb(PurpleChatConversation *chat, const char *name,

const char *reason, PurpleSoundEventID event)

{

if (!chat_nick_matches_name(chat, name))

play_conv_event(PURPLE_CONVERSATION(chat), event);

}

static void

chat_msg_sent_cb(PurpleAccount *account, PurpleMessage *msg, int id,

PurpleSoundEventID event)

{

PurpleConnection *conn = purple_account_get_connection(account);

PurpleConversation *conv = NULL;

if (conn!=NULL)

conv = PURPLE_CONVERSATION(purple_conversations_find_chat(conn,id));

play_conv_event(conv, event);

}

static void

chat_msg_received_cb(PurpleAccount *account, char *sender,

char *message, PurpleChatConversation *chat,

PurpleMessageFlags flags, PurpleSoundEventID event)

{

PurpleConversation *conv = PURPLE_CONVERSATION(chat);

if (flags & PURPLE_MESSAGE_DELAYED || flags & PURPLE_MESSAGE_NOTIFY)

return;

g_return_if_fail(conv != NULL);

if (purple_chat_conversation_is_ignored_user(chat, sender))

return;

if (chat_nick_matches_name(chat, sender))

return;

if (flags & PURPLE_MESSAGE_NICK || purple_utf8_has_word(message, purple_chat_conversation_get_nick(chat)))

/* This isn't quite right; if you have the PURPLE_SOUND_CHAT_NICK event disabled

* and the PURPLE_SOUND_CHAT_SAY event enabled, you won't get a sound at all */

play_conv_event(conv, PURPLE_SOUND_CHAT_NICK);

else

play_conv_event(conv, event);

}

static void

got_attention_cb(PurpleAccount *account, const char *who,

PurpleConversation *conv, guint type, PurpleSoundEventID event)

{

play_conv_event(conv, event);

}

/*

* We mute sounds for the 10 seconds after you log in so that

* you don't get flooded with sounds when the blist shows all

* your buddies logging in.

*/

static void

account_signon_cb(PurpleConnection *gc, gpointer data)

{

if (mute_login_sounds_timeout != 0)

g_source_remove(mute_login_sounds_timeout);

mute_login_sounds = TRUE;

mute_login_sounds_timeout = g_timeout_add_seconds(10, unmute_login_sounds_cb, NULL);

}

const char *

pidgin_sound_get_event_option(PurpleSoundEventID event)

{

if(event >= PURPLE_NUM_SOUNDS)

return 0;

return sounds[event].pref;

}

const char *

pidgin_sound_get_event_label(PurpleSoundEventID event)

{

if(event >= PURPLE_NUM_SOUNDS)

return NULL;

return sounds[event].label;

}

void *

pidgin_sound_get_handle()

{

static int handle;

return &handle;

}

static void

pidgin_sound_init(void)

{

void *gtk_sound_handle = pidgin_sound_get_handle();

void *blist_handle = purple_blist_get_handle();

void *conv_handle = purple_conversations_get_handle();

#ifdef USE_GSTREAMER

GError *error = NULL;

#endif

purple_signal_connect(purple_connections_get_handle(), "signed-on",

gtk_sound_handle, PURPLE_CALLBACK(account_signon_cb),

NULL);

purple_prefs_add_none(PIDGIN_PREFS_ROOT "/sound");

purple_prefs_add_none(PIDGIN_PREFS_ROOT "/sound/enabled");

purple_prefs_add_none(PIDGIN_PREFS_ROOT "/sound/file");

purple_prefs_add_bool(PIDGIN_PREFS_ROOT "/sound/enabled/login", TRUE);

purple_prefs_add_path(PIDGIN_PREFS_ROOT "/sound/file/login", "");

purple_prefs_add_bool(PIDGIN_PREFS_ROOT "/sound/enabled/logout", TRUE);

purple_prefs_add_path(PIDGIN_PREFS_ROOT "/sound/file/logout", "");

purple_prefs_add_bool(PIDGIN_PREFS_ROOT "/sound/enabled/im_recv", TRUE);

purple_prefs_add_path(PIDGIN_PREFS_ROOT "/sound/file/im_recv", "");

purple_prefs_add_bool(PIDGIN_PREFS_ROOT "/sound/enabled/first_im_recv", FALSE);

purple_prefs_add_path(PIDGIN_PREFS_ROOT "/sound/file/first_im_recv", "");

purple_prefs_add_bool(PIDGIN_PREFS_ROOT "/sound/enabled/send_im", TRUE);

purple_prefs_add_path(PIDGIN_PREFS_ROOT "/sound/file/send_im", "");

purple_prefs_add_bool(PIDGIN_PREFS_ROOT "/sound/enabled/join_chat", FALSE);

purple_prefs_add_path(PIDGIN_PREFS_ROOT "/sound/file/join_chat", "");

purple_prefs_add_bool(PIDGIN_PREFS_ROOT "/sound/enabled/left_chat", FALSE);

purple_prefs_add_path(PIDGIN_PREFS_ROOT "/sound/file/left_chat", "");

purple_prefs_add_bool(PIDGIN_PREFS_ROOT "/sound/enabled/send_chat_msg", FALSE);

purple_prefs_add_path(PIDGIN_PREFS_ROOT "/sound/file/send_chat_msg", "");

purple_prefs_add_bool(PIDGIN_PREFS_ROOT "/sound/enabled/chat_msg_recv", FALSE);

purple_prefs_add_path(PIDGIN_PREFS_ROOT "/sound/file/chat_msg_recv", "");

purple_prefs_add_bool(PIDGIN_PREFS_ROOT "/sound/enabled/nick_said", FALSE);

purple_prefs_add_path(PIDGIN_PREFS_ROOT "/sound/file/nick_said", "");

purple_prefs_add_bool(PIDGIN_PREFS_ROOT "/sound/enabled/pounce_default", TRUE);

purple_prefs_add_path(PIDGIN_PREFS_ROOT "/sound/file/pounce_default", "");

purple_prefs_add_string(PIDGIN_PREFS_ROOT "/sound/theme", "");

purple_prefs_add_bool(PIDGIN_PREFS_ROOT "/sound/enabled/sent_attention", TRUE);

purple_prefs_add_path(PIDGIN_PREFS_ROOT "/sound/file/sent_attention", "");

purple_prefs_add_bool(PIDGIN_PREFS_ROOT "/sound/enabled/got_attention", TRUE);

purple_prefs_add_path(PIDGIN_PREFS_ROOT "/sound/file/got_attention", "");

purple_prefs_add_bool(PIDGIN_PREFS_ROOT "/sound/conv_focus", TRUE);

purple_prefs_add_bool(PIDGIN_PREFS_ROOT "/sound/mute", FALSE);

purple_prefs_add_path(PIDGIN_PREFS_ROOT "/sound/command", "");

purple_prefs_add_string(PIDGIN_PREFS_ROOT "/sound/method", "automatic");

#ifdef USE_GSTREAMER

purple_debug_info("sound", "Initializing sound output drivers.\n");

gst_registry_fork_set_enabled(FALSE);

if ((gst_init_failed = !gst_init_check(NULL, NULL, &error))) {

purple_notify_error(NULL, _("GStreamer Failure"),

_("GStreamer failed to initialize."),

error ? error->message : "", NULL);

if (error) {

g_error_free(error);

error = NULL;

}

}

#endif /* USE_GSTREAMER */

purple_signal_connect(blist_handle, "buddy-signed-on",

gtk_sound_handle, PURPLE_CALLBACK(buddy_state_cb),

GINT_TO_POINTER(PURPLE_SOUND_BUDDY_ARRIVE));

purple_signal_connect(blist_handle, "buddy-signed-off",

gtk_sound_handle, PURPLE_CALLBACK(buddy_state_cb),

GINT_TO_POINTER(PURPLE_SOUND_BUDDY_LEAVE));

purple_signal_connect(conv_handle, "received-im-msg",

gtk_sound_handle, PURPLE_CALLBACK(im_msg_received_cb),

GINT_TO_POINTER(PURPLE_SOUND_RECEIVE));

purple_signal_connect(conv_handle, "sent-im-msg",

gtk_sound_handle, PURPLE_CALLBACK(im_msg_sent_cb),

GINT_TO_POINTER(PURPLE_SOUND_SEND));

purple_signal_connect(conv_handle, "chat-user-joined",

gtk_sound_handle, PURPLE_CALLBACK(chat_user_join_cb),

GINT_TO_POINTER(PURPLE_SOUND_CHAT_JOIN));

purple_signal_connect(conv_handle, "chat-user-left",

gtk_sound_handle, PURPLE_CALLBACK(chat_user_left_cb),

GINT_TO_POINTER(PURPLE_SOUND_CHAT_LEAVE));

purple_signal_connect(conv_handle, "sent-chat-msg",

gtk_sound_handle, PURPLE_CALLBACK(chat_msg_sent_cb),

GINT_TO_POINTER(PURPLE_SOUND_CHAT_YOU_SAY));

purple_signal_connect(conv_handle, "received-chat-msg",

gtk_sound_handle, PURPLE_CALLBACK(chat_msg_received_cb),

GINT_TO_POINTER(PURPLE_SOUND_CHAT_SAY));

purple_signal_connect(conv_handle, "got-attention", gtk_sound_handle,

PURPLE_CALLBACK(got_attention_cb),

GINT_TO_POINTER(PURPLE_SOUND_GOT_ATTENTION));

/* for the time being, don't handle sent-attention here, since playing a

sound would result induplicate sounds. And fixing that would require changing the

conversation signal for msg-recv */

}

static void

pidgin_sound_uninit(void)

{

#ifdef USE_GSTREAMER

if (!gst_init_failed)

gst_deinit();

#endif

purple_signals_disconnect_by_handle(pidgin_sound_get_handle());

}

#ifdef USE_GSTREAMER

static gboolean

bus_call (GstBus *bus,

GstMessage *msg,

gpointer data)

{

GstElement *play = data;

GError *err = NULL;

switch (GST_MESSAGE_TYPE (msg)) {

case GST_MESSAGE_ERROR:

gst_message_parse_error(msg, &err, NULL);

purple_debug_error("gstreamer", "%s\n", err->message);

g_error_free(err);

/* fall-through and clean up */

case GST_MESSAGE_EOS:

gst_element_set_state(play, GST_STATE_NULL);

gst_object_unref(GST_OBJECT(play));

return FALSE;

break;

case GST_MESSAGE_WARNING:

gst_message_parse_warning(msg, &err, NULL);

purple_debug_warning("gstreamer", "%s\n", err->message);

g_error_free(err);

break;

default:

break;

}

return TRUE;

}

#endif

#ifndef _WIN32

static gboolean

expire_old_child(gpointer data)

{

pid_t pid = GPOINTER_TO_INT(data);

if (waitpid(pid, NULL, WNOHANG | WUNTRACED) < 0) {

if (errno == ECHILD)

return FALSE;

else

purple_debug_warning("gtksound", "Child is ill, pid: %d (%s)\n", pid, strerror(errno));

}

if (kill(pid, SIGKILL) < 0)

purple_debug_error("gtksound", "Killing process %d failed (%s)\n", pid, strerror(errno));

return FALSE;

}

#endif

#ifdef _WIN32

static void

pidgin_sound_play_file_win32(const char *filename)

{

wchar_t *wc_filename = g_utf8_to_utf16(filename,

-1, NULL, NULL, NULL);

if (!PlaySoundW(wc_filename, NULL, SND_ASYNC | SND_FILENAME))

purple_debug(PURPLE_DEBUG_ERROR, "sound", "Error playing sound.\n");

g_free(wc_filename);

}

#endif /* _WIN32 */

static void

pidgin_sound_play_file(const char *filename)

{

const char *method;

#ifdef USE_GSTREAMER

char *uri;

GstElement *sink = NULL;

GstElement *play = NULL;

GstBus *bus = NULL;

#endif

if (purple_prefs_get_bool(PIDGIN_PREFS_ROOT "/sound/mute"))

return;

method = purple_prefs_get_string(PIDGIN_PREFS_ROOT "/sound/method");

if (purple_strequal(method, "none")) {

return;

} else if (purple_strequal(method, "beep")) {

gdk_beep();

return;

}

#ifdef _WIN32

else if (purple_strequal(method, "playsoundw")) {

pidgin_sound_play_file_win32(filename);

return;

}

#endif /* _WIN32 */

if (!g_file_test(filename, G_FILE_TEST_EXISTS)) {

purple_debug_error("gtksound", "sound file (%s) does not exist.\n", filename);

return;

}

#ifndef _WIN32

if (purple_strequal(method, "custom")) {

const char *sound_cmd;

char *command;

char *esc_filename;

char **argv = NULL;

GError *error = NULL;

GPid pid;

sound_cmd = purple_prefs_get_path(PIDGIN_PREFS_ROOT "/sound/command");

if (!sound_cmd || *sound_cmd == '\0') {

purple_debug_error("gtksound",

"'Command' sound method has been chosen, "

"but no command has been set.\n");

return;

}

esc_filename = g_shell_quote(filename);

if(strstr(sound_cmd, "%s"))

command = purple_strreplace(sound_cmd, "%s", esc_filename);

else

command = g_strdup_printf("%s %s", sound_cmd, esc_filename);

if (!g_shell_parse_argv(command, NULL, &argv, &error)) {

purple_debug_error("gtksound", "error parsing command %s (%s)\n",

command, error->message);

g_error_free(error);

g_free(esc_filename);

g_free(command);

return;

}

if (!g_spawn_async(NULL, argv, NULL, G_SPAWN_SEARCH_PATH | G_SPAWN_DO_NOT_REAP_CHILD,

NULL, NULL, &pid, &error)) {

purple_debug_error("gtksound", "sound command could not be launched: %s\n",

error->message);

g_error_free(error);

} else {

g_timeout_add_seconds(15, expire_old_child, GINT_TO_POINTER(pid));

}

g_strfreev(argv);

g_free(esc_filename);

g_free(command);

return;

}

#endif /* _WIN32 */

#ifdef USE_GSTREAMER

if (gst_init_failed) /* Perhaps do gdk_beep instead? */

return;

#ifdef _WIN32

if (purple_strequal(method, "automatic")) {

sink = gst_element_factory_make("directsoundsink", "sink");

if (sink == NULL)

sink = gst_element_factory_make("waveformsink", "sink");

if (sink == NULL)

sink = gst_element_factory_make("gconfaudiosink", "sink");

} else if (purple_strequal(method, "directsound")) {

sink = gst_element_factory_make("directsoundsink", "sink");

} else if (purple_strequal(method, "waveform")) {

sink = gst_element_factory_make("waveformsink", "sink");

}

#else

if (purple_strequal(method, "automatic")) {

sink = gst_element_factory_make("gconfaudiosink", "sink");

} else if (purple_strequal(method, "esd")) {

sink = gst_element_factory_make("esdsink", "sink");

} else if (purple_strequal(method, "alsa")) {

sink = gst_element_factory_make("alsasink", "sink");

}

#endif

else {

purple_debug_error("sound", "Unknown sound method '%s'\n", method);

return;

}

if (!purple_strequal(method, "automatic") && !sink) {

purple_debug_error("sound", "Unable to create GStreamer audiosink.\n");

return;

}

play = gst_element_factory_make("playbin", "play");

if (play == NULL) {

return;

}

#ifdef _WIN32

uri = g_strdup_printf("file:///%s", filename);

g_strdelimit(uri, "\\", '/');

#else

uri = g_strdup_printf("file://%s", filename);

#endif

g_object_set(G_OBJECT(play), "uri", uri,

"audio-sink", sink, NULL);

bus = gst_pipeline_get_bus(GST_PIPELINE(play));

gst_bus_add_watch(bus, bus_call, play);

gst_element_set_state(play, GST_STATE_PLAYING);

gst_object_unref(bus);

g_free(uri);

#else /* #ifdef USE_GSTREAMER */

#ifndef _WIN32

gdk_beep();

#else /* _WIN32 */

pidgin_sound_play_file_win32(filename);

#endif /* _WIN32 */

#endif /* USE_GSTREAMER */

}

static void

pidgin_sound_play_event(PurpleSoundEventID event)

{

char *enable_pref;

char *file_pref;

const char *theme_name;

PurpleSoundTheme *theme;

if ((event == PURPLE_SOUND_BUDDY_ARRIVE) && mute_login_sounds)

return;

if (event >= PURPLE_NUM_SOUNDS) {

purple_debug_error("sound", "got request for unknown sound: %d\n", event);

return;

}

enable_pref = g_strdup_printf(PIDGIN_PREFS_ROOT "/sound/enabled/%s",

sounds[event].pref);

file_pref = g_strdup_printf(PIDGIN_PREFS_ROOT "/sound/file/%s", sounds[event].pref);

/* check NULL for sounds that don't have an option, ie buddy pounce */

if (purple_prefs_get_bool(enable_pref)) {

char *filename = g_strdup(purple_prefs_get_path(file_pref));

theme_name = purple_prefs_get_string(PIDGIN_PREFS_ROOT "/sound/theme");

if (theme_name && *theme_name && (!filename || !*filename)) {

/* Use theme */

g_free(filename);

theme = PURPLE_SOUND_THEME(purple_theme_manager_find_theme(theme_name, "sound"));

filename = purple_sound_theme_get_file_full(theme, sounds[event].pref);

if(!g_file_test(filename, G_FILE_TEST_IS_REGULAR)){ /* Use Default sound in this case */

purple_debug_error("sound", "The file: (%s) %s\n from theme: %s, was not found or wasn't readable\n",

sounds[event].pref, filename, theme_name);

g_free(filename);

filename = NULL;

}

}

if (!filename || *filename == '\0') { /* Use Default sounds */

g_free(filename);

filename = g_build_filename(PURPLE_DATADIR,

"sounds", "purple", sounds[event].def, NULL);

}

purple_sound_play_file(filename, NULL);

g_free(filename);

}

g_free(enable_pref);

g_free(file_pref);

}

gboolean

pidgin_sound_is_customized(void)

{

gint i;

gchar *path;

const char *file;

for (i = 0; i < PURPLE_NUM_SOUNDS; i++) {

path = g_strdup_printf(PIDGIN_PREFS_ROOT "/sound/file/%s", sounds[i].pref);

file = purple_prefs_get_path(path);

g_free(path);

if (file && file[0] != '\0')

return TRUE;

}

return FALSE;

}

static PurpleSoundUiOps sound_ui_ops =

{

pidgin_sound_init,

pidgin_sound_uninit,

pidgin_sound_play_file,

pidgin_sound_play_event,

NULL,

NULL,

NULL,

NULL

};

PurpleSoundUiOps *

pidgin_sound_get_ui_ops(void)

{

return &sound_ui_ops;

}