1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
/*
* games-sound.c: common sound player for gnome-games
*
* Copyright © 2007-2008 Andreas Røsdal
* Copyright © 2009 Christian Persch
*
* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
*/
#include <config.h>
#include <glib.h>
#include <glib/gi18n.h>
#ifdef ENABLE_SOUND
#include <canberra-gtk.h>
#endif
#include "games-debug.h"
#include "games-runtime.h"
#include "games-sound.h"
#ifdef ENABLE_SOUND
#ifdef CA_CHECK_VERSION
#if CA_CHECK_VERSION (0, 13)
#define HAVE_CANBERRA_GTK_MULTIHEAD_SAFE
#endif
#endif
static gboolean sound_enabled = FALSE;
typedef enum {
GAMES_SOUND_PLAIN,
GAMES_SOUND_FOR_EVENT,
GAMES_SOUND_FOR_WIDGET
} GamesSoundCanberraType;
static void
games_sound_canberra_play (const char *sound_name,
GamesSoundCanberraType type,
gpointer data)
{
char *name, *path;
int rv;
if (!sound_enabled)
return;
name = g_strdup_printf ("%s.ogg", sound_name);
path = games_runtime_get_file (GAMES_RUNTIME_SOUND_DIRECTORY, name);
g_free (name);
switch (type) {
case GAMES_SOUND_PLAIN:
#if 1
/* FIXMEchpe: instead, make sure all games call games_sound_init()
* themselves!
*/
games_sound_init (data);
#endif
#ifdef GNOME_ENABLE_DEBUG
_GAMES_DEBUG_IF (GAMES_DEBUG_SOUND) {
if (!GPOINTER_TO_INT (g_object_get_data (G_OBJECT (data), "games-sound-initialised")))
_games_debug_print (GAMES_DEBUG_SOUND,
"games_sound_play_for_screen called for display %s screen %d but canberra-gtk context not initialised!",
gdk_display_get_name (gdk_screen_get_display (data)),
gdk_screen_get_number (data));
}
#endif /* GNOME_ENABLE_DEBUG */
rv = ca_context_play (
#ifdef HAVE_CANBERRA_GTK_MULTIHEAD_SAFE
ca_gtk_context_get_for_screen (data),
#else
ca_gtk_context_get (),
#endif /* HAVE_CANBERRA_GTK_MULTIHEAD_SAFE */
0,
CA_PROP_MEDIA_NAME, sound_name,
CA_PROP_MEDIA_FILENAME, path,
NULL);
break;
case GAMES_SOUND_FOR_EVENT:
rv = ca_gtk_play_for_event (data,
0,
CA_PROP_MEDIA_NAME, sound_name,
CA_PROP_MEDIA_FILENAME, path,
NULL);
break;
case GAMES_SOUND_FOR_WIDGET:
rv = ca_gtk_play_for_widget (data,
0,
CA_PROP_MEDIA_NAME, sound_name,
CA_PROP_MEDIA_FILENAME, path,
NULL);
break;
default:
g_assert_not_reached ();
}
_games_debug_print (GAMES_DEBUG_SOUND,
"libcanberra playing sound %s [file %s]: %s\n",
sound_name, path, ca_strerror (rv));
g_free (path);
}
#endif /* ENABLE_SOUND */
/**
* games_sound_init:
* @screen: a #GdkScreen
*
* Initialises the sound context of @screen. Should be called
* when creating a window on @screen, or when a window is moved to
* @screen. It is safe to call this multiple times for the same
* @screen.
*/
void
games_sound_init (GdkScreen *screen)
{
#ifdef ENABLE_SOUND
ca_context *context;
if (screen == NULL)
screen = gdk_screen_get_default ();
if (GPOINTER_TO_INT (g_object_get_data (G_OBJECT (screen), "games-sound-initialised")))
return;
_games_debug_print (GAMES_DEBUG_SOUND,
"Initialising canberra-gtk context for display %s screen %d\n",
gdk_display_get_name (gdk_screen_get_display (screen)),
gdk_screen_get_number (screen));
#ifdef HAVE_CANBERRA_GTK_MULTIHEAD_SAFE
context = ca_gtk_context_get_for_screen (screen);
#else
context = ca_gtk_context_get ();
#endif /* HAVE_CANBERRA_GTK_MULTIHEAD_SAFE */
if (!context)
return;
ca_context_change_props (context,
CA_PROP_MEDIA_ROLE, "game",
NULL);
g_object_set_data (G_OBJECT (screen), "games-sound-initialised", GINT_TO_POINTER (TRUE));
#endif /* ENABLE_SOUND */
}
/**
* games_sound_play:
* @sound_name: the sound file to player
*
* Plays a sound with the given filename from the
* GAMES_RUNTIME_SOUND_DIRECTORY directory in .ogg format.
* Sound is played asynchronously; i.e. this function does not block
* until the sound has finished playing.
*
* Use games_sound_play_for_screen(), games_sound_play_for_event()
* or games_sound_play_for_widget() instead.
*/
void
games_sound_play (const gchar * sound_name)
{
games_sound_play_for_screen (sound_name, gdk_screen_get_default ());
}
/**
* games_sound_play_for_screen:
* @sound_name: the sound file to player
*
* Plays a sound with the given filename from the
* GAMES_RUNTIME_SOUND_DIRECTORY directory in .ogg format.
* Sound is played asynchronously; i.e. this function does not block
* until the sound has finished playing.
*
* Consider using games_sound_play_for_event() or games_sound_play_for_widget()
* instead.
*/
void
games_sound_play_for_screen (const gchar * sound_name,
GdkScreen *screen)
{
#if defined(ENABLE_SOUND)
games_sound_canberra_play (sound_name, GAMES_SOUND_PLAIN, screen);
#endif
}
/**
* games_sound_play_for_event:
* @sound_name: the name of the sound to play
* @event: the #GdkEvent associated with the sound
*
* Plays a sound for @event.
* See games_sound_play() for more information.
*/
void
games_sound_play_for_event (const gchar *sound_name,
GdkEvent *event)
{
#ifdef ENABLE_SOUND
games_sound_canberra_play (sound_name, GAMES_SOUND_FOR_EVENT, event);
#endif /* ENABLE_SOUND */
}
/**
* games_sound_play_for_widget:
* @sound_name: the name of the sound to play
* @widget: the #GtkWidget to play the sound for
*
* Plays a sound for @widget. Use games_sound_play_for_event() instead
* if the sound is associated with an event.
*
* See games_sound_play() for more information.
*/
void
games_sound_play_for_widget (const gchar *sound_name,
GtkWidget *widget)
{
#ifdef ENABLE_SOUND
games_sound_canberra_play (sound_name, GAMES_SOUND_FOR_WIDGET, widget);
#endif /* ENABLE_SOUND */
}
/**
* games_sound_enable:
* @enabled:
*
* Enables or disables sound support.
*/
void
games_sound_enable (gboolean enabled)
{
#ifdef ENABLE_SOUND
sound_enabled = enabled;
#endif /* ENABLE_SOUND */
}
/**
* games_sound_is_enabled:
*
* Returns: %TRUE iff sound support is enabled.
*/
gboolean
games_sound_is_enabled (void)
{
#ifdef ENABLE_SOUND
return sound_enabled;
#else
return FALSE;
#endif /* ENABLE_SOUND */
}
/**
* games_sound_is_available:
*
* Returns: whether sound is available
*/
gboolean
games_sound_is_available (void)
{
#ifdef ENABLE_SOUND
return TRUE;
#else
return FALSE;
#endif /* ENABLE_SOUND */
}
|