]> git.sesse.net Git - vlc/blobdiff - modules/demux/mod.c
Use var_InheritString for --decklink-video-connection.
[vlc] / modules / demux / mod.c
index c0ff6dcf8c7761e013c8d8b4b63533b7c1891955..b7817a4f87cef1d9a5f33988c723fae7fc2f5ad1 100644 (file)
@@ -5,6 +5,7 @@
  * $Id$
  *
  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
+ * Konstanty Bialkowski <konstanty@ieee.org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -32,6 +33,8 @@
 #include <vlc_common.h>
 #include <vlc_plugin.h>
 #include <vlc_demux.h>
+#include <vlc_meta.h>
+#include <assert.h>
 
 #include <libmodplug/modplug.h>
 
@@ -109,7 +112,7 @@ struct demux_sys_t
     es_format_t  fmt;
     es_out_id_t *es;
 
-    int64_t     i_time;
+    date_t      pts;
     int64_t     i_length;
 
     int         i_data;
@@ -120,13 +123,16 @@ struct demux_sys_t
 static int Demux  ( demux_t *p_demux );
 static int Control( demux_t *p_demux, int i_query, va_list args );
 
+static int Validate( demux_t *p_demux, const char *psz_ext );
+
 static const char *ppsz_mod_ext[] =
 {
     "mod", "s3m", "xm",  "it",  "669", "amf", "ams", "dbm", "dmf", "dsm",
     "far", "mdl", "med", "mtm", "okt", "ptm", "stm", "ult", "umx", "mt2",
-    "psm", NULL
+    "psm", "abc", NULL
 };
 
+
 /* We load the complete file in memory, put a higher bound
  * of 500 Mo (which is really big anyway) */
 #define MOD_MAX_FILE_SIZE (500*1000*1000)
@@ -143,7 +149,9 @@ static int Open( vlc_object_t *p_this )
     /* We accept file based on extension match */
     if( !p_demux->b_force )
     {
-        const char *psz_ext = strrchr( p_demux->psz_path, '.' );
+        if( !p_demux->psz_file )
+            return VLC_EGENERIC;
+        const char *psz_ext = strrchr( p_demux->psz_file, '.' );
         int i;
 
         if( !psz_ext )
@@ -157,6 +165,11 @@ static int Open( vlc_object_t *p_this )
         }
         if( ppsz_mod_ext[i] == NULL )
             return VLC_EGENERIC;
+        if( Validate( p_demux, ppsz_mod_ext[i] ) )
+        {
+            msg_Warn( p_demux, "MOD validation failed (ext=%s)", ppsz_mod_ext[i]);
+            return VLC_EGENERIC;
+        }
         msg_Dbg( p_demux, "running MOD demuxer (ext=%s)", ppsz_mod_ext[i] );
     }
 
@@ -223,7 +236,8 @@ static int Open( vlc_object_t *p_this )
     }
 
     /* init time */
-    p_sys->i_time  = 1;
+    date_Init( &p_sys->pts, settings.mFrequency, 1 );
+    date_Set( &p_sys->pts, 0 );
     p_sys->i_length = ModPlug_GetLength( p_sys->f ) * INT64_C(1000);
 
     msg_Dbg( p_demux, "MOD loaded name=%s lenght=%"PRId64"ms",
@@ -264,15 +278,14 @@ static int Demux( demux_t *p_demux )
 {
     demux_sys_t *p_sys = p_demux->p_sys;
     block_t     *p_frame;
-    int         i_bk = ( p_sys->fmt.audio.i_bitspersample / 8 ) *
+    const int i_bk = ( p_sys->fmt.audio.i_bitspersample / 8 ) *
                        p_sys->fmt.audio.i_channels;
-    int         i_read;
 
     p_frame = block_New( p_demux, p_sys->fmt.audio.i_rate / 10 * i_bk );
     if( !p_frame )
         return -1;
 
-    i_read = ModPlug_Read( p_sys->f, p_frame->p_buffer, p_frame->i_buffer );
+    const int i_read = ModPlug_Read( p_sys->f, p_frame->p_buffer, p_frame->i_buffer );
     if( i_read <= 0 )
     {
         /* EOF */
@@ -280,17 +293,17 @@ static int Demux( demux_t *p_demux )
         return 0;
     }
     p_frame->i_buffer = i_read;
+    p_frame->i_dts =
+    p_frame->i_pts = VLC_TS_0 + date_Get( &p_sys->pts );
 
     /* Set PCR */
-    es_out_Control( p_demux->out, ES_OUT_SET_PCR, (int64_t)p_sys->i_time );
-
-    /* We should use p_frame->i_buffer */
-    p_sys->i_time += INT64_C(1000000) * p_frame->i_buffer / i_bk / p_sys->fmt.audio.i_rate;
+    es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_frame->i_pts );
 
     /* Send data */
-    p_frame->i_dts = p_frame->i_pts = p_sys->i_time;
     es_out_Send( p_demux->out, p_sys->es, p_frame );
 
+    date_Increment( &p_sys->pts, i_read / i_bk );
+
     return 1;
 }
 
@@ -309,7 +322,9 @@ static int Control( demux_t *p_demux, int i_query, va_list args )
         pf = (double*) va_arg( args, double* );
         if( p_sys->i_length > 0 )
         {
-            *pf = (double)p_sys->i_time / (double)p_sys->i_length;
+            double current = date_Get( &p_sys->pts );
+            double length = p_sys->i_length;
+            *pf = current / length;
             return VLC_SUCCESS;
         }
         return VLC_EGENERIC;
@@ -321,7 +336,7 @@ static int Control( demux_t *p_demux, int i_query, va_list args )
         if( i64 >= 0 && i64 <= p_sys->i_length )
         {
             ModPlug_Seek( p_sys->f, i64 / 1000 );
-            p_sys->i_time = i64 + 1;
+            date_Set( &p_sys->pts, i64 );
 
             return VLC_SUCCESS;
         }
@@ -329,7 +344,7 @@ static int Control( demux_t *p_demux, int i_query, va_list args )
 
     case DEMUX_GET_TIME:
         pi64 = (int64_t*)va_arg( args, int64_t * );
-        *pi64 = p_sys->i_time;
+        *pi64 = date_Get( &p_sys->pts );
         return VLC_SUCCESS;
 
     case DEMUX_GET_LENGTH:
@@ -343,15 +358,225 @@ static int Control( demux_t *p_demux, int i_query, va_list args )
         if( i64 >= 0 && i64 <= p_sys->i_length )
         {
             ModPlug_Seek( p_sys->f, i64 / 1000 );
-            p_sys->i_time = i64 + 1;
+            date_Set( &p_sys->pts, i64 );
 
             return VLC_SUCCESS;
         }
         return VLC_EGENERIC;
 
+    case DEMUX_HAS_UNSUPPORTED_META:
+    {
+        bool *pb_bool = (bool*)va_arg( args, bool* );
+        *pb_bool = false; /* FIXME I am not sure of this one */
+        return VLC_SUCCESS;
+    }
+    case DEMUX_GET_META:
+    {
+        vlc_meta_t *p_meta = (vlc_meta_t *)va_arg( args, vlc_meta_t* );
+        unsigned i_num_samples = ModPlug_NumSamples( p_sys->f ),
+                 i_num_instruments = ModPlug_NumInstruments( p_sys->f );
+        unsigned i_num_patterns = ModPlug_NumPatterns( p_sys->f ),
+                 i_num_channels = ModPlug_NumChannels( p_sys->f );
+        //      unsigned modType = ModPlug_GetModuleType( p_sys->f );
+
+        char psz_temp[2048]; /* 32 * 240 max, but only need start  */
+        char *psz_module_info, *psz_instrument_info;
+        unsigned i_temp_index = 0;
+        const char *psz_name = ModPlug_GetName( p_sys->f );
+        if( psz_name && *psz_name )
+            vlc_meta_SetTitle( p_meta, psz_name );
+
+        /* Comment field from artist - not in every type of MOD */
+        psz_name = ModPlug_GetMessage( p_sys->f );
+        if( psz_name && *psz_name )
+            vlc_meta_SetDescription( p_meta, psz_name );
+
+        /* Instruments only in newer MODs - so don't show if 0 */
+        if( asprintf( &psz_instrument_info, ", %i Instruments",
+                      i_num_instruments ) >= 0 )
+        {
+            if( asprintf( &psz_module_info,
+                          "%i Channels, %i Patterns\n"
+                          "%i Samples%s\n",
+                          i_num_channels, i_num_patterns, i_num_samples,
+                          ( i_num_instruments ? psz_instrument_info : "" ) ) >= 0 )
+            {
+                vlc_meta_AddExtra( p_meta, "Module Information",
+                                   psz_module_info );
+                free( psz_module_info );
+            }
+
+            free( psz_instrument_info );
+        }
+
+        /* Make list of instruments (XM, IT, etc) */
+        if( i_num_instruments )
+        {
+            i_temp_index = 0;
+            for( unsigned i = 0; i < i_num_instruments && i_temp_index < sizeof(psz_temp); i++ )
+            {
+                char lBuffer[33];
+                ModPlug_InstrumentName( p_sys->f, i, lBuffer );
+                if ( !lBuffer[0] ) continue; // don't add empty fields.
+                i_temp_index += snprintf( &psz_temp[i_temp_index], sizeof(psz_temp) - i_temp_index, "%s\n", lBuffer );
+            }
+
+            vlc_meta_AddExtra( p_meta, "Instruments", psz_temp );
+        }
+
+        /* Make list of samples */
+        for( unsigned int i = 0; i < i_num_samples && i_temp_index < sizeof(psz_temp); i++ )
+        {
+            char psz_buffer[33];
+            ModPlug_SampleName( p_sys->f, i, psz_buffer );
+            if ( !psz_buffer[0] ) continue; // don't add empty fields.
+            i_temp_index += snprintf( &psz_temp[i_temp_index], sizeof(psz_temp) - i_temp_index, "%s\n", psz_buffer );
+        }
+
+        vlc_meta_AddExtra( p_meta, "Samples", psz_temp );
+
+        return VLC_SUCCESS;
+    }
+
     case DEMUX_GET_FPS: /* meaningless */
     default:
         return VLC_EGENERIC;
     }
 }
 
+/*****************************************************************************
+ * Validate: try to ensure it is really a mod file.
+ * The tests are not robust enough to replace extension checks in the general
+ * cases.
+ * TODO: maybe it should return a score, which will be used to bypass the
+ * extension checks when high enough.
+ *****************************************************************************/
+static int Validate( demux_t *p_demux, const char *psz_ext )
+{
+    static const struct
+    {
+        int i_offset;
+        const char *psz_marker;
+    } p_marker[] = {
+        {  0, "ziRCONia" },             /* MMCMP files */
+        {  0, "Extended Module" },      /* XM */
+        { 44, "SCRM" },                 /* S3M */
+        {  0, "IMPM" },                 /* IT */
+        {  0, "MThd" },                 /* MID */
+        {  0, "GF1PATCH110" },          /* PAT */
+        { 20, "!SCREAM!" },             /* STM */
+        { 20, "!Scream!" },             /* STM */
+        { 20, "BMOD2STM" },             /* STM */
+        {  0, "MMD0" },                 /* MED v0 */
+        {  0, "MMD1" },                 /* MED v1 */
+        {  0, "MMD2" },                 /* MED v2 */
+        {  0, "MMD3" },                 /* MED v3 */
+        {  0, "MTM" },                  /* MTM */
+        {  0, "DMDL" },                 /* MDL */
+        {  0, "DBM0" },                 /* DBM */
+        {  0, "if" },                   /* 669 */
+        {  0, "JN" },                   /* 669 */
+        {  0, "FAR\xfe" },              /* FAR */
+        {  0, "Extreme" },              /* AMS */
+        {  0, "OKTASONGCMOD" },         /* OKT */
+        { 44, "PTMF" },                 /* PTM */
+        {  0, "MAS_UTrack_V00" },       /* Ult */
+        {  0, "DDMF" },                 /* DMF */
+        {  8, "DSMFSONG" },             /* DSM */
+        {  0, "\xc1\x83\x2a\x9e" },     /* UMX */
+        {  0, "ASYLUM Music Format V1.0" }, /* AMF Type 0 */
+        {  0, "AMF" },                  /* AMF */
+        {  0, "PSM\xfe" },              /* PSM */
+        {  0, "PSM " },                 /* PSM */
+        {  0, "MT20" },                 /* MT2 */
+
+        { 1080, "M.K." },               /* MOD */
+        { 1080, "M!K!" },
+        { 1080, "M&K!" },
+        { 1080, "N.T." },
+        { 1080, "CD81" },
+        { 1080, "OKTA" },
+        { 1080, "16CN" },
+        { 1080, "32CN" },
+        { 1080, "FLT" },
+        { 1080, "TDZ" },
+        { 1081, "CHN" },
+        { 1082, "CH" },
+
+        {  -1, NULL }
+    };
+
+    const uint8_t *p_peek;
+    const int i_peek = stream_Peek( p_demux->s, &p_peek, 2048 );
+    if( i_peek < 4 )
+        return VLC_EGENERIC;
+
+    for( int i = 0; p_marker[i].i_offset >= 0; i++ )
+    {
+        const char *psz_marker = p_marker[i].psz_marker;
+        const int i_size = strlen( psz_marker );
+        const int i_offset = p_marker[i].i_offset;
+
+        if( i_peek < i_offset + i_size )
+            continue;
+
+        if( !memcmp( &p_peek[i_offset], psz_marker, i_size ) )
+            return VLC_SUCCESS;
+    }
+
+    /* The only two format left untested are ABC and MOD(old version)
+     * ant they are difficult to test :( */
+
+    /* Check for ABC
+     * TODO i_peek = 2048 is too big for such files */
+    if( !strcasecmp( psz_ext, "abc" ) )
+    {
+        bool b_k = false;
+        bool b_tx = false;
+
+        for( int i = 0; i < i_peek-1; i++ )
+        {
+            b_k |= p_peek[i+0] == 'K' && p_peek[i+1] == ':';
+            b_tx |= ( p_peek[i+0] == 'X' || p_peek[i+0] == 'T') && p_peek[i+1] == ':';
+        }
+        if( !b_k || !b_tx )
+            return VLC_EGENERIC;
+        return VLC_SUCCESS;
+    }
+
+    /* Check for MOD */
+    if( !strcasecmp( psz_ext, "mod" ) && i_peek >= 20 + 15 * 30 )
+    {
+        /* Check that the name is correctly null padded */
+        const uint8_t *p = memchr( p_peek, '\0', 20 );
+        if( p )
+        {
+            for( ; p < &p_peek[20]; p++ )
+            {
+                if( *p )
+                    return VLC_EGENERIC;
+            }
+        }
+
+        for( int i = 0; i < 15; i++ )
+        {
+            const uint8_t *p_sample = &p_peek[20 + i*30];
+
+            /* Check correct null padding */
+            const uint8_t *p = memchr( &p_sample[0], '\0', 22 );
+            if( p )
+            {
+                for( ; p < &p_sample[22]; p++ )
+                {
+                    if( *p )
+                        return VLC_EGENERIC;
+                }
+            }
+
+            if( p_sample[25] > 64 ) /* Volume value */
+                return VLC_EGENERIC;
+        }
+        return VLC_SUCCESS;
+    }
+    return VLC_EGENERIC;
+}