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

   1 /*****************************************************************************
   2  * subtitles.c
   3  *****************************************************************************
   4  * Copyright (C) 2003-2004 VideoLAN
   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., 59 Temple Place - Suite 330, Boston, MA  02111, 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
  34 #ifdef HAVE_DIRENT_H
  35 #   include <dirent.h>
  36 #else
  37 #   include "../extras/dirent.h"
  38 #endif
  39
  40 #include <ctype.h>
  41
  42 /**
  43  * What's between a directory and a filename?
  44  */
  45 #if defined( WIN32 )
  46     #define DIRECTORY_SEPARATOR '\\'
  47 #else
  48     #define DIRECTORY_SEPARATOR '/'
  49 #endif
  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 extentions 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         strcpy(d, s);
  96         return;
  97     }
  98     else
  99     {
 100         strncpy(d, s, tmp - s);
 101         d[tmp - s] = 0;
 102     }
 103     while( *d )
 104     {
 105         *d = tolower(*d);
 106         d++;
 107     }
 108 }
 109
 110 static void strcpy_get_ext( char *d, char *s )
 111 {
 112     char *tmp = strrchr(s, '.');
 113     if( !tmp )
 114     {
 115         strcpy(d, "");
 116         return;
 117     } else strcpy( d, tmp + 1 );
 118 }
 119
 120 static int whiteonly( char *s )
 121 {
 122   while ( *s )
 123   {
 124         if( isalnum( *s ) ) return 0;
 125         s++;
 126   }
 127   return 1;
 128 }
 129
 130 typedef struct _subfn
 131 {
 132     int priority;
 133     char *psz_fname;
 134 } subfn;
 135
 136 static int compare_sub_priority( const void *a, const void *b )
 137 {
 138     if (((subfn*)a)->priority > ((subfn*)b)->priority)
 139     {
 140         return -1;
 141     }
 142
 143     if (((subfn*)a)->priority < ((subfn*)b)->priority)
 144     {
 145         return 1;
 146     }
 147
 148 #ifndef UNDER_CE
 149     return strcoll(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
 150 #else
 151     return strcmp(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
 152 #endif
 153 }
 154
 155 /**
 156  * Convert a list of paths separated by ',' to a char**
 157  */
 158 static char **paths_to_list( char *psz_dir, char *psz_path )
 159 {
 160     unsigned int i, k, i_nb_subdirs;
 161     char **subdirs; /* list of subdirectories to look in */
 162
 163     i_nb_subdirs = 1;
 164     for( k = 0; k < strlen( psz_path ); k++ )
 165     {
 166         if( psz_path[k] == ',' )
 167         {
 168             i_nb_subdirs++;
 169         }
 170     }
 171
 172     if( i_nb_subdirs > 0 )
 173     {
 174         char *psz_parser, *psz_temp;
 175
 176         subdirs = (char**)malloc( sizeof(char*) * ( i_nb_subdirs + 1 ) );
 177         memset( subdirs, 0, sizeof(char*) * ( i_nb_subdirs + 1 ) );
 178         i = 0;
 179         psz_parser = psz_path;
 180         while( psz_parser && *psz_parser )
 181         {
 182             char *psz_subdir;
 183             psz_subdir = psz_parser;
 184             psz_parser = strchr( psz_subdir, ',' );
 185             if( psz_parser )
 186             {
 187                 *psz_parser = '\0';
 188                 psz_parser++;
 189                 while( *psz_parser == ' ' )
 190                 {
 191                     psz_parser++;
 192                 }
 193             }
 194             if( strlen( psz_subdir ) > 0 )
 195             {
 196                 psz_temp = (char *)malloc( strlen(psz_dir)
 197                                            + strlen(psz_subdir) + 2 );
 198                 if( psz_temp )
 199                 {
 200                     sprintf( psz_temp, "%s%s%c",
 201                              psz_subdir[0] == '.' ? psz_dir : "",
 202                              psz_subdir,
 203                              psz_subdir[strlen(psz_subdir) - 1] ==
 204                               DIRECTORY_SEPARATOR ? '\0' : DIRECTORY_SEPARATOR );
 205                     subdirs[i] = psz_temp;
 206                     i++;
 207                 }
 208             }
 209         }
 210         subdirs[i] = NULL;
 211     }
 212     else
 213     {
 214         subdirs = NULL;
 215     }
 216     return subdirs;
 217 }
 218
 219 /**
 220  * Detect subtitle files.
 221  *
 222  * When called this function will split up the psz_fname string into a
 223  * directory, filename and extension. It then opens the directory
 224  * in which the file resides and tries to find possible matches of
 225  * subtitles files.
 226  *
 227  * \ingroup Demux
 228  * \param p_this the calling \ref input_thread_t
 229  * \param psz_path a list of subdirectories (separated by a ',') to look in.
 230  * \param psz_fname the complete filename to base the search on.
 231  * \return a NULL terminated array of filenames with detected possible subtitles.
 232  * The array contains max MAX_SUBTITLE_FILES items and you need to free it after use.
 233  */
 234 char **subtitles_Detect( input_thread_t *p_this, char *psz_path,
 235                          char *psz_fname )
 236 {
 237     /* variables to be used for derivatives of psz_fname */
 238     char *f_dir, *f_fname, *f_fname_noext, *f_fname_trim, *tmp;
 239     /* variables to be used for derivatives FILE *f */
 240     char *tmp_fname_noext, *tmp_fname_trim, *tmp_fname_ext, *tmpresult;
 241     vlc_value_t fuzzy;
 242     int len, i, j, i_sub_count;
 243     subfn *result; /* unsorted results */
 244     char **result2; /* sorted results */
 245     char **tmp_subdirs, **subdirs; /* list of subdirectories to look in */
 246
 247     FILE *f;
 248     DIR *d;
 249     struct dirent *de;
 250
 251     if( !strncmp( psz_fname, "file://", 7 ) )
 252     {
 253         psz_fname += 7;
 254     }
 255
 256     i_sub_count = 0;
 257     len = strlen( psz_fname ) > 256 ? strlen( psz_fname ) : 256;
 258
 259     f_dir = (char*)malloc(len);
 260     f_fname = (char*)malloc(len);
 261     f_fname_noext = (char*)malloc(len);
 262     f_fname_trim = (char*)malloc(len);
 263
 264     tmp_fname_noext = (char*)malloc(len);
 265     tmp_fname_trim = (char*)malloc(len);
 266     tmp_fname_ext = (char*)malloc(len);
 267
 268     tmpresult = (char*)malloc(len);
 269
 270     result = (subfn*)malloc( sizeof(subfn) * MAX_SUBTITLE_FILES );
 271     memset( result, 0, sizeof(subfn) * MAX_SUBTITLE_FILES );
 272
 273     /* extract filename & dirname from psz_fname */
 274     tmp = strrchr( psz_fname, DIRECTORY_SEPARATOR );
 275     if( tmp )
 276     {
 277         int pos;
 278         strncpy( f_fname, tmp + 1, len - 1 );
 279         f_fname[len - 1] = 0;
 280         pos = tmp - psz_fname + 1;
 281         strncpy( f_dir, psz_fname, __MIN(pos,len-1) );
 282         f_dir[__MIN(pos,len-1)] = 0;
 283     }
 284     else
 285     {
 286         strncpy( f_fname, psz_fname, len - 1 );
 287         f_fname[len - 1] = 0;
 288         strcpy( f_dir, "" );
 289     }
 290
 291     strcpy_strip_ext( f_fname_noext, f_fname );
 292     strcpy_trim( f_fname_trim, f_fname_noext );
 293     var_Get( p_this, "sub-autodetect-fuzzy", &fuzzy );
 294
 295     tmp_subdirs = paths_to_list( f_dir, psz_path );
 296     subdirs = tmp_subdirs;
 297
 298     for( j = -1; j == -1 || ( j >= 0 && subdirs != NULL && *subdirs != NULL );
 299          j++)
 300     {
 301         d = opendir( j < 0 ? f_dir : *subdirs );
 302         if( d )
 303         {
 304             int b_found;
 305             msg_Dbg( p_this, "looking for a subtitle file in %s",
 306                      j < 0 ? f_dir : *subdirs );
 307             while( ( de = readdir( d ) ) )
 308             {
 309                 /* retrieve various parts of the filename */
 310                 strcpy_strip_ext( tmp_fname_noext, de->d_name );
 311                 strcpy_get_ext( tmp_fname_ext, de->d_name );
 312                 strcpy_trim( tmp_fname_trim, tmp_fname_noext );
 313
 314                 /* does it end with a subtitle extension? */
 315                 b_found = 0;
 316                 for( i = 0; sub_exts[i]; i++ )
 317                 {
 318                     if( strcmp( sub_exts[i], tmp_fname_ext ) == 0 )
 319                     {
 320                         b_found = 1;
 321                         msg_Dbg( p_this, "found a possible subtitle: %s",
 322                                  de->d_name );
 323                         break;
 324                     }
 325                 }
 326
 327                 /* we have a (likely) subtitle file */
 328                 if( b_found )
 329                 {
 330                     int i_prio = 0;
 331                     if( !i_prio && !strcmp( tmp_fname_trim, f_fname_trim ) )
 332                     {
 333                         /* matches the movie name exactly */
 334                         i_prio = 4;
 335                     }
 336                     if( !i_prio &&
 337                         ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
 338                     {
 339                         /* contains the movie name */
 340                         tmp += strlen( f_fname_trim );
 341                         if( whiteonly( tmp ) )
 342                         {
 343                             /* chars in front of the movie name */
 344                             i_prio = 2;
 345                         }
 346                         else
 347                         {
 348                             /* chars after (and possibly in front of)
 349                              * the movie name */
 350                             i_prio = 3;
 351                         }
 352                     }
 353                     if( !i_prio )
 354                     {
 355                         /* doesn't contain the movie name */
 356                         if( j == 0 ) i_prio = 1;
 357                     }
 358
 359                     if( i_prio >= fuzzy.i_int )
 360                     {
 361                         sprintf( tmpresult, "%s%s", j == -1 ? f_dir : *subdirs,
 362                                  de->d_name );
 363                         msg_Dbg( p_this, "autodetected subtitle: %s with "
 364                                  "priority %d", de->d_name, i_prio );
 365                         if( ( f = fopen( tmpresult, "rt" ) ) )
 366                         {
 367                             fclose( f );
 368                             result[i_sub_count].priority = i_prio;
 369                             result[i_sub_count].psz_fname = strdup(tmpresult);
 370                             i_sub_count++;
 371                         }
 372                     }
 373                 }
 374                 if( i_sub_count >= MAX_SUBTITLE_FILES ) break;
 375             }
 376             closedir( d );
 377         }
 378         if( j >= 0 ) free( *subdirs++ );
 379     }
 380
 381     if( tmp_subdirs ) free( tmp_subdirs );
 382
 383     free( f_dir );
 384     free( f_fname );
 385     free( f_fname_noext );
 386     free( f_fname_trim );
 387
 388     free( tmp_fname_noext );
 389     free( tmp_fname_trim );
 390     free( tmp_fname_ext );
 391
 392     free( tmpresult );
 393
 394     qsort( result, i_sub_count, sizeof( subfn ), compare_sub_priority );
 395
 396     result2 = (char**)malloc( sizeof(char*) * ( i_sub_count + 1 ) );
 397     memset( result2, 0, sizeof(char*) * ( i_sub_count + 1 ) );
 398
 399     for( i = 0; i < i_sub_count; i++ )
 400     {
 401         result2[i] = result[i].psz_fname;
 402     }
 403     result2[i_sub_count] = NULL;
 404     free( result );
 405     return result2;
 406 }