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

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