]> git.sesse.net Git - vlc/blobdiff - src/input/subtitles.c
Copyright fixes
[vlc] / src / input / subtitles.c
index ca5f8df3dd8300e9f02073026ea59b6b0a0cddbe..751562c061f542dad1fc7c05630c70ae68784b5e 100644 (file)
@@ -1,8 +1,8 @@
 /*****************************************************************************
  * subtitles.c
  *****************************************************************************
- * Copyright (C) 2003 VideoLAN
- * $Id: subtitles.c,v 1.1 2003/09/22 03:40:06 hartman Exp $
+ * Copyright (C) 2003-2004 VideoLAN (Centrale Réseaux) and its contributors
+ * $Id$
  *
  * Authors: Derk-Jan Hartman <hartman at videolan.org>
  * This is adapted code from the GPL'ed MPlayer (http://mplayerhq.hu)
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  *****************************************************************************/
 
+/**
+ *  \file
+ *  This file contains functions to dectect subtitle files.
+ */
+
 #include <stdlib.h>
 #include <vlc/vlc.h>
 #include <vlc/input.h>
 
-#include "ninput.h"
-#include <dirent.h>
+#ifdef HAVE_DIRENT_H
+#   include <dirent.h>
+#endif
+
 #include <ctype.h>
 
+/**
+ * What's between a directory and a filename?
+ */
 #if defined( WIN32 )
     #define DIRECTORY_SEPARATOR '\\'
 #else
     #define DIRECTORY_SEPARATOR '/'
 #endif
 
+/**
+ * We are not going to autodetect more subtitle files than this.
+ */
 #define MAX_SUBTITLE_FILES 128
 
 
+/**
+ * The possible extentions 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 )
 {
     /* skip leading whitespace */
     while( *s && !isalnum(*s) )
     {
-       s++;
+        s++;
     }
     for(;;)
     {
-       /* copy word */
-       while( *s && isalnum(*s) )
+        /* copy word */
+        while( *s && isalnum(*s) )
         {
-           *d = tolower(*s);
-           s++; d++;
-       }
-       if (*s == 0) break;
-       /* trim excess whitespace */
-       while( *s && !isalnum(*s) )
+            *d = tolower(*s);
+            s++; d++;
+        }
+        if (*s == 0) break;
+        /* trim excess whitespace */
+        while( *s && !isalnum(*s) )
         {
-           s++;
-       }
-       if( *s == 0 ) break;
-       *d++ = ' ';
+            s++;
+        }
+        if( *s == 0 ) break;
+        *d++ = ' ';
     }
     *d = 0;
 }
+
 static void strcpy_strip_ext( char *d, char *s )
 {
     char *tmp = strrchr(s, '.');
     if( !tmp ) {
-       strcpy(d, s);
-       return;
+        strcpy(d, s);
+        return;
     }
     else
     {
-       strncpy(d, s, tmp - s);
-       d[tmp - s] = 0;
+        strncpy(d, s, tmp - s);
+        d[tmp - s] = 0;
     }
     while( *d )
     {
-       *d = tolower(*d);
-       d++;
+        *d = tolower(*d);
+        d++;
     }
 }
+
 static void strcpy_get_ext( char *d, char *s )
 {
     char *tmp = strrchr(s, '.');
     if( !tmp )
     {
-       strcpy(d, "");
-       return;
+        strcpy(d, "");
+        return;
     } else strcpy( d, tmp + 1 );
 }
 
@@ -99,54 +119,141 @@ static int whiteonly( char *s )
 {
   while ( *s )
   {
-       if( isalnum( *s ) ) return 0;
-       s++;
+        if( isalnum( *s ) ) return 0;
+        s++;
   }
   return 1;
 }
 
-typedef struct _subfn 
+typedef struct _subfn
 {
     int priority;
     char *psz_fname;
+    char *psz_ext;
 } subfn;
 
 static int compare_sub_priority( const void *a, const void *b )
 {
-    if (((subfn*)a)->priority > ((subfn*)b)->priority) {
-       return -1;
-    } else if (((subfn*)a)->priority < ((subfn*)b)->priority) {
-       return 1;
-    } else {
-       return strcoll(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
+    if (((subfn*)a)->priority > ((subfn*)b)->priority)
+    {
+        return -1;
     }
+
+    if (((subfn*)a)->priority < ((subfn*)b)->priority)
+    {
+        return 1;
+    }
+
+#ifndef UNDER_CE
+    return strcoll(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
+#else
+    return strcmp(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
+#endif
 }
 
-/*****************************************************************************
- * subtitles_Detect: Use the original filename to find a subtitle files.
- *****************************************************************************/
-char** subtitles_Detect( input_thread_t *p_input, char *psz_path, char *psz_fname )
+/**
+ * Convert a list of paths separated by ',' to a char**
+ */
+static char **paths_to_list( 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++ )
+    {
+        if( psz_path[k] == ',' )
+        {
+            i_nb_subdirs++;
+        }
+    }
+                                                                                                                            
+    if( i_nb_subdirs > 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_subdir = psz_parser;
+            psz_parser = strchr( psz_subdir, ',' );
+            if( psz_parser )
+            {
+                *psz_parser = '\0';
+                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;
+    }
+    return subdirs;
+}
+
+/**
+ * Detect subtitle files.
+ *
+ * When called this function will split up the psz_fname 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.
+ *
+ * \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.
+ * \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 )
 {
     /* 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;
-    int len, i, j, i_sub_count, i_sub_match_fuzziness;
+    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;
 
-    char * sub_exts[] = {  "utf", "utf8", "utf-8", "sub", "srt", "smi", "txt", "ssa", NULL};
-    /* extensions from unsupported types */
-    /* rt, aqt, jss, js, ass */
+    if( !strncmp( psz_fname, "file://", 7 ) )
+    {
+        psz_fname += 7;
+    }
 
     i_sub_count = 0;
-    len = ( strlen( psz_fname ) > 256 ? strlen( psz_fname ) : 256 ) +
-        ( strlen( psz_path ) > 256 ? strlen( psz_path ) : 256 ) + 2;
+    len = strlen( psz_fname ) > 256 ? strlen( psz_fname ) : 256;
 
     f_dir = (char*)malloc(len);
     f_fname = (char*)malloc(len);
@@ -167,64 +274,68 @@ char** subtitles_Detect( input_thread_t *p_input, char *psz_path, char *psz_fnam
     if( tmp )
     {
         int pos;
-       strcpy( f_fname, tmp + 1 );
-       pos = tmp - psz_fname;
-       strncpy( f_dir, psz_fname, pos + 1 );
-       f_dir[pos + 1] = 0;
+        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;
     }
     else
     {
-       strcpy( f_fname, psz_fname );
-       strcpy( f_dir, "" );
+        strncpy( f_fname, psz_fname, len - 1 );
+        f_fname[len - 1] = 0;
+        strcpy( f_dir, "" );
     }
 
     strcpy_strip_ext( f_fname_noext, f_fname );
     strcpy_trim( f_fname_trim, f_fname_noext );
+    var_Get( p_this, "sub-autodetect-fuzzy", &fuzzy );
 
-    i_sub_match_fuzziness = 3;
-    /* 0 = nothing
-     * 1 = any subtitle file
-     * 2 = any sub file containing movie name
-     * 3 = sub file matching movie name exactly
-     * 4 = sub file matching movie name with additional chars 
-     */
-    for( j = 0; j <= 1; j++)
+    tmp_subdirs = paths_to_list( f_dir, psz_path );
+    subdirs = tmp_subdirs;
+
+    for( j = -1; j == -1 || ( j >= 0 && subdirs != NULL && *subdirs != NULL );
+         j++)
     {
-       d = opendir( j == 0 ? f_dir : psz_path );
-       if( d )
+        d = opendir( j < 0 ? f_dir : *subdirs );
+        if( d )
         {
             int b_found;
-           while( de = readdir( d ) )
+            msg_Dbg( p_this, "looking for a subtitle file in %s", 
+                     j < 0 ? f_dir : *subdirs );
+            while( ( de = readdir( d ) ) )
             {
-               /* 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++ )
+                /* 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++ )
                 {
-                   if( strcmp(sub_exts[i], tmp_fname_ext ) == 0 )
+                    if( strcmp( sub_exts[i], tmp_fname_ext ) == 0 )
                     {
-                       b_found = 1;
-                        msg_Dbg( p_input, "found subtitle: %s", de->d_name );
-                       break;
-                   }
-               }
-               /* we have a (likely) subtitle file */
-               if( b_found )
+                        b_found = 1;
+                        msg_Dbg( p_this, "found a possible subtitle: %s",
+                                 de->d_name );
+                        break;
+                    }
+                }
+
+                /* we have a (likely) subtitle file */
+                if( b_found )
                 {
-                   int i_prio = 0;
-                   if( !i_prio && strcmp( tmp_fname_trim, f_fname_trim ) == 0 )
+                    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 ) ) )
+                        /* matches the movie name exactly */
+                        i_prio = 4;
+                    }
+                    if( !i_prio &&
+                        ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
                     {
-                       /* contains the movie name */
+                        /* contains the movie name */
                         tmp += strlen( f_fname_trim );
                         if( whiteonly( tmp ) )
                         {
@@ -233,36 +344,42 @@ char** subtitles_Detect( input_thread_t *p_input, char *psz_path, char *psz_fnam
                         }
                         else
                         {
-                            /* chars after (and possibly in front of) the movie name */
+                            /* chars after (and possibly in front of)
+                             * the movie name */
                             i_prio = 3;
                         }
-                   }
-                   if( !i_prio )
+                    }
+                    if( !i_prio )
                     {
-                       /* doesn't contain the movie name */
-                       if( j == 0 ) i_prio = 1;
-                   }
+                        /* doesn't contain the movie name */
+                        if( j == 0 ) i_prio = 1;
+                    }
 
-                   if( i_prio >= i_sub_match_fuzziness )
+                    if( i_prio >= fuzzy.i_int )
                     {
-                        sprintf( tmpresult, "%s%s", j == 0 ? f_dir : psz_path, de->d_name );
-                        msg_Dbg( p_input, "autodetected subtitle: %s with priority %d", de->d_name, i_prio );
-                       if( f = fopen( tmpresult, "rt" ) )
+                        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 );
-                           i_sub_count++;
-                       }
-                   }
-
-               }
-               if( i_sub_count >= MAX_SUBTITLE_FILES ) break;
-           }
-           closedir( d );
-       }
+                            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++;
+                        }
+                    }
+                }
+                if( i_sub_count >= MAX_SUBTITLE_FILES ) break;
+            }
+            closedir( d );
+        }
+        if( j >= 0 ) free( *subdirs++ );
     }
-    
+
+    if( tmp_subdirs ) free( tmp_subdirs );
+
     free( f_dir );
     free( f_fname );
     free( f_fname_noext );
@@ -278,13 +395,33 @@ char** subtitles_Detect( input_thread_t *p_input, char *psz_path, char *psz_fnam
 
     result2 = (char**)malloc( sizeof(char*) * ( i_sub_count + 1 ) );
     memset( result2, 0, sizeof(char*) * ( i_sub_count + 1 ) );
+    i_result2 = 0;
 
     for( i = 0; i < i_sub_count; i++ )
     {
-       result2[i] = result[i].psz_fname;
+        if( result[i].psz_ext && !strcasecmp( result[i].psz_ext, "sub" ) )
+        {
+            int j;
+            for( j = 0; j < i_sub_count; j++ )
+            {
+                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" ) )
+                    break;
+                
+            }
+            if( j >= i_sub_count )
+            {
+                result2[i_result2] = result[i].psz_fname;
+                i_result2++;
+            }
+        }
+        else
+        {
+            result2[i_result2] = result[i].psz_fname;
+            i_result2++;
+        }
     }
-    result2[i_sub_count] = NULL;
     free( result );
     return result2;
 }
-