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

   1 /*****************************************************************************
   2  * subtitles.c
   3  *****************************************************************************
   4  * Copyright (C) 2003-2004 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., 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
  31 #include <stdlib.h>
  32 #include <vlc/vlc.h>
  33 #include <vlc/input.h>
  34 #include "charset.h"
  35
  36 #ifdef HAVE_DIRENT_H
  37 #   include <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
  65 static void strcpy_trim( char *d, char *s )
  66 {
  67     /* skip leading whitespace */
  68     while( *s && !isalnum(*s) )
  69     {
  70         s++;
  71     }
  72     for(;;)
  73     {
  74         /* copy word */
  75         while( *s && isalnum(*s) )
  76         {
  77             *d = tolower(*s);
  78             s++; d++;
  79         }
  80         if( *s == 0 ) break;
  81         /* trim excess whitespace */
  82         while( *s && !isalnum(*s) )
  83         {
  84             s++;
  85         }
  86         if( *s == 0 ) break;
  87         *d++ = ' ';
  88     }
  89     *d = 0;
  90 }
  91
  92 static void strcpy_strip_ext( char *d, char *s )
  93 {
  94     char *tmp = strrchr(s, '.');
  95     if( !tmp ) {
  96         strcpy(d, s);
  97         return;
  98     }
  99     else
 100     {
 101         strncpy(d, s, tmp - s);
 102         d[tmp - s] = 0;
 103     }
 104     while( *d )
 105     {
 106         *d = tolower(*d);
 107         d++;
 108     }
 109 }
 110
 111 static void strcpy_get_ext( char *d, char *s )
 112 {
 113     char *tmp = strrchr(s, '.');
 114     if( !tmp )
 115     {
 116         strcpy(d, "");
 117         return;
 118     } else strcpy( d, tmp + 1 );
 119 }
 120
 121 static int whiteonly( char *s )
 122 {
 123   while ( *s )
 124   {
 125         if( isalnum( *s ) ) return 0;
 126         s++;
 127   }
 128   return 1;
 129 }
 130
 131 typedef struct _subfn
 132 {
 133     int priority;
 134     char *psz_fname;
 135     char *psz_ext;
 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 #ifndef UNDER_CE
 151     return strcoll(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
 152 #else
 153     return strcmp(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
 154 #endif
 155 }
 156
 157 /* Utility function for scandir */
 158 static int Filter( const struct dirent *p_dir_content )
 159 {
 160     int i;
 161     char *tmp;
 162
 163     if( p_dir_content == NULL || p_dir_content->d_name == NULL ) return VLC_FALSE;
 164     /* does it end with a subtitle extension? */
 165     tmp = strrchr( p_dir_content->d_name, '.');
 166     if( !tmp )
 167     {
 168         return VLC_FALSE;
 169     }
 170     else
 171     {
 172         for( i = 0; sub_exts[i]; i++ )
 173         {
 174             if( strcmp( sub_exts[i], tmp+1 ) == 0 )
 175             {
 176                 return VLC_TRUE;
 177             }
 178         }
 179     }
 180     return VLC_FALSE;
 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     i_nb_subdirs = 1;
 193     for( k = 0; k < strlen( psz_path ); k++ )
 194     {
 195         if( psz_path[k] == ',' )
 196         {
 197             i_nb_subdirs++;
 198         }
 199     }
 200
 201     if( i_nb_subdirs > 0 )
 202     {
 203         char *psz_parser, *psz_temp;
 204
 205         subdirs = (char**)malloc( sizeof(char*) * ( i_nb_subdirs + 1 ) );
 206         memset( subdirs, 0, sizeof(char*) * ( i_nb_subdirs + 1 ) );
 207         i = 0;
 208         psz_parser = psz_path;
 209         while( psz_parser && *psz_parser )
 210         {
 211             char *psz_subdir;
 212             psz_subdir = psz_parser;
 213             psz_parser = strchr( psz_subdir, ',' );
 214             if( psz_parser )
 215             {
 216                 *psz_parser = '\0';
 217                 psz_parser++;
 218                 while( *psz_parser == ' ' )
 219                 {
 220                     psz_parser++;
 221                 }
 222             }
 223             if( strlen( psz_subdir ) > 0 )
 224             {
 225                 psz_temp = (char *)malloc( strlen(psz_dir)
 226                                            + strlen(psz_subdir) + 2 );
 227                 if( psz_temp )
 228                 {
 229                     sprintf( psz_temp, "%s%s%c",
 230                              psz_subdir[0] == '.' ? psz_dir : "",
 231                              psz_subdir,
 232                              psz_subdir[strlen(psz_subdir) - 1] ==
 233                               DIRECTORY_SEPARATOR ? '\0' : DIRECTORY_SEPARATOR );
 234                     subdirs[i] = psz_temp;
 235                     i++;
 236                 }
 237             }
 238         }
 239         subdirs[i] = NULL;
 240     }
 241     else
 242     {
 243         subdirs = NULL;
 244     }
 245     return subdirs;
 246 }
 247
 248
 249 /**
 250  * Detect subtitle files.
 251  *
 252  * When called this function will split up the psz_name string into a
 253  * directory, filename and extension. It then opens the directory
 254  * in which the file resides and tries to find possible matches of
 255  * subtitles files.
 256  *
 257  * \ingroup Demux
 258  * \param p_this the calling \ref input_thread_t
 259  * \param psz_path a list of subdirectories (separated by a ',') to look in.
 260  * \param psz_name the complete filename to base the search on.
 261  * \return a NULL terminated array of filenames with detected possible subtitles.
 262  * The array contains max MAX_SUBTITLE_FILES items and you need to free it after use.
 263  */
 264 char **subtitles_Detect( input_thread_t *p_this, char *psz_path,
 265                          char *psz_name )
 266 {
 267     vlc_value_t fuzzy;
 268     int j, i_result2, i_dir_content, i_sub_count = 0, i_fname_len = 0;
 269     char *f_dir, *f_fname, *f_fname_noext, *f_fname_trim;
 270     char *tmp;
 271
 272     char tmp_fname_noext[PATH_MAX];
 273     char tmp_fname_trim[PATH_MAX];
 274     char tmp_fname_ext[PATH_MAX];
 275
 276     struct dirent **pp_dir_content;
 277     char **tmp_subdirs, **subdirs; /* list of subdirectories to look in */
 278
 279     subfn *result; /* unsorted results */
 280     char **result2; /* sorted results */
 281
 282     char *psz_fname_original = strdup( psz_name );
 283     char *psz_fname = psz_fname_original;
 284
 285     if( !strncmp( psz_fname, "file://", 7 ) )
 286     {
 287         psz_fname += 7;
 288     }
 289
 290     /* extract filename & dirname from psz_fname */
 291     tmp = strrchr( psz_fname, DIRECTORY_SEPARATOR );
 292     if( tmp )
 293     {
 294         int dirlen;
 295         f_fname = malloc( strlen(tmp) );
 296         strcpy( f_fname, tmp+1 ); // we skip the seperator, so it will still fit in the allocated space
 297         dirlen = strlen(psz_fname) - strlen(tmp);
 298         f_dir = malloc( dirlen + 1 );
 299         strncpy( f_dir, psz_fname, dirlen + 1 );
 300         f_dir[dirlen + 1] = 0;
 301     }
 302     else
 303     {
 304         f_fname = strdup( psz_fname );
 305     }
 306
 307     i_fname_len = strlen( f_fname );
 308     f_fname_noext = malloc(i_fname_len + 1);
 309     f_fname_trim = malloc(i_fname_len + 1 );
 310
 311     strcpy_strip_ext( f_fname_noext, f_fname );
 312     strcpy_trim( f_fname_trim, f_fname_noext );
 313
 314     result = (subfn*)malloc( sizeof(subfn) * MAX_SUBTITLE_FILES );
 315     memset( result, 0, sizeof(subfn) * MAX_SUBTITLE_FILES );
 316
 317     var_Get( p_this, "sub-autodetect-fuzzy", &fuzzy );
 318
 319     tmp_subdirs = paths_to_list( f_dir, psz_path );
 320     subdirs = tmp_subdirs;
 321
 322     for( j = -1; j == -1 || ( j >= 0 && subdirs != NULL && *subdirs != NULL );
 323          j++)
 324     {
 325         pp_dir_content = NULL;
 326         i_dir_content = 0;
 327
 328         /* parse psz_src dir */
 329         if( ( i_dir_content = scandir( j < 0 ? f_dir : *subdirs, &pp_dir_content, Filter,
 330                                 NULL ) ) != -1 )
 331         {
 332             int a;
 333             msg_Dbg( p_this, "looking for a subtitle file in %s", j < 0 ? f_dir : *subdirs );
 334
 335             for( a = 0; a < i_dir_content; a++ )
 336             {
 337                 int i_prio = 0;
 338                 struct dirent *p_dir_content = pp_dir_content[a];
 339                 char *psz_inUTF8 = FromLocale( p_dir_content->d_name );
 340                 char *p_fixed_name = vlc_fix_readdir_charset( p_this, psz_inUTF8 );
 341
 342                 LocaleFree( psz_inUTF8 );
 343
 344                 /* retrieve various parts of the filename */
 345                 strcpy_strip_ext( tmp_fname_noext, p_fixed_name );
 346                 strcpy_get_ext( tmp_fname_ext, p_fixed_name );
 347                 strcpy_trim( tmp_fname_trim, tmp_fname_noext );
 348
 349                 if( !i_prio && !strcmp( tmp_fname_trim, f_fname_trim ) )
 350                 {
 351                     /* matches the movie name exactly */
 352                     i_prio = 4;
 353                 }
 354                 if( !i_prio &&
 355                     ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
 356                 {
 357                     /* contains the movie name */
 358                     tmp += strlen( f_fname_trim );
 359                     if( whiteonly( tmp ) )
 360                     {
 361                         /* chars in front of the movie name */
 362                         i_prio = 2;
 363                     }
 364                     else
 365                     {
 366                         /* chars after (and possibly in front of)
 367                          * the movie name */
 368                         i_prio = 3;
 369                     }
 370                 }
 371                 if( !i_prio )
 372                 {
 373                     /* doesn't contain the movie name */
 374                     if( j == 0 ) i_prio = 1;
 375                 }
 376                 if( i_prio >= fuzzy.i_int )
 377                 {
 378                     FILE *f;
 379                     char *tmpresult;
 380
 381                     asprintf( &tmpresult, "%s%s", j < 0 ? f_dir : *subdirs, p_fixed_name );
 382                     msg_Dbg( p_this, "autodetected subtitle: %s with priority %d", p_fixed_name, i_prio );
 383                     if( ( f = fopen( tmpresult, "rt" ) ) )
 384                     {
 385                         fclose( f );
 386                         result[i_sub_count].priority = i_prio;
 387                         result[i_sub_count].psz_fname = tmpresult;
 388                         result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
 389                         i_sub_count++;
 390                     } else free( tmpresult );
 391                 }
 392                 if( i_sub_count >= MAX_SUBTITLE_FILES ) break;
 393                 free( p_fixed_name );
 394             }
 395         }
 396         if( j >= 0 ) free( *subdirs++ );
 397     }
 398
 399     if(tmp_subdirs) free(tmp_subdirs);
 400     if(f_fname_trim) free(f_fname_trim);
 401     if(f_fname_noext) free(f_fname_noext);
 402     if(f_fname) free(f_fname);
 403     if(f_dir) free(f_dir);
 404
 405     qsort( result, i_sub_count, sizeof( subfn ), compare_sub_priority );
 406
 407     result2 = (char**)malloc( sizeof(char*) * ( i_sub_count + 1 ) );
 408     memset( result2, 0, sizeof(char*) * ( i_sub_count + 1 ) );
 409     i_result2 = 0;
 410
 411     for( j = 0; j < i_sub_count; j++ )
 412     {
 413         if( result[j].psz_ext && !strcasecmp( result[j].psz_ext, "sub" ) )
 414         {
 415             int i;
 416             for( i = 0; i < i_sub_count; i++ )
 417             {
 418                 if( result[i].psz_fname && result[j].psz_fname &&
 419                     !strncasecmp( result[j].psz_fname, result[i].psz_fname, sizeof( result[j].psz_fname) - 4 ) &&
 420                     !strcasecmp( result[i].psz_ext, "idx" ) )
 421                     break;
 422
 423             }
 424             if( i >= i_sub_count )
 425             {
 426                 result2[i_result2] = result[j].psz_fname;
 427                 i_result2++;
 428             }
 429         }
 430         else
 431         {
 432             result2[i_result2] = result[j].psz_fname;
 433             i_result2++;
 434         }
 435     }
 436
 437     free( psz_fname_original );
 438     free( result );
 439     return result2;
 440 }