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