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 *****************************************************************************/
46 /*****************************************************************************
48 *****************************************************************************/
49 static int Open ( vlc_object_t * );
50 static void Close ( vlc_object_t * );
53 set_shortname( "GME");
54 set_description( _("GME demuxer (Game_Music_Emu)" ) );
55 set_capability( "demux2", 10 );
56 set_category( CAT_INPUT );
57 set_subcategory( SUBCAT_INPUT_DEMUX );
58 set_callbacks( Open, Close );
59 add_shortcut( "gme" );
62 /*****************************************************************************
64 *****************************************************************************/
75 static const char* type_str[] =
77 "NSF (Nes)", "GBS (Gameboy)", "VGM (Master System/Game Gear/Genesis)", "SPC (Super Nes)", "GYM (Genesis)"
92 Music_Emu *p_musicemu;
93 Emu_Mem_Reader *p_reader;
97 static int Demux ( demux_t *p_demux );
98 static int Control( demux_t *p_demux, int i_query, va_list args );
101 static void inflate_gzbuf(uint8_t * p_buffer, size_t i_size, uint8_t ** pp_obuffer, size_t * pi_osize);
104 static const char* gme_ext[] =
106 "nsf", "nsfe", "gbs", "vgm", "vgz", "spc", "gym", NULL
109 /*****************************************************************************
111 *****************************************************************************/
112 static int Open( vlc_object_t *p_this )
114 demux_t *p_demux = (demux_t*)p_this;
120 /* We accept file based on extention match */
121 if( !p_demux->b_force )
123 if( ( ext = strrchr( p_demux->psz_path, '.' ) ) == NULL ||
124 stream_Size( p_demux->s ) == 0 ) return VLC_EGENERIC;
127 for( i = 0; gme_ext[i] != NULL; i++ )
129 if( !strcasecmp( ext, gme_ext[i] ) )
134 if( gme_ext[i] == NULL ) return VLC_EGENERIC;
135 msg_Dbg( p_demux, "running GME demuxer (ext=%s)", gme_ext[i] );
139 if (i == 4) /* gzipped vgm */
141 msg_Dbg( p_demux, "zlib unvailable, unable to read gzipped vgz file" );
146 /* Fill p_demux field */
147 p_demux->pf_demux = Demux;
148 p_demux->pf_control = Control;
149 p_demux->p_sys = p_sys = (demux_sys_t *)malloc( sizeof( demux_sys_t ) );
151 msg_Dbg( p_demux, "loading complete file (could be long)" );
152 p_sys->i_data = stream_Size( p_demux->s );
153 p_sys->p_data = (uint8_t *)malloc( p_sys->i_data );
154 p_sys->i_data = stream_Read( p_demux->s, p_sys->p_data, p_sys->i_data );
155 if( p_sys->i_data <= 0 )
157 msg_Err( p_demux, "failed to read the complete file" );
158 free( p_sys->p_data );
163 /* Prepare emulator */
166 if (i == 4) /* gzipped vgm */
168 uint8_t * p_outbuffer;
171 inflate_gzbuf( p_sys->p_data, p_sys->i_data, &p_outbuffer, &i_outsize );
173 if (p_outbuffer == NULL)
175 msg_Err( p_demux, "failed to understand the file : unable to inflate vgz file" );
176 /* we try to seek to recover for other plugin */
177 stream_Seek( p_demux->s, 0 );
178 free( p_sys->p_data );
185 p_sys->p_data = p_outbuffer;
186 p_sys->i_data = i_outsize;
190 p_sys->p_reader = new Emu_Mem_Reader( p_sys->p_data, p_sys->i_data );
196 p_sys->i_type = EMU_NSF;
199 p_sys->i_type = EMU_GBS;
203 p_sys->i_type = EMU_VGM;
206 p_sys->i_type = EMU_SPC;
209 p_sys->i_type = EMU_GYM;
213 /* Emulator specific initialization */
215 #define INIT_EMU(type) \
216 type##_Emu::header_t header; \
217 type##_Emu * p_emu = new type##_Emu; \
218 p_emu->init( 44100 ); \
219 p_sys->p_musicemu = p_emu; \
220 p_sys->p_reader->read( &header, sizeof(header) ); \
221 p_error = p_emu->load( header, *(p_sys->p_reader) );
223 p_sys->p_meta = vlc_meta_New();
227 /// \todo Reinstate meta codec name
228 //SET_META( VLC_META_CODEC_NAME, type_str[p_sys->i_type])
230 const char * p_error;
232 switch(p_sys->i_type)
239 vlc_meta_SetTitle( p_meta, header.game );
240 vlc_meta_SetArtist( p_meta, header.author );
241 vlc_meta_SetCopyright( p_meta, header.copyright );
242 p_sys->i_tracks = p_emu->track_count();
251 vlc_meta_SetTitle( p_meta, header.game );
252 vlc_meta_SetArtist( p_meta, header.author );
253 vlc_meta_SetCopyright( p_meta, header.copyright );
254 p_sys->i_tracks = p_emu->track_count();
263 p_sys->i_tracks = p_emu->track_count();
272 snprintf( psz_temp, 511, "%s (%s)", header.song, header.game );
273 vlc_meta_SetTitle( p_meta, psz_temp );
274 vlc_meta_SetArtist( p_meta, header.author );
275 p_sys->i_tracks = p_emu->track_count();
284 snprintf( psz_temp, 511, "%s (%s)", header.song, header.game );
285 vlc_meta_SetTitle( p_meta, psz_temp );
286 vlc_meta_SetCopyright( p_meta, header.copyright );
287 p_sys->i_tracks = p_emu->track_count();
293 if( p_error != NULL )
295 msg_Err( p_demux, "failed to understand the file : %s", p_error );
296 /* we try to seek to recover for other plugin */
297 stream_Seek( p_demux->s, 0 );
298 free( p_sys->p_data );
305 p_sys->i_length = 314 * (int64_t)1000;
307 msg_Dbg( p_demux, "GME loaded type=%s title=%s tracks=%i", type_str[p_sys->i_type],
308 vlc_meta_GetValue( p_sys->p_meta, VLC_META_TITLE ), p_sys->i_tracks );
310 p_sys->p_musicemu->start_track( 0 );
312 #ifdef WORDS_BIGENDIAN
313 es_format_Init( &p_sys->fmt, AUDIO_ES, VLC_FOURCC( 't', 'w', 'o', 's' ) );
315 es_format_Init( &p_sys->fmt, AUDIO_ES, VLC_FOURCC( 'a', 'r', 'a', 'w' ) );
317 p_sys->fmt.audio.i_rate = 44100;
318 p_sys->fmt.audio.i_channels = 2;
319 p_sys->fmt.audio.i_bitspersample = 16;
320 p_sys->es = es_out_Add( p_demux->out, &p_sys->fmt );
325 /*****************************************************************************
327 *****************************************************************************/
328 static void Close( vlc_object_t *p_this )
330 demux_t *p_demux = (demux_t*)p_this;
331 demux_sys_t *p_sys = p_demux->p_sys;
333 delete p_sys->p_musicemu;
334 delete p_sys->p_reader;
336 free( p_sys->p_data );
341 /*****************************************************************************
343 *****************************************************************************/
344 static int Demux( demux_t *p_demux )
346 demux_sys_t *p_sys = p_demux->p_sys;
348 int i_bk = ( p_sys->fmt.audio.i_bitspersample / 8 ) *
349 p_sys->fmt.audio.i_channels;
350 const unsigned int i_buf = p_sys->fmt.audio.i_rate / 10 * i_bk;
351 const unsigned int i_emubuf = i_buf / sizeof(Music_Emu::sample_t);
352 const char * p_error;
353 Music_Emu::sample_t p_emubuf [i_emubuf];
355 p_frame = block_New( p_demux, i_buf );
357 p_sys->p_musicemu->play( i_emubuf, p_emubuf );
360 if( p_error != NULL )
362 msg_Dbg( p_demux, "stop playing : %s", p_error );
363 block_Release( p_frame );
368 /* Copy emulator output to frame */
369 for (int i = 0; i<i_buf; i++) p_frame->p_buffer[i] = ((uint8_t *)p_emubuf)[i];
372 es_out_Control( p_demux->out, ES_OUT_SET_PCR, (int64_t)p_sys->i_time );
374 /* We should use p_frame->i_buffer */
375 p_sys->i_time += (int64_t)1000000 * p_frame->i_buffer / i_bk / p_sys->fmt.audio.i_rate;
378 p_frame->i_dts = p_frame->i_pts = p_sys->i_time;
379 es_out_Send( p_demux->out, p_sys->es, p_frame );
384 /*****************************************************************************
386 *****************************************************************************/
387 static int Control( demux_t *p_demux, int i_query, va_list args )
389 demux_sys_t *p_sys = p_demux->p_sys;
393 vlc_meta_t **pp_meta;
398 pp_meta = (vlc_meta_t **)va_arg( args, vlc_meta_t** );
400 *pp_meta = vlc_meta_Duplicate( p_sys->p_meta );
405 case DEMUX_GET_POSITION:
406 pf = (double*) va_arg( args, double* );
407 if( p_sys->i_length > 0 )
409 *pf = (double)p_sys->i_time / (double)p_sys->i_length;
414 case DEMUX_SET_POSITION:
415 f = (double) va_arg( args, double );
417 i64 = f * p_sys->i_length;
418 if( i64 >= 0 && i64 <= p_sys->i_length )
420 ModPlug_Seek( p_sys->f, i64 / 1000 );
421 p_sys->i_time = i64 + 1;
422 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
429 pi64 = (int64_t*)va_arg( args, int64_t * );
430 *pi64 = p_sys->i_time;
433 case DEMUX_GET_LENGTH:
434 pi64 = (int64_t*)va_arg( args, int64_t * );
435 *pi64 = p_sys->i_length;
439 i64 = (int64_t)va_arg( args, int64_t );
441 if( i64 >= 0 && i64 <= p_sys->i_length )
443 ModPlug_Seek( p_sys->f, i64 / 1000 );
444 p_sys->i_time = i64 + 1;
445 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
451 case DEMUX_GET_TITLE_INFO:
452 if( p_sys->i_tracks > 1 )
454 input_title_t ***ppp_title = (input_title_t***)va_arg( args, input_title_t*** );
455 int *pi_int = (int*)va_arg( args, int* );
457 *pi_int = p_sys->i_tracks;
458 *ppp_title = (input_title_t**)malloc( sizeof( input_title_t**) * p_sys->i_tracks );
460 for( int i = 0; i < p_sys->i_tracks; i++ )
463 snprintf(psz_temp, 15, "Track %i", i);
464 (*ppp_title)[i] = vlc_input_title_New();
465 (*ppp_title)[i]->psz_name = strdup(psz_temp);
473 case DEMUX_SET_TITLE:
474 i_idx = (int)va_arg( args, int );
475 p_sys->p_musicemu->start_track( i_idx );
476 p_demux->info.i_title = i_idx;
477 p_demux->info.i_update = INPUT_UPDATE_TITLE;
478 msg_Dbg( p_demux, "set title %i", i_idx);
481 case DEMUX_GET_FPS: /* meaningless */
489 static void inflate_gzbuf(uint8_t * p_buffer, size_t i_size, uint8_t ** pp_obuffer, size_t * pi_osize)
493 size_t offset, out_size;
494 uint8_t * out_buffer;
496 (*pp_obuffer) = NULL;
499 memset(&z_str, 0, sizeof(z_str));
501 out_size = i_size * 2;
502 out_buffer = (uint8_t*)malloc(out_size);
504 z_str.next_in = (unsigned char*)p_buffer;
505 z_str.avail_in = i_size;
506 z_str.next_out = out_buffer;
507 z_str.avail_out = out_size;
509 if ((err = inflateInit2(&z_str, 31)) != Z_OK) /* gzip format */
515 while ((err = inflate(&z_str, Z_FINISH)) != Z_STREAM_END)
522 offset = z_str.next_out - out_buffer;
524 out_buffer = (uint8_t *)realloc(out_buffer, out_size);
525 z_str.next_out = out_buffer + offset;
526 z_str.avail_out = out_size - offset;
535 (*pi_osize) = out_size - z_str.avail_out;
539 out_buffer = (uint8_t *)realloc(out_buffer, *pi_osize);
540 (*pp_obuffer) = out_buffer;