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