Added a few sanity checks to mod.
[vlc.git] / modules / demux / mod.c
1 /*****************************************************************************
2  * mod.c: MOD file demuxer (using libmodplug)
3  *****************************************************************************
4  * Copyright (C) 2004-2009 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_demux.h>
35
36 #include <libmodplug/modplug.h>
37
38 /* TODO:
39  *  - extend demux control to query meta data (demuxer should NEVER touch
40  *      playlist itself)
41  *  - FIXME test endian of samples
42  *  - ...
43  */
44
45 /*****************************************************************************
46  * Module descriptor
47  *****************************************************************************/
48 static int  Open    ( vlc_object_t * );
49 static void Close  ( vlc_object_t * );
50
51 #define NOISE_LONGTEXT N_("Enable noise reduction algorithm.")
52 #define REVERB_LONGTEXT N_("Enable reverberation" )
53 #define REVERB_LEVEL_LONGTEXT N_( "Reverberation level (from 0 " \
54                 "to 100, default value is 0)." )
55 #define REVERB_DELAY_LONGTEXT N_("Reverberation delay, in ms." \
56                 " Usual values are from to 40 to 200ms." )
57 #define MEGABASS_LONGTEXT N_( "Enable megabass mode" )
58 #define MEGABASS_LEVEL_LONGTEXT N_("Megabass mode level (from 0 to 100, " \
59                 "default value is 0)." )
60 #define MEGABASS_RANGE_LONGTEXT N_("Megabass mode cutoff frequency, in Hz. " \
61                 "This is the maximum frequency for which the megabass " \
62                 "effect applies. Valid values are from 10 to 100 Hz." )
63 #define SURROUND_LEVEL_LONGTEXT N_( "Surround effect level (from 0 to 100, " \
64                 "default value is 0)." )
65 #define SURROUND_DELAY_LONGTEXT N_("Surround delay, in ms. Usual values are " \
66                 "from 5 to 40 ms." )
67
68 vlc_module_begin ()
69     set_shortname( "MOD")
70     set_description( N_("MOD demuxer (libmodplug)" ) )
71     set_capability( "demux", 10 )
72     set_category( CAT_INPUT )
73     set_subcategory( SUBCAT_INPUT_DEMUX )
74
75     add_bool( "mod-noisereduction", true, NULL, N_("Noise reduction"),
76               NOISE_LONGTEXT, false )
77
78     add_bool( "mod-reverb", false, NULL, N_("Reverb"),
79               REVERB_LONGTEXT, false )
80     add_integer_with_range( "mod-reverb-level", 0, 0, 100, NULL,
81              N_("Reverberation level"), REVERB_LEVEL_LONGTEXT, true )
82     add_integer_with_range( "mod-reverb-delay", 40, 0, 1000, NULL,
83              N_("Reverberation delay"), REVERB_DELAY_LONGTEXT, true )
84
85     add_bool( "mod-megabass", false, NULL, N_("Mega bass"),
86                     MEGABASS_LONGTEXT, false )
87     add_integer_with_range( "mod-megabass-level", 0, 0, 100, NULL,
88               N_("Mega bass level"), MEGABASS_LEVEL_LONGTEXT, true )
89     add_integer_with_range( "mod-megabass-range", 10, 10, 100, NULL,
90               N_("Mega bass cutoff"), MEGABASS_RANGE_LONGTEXT, true )
91
92     add_bool( "mod-surround", false, NULL, N_("Surround"), N_("Surround"),
93                false )
94     add_integer_with_range( "mod-surround-level", 0, 0, 100, NULL,
95               N_("Surround level"), SURROUND_LEVEL_LONGTEXT, true )
96     add_integer_with_range( "mod-surround-delay", 5, 0, 1000, NULL,
97               N_("Surround delay (ms)"), SURROUND_DELAY_LONGTEXT, true )
98
99     set_callbacks( Open, Close )
100     add_shortcut( "mod" )
101 vlc_module_end ()
102
103 /*****************************************************************************
104  * Local prototypes
105  *****************************************************************************/
106
107 struct demux_sys_t
108 {
109     es_format_t  fmt;
110     es_out_id_t *es;
111
112     int64_t     i_time;
113     int64_t     i_length;
114
115     int         i_data;
116     uint8_t     *p_data;
117     ModPlugFile *f;
118 };
119
120 static int Demux  ( demux_t *p_demux );
121 static int Control( demux_t *p_demux, int i_query, va_list args );
122
123 static const char *ppsz_mod_ext[] =
124 {
125     "mod", "s3m", "xm",  "it",  "669", "amf", "ams", "dbm", "dmf", "dsm",
126     "far", "mdl", "med", "mtm", "okt", "ptm", "stm", "ult", "umx", "mt2",
127     "psm", NULL
128 };
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->b_force )
145     {
146         const char *psz_ext = strrchr( p_demux->psz_path, '.' );
147         int i;
148
149         if( !psz_ext )
150             return VLC_EGENERIC;
151
152         psz_ext++;  /* skip . */
153         for( i = 0; ppsz_mod_ext[i] != NULL; i++ )
154         {
155             if( !strcasecmp( psz_ext, ppsz_mod_ext[i] ) )
156                 break;
157         }
158         if( ppsz_mod_ext[i] == NULL )
159             return VLC_EGENERIC;
160         msg_Dbg( p_demux, "running MOD demuxer (ext=%s)", ppsz_mod_ext[i] );
161     }
162
163     const int64_t i_size = stream_Size( p_demux->s );
164     if( i_size <= 0 || i_size >= MOD_MAX_FILE_SIZE )
165         return VLC_EGENERIC;
166
167     /* Fill p_demux field */
168     p_demux->pf_demux = Demux;
169     p_demux->pf_control = Control;
170     p_demux->p_sys = p_sys = malloc( sizeof( *p_sys ) );
171     if( !p_sys )
172         return VLC_ENOMEM;
173
174     msg_Dbg( p_demux, "loading complete file (could be long)" );
175     p_sys->i_data = i_size;
176     p_sys->p_data = malloc( p_sys->i_data );
177     if( p_sys->p_data )
178         p_sys->i_data = stream_Read( p_demux->s, p_sys->p_data, p_sys->i_data );
179     if( p_sys->i_data <= 0 || !p_sys->p_data )
180     {
181         msg_Err( p_demux, "failed to read the complete file" );
182         free( p_sys->p_data );
183         free( p_sys );
184         return VLC_EGENERIC;
185     }
186
187     /* Configure modplug before loading the file */
188     ModPlug_GetSettings( &settings );
189     settings.mFlags = MODPLUG_ENABLE_OVERSAMPLING;
190     settings.mChannels = 2;
191     settings.mBits = 16;
192     settings.mFrequency = 44100;
193     settings.mResamplingMode = MODPLUG_RESAMPLE_FIR;
194
195     if( var_CreateGetBool( p_demux, "mod-noisereduction" ) )
196         settings.mFlags |= MODPLUG_ENABLE_NOISE_REDUCTION;
197
198     if( var_CreateGetBool( p_demux, "mod-reverb" ) )
199         settings.mFlags |= MODPLUG_ENABLE_REVERB;
200     settings.mReverbDepth = var_CreateGetInteger( p_demux, "mod-reverb-level" );
201     settings.mReverbDelay = var_CreateGetInteger( p_demux, "mod-reverb-delay" );
202
203     if( var_CreateGetBool( p_demux, "mod-megabass" ) )
204         settings.mFlags |= MODPLUG_ENABLE_MEGABASS;
205     settings.mBassAmount = var_CreateGetInteger( p_demux, "mod-megabass-level" );
206     settings.mBassRange = var_CreateGetInteger( p_demux, "mod-megabass-range" );
207
208     if( var_CreateGetBool( p_demux, "mod-surround" ) )
209         settings.mFlags |= MODPLUG_ENABLE_SURROUND;
210     settings.mSurroundDepth = var_CreateGetInteger( p_demux, "mod-surround-level" );
211     settings.mSurroundDelay = var_CreateGetInteger( p_demux, "mod-surround-delay" );
212
213     ModPlug_SetSettings( &settings );
214
215     if( ( p_sys->f = ModPlug_Load( p_sys->p_data, p_sys->i_data ) ) == NULL )
216     {
217         msg_Err( p_demux, "failed to understand the file" );
218         /* we try to seek to recover for other plugin */
219         stream_Seek( p_demux->s, 0 );
220         free( p_sys->p_data );
221         free( p_sys );
222         return VLC_EGENERIC;
223     }
224
225     /* init time */
226     p_sys->i_time  = 1;
227     p_sys->i_length = ModPlug_GetLength( p_sys->f ) * INT64_C(1000);
228
229     msg_Dbg( p_demux, "MOD loaded name=%s lenght=%"PRId64"ms",
230              ModPlug_GetName( p_sys->f ),
231              p_sys->i_length );
232
233 #ifdef WORDS_BIGENDIAN
234     es_format_Init( &p_sys->fmt, AUDIO_ES, VLC_FOURCC( 't', 'w', 'o', 's' ) );
235 #else
236     es_format_Init( &p_sys->fmt, AUDIO_ES, VLC_FOURCC( 'a', 'r', 'a', 'w' ) );
237 #endif
238     p_sys->fmt.audio.i_rate = settings.mFrequency;
239     p_sys->fmt.audio.i_channels = settings.mChannels;
240     p_sys->fmt.audio.i_bitspersample = settings.mBits;
241     p_sys->es = es_out_Add( p_demux->out, &p_sys->fmt );
242
243     return VLC_SUCCESS;
244 }
245
246 /*****************************************************************************
247  * Close
248  *****************************************************************************/
249 static void Close( vlc_object_t *p_this )
250 {
251     demux_t     *p_demux = (demux_t*)p_this;
252     demux_sys_t *p_sys = p_demux->p_sys;
253
254     ModPlug_Unload( p_sys->f );
255     free( p_sys->p_data );
256     free( p_sys );
257 }
258
259
260 /*****************************************************************************
261  * Demux:
262  *****************************************************************************/
263 static int Demux( demux_t *p_demux )
264 {
265     demux_sys_t *p_sys = p_demux->p_sys;
266     block_t     *p_frame;
267     int         i_bk = ( p_sys->fmt.audio.i_bitspersample / 8 ) *
268                        p_sys->fmt.audio.i_channels;
269     int         i_read;
270
271     p_frame = block_New( p_demux, p_sys->fmt.audio.i_rate / 10 * i_bk );
272     if( !p_frame )
273         return -1;
274
275     i_read = ModPlug_Read( p_sys->f, p_frame->p_buffer, p_frame->i_buffer );
276     if( i_read <= 0 )
277     {
278         /* EOF */
279         block_Release( p_frame );
280         return 0;
281     }
282     p_frame->i_buffer = i_read;
283
284     /* Set PCR */
285     es_out_Control( p_demux->out, ES_OUT_SET_PCR, (int64_t)p_sys->i_time );
286
287     /* We should use p_frame->i_buffer */
288     p_sys->i_time += INT64_C(1000000) * p_frame->i_buffer / i_bk / p_sys->fmt.audio.i_rate;
289
290     /* Send data */
291     p_frame->i_dts = p_frame->i_pts = p_sys->i_time;
292     es_out_Send( p_demux->out, p_sys->es, p_frame );
293
294     return 1;
295 }
296
297 /*****************************************************************************
298  * Control:
299  *****************************************************************************/
300 static int Control( demux_t *p_demux, int i_query, va_list args )
301 {
302     demux_sys_t *p_sys = p_demux->p_sys;
303     double f, *pf;
304     int64_t i64, *pi64;
305
306     switch( i_query )
307     {
308     case DEMUX_GET_POSITION:
309         pf = (double*) va_arg( args, double* );
310         if( p_sys->i_length > 0 )
311         {
312             *pf = (double)p_sys->i_time / (double)p_sys->i_length;
313             return VLC_SUCCESS;
314         }
315         return VLC_EGENERIC;
316
317     case DEMUX_SET_POSITION:
318         f = (double) va_arg( args, double );
319
320         i64 = f * p_sys->i_length;
321         if( i64 >= 0 && i64 <= p_sys->i_length )
322         {
323             ModPlug_Seek( p_sys->f, i64 / 1000 );
324             p_sys->i_time = i64 + 1;
325
326             return VLC_SUCCESS;
327         }
328         return VLC_EGENERIC;
329
330     case DEMUX_GET_TIME:
331         pi64 = (int64_t*)va_arg( args, int64_t * );
332         *pi64 = p_sys->i_time;
333         return VLC_SUCCESS;
334
335     case DEMUX_GET_LENGTH:
336         pi64 = (int64_t*)va_arg( args, int64_t * );
337         *pi64 = p_sys->i_length;
338         return VLC_SUCCESS;
339
340     case DEMUX_SET_TIME:
341         i64 = (int64_t)va_arg( args, int64_t );
342
343         if( i64 >= 0 && i64 <= p_sys->i_length )
344         {
345             ModPlug_Seek( p_sys->f, i64 / 1000 );
346             p_sys->i_time = i64 + 1;
347
348             return VLC_SUCCESS;
349         }
350         return VLC_EGENERIC;
351
352     case DEMUX_GET_FPS: /* meaningless */
353     default:
354         return VLC_EGENERIC;
355     }
356 }
357