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