git.sesse.net Git - vlc/blob - modules/demux/mod.c

   1 /*****************************************************************************
   2  * mod.c: MOD file demuxer (using libmodplug)
   3  *****************************************************************************
   4  * Copyright (C) 2004 VideoLAN
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <stdlib.h>                                      /* malloc(), free() */
  28
  29 #include <vlc/vlc.h>
  30 #include <vlc/input.h>
  31
  32 #include <libmodplug/modplug.h>
  33
  34 /* TODO:
  35  *  - extend demux control to query meta data (demuxer should NEVER touch
  36  *      playlist itself)
  37  *  - FIXME test endian of samples
  38  *  - ...
  39  */
  40
  41 /*****************************************************************************
  42  * Module descriptor
  43  *****************************************************************************/
  44 static int  Open    ( vlc_object_t * );
  45 static void Close  ( vlc_object_t * );
  46
  47 vlc_module_begin();
  48     set_description( _("MOD demuxer (libmodplug)" ) );
  49     set_capability( "demux2", 10 );
  50     set_category( CAT_INPUT );
  51     set_subcategory( SUBCAT_INPUT_DEMUX );
  52
  53     add_bool( "mod-noisereduction", VLC_TRUE, NULL, N_("Noise reduction"), N_("Noise reduction"), VLC_FALSE );
  54
  55     add_bool( "mod-reverb", VLC_FALSE, NULL, N_("Reverb"), N_("Reverb"), VLC_FALSE );
  56     add_integer_with_range( "mod-reverb-level", 0, 0, 100, NULL, N_("Reverb level (0-100)"), N_("Reverb level (0-100 defaults to 0)"), VLC_FALSE );
  57     add_integer_with_range( "mod-reverb-delay", 40, 0, 1000, NULL, N_("Reverb delay (ms)"), N_("Reverb delay in ms (usually 40-200ms)"), VLC_FALSE );
  58
  59     add_bool( "mod-megabass", VLC_FALSE, NULL, N_("Mega bass"), N_("Mega bass"), VLC_FALSE );
  60     add_integer_with_range( "mod-megabass-level", 0, 0, 100, NULL, N_("Mega bass level (0-100)"), N_("Mega bass level (0-100 defaults to 0)"), VLC_FALSE );
  61     add_integer_with_range( "mod-megabass-range", 10, 10, 100, NULL, N_("Mega bass cut off (Hz)"), N_("Mega bass cut off (10-100Hz)"), VLC_FALSE );
  62
  63     add_bool( "mod-surround", VLC_FALSE, NULL, N_("Surround"), N_("Surround"), VLC_FALSE );
  64     add_integer_with_range( "mod-surround-level", 0, 0, 100, NULL, N_("Surround level (0-100)"), N_("Surround level (0-100 defaults to 0)"), VLC_FALSE );
  65     add_integer_with_range( "mod-surround-delay", 5, 0, 1000, NULL, N_("Surround delay (ms)"), N_("Surround delay in ms (usually 5-40ms)"), VLC_FALSE );
  66
  67     set_callbacks( Open, Close );
  68     add_shortcut( "mod" );
  69 vlc_module_end();
  70
  71 /*****************************************************************************
  72  * Local prototypes
  73  *****************************************************************************/
  74
  75 struct demux_sys_t
  76 {
  77     es_format_t  fmt;
  78     es_out_id_t *es;
  79
  80     int64_t     i_time;
  81     int64_t     i_length;
  82
  83     int         i_data;
  84     uint8_t     *p_data;
  85     ModPlugFile *f;
  86 };
  87
  88 static int Demux  ( demux_t *p_demux );
  89 static int Control( demux_t *p_demux, int i_query, va_list args );
  90
  91 static const char* mod_ext[] =
  92 {
  93     "mod", "s3m", "xm",  "it",  "669", "amf", "ams", "dbm", "dmf", "dsm",
  94     "far", "mdl", "med", "mtm", "okt", "ptm", "stm", "ult", "umx", "mt2",
  95     "psm", NULL
  96 };
  97
  98 /*****************************************************************************
  99  * Open
 100  *****************************************************************************/
 101 static int Open( vlc_object_t *p_this )
 102 {
 103     demux_t     *p_demux = (demux_t*)p_this;
 104     demux_sys_t *p_sys;
 105     char        *ext;
 106     int         i;
 107     ModPlug_Settings settings;
 108     vlc_value_t val;
 109
 110     /* We accept file based on extention match */
 111     if( strcasecmp( p_demux->psz_demux, "mod" ) )
 112     {
 113         if( ( ext = strchr( p_demux->psz_path, '.' ) ) == NULL || stream_Size( p_demux->s ) == 0 )
 114         {
 115             msg_Warn( p_demux, "MOD module discarded (path=%s)", p_demux->psz_path );
 116             return VLC_EGENERIC;
 117         }
 118         ext++;  /* skip . */
 119         for( i = 0; mod_ext[i] != NULL; i++ )
 120         {
 121             if( !strcasecmp( ext, mod_ext[i] ) )
 122             {
 123                 break;
 124             }
 125         }
 126         if( mod_ext[i] == NULL )
 127         {
 128             msg_Warn( p_demux, "MOD module discarded (extention '%s' unknown)", ext );
 129             return VLC_EGENERIC;
 130         }
 131         msg_Dbg( p_demux, "running MOD demuxer (ext=%s)", mod_ext[i] );
 132     }
 133
 134     /* Fill p_demux field */
 135     p_demux->pf_demux = Demux;
 136     p_demux->pf_control = Control;
 137     p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
 138
 139     msg_Dbg( p_demux, "loading complete file (could be long)" );
 140     p_sys->i_data = stream_Size( p_demux->s );
 141     p_sys->p_data = malloc( p_sys->i_data );
 142     p_sys->i_data = stream_Read( p_demux->s, p_sys->p_data, p_sys->i_data );
 143     if( p_sys->i_data <= 0 )
 144     {
 145         msg_Err( p_demux, "failed to read the complete file" );
 146         free( p_sys->p_data );
 147         free( p_sys );
 148         return VLC_EGENERIC;
 149     }
 150     /* Create our config variable */
 151     var_Create( p_demux, "mod-noisereduction", VLC_VAR_BOOL|VLC_VAR_DOINHERIT );
 152     var_Create( p_demux, "mod-reverb", VLC_VAR_BOOL|VLC_VAR_DOINHERIT );
 153     var_Create( p_demux, "mod-reverb-level", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 154     var_Create( p_demux, "mod-reverb-delay", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 155     var_Create( p_demux, "mod-megabass", VLC_VAR_BOOL|VLC_VAR_DOINHERIT );
 156     var_Create( p_demux, "mod-megabass-level", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 157     var_Create( p_demux, "mod-megabass-range", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 158     var_Create( p_demux, "mod-surround", VLC_VAR_BOOL|VLC_VAR_DOINHERIT );
 159     var_Create( p_demux, "mod-surround-level", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 160     var_Create( p_demux, "mod-surround-delay", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 161
 162     /* Configure modplug before loading the file */
 163     ModPlug_GetSettings( &settings );
 164     settings.mFlags = MODPLUG_ENABLE_OVERSAMPLING;
 165     settings.mChannels = 2;
 166     settings.mBits = 16;
 167     settings.mFrequency = 44100;
 168     settings.mResamplingMode = MODPLUG_RESAMPLE_FIR;
 169
 170     var_Get( p_demux, "mod-noisereduction", &val );
 171     if( val.b_bool) settings.mFlags |= MODPLUG_ENABLE_NOISE_REDUCTION;
 172
 173     var_Get( p_demux, "mod-reverb", &val );
 174     if( val.b_bool) settings.mFlags |= MODPLUG_ENABLE_REVERB;
 175     var_Get( p_demux, "mod-reverb-level", &val );
 176     settings.mReverbDepth = val.i_int;
 177     var_Get( p_demux, "mod-reverb-delay", &val );
 178     settings.mReverbDelay = val.i_int;
 179
 180     var_Get( p_demux, "mod-megabass", &val );
 181     if( val.b_bool) settings.mFlags |= MODPLUG_ENABLE_MEGABASS;
 182     var_Get( p_demux, "mod-megabass-level", &val );
 183     settings.mBassAmount = val.i_int;
 184     var_Get( p_demux, "mod-megabass-range", &val );
 185     settings.mBassRange = val.i_int;
 186
 187     var_Get( p_demux, "mod-surround", &val );
 188     if( val.b_bool) settings.mFlags |= MODPLUG_ENABLE_SURROUND;
 189     var_Get( p_demux, "mod-surround-level", &val );
 190     settings.mSurroundDepth = val.i_int;
 191     var_Get( p_demux, "mod-surround-delay", &val );
 192     settings.mSurroundDelay = val.i_int;
 193
 194     ModPlug_SetSettings( &settings );
 195
 196     if( ( p_sys->f = ModPlug_Load( p_sys->p_data, p_sys->i_data ) ) == NULL )
 197     {
 198         msg_Err( p_demux, "failed to understand the file" );
 199         /* we try to seek to recover for other plugin */
 200         stream_Seek( p_demux->s, 0 );
 201         free( p_sys->p_data );
 202         free( p_sys );
 203         return VLC_EGENERIC;
 204     }
 205
 206     /* init time */
 207     p_sys->i_time  = 1;
 208     p_sys->i_length = ModPlug_GetLength( p_sys->f ) * (int64_t)1000;
 209
 210     msg_Dbg( p_demux, "MOD loaded name=%s lenght="I64Fd"ms",
 211              ModPlug_GetName( p_sys->f ),
 212              p_sys->i_length );
 213
 214 #ifdef WORDS_BIGENDIAN
 215     es_format_Init( &p_sys->fmt, AUDIO_ES, VLC_FOURCC( 't', 'w', 'o', 's' ) );
 216 #else
 217     es_format_Init( &p_sys->fmt, AUDIO_ES, VLC_FOURCC( 'a', 'r', 'a', 'w' ) );
 218 #endif
 219     p_sys->fmt.audio.i_rate = settings.mFrequency;
 220     p_sys->fmt.audio.i_channels = settings.mChannels;
 221     p_sys->fmt.audio.i_bitspersample = settings.mBits;
 222     p_sys->es = es_out_Add( p_demux->out, &p_sys->fmt );
 223
 224     return VLC_SUCCESS;
 225 }
 226
 227 /*****************************************************************************
 228  * Close
 229  *****************************************************************************/
 230 static void Close( vlc_object_t *p_this )
 231 {
 232     demux_t     *p_demux = (demux_t*)p_this;
 233     demux_sys_t *p_sys = p_demux->p_sys;
 234
 235     ModPlug_Unload( p_sys->f );
 236     free( p_sys->p_data );
 237     free( p_sys );
 238 }
 239
 240
 241 /*****************************************************************************
 242  * Demux:
 243  *****************************************************************************/
 244 static int Demux( demux_t *p_demux )
 245 {
 246     demux_sys_t *p_sys = p_demux->p_sys;
 247     block_t     *p_frame;
 248     int         i_bk = ( p_sys->fmt.audio.i_bitspersample / 8 ) *
 249                        p_sys->fmt.audio.i_channels;
 250
 251     p_frame = block_New( p_demux, p_sys->fmt.audio.i_rate / 10 * i_bk );
 252
 253     p_frame->i_buffer = ModPlug_Read( p_sys->f, p_frame->p_buffer, p_frame->i_buffer );
 254     if( p_frame->i_buffer <= 0 )
 255     {
 256         /* EOF */
 257         block_Release( p_frame );
 258         return 0;
 259     }
 260
 261     /* Set PCR */
 262     es_out_Control( p_demux->out, ES_OUT_SET_PCR, (int64_t)p_sys->i_time );
 263
 264     /* We should use p_frame->i_buffer */
 265     p_sys->i_time += (int64_t)1000000 * p_frame->i_buffer / i_bk / p_sys->fmt.audio.i_rate;
 266
 267     /* Send data */
 268     p_frame->i_dts = p_frame->i_pts = p_sys->i_time;
 269     es_out_Send( p_demux->out, p_sys->es, p_frame );
 270
 271     return 1;
 272 }
 273
 274 /*****************************************************************************
 275  * Control:
 276  *****************************************************************************/
 277 static int Control( demux_t *p_demux, int i_query, va_list args )
 278 {
 279     demux_sys_t *p_sys = p_demux->p_sys;
 280     double f, *pf;
 281     int64_t i64, *pi64;
 282
 283     switch( i_query )
 284     {
 285         case DEMUX_GET_POSITION:
 286             pf = (double*) va_arg( args, double* );
 287             if( p_sys->i_length > 0 )
 288             {
 289                 *pf = (double)p_sys->i_time / (double)p_sys->i_length;
 290                 return VLC_SUCCESS;
 291             }
 292             return VLC_EGENERIC;
 293
 294         case DEMUX_SET_POSITION:
 295             f = (double) va_arg( args, double );
 296
 297             i64 = f * p_sys->i_length;
 298             if( i64 >= 0 && i64 <= p_sys->i_length )
 299             {
 300                 ModPlug_Seek( p_sys->f, i64 / 1000 );
 301                 p_sys->i_time = i64 + 1;
 302                 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
 303
 304                 return VLC_SUCCESS;
 305             }
 306             return VLC_EGENERIC;
 307
 308         case DEMUX_GET_TIME:
 309             pi64 = (int64_t*)va_arg( args, int64_t * );
 310             *pi64 = p_sys->i_time;
 311             return VLC_SUCCESS;
 312
 313         case DEMUX_GET_LENGTH:
 314             pi64 = (int64_t*)va_arg( args, int64_t * );
 315             *pi64 = p_sys->i_length;
 316             return VLC_SUCCESS;
 317
 318         case DEMUX_SET_TIME:
 319             i64 = (int64_t)va_arg( args, int64_t );
 320
 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                 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
 326
 327                 return VLC_SUCCESS;
 328             }
 329             return VLC_EGENERIC;
 330
 331         case DEMUX_GET_FPS: /* meaningless */
 332         default:
 333             return VLC_EGENERIC;
 334     }
 335 }
 336