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