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