3 #include <glib/gi18n.h>
4 #include <libchimara/glk.h>
10 #include "chimara-glk-private.h"
15 extern GPrivate *glk_data_key;
17 #ifdef GSTREAMER_SOUND
19 on_pipeline_message(GstBus *bus, GstMessage *message, schanid_t s)
21 g_print("Got %s message\n", GST_MESSAGE_TYPE_NAME(message));
23 switch(GST_MESSAGE_TYPE(message)) {
24 case GST_MESSAGE_ERROR:
29 gst_message_parse_error(message, &err, &debug);
30 g_print("Error: %s\n", err->message);
35 case GST_MESSAGE_STATE_CHANGED:
37 GstState old_state, new_state;
38 gst_message_parse_state_changed(message, &old_state, &new_state, NULL);
39 g_print("Element %s changed state from %s to %s.\n",
40 GST_OBJECT_NAME(message->src),
41 gst_element_state_get_name(old_state),
42 gst_element_state_get_name(new_state));
47 if(!gst_element_set_state(s->pipeline, GST_STATE_READY))
48 WARNING_S(_("Could not set GstElement state to"), "READY");
51 /* unhandled message */
57 on_ogg_demuxer_pad_added(GstElement *demux, GstPad *pad, schanid_t s)
61 /* We can now link this pad with the vorbis-decoder sink pad */
62 sinkpad = gst_element_get_static_pad(s->decode, "sink");
63 gst_pad_link(pad, sinkpad);
64 gst_object_unref(sinkpad);
68 on_type_found(GstElement *typefind, guint probability, GstCaps *caps, schanid_t s)
70 gchar *type = gst_caps_to_string(caps);
71 if(strcmp(type, "application/ogg") == 0)
73 s->demux = gst_element_factory_make("oggdemux", NULL);
74 s->decode = gst_element_factory_make("vorbisdec", NULL);
75 if(!s->demux || !s->decode)
77 WARNING(_("Could not create one or more GStreamer elements"));
80 gst_bin_add_many(GST_BIN(s->pipeline), s->demux, s->decode, NULL);
81 if(!gst_element_link(s->typefind, s->demux) || !gst_element_link(s->decode, s->convert))
83 WARNING(_("Could not link GStreamer elements"));
86 /* We link the demuxer and decoder together dynamically, since the
87 demuxer doesn't know what source pads it will have until it starts
88 demuxing the stream */
89 g_signal_connect(s->demux, "pad-added", G_CALLBACK(on_ogg_demuxer_pad_added), s);
91 else if(strcmp(type, "audio/x-aiff") == 0)
93 s->decode = gst_element_factory_make("aiffparse", NULL);
96 WARNING(_("Could not create 'aiffparse' GStreamer element"));
99 gst_bin_add(GST_BIN(s->pipeline), s->decode);
100 if(!gst_element_link_many(s->typefind, s->decode, s->convert, NULL))
102 WARNING(_("Could not link GStreamer elements"));
108 WARNING("Can't play that type, you FOOL!");
114 #endif /* GSTREAMER_SOUND */
117 * glk_schannel_create:
118 * @rock: The rock value to give the new sound channel.
120 * This creates a sound channel, about as you'd expect.
122 * Remember that it is possible that the library will be unable to create a new
123 * channel, in which case glk_schannel_create() will return %NULL.
125 * Returns: A new sound channel, or %NULL.
128 glk_schannel_create(glui32 rock)
130 #ifdef GSTREAMER_SOUND
131 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
133 schanid_t s = g_new0(struct glk_schannel_struct, 1);
134 s->magic = MAGIC_SCHANNEL;
136 if(glk_data->register_obj)
137 s->disprock = (*glk_data->register_obj)(s, gidisp_Class_Schannel);
139 /* Add it to the global sound channel list */
140 glk_data->schannel_list = g_list_prepend(glk_data->schannel_list, s);
141 s->schannel_list = glk_data->schannel_list;
143 /* Create a GStreamer pipeline for the sound channel */
144 gchar *pipeline_name = g_strdup_printf("pipeline-%p", s);
145 s->pipeline = gst_pipeline_new(pipeline_name);
146 g_free(pipeline_name);
148 /* Watch for messages from the pipeline */
149 GstBus *bus = gst_pipeline_get_bus(GST_PIPELINE(s->pipeline));
150 gst_bus_add_signal_watch(bus);
151 g_signal_connect(bus, "message", G_CALLBACK(on_pipeline_message), s);
152 gst_object_unref(bus);
154 /* Create GStreamer elements to put in the pipeline */
155 s->source = gst_element_factory_make("giostreamsrc", NULL);
156 s->typefind = gst_element_factory_make("typefind", NULL);
157 s->convert = gst_element_factory_make("audioconvert", NULL);
158 s->filter = gst_element_factory_make("volume", NULL);
159 s->sink = gst_element_factory_make("autoaudiosink", NULL);
160 if(!s->source || !s->typefind || !s->convert || !s->filter || !s->sink) {
161 WARNING(_("Could not create one or more GStreamer elements"));
165 gst_bin_add_many(GST_BIN(s->pipeline), s->source, s->typefind, s->convert, s->filter, s->sink, NULL);
166 /* Link elements: Source -> typefinder -> ??? -> Converter -> Volume filter -> Sink */
167 if(!gst_element_link(s->source, s->typefind) || !gst_element_link_many(s->convert, s->filter, s->sink, NULL)) {
168 WARNING(_("Could not link GStreamer elements"));
171 g_signal_connect(s->typefind, "have-type", G_CALLBACK(on_type_found), s);
176 glk_schannel_destroy(s);
180 #endif /* GSTREAMER_SOUND */
184 * glk_schannel_destroy:
185 * @chan: The sound channel to destroy.
187 * Destroys the channel. If the channel is playing a sound, the sound stops
188 * immediately (with no notification event).
191 glk_schannel_destroy(schanid_t chan)
193 VALID_SCHANNEL(chan, return);
195 #ifdef GSTREAMER_SOUND
196 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
198 if(!gst_element_set_state(chan->pipeline, GST_STATE_NULL))
199 WARNING_S(_("Could not set GstElement state to"), "NULL");
201 glk_data->schannel_list = g_list_delete_link(glk_data->schannel_list, chan->schannel_list);
203 if(glk_data->unregister_obj)
205 (*glk_data->unregister_obj)(chan, gidisp_Class_Schannel, chan->disprock);
206 chan->disprock.ptr = NULL;
210 gst_object_unref(chan->pipeline);
212 chan->magic = MAGIC_FREE;
218 * glk_schannel_iterate:
219 * @chan: A sound channel, or %NULL.
220 * @rockptr: Return location for the next sound channel's rock, or %NULL.
222 * This function can be used to iterate through the list of all open channels.
223 * See <link linkend="chimara-Iterating-Through-Opaque-Objects">Iterating
224 * Through Opaque Objects</link>.
226 * As that section describes, the order in which channels are returned is
229 * Returns: the next sound channel, or %NULL if there are no more.
232 glk_schannel_iterate(schanid_t chan, glui32 *rockptr)
234 VALID_SCHANNEL_OR_NULL(chan, return NULL);
236 #ifdef GSTREAMER_SOUND
237 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
241 retnode = glk_data->schannel_list;
243 retnode = chan->schannel_list->next;
244 schanid_t retval = retnode? (schanid_t)retnode->data : NULL;
246 /* Store the sound channel's rock in rockptr */
247 if(retval && rockptr)
248 *rockptr = glk_schannel_get_rock(retval);
253 #endif /* GSTREAMER_SOUND */
257 * glk_schannel_get_rock:
258 * @chan: A sound channel.
260 * Retrieves the channel's rock value. See <link
261 * linkend="chimara-Rocks">Rocks</link>.
263 * Returns: A rock value.
266 glk_schannel_get_rock(schanid_t chan)
268 VALID_SCHANNEL(chan, return 0);
274 * @chan: Channel to play the sound in.
275 * @snd: Resource number of the sound to play.
277 * Begins playing the given sound on the channel. If the channel was already
278 * playing a sound (even the same one), the old sound is stopped (with no
279 * notification event.
281 * This returns 1 if the sound actually started playing, and 0 if there was any
284 * The most obvious problem is if there is no sound resource with the given
285 * identifier. But other problems can occur. For example, the MOD-playing
286 * facility in a library might be unable to handle two MODs at the same time,
287 * in which case playing a MOD resource would fail if one was already playing.
290 * Returns: 1 on success, 0 on failure.
293 glk_schannel_play(schanid_t chan, glui32 snd)
295 return glk_schannel_play_ext(chan, snd, 1, 0);
299 * glk_schannel_play_ext:
300 * @chan: Channel to play the sound in.
301 * @snd: Resource number of the sound to play.
302 * @repeats: Number of times to repeat the sound.
303 * @notify: If nonzero, requests a notification when the sound is finished.
305 * This works the same as glk_schannel_play(), but lets you specify additional
306 * options. <code>glk_schannel_play(chan, snd)</code> is exactly equivalent to
307 * <code>glk_schannel_play_ext(chan, snd, 1, 0)</code>.
309 * The @repeats value is the number of times the sound should be repeated. A
310 * repeat value of -1 (or rather 0xFFFFFFFF) means that the sound should repeat
311 * forever. A repeat value of 0 means that the sound will not be played at all;
312 * nothing happens. (Although a previous sound on the channel will be stopped,
313 * and the function will return 1.)
315 * The @notify value should be nonzero in order to request a sound notification
316 * event. If you do this, when the sound is completed, you will get an event
317 * with type %evtype_SoundNotify. The @window will be %NULL, @val1 will be the
318 * sound's resource id, and @val2 will be the nonzero value you passed as
321 * If you request sound notification, and the repeat value is greater than one,
322 * you will get the event only after the last repetition. If the repeat value is
323 * 0 or -1, you will never get a notification event at all. Similarly, if the
324 * sound is stopped or interrupted, or if the channel is destroyed while the
325 * sound is playing, there will be no notification event.
327 * Not all libraries support sound notification. You should test the
328 * %gestalt_SoundNotify selector before you rely on it; see <link
329 * linkend="chimara-Testing-for-Sound-Capabilities">Testing for Sound
330 * Capabilities</link>.
332 * Returns: 1 on success, 0 on failure.
335 glk_schannel_play_ext(schanid_t chan, glui32 snd, glui32 repeats, glui32 notify)
337 VALID_SCHANNEL(chan, return 0);
338 #ifdef GSTREAMER_SOUND
339 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
341 if(!glk_data->resource_map) {
342 if(!glk_data->resource_load_callback) {
343 WARNING(_("No resource map has been loaded yet."));
346 WARNING(_("Loading sound resources from alternative location not yet supported."));
350 giblorb_result_t resource;
351 giblorb_err_t result = giblorb_load_resource(glk_data->resource_map, giblorb_method_Memory, &resource, giblorb_ID_Snd, snd);
352 if(result != giblorb_err_None) {
353 WARNING_S( _("Error loading resource"), giblorb_get_error_message(result) );
356 g_printerr("playing sound resource %d on channel %p\n", snd, chan);
357 GInputStream *stream = g_memory_input_stream_new_from_data(resource.data.ptr, resource.length, NULL);
358 g_object_set(chan->source, "stream", stream, NULL);
360 if(!gst_element_set_state(chan->pipeline, GST_STATE_PLAYING)) {
361 WARNING_S(_("Could not set GstElement state to"), "PLAYING");
372 * @chan: Channel to silence.
374 * Stops any sound playing in the channel. No notification event is generated,
375 * even if you requested one. If no sound is playing, this has no effect.
378 glk_schannel_stop(schanid_t chan)
380 VALID_SCHANNEL(chan, return);
381 #ifdef GSTREAMER_SOUND
382 if(!gst_element_set_state(chan->pipeline, GST_STATE_READY))
383 WARNING_S(_("Could not set GstElement state to"), "READY");
388 * glk_schannel_set_volume:
389 * @chan: Channel to set the volume of.
390 * @vol: Integer representing the volume; 0x10000 is 100%.
392 * Sets the volume in the channel. When you create a channel, it has full
393 * volume, represented by the value 0x10000. Half volume would be 0x8000,
394 * three-quarters volume would be 0xC000, and so on. A volume of zero represents
395 * silence, although the sound is still considered to be playing.
397 * You can call this function between sounds, or while a sound is playing. The
398 * effect is immediate.
400 * You can overdrive the volume of a channel by setting a volume greater than
401 * 0x10000. However, this is not recommended; the library may be unable to
402 * increase the volume past full, or the sound may become distorted. You should
403 * always create sound resources with the maximum volume you will need, and then
404 * call glk_schannel_set_volume() to reduce the volume when appropriate.
406 * Not all libraries support this function. You should test the
407 * %gestalt_SoundVolume selector before you rely on it; see <link
408 * linkend="chimara-Testing-for-Sound-Capabilities">Testing for Sound
409 * Capabilities</link>.
411 * <note><title>Chimara</title>
412 * <para>Chimara supports volumes from 0 to 1000%, that is, values of
413 * @vol up to 0xA0000.</para>
417 glk_schannel_set_volume(schanid_t chan, glui32 vol)
419 VALID_SCHANNEL(chan, return);
420 #ifdef GSTREAMER_SOUND
421 gdouble volume_gst = (gdouble)vol / 0x10000;
422 g_printerr("Volume set to: %f\n", volume_gst);
423 g_object_set(chan->filter, "volume", CLAMP(volume_gst, 0.0, 10.0), NULL);
428 * glk_sound_load_hint:
429 * @snd: Resource number of a sound.
430 * @flag: Nonzero to tell the library to load the sound, zero to tell the
431 * library to unload it.
433 * This gives the library a hint about whether the given sound should be loaded
434 * or not. If the @flag is nonzero, the library may preload the sound or do
435 * other initialization, so that glk_schannel_play() will be faster. If the
436 * @flag is zero, the library may release memory or other resources associated
437 * with the sound. Calling this function is always optional, and it has no
438 * effect on what the library actually plays.
440 * <warning><para>This function is not implemented yet.</para></warning>
443 glk_sound_load_hint(glui32 snd, glui32 flag)