Cosmetics (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 /*****************************************************************************
131  * Open
132  *****************************************************************************/
133 static int Open( vlc_object_t *p_this )
134 {
135     demux_t     *p_demux = (demux_t*)p_this;
136     demux_sys_t *p_sys;
137     ModPlug_Settings settings;
138
139     /* We accept file based on extension match */
140     if( !p_demux->b_force )
141     {
142         char *psz_ext;
143         int i;
144         if( ( psz_ext = strrchr( p_demux->psz_path, '.' ) ) == NULL ||
145             stream_Size( p_demux->s ) == 0 ) return VLC_EGENERIC;
146
147         psz_ext++;  /* skip . */
148         for( i = 0; ppsz_mod_ext[i] != NULL; i++ )
149         {
150             if( !strcasecmp( psz_ext, ppsz_mod_ext[i] ) )
151                 break;
152         }
153         if( ppsz_mod_ext[i] == NULL )
154             return VLC_EGENERIC;
155         msg_Dbg( p_demux, "running MOD demuxer (ext=%s)", ppsz_mod_ext[i] );
156     }
157
158     /* Fill p_demux field */
159     p_demux->pf_demux = Demux;
160     p_demux->pf_control = Control;
161     p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
162
163     msg_Dbg( p_demux, "loading complete file (could be long)" );
164     p_sys->i_data = stream_Size( p_demux->s );
165     p_sys->p_data = malloc( p_sys->i_data );
166     p_sys->i_data = stream_Read( p_demux->s, p_sys->p_data, p_sys->i_data );
167     if( p_sys->i_data <= 0 )
168     {
169         msg_Err( p_demux, "failed to read the complete file" );
170         free( p_sys->p_data );
171         free( p_sys );
172         return VLC_EGENERIC;
173     }
174
175     /* Configure modplug before loading the file */
176     ModPlug_GetSettings( &settings );
177     settings.mFlags = MODPLUG_ENABLE_OVERSAMPLING;
178     settings.mChannels = 2;
179     settings.mBits = 16;
180     settings.mFrequency = 44100;
181     settings.mResamplingMode = MODPLUG_RESAMPLE_FIR;
182
183     if( var_CreateGetBool( p_demux, "mod-noisereduction" ) )
184         settings.mFlags |= MODPLUG_ENABLE_NOISE_REDUCTION;
185
186     if( var_CreateGetBool( p_demux, "mod-reverb" ) )
187         settings.mFlags |= MODPLUG_ENABLE_REVERB;
188     settings.mReverbDepth = var_CreateGetInteger( p_demux, "mod-reverb-level" );
189     settings.mReverbDelay = var_CreateGetInteger( p_demux, "mod-reverb-delay" );
190
191     if( var_CreateGetBool( p_demux, "mod-megabass" ) )
192         settings.mFlags |= MODPLUG_ENABLE_MEGABASS;
193     settings.mBassAmount = var_CreateGetInteger( p_demux, "mod-megabass-level" );
194     settings.mBassRange = var_CreateGetInteger( p_demux, "mod-megabass-range" );
195
196     if( var_CreateGetBool( p_demux, "mod-surround" ) )
197         settings.mFlags |= MODPLUG_ENABLE_SURROUND;
198     settings.mSurroundDepth = var_CreateGetInteger( p_demux, "mod-surround-level" );
199     settings.mSurroundDelay = var_CreateGetInteger( p_demux, "mod-surround-delay" );
200
201     ModPlug_SetSettings( &settings );
202
203     if( ( p_sys->f = ModPlug_Load( p_sys->p_data, p_sys->i_data ) ) == NULL )
204     {
205         msg_Err( p_demux, "failed to understand the file" );
206         /* we try to seek to recover for other plugin */
207         stream_Seek( p_demux->s, 0 );
208         free( p_sys->p_data );
209         free( p_sys );
210         return VLC_EGENERIC;
211     }
212
213     /* init time */
214     p_sys->i_time  = 1;
215     p_sys->i_length = ModPlug_GetLength( p_sys->f ) * INT64_C(1000);
216
217     msg_Dbg( p_demux, "MOD loaded name=%s lenght=%"PRId64"ms",
218              ModPlug_GetName( p_sys->f ),
219              p_sys->i_length );
220
221 #ifdef WORDS_BIGENDIAN
222     es_format_Init( &p_sys->fmt, AUDIO_ES, VLC_FOURCC( 't', 'w', 'o', 's' ) );
223 #else
224     es_format_Init( &p_sys->fmt, AUDIO_ES, VLC_FOURCC( 'a', 'r', 'a', 'w' ) );
225 #endif
226     p_sys->fmt.audio.i_rate = settings.mFrequency;
227     p_sys->fmt.audio.i_channels = settings.mChannels;
228     p_sys->fmt.audio.i_bitspersample = settings.mBits;
229     p_sys->es = es_out_Add( p_demux->out, &p_sys->fmt );
230
231     return VLC_SUCCESS;
232 }
233
234 /*****************************************************************************
235  * Close
236  *****************************************************************************/
237 static void Close( vlc_object_t *p_this )
238 {
239     demux_t     *p_demux = (demux_t*)p_this;
240     demux_sys_t *p_sys = p_demux->p_sys;
241
242     ModPlug_Unload( p_sys->f );
243     free( p_sys->p_data );
244     free( p_sys );
245 }
246
247
248 /*****************************************************************************
249  * Demux:
250  *****************************************************************************/
251 static int Demux( demux_t *p_demux )
252 {
253     demux_sys_t *p_sys = p_demux->p_sys;
254     block_t     *p_frame;
255     int         i_bk = ( p_sys->fmt.audio.i_bitspersample / 8 ) *
256                        p_sys->fmt.audio.i_channels;
257     int         i_read;
258
259     p_frame = block_New( p_demux, p_sys->fmt.audio.i_rate / 10 * i_bk );
260
261     i_read = ModPlug_Read( p_sys->f, p_frame->p_buffer, p_frame->i_buffer );
262     if( i_read <= 0 )
263     {
264         /* EOF */
265         block_Release( p_frame );
266         return 0;
267     }
268     p_frame->i_buffer = i_read;
269
270     /* Set PCR */
271     es_out_Control( p_demux->out, ES_OUT_SET_PCR, (int64_t)p_sys->i_time );
272
273     /* We should use p_frame->i_buffer */
274     p_sys->i_time += INT64_C(1000000) * p_frame->i_buffer / i_bk / p_sys->fmt.audio.i_rate;
275
276     /* Send data */
277     p_frame->i_dts = p_frame->i_pts = p_sys->i_time;
278     es_out_Send( p_demux->out, p_sys->es, p_frame );
279
280     return 1;
281 }
282
283 /*****************************************************************************
284  * Control:
285  *****************************************************************************/
286 static int Control( demux_t *p_demux, int i_query, va_list args )
287 {
288     demux_sys_t *p_sys = p_demux->p_sys;
289     double f, *pf;
290     int64_t i64, *pi64;
291
292     switch( i_query )
293     {
294     case DEMUX_GET_POSITION:
295         pf = (double*) va_arg( args, double* );
296         if( p_sys->i_length > 0 )
297         {
298             *pf = (double)p_sys->i_time / (double)p_sys->i_length;
299             return VLC_SUCCESS;
300         }
301         return VLC_EGENERIC;
302
303     case DEMUX_SET_POSITION:
304         f = (double) va_arg( args, double );
305
306         i64 = f * p_sys->i_length;
307         if( i64 >= 0 && i64 <= p_sys->i_length )
308         {
309             ModPlug_Seek( p_sys->f, i64 / 1000 );
310             p_sys->i_time = i64 + 1;
311
312             return VLC_SUCCESS;
313         }
314         return VLC_EGENERIC;
315
316     case DEMUX_GET_TIME:
317         pi64 = (int64_t*)va_arg( args, int64_t * );
318         *pi64 = p_sys->i_time;
319         return VLC_SUCCESS;
320
321     case DEMUX_GET_LENGTH:
322         pi64 = (int64_t*)va_arg( args, int64_t * );
323         *pi64 = p_sys->i_length;
324         return VLC_SUCCESS;
325
326     case DEMUX_SET_TIME:
327         i64 = (int64_t)va_arg( args, int64_t );
328
329         if( i64 >= 0 && i64 <= p_sys->i_length )
330         {
331             ModPlug_Seek( p_sys->f, i64 / 1000 );
332             p_sys->i_time = i64 + 1;
333
334             return VLC_SUCCESS;
335         }
336         return VLC_EGENERIC;
337
338     case DEMUX_GET_FPS: /* meaningless */
339     default:
340         return VLC_EGENERIC;
341     }
342 }
343