1 /*****************************************************************************
2 * gme.cpp: Game Music files demuxer (using Game_Music_Emu)
3 *****************************************************************************
4 * Copyright (C) 2006 the VideoLAN team
7 * Authors: Jean Sreng <fox@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
33 #include <vlc_plugin.h>
47 /*****************************************************************************
49 *****************************************************************************/
50 static int Open ( vlc_object_t * );
51 static void Close ( vlc_object_t * );
54 set_shortname( "GME");
55 set_description( _("GME demuxer (Game_Music_Emu)" ) );
56 set_capability( "demux", 10 );
57 set_category( CAT_INPUT );
58 set_subcategory( SUBCAT_INPUT_DEMUX );
59 set_callbacks( Open, Close );
60 add_shortcut( "gme" );
63 /*****************************************************************************
65 *****************************************************************************/
76 static const char* type_str[] =
78 "NSF (Nes)", "GBS (Gameboy)", "VGM (Master System/Game Gear/Genesis)", "SPC (Super Nes)", "GYM (Genesis)"
93 Music_Emu *p_musicemu;
94 Emu_Mem_Reader *p_reader;
98 static int Demux ( demux_t *p_demux );
99 static int Control( demux_t *p_demux, int i_query, va_list args );
102 static void inflate_gzbuf(uint8_t * p_buffer, size_t i_size, uint8_t ** pp_obuffer, size_t * pi_osize);
105 static const char* gme_ext[] =
107 "nsf", "nsfe", "gbs", "vgm", "vgz", "spc", "gym", NULL
110 /*****************************************************************************
112 *****************************************************************************/
113 static int Open( vlc_object_t *p_this )
115 demux_t *p_demux = (demux_t*)p_this;
121 /* We accept file based on extention match */
122 if( !p_demux->b_force )
124 if( ( ext = strrchr( p_demux->psz_path, '.' ) ) == NULL ||
125 stream_Size( p_demux->s ) == 0 ) return VLC_EGENERIC;
128 for( i = 0; gme_ext[i] != NULL; i++ )
130 if( !strcasecmp( ext, gme_ext[i] ) )
135 if( gme_ext[i] == NULL ) return VLC_EGENERIC;
136 msg_Dbg( p_demux, "running GME demuxer (ext=%s)", gme_ext[i] );
140 if (i == 4) /* gzipped vgm */
142 msg_Dbg( p_demux, "zlib unvailable, unable to read gzipped vgz file" );
147 /* Fill p_demux field */
148 p_demux->pf_demux = Demux;
149 p_demux->pf_control = Control;
150 p_demux->p_sys = p_sys = (demux_sys_t *)malloc( sizeof( demux_sys_t ) );
152 msg_Dbg( p_demux, "loading complete file (could be long)" );
153 p_sys->i_data = stream_Size( p_demux->s );
154 p_sys->p_data = (uint8_t *)malloc( p_sys->i_data );
155 p_sys->i_data = stream_Read( p_demux->s, p_sys->p_data, p_sys->i_data );
156 if( p_sys->i_data <= 0 )
158 msg_Err( p_demux, "failed to read the complete file" );
159 free( p_sys->p_data );
164 /* Prepare emulator */
167 if (i == 4) /* gzipped vgm */
169 uint8_t * p_outbuffer;
172 inflate_gzbuf( p_sys->p_data, p_sys->i_data, &p_outbuffer, &i_outsize );
174 if (p_outbuffer == NULL)
176 msg_Err( p_demux, "failed to understand the file : unable to inflate vgz file" );
177 /* we try to seek to recover for other plugin */
178 stream_Seek( p_demux->s, 0 );
179 free( p_sys->p_data );
186 p_sys->p_data = p_outbuffer;
187 p_sys->i_data = i_outsize;
191 p_sys->p_reader = new Emu_Mem_Reader( p_sys->p_data, p_sys->i_data );
197 p_sys->i_type = EMU_NSF;
200 p_sys->i_type = EMU_GBS;
204 p_sys->i_type = EMU_VGM;
207 p_sys->i_type = EMU_SPC;
210 p_sys->i_type = EMU_GYM;
214 /* Emulator specific initialization */
216 #define INIT_EMU(type) \
217 type##_Emu::header_t header; \
218 type##_Emu * p_emu = new type##_Emu; \
219 p_emu->init( 44100 ); \
220 p_sys->p_musicemu = p_emu; \
221 p_sys->p_reader->read( &header, sizeof(header) ); \
222 p_error = p_emu->load( header, *(p_sys->p_reader) );
224 p_sys->p_meta = vlc_meta_New();
228 /// \todo Reinstate meta codec name
229 //SET_META( VLC_META_CODEC_NAME, type_str[p_sys->i_type])
231 const char * p_error;
233 switch(p_sys->i_type)
240 vlc_meta_SetTitle( p_meta, header.game );
241 vlc_meta_SetArtist( p_meta, header.author );
242 vlc_meta_SetCopyright( p_meta, header.copyright );
243 p_sys->i_tracks = p_emu->track_count();
252 vlc_meta_SetTitle( p_meta, header.game );
253 vlc_meta_SetArtist( p_meta, header.author );
254 vlc_meta_SetCopyright( p_meta, header.copyright );
255 p_sys->i_tracks = p_emu->track_count();
264 p_sys->i_tracks = p_emu->track_count();
273 snprintf( psz_temp, 511, "%s (%s)", header.song, header.game );
274 vlc_meta_SetTitle( p_meta, psz_temp );
275 vlc_meta_SetArtist( p_meta, header.author );
276 p_sys->i_tracks = p_emu->track_count();
285 snprintf( psz_temp, 511, "%s (%s)", header.song, header.game );
286 vlc_meta_SetTitle( p_meta, psz_temp );
287 vlc_meta_SetCopyright( p_meta, header.copyright );
288 p_sys->i_tracks = p_emu->track_count();
294 if( p_error != NULL )
296 msg_Err( p_demux, "failed to understand the file : %s", p_error );
297 /* we try to seek to recover for other plugin */
298 stream_Seek( p_demux->s, 0 );
299 free( p_sys->p_data );
306 p_sys->i_length = 314 * (int64_t)1000;
308 msg_Dbg( p_demux, "GME loaded type=%s title=%s tracks=%i", type_str[p_sys->i_type],
309 vlc_meta_GetValue( p_sys->p_meta, VLC_META_TITLE ), p_sys->i_tracks );
311 p_sys->p_musicemu->start_track( 0 );
313 #ifdef WORDS_BIGENDIAN
314 es_format_Init( &p_sys->fmt, AUDIO_ES, VLC_FOURCC( 't', 'w', 'o', 's' ) );
316 es_format_Init( &p_sys->fmt, AUDIO_ES, VLC_FOURCC( 'a', 'r', 'a', 'w' ) );
318 p_sys->fmt.audio.i_rate = 44100;
319 p_sys->fmt.audio.i_channels = 2;
320 p_sys->fmt.audio.i_bitspersample = 16;
321 p_sys->es = es_out_Add( p_demux->out, &p_sys->fmt );
326 /*****************************************************************************
328 *****************************************************************************/
329 static void Close( vlc_object_t *p_this )
331 demux_t *p_demux = (demux_t*)p_this;
332 demux_sys_t *p_sys = p_demux->p_sys;
334 delete p_sys->p_musicemu;
335 delete p_sys->p_reader;
337 free( p_sys->p_data );
342 /*****************************************************************************
344 *****************************************************************************/
345 static int Demux( demux_t *p_demux )
347 demux_sys_t *p_sys = p_demux->p_sys;
349 int i_bk = ( p_sys->fmt.audio.i_bitspersample / 8 ) *
350 p_sys->fmt.audio.i_channels;
351 const unsigned int i_buf = p_sys->fmt.audio.i_rate / 10 * i_bk;
352 const unsigned int i_emubuf = i_buf / sizeof(Music_Emu::sample_t);
353 const char * p_error;
354 Music_Emu::sample_t p_emubuf [i_emubuf];
356 p_frame = block_New( p_demux, i_buf );
358 p_sys->p_musicemu->play( i_emubuf, p_emubuf );
361 if( p_error != NULL )
363 msg_Dbg( p_demux, "stop playing : %s", p_error );
364 block_Release( p_frame );
369 /* Copy emulator output to frame */
370 for (int i = 0; i<i_buf; i++) p_frame->p_buffer[i] = ((uint8_t *)p_emubuf)[i];
373 es_out_Control( p_demux->out, ES_OUT_SET_PCR, (int64_t)p_sys->i_time );
375 /* We should use p_frame->i_buffer */
376 p_sys->i_time += (int64_t)1000000 * p_frame->i_buffer / i_bk / p_sys->fmt.audio.i_rate;
379 p_frame->i_dts = p_frame->i_pts = p_sys->i_time;
380 es_out_Send( p_demux->out, p_sys->es, p_frame );
385 /*****************************************************************************
387 *****************************************************************************/
388 static int Control( demux_t *p_demux, int i_query, va_list args )
390 demux_sys_t *p_sys = p_demux->p_sys;
394 vlc_meta_t **pp_meta;
399 pp_meta = (vlc_meta_t **)va_arg( args, vlc_meta_t** );
401 *pp_meta = vlc_meta_Duplicate( p_sys->p_meta );
406 case DEMUX_GET_POSITION:
407 pf = (double*) va_arg( args, double* );
408 if( p_sys->i_length > 0 )
410 *pf = (double)p_sys->i_time / (double)p_sys->i_length;
415 case DEMUX_SET_POSITION:
416 f = (double) va_arg( args, double );
418 i64 = f * p_sys->i_length;
419 if( i64 >= 0 && i64 <= p_sys->i_length )
421 ModPlug_Seek( p_sys->f, i64 / 1000 );
422 p_sys->i_time = i64 + 1;
423 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
430 pi64 = (int64_t*)va_arg( args, int64_t * );
431 *pi64 = p_sys->i_time;
434 case DEMUX_GET_LENGTH:
435 pi64 = (int64_t*)va_arg( args, int64_t * );
436 *pi64 = p_sys->i_length;
440 i64 = (int64_t)va_arg( args, int64_t );
442 if( i64 >= 0 && i64 <= p_sys->i_length )
444 ModPlug_Seek( p_sys->f, i64 / 1000 );
445 p_sys->i_time = i64 + 1;
446 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
452 case DEMUX_GET_TITLE_INFO:
453 if( p_sys->i_tracks > 1 )
455 input_title_t ***ppp_title = (input_title_t***)va_arg( args, input_title_t*** );
456 int *pi_int = (int*)va_arg( args, int* );
458 *pi_int = p_sys->i_tracks;
459 *ppp_title = (input_title_t**)malloc( sizeof( input_title_t**) * p_sys->i_tracks );
461 for( int i = 0; i < p_sys->i_tracks; i++ )
464 snprintf(psz_temp, 15, "Track %i", i);
465 (*ppp_title)[i] = vlc_input_title_New();
466 (*ppp_title)[i]->psz_name = strdup(psz_temp);
474 case DEMUX_SET_TITLE:
475 i_idx = (int)va_arg( args, int );
476 p_sys->p_musicemu->start_track( i_idx );
477 p_demux->info.i_title = i_idx;
478 p_demux->info.i_update = INPUT_UPDATE_TITLE;
479 msg_Dbg( p_demux, "set title %i", i_idx);
482 case DEMUX_GET_FPS: /* meaningless */
490 static void inflate_gzbuf(uint8_t * p_buffer, size_t i_size, uint8_t ** pp_obuffer, size_t * pi_osize)
494 size_t offset, out_size;
495 uint8_t * out_buffer;
497 (*pp_obuffer) = NULL;
500 memset(&z_str, 0, sizeof(z_str));
502 out_size = i_size * 2;
503 out_buffer = (uint8_t*)malloc(out_size);
505 z_str.next_in = (unsigned char*)p_buffer;
506 z_str.avail_in = i_size;
507 z_str.next_out = out_buffer;
508 z_str.avail_out = out_size;
510 if ((err = inflateInit2(&z_str, 31)) != Z_OK) /* gzip format */
516 while ((err = inflate(&z_str, Z_FINISH)) != Z_STREAM_END)
523 offset = z_str.next_out - out_buffer;
525 out_buffer = (uint8_t *)realloc(out_buffer, out_size);
526 z_str.next_out = out_buffer + offset;
527 z_str.avail_out = out_size - offset;
536 (*pi_osize) = out_size - z_str.avail_out;
540 out_buffer = (uint8_t *)realloc(out_buffer, *pi_osize);
541 (*pp_obuffer) = out_buffer;