ext/mikmod/gstmikmod.c

   1 /* GStreamer
   2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #include "config.h"
  22 #endif
  23 #include "gstmikmod.h"
  24
  25 #include <stdlib.h>
  26
  27 /* Filter signals and args */
  28 enum
  29 {
  30   /* FILL ME */
  31   LAST_SIGNAL
  32 };
  33
  34 enum
  35 {
  36   ARG_0,
  37   ARG_SONGNAME,
  38   ARG_MODTYPE,
  39   ARG_MUSICVOLUME,
  40   ARG_PANSEP,
  41   ARG_REVERB,
  42   ARG_SNDFXVOLUME,
  43   ARG_VOLUME,
  44   ARG_INTERP,
  45   ARG_REVERSE,
  46   ARG_SURROUND,
  47   ARG_HQMIXER,
  48   ARG_SOFT_MUSIC,
  49   ARG_SOFT_SNDFX
  50 };
  51
  52 MODULE *module;
  53 MREADER *reader;
  54 GstPad *srcpad;
  55 GstClockTime timestamp;
  56 int need_sync;
  57
  58 static GstStaticPadTemplate mikmod_src_factory = GST_STATIC_PAD_TEMPLATE ("src",
  59     GST_PAD_SRC,
  60     GST_PAD_ALWAYS,
  61     GST_STATIC_CAPS ("audio/x-raw-int, "
  62         "endianness = (int) BYTE_ORDER, "
  63         "signed = (boolean) TRUE, "
  64         "width = (int) 16, "
  65         "depth = (int) 16, "
  66         "rate = (int) { 8000, 11025, 22050, 44100 }, "
  67         "channels = (int) [ 1, 2 ]; "
  68         "audio/x-raw-int, "
  69         "endianness = (int) BYTE_ORDER, "
  70         "signed = (boolean) FALSE, "
  71         "width = (int) 8, "
  72         "depth = (int) 8, "
  73         "rate = (int) { 8000, 11025, 22050, 44100 }, "
  74         "channels = (int) [ 1, 2 ]")
  75     );
  76
  77 static GstStaticPadTemplate mikmod_sink_factory =
  78 GST_STATIC_PAD_TEMPLATE ("sink",
  79     GST_PAD_SINK,
  80     GST_PAD_ALWAYS,
  81     GST_STATIC_CAPS ("audio/x-mod")
  82     );
  83
  84 static void gst_mikmod_base_init (gpointer g_class);
  85 static void gst_mikmod_class_init (GstMikModClass * klass);
  86 static void gst_mikmod_init (GstMikMod * filter);
  87 static void gst_mikmod_set_property (GObject * object, guint id,
  88     const GValue * value, GParamSpec * pspec);
  89 static void gst_mikmod_get_property (GObject * object, guint id, GValue * value,
  90     GParamSpec * pspec);
  91 static GstPadLinkReturn gst_mikmod_srclink (GstPad * pad, const GstCaps * caps);
  92 static GstCaps *gst_mikmod_srcfixate (GstPad * pad, const GstCaps * caps);
  93 static void gst_mikmod_loop (GstElement * element);
  94 static gboolean gst_mikmod_setup (GstMikMod * mikmod);
  95 static GstStateChangeReturn gst_mikmod_change_state (GstElement * element,
  96     GstStateChange transition);
  97
  98
  99
 100 static GstElementClass *parent_class = NULL;
 101
 102 GType
 103 gst_mikmod_get_type (void)
 104 {
 105   static GType mikmod_type = 0;
 106
 107   if (!mikmod_type) {
 108     static const GTypeInfo mikmod_info = {
 109       sizeof (GstMikModClass),
 110       gst_mikmod_base_init,
 111       NULL,
 112       (GClassInitFunc) gst_mikmod_class_init,
 113       NULL,
 114       NULL,
 115       sizeof (GstMikMod),
 116       0,
 117       (GInstanceInitFunc) gst_mikmod_init,
 118     };
 119
 120     mikmod_type =
 121         g_type_register_static (GST_TYPE_ELEMENT, "GstMikmod", &mikmod_info, 0);
 122   }
 123   return mikmod_type;
 124 }
 125
 126 static void
 127 gst_mikmod_base_init (gpointer g_class)
 128 {
 129   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 130
 131   gst_element_class_add_static_pad_template (element_class,
 132       &mikmod_src_factory);
 133   gst_element_class_add_static_pad_template (element_class,
 134       &mikmod_sink_factory);
 135   gst_element_class_set_details_simple (element_class, "MikMod audio decoder",
 136       "Codec/Decoder/Audio",
 137       "Module decoder based on libmikmod", "Jeremy SIMON <jsimon13@yahoo.fr>");
 138 }
 139
 140 static void
 141 gst_mikmod_class_init (GstMikModClass * klass)
 142 {
 143   GObjectClass *gobject_class;
 144   GstElementClass *gstelement_class;
 145
 146   gobject_class = (GObjectClass *) klass;
 147   gstelement_class = (GstElementClass *) klass;
 148
 149   parent_class = g_type_class_peek_parent (klass);
 150
 151   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SONGNAME,
 152       g_param_spec_string ("songname", "songname", "songname",
 153           NULL, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 154   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MODTYPE,
 155       g_param_spec_string ("modtype", "modtype", "modtype",
 156           NULL, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 157   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MUSICVOLUME,
 158       g_param_spec_int ("musicvolume", "musivolume", "musicvolume",
 159           0, 128, 128, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 160   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_PANSEP,
 161       g_param_spec_int ("pansep", "pansep", "pansep",
 162           0, 128, 128, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 163   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_REVERB,
 164       g_param_spec_int ("reverb", "reverb", "reverb",
 165           0, 15, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 166   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SNDFXVOLUME,
 167       g_param_spec_int ("sndfxvolume", "sndfxvolume", "sndfxvolume",
 168           0, 128, 128, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 169   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_VOLUME,
 170       g_param_spec_int ("volume", "volume", "volume",
 171           0, 128, 96, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 172
 173   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_INTERP,
 174       g_param_spec_boolean ("interp", "interp", "interp",
 175           FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 176   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_REVERSE,
 177       g_param_spec_boolean ("reverse", "reverse", "reverse",
 178           FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 179   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SURROUND,
 180       g_param_spec_boolean ("surround", "surround", "surround",
 181           TRUE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 182   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_HQMIXER,
 183       g_param_spec_boolean ("hqmixer", "hqmixer", "hqmixer",
 184           FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 185   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SOFT_MUSIC,
 186       g_param_spec_boolean ("soft-music", "soft music", "soft music",
 187           TRUE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 188   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SOFT_SNDFX,
 189       g_param_spec_boolean ("soft-sndfx", "soft sndfx", "soft sndfx",
 190           TRUE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 191
 192
 193   gobject_class->set_property = gst_mikmod_set_property;
 194   gobject_class->get_property = gst_mikmod_get_property;
 195
 196   gstelement_class->change_state = gst_mikmod_change_state;
 197 }
 198
 199
 200 static void
 201 gst_mikmod_init (GstMikMod * filter)
 202 {
 203   filter->sinkpad =
 204       gst_pad_new_from_static_template (&mikmod_sink_factory, "sink");
 205   filter->srcpad =
 206       gst_pad_new_from_static_template (&mikmod_src_factory, "src");
 207
 208   gst_element_add_pad (GST_ELEMENT (filter), filter->sinkpad);
 209   gst_element_add_pad (GST_ELEMENT (filter), filter->srcpad);
 210   gst_pad_set_link_function (filter->srcpad, gst_mikmod_srclink);
 211   gst_pad_set_fixate_function (filter->srcpad, gst_mikmod_srcfixate);
 212
 213   gst_element_set_loop_function (GST_ELEMENT (filter), gst_mikmod_loop);
 214
 215   filter->Buffer = NULL;
 216
 217   filter->stereo = TRUE;
 218   filter->surround = TRUE;
 219   filter->_16bit = TRUE;
 220   filter->soft_music = TRUE;
 221   filter->soft_sndfx = TRUE;
 222   filter->mixfreq = 44100;
 223   filter->reverb = 0;
 224   filter->pansep = 128;
 225   filter->musicvolume = 128;
 226   filter->volume = 96;
 227   filter->sndfxvolume = 128;
 228   filter->songname = NULL;
 229   filter->modtype = NULL;
 230
 231   filter->initialized = FALSE;
 232 }
 233
 234 static GstCaps *
 235 gst_mikmod_srcfixate (GstPad * pad, const GstCaps * caps)
 236 {
 237   GstCaps *ret;
 238   GstStructure *structure;
 239
 240   /* FIXME: select est caps here */
 241   if (gst_caps_get_size (caps) > 1)
 242     return NULL;
 243
 244   ret = gst_caps_copy (caps);
 245   structure = gst_caps_get_structure (ret, 0);
 246
 247   if (gst_structure_fixate_field_nearest_int (structure, "channels", 2))
 248     return ret;
 249   if (gst_structure_fixate_field_nearest_int (structure, "rate", 44100))
 250     return ret;
 251
 252   gst_caps_free (ret);
 253   return NULL;
 254 }
 255
 256 static GstPadLinkReturn
 257 gst_mikmod_srclink (GstPad * pad, const GstCaps * caps)
 258 {
 259   GstMikMod *filter;
 260   GstStructure *structure;
 261   gint depth;
 262   gint channels;
 263   gboolean result;
 264
 265   filter = GST_MIKMOD (gst_pad_get_parent (pad));
 266
 267   structure = gst_caps_get_structure (caps, 0);
 268
 269   gst_structure_get_int (structure, "depth", &depth);
 270   filter->_16bit = (depth == 16);
 271   gst_structure_get_int (structure, "channels", &channels);
 272   filter->stereo = (channels == 2);
 273   gst_structure_get_int (structure, "rate", &filter->mixfreq);
 274
 275   result = gst_mikmod_setup (filter);
 276   gst_object_unref (filter);
 277
 278   if (result) {
 279     return GST_PAD_LINK_OK;
 280   } else {
 281     return GST_PAD_LINK_REFUSED;
 282   }
 283 }
 284
 285 static void
 286 gst_mikmod_loop (GstElement * element)
 287 {
 288   GstMikMod *mikmod;
 289   GstBuffer *buffer_in;
 290
 291   g_return_if_fail (element != NULL);
 292   g_return_if_fail (GST_IS_MIKMOD (element));
 293
 294   mikmod = GST_MIKMOD (element);
 295   srcpad = mikmod->srcpad;
 296   mikmod->Buffer = NULL;
 297
 298   if (!mikmod->initialized) {
 299     while ((buffer_in = GST_BUFFER (gst_pad_pull (mikmod->sinkpad)))) {
 300       if (GST_IS_EVENT (buffer_in)) {
 301         GstEvent *event = GST_EVENT (buffer_in);
 302
 303         if (GST_EVENT_TYPE (event) == GST_EVENT_EOS)
 304           break;
 305       } else {
 306         if (mikmod->Buffer) {
 307           GstBuffer *merge;
 308
 309           merge = gst_buffer_merge (mikmod->Buffer, buffer_in);
 310           gst_buffer_unref (buffer_in);
 311           gst_buffer_unref (mikmod->Buffer);
 312           mikmod->Buffer = merge;
 313         } else {
 314           mikmod->Buffer = buffer_in;
 315         }
 316       }
 317     }
 318
 319     if (!GST_PAD_CAPS (mikmod->srcpad)) {
 320       if (GST_PAD_LINK_SUCCESSFUL (gst_pad_renegotiate (mikmod->srcpad))) {
 321         GST_ELEMENT_ERROR (mikmod, CORE, NEGOTIATION, (NULL), (NULL));
 322         return;
 323       }
 324     }
 325
 326     MikMod_RegisterDriver (&drv_gst);
 327     MikMod_RegisterAllLoaders ();
 328
 329     MikMod_Init ("");
 330     reader = GST_READER_new (mikmod);
 331     module = Player_LoadGeneric (reader, 64, 0);
 332
 333     gst_buffer_unref (mikmod->Buffer);
 334
 335     if (!Player_Active ())
 336       Player_Start (module);
 337
 338     mikmod->initialized = TRUE;
 339   }
 340
 341   if (Player_Active ()) {
 342     timestamp = (module->sngtime / 1024.0) * GST_SECOND;
 343     drv_gst.Update ();
 344   } else {
 345     gst_element_set_eos (GST_ELEMENT (mikmod));
 346     gst_pad_push (mikmod->srcpad, GST_DATA (gst_event_new (GST_EVENT_EOS)));
 347   }
 348 }
 349
 350
 351 static gboolean
 352 gst_mikmod_setup (GstMikMod * mikmod)
 353 {
 354   md_musicvolume = mikmod->musicvolume;
 355   md_pansep = mikmod->pansep;
 356   md_reverb = mikmod->reverb;
 357   md_sndfxvolume = mikmod->sndfxvolume;
 358   md_volume = mikmod->volume;
 359   md_mixfreq = mikmod->mixfreq;
 360
 361   md_mode = 0;
 362
 363   if (mikmod->interp)
 364     md_mode = md_mode | DMODE_INTERP;
 365
 366   if (mikmod->reverse)
 367     md_mode = md_mode | DMODE_REVERSE;
 368
 369   if (mikmod->surround)
 370     md_mode = md_mode | DMODE_SURROUND;
 371
 372   if (mikmod->_16bit)
 373     md_mode = md_mode | DMODE_16BITS;
 374
 375   if (mikmod->hqmixer)
 376     md_mode = md_mode | DMODE_HQMIXER;
 377
 378   if (mikmod->soft_music)
 379     md_mode = md_mode | DMODE_SOFT_MUSIC;
 380
 381   if (mikmod->soft_sndfx)
 382     md_mode = md_mode | DMODE_SOFT_SNDFX;
 383
 384   if (mikmod->stereo)
 385     md_mode = md_mode | DMODE_STEREO;
 386
 387   return TRUE;
 388 }
 389
 390
 391 static GstStateChangeReturn
 392 gst_mikmod_change_state (GstElement * element, GstStateChange transition)
 393 {
 394   GstMikMod *mikmod;
 395
 396   g_return_val_if_fail (GST_IS_MIKMOD (element), GST_STATE_CHANGE_FAILURE);
 397
 398   mikmod = GST_MIKMOD (element);
 399
 400   GST_DEBUG ("state pending %d", GST_STATE_PENDING (element));
 401
 402   if (GST_STATE_PENDING (element) == GST_STATE_READY) {
 403     gst_mikmod_setup (mikmod);
 404
 405     if (Player_Active ()) {
 406       Player_TogglePause ();
 407       Player_SetPosition (0);
 408     }
 409     mikmod->initialized = FALSE;
 410   }
 411
 412   if (GST_STATE_PENDING (element) == GST_STATE_PLAYING) {
 413     if (Player_Active () && Player_Paused ())
 414       Player_TogglePause ();
 415     else if (!Player_Active ())
 416       Player_Start (module);
 417
 418   }
 419
 420   if (GST_STATE_PENDING (element) == GST_STATE_PAUSED)
 421     if (Player_Active () && !Player_Paused ())
 422       Player_TogglePause ();
 423
 424   if (GST_STATE_PENDING (element) == GST_STATE_NULL)
 425     MikMod_Exit ();
 426
 427
 428   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 429     return GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 430
 431   return GST_STATE_CHANGE_SUCCESS;
 432 }
 433
 434
 435
 436 static void
 437 gst_mikmod_set_property (GObject * object, guint id, const GValue * value,
 438     GParamSpec * pspec)
 439 {
 440   GstMikMod *filter;
 441
 442   g_return_if_fail (GST_IS_MIKMOD (object));
 443   filter = GST_MIKMOD (object);
 444
 445   switch (id) {
 446     case ARG_SONGNAME:
 447       g_free (filter->songname);
 448       filter->songname = g_strdup (g_value_get_string (value));
 449       break;
 450     case ARG_MODTYPE:
 451       g_free (filter->modtype);
 452       filter->modtype = g_strdup (g_value_get_string (value));
 453       break;
 454     case ARG_MUSICVOLUME:
 455       filter->musicvolume = g_value_get_int (value);
 456       break;
 457     case ARG_PANSEP:
 458       filter->pansep = g_value_get_int (value);
 459       break;
 460     case ARG_REVERB:
 461       filter->reverb = g_value_get_int (value);
 462       break;
 463     case ARG_SNDFXVOLUME:
 464       filter->sndfxvolume = g_value_get_int (value);
 465       break;
 466     case ARG_VOLUME:
 467       filter->volume = g_value_get_int (value);
 468       break;
 469     case ARG_INTERP:
 470       filter->interp = g_value_get_boolean (value);
 471       break;
 472     case ARG_REVERSE:
 473       filter->reverse = g_value_get_boolean (value);
 474       break;
 475     case ARG_SURROUND:
 476       filter->surround = g_value_get_boolean (value);
 477       break;
 478     case ARG_HQMIXER:
 479       filter->hqmixer = g_value_get_boolean (value);
 480       break;
 481     case ARG_SOFT_MUSIC:
 482       filter->soft_music = g_value_get_boolean (value);
 483       break;
 484     case ARG_SOFT_SNDFX:
 485       filter->soft_sndfx = g_value_get_boolean (value);
 486       break;
 487     default:
 488       break;
 489   }
 490 }
 491
 492 static void
 493 gst_mikmod_get_property (GObject * object, guint id, GValue * value,
 494     GParamSpec * pspec)
 495 {
 496   GstMikMod *filter;
 497
 498   g_return_if_fail (GST_IS_MIKMOD (object));
 499   filter = GST_MIKMOD (object);
 500
 501   switch (id) {
 502     case ARG_MUSICVOLUME:
 503       g_value_set_int (value, filter->musicvolume);
 504       break;
 505     case ARG_PANSEP:
 506       g_value_set_int (value, filter->pansep);
 507       break;
 508     case ARG_REVERB:
 509       g_value_set_int (value, filter->reverb);
 510       break;
 511     case ARG_SNDFXVOLUME:
 512       g_value_set_int (value, filter->sndfxvolume);
 513       break;
 514     case ARG_VOLUME:
 515       g_value_set_int (value, filter->volume);
 516       break;
 517     case ARG_INTERP:
 518       g_value_set_boolean (value, filter->interp);
 519       break;
 520     case ARG_REVERSE:
 521       g_value_set_boolean (value, filter->reverse);
 522       break;
 523     case ARG_SURROUND:
 524       g_value_set_boolean (value, filter->surround);
 525       break;
 526     case ARG_HQMIXER:
 527       g_value_set_boolean (value, filter->hqmixer);
 528       break;
 529     case ARG_SOFT_MUSIC:
 530       g_value_set_boolean (value, filter->soft_music);
 531       break;
 532     case ARG_SOFT_SNDFX:
 533       g_value_set_boolean (value, filter->soft_sndfx);
 534       break;
 535     default:
 536       break;
 537   }
 538 }
 539
 540 static gboolean
 541 plugin_init (GstPlugin * plugin)
 542 {
 543   if (!gst_element_register (plugin, "mikmod", GST_RANK_SECONDARY,
 544           GST_TYPE_MIKMOD))
 545     return FALSE;
 546
 547   return TRUE;
 548 }
 549
 550 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
 551     GST_VERSION_MINOR,
 552     "mikmod",
 553     "Mikmod plugin library",
 554     plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)