?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
demux: libavi: remove useless member
[vlc.git] / modules / demux / mod.c
blob368a63ccd2f8fe30e064d21323eec591a2fd301f
1 /*****************************************************************************
2 * mod.c: MOD file demuxer (using libmodplug)
3 *****************************************************************************
4 * Copyright (C) 2004-2009 VLC authors and VideoLAN
5 * $Id$
6 *
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8 * Konstanty Bialkowski <konstanty@ieee.org>
9 *
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Lesser General Public License for more details.
19 *
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
24
25 /*****************************************************************************
26 * Preamble
27 *****************************************************************************/
28
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_demux.h>
36 #include <vlc_meta.h>
37 #include <vlc_charset.h>
38 #include <assert.h>
39
40 #include <libmodplug/modplug.h>
41
42 /* TODO:
43 * - extend demux control to query meta data (demuxer should NEVER touch
44 * playlist itself)
45 * - FIXME test endian of samples
46 * - ...
47 */
48
49 /*****************************************************************************
50 * Module descriptor
51 *****************************************************************************/
52 static int Open ( vlc_object_t * );
53 static void Close ( vlc_object_t * );
54
55 #define NOISE_LONGTEXT N_("Enable noise reduction algorithm.")
56 #define REVERB_LONGTEXT N_("Enable reverberation" )
57 #define REVERB_LEVEL_LONGTEXT N_( "Reverberation level (from 0 " \
58 "to 100, default value is 0)." )
59 #define REVERB_DELAY_LONGTEXT N_("Reverberation delay, in ms." \
60 " Usual values are from 40 to 200ms." )
61 #define MEGABASS_LONGTEXT N_( "Enable megabass mode" )
62 #define MEGABASS_LEVEL_LONGTEXT N_("Megabass mode level (from 0 to 100, " \
63 "default value is 0)." )
64 #define MEGABASS_RANGE_LONGTEXT N_("Megabass mode cutoff frequency, in Hz. " \
65 "This is the maximum frequency for which the megabass " \
66 "effect applies. Valid values are from 10 to 100 Hz." )
67 #define SURROUND_LEVEL_LONGTEXT N_( "Surround effect level (from 0 to 100, " \
68 "default value is 0)." )
69 #define SURROUND_DELAY_LONGTEXT N_("Surround delay, in ms. Usual values are " \
70 "from 5 to 40 ms." )
71
72 vlc_module_begin ()
73 set_shortname( "MOD")
74 set_description( N_("MOD demuxer (libmodplug)" ) )
75 set_capability( "demux", 10 )
76 set_category( CAT_INPUT )
77 set_subcategory( SUBCAT_INPUT_DEMUX )
78
79 add_bool( "mod-noisereduction", true, N_("Noise reduction"),
80 NOISE_LONGTEXT, false )
81
82 add_bool( "mod-reverb", false, N_("Reverb"),
83 REVERB_LONGTEXT, false )
84 add_integer_with_range( "mod-reverb-level", 0, 0, 100,
85 N_("Reverberation level"), REVERB_LEVEL_LONGTEXT, true )
86 add_integer_with_range( "mod-reverb-delay", 40, 0, 1000,
87 N_("Reverberation delay"), REVERB_DELAY_LONGTEXT, true )
88
89 add_bool( "mod-megabass", false, N_("Mega bass"),
90 MEGABASS_LONGTEXT, false )
91 add_integer_with_range( "mod-megabass-level", 0, 0, 100,
92 N_("Mega bass level"), MEGABASS_LEVEL_LONGTEXT, true )
93 add_integer_with_range( "mod-megabass-range", 10, 10, 100,
94 N_("Mega bass cutoff"), MEGABASS_RANGE_LONGTEXT, true )
95
96 add_bool( "mod-surround", false, N_("Surround"), N_("Surround"),
97 false )
98 add_integer_with_range( "mod-surround-level", 0, 0, 100,
99 N_("Surround level"), SURROUND_LEVEL_LONGTEXT, true )
100 add_integer_with_range( "mod-surround-delay", 5, 0, 1000,
101 N_("Surround delay (ms)"), SURROUND_DELAY_LONGTEXT, true )
102
103 set_callbacks( Open, Close )
104 add_shortcut( "mod" )
105 vlc_module_end ()
106
107 /*****************************************************************************
108 * Local prototypes
109 *****************************************************************************/
110 static vlc_mutex_t libmodplug_lock = VLC_STATIC_MUTEX;
111
112 struct demux_sys_t
113 {
114 es_format_t fmt;
115 es_out_id_t *es;
116
117 date_t pts;
118 int64_t i_length;
119
120 int i_data;
121 uint8_t *p_data;
122 ModPlugFile *f;
123 };
124
125 static int Demux ( demux_t *p_demux );
126 static int Control( demux_t *p_demux, int i_query, va_list args );
127
128 static int Validate( demux_t *p_demux, const char *psz_ext );
129
130 /* We load the complete file in memory, put a higher bound
131 * of 500 Mo (which is really big anyway) */
132 #define MOD_MAX_FILE_SIZE (500*1000*1000)
133
134 /*****************************************************************************
135 * Open
136 *****************************************************************************/
137 static int Open( vlc_object_t *p_this )
138 {
139 demux_t *p_demux = (demux_t*)p_this;
140 demux_sys_t *p_sys;
141 ModPlug_Settings settings;
142
143 /* We accept file based on extension match */
144 if( !p_demux->obj.force )
145 {
146 const char *psz_ext = p_demux->psz_file ? strrchr( p_demux->psz_file, '.' )
147 : NULL;
148 if( psz_ext )
149 psz_ext++;
150
151 if( Validate( p_demux, psz_ext ) )
152 {
153 msg_Dbg( p_demux, "MOD validation failed (ext=%s)", psz_ext ? psz_ext : "");
154 return VLC_EGENERIC;
155 }
156 }
157
158 const int64_t i_size = stream_Size( p_demux->s );
159 if( i_size <= 0 || i_size >= MOD_MAX_FILE_SIZE )
160 return VLC_EGENERIC;
161
162 /* Fill p_demux field */
163 p_demux->pf_demux = Demux;
164 p_demux->pf_control = Control;
165 p_demux->p_sys = p_sys = malloc( sizeof( *p_sys ) );
166 if( !p_sys )
167 return VLC_ENOMEM;
168
169 msg_Dbg( p_demux, "loading complete file (could be long)" );
170 p_sys->i_data = i_size;
171 p_sys->p_data = malloc( p_sys->i_data );
172 if( p_sys->p_data )
173 p_sys->i_data = vlc_stream_Read( p_demux->s, p_sys->p_data,
174 p_sys->i_data );
175 if( p_sys->i_data <= 0 || !p_sys->p_data )
176 {
177 msg_Err( p_demux, "failed to read the complete file" );
178 free( p_sys->p_data );
179 free( p_sys );
180 return VLC_EGENERIC;
181 }
182
183 /* Configure modplug before loading the file */
184 vlc_mutex_lock( &libmodplug_lock );
185 ModPlug_GetSettings( &settings );
186 settings.mFlags = MODPLUG_ENABLE_OVERSAMPLING;
187 settings.mChannels = 2;
188 settings.mBits = 16;
189 settings.mFrequency = 44100;
190 settings.mResamplingMode = MODPLUG_RESAMPLE_FIR;
191
192 if( var_InheritBool( p_demux, "mod-noisereduction" ) )
193 settings.mFlags |= MODPLUG_ENABLE_NOISE_REDUCTION;
194
195 if( var_InheritBool( p_demux, "mod-reverb" ) )
196 settings.mFlags |= MODPLUG_ENABLE_REVERB;
197 settings.mReverbDepth = var_InheritInteger( p_demux, "mod-reverb-level" );
198 settings.mReverbDelay = var_InheritInteger( p_demux, "mod-reverb-delay" );
199
200 if( var_InheritBool( p_demux, "mod-megabass" ) )
201 settings.mFlags |= MODPLUG_ENABLE_MEGABASS;
202 settings.mBassAmount = var_InheritInteger( p_demux, "mod-megabass-level" );
203 settings.mBassRange = var_InheritInteger( p_demux, "mod-megabass-range" );
204
205 if( var_InheritBool( p_demux, "mod-surround" ) )
206 settings.mFlags |= MODPLUG_ENABLE_SURROUND;
207 settings.mSurroundDepth = var_InheritInteger( p_demux, "mod-surround-level" );
208 settings.mSurroundDelay = var_InheritInteger( p_demux, "mod-surround-delay" );
209
210 ModPlug_SetSettings( &settings );
211
212 p_sys->f = ModPlug_Load( p_sys->p_data, p_sys->i_data );
213 vlc_mutex_unlock( &libmodplug_lock );
214
215 if( !p_sys->f )
216 {
217 msg_Err( p_demux, "failed to understand the file" );
218 free( p_sys->p_data );
219 free( p_sys );
220 return VLC_EGENERIC;
221 }
222
223 /* init time */
224 date_Init( &p_sys->pts, settings.mFrequency, 1 );
225 date_Set( &p_sys->pts, 0 );
226 p_sys->i_length = ModPlug_GetLength( p_sys->f ) * INT64_C(1000);
227
228 msg_Dbg( p_demux, "MOD loaded name=%s length=%"PRId64"ms",
229 ModPlug_GetName( p_sys->f ),
230 p_sys->i_length );
231
232 #ifdef WORDS_BIGENDIAN
233 es_format_Init( &p_sys->fmt, AUDIO_ES, VLC_FOURCC( 't', 'w', 'o', 's' ) );
234 #else
235 es_format_Init( &p_sys->fmt, AUDIO_ES, VLC_FOURCC( 'a', 'r', 'a', 'w' ) );
236 #endif
237 p_sys->fmt.audio.i_rate = settings.mFrequency;
238 p_sys->fmt.audio.i_channels = settings.mChannels;
239 p_sys->fmt.audio.i_bitspersample = settings.mBits;
240 p_sys->es = es_out_Add( p_demux->out, &p_sys->fmt );
241
242 return VLC_SUCCESS;
243 }
244
245 /*****************************************************************************
246 * Close
247 *****************************************************************************/
248 static void Close( vlc_object_t *p_this )
249 {
250 demux_t *p_demux = (demux_t*)p_this;
251 demux_sys_t *p_sys = p_demux->p_sys;
252
253 ModPlug_Unload( p_sys->f );
254 free( p_sys->p_data );
255 free( p_sys );
256 }
257
258
259 /*****************************************************************************
260 * Demux:
261 *****************************************************************************/
262 static int Demux( demux_t *p_demux )
263 {
264 demux_sys_t *p_sys = p_demux->p_sys;
265 block_t *p_frame;
266 const int i_bk = ( p_sys->fmt.audio.i_bitspersample / 8 ) *
267 p_sys->fmt.audio.i_channels;
268
269 p_frame = block_Alloc( p_sys->fmt.audio.i_rate / 10 * i_bk );
270 if( !p_frame )
271 return -1;
272
273 const int i_read = ModPlug_Read( p_sys->f, p_frame->p_buffer, p_frame->i_buffer );
274 if( i_read <= 0 )
275 {
276 /* EOF */
277 block_Release( p_frame );
278 return 0;
279 }
280 p_frame->i_buffer = i_read;
281 p_frame->i_dts =
282 p_frame->i_pts = VLC_TS_0 + date_Get( &p_sys->pts );
283
284 /* Set PCR */
285 es_out_SetPCR( p_demux->out, p_frame->i_pts );
286
287 /* Send data */
288 es_out_Send( p_demux->out, p_sys->es, p_frame );
289
290 date_Increment( &p_sys->pts, i_read / i_bk );
291
292 return 1;
293 }
294
295 /*****************************************************************************
296 * Control:
297 *****************************************************************************/
298 static int Control( demux_t *p_demux, int i_query, va_list args )
299 {
300 demux_sys_t *p_sys = p_demux->p_sys;
301 double f, *pf;
302 int64_t i64, *pi64;
303
304 switch( i_query )
305 {
306 case DEMUX_CAN_SEEK:
307 *va_arg( args, bool * ) = true;
308 return VLC_SUCCESS;
309
310 case DEMUX_GET_POSITION:
311 pf = va_arg( args, double* );
312 if( p_sys->i_length > 0 )
313 {
314 double current = date_Get( &p_sys->pts );
315 double length = p_sys->i_length;
316 *pf = current / length;
317 return VLC_SUCCESS;
318 }
319 return VLC_EGENERIC;
320
321 case DEMUX_SET_POSITION:
322 f = va_arg( args, double );
323
324 i64 = f * p_sys->i_length;
325 if( i64 >= 0 && i64 <= p_sys->i_length )
326 {
327 ModPlug_Seek( p_sys->f, i64 / 1000 );
328 date_Set( &p_sys->pts, i64 );
329
330 return VLC_SUCCESS;
331 }
332 return VLC_EGENERIC;
333
334 case DEMUX_GET_TIME:
335 pi64 = va_arg( args, int64_t * );
336 *pi64 = date_Get( &p_sys->pts );
337 return VLC_SUCCESS;
338
339 case DEMUX_GET_LENGTH:
340 pi64 = va_arg( args, int64_t * );
341 *pi64 = p_sys->i_length;
342 return VLC_SUCCESS;
343
344 case DEMUX_SET_TIME:
345 i64 = va_arg( args, int64_t );
346
347 if( i64 >= 0 && i64 <= p_sys->i_length )
348 {
349 ModPlug_Seek( p_sys->f, i64 / 1000 );
350 date_Set( &p_sys->pts, i64 );
351
352 return VLC_SUCCESS;
353 }
354 return VLC_EGENERIC;
355
356 case DEMUX_HAS_UNSUPPORTED_META:
357 {
358 bool *pb_bool = va_arg( args, bool* );
359 *pb_bool = false; /* FIXME I am not sure of this one */
360 return VLC_SUCCESS;
361 }
362 case DEMUX_GET_META:
363 {
364 vlc_meta_t *p_meta = va_arg( args, vlc_meta_t * );
365 unsigned i_num_samples = ModPlug_NumSamples( p_sys->f ),
366 i_num_instruments = ModPlug_NumInstruments( p_sys->f );
367 unsigned i_num_patterns = ModPlug_NumPatterns( p_sys->f ),
368 i_num_channels = ModPlug_NumChannels( p_sys->f );
369 // unsigned modType = ModPlug_GetModuleType( p_sys->f );
370
371 char psz_temp[2048]; /* 32 * 240 max, but only need start */
372 char *psz_module_info, *psz_instrument_info;
373 unsigned i_temp_index = 0;
374 const char *psz_name = ModPlug_GetName( p_sys->f );
375 if( psz_name && *psz_name && IsUTF8( psz_name ) )
376 vlc_meta_SetTitle( p_meta, psz_name );
377
378 /* Comment field from artist - not in every type of MOD */
379 psz_name = ModPlug_GetMessage( p_sys->f );
380 if( psz_name && *psz_name && IsUTF8( psz_name ) )
381 vlc_meta_SetDescription( p_meta, psz_name );
382
383 /* Instruments only in newer MODs - so don't show if 0 */
384 if( asprintf( &psz_instrument_info, ", %i Instruments",
385 i_num_instruments ) >= 0 )
386 {
387 if( asprintf( &psz_module_info,
388 "%i Channels, %i Patterns\n"
389 "%i Samples%s\n",
390 i_num_channels, i_num_patterns, i_num_samples,
391 ( i_num_instruments ? psz_instrument_info : "" ) ) >= 0 )
392 {
393 vlc_meta_AddExtra( p_meta, "Module Information",
394 psz_module_info );
395 free( psz_module_info );
396 }
397
398 free( psz_instrument_info );
399 }
400
401 /* Make list of instruments (XM, IT, etc) */
402 if( i_num_instruments )
403 {
404 i_temp_index = 0;
405 for( unsigned i = 0; i < i_num_instruments && i_temp_index < sizeof(psz_temp); i++ )
406 {
407 char lBuffer[33];
408 ModPlug_InstrumentName( p_sys->f, i, lBuffer );
409 if ( !lBuffer[0] || !IsUTF8( lBuffer ) ) continue;
410 i_temp_index += snprintf( &psz_temp[i_temp_index], sizeof(psz_temp) - i_temp_index, "%s\n", lBuffer );
411 }
412
413 vlc_meta_AddExtra( p_meta, "Instruments", psz_temp );
414 }
415
416 /* Make list of samples */
417 for( unsigned int i = 0; i < i_num_samples && i_temp_index < sizeof(psz_temp); i++ )
418 {
419 char psz_buffer[33];
420 ModPlug_SampleName( p_sys->f, i, psz_buffer );
421 if ( !psz_buffer[0] || !IsUTF8( psz_buffer ) ) continue;
422 i_temp_index += snprintf( &psz_temp[i_temp_index], sizeof(psz_temp) - i_temp_index, "%s\n", psz_buffer );
423 }
424
425 vlc_meta_AddExtra( p_meta, "Samples", psz_temp );
426
427 return VLC_SUCCESS;
428 }
429
430 case DEMUX_GET_FPS: /* meaningless */
431 default:
432 return VLC_EGENERIC;
433 }
434 }
435
436 /*****************************************************************************
437 * Validate: try to ensure it is really a mod file.
438 * The tests are not robust enough to replace extension checks in the general
439 * cases.
440 * TODO: maybe it should return a score, which will be used to bypass the
441 * extension checks when high enough.
442 *****************************************************************************/
443 static int Validate( demux_t *p_demux, const char *psz_ext )
444 {
445 static const struct
446 {
447 int i_offset;
448 const char *psz_marker;
449 } p_marker[] = {
450 { 0, "ziRCONia" }, /* MMCMP files */
451 { 0, "Extended Module" }, /* XM */
452 { 44, "SCRM" }, /* S3M */
453 { 0, "IMPM" }, /* IT */
454 { 0, "GF1PATCH110" }, /* PAT */
455 { 20, "!SCREAM!" }, /* STM */
456 { 20, "!Scream!" }, /* STM */
457 { 20, "BMOD2STM" }, /* STM */
458 { 0, "MMD0" }, /* MED v0 */
459 { 0, "MMD1" }, /* MED v1 */
460 { 0, "MMD2" }, /* MED v2 */
461 { 0, "MMD3" }, /* MED v3 */
462 { 0, "MTM" }, /* MTM */
463 { 0, "DMDL" }, /* MDL */
464 { 0, "DBM0" }, /* DBM */
465 { 0, "if" }, /* 669 */
466 { 0, "JN" }, /* 669 */
467 { 0, "FAR\xfe" }, /* FAR */
468 { 0, "Extreme" }, /* AMS */
469 { 0, "OKTASONGCMOD" }, /* OKT */
470 { 44, "PTMF" }, /* PTM */
471 { 0, "MAS_UTrack_V00" }, /* Ult */
472 { 0, "DDMF" }, /* DMF */
473 { 8, "DSMFSONG" }, /* DSM */
474 { 0, "\xc1\x83\x2a\x9e" }, /* UMX */
475 { 0, "ASYLUM Music Format V1.0" }, /* AMF Type 0 */
476 { 0, "AMF" }, /* AMF */
477 { 0, "PSM\xfe" }, /* PSM */
478 { 0, "PSM " }, /* PSM */
479 { 0, "MT20" }, /* MT2 */
480
481 { 1080, "M.K." }, /* MOD */
482 { 1080, "M!K!" },
483 { 1080, "M&K!" },
484 { 1080, "N.T." },
485 { 1080, "CD81" },
486 { 1080, "OKTA" },
487 { 1080, "16CN" },
488 { 1080, "32CN" },
489 { 1080, "FLT4" },
490 { 1080, "FLT8" },
491 { 1080, "6CHN" },
492 { 1080, "8CHN" },
493 { 1080, "FLT" },
494 { 1080, "TDZ" },
495 { 1081, "CHN" },
496 { 1082, "CH" },
497
498 { -1, NULL }
499 };
500 static const char *ppsz_mod_ext[] =
501 {
502 "mod", "s3m", "xm", "it", "669", "amf", "ams", "dbm", "dmf", "dsm",
503 "far", "mdl", "med", "mtm", "okt", "ptm", "stm", "ult", "umx", "mt2",
504 "psm", "abc", NULL
505 };
506 bool has_valid_extension = false;
507 if( psz_ext )
508 {
509 for( int i = 0; ppsz_mod_ext[i] != NULL; i++ )
510 {
511 has_valid_extension |= !strcasecmp( psz_ext, ppsz_mod_ext[i] );
512 if( has_valid_extension )
513 break;
514 }
515 }
516
517 const uint8_t *p_peek;
518 const int i_peek = vlc_stream_Peek( p_demux->s, &p_peek, 2048 );
519 if( i_peek < 4 )
520 return VLC_EGENERIC;
521
522 for( int i = 0; p_marker[i].i_offset >= 0; i++ )
523 {
524 const char *psz_marker = p_marker[i].psz_marker;
525 const int i_size = strlen( psz_marker );
526 const int i_offset = p_marker[i].i_offset;
527
528 if( i_peek < i_offset + i_size )
529 continue;
530
531 if( !memcmp( &p_peek[i_offset], psz_marker, i_size ) )
532 {
533 if( i_size >= 4 || has_valid_extension )
534 return VLC_SUCCESS;
535 }
536 }
537
538 /* The only two format left untested are ABC and MOD(old version)
539 * ant they are difficult to test :( */
540
541 /* Check for ABC
542 * TODO i_peek = 2048 is too big for such files */
543 if( psz_ext && !strcasecmp( psz_ext, "abc" ) )
544 {
545 bool b_k = false;
546 bool b_tx = false;
547
548 for( int i = 0; i < i_peek-1; i++ )
549 {
550 b_k |= p_peek[i+0] == 'K' && p_peek[i+1] == ':';
551 b_tx |= ( p_peek[i+0] == 'X' || p_peek[i+0] == 'T') && p_peek[i+1] == ':';
552 }
553 if( !b_k || !b_tx )
554 return VLC_EGENERIC;
555 return VLC_SUCCESS;
556 }
557
558 /* Check for MOD */
559 if( psz_ext && !strcasecmp( psz_ext, "mod" ) && i_peek >= 20 + 15 * 30 )
560 {
561 /* Check that the name is correctly null padded */
562 const uint8_t *p = memchr( p_peek, '\0', 20 );
563 if( p )
564 {
565 for( ; p < &p_peek[20]; p++ )
566 {
567 if( *p )
568 return VLC_EGENERIC;
569 }
570 }
571
572 for( int i = 0; i < 15; i++ )
573 {
574 const uint8_t *p_sample = &p_peek[20 + i*30];
575
576 /* Check correct null padding */
577 p = memchr( &p_sample[0], '\0', 22 );
578 if( p )
579 {
580 for( ; p < &p_sample[22]; p++ )
581 {
582 if( *p )
583 return VLC_EGENERIC;
584 }
585 }
586
587 if( p_sample[25] > 64 ) /* Volume value */
588 return VLC_EGENERIC;
589 }
590 return VLC_SUCCESS;
591 }
592 return VLC_EGENERIC;
593 }
VLC Development tree mirror