#include <config.h>
#include <glib.h>
-#include <glib/gi18n.h>
+#include <glib/gi18n-lib.h>
#include <libchimara/glk.h>
#ifdef GSTREAMER_SOUND
#include <gst/gst.h>
#include "gi_dispa.h"
#include "gi_blorb.h"
#include "resource.h"
+#include "event.h"
extern GPrivate *glk_data_key;
#ifdef GSTREAMER_SOUND
+/* Stop any currently playing sound on this channel, and remove any
+ format-specific GStreamer elements from the channel. */
+static void
+clean_up_after_playing_sound(schanid_t chan)
+{
+ if(!gst_element_set_state(chan->pipeline, GST_STATE_NULL))
+ WARNING_S(_("Could not set GstElement state to"), "NULL");
+ if(chan->demux)
+ {
+ gst_bin_remove(GST_BIN(chan->pipeline), chan->demux);
+ chan->demux = NULL;
+ }
+ if(chan->decode)
+ {
+ gst_bin_remove(GST_BIN(chan->pipeline), chan->decode);
+ chan->decode = NULL;
+ }
+}
+
+/* This signal is thrown whenever the GStreamer pipeline generates a message.
+ Most messages are harmless. */
static void
on_pipeline_message(GstBus *bus, GstMessage *message, schanid_t s)
{
- g_print("Got %s message\n", GST_MESSAGE_TYPE_NAME(message));
+ /* g_printerr("Got %s message\n", GST_MESSAGE_TYPE_NAME(message)); */
+ GError *err;
+ gchar *debug_message;
+
switch(GST_MESSAGE_TYPE(message)) {
case GST_MESSAGE_ERROR:
{
- GError *err;
- gchar *debug;
-
- gst_message_parse_error(message, &err, &debug);
- g_print("Error: %s\n", err->message);
+ gst_message_parse_error(message, &err, &debug_message);
+ IO_WARNING(_("GStreamer error"), err->message, debug_message);
g_error_free(err);
- g_free(debug);
+ g_free(debug_message);
+ clean_up_after_playing_sound(s);
}
break;
- case GST_MESSAGE_STATE_CHANGED:
+ case GST_MESSAGE_WARNING:
{
- GstState old_state, new_state;
- gst_message_parse_state_changed(message, &old_state, &new_state, NULL);
- g_print("Element %s changed state from %s to %s.\n",
- GST_OBJECT_NAME(message->src),
- gst_element_state_get_name(old_state),
- gst_element_state_get_name(new_state));
+ gst_message_parse_warning(message, &err, &debug_message);
+ IO_WARNING(_("GStreamer warning"), err->message, debug_message);
+ g_error_free(err);
+ g_free(debug_message);
}
break;
- case GST_MESSAGE_EOS:
- /* end-of-stream */
- if(!gst_element_set_state(s->pipeline, GST_STATE_READY))
- WARNING_S(_("Could not set GstElement state to"), "READY");
+ case GST_MESSAGE_INFO:
+ {
+ gst_message_parse_info(message, &err, &debug_message);
+ g_message("GStreamer info \"%s\": %s", err->message, debug_message);
+ g_error_free(err);
+ g_free(debug_message);
+ }
+ break;
+ case GST_MESSAGE_EOS: /* End of stream */
+ /* Decrease repeats if not set to forever */
+ if(s->repeats != (glui32)-1)
+ s->repeats--;
+ if(s->repeats > 0) {
+ if(!gst_element_seek_simple(s->pipeline, GST_FORMAT_TIME, GST_SEEK_FLAG_FLUSH | GST_SEEK_FLAG_KEY_UNIT, 0)) {
+ WARNING(_("Could not execute GStreamer seek"));
+ clean_up_after_playing_sound(s);
+ }
+ } else {
+ clean_up_after_playing_sound(s);
+ /* Sound ended normally, send a notification if requested */
+ if(s->notify)
+ event_throw(s->glk, evtype_SoundNotify, NULL, s->resource, s->notify);
+ }
break;
default:
/* unhandled message */
}
}
+/* This signal is thrown when the OGG demuxer element has decided what kind of
+ outputs it will output. We connect the decoder element dynamically. */
static void
on_ogg_demuxer_pad_added(GstElement *demux, GstPad *pad, schanid_t s)
{
GstPad *sinkpad;
-
+
/* We can now link this pad with the vorbis-decoder sink pad */
sinkpad = gst_element_get_static_pad(s->decode, "sink");
- gst_pad_link(pad, sinkpad);
+ if(gst_pad_link(pad, sinkpad) != GST_PAD_LINK_OK)
+ WARNING(_("Could not link OGG demuxer with Vorbis decoder"));
gst_object_unref(sinkpad);
}
+/* This signal is thrown when the typefinder element has found the type of its
+ input. Now that we know what kind of input stream we have, we can connect the
+ proper demuxer/decoder elements. */
static void
on_type_found(GstElement *typefind, guint probability, GstCaps *caps, schanid_t s)
{
gchar *type = gst_caps_to_string(caps);
- if(strcmp(type, "application/ogg") == 0)
- {
+ if(strcmp(type, "application/ogg") == 0) {
s->demux = gst_element_factory_make("oggdemux", NULL);
s->decode = gst_element_factory_make("vorbisdec", NULL);
- if(!s->demux || !s->decode)
- {
+ if(!s->demux || !s->decode) {
WARNING(_("Could not create one or more GStreamer elements"));
goto finally;
}
gst_bin_add_many(GST_BIN(s->pipeline), s->demux, s->decode, NULL);
- if(!gst_element_link(s->typefind, s->demux) || !gst_element_link(s->decode, s->convert))
- {
+ if(!gst_element_link(s->typefind, s->demux) || !gst_element_link(s->decode, s->convert)) {
WARNING(_("Could not link GStreamer elements"));
goto finally;
}
demuxer doesn't know what source pads it will have until it starts
demuxing the stream */
g_signal_connect(s->demux, "pad-added", G_CALLBACK(on_ogg_demuxer_pad_added), s);
- }
- else if(strcmp(type, "audio/x-aiff") == 0)
- {
+ } else if(strcmp(type, "audio/x-aiff") == 0) {
s->decode = gst_element_factory_make("aiffparse", NULL);
- if(!s->decode)
- {
+ if(!s->decode) {
WARNING(_("Could not create 'aiffparse' GStreamer element"));
goto finally;
}
gst_bin_add(GST_BIN(s->pipeline), s->decode);
- if(!gst_element_link_many(s->typefind, s->decode, s->convert, NULL))
- {
+ if(!gst_element_link_many(s->typefind, s->decode, s->convert, NULL)) {
WARNING(_("Could not link GStreamer elements"));
goto finally;
}
- }
- else
- {
- WARNING("Can't play that type, you FOOL!");
+ } else if(strcmp(type, "audio/x-mod") == 0) {
+ s->decode = gst_element_factory_make("modplug", NULL);
+ if(!s->decode) {
+ WARNING(_("Could not create 'modplug' GStreamer element"));
+ goto finally;
+ }
+ gst_bin_add(GST_BIN(s->pipeline), s->decode);
+ if(!gst_element_link_many(s->typefind, s->decode, s->convert, NULL)) {
+ WARNING(_("Could not link GStreamer elements"));
+ goto finally;
+ }
+ } else {
+ WARNING_S(_("Unexpected audio type in blorb"), type);
}
finally:
*/
schanid_t
glk_schannel_create(glui32 rock)
+{
+ return glk_schannel_create_ext(rock, 0x10000);
+}
+
+/**
+ * glk_schannel_create_ext:
+ * @rock: The rock value to give the new sound channel.
+ * @volume: Integer representing the volume; 0x10000 is 100%.
+ *
+ * [DRAFT SPEC]
+ *
+ * The glk_schannel_create_ext() call lets you create a channel with the volume
+ * already set at a given level.
+ *
+ * Returns: A new sound channel, or %NULL.
+ */
+schanid_t
+glk_schannel_create_ext(glui32 rock, glui32 volume)
{
#ifdef GSTREAMER_SOUND
ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
glk_data->schannel_list = g_list_prepend(glk_data->schannel_list, s);
s->schannel_list = glk_data->schannel_list;
+ /* Add a pointer to the ChimaraGlk widget, for convenience */
+ s->glk = glk_data->self;
+
/* Create a GStreamer pipeline for the sound channel */
gchar *pipeline_name = g_strdup_printf("pipeline-%p", s);
s->pipeline = gst_pipeline_new(pipeline_name);
WARNING(_("Could not create one or more GStreamer elements"));
goto fail;
}
-
+
+ /* Set the initial volume */
+ glk_schannel_set_volume(s, volume);
+
+ /* Put the elements in the pipeline and link as many together as we can
+ without knowing the type of the audio stream */
gst_bin_add_many(GST_BIN(s->pipeline), s->source, s->typefind, s->convert, s->filter, s->sink, NULL);
/* Link elements: Source -> typefinder -> ??? -> Converter -> Volume filter -> Sink */
if(!gst_element_link(s->source, s->typefind) || !gst_element_link_many(s->convert, s->filter, s->sink, NULL)) {
(*glk_data->unregister_obj)(chan, gidisp_Class_Schannel, chan->disprock);
chan->disprock.ptr = NULL;
}
-
+
+ /* This also frees all the objects inside the pipeline */
if(chan->pipeline)
gst_object_unref(chan->pipeline);
glk_schannel_play_ext(schanid_t chan, glui32 snd, glui32 repeats, glui32 notify)
{
VALID_SCHANNEL(chan, return 0);
+ g_printerr("Play sound %d with repeats %d and notify %d\n", snd, repeats, notify);
#ifdef GSTREAMER_SOUND
ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
-
+ GInputStream *stream;
+
+ /* Stop the previous sound */
+ clean_up_after_playing_sound(chan);
+
+ /* Don't play if repeats = 0 */
+ if(repeats == 0) {
+ chan->repeats = 0;
+ return 1;
+ }
+
+ /* Load the sound into a GInputStream, by whatever method */
if(!glk_data->resource_map) {
if(!glk_data->resource_load_callback) {
WARNING(_("No resource map has been loaded yet."));
return 0;
}
- WARNING(_("Loading sound resources from alternative location not yet supported."));
- return 0;
- }
-
- giblorb_result_t resource;
- giblorb_err_t result = giblorb_load_resource(glk_data->resource_map, giblorb_method_Memory, &resource, giblorb_ID_Snd, snd);
- if(result != giblorb_err_None) {
- WARNING_S( _("Error loading resource"), giblorb_get_error_message(result) );
- return 0;
+ gchar *filename = glk_data->resource_load_callback(CHIMARA_RESOURCE_SOUND, snd, glk_data->resource_load_callback_data);
+ if(!filename) {
+ WARNING(_("Error loading resource from alternative location."));
+ return 0;
+ }
+
+ GError *err = NULL;
+ GFile *file = g_file_new_for_path(filename);
+ stream = G_INPUT_STREAM(g_file_read(file, NULL, &err));
+ if(!stream) {
+ IO_WARNING(_("Error loading resource from file"), filename, err->message);
+ g_free(filename);
+ g_object_unref(file);
+ return 0;
+ }
+ g_free(filename);
+ g_object_unref(file);
+ } else {
+ giblorb_result_t resource;
+ giblorb_err_t result = giblorb_load_resource(glk_data->resource_map, giblorb_method_Memory, &resource, giblorb_ID_Snd, snd);
+ if(result != giblorb_err_None) {
+ WARNING_S( _("Error loading resource"), giblorb_get_error_message(result) );
+ return 0;
+ }
+ stream = g_memory_input_stream_new_from_data(resource.data.ptr, resource.length, NULL);
}
- g_printerr("playing sound resource %d on channel %p\n", snd, chan);
- GInputStream *stream = g_memory_input_stream_new_from_data(resource.data.ptr, resource.length, NULL);
+
+ chan->repeats = repeats;
+ chan->resource = snd;
+ chan->notify = notify;
g_object_set(chan->source, "stream", stream, NULL);
+ g_object_unref(stream); /* Now owned by GStreamer element */
- if(!gst_element_set_state(chan->pipeline, GST_STATE_PLAYING)) {
- WARNING_S(_("Could not set GstElement state to"), "PLAYING");
+ /* Play the sound; unless the channel is paused, then pause it instead */
+ if(!gst_element_set_state(chan->pipeline, chan->paused? GST_STATE_PAUSED : GST_STATE_PLAYING)) {
+ WARNING_S(_("Could not set GstElement state to"), chan->paused? "PAUSED" : "PLAYING");
return 0;
}
return 1;
#endif
}
+/**
+ * glk_schannel_play_multi:
+ * @chanarray:
+ * @chancount:
+ * @sndarray:
+ * @soundcount:
+ * @notify:
+ *
+ * [DRAFT SPEC]
+ *
+ * This works the same as glk_schannel_play_ext(), except that you can specify
+ * more than one sound. The channel references and sound resource numbers are
+ * given as two arrays, which must be the same length. The @notify argument
+ * applies to all the sounds; the repeats value for all the sounds is 1.
+ *
+ * All the sounds will begin at exactly the same time.
+ *
+ * This returns the number of sounds that began playing correctly. (This will be
+ * a number from 0 to @soundcount.)
+ *
+ * <note><para>
+ * Note that you have to supply @chancount and @soundcount as separate
+ * arguments, even though they are required to be the same. This is an awkward
+ * consequence of the way array arguments are dispatched in Glulx.
+ * </para></note>
+ *
+ * Returns: The number of sounds that started playing correctly.
+ */
+glui32
+glk_schannel_play_multi(schanid_t *chanarray, glui32 chancount, glui32 *sndarray, glui32 soundcount, glui32 notify)
+{
+ g_return_val_if_fail(chancount == soundcount, 0);
+ g_return_val_if_fail(chanarray == NULL && chancount != 0, 0);
+ g_return_val_if_fail(sndarray == NULL && soundcount != 0, 0);
+
+ int count;
+ for(count = 0; count < chancount; count++)
+ VALID_SCHANNEL(chanarray[count], return 0);
+
+ g_warning("Not implemented");
+ return 0;
+}
+
/**
* glk_schannel_stop:
* @chan: Channel to silence.
{
VALID_SCHANNEL(chan, return);
#ifdef GSTREAMER_SOUND
- if(!gst_element_set_state(chan->pipeline, GST_STATE_READY))
- WARNING_S(_("Could not set GstElement state to"), "READY");
+ clean_up_after_playing_sound(chan);
#endif
}
+/**
+ * glk_schannel_pause:
+ * @chan: Channel to pause.
+ *
+ * [DRAFT SPEC]
+ *
+ * Pause any sound playing in the channel. This does not generate any
+ * notification events. If the channel is already paused, this does nothing.
+ *
+ * New sounds started in a paused channel are paused immediately.
+ *
+ * A volume change in progress is <emphasis>not</emphasis> paused, and may
+ * proceed to completion, generating a notification if appropriate.
+ */
+void
+glk_schannel_pause(schanid_t chan)
+{
+ VALID_SCHANNEL(chan, return);
+
+ if(chan->paused)
+ return; /* Silently do nothing */
+
+ /* Mark the channel as paused even if there is no sound playing yet */
+ chan->paused = TRUE;
+
+ GstState state;
+ if(gst_element_get_state(chan->pipeline, &state, NULL, GST_CLOCK_TIME_NONE) != GST_STATE_CHANGE_SUCCESS) {
+ WARNING(_("Could not get GstElement state"));
+ return;
+ }
+ if(state != GST_STATE_PLAYING)
+ return; /* Silently do nothing if no sound is playing */
+
+ if(!gst_element_set_state(chan->pipeline, GST_STATE_PAUSED)) {
+ WARNING_S(_("Could not set GstElement state to"), "PAUSED");
+ return;
+ }
+}
+
+/**
+ * glk_schannel_unpause:
+ * @chan: Channel to unpause.
+ *
+ * [DRAFT SPEC]
+ *
+ * Unpause the channel. Any paused sounds begin playing where they left off. If
+ * the channel is not already paused, this does nothing.
+ */
+void
+glk_schannel_unpause(schanid_t chan)
+{
+ VALID_SCHANNEL(chan, return);
+
+ if(!chan->paused)
+ return; /* Silently do nothing */
+
+ /* Mark the channel as not paused in any case */
+ chan->paused = FALSE;
+
+ GstState state;
+ if(gst_element_get_state(chan->pipeline, &state, NULL, GST_CLOCK_TIME_NONE) != GST_STATE_CHANGE_SUCCESS) {
+ WARNING(_("Could not get GstElement state"));
+ return;
+ }
+ if(state != GST_STATE_PAUSED)
+ return; /* Silently do nothing */
+
+ if(!gst_element_set_state(chan->pipeline, GST_STATE_PLAYING)) {
+ WARNING_S(_("Could not set GstElement state to"), "PLAYING");
+ return;
+ }
+}
+
/**
* glk_schannel_set_volume:
* @chan: Channel to set the volume of.
*/
void
glk_schannel_set_volume(schanid_t chan, glui32 vol)
+{
+ glk_schannel_set_volume_ext(chan, vol, 0, 0);
+}
+
+/**
+ * glk_schannel_set_volume_ext:
+ * @chan: Channel to set the volume of.
+ * @vol: Integer representing the volume; 0x10000 is 100%.
+ * @duration: Length of volume change in milliseconds, or 0 for immediate.
+ * @notify: If nonzero, requests a notification when the volume change finishes.
+ *
+ * [DRAFT SPEC]
+ *
+ * Sets the volume in the channel, from 0 (silence) to 0x10000 (full volume).
+ * Again, you can overdrive the volume by setting a value greater than 0x10000,
+ * but this is not recommended.
+ *
+ * If the @duration is zero, the change is immediate. Otherwise, the change
+ * begins immediately, and occurs smoothly over the next @duration milliseconds.
+ *
+ * The @notify value should be nonzero in order to request a volume notification
+ * event. If you do this, when the volume change is completed, you will get an
+ * event with type #evtype_VolumeNotify. The window will be %NULL, @val1 will be
+ * zero, and @val2 will be the nonzero value you passed as @notify.
+ *
+ * The glk_schannel_set_volume() does not include @duration and @notify values.
+ * Both are assumed to be zero: immediate change, no notification.
+ *
+ * You can call these functions between sounds, or while a sound is playing.
+ * However, a zero-duration change while a sound is playing may produce
+ * unpleasant clicks.
+ *
+ * At most one volume change can be occurring on a sound channel at any time. If
+ * you call one of these functions while a previous volume change is in
+ * progress, the previous change is interrupted. The beginning point of the new
+ * volume change should be wherever the previous volume change was interrupted
+ * (rather than the previous change's beginning or ending point).
+ *
+ * Not all libraries support these functions. You should test the appropriate
+ * gestalt selectors before you rely on them; see "Testing for Sound
+ * Capabilities".
+ */
+void
+glk_schannel_set_volume_ext(schanid_t chan, glui32 vol, glui32 duration, glui32 notify)
{
VALID_SCHANNEL(chan, return);
+ /* Silently ignore out-of-range volume values */
+
#ifdef GSTREAMER_SOUND
gdouble volume_gst = (gdouble)vol / 0x10000;
- g_printerr("Volume set to: %f\n", volume_gst);
g_object_set(chan->filter, "volume", CLAMP(volume_gst, 0.0, 10.0), NULL);
#endif
+
+ /* Not implemented */
}
/**
* @flag is zero, the library may release memory or other resources associated
* with the sound. Calling this function is always optional, and it has no
* effect on what the library actually plays.
- *
- * <warning><para>This function is not implemented yet.</para></warning>
*/
void
glk_sound_load_hint(glui32 snd, glui32 flag)
{
+#ifdef GSTREAMER_SOUND
+ ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
+ giblorb_result_t resource;
+ giblorb_err_t result;
+
+ /* Sound load hints only work for Blorb resource maps */
+ if(!glk_data->resource_map)
+ return;
+
+ if(flag) {
+ /* The sound load hint simply loads the resource from the resource map;
+ loading a chunk more than once does nothing */
+ result = giblorb_load_resource(glk_data->resource_map, giblorb_method_Memory, &resource, giblorb_ID_Snd, snd);
+ if(result != giblorb_err_None) {
+ WARNING_S( _("Error loading resource"), giblorb_get_error_message(result) );
+ return;
+ }
+ } else {
+ /* Get the Blorb chunk number by loading the resource with
+ method_DontLoad, then unload that chunk - has no effect if the chunk
+ isn't loaded */
+ result = giblorb_load_resource(glk_data->resource_map, giblorb_method_DontLoad, &resource, giblorb_ID_Snd, snd);
+ if(result != giblorb_err_None) {
+ WARNING_S( _("Error loading resource"), giblorb_get_error_message(result) );
+ return;
+ }
+ result = giblorb_unload_chunk(glk_data->resource_map, resource.chunknum);
+ if(result != giblorb_err_None) {
+ WARNING_S( _("Error unloading chunk"), giblorb_get_error_message(result) );
+ return;
+ }
+ }
+#endif /* GSTREAMER_SOUND */
}
projects / projects / chimara / chimara.git / blobdiff