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 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
47 /*****************************************************************************
49 *****************************************************************************/
50 static int Open ( vlc_object_t * );
51 static void Close ( vlc_object_t * );
55 set_description( N_("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 )
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 ) );
151 if( unlikely( !p_sys ) )
154 msg_Dbg( p_demux, "loading complete file (could be long)" );
155 p_sys->i_data = stream_Size( p_demux->s );
156 p_sys->p_data = (uint8_t *)malloc( p_sys->i_data );
157 if( unlikely( !p_sys->p_data ) )
162 p_sys->i_data = stream_Read( p_demux->s, p_sys->p_data, p_sys->i_data );
163 if( p_sys->i_data <= 0 )
165 msg_Err( p_demux, "failed to read the complete file" );
166 free( p_sys->p_data );
171 /* Prepare emulator */
174 if (i == 4) /* gzipped vgm */
176 uint8_t * p_outbuffer;
179 inflate_gzbuf( p_sys->p_data, p_sys->i_data, &p_outbuffer, &i_outsize );
181 if (p_outbuffer == NULL)
183 msg_Err( p_demux, "failed to understand the file : unable to inflate vgz file" );
184 /* we try to seek to recover for other plugin */
185 stream_Seek( p_demux->s, 0 );
186 free( p_sys->p_data );
193 p_sys->p_data = p_outbuffer;
194 p_sys->i_data = i_outsize;
198 p_sys->p_reader = new Emu_Mem_Reader( p_sys->p_data, p_sys->i_data );
204 p_sys->i_type = EMU_NSF;
207 p_sys->i_type = EMU_GBS;
211 p_sys->i_type = EMU_VGM;
214 p_sys->i_type = EMU_SPC;
217 p_sys->i_type = EMU_GYM;
221 /* Emulator specific initialization */
223 #define INIT_EMU(type) \
224 type##_Emu::header_t header; \
225 type##_Emu * p_emu = new type##_Emu; \
226 p_emu->init( 44100 ); \
227 p_sys->p_musicemu = p_emu; \
228 p_sys->p_reader->read( &header, sizeof(header) ); \
229 p_error = p_emu->load( header, *(p_sys->p_reader) );
231 p_sys->p_meta = vlc_meta_New();
235 /// \todo Reinstate meta codec name
236 //SET_META( VLC_META_CODEC_NAME, type_str[p_sys->i_type])
238 const char * p_error;
240 switch(p_sys->i_type)
247 vlc_meta_SetTitle( p_meta, header.game );
248 vlc_meta_SetArtist( p_meta, header.author );
249 vlc_meta_SetCopyright( p_meta, header.copyright );
250 p_sys->i_tracks = p_emu->track_count();
259 vlc_meta_SetTitle( p_meta, header.game );
260 vlc_meta_SetArtist( p_meta, header.author );
261 vlc_meta_SetCopyright( p_meta, header.copyright );
262 p_sys->i_tracks = p_emu->track_count();
271 p_sys->i_tracks = p_emu->track_count();
280 snprintf( psz_temp, 511, "%s (%s)", header.song, header.game );
281 vlc_meta_SetTitle( p_meta, psz_temp );
282 vlc_meta_SetArtist( p_meta, header.author );
283 p_sys->i_tracks = p_emu->track_count();
292 snprintf( psz_temp, 511, "%s (%s)", header.song, header.game );
293 vlc_meta_SetTitle( p_meta, psz_temp );
294 vlc_meta_SetCopyright( p_meta, header.copyright );
295 p_sys->i_tracks = p_emu->track_count();
301 if( p_error != NULL )
303 msg_Err( p_demux, "failed to understand the file : %s", p_error );
304 /* we try to seek to recover for other plugin */
305 stream_Seek( p_demux->s, 0 );
306 free( p_sys->p_data );
313 p_sys->i_length = 314 * (int64_t)1000;
315 msg_Dbg( p_demux, "GME loaded type=%s title=%s tracks=%i", type_str[p_sys->i_type],
316 vlc_meta_GetValue( p_sys->p_meta, VLC_META_TITLE ), p_sys->i_tracks );
318 p_sys->p_musicemu->start_track( 0 );
320 #ifdef WORDS_BIGENDIAN
321 es_format_Init( &p_sys->fmt, AUDIO_ES, VLC_FOURCC( 't', 'w', 'o', 's' ) );
323 es_format_Init( &p_sys->fmt, AUDIO_ES, VLC_FOURCC( 'a', 'r', 'a', 'w' ) );
325 p_sys->fmt.audio.i_rate = 44100;
326 p_sys->fmt.audio.i_channels = 2;
327 p_sys->fmt.audio.i_bitspersample = 16;
328 p_sys->es = es_out_Add( p_demux->out, &p_sys->fmt );
333 /*****************************************************************************
335 *****************************************************************************/
336 static void Close( vlc_object_t *p_this )
338 demux_t *p_demux = (demux_t*)p_this;
339 demux_sys_t *p_sys = p_demux->p_sys;
341 delete p_sys->p_musicemu;
342 delete p_sys->p_reader;
344 free( p_sys->p_data );
349 /*****************************************************************************
351 *****************************************************************************/
352 static int Demux( demux_t *p_demux )
354 demux_sys_t *p_sys = p_demux->p_sys;
356 int i_bk = ( p_sys->fmt.audio.i_bitspersample / 8 ) *
357 p_sys->fmt.audio.i_channels;
358 const unsigned int i_buf = p_sys->fmt.audio.i_rate / 10 * i_bk;
359 const unsigned int i_emubuf = i_buf / sizeof(Music_Emu::sample_t);
360 const char * p_error;
361 Music_Emu::sample_t p_emubuf [i_emubuf];
363 p_frame = block_New( p_demux, i_buf );
365 p_sys->p_musicemu->play( i_emubuf, p_emubuf );
368 if( p_error != NULL )
370 msg_Dbg( p_demux, "stop playing : %s", p_error );
371 block_Release( p_frame );
376 /* Copy emulator output to frame */
377 for (int i = 0; i<i_buf; i++) p_frame->p_buffer[i] = ((uint8_t *)p_emubuf)[i];
380 es_out_Control( p_demux->out, ES_OUT_SET_PCR, VLC_TS_0 + p_sys->i_time );
381 p_frame->i_dts = p_frame->i_pts = VLC_TS_0 + p_sys->i_time;
383 /* We should use p_frame->i_buffer */
384 p_sys->i_time += (int64_t)1000000 * p_frame->i_buffer / i_bk / p_sys->fmt.audio.i_rate;
387 es_out_Send( p_demux->out, p_sys->es, p_frame );
392 /*****************************************************************************
394 *****************************************************************************/
395 static int Control( demux_t *p_demux, int i_query, va_list args )
397 demux_sys_t *p_sys = p_demux->p_sys;
401 vlc_meta_t **pp_meta;
406 pp_meta = (vlc_meta_t **)va_arg( args, vlc_meta_t** );
408 *pp_meta = vlc_meta_Duplicate( p_sys->p_meta );
413 case DEMUX_GET_POSITION:
414 pf = (double*) va_arg( args, double* );
415 if( p_sys->i_length > 0 )
417 *pf = (double)p_sys->i_time / (double)p_sys->i_length;
422 case DEMUX_SET_POSITION:
423 f = (double) va_arg( args, double );
425 i64 = f * p_sys->i_length;
426 if( i64 >= 0 && i64 <= p_sys->i_length )
428 ModPlug_Seek( p_sys->f, i64 / 1000 );
436 pi64 = (int64_t*)va_arg( args, int64_t * );
437 *pi64 = p_sys->i_time;
440 case DEMUX_GET_LENGTH:
441 pi64 = (int64_t*)va_arg( args, int64_t * );
442 *pi64 = p_sys->i_length;
446 i64 = (int64_t)va_arg( args, int64_t );
448 if( i64 >= 0 && i64 <= p_sys->i_length )
450 ModPlug_Seek( p_sys->f, i64 / 1000 );
457 case DEMUX_GET_TITLE_INFO:
458 if( p_sys->i_tracks > 1 )
460 input_title_t ***ppp_title = (input_title_t***)va_arg( args, input_title_t*** );
461 int *pi_int = (int*)va_arg( args, int* );
463 *pi_int = p_sys->i_tracks;
464 *ppp_title = (input_title_t**)xmalloc( sizeof( input_title_t**) * p_sys->i_tracks );
466 for( int i = 0; i < p_sys->i_tracks; i++ )
469 snprintf(psz_temp, 15, "Track %i", i);
470 (*ppp_title)[i] = vlc_input_title_New();
471 (*ppp_title)[i]->psz_name = strdup(psz_temp);
479 case DEMUX_SET_TITLE:
480 i_idx = (int)va_arg( args, int );
481 p_sys->p_musicemu->start_track( i_idx );
482 p_demux->info.i_title = i_idx;
483 p_demux->info.i_update = INPUT_UPDATE_TITLE;
484 msg_Dbg( p_demux, "set title %i", i_idx);
487 case DEMUX_GET_FPS: /* meaningless */
495 static void inflate_gzbuf(uint8_t * p_buffer, size_t i_size, uint8_t ** pp_obuffer, size_t * pi_osize)
499 size_t offset, out_size;
500 uint8_t * out_buffer;
502 (*pp_obuffer) = NULL;
505 memset(&z_str, 0, sizeof(z_str));
507 out_size = i_size * 2;
508 out_buffer = (uint8_t*)xmalloc(out_size);
510 z_str.next_in = (unsigned char*)p_buffer;
511 z_str.avail_in = i_size;
512 z_str.next_out = out_buffer;
513 z_str.avail_out = out_size;
515 if ((err = inflateInit2(&z_str, 31)) != Z_OK) /* gzip format */
521 while ((err = inflate(&z_str, Z_FINISH)) != Z_STREAM_END)
528 offset = z_str.next_out - out_buffer;
530 out_buffer = (uint8_t *)xrealloc(out_buffer, out_size);
531 z_str.next_out = out_buffer + offset;
532 z_str.avail_out = out_size - offset;
541 (*pi_osize) = out_size - z_str.avail_out;
545 out_buffer = (uint8_t *)xrealloc(out_buffer, *pi_osize);
546 (*pp_obuffer) = out_buffer;