modules/demux/gme.c

   1 /**
   2  * @file gme.c
   3  * @brief Game Music Emu demux module for VLC media player
   4  */
   5 /*****************************************************************************
   6  * Copyright © 2010 Rémi Denis-Courmont
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU Lesser General Public License as published by
  10  * the Free Software Foundation; either version 2.1 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  21  *****************************************************************************/
  22
  23 #ifdef HAVE_CONFIG_H
  24 # include <config.h>
  25 #endif
  26
  27 #include <stdarg.h>
  28 #include <limits.h>
  29 #include <assert.h>
  30
  31 #include <vlc_common.h>
  32 #include <vlc_input.h>
  33 #include <vlc_demux.h>
  34 #include <vlc_plugin.h>
  35
  36 #include <gme/gme.h>
  37
  38 static int  Open (vlc_object_t *);
  39 static void Close (vlc_object_t *);
  40
  41 vlc_module_begin ()
  42     set_shortname ("GME")
  43     set_description ("Game Music Emu")
  44     set_category (CAT_INPUT)
  45     set_subcategory (SUBCAT_INPUT_DEMUX)
  46     set_capability ("demux", 10)
  47     set_callbacks (Open, Close)
  48 vlc_module_end ()
  49
  50 #define RATE 48000
  51
  52 struct demux_sys_t
  53 {
  54     Music_Emu   *emu;
  55     unsigned     track_id;
  56
  57     es_out_id_t *es;
  58     date_t       pts;
  59
  60     input_title_t **titlev;
  61     unsigned        titlec;
  62 };
  63
  64
  65 static int Demux (demux_t *);
  66 static int Control (demux_t *, int, va_list);
  67 static gme_err_t ReaderStream (void *, void *, int);
  68 static gme_err_t ReaderBlock (void *, void *, int);
  69
  70 static int Open (vlc_object_t *obj)
  71 {
  72     demux_t *demux = (demux_t *)obj;
  73     uint64_t size;
  74
  75     if (vlc_stream_GetSize(demux->s, &size))
  76         return VLC_EGENERIC;
  77     if (size > LONG_MAX /* too big for GME */)
  78         return VLC_EGENERIC;
  79
  80     /* Auto detection */
  81     const uint8_t *peek;
  82     if (vlc_stream_Peek (demux->s, &peek, 4) < 4)
  83         return VLC_EGENERIC;
  84
  85     const char *type = gme_identify_header (peek);
  86     if (!*type)
  87         return VLC_EGENERIC;
  88     msg_Dbg (obj, "detected file type %s", type);
  89
  90     block_t *data = NULL;
  91     if (size <= 0)
  92     {
  93         data = vlc_stream_Block (demux->s, 1 << 24);
  94         if (data == NULL)
  95             return VLC_EGENERIC;
  96     }
  97
  98     /* Initialization */
  99     demux_sys_t *sys = malloc (sizeof (*sys));
 100     if (unlikely(sys == NULL))
 101         return VLC_ENOMEM;
 102
 103     sys->emu = gme_new_emu (gme_identify_extension (type), RATE);
 104     if (sys->emu == NULL)
 105     {
 106         free (sys);
 107         return VLC_ENOMEM;
 108     }
 109     if (data)
 110     {
 111         gme_load_custom (sys->emu, ReaderBlock, data->i_buffer, data);
 112         block_Release(data);
 113     }
 114     else
 115     {
 116         gme_load_custom (sys->emu, ReaderStream, size, demux->s);
 117     }
 118     gme_start_track (sys->emu, sys->track_id = 0);
 119
 120     es_format_t fmt;
 121     es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_S16N);
 122     fmt.audio.i_rate = RATE;
 123     fmt.audio.i_bytes_per_frame = 4;
 124     fmt.audio.i_frame_length = 4;
 125     fmt.audio.i_channels = 2;
 126     fmt.audio.i_blockalign = 4;
 127     fmt.audio.i_bitspersample = 16;
 128     fmt.i_bitrate = RATE * 4;
 129
 130     sys->es = es_out_Add (demux->out, &fmt);
 131     date_Init (&sys->pts, RATE, 1);
 132     date_Set (&sys->pts, 0);
 133
 134     /* Titles */
 135     unsigned n = gme_track_count (sys->emu);
 136     sys->titlev = vlc_alloc (n, sizeof (*sys->titlev));
 137     if (unlikely(sys->titlev == NULL))
 138         n = 0;
 139     sys->titlec = n;
 140     for (unsigned i = 0; i < n; i++)
 141     {
 142          input_title_t *title = vlc_input_title_New ();
 143          sys->titlev[i] = title;
 144          if (unlikely(title == NULL))
 145              continue;
 146
 147          gme_info_t *infos;
 148          if (gme_track_info (sys->emu, &infos, i))
 149              continue;
 150          msg_Dbg (obj, "track %u: %s %d ms", i, infos->song, infos->length);
 151          if (infos->length != -1)
 152              title->i_length = infos->length * INT64_C(1000);
 153          if (infos->song[0])
 154              title->psz_name = strdup (infos->song);
 155          gme_free_info (infos);
 156     }
 157
 158     /* Callbacks */
 159     demux->pf_demux = Demux;
 160     demux->pf_control = Control;
 161     demux->p_sys = sys;
 162     return VLC_SUCCESS;
 163 }
 164
 165
 166 static void Close (vlc_object_t *obj)
 167 {
 168     demux_t *demux = (demux_t *)obj;
 169     demux_sys_t *sys = demux->p_sys;
 170
 171     for (unsigned i = 0, n = sys->titlec; i < n; i++)
 172         vlc_input_title_Delete (sys->titlev[i]);
 173     free (sys->titlev);
 174     gme_delete (sys->emu);
 175     free (sys);
 176 }
 177
 178
 179 static gme_err_t ReaderStream (void *data, void *buf, int length)
 180 {
 181     stream_t *s = data;
 182
 183     if (vlc_stream_Read (s, buf, length) < length)
 184         return "short read";
 185     return NULL;
 186 }
 187 static gme_err_t ReaderBlock (void *data, void *buf, int length)
 188 {
 189     block_t *block = data;
 190
 191     int max = __MIN (length, (int)block->i_buffer);
 192     memcpy (buf, block->p_buffer, max);
 193     block->i_buffer -= max;
 194     block->p_buffer += max;
 195     if (max != length)
 196         return "short read";
 197     return NULL;
 198 }
 199
 200 #define SAMPLES (RATE / 10)
 201
 202 static int Demux (demux_t *demux)
 203 {
 204     demux_sys_t *sys = demux->p_sys;
 205
 206     /* Next track */
 207     if (gme_track_ended (sys->emu))
 208     {
 209         msg_Dbg (demux, "track %u ended", sys->track_id);
 210         if (++sys->track_id >= (unsigned)gme_track_count (sys->emu))
 211             return 0;
 212
 213         demux->info.i_update |= INPUT_UPDATE_TITLE;
 214         gme_start_track (sys->emu, sys->track_id);
 215     }
 216
 217
 218     block_t *block = block_Alloc (2 * 2 * SAMPLES);
 219     if (unlikely(block == NULL))
 220         return 0;
 221
 222     gme_err_t ret = gme_play (sys->emu, 2 * SAMPLES, (void *)block->p_buffer);
 223     if (ret != NULL)
 224     {
 225         block_Release (block);
 226         msg_Err (demux, "%s", ret);
 227         return 0;
 228     }
 229
 230     block->i_pts = block->i_dts = VLC_TS_0 + date_Get (&sys->pts);
 231     es_out_SetPCR (demux->out, block->i_pts);
 232     es_out_Send (demux->out, sys->es, block);
 233     date_Increment (&sys->pts, SAMPLES);
 234     return 1;
 235 }
 236
 237
 238 static int Control (demux_t *demux, int query, va_list args)
 239 {
 240     demux_sys_t *sys = demux->p_sys;
 241
 242     switch (query)
 243     {
 244         case DEMUX_CAN_SEEK:
 245             *va_arg (args, bool *) = true;
 246             return VLC_SUCCESS;
 247
 248         case DEMUX_GET_POSITION:
 249         {
 250             double *pos = va_arg (args, double *);
 251
 252             if (unlikely(sys->track_id >= sys->titlec)
 253              || (sys->titlev[sys->track_id]->i_length == 0))
 254                 *pos = 0.;
 255             else
 256             {
 257                 int offset = gme_tell (sys->emu);
 258
 259                 *pos = (double)offset
 260                     / (double)(sys->titlev[sys->track_id]->i_length / 1000);
 261             }
 262             return VLC_SUCCESS;
 263         }
 264
 265         case DEMUX_SET_POSITION:
 266         {
 267             double pos = va_arg (args, double);
 268
 269             if (unlikely(sys->track_id >= sys->titlec)
 270              || (sys->titlev[sys->track_id]->i_length == 0))
 271                 break;
 272
 273             int seek = (sys->titlev[sys->track_id]->i_length / 1000) * pos;
 274             if (gme_seek (sys->emu, seek))
 275                 break;
 276             return VLC_SUCCESS;
 277         }
 278
 279         case DEMUX_GET_LENGTH:
 280         {
 281             int64_t *v = va_arg (args, int64_t *);
 282
 283             if (unlikely(sys->track_id >= sys->titlec)
 284              || (sys->titlev[sys->track_id]->i_length == 0))
 285                 break;
 286             *v = sys->titlev[sys->track_id]->i_length;
 287             return VLC_SUCCESS;
 288         }
 289
 290         case DEMUX_GET_TIME:
 291         {
 292             int64_t *v = va_arg (args, int64_t *);
 293             *v = gme_tell (sys->emu) * INT64_C(1000);
 294             return VLC_SUCCESS;
 295         }
 296
 297         case DEMUX_SET_TIME:
 298         {
 299             int64_t v = va_arg (args, int64_t) / 1000;
 300             if (v > INT_MAX || gme_seek (sys->emu, v))
 301                 break;
 302             return VLC_SUCCESS;
 303         }
 304
 305         case DEMUX_GET_TITLE_INFO:
 306         {
 307             input_title_t ***titlev = va_arg (args, input_title_t ***);
 308             int *titlec = va_arg (args, int *);
 309             *(va_arg (args, int *)) = 0; /* Title offset */
 310             *(va_arg (args, int *)) = 0; /* Chapter offset */
 311
 312             unsigned n = sys->titlec;
 313             *titlev = vlc_alloc (n, sizeof (**titlev));
 314             if (unlikely(*titlev == NULL))
 315                 n = 0;
 316             *titlec = n;
 317             for (unsigned i = 0; i < n; i++)
 318                 (*titlev)[i] = vlc_input_title_Duplicate (sys->titlev[i]);
 319             return VLC_SUCCESS;
 320         }
 321
 322         case DEMUX_SET_TITLE:
 323         {
 324             int track_id = va_arg (args, int);
 325             if (track_id >= gme_track_count (sys->emu))
 326                 break;
 327             gme_start_track (sys->emu, track_id);
 328             demux->info.i_update |= INPUT_UPDATE_TITLE;
 329             sys->track_id = track_id;
 330             return VLC_SUCCESS;
 331         }
 332
 333         case DEMUX_GET_TITLE:
 334             *va_arg(args, int *) = sys->track_id;
 335             return VLC_SUCCESS;
 336     }
 337
 338     return VLC_EGENERIC;
 339 }