]> git.sesse.net Git - vlc/blobdiff - src/input/subtitles.c
Use var_Inherit* instead of var_CreateGet*.
[vlc] / src / input / subtitles.c
index bc5a8273b6ebb866adec7fe09d9e62622a6bbe4a..9c6843d6ba26f9ba9b0c86ea51b239a5e5b0c7e6 100644 (file)
@@ -1,7 +1,7 @@
 /*****************************************************************************
- * subtitles.c
+ * subtitles.c : subtitles detection
  *****************************************************************************
- * Copyright (C) 2003-2004 VideoLAN
+ * Copyright (C) 2003-2009 the VideoLAN team
  * $Id$
  *
  * Authors: Derk-Jan Hartman <hartman at videolan.org>
@@ -19,7 +19,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /**
  *  This file contains functions to dectect subtitle files.
  */
 
-#include <stdlib.h>
-#include <vlc/vlc.h>
-#include <vlc/input.h>
-
-#ifdef HAVE_DIRENT_H
-#   include <dirent.h>
-#else
-#   include "../extras/dirent.h"
+#ifdef HAVE_CONFIG_H
+# include "config.h"
 #endif
 
-#include <ctype.h>
+#include <vlc_common.h>
+#include <vlc_fs.h>
+#include <vlc_url.h>
 
-/**
- * What's between a directory and a filename?
- */
-#if defined( WIN32 )
-    #define DIRECTORY_SEPARATOR '\\'
-#else
-    #define DIRECTORY_SEPARATOR '/'
+#ifdef HAVE_UNISTD_H
+#   include <unistd.h>
 #endif
 
+#include <sys/stat.h>
+
+#include <ctype.h> /* isalnum */
+
+#include "input_internal.h"
+
 /**
  * We are not going to autodetect more subtitle files than this.
  */
 #define MAX_SUBTITLE_FILES 128
 
-
 /**
- * The possible extentions for subtitle files we support
+ * The possible extensions for subtitle files we support
  */
-static const char * sub_exts[] = {  "utf", "utf8", "utf-8", "sub", "srt", "smi", "txt", "ssa", "idx", NULL};
-/* extensions from unsupported types */
-/* rt, aqt, jss, js, ass */
-
-static void strcpy_trim( char *d, char *s )
+static const char const sub_exts[][6] = {
+    "idx", "sub",  "srt",
+    "ssa", "ass",  "smi",
+    "utf", "utf8", "utf-8",
+    "txt", "rt",   "aqt",
+    "usf", "jss",  "cdg",
+    "psb", "mpsub","mpl2",
+    "pjs", "dks",
+    ""
+};
+
+static void strcpy_trim( char *d, const char *s )
 {
     /* skip leading whitespace */
     while( *s && !isalnum(*s) )
@@ -76,7 +79,7 @@ static void strcpy_trim( char *d, char *s )
             *d = tolower(*s);
             s++; d++;
         }
-        if (*s == 0) break;
+        if( *s == 0 ) break;
         /* trim excess whitespace */
         while( *s && !isalnum(*s) )
         {
@@ -88,18 +91,16 @@ static void strcpy_trim( char *d, char *s )
     *d = 0;
 }
 
-static void strcpy_strip_ext( char *d, char *s )
+static void strcpy_strip_ext( char *d, const char *s )
 {
-    char *tmp = strrchr(s, '.');
-    if( !tmp ) {
+    const char *tmp = strrchr(s, '.');
+    if( !tmp )
+    {
         strcpy(d, s);
         return;
     }
     else
-    {
-        strncpy(d, s, tmp - s);
-        d[tmp - s] = 0;
-    }
+        strlcpy(d, s, tmp - s + 1 );
     while( *d )
     {
         *d = tolower(*d);
@@ -107,120 +108,127 @@ static void strcpy_strip_ext( char *d, char *s )
     }
 }
 
-static void strcpy_get_ext( char *d, char *s )
+static void strcpy_get_ext( char *d, const char *s )
 {
-    char *tmp = strrchr(s, '.');
+    const char *tmp = strrchr(s, '.');
     if( !tmp )
-    {
         strcpy(d, "");
-        return;
-    } else strcpy( d, tmp + 1 );
+    else
+        strcpy( d, tmp + 1 );
 }
 
-static int whiteonly( char *s )
+static int whiteonly( const char *s )
 {
-  while ( *s )
-  {
-        if( isalnum( *s ) ) return 0;
+    while( *s )
+    {
+        if( isalnum( *s ) )
+            return 0;
         s++;
-  }
-  return 1;
+    }
+    return 1;
 }
 
-typedef struct _subfn
+enum
+{
+    SUB_PRIORITY_NONE        = 0,
+    SUB_PRIORITY_MATCH_NONE  = 1,
+    SUB_PRIORITY_MATCH_RIGHT = 2,
+    SUB_PRIORITY_MATCH_LEFT  = 3,
+    SUB_PRIORITY_MATCH_ALL   = 4,
+};
+typedef struct
 {
     int priority;
     char *psz_fname;
     char *psz_ext;
-} subfn;
+} vlc_subfn_t;
 
 static int compare_sub_priority( const void *a, const void *b )
 {
-    if (((subfn*)a)->priority > ((subfn*)b)->priority)
-    {
+    const vlc_subfn_t *p0 = a;
+    const vlc_subfn_t *p1 = b;
+
+    if( p0->priority > p1->priority )
         return -1;
-    }
 
-    if (((subfn*)a)->priority < ((subfn*)b)->priority)
-    {
+    if( p0->priority < p1->priority )
         return 1;
-    }
 
 #ifndef UNDER_CE
-    return strcoll(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
+    return strcoll( p0->psz_fname, p1->psz_fname);
 #else
-    return strcmp(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
+    return strcmp( p0->psz_fname, p1->psz_fname);
 #endif
 }
 
+/*
+ * Check if a file ends with a subtitle extension
+ */
+int subtitles_Filter( const char *psz_dir_content )
+{
+    const char *tmp = strrchr( psz_dir_content, '.');
+
+    if( !tmp )
+        return 0;
+    tmp++;
+
+    for( int i = 0; sub_exts[i][0]; i++ )
+        if( strcasecmp( sub_exts[i], tmp ) == 0 )
+            return 1;
+    return 0;
+}
+
+
 /**
  * Convert a list of paths separated by ',' to a char**
  */
-static char **paths_to_list( char *psz_dir, char *psz_path )
+static char **paths_to_list( const char *psz_dir, char *psz_path )
 {
     unsigned int i, k, i_nb_subdirs;
     char **subdirs; /* list of subdirectories to look in */
-    
-    i_nb_subdirs = 1;
-    for( k = 0; k < strlen( psz_path ); k++ )
+    char *psz_parser = psz_path;
+
+    if( !psz_dir || !psz_path )
+        return NULL;
+
+    for( k = 0, i_nb_subdirs = 1; psz_path[k] != '\0'; k++ )
     {
         if( psz_path[k] == ',' )
-        {
             i_nb_subdirs++;
-        }
     }
-                                                                                                                            
-    if( i_nb_subdirs > 0 )
+
+    subdirs = calloc( i_nb_subdirs + 1, sizeof(char*) );
+    if( !subdirs )
+        return NULL;
+
+    for( i = 0; psz_parser && *psz_parser != '\0' ; )
     {
-        char *psz_parser, *psz_temp;
-                                                                                                                            
-        subdirs = (char**)malloc( sizeof(char*) * ( i_nb_subdirs + 1 ) );
-        memset( subdirs, 0, sizeof(char*) * ( i_nb_subdirs + 1 ) );
-        i = 0;
-        psz_parser = psz_path;
-        while( psz_parser && *psz_parser )
+        char *psz_subdir = psz_parser;
+        psz_parser = strchr( psz_subdir, ',' );
+        if( psz_parser )
         {
-            char *psz_subdir;
-            psz_subdir = psz_parser;
-            psz_parser = strchr( psz_subdir, ',' );
-            if( psz_parser )
-            {
-                *psz_parser = '\0';
+            *psz_parser++ = '\0';
+            while( *psz_parser == ' ' )
                 psz_parser++;
-                while( *psz_parser == ' ' )
-                {
-                    psz_parser++;
-                }
-            }
-            if( strlen( psz_subdir ) > 0 )
-            {
-                psz_temp = (char *)malloc( strlen(psz_dir)
-                                           + strlen(psz_subdir) + 2 );
-                if( psz_temp )
-                {
-                    sprintf( psz_temp, "%s%s%c", 
-                             psz_subdir[0] == '.' ? psz_dir : "", 
-                             psz_subdir,
-                             psz_subdir[strlen(psz_subdir) - 1] == 
-                              DIRECTORY_SEPARATOR ? '\0' : DIRECTORY_SEPARATOR );
-                    subdirs[i] = psz_temp;
-                    i++;
-                }
-            }
         }
-        subdirs[i] = NULL;
-    }
-    else
-    {
-        subdirs = NULL;
+        if( *psz_subdir == '\0' )
+            continue;
+
+        if( asprintf( &subdirs[i++], "%s%s",
+                  psz_subdir[0] == '.' ? psz_dir : "",
+                  psz_subdir ) == -1 )
+            break;
     }
+    subdirs[i] = NULL;
+
     return subdirs;
 }
 
+
 /**
  * Detect subtitle files.
  *
- * When called this function will split up the psz_fname string into a
+ * When called this function will split up the psz_name string into a
  * directory, filename and extension. It then opens the directory
  * in which the file resides and tries to find possible matches of
  * subtitles files.
@@ -228,203 +236,218 @@ static char **paths_to_list( char *psz_dir, char *psz_path )
  * \ingroup Demux
  * \param p_this the calling \ref input_thread_t
  * \param psz_path a list of subdirectories (separated by a ',') to look in.
- * \param psz_fname the complete filename to base the search on.
+ * \param psz_name the complete filename to base the search on.
  * \return a NULL terminated array of filenames with detected possible subtitles.
  * The array contains max MAX_SUBTITLE_FILES items and you need to free it after use.
  */
 char **subtitles_Detect( input_thread_t *p_this, char *psz_path,
-                         char *psz_fname )
+                         const char *psz_name_org )
 {
-    /* variables to be used for derivatives of psz_fname */
-    char *f_dir, *f_fname, *f_fname_noext, *f_fname_trim, *tmp;
-    /* variables to be used for derivatives FILE *f */
-    char *tmp_fname_noext, *tmp_fname_trim, *tmp_fname_ext, *tmpresult;
-    vlc_value_t fuzzy;
-    int len, i, j, i_sub_count, i_result2;
-    subfn *result; /* unsorted results */
-    char **result2; /* sorted results */
-    char **tmp_subdirs, **subdirs; /* list of subdirectories to look in */
-
-    FILE *f;
-    DIR *d;
-    struct dirent *de;
+    int i_fuzzy;
+    int j, i_result2, i_sub_count, i_fname_len;
+    char *f_fname_noext = NULL, *f_fname_trim = NULL;
 
-    if( !strncmp( psz_fname, "file://", 7 ) )
-    {
-        psz_fname += 7;
-    }
-
-    i_sub_count = 0;
-    len = strlen( psz_fname ) > 256 ? strlen( psz_fname ) : 256;
-
-    f_dir = (char*)malloc(len);
-    f_fname = (char*)malloc(len);
-    f_fname_noext = (char*)malloc(len);
-    f_fname_trim = (char*)malloc(len);
+    char **subdirs; /* list of subdirectories to look in */
 
-    tmp_fname_noext = (char*)malloc(len);
-    tmp_fname_trim = (char*)malloc(len);
-    tmp_fname_ext = (char*)malloc(len);
+    vlc_subfn_t *result = NULL; /* unsorted results */
+    char **result2; /* sorted results */
 
-    tmpresult = (char*)malloc(len);
+    if( !psz_name_org )
+        return NULL;
 
-    result = (subfn*)malloc( sizeof(subfn) * MAX_SUBTITLE_FILES );
-    memset( result, 0, sizeof(subfn) * MAX_SUBTITLE_FILES );
+    char *psz_fname = make_path( psz_name_org );
+    if( !psz_fname )
+        return NULL;
 
     /* extract filename & dirname from psz_fname */
-    tmp = strrchr( psz_fname, DIRECTORY_SEPARATOR );
-    if( tmp )
+    char *f_dir = strdup( psz_fname );
+    if( f_dir == NULL )
     {
-        int pos;
-        strncpy( f_fname, tmp + 1, len - 1 );
-        f_fname[len - 1] = 0;
-        pos = tmp - psz_fname + 1;
-        strncpy( f_dir, psz_fname, __MIN(pos,len-1) );
-        f_dir[__MIN(pos,len-1)] = 0;
+        free( psz_fname );
+        return NULL;
     }
-    else
+
+    char *f_fname = strrchr( f_dir, DIR_SEP_CHAR );
+    if( !f_fname )
+    {
+        free( f_dir );
+        free( psz_fname );
+        return NULL;
+    }
+    *(f_fname++) = 0; /* skip dir separator */
+
+    i_fname_len = strlen( f_fname );
+
+    f_fname_noext = malloc(i_fname_len + 1);
+    f_fname_trim = malloc(i_fname_len + 1 );
+    if( !f_fname_noext || !f_fname_trim )
     {
-        strncpy( f_fname, psz_fname, len - 1 );
-        f_fname[len - 1] = 0;
-        strcpy( f_dir, "" );
+        free( f_dir );
+        free( f_fname_noext );
+        free( f_fname_trim );
+        free( psz_fname );
+        return NULL;
     }
 
     strcpy_strip_ext( f_fname_noext, f_fname );
     strcpy_trim( f_fname_trim, f_fname_noext );
-    var_Get( p_this, "sub-autodetect-fuzzy", &fuzzy );
 
-    tmp_subdirs = paths_to_list( f_dir, psz_path );
-    subdirs = tmp_subdirs;
+    i_fuzzy = var_GetInteger( p_this, "sub-autodetect-fuzzy" );
 
-    for( j = -1; j == -1 || ( j >= 0 && subdirs != NULL && *subdirs != NULL );
-         j++)
+    result = calloc( MAX_SUBTITLE_FILES+1, sizeof(vlc_subfn_t) ); /* We check it later (simplify code) */
+    subdirs = paths_to_list( f_dir, psz_path );
+    for( j = -1, i_sub_count = 0; (j == -1) || ( j >= 0 && subdirs != NULL && subdirs[j] != NULL ); j++ )
     {
-        d = opendir( j < 0 ? f_dir : *subdirs );
-        if( d )
+        const char *psz_dir = (j < 0) ? f_dir : subdirs[j];
+        if( psz_dir == NULL || ( j >= 0 && !strcmp( psz_dir, f_dir ) ) )
+            continue;
+
+        /* parse psz_src dir */
+        DIR *dir = vlc_opendir( psz_dir );
+        if( dir == NULL )
+            continue;
+
+        msg_Dbg( p_this, "looking for a subtitle file in %s", psz_dir );
+
+        char *psz_name;
+        while( (psz_name = vlc_readdir( dir )) && i_sub_count < MAX_SUBTITLE_FILES )
         {
-            int b_found;
-            msg_Dbg( p_this, "looking for a subtitle file in %s", 
-                     j < 0 ? f_dir : *subdirs );
-            while( ( de = readdir( d ) ) )
+            if( psz_name[0] == '.' || !subtitles_Filter( psz_name ) )
             {
-                /* retrieve various parts of the filename */
-                strcpy_strip_ext( tmp_fname_noext, de->d_name );
-                strcpy_get_ext( tmp_fname_ext, de->d_name );
-                strcpy_trim( tmp_fname_trim, tmp_fname_noext );
-
-                /* does it end with a subtitle extension? */
-                b_found = 0;
-                for( i = 0; sub_exts[i]; i++ )
+                free( psz_name );
+                continue;
+            }
+
+            char tmp_fname_noext[strlen( psz_name ) + 1];
+            char tmp_fname_trim[strlen( psz_name ) + 1];
+            char tmp_fname_ext[strlen( psz_name ) + 1];
+            char *tmp;
+
+            int i_prio;
+
+            /* retrieve various parts of the filename */
+            strcpy_strip_ext( tmp_fname_noext, psz_name );
+            strcpy_get_ext( tmp_fname_ext, psz_name );
+            strcpy_trim( tmp_fname_trim, tmp_fname_noext );
+
+            i_prio = SUB_PRIORITY_NONE;
+            if( i_prio == SUB_PRIORITY_NONE && !strcmp( tmp_fname_trim, f_fname_trim ) )
+            {
+                /* matches the movie name exactly */
+                i_prio = SUB_PRIORITY_MATCH_ALL;
+            }
+            if( i_prio == SUB_PRIORITY_NONE &&
+                ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
+            {
+                /* contains the movie name */
+                tmp += strlen( f_fname_trim );
+                if( whiteonly( tmp ) )
+                {
+                    /* chars in front of the movie name */
+                    i_prio = SUB_PRIORITY_MATCH_RIGHT;
+                }
+                else
                 {
-                    if( strcmp( sub_exts[i], tmp_fname_ext ) == 0 )
-                    {
-                        b_found = 1;
-                        msg_Dbg( p_this, "found a possible subtitle: %s",
-                                 de->d_name );
-                        break;
-                    }
+                    /* chars after (and possibly in front of)
+                     * the movie name */
+                    i_prio = SUB_PRIORITY_MATCH_LEFT;
+                }
+            }
+            if( i_prio == SUB_PRIORITY_NONE &&
+                j == 0 )
+            {
+                /* doesn't contain the movie name, prefer files in f_dir over subdirs */
+                i_prio = SUB_PRIORITY_MATCH_NONE;
+            }
+            if( i_prio >= i_fuzzy )
+            {
+                char psz_path[strlen( psz_dir ) + strlen( psz_name ) + 2];
+                struct stat st;
+
+                sprintf( psz_path, "%s"DIR_SEP"%s", psz_dir, psz_name );
+                if( !strcmp( psz_path, psz_fname ) )
+                {
+                    free( psz_name );
+                    continue;
                 }
 
-                /* we have a (likely) subtitle file */
-                if( b_found )
+                if( !vlc_stat( psz_path, &st ) && S_ISREG( st.st_mode ) && result )
                 {
-                    int i_prio = 0;
-                    if( !i_prio && !strcmp( tmp_fname_trim, f_fname_trim ) )
-                    {
-                        /* matches the movie name exactly */
-                        i_prio = 4;
-                    }
-                    if( !i_prio &&
-                        ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
-                    {
-                        /* contains the movie name */
-                        tmp += strlen( f_fname_trim );
-                        if( whiteonly( tmp ) )
-                        {
-                            /* chars in front of the movie name */
-                            i_prio = 2;
-                        }
-                        else
-                        {
-                            /* chars after (and possibly in front of)
-                             * the movie name */
-                            i_prio = 3;
-                        }
-                    }
-                    if( !i_prio )
-                    {
-                        /* doesn't contain the movie name */
-                        if( j == 0 ) i_prio = 1;
-                    }
-
-                    if( i_prio >= fuzzy.i_int )
-                    {
-                        sprintf( tmpresult, "%s%s", j == -1 ? f_dir : *subdirs,
-                                 de->d_name );
-                        msg_Dbg( p_this, "autodetected subtitle: %s with "
-                                 "priority %d", de->d_name, i_prio );
-                        if( ( f = fopen( tmpresult, "rt" ) ) )
-                        {
-                            fclose( f );
-                            result[i_sub_count].priority = i_prio;
-                            result[i_sub_count].psz_fname = strdup(tmpresult);
-                            result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
-                            i_sub_count++;
-                        }
-                    }
+                    msg_Dbg( p_this,
+                            "autodetected subtitle: %s with priority %d",
+                            psz_path, i_prio );
+                    result[i_sub_count].priority = i_prio;
+                    result[i_sub_count].psz_fname = strdup( psz_path );
+                    result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
+                    i_sub_count++;
+                }
+                else
+                {
+                    msg_Dbg( p_this, "stat failed (autodetecting subtitle: %s with priority %d)",
+                             psz_path, i_prio );
                 }
-                if( i_sub_count >= MAX_SUBTITLE_FILES ) break;
             }
-            closedir( d );
+            free( psz_name );
         }
-        if( j >= 0 ) free( *subdirs++ );
+        closedir( dir );
+    }
+    if( subdirs )
+    {
+        for( j = 0; subdirs[j]; j++ )
+            free( subdirs[j] );
+        free( subdirs );
     }
-
-    if( tmp_subdirs ) free( tmp_subdirs );
-
     free( f_dir );
-    free( f_fname );
-    free( f_fname_noext );
     free( f_fname_trim );
+    free( f_fname_noext );
+    free( psz_fname );
 
-    free( tmp_fname_noext );
-    free( tmp_fname_trim );
-    free( tmp_fname_ext );
-
-    free( tmpresult );
+    if( !result )
+        return NULL;
 
-    qsort( result, i_sub_count, sizeof( subfn ), compare_sub_priority );
+    qsort( result, i_sub_count, sizeof(vlc_subfn_t), compare_sub_priority );
 
-    result2 = (char**)malloc( sizeof(char*) * ( i_sub_count + 1 ) );
-    memset( result2, 0, sizeof(char*) * ( i_sub_count + 1 ) );
-    i_result2 = 0;
+    result2 = calloc( i_sub_count + 1, sizeof(char*) );
 
-    for( i = 0; i < i_sub_count; i++ )
+    for( j = 0, i_result2 = 0; j < i_sub_count && result2 != NULL; j++ )
     {
-        if( result[i].psz_ext && !strcasecmp( result[i].psz_ext, "sub" ) )
+        bool b_reject = false;
+
+        if( !result[j].psz_fname || !result[j].psz_ext ) /* memory out */
+            break;
+
+        if( !strcasecmp( result[j].psz_ext, "sub" ) )
         {
-            int j;
-            for( j = 0; j < i_sub_count; j++ )
+            int i;
+            for( i = 0; i < i_sub_count; i++ )
             {
-                if( result[j].psz_fname && result[i].psz_fname &&
-                    !strncasecmp( result[i].psz_fname, result[j].psz_fname, sizeof( result[i].psz_fname) - 4 ) && 
-                    !strcasecmp( result[j].psz_ext, "idx" ) )
+                if( result[i].psz_fname && result[i].psz_ext &&
+                    !strncasecmp( result[j].psz_fname, result[i].psz_fname,
+                                  strlen( result[j].psz_fname) - 3 ) &&
+                    !strcasecmp( result[i].psz_ext, "idx" ) )
                     break;
-                
-            }
-            if( j >= i_sub_count )
-            {
-                result2[i_result2] = result[i].psz_fname;
-                i_result2++;
             }
+            if( i < i_sub_count )
+                b_reject = true;
         }
-        else
+        else if( !strcasecmp( result[j].psz_ext, "cdg" ) )
         {
-            result2[i_result2] = result[i].psz_fname;
-            i_result2++;
+            if( result[j].priority < SUB_PRIORITY_MATCH_ALL )
+                b_reject = true;
         }
+
+        /* */
+        if( !b_reject )
+            result2[i_result2++] = strdup( result[j].psz_fname );
+    }
+
+    for( j = 0; j < i_sub_count; j++ )
+    {
+        free( result[j].psz_fname );
+        free( result[j].psz_ext );
     }
-    result2[i_result2+1] = NULL;
     free( result );
+
     return result2;
 }
+