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