git.sesse.net Git - vlc/blob - src/input/subtitles.c

   1 /*****************************************************************************
   2  * subtitles.c
   3  *****************************************************************************
   4  * Copyright (C) 2003-2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Derk-Jan Hartman <hartman at videolan.org>
   8  * This is adapted code from the GPL'ed MPlayer (http://mplayerhq.hu)
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /**
  26  *  \file
  27  *  This file contains functions to dectect subtitle files.
  28  */
  29
  30 #ifdef HAVE_CONFIG_H
  31 # include "config.h"
  32 #endif
  33
  34 #include <vlc_common.h>
  35 #include <vlc_input.h>
  36 #include <vlc_charset.h>
  37
  38 #ifdef HAVE_DIRENT_H
  39 #   include <dirent.h>
  40 #endif
  41
  42 #include <limits.h>
  43
  44 #ifdef HAVE_UNISTD_H
  45 #   include <unistd.h>
  46 #endif
  47 #include <sys/stat.h>
  48
  49 #include <ctype.h>
  50 #include "input_internal.h"
  51
  52 /**
  53  * We are not going to autodetect more subtitle files than this.
  54  */
  55 #define MAX_SUBTITLE_FILES 128
  56
  57
  58 /**
  59  * The possible extensions for subtitle files we support
  60  */
  61 static const char const sub_exts[][6] = {
  62     "utf", "utf8", "utf-8",
  63     "sub", "srt", "smi",
  64     "txt", "ssa", "idx",
  65     "ass", "rt", "aqt",
  66     "usf", "jss", "cdg",
  67     ""
  68 };
  69
  70 static void strcpy_trim( char *d, const char *s )
  71 {
  72     /* skip leading whitespace */
  73     while( *s && !isalnum(*s) )
  74     {
  75         s++;
  76     }
  77     for(;;)
  78     {
  79         /* copy word */
  80         while( *s && isalnum(*s) )
  81         {
  82             *d = tolower(*s);
  83             s++; d++;
  84         }
  85         if( *s == 0 ) break;
  86         /* trim excess whitespace */
  87         while( *s && !isalnum(*s) )
  88         {
  89             s++;
  90         }
  91         if( *s == 0 ) break;
  92         *d++ = ' ';
  93     }
  94     *d = 0;
  95 }
  96
  97 static void strcpy_strip_ext( char *d, const char *s )
  98 {
  99     const char *tmp = strrchr(s, '.');
 100     if( !tmp )
 101     {
 102         strcpy(d, s);
 103         return;
 104     }
 105     else
 106         strlcpy(d, s, tmp - s + 1 );
 107     while( *d )
 108     {
 109         *d = tolower(*d);
 110         d++;
 111     }
 112 }
 113
 114 static void strcpy_get_ext( char *d, const char *s )
 115 {
 116     const char *tmp = strrchr(s, '.');
 117     if( !tmp )
 118         strcpy(d, "");
 119     else
 120         strcpy( d, tmp + 1 );
 121 }
 122
 123 static int whiteonly( const char *s )
 124 {
 125     while( *s )
 126     {
 127         if( isalnum( *s ) )
 128             return 0;
 129         s++;
 130     }
 131     return 1;
 132 }
 133
 134 enum
 135 {
 136     SUB_PRIORITY_NONE = 0,
 137     SUB_PRIORITY_MATCH_NONE = 1,
 138     SUB_PRIORITY_MATCH_RIGHT = 2,
 139     SUB_PRIORITY_MATCH_LEFT = 3,
 140     SUB_PRIORITY_MATCH_ALL = 4,
 141 };
 142 typedef struct
 143 {
 144     int priority;
 145     char *psz_fname;
 146     char *psz_ext;
 147 } vlc_subfn_t;
 148
 149 static int compare_sub_priority( const void *a, const void *b )
 150 {
 151     const vlc_subfn_t *p0 = a;
 152     const vlc_subfn_t *p1 = b;
 153
 154     if( p0->priority > p1->priority )
 155         return -1;
 156
 157     if( p0->priority < p1->priority )
 158         return 1;
 159
 160 #ifndef UNDER_CE
 161     return strcoll( p0->psz_fname, p1->psz_fname);
 162 #else
 163     return strcmp( p0->psz_fname, p1->psz_fname);
 164 #endif
 165 }
 166
 167 /*
 168  * Check if a file ends with a subtitle extension
 169  */
 170 int subtitles_Filter( const char *psz_dir_content )
 171 {
 172     const char *tmp = strrchr( psz_dir_content, '.');
 173     int i;
 174
 175     if( !tmp )
 176         return 0;
 177     tmp++;
 178
 179     for( i = 0; sub_exts[i][0]; i++ )
 180         if( strcasecmp( sub_exts[i], tmp ) == 0 )
 181             return 1;
 182     return 0;
 183 }
 184
 185
 186 /**
 187  * Convert a list of paths separated by ',' to a char**
 188  */
 189 static char **paths_to_list( const char *psz_dir, char *psz_path )
 190 {
 191     unsigned int i, k, i_nb_subdirs;
 192     char **subdirs; /* list of subdirectories to look in */
 193     char *psz_parser = psz_path;
 194
 195     if( !psz_dir || !psz_path )
 196         return NULL;
 197
 198     for( k = 0, i_nb_subdirs = 1; psz_path[k] != '\0'; k++ )
 199     {
 200         if( psz_path[k] == ',' )
 201             i_nb_subdirs++;
 202     }
 203
 204     subdirs = calloc( i_nb_subdirs + 1, sizeof(char*) );
 205     if( !subdirs )
 206         return NULL;
 207
 208     for( i = 0; psz_parser && *psz_parser != '\0' ; )
 209     {
 210         char *psz_subdir = psz_parser;
 211         psz_parser = strchr( psz_subdir, ',' );
 212         if( psz_parser )
 213         {
 214             *psz_parser++ = '\0';
 215             while( *psz_parser == ' ' )
 216                 psz_parser++;
 217         }
 218         if( *psz_subdir == '\0' )
 219             continue;
 220
 221         if( asprintf( &subdirs[i++], "%s%s%c",
 222                   psz_subdir[0] == '.' ? psz_dir : "",
 223                   psz_subdir,
 224                   psz_subdir[strlen(psz_subdir) - 1] == DIR_SEP_CHAR ?
 225                                            '\0' : DIR_SEP_CHAR ) == -1 )
 226             break;
 227     }
 228     subdirs[i] = NULL;
 229
 230     return subdirs;
 231 }
 232
 233
 234 /**
 235  * Detect subtitle files.
 236  *
 237  * When called this function will split up the psz_name string into a
 238  * directory, filename and extension. It then opens the directory
 239  * in which the file resides and tries to find possible matches of
 240  * subtitles files.
 241  *
 242  * \ingroup Demux
 243  * \param p_this the calling \ref input_thread_t
 244  * \param psz_path a list of subdirectories (separated by a ',') to look in.
 245  * \param psz_name the complete filename to base the search on.
 246  * \return a NULL terminated array of filenames with detected possible subtitles.
 247  * The array contains max MAX_SUBTITLE_FILES items and you need to free it after use.
 248  */
 249 char **subtitles_Detect( input_thread_t *p_this, char *psz_path,
 250                          const char *psz_name_org )
 251 {
 252     vlc_value_t fuzzy;
 253     int j, i_result2, i_sub_count, i_fname_len;
 254     char *f_dir = NULL, *f_fname = NULL, *f_fname_noext = NULL, *f_fname_trim = NULL;
 255     char *tmp = NULL;
 256
 257     char **subdirs; /* list of subdirectories to look in */
 258
 259     vlc_subfn_t *result = NULL; /* unsorted results */
 260     char **result2; /* sorted results */
 261     const char *psz_fname = psz_name_org;
 262
 263     if( !psz_fname )
 264         return NULL;
 265
 266     if( !strncmp( psz_fname, "file://", 7 ) )
 267         psz_fname += 7;
 268
 269     /* extract filename & dirname from psz_fname */
 270     tmp = strrchr( psz_fname, DIR_SEP_CHAR );
 271     if( tmp )
 272     {
 273         const int i_dirlen = strlen(psz_fname)-strlen(tmp)+1; /* include the separator */
 274         f_fname = strdup( &tmp[1] );    /* skip the separator */
 275         f_dir = strndup( psz_fname, i_dirlen );
 276     }
 277     else
 278     {
 279 #ifdef HAVE_UNISTD_H
 280         /* Get the current working directory */
 281         char *psz_cwd = getcwd( NULL, 0 );
 282 #else
 283         char *psz_cwd = NULL;
 284 #endif
 285         if( !psz_cwd )
 286             return NULL;
 287
 288         f_fname = strdup( psz_fname );
 289         if( asprintf( &f_dir, "%s%c", psz_cwd, DIR_SEP_CHAR ) == -1 )
 290             f_dir = NULL; /* Assure that function will return in next test */
 291         free( psz_cwd );
 292     }
 293     if( !f_fname || !f_dir )
 294     {
 295         free( f_fname );
 296         free( f_dir );
 297         return NULL;
 298     }
 299
 300     i_fname_len = strlen( f_fname );
 301
 302     f_fname_noext = malloc(i_fname_len + 1);
 303     f_fname_trim = malloc(i_fname_len + 1 );
 304     if( !f_fname_noext || !f_fname_trim )
 305     {
 306         free( f_fname );
 307         free( f_dir );
 308         free( f_fname_noext );
 309         free( f_fname_trim );
 310         return NULL;
 311     }
 312
 313     strcpy_strip_ext( f_fname_noext, f_fname );
 314     strcpy_trim( f_fname_trim, f_fname_noext );
 315
 316     var_Get( p_this, "sub-autodetect-fuzzy", &fuzzy );
 317
 318     result = calloc( MAX_SUBTITLE_FILES+1, sizeof(vlc_subfn_t) ); /* We check it later (simplify code) */
 319     subdirs = paths_to_list( f_dir, psz_path );
 320     for( j = -1, i_sub_count = 0; (j == -1) || ( j >= 0 && subdirs != NULL && subdirs[j] != NULL ); j++ )
 321     {
 322         const char *psz_dir = j < 0 ? f_dir : subdirs[j];
 323         char **ppsz_dir_content;
 324         int i_dir_content;
 325         int a;
 326
 327         if( psz_dir == NULL || ( j >= 0 && !strcmp( psz_dir, f_dir ) ) )
 328             continue;
 329
 330         /* parse psz_src dir */
 331         i_dir_content = utf8_scandir( psz_dir, &ppsz_dir_content,
 332                                       subtitles_Filter, NULL );
 333         if( i_dir_content < 0 )
 334             continue;
 335
 336         msg_Dbg( p_this, "looking for a subtitle file in %s", psz_dir );
 337         for( a = 0; a < i_dir_content && i_sub_count < MAX_SUBTITLE_FILES ; a++ )
 338         {
 339             char *psz_name = ppsz_dir_content[a];
 340             char tmp_fname_noext[strlen( psz_name ) + 1];
 341             char tmp_fname_trim[strlen( psz_name ) + 1];
 342             char tmp_fname_ext[strlen( psz_name ) + 1];
 343
 344             int i_prio;
 345
 346             if( psz_name == NULL )
 347                 continue;
 348
 349             /* retrieve various parts of the filename */
 350             strcpy_strip_ext( tmp_fname_noext, psz_name );
 351             strcpy_get_ext( tmp_fname_ext, psz_name );
 352             strcpy_trim( tmp_fname_trim, tmp_fname_noext );
 353
 354             i_prio = SUB_PRIORITY_NONE;
 355             if( i_prio == SUB_PRIORITY_NONE && !strcmp( tmp_fname_trim, f_fname_trim ) )
 356             {
 357                 /* matches the movie name exactly */
 358                 i_prio = SUB_PRIORITY_MATCH_ALL;
 359             }
 360             if( i_prio == SUB_PRIORITY_NONE &&
 361                 ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
 362             {
 363                 /* contains the movie name */
 364                 tmp += strlen( f_fname_trim );
 365                 if( whiteonly( tmp ) )
 366                 {
 367                     /* chars in front of the movie name */
 368                     i_prio = SUB_PRIORITY_MATCH_RIGHT;
 369                 }
 370                 else
 371                 {
 372                     /* chars after (and possibly in front of)
 373                      * the movie name */
 374                     i_prio = SUB_PRIORITY_MATCH_LEFT;
 375                 }
 376             }
 377             if( i_prio == SUB_PRIORITY_NONE &&
 378                 j == 0 )
 379             {
 380                 /* doesn't contain the movie name, prefer files in f_dir over subdirs */
 381                 i_prio = SUB_PRIORITY_MATCH_NONE;
 382             }
 383             if( i_prio >= fuzzy.i_int )
 384             {
 385                 char psz_path[strlen( psz_dir ) + strlen( psz_name ) + 1];
 386                 struct stat st;
 387
 388                 sprintf( psz_path, "%s%s", psz_dir, psz_name );
 389                 if( !strcmp( psz_path, psz_fname ) )
 390                     continue;
 391
 392                 if( !utf8_stat( psz_path, &st ) && S_ISREG( st.st_mode ) && result )
 393                 {
 394                     msg_Dbg( p_this,
 395                             "autodetected subtitle: %s with priority %d",
 396                             psz_path, i_prio );
 397                     result[i_sub_count].priority = i_prio;
 398                     result[i_sub_count].psz_fname = strdup( psz_path );
 399                     result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
 400                     i_sub_count++;
 401                 }
 402                 else
 403                 {
 404                     msg_Dbg( p_this, "stat failed (autodetecting subtitle: %s with priority %d)",
 405                              psz_path, i_prio );
 406                 }
 407             }
 408         }
 409         if( ppsz_dir_content )
 410         {
 411             for( a = 0; a < i_dir_content; a++ )
 412                 free( ppsz_dir_content[a] );
 413             free( ppsz_dir_content );
 414         }
 415     }
 416     if( subdirs )
 417     {
 418         for( j = 0; subdirs[j]; j++ )
 419             free( subdirs[j] );
 420         free( subdirs );
 421     }
 422     free( f_fname );
 423     free( f_dir );
 424     free( f_fname_trim );
 425     free( f_fname_noext );
 426
 427     if( !result )
 428         return NULL;
 429
 430     qsort( result, i_sub_count, sizeof(vlc_subfn_t), compare_sub_priority );
 431
 432     result2 = calloc( i_sub_count + 1, sizeof(char*) );
 433
 434     for( j = 0, i_result2 = 0; j < i_sub_count && result2 != NULL; j++ )
 435     {
 436         bool b_reject = false;
 437
 438         if( !result[j].psz_fname || !result[j].psz_ext ) /* memory out */
 439             break;
 440
 441         if( !strcasecmp( result[j].psz_ext, "sub" ) )
 442         {
 443             int i;
 444             for( i = 0; i < i_sub_count; i++ )
 445             {
 446                 if( result[i].psz_fname && result[i].psz_ext &&
 447                     !strncasecmp( result[j].psz_fname, result[i].psz_fname,
 448                                   strlen( result[j].psz_fname) - 3 ) &&
 449                     !strcasecmp( result[i].psz_ext, "idx" ) )
 450                     break;
 451             }
 452             if( i < i_sub_count )
 453                 b_reject = true;
 454         }
 455         else if( !strcasecmp( result[j].psz_ext, "cdg" ) )
 456         {
 457             if( result[j].priority < SUB_PRIORITY_MATCH_ALL )
 458                 b_reject = true;
 459         }
 460
 461         /* */
 462         if( !b_reject )
 463             result2[i_result2++] = strdup( result[j].psz_fname );
 464     }
 465
 466     for( j = 0; j < i_sub_count; j++ )
 467     {
 468         free( result[j].psz_fname );
 469         free( result[j].psz_ext );
 470     }
 471     free( result );
 472
 473     return result2;
 474 }
 475