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         "signed = (boolean) FALSE, "
  79         "width = (int) 8, "
  80         "depth = (int) 8, "
  81         "rate = (int) { 8000, 11025, 22050, 44100 }, "
  82         "channels = (int) [ 1, 2 ]")
  83     );
  84
  85 static GstStaticPadTemplate mikmod_sink_factory =
  86 GST_STATIC_PAD_TEMPLATE ("sink",
  87     GST_PAD_SINK,
  88     GST_PAD_ALWAYS,
  89     GST_STATIC_CAPS ("audio/x-mod")
  90     );
  91
  92 static void gst_mikmod_base_init (gpointer g_class);
  93 static void gst_mikmod_class_init (GstMikModClass * klass);
  94 static void gst_mikmod_init (GstMikMod * filter);
  95 static void gst_mikmod_set_property (GObject * object, guint id,
  96     const GValue * value, GParamSpec * pspec);
  97 static void gst_mikmod_get_property (GObject * object, guint id, GValue * value,
  98     GParamSpec * pspec);
  99 static GstPadLinkReturn gst_mikmod_srclink (GstPad * pad, const GstCaps * caps);
 100 static GstCaps *gst_mikmod_srcfixate (GstPad * pad, const GstCaps * caps);
 101 static void gst_mikmod_loop (GstElement * element);
 102 static gboolean gst_mikmod_setup (GstMikMod * mikmod);
 103 static GstElementStateReturn gst_mikmod_change_state (GstElement * element);
 104
 105
 106
 107 static GstElementClass *parent_class = NULL;
 108
 109 GType
 110 gst_mikmod_get_type (void)
 111 {
 112   static GType mikmod_type = 0;
 113
 114   if (!mikmod_type) {
 115     static const GTypeInfo mikmod_info = {
 116       sizeof (GstMikModClass),
 117       gst_mikmod_base_init,
 118       NULL,
 119       (GClassInitFunc) gst_mikmod_class_init,
 120       NULL,
 121       NULL,
 122       sizeof (GstMikMod),
 123       0,
 124       (GInstanceInitFunc) gst_mikmod_init,
 125     };
 126     mikmod_type =
 127         g_type_register_static (GST_TYPE_ELEMENT, "GstMikmod", &mikmod_info, 0);
 128   }
 129   return mikmod_type;
 130 }
 131
 132 static void
 133 gst_mikmod_base_init (gpointer g_class)
 134 {
 135   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 136
 137   gst_element_class_add_pad_template (element_class,
 138       gst_static_pad_template_get (&mikmod_src_factory));
 139   gst_element_class_add_pad_template (element_class,
 140       gst_static_pad_template_get (&mikmod_sink_factory));
 141   gst_element_class_set_details (element_class, &mikmod_details);
 142 }
 143
 144 static void
 145 gst_mikmod_class_init (GstMikModClass * klass)
 146 {
 147   GObjectClass *gobject_class;
 148   GstElementClass *gstelement_class;
 149
 150   gobject_class = (GObjectClass *) klass;
 151   gstelement_class = (GstElementClass *) klass;
 152
 153   parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
 154
 155   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SONGNAME,
 156       g_param_spec_string ("songname", "songname", "songname",
 157           NULL, G_PARAM_READABLE));
 158   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MODTYPE,
 159       g_param_spec_string ("modtype", "modtype", "modtype",
 160           NULL, G_PARAM_READABLE));
 161   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MUSICVOLUME,
 162       g_param_spec_int ("musicvolume", "musivolume", "musicvolume",
 163           0, 128, 128, G_PARAM_READWRITE));
 164   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_PANSEP,
 165       g_param_spec_int ("pansep", "pansep", "pansep",
 166           0, 128, 128, G_PARAM_READWRITE));
 167   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_REVERB,
 168       g_param_spec_int ("reverb", "reverb", "reverb",
 169           0, 15, 0, G_PARAM_READWRITE));
 170   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SNDFXVOLUME,
 171       g_param_spec_int ("sndfxvolume", "sndfxvolume", "sndfxvolume",
 172           0, 128, 128, G_PARAM_READWRITE));
 173   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_VOLUME,
 174       g_param_spec_int ("volume", "volume", "volume",
 175           0, 128, 96, G_PARAM_READWRITE));
 176
 177   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_INTERP,
 178       g_param_spec_boolean ("interp", "interp", "interp",
 179           FALSE, G_PARAM_READWRITE));
 180   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_REVERSE,
 181       g_param_spec_boolean ("reverse", "reverse", "reverse",
 182           FALSE, G_PARAM_READWRITE));
 183   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SURROUND,
 184       g_param_spec_boolean ("surround", "surround", "surround",
 185           TRUE, G_PARAM_READWRITE));
 186   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_HQMIXER,
 187       g_param_spec_boolean ("hqmixer", "hqmixer", "hqmixer",
 188           FALSE, G_PARAM_READWRITE));
 189   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SOFT_MUSIC,
 190       g_param_spec_boolean ("soft_music", "soft_music", "soft_music",
 191           TRUE, G_PARAM_READWRITE));
 192   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SOFT_SNDFX,
 193       g_param_spec_boolean ("soft_sndfx", "soft_sndfx", "soft_sndfx",
 194           TRUE, G_PARAM_READWRITE));
 195
 196
 197   gobject_class->set_property = gst_mikmod_set_property;
 198   gobject_class->get_property = gst_mikmod_get_property;
 199
 200   gstelement_class->change_state = gst_mikmod_change_state;
 201 }
 202
 203
 204 static void
 205 gst_mikmod_init (GstMikMod * filter)
 206 {
 207   filter->sinkpad =
 208       gst_pad_new_from_template (gst_static_pad_template_get
 209       (&mikmod_sink_factory), "sink");
 210   filter->srcpad =
 211       gst_pad_new_from_template (gst_static_pad_template_get
 212       (&mikmod_src_factory), "src");
 213
 214   gst_element_add_pad (GST_ELEMENT (filter), filter->sinkpad);
 215   gst_element_add_pad (GST_ELEMENT (filter), filter->srcpad);
 216   gst_pad_set_link_function (filter->srcpad, gst_mikmod_srclink);
 217   gst_pad_set_fixate_function (filter->srcpad, gst_mikmod_srcfixate);
 218
 219   gst_element_set_loop_function (GST_ELEMENT (filter), gst_mikmod_loop);
 220
 221   filter->Buffer = NULL;
 222
 223   filter->stereo = TRUE;
 224   filter->surround = TRUE;
 225   filter->_16bit = TRUE;
 226   filter->soft_music = TRUE;
 227   filter->soft_sndfx = TRUE;
 228   filter->mixfreq = 44100;
 229   filter->reverb = 0;
 230   filter->pansep = 128;
 231   filter->musicvolume = 128;
 232   filter->volume = 96;
 233   filter->sndfxvolume = 128;
 234   filter->songname = NULL;
 235   filter->modtype = NULL;
 236
 237   filter->initialized = FALSE;
 238 }
 239
 240 static GstCaps *
 241 gst_mikmod_srcfixate (GstPad * pad, const GstCaps * caps)
 242 {
 243   GstCaps *ret;
 244   GstStructure *structure;
 245
 246   /* FIXME: select est caps here */
 247   if (gst_caps_get_size (caps) > 1)
 248     return NULL;
 249
 250   ret = gst_caps_copy (caps);
 251   structure = gst_caps_get_structure (ret, 0);
 252
 253   if (gst_caps_structure_fixate_field_nearest_int (structure, "channels", 2))
 254     return ret;
 255   if (gst_caps_structure_fixate_field_nearest_int (structure, "rate", 44100))
 256     return ret;
 257
 258   gst_caps_free (ret);
 259   return NULL;
 260 }
 261
 262 static GstPadLinkReturn
 263 gst_mikmod_srclink (GstPad * pad, const GstCaps * caps)
 264 {
 265   GstMikMod *filter;
 266   GstStructure *structure;
 267   gint depth;
 268   gint channels;
 269
 270   filter = GST_MIKMOD (gst_pad_get_parent (pad));
 271
 272   structure = gst_caps_get_structure (caps, 0);
 273
 274   gst_structure_get_int (structure, "depth", &depth);
 275   filter->_16bit = (depth == 16);
 276   gst_structure_get_int (structure, "channels", &channels);
 277   filter->stereo = (channels == 2);
 278   gst_structure_get_int (structure, "rate", &filter->mixfreq);
 279
 280   return gst_mikmod_setup (filter) ? GST_PAD_LINK_OK : GST_PAD_LINK_REFUSED;
 281 }
 282
 283 static void
 284 gst_mikmod_loop (GstElement * element)
 285 {
 286   GstMikMod *mikmod;
 287   GstBuffer *buffer_in;
 288
 289   g_return_if_fail (element != NULL);
 290   g_return_if_fail (GST_IS_MIKMOD (element));
 291
 292   mikmod = GST_MIKMOD (element);
 293   srcpad = mikmod->srcpad;
 294   mikmod->Buffer = NULL;
 295
 296   if (!mikmod->initialized) {
 297     while ((buffer_in = GST_BUFFER (gst_pad_pull (mikmod->sinkpad)))) {
 298       if (GST_IS_EVENT (buffer_in)) {
 299         GstEvent *event = GST_EVENT (buffer_in);
 300
 301         if (GST_EVENT_TYPE (event) == GST_EVENT_EOS)
 302           break;
 303       } else {
 304         if (mikmod->Buffer) {
 305           GstBuffer *merge;
 306
 307           merge = gst_buffer_merge (mikmod->Buffer, buffer_in);
 308           gst_buffer_unref (buffer_in);
 309           gst_buffer_unref (mikmod->Buffer);
 310           mikmod->Buffer = merge;
 311         } else {
 312           mikmod->Buffer = buffer_in;
 313         }
 314       }
 315     }
 316
 317     if (!GST_PAD_CAPS (mikmod->srcpad)) {
 318       if (GST_PAD_LINK_SUCCESSFUL (gst_pad_renegotiate (mikmod->srcpad))) {
 319         GST_ELEMENT_ERROR (mikmod, CORE, NEGOTIATION, (NULL), (NULL));
 320         return;
 321       }
 322     }
 323
 324     MikMod_RegisterDriver (&drv_gst);
 325     MikMod_RegisterAllLoaders ();
 326
 327     MikMod_Init ("");
 328     reader = GST_READER_new (mikmod);
 329     module = Player_LoadGeneric (reader, 64, 0);
 330
 331     gst_buffer_unref (mikmod->Buffer);
 332
 333     if (!Player_Active ())
 334       Player_Start (module);
 335
 336     mikmod->initialized = TRUE;
 337   }
 338
 339   if (Player_Active ()) {
 340     timestamp = (module->sngtime / 1024.0) * GST_SECOND;
 341     drv_gst.Update ();
 342   } else {
 343     gst_element_set_eos (GST_ELEMENT (mikmod));
 344     gst_pad_push (mikmod->srcpad, GST_DATA (gst_event_new (GST_EVENT_EOS)));
 345   }
 346 }
 347
 348
 349 static gboolean
 350 gst_mikmod_setup (GstMikMod * mikmod)
 351 {
 352   md_musicvolume = mikmod->musicvolume;
 353   md_pansep = mikmod->pansep;
 354   md_reverb = mikmod->reverb;
 355   md_sndfxvolume = mikmod->sndfxvolume;
 356   md_volume = mikmod->volume;
 357   md_mixfreq = mikmod->mixfreq;
 358
 359   md_mode = 0;
 360
 361   if (mikmod->interp)
 362     md_mode = md_mode | DMODE_INTERP;
 363
 364   if (mikmod->reverse)
 365     md_mode = md_mode | DMODE_REVERSE;
 366
 367   if (mikmod->surround)
 368     md_mode = md_mode | DMODE_SURROUND;
 369
 370   if (mikmod->_16bit)
 371     md_mode = md_mode | DMODE_16BITS;
 372
 373   if (mikmod->hqmixer)
 374     md_mode = md_mode | DMODE_HQMIXER;
 375
 376   if (mikmod->soft_music)
 377     md_mode = md_mode | DMODE_SOFT_MUSIC;
 378
 379   if (mikmod->soft_sndfx)
 380     md_mode = md_mode | DMODE_SOFT_SNDFX;
 381
 382   if (mikmod->stereo)
 383     md_mode = md_mode | DMODE_STEREO;
 384
 385   return TRUE;
 386 }
 387
 388
 389 static GstElementStateReturn
 390 gst_mikmod_change_state (GstElement * element)
 391 {
 392   GstMikMod *mikmod;
 393
 394   g_return_val_if_fail (GST_IS_MIKMOD (element), GST_STATE_FAILURE);
 395
 396   mikmod = GST_MIKMOD (element);
 397
 398   GST_DEBUG ("state pending %d", GST_STATE_PENDING (element));
 399
 400   if (GST_STATE_PENDING (element) == GST_STATE_READY) {
 401     gst_mikmod_setup (mikmod);
 402
 403     if (Player_Active ()) {
 404       Player_TogglePause ();
 405       Player_SetPosition (0);
 406     }
 407     mikmod->initialized = FALSE;
 408   }
 409
 410   if (GST_STATE_PENDING (element) == GST_STATE_PLAYING) {
 411     if (Player_Active () && Player_Paused ())
 412       Player_TogglePause ();
 413     else if (!Player_Active ())
 414       Player_Start (module);
 415
 416   }
 417
 418   if (GST_STATE_PENDING (element) == GST_STATE_PAUSED)
 419     if (Player_Active () && !Player_Paused ())
 420       Player_TogglePause ();
 421
 422   if (GST_STATE_PENDING (element) == GST_STATE_NULL)
 423     MikMod_Exit ();
 424
 425
 426   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 427     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
 428
 429   return GST_STATE_SUCCESS;
 430 }
 431
 432
 433
 434 static void
 435 gst_mikmod_set_property (GObject * object, guint id, const GValue * value,
 436     GParamSpec * pspec)
 437 {
 438   GstMikMod *filter;
 439
 440   /* it's not null if we got it, but it might not be ours */
 441   g_return_if_fail (GST_IS_MIKMOD (object));
 442   filter = GST_MIKMOD (object);
 443
 444   switch (id) {
 445     case ARG_SONGNAME:
 446       g_free (filter->songname);
 447       filter->songname = g_strdup (g_value_get_string (value));
 448       break;
 449     case ARG_MODTYPE:
 450       g_free (filter->modtype);
 451       filter->modtype = g_strdup (g_value_get_string (value));
 452       break;
 453     case ARG_MUSICVOLUME:
 454       filter->musicvolume = g_value_get_int (value);
 455       break;
 456     case ARG_PANSEP:
 457       filter->pansep = g_value_get_int (value);
 458       break;
 459     case ARG_REVERB:
 460       filter->reverb = g_value_get_int (value);
 461       break;
 462     case ARG_SNDFXVOLUME:
 463       filter->sndfxvolume = g_value_get_int (value);
 464       break;
 465     case ARG_VOLUME:
 466       filter->volume = g_value_get_int (value);
 467       break;
 468     case ARG_INTERP:
 469       filter->interp = g_value_get_boolean (value);
 470       break;
 471     case ARG_REVERSE:
 472       filter->reverse = g_value_get_boolean (value);
 473       break;
 474     case ARG_SURROUND:
 475       filter->surround = g_value_get_boolean (value);
 476       break;
 477     case ARG_HQMIXER:
 478       filter->hqmixer = g_value_get_boolean (value);
 479       break;
 480     case ARG_SOFT_MUSIC:
 481       filter->soft_music = g_value_get_boolean (value);
 482       break;
 483     case ARG_SOFT_SNDFX:
 484       filter->soft_sndfx = g_value_get_boolean (value);
 485       break;
 486     default:
 487       break;
 488   }
 489 }
 490
 491 static void
 492 gst_mikmod_get_property (GObject * object, guint id, GValue * value,
 493     GParamSpec * pspec)
 494 {
 495   GstMikMod *filter;
 496
 497   /* it's not null if we got it, but it might not be ours */
 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, "GPL", GST_PACKAGE, GST_ORIGIN)