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     "idx", "sub",  "srt",
  63     "ssa", "ass",  "smi",
  64     "utf", "utf8", "utf-8",
  65     "txt", "rt",   "aqt",
  66     "usf", "jss",  "cdg",
  67     "psb", "mpsub","mpl2",
  68     "pjs", "dks",
  69     ""
  70 };
  71
  72 static void strcpy_trim( char *d, const char *s )
  73 {
  74     /* skip leading whitespace */
  75     while( *s && !isalnum(*s) )
  76     {
  77         s++;
  78     }
  79     for(;;)
  80     {
  81         /* copy word */
  82         while( *s && isalnum(*s) )
  83         {
  84             *d = tolower(*s);
  85             s++; d++;
  86         }
  87         if( *s == 0 ) break;
  88         /* trim excess whitespace */
  89         while( *s && !isalnum(*s) )
  90         {
  91             s++;
  92         }
  93         if( *s == 0 ) break;
  94         *d++ = ' ';
  95     }
  96     *d = 0;
  97 }
  98
  99 static void strcpy_strip_ext( char *d, const char *s )
 100 {
 101     const char *tmp = strrchr(s, '.');
 102     if( !tmp )
 103     {
 104         strcpy(d, s);
 105         return;
 106     }
 107     else
 108         strlcpy(d, s, tmp - s + 1 );
 109     while( *d )
 110     {
 111         *d = tolower(*d);
 112         d++;
 113     }
 114 }
 115
 116 static void strcpy_get_ext( char *d, const char *s )
 117 {
 118     const char *tmp = strrchr(s, '.');
 119     if( !tmp )
 120         strcpy(d, "");
 121     else
 122         strcpy( d, tmp + 1 );
 123 }
 124
 125 static int whiteonly( const char *s )
 126 {
 127     while( *s )
 128     {
 129         if( isalnum( *s ) )
 130             return 0;
 131         s++;
 132     }
 133     return 1;
 134 }
 135
 136 enum
 137 {
 138     SUB_PRIORITY_NONE = 0,
 139     SUB_PRIORITY_MATCH_NONE = 1,
 140     SUB_PRIORITY_MATCH_RIGHT = 2,
 141     SUB_PRIORITY_MATCH_LEFT = 3,
 142     SUB_PRIORITY_MATCH_ALL = 4,
 143 };
 144 typedef struct
 145 {
 146     int priority;
 147     char *psz_fname;
 148     char *psz_ext;
 149 } vlc_subfn_t;
 150
 151 static int compare_sub_priority( const void *a, const void *b )
 152 {
 153     const vlc_subfn_t *p0 = a;
 154     const vlc_subfn_t *p1 = b;
 155
 156     if( p0->priority > p1->priority )
 157         return -1;
 158
 159     if( p0->priority < p1->priority )
 160         return 1;
 161
 162 #ifndef UNDER_CE
 163     return strcoll( p0->psz_fname, p1->psz_fname);
 164 #else
 165     return strcmp( p0->psz_fname, p1->psz_fname);
 166 #endif
 167 }
 168
 169 /*
 170  * Check if a file ends with a subtitle extension
 171  */
 172 int subtitles_Filter( const char *psz_dir_content )
 173 {
 174     const char *tmp = strrchr( psz_dir_content, '.');
 175     int i;
 176
 177     if( !tmp )
 178         return 0;
 179     tmp++;
 180
 181     for( i = 0; sub_exts[i][0]; i++ )
 182         if( strcasecmp( sub_exts[i], tmp ) == 0 )
 183             return 1;
 184     return 0;
 185 }
 186
 187
 188 /**
 189  * Convert a list of paths separated by ',' to a char**
 190  */
 191 static char **paths_to_list( const char *psz_dir, char *psz_path )
 192 {
 193     unsigned int i, k, i_nb_subdirs;
 194     char **subdirs; /* list of subdirectories to look in */
 195     char *psz_parser = psz_path;
 196
 197     if( !psz_dir || !psz_path )
 198         return NULL;
 199
 200     for( k = 0, i_nb_subdirs = 1; psz_path[k] != '\0'; k++ )
 201     {
 202         if( psz_path[k] == ',' )
 203             i_nb_subdirs++;
 204     }
 205
 206     subdirs = calloc( i_nb_subdirs + 1, sizeof(char*) );
 207     if( !subdirs )
 208         return NULL;
 209
 210     for( i = 0; psz_parser && *psz_parser != '\0' ; )
 211     {
 212         char *psz_subdir = psz_parser;
 213         psz_parser = strchr( psz_subdir, ',' );
 214         if( psz_parser )
 215         {
 216             *psz_parser++ = '\0';
 217             while( *psz_parser == ' ' )
 218                 psz_parser++;
 219         }
 220         if( *psz_subdir == '\0' )
 221             continue;
 222
 223         if( asprintf( &subdirs[i++], "%s%s%c",
 224                   psz_subdir[0] == '.' ? psz_dir : "",
 225                   psz_subdir,
 226                   psz_subdir[strlen(psz_subdir) - 1] == DIR_SEP_CHAR ?
 227                                            '\0' : DIR_SEP_CHAR ) == -1 )
 228             break;
 229     }
 230     subdirs[i] = NULL;
 231
 232     return subdirs;
 233 }
 234
 235
 236 /**
 237  * Detect subtitle files.
 238  *
 239  * When called this function will split up the psz_name string into a
 240  * directory, filename and extension. It then opens the directory
 241  * in which the file resides and tries to find possible matches of
 242  * subtitles files.
 243  *
 244  * \ingroup Demux
 245  * \param p_this the calling \ref input_thread_t
 246  * \param psz_path a list of subdirectories (separated by a ',') to look in.
 247  * \param psz_name the complete filename to base the search on.
 248  * \return a NULL terminated array of filenames with detected possible subtitles.
 249  * The array contains max MAX_SUBTITLE_FILES items and you need to free it after use.
 250  */
 251 char **subtitles_Detect( input_thread_t *p_this, char *psz_path,
 252                          const char *psz_name_org )
 253 {
 254     int i_fuzzy;
 255     int j, i_result2, i_sub_count, i_fname_len;
 256     char *f_dir = NULL, *f_fname = NULL, *f_fname_noext = NULL, *f_fname_trim = NULL;
 257     char *tmp = NULL;
 258
 259     char **subdirs; /* list of subdirectories to look in */
 260
 261     vlc_subfn_t *result = NULL; /* unsorted results */
 262     char **result2; /* sorted results */
 263     const char *psz_fname = psz_name_org;
 264
 265     if( !psz_fname )
 266         return NULL;
 267
 268     if( !strncmp( psz_fname, "file://", 7 ) )
 269         psz_fname += 7;
 270
 271     /* extract filename & dirname from psz_fname */
 272     tmp = strrchr( psz_fname, DIR_SEP_CHAR );
 273     if( tmp )
 274     {
 275         const int i_dirlen = strlen(psz_fname)-strlen(tmp)+1; /* include the separator */
 276         f_fname = strdup( &tmp[1] );    /* skip the separator */
 277         f_dir = strndup( psz_fname, i_dirlen );
 278     }
 279     else
 280     {
 281 #if defined (HAVE_UNISTD_H) && !defined (UNDER_CE)
 282         /* Get the current working directory */
 283         char *psz_cwd = getcwd( NULL, 0 );
 284 #else
 285         char *psz_cwd = NULL;
 286 #endif
 287         if( !psz_cwd )
 288             return NULL;
 289
 290         f_fname = strdup( psz_fname );
 291         if( asprintf( &f_dir, "%s%c", psz_cwd, DIR_SEP_CHAR ) == -1 )
 292             f_dir = NULL; /* Assure that function will return in next test */
 293         free( psz_cwd );
 294     }
 295     if( !f_fname || !f_dir )
 296     {
 297         free( f_fname );
 298         free( f_dir );
 299         return NULL;
 300     }
 301
 302     i_fname_len = strlen( f_fname );
 303
 304     f_fname_noext = malloc(i_fname_len + 1);
 305     f_fname_trim = malloc(i_fname_len + 1 );
 306     if( !f_fname_noext || !f_fname_trim )
 307     {
 308         free( f_fname );
 309         free( f_dir );
 310         free( f_fname_noext );
 311         free( f_fname_trim );
 312         return NULL;
 313     }
 314
 315     strcpy_strip_ext( f_fname_noext, f_fname );
 316     strcpy_trim( f_fname_trim, f_fname_noext );
 317
 318     i_fuzzy = var_GetInteger( p_this, "sub-autodetect-fuzzy" );
 319
 320     result = calloc( MAX_SUBTITLE_FILES+1, sizeof(vlc_subfn_t) ); /* We check it later (simplify code) */
 321     subdirs = paths_to_list( f_dir, psz_path );
 322     for( j = -1, i_sub_count = 0; (j == -1) || ( j >= 0 && subdirs != NULL && subdirs[j] != NULL ); j++ )
 323     {
 324         const char *psz_dir = j < 0 ? f_dir : subdirs[j];
 325         char **ppsz_dir_content;
 326         int i_dir_content;
 327         int a;
 328
 329         if( psz_dir == NULL || ( j >= 0 && !strcmp( psz_dir, f_dir ) ) )
 330             continue;
 331
 332         /* parse psz_src dir */
 333         i_dir_content = utf8_scandir( psz_dir, &ppsz_dir_content,
 334                                       subtitles_Filter, NULL );
 335         if( i_dir_content < 0 )
 336             continue;
 337
 338         msg_Dbg( p_this, "looking for a subtitle file in %s", psz_dir );
 339         for( a = 0; a < i_dir_content && i_sub_count < MAX_SUBTITLE_FILES ; a++ )
 340         {
 341             char *psz_name = ppsz_dir_content[a];
 342             char tmp_fname_noext[strlen( psz_name ) + 1];
 343             char tmp_fname_trim[strlen( psz_name ) + 1];
 344             char tmp_fname_ext[strlen( psz_name ) + 1];
 345
 346             int i_prio;
 347
 348             if( psz_name == NULL || psz_name[0] == '.' )
 349                 continue;
 350
 351             /* retrieve various parts of the filename */
 352             strcpy_strip_ext( tmp_fname_noext, psz_name );
 353             strcpy_get_ext( tmp_fname_ext, psz_name );
 354             strcpy_trim( tmp_fname_trim, tmp_fname_noext );
 355
 356             i_prio = SUB_PRIORITY_NONE;
 357             if( i_prio == SUB_PRIORITY_NONE && !strcmp( tmp_fname_trim, f_fname_trim ) )
 358             {
 359                 /* matches the movie name exactly */
 360                 i_prio = SUB_PRIORITY_MATCH_ALL;
 361             }
 362             if( i_prio == SUB_PRIORITY_NONE &&
 363                 ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
 364             {
 365                 /* contains the movie name */
 366                 tmp += strlen( f_fname_trim );
 367                 if( whiteonly( tmp ) )
 368                 {
 369                     /* chars in front of the movie name */
 370                     i_prio = SUB_PRIORITY_MATCH_RIGHT;
 371                 }
 372                 else
 373                 {
 374                     /* chars after (and possibly in front of)
 375                      * the movie name */
 376                     i_prio = SUB_PRIORITY_MATCH_LEFT;
 377                 }
 378             }
 379             if( i_prio == SUB_PRIORITY_NONE &&
 380                 j == 0 )
 381             {
 382                 /* doesn't contain the movie name, prefer files in f_dir over subdirs */
 383                 i_prio = SUB_PRIORITY_MATCH_NONE;
 384             }
 385             if( i_prio >= i_fuzzy )
 386             {
 387                 char psz_path[strlen( psz_dir ) + strlen( psz_name ) + 1];
 388                 struct stat st;
 389
 390                 sprintf( psz_path, "%s%s", psz_dir, psz_name );
 391                 if( !strcmp( psz_path, psz_fname ) )
 392                     continue;
 393
 394                 if( !utf8_stat( psz_path, &st ) && S_ISREG( st.st_mode ) && result )
 395                 {
 396                     msg_Dbg( p_this,
 397                             "autodetected subtitle: %s with priority %d",
 398                             psz_path, i_prio );
 399                     result[i_sub_count].priority = i_prio;
 400                     result[i_sub_count].psz_fname = strdup( psz_path );
 401                     result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
 402                     i_sub_count++;
 403                 }
 404                 else
 405                 {
 406                     msg_Dbg( p_this, "stat failed (autodetecting subtitle: %s with priority %d)",
 407                              psz_path, i_prio );
 408                 }
 409             }
 410         }
 411         if( ppsz_dir_content )
 412         {
 413             for( a = 0; a < i_dir_content; a++ )
 414                 free( ppsz_dir_content[a] );
 415             free( ppsz_dir_content );
 416         }
 417     }
 418     if( subdirs )
 419     {
 420         for( j = 0; subdirs[j]; j++ )
 421             free( subdirs[j] );
 422         free( subdirs );
 423     }
 424     free( f_fname );
 425     free( f_dir );
 426     free( f_fname_trim );
 427     free( f_fname_noext );
 428
 429     if( !result )
 430         return NULL;
 431
 432     qsort( result, i_sub_count, sizeof(vlc_subfn_t), compare_sub_priority );
 433
 434     result2 = calloc( i_sub_count + 1, sizeof(char*) );
 435
 436     for( j = 0, i_result2 = 0; j < i_sub_count && result2 != NULL; j++ )
 437     {
 438         bool b_reject = false;
 439
 440         if( !result[j].psz_fname || !result[j].psz_ext ) /* memory out */
 441             break;
 442
 443         if( !strcasecmp( result[j].psz_ext, "sub" ) )
 444         {
 445             int i;
 446             for( i = 0; i < i_sub_count; i++ )
 447             {
 448                 if( result[i].psz_fname && result[i].psz_ext &&
 449                     !strncasecmp( result[j].psz_fname, result[i].psz_fname,
 450                                   strlen( result[j].psz_fname) - 3 ) &&
 451                     !strcasecmp( result[i].psz_ext, "idx" ) )
 452                     break;
 453             }
 454             if( i < i_sub_count )
 455                 b_reject = true;
 456         }
 457         else if( !strcasecmp( result[j].psz_ext, "cdg" ) )
 458         {
 459             if( result[j].priority < SUB_PRIORITY_MATCH_ALL )
 460                 b_reject = true;
 461         }
 462
 463         /* */
 464         if( !b_reject )
 465             result2[i_result2++] = strdup( result[j].psz_fname );
 466     }
 467
 468     for( j = 0; j < i_sub_count; j++ )
 469     {
 470         free( result[j].psz_fname );
 471         free( result[j].psz_ext );
 472     }
 473     free( result );
 474
 475     return result2;
 476 }
 477