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