libchimara/schannel.c

   1 #include <config.h>
   2 #include <glib.h>
   3 #include <libchimara/glk.h>
   4 #ifdef GSTREAMER_SOUND
   5 #include <gst/gst.h>
   6 #endif
   7 #include "magic.h"
   8 #include "schannel.h"
   9 #include "chimara-glk-private.h"
  10 #include "gi_dispa.h"
  11
  12 extern GPrivate *glk_data_key;
  13
  14 /**
  15  * glk_schannel_create:
  16  * @rock: The rock value to give the new sound channel.
  17  *
  18  * This creates a sound channel, about as you'd expect.
  19  *
  20  * Remember that it is possible that the library will be unable to create a new
  21  * channel, in which case glk_schannel_create() will return %NULL.
  22  *
  23  * Returns: A new sound channel, or %NULL.
  24  */
  25 schanid_t
  26 glk_schannel_create(glui32 rock)
  27 {
  28 #ifdef GSTREAMER_SOUND
  29         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
  30
  31         schanid_t s = g_new0(struct glk_schannel_struct, 1);
  32         s->magic = MAGIC_SCHANNEL;
  33         s->rock = rock;
  34         if(glk_data->register_obj)
  35                 s->disprock = (*glk_data->register_obj)(s, gidisp_Class_Schannel);
  36
  37         /* Add it to the global sound channel list */
  38         glk_data->schannel_list = g_list_prepend(glk_data->schannel_list, s);
  39         s->schannel_list = glk_data->schannel_list;
  40
  41         /* Create a GStreamer pipeline for the sound channel */
  42         gchar *pipeline_name = g_strdup_printf("pipeline-%p", s);
  43         s->pipeline = gst_pipeline_new(pipeline_name);
  44         g_free(pipeline_name);
  45
  46         /* Create GStreamer elements to put in the pipeline */
  47         s->source = gst_element_factory_make("fakesrc", NULL);
  48         s->filter = gst_element_factory_make("identity", NULL);
  49         s->sink = gst_element_factory_make("fakesink", NULL);
  50         gst_bin_add_many(GST_BIN(s->pipeline), s->source, s->filter, s->sink, NULL);
  51         if(!gst_element_link_many(s->source, s->filter, s->sink, NULL))
  52                 goto fail;
  53
  54         return s;
  55
  56 fail:
  57         glk_schannel_destroy(s);
  58         return NULL;
  59 #else
  60         return NULL;
  61 #endif /* GSTREAMER_SOUND */
  62 }
  63
  64 /**
  65  * glk_schannel_destroy:
  66  * @chan: The sound channel to destroy.
  67  *
  68  * Destroys the channel. If the channel is playing a sound, the sound stops
  69  * immediately (with no notification event).
  70  */
  71 void
  72 glk_schannel_destroy(schanid_t chan)
  73 {
  74         VALID_SCHANNEL(chan, return);
  75
  76         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
  77
  78         glk_data->schannel_list = g_list_delete_link(glk_data->schannel_list, chan->schannel_list);
  79
  80         if(glk_data->unregister_obj)
  81         {
  82                 (*glk_data->unregister_obj)(chan, gidisp_Class_Schannel, chan->disprock);
  83                 chan->disprock.ptr = NULL;
  84         }
  85
  86         if(chan->pipeline)
  87                 g_object_unref(chan->pipeline);
  88
  89         chan->magic = MAGIC_FREE;
  90         g_free(chan);
  91 }
  92
  93 /**
  94  * glk_schannel_iterate:
  95  * @chan: A sound channel, or %NULL.
  96  * @rockptr: Return location for the next sound channel's rock, or %NULL.
  97  *
  98  * This function can be used to iterate through the list of all open channels.
  99  * See <link linkend="chimara-Iterating-Through-Opaque-Objects">Iterating
 100  * Through Opaque Objects</link>.
 101  *
 102  * As that section describes, the order in which channels are returned is
 103  * arbitrary.
 104  *
 105  * Returns: the next sound channel, or %NULL if there are no more.
 106  */
 107 schanid_t
 108 glk_schannel_iterate(schanid_t chan, glui32 *rockptr)
 109 {
 110         VALID_SCHANNEL_OR_NULL(chan, return NULL);
 111
 112         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 113         GList *retnode;
 114
 115         if(chan == NULL)
 116                 retnode = glk_data->schannel_list;
 117         else
 118                 retnode = chan->schannel_list->next;
 119         schanid_t retval = retnode? (schanid_t)retnode->data : NULL;
 120
 121         /* Store the sound channel's rock in rockptr */
 122         if(retval && rockptr)
 123                 *rockptr = glk_schannel_get_rock(retval);
 124
 125         return retval;
 126 }
 127
 128 /**
 129  * glk_schannel_get_rock:
 130  * @chan: A sound channel.
 131  *
 132  * Retrieves the channel's rock value. See <link
 133  * linkend="chimara-Rocks">Rocks</link>.
 134  *
 135  * Returns: A rock value.
 136  */
 137 glui32
 138 glk_schannel_get_rock(schanid_t chan)
 139 {
 140         VALID_SCHANNEL(chan, return 0);
 141         return chan->rock;
 142 }
 143
 144 /**
 145  * glk_schannel_play:
 146  * @chan: Channel to play the sound in.
 147  * @snd: Resource number of the sound to play.
 148  *
 149  * Begins playing the given sound on the channel. If the channel was already
 150  * playing a sound (even the same one), the old sound is stopped (with no
 151  * notification event.
 152  *
 153  * This returns 1 if the sound actually started playing, and 0 if there was any
 154  * problem.
 155  * <note><para>
 156  *   The most obvious problem is if there is no sound resource with the given
 157  *   identifier. But other problems can occur. For example, the MOD-playing
 158  *   facility in a library might be unable to handle two MODs at the same time,
 159  *   in which case playing a MOD resource would fail if one was already playing.
 160  * </para></note>
 161  *
 162  * <warning><para>This function is not implemented yet.</para></warning>
 163  *
 164  * Returns: 1 on success, 0 on failure.
 165  */
 166 glui32
 167 glk_schannel_play(schanid_t chan, glui32 snd)
 168 {
 169         VALID_SCHANNEL(chan, return 0);
 170         return 0;
 171 }
 172
 173 /**
 174  * glk_schannel_play_ext:
 175  * @chan: Channel to play the sound in.
 176  * @snd: Resource number of the sound to play.
 177  * @repeats: Number of times to repeat the sound.
 178  * @notify: If nonzero, requests a notification when the sound is finished.
 179  *
 180  * This works the same as glk_schannel_play(), but lets you specify additional
 181  * options. <code>glk_schannel_play(chan, snd)</code> is exactly equivalent to
 182  * <code>glk_schannel_play_ext(chan, snd, 1, 0)</code>.
 183  *
 184  * The @repeats value is the number of times the sound should be repeated. A
 185  * repeat value of -1 (or rather 0xFFFFFFFF) means that the sound should repeat
 186  * forever. A repeat value of 0 means that the sound will not be played at all;
 187  * nothing happens. (Although a previous sound on the channel will be stopped,
 188  * and the function will return 1.)
 189  *
 190  * The @notify value should be nonzero in order to request a sound notification
 191  * event. If you do this, when the sound is completed, you will get an event
 192  * with type %evtype_SoundNotify. The @window will be %NULL, @val1 will be the
 193  * sound's resource id, and @val2 will be the nonzero value you passed as
 194  * @notify.
 195  *
 196  * If you request sound notification, and the repeat value is greater than one,
 197  * you will get the event only after the last repetition. If the repeat value is
 198  * 0 or -1, you will never get a notification event at all. Similarly, if the
 199  * sound is stopped or interrupted, or if the channel is destroyed while the
 200  * sound is playing, there will be no notification event.
 201  *
 202  * Not all libraries support sound notification. You should test the
 203  * %gestalt_SoundNotify selector before you rely on it; see <link
 204  * linkend="chimara-Testing-for-Sound-Capabilities">Testing for Sound
 205  * Capabilities</link>.
 206  *
 207  * <warning><para>This function is not implemented yet.</para></warning>
 208  *
 209  * Returns: 1 on success, 0 on failure.
 210  */
 211 glui32
 212 glk_schannel_play_ext(schanid_t chan, glui32 snd, glui32 repeats, glui32 notify)
 213 {
 214         VALID_SCHANNEL(chan, return 0);
 215         return 0;
 216 }
 217
 218 /**
 219  * glk_schannel_stop:
 220  * @chan: Channel to silence.
 221  *
 222  * Stops any sound playing in the channel. No notification event is generated,
 223  * even if you requested one. If no sound is playing, this has no effect.
 224  *
 225  * <warning><para>This function is not implemented yet.</para></warning>
 226  */
 227 void
 228 glk_schannel_stop(schanid_t chan)
 229 {
 230         VALID_SCHANNEL(chan, return);
 231 }
 232
 233 /**
 234  * glk_schannel_set_volume:
 235  * @chan: Channel to set the volume of.
 236  * @vol: Integer representing the volume; 0x10000 is 100&percnt;.
 237  *
 238  * Sets the volume in the channel. When you create a channel, it has full
 239  * volume, represented by the value 0x10000. Half volume would be 0x8000,
 240  * three-quarters volume would be 0xC000, and so on. A volume of zero represents
 241  * silence, although the sound is still considered to be playing.
 242  *
 243  * You can call this function between sounds, or while a sound is playing. The
 244  * effect is immediate.
 245  *
 246  * You can overdrive the volume of a channel by setting a volume greater than
 247  * 0x10000. However, this is not recommended; the library may be unable to
 248  * increase the volume past full, or the sound may become distorted. You should
 249  * always create sound resources with the maximum volume you will need, and then
 250  * call glk_schannel_set_volume() to reduce the volume when appropriate.
 251  *
 252  * Not all libraries support this function. You should test the
 253  * %gestalt_SoundVolume selector before you rely on it; see <link
 254  * linkend="chimara-Testing-for-Sound-Capabilities">Testing for Sound
 255  * Capabilities</link>.
 256  *
 257  * <warning><para>This function is not implemented yet.</para></warning>
 258  */
 259 void
 260 glk_schannel_set_volume(schanid_t chan, glui32 vol)
 261 {
 262         VALID_SCHANNEL(chan, return);
 263 }
 264
 265 /**
 266  * glk_sound_load_hint:
 267  * @snd: Resource number of a sound.
 268  * @flag: Nonzero to tell the library to load the sound, zero to tell the
 269  * library to unload it.
 270  *
 271  * This gives the library a hint about whether the given sound should be loaded
 272  * or not. If the @flag is nonzero, the library may preload the sound or do
 273  * other initialization, so that glk_schannel_play() will be faster. If the
 274  * @flag is zero, the library may release memory or other resources associated
 275  * with the sound. Calling this function is always optional, and it has no
 276  * effect on what the library actually plays.
 277  *
 278  * <warning><para>This function is not implemented yet.</para></warning>
 279  */
 280 void
 281 glk_sound_load_hint(glui32 snd, glui32 flag)
 282 {
 283 }