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

   1 /*****************************************************************************
   2  * subtitles.c
   3  *****************************************************************************
   4  * Copyright (C) 2003-2004 VideoLAN
   5  * $Id: subtitles.c,v 1.10 2004/01/26 20:26:54 gbazin Exp $
   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 subdirectory to look into. This is not used atm.
 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;
 178     subfn *result; /* unsorted results */
 179     char **result2; /* sorted results */
 180
 181     FILE *f;
 182     DIR *d;
 183     struct dirent *de;
 184
 185     i_sub_count = 0;
 186     len = ( strlen( psz_fname ) > 256 ? strlen( psz_fname ) : 256 ) +
 187         ( strlen( psz_path ) > 256 ? strlen( psz_path ) : 256 ) + 2;
 188
 189     f_dir = (char*)malloc(len);
 190     f_fname = (char*)malloc(len);
 191     f_fname_noext = (char*)malloc(len);
 192     f_fname_trim = (char*)malloc(len);
 193
 194     tmp_fname_noext = (char*)malloc(len);
 195     tmp_fname_trim = (char*)malloc(len);
 196     tmp_fname_ext = (char*)malloc(len);
 197
 198     tmpresult = (char*)malloc(len);
 199
 200     result = (subfn*)malloc( sizeof(subfn) * MAX_SUBTITLE_FILES );
 201     memset( result, 0, sizeof(subfn) * MAX_SUBTITLE_FILES );
 202
 203     /* extract filename & dirname from psz_fname */
 204     tmp = strrchr( psz_fname, DIRECTORY_SEPARATOR );
 205     if( tmp )
 206     {
 207         int pos;
 208         strncpy( f_fname, tmp + 1, len - 1 );
 209         f_fname[len - 1] = 0;
 210         pos = tmp - psz_fname + 1;
 211         strncpy( f_dir, psz_fname, __MIN(pos,len-1) );
 212         f_dir[__MIN(pos,len-1)] = 0;
 213     }
 214     else
 215     {
 216         strncpy( f_fname, psz_fname, len - 1 );
 217         f_fname[len - 1] = 0;
 218         strcpy( f_dir, "" );
 219     }
 220
 221     strcpy_strip_ext( f_fname_noext, f_fname );
 222     strcpy_trim( f_fname_trim, f_fname_noext );
 223     var_Get( p_this, "sub-autodetect-fuzzy", &fuzzy );
 224
 225
 226     for( j = 0; j <= 1; j++)
 227     {
 228         d = opendir( j == 0 ? f_dir : psz_path );
 229         if( d )
 230         {
 231             int b_found;
 232             while( ( de = readdir( d ) ) )
 233             {
 234                 /* retrieve various parts of the filename */
 235                 strcpy_strip_ext( tmp_fname_noext, de->d_name );
 236                 strcpy_get_ext( tmp_fname_ext, de->d_name );
 237                 strcpy_trim( tmp_fname_trim, tmp_fname_noext );
 238
 239                 /* does it end with a subtitle extension? */
 240                 b_found = 0;
 241                 for( i = 0; sub_exts[i]; i++ )
 242                 {
 243                     if( strcmp(sub_exts[i], tmp_fname_ext ) == 0 )
 244                     {
 245                         b_found = 1;
 246                         msg_Dbg( p_this, "found a possible subtitle: %s",
 247                                  de->d_name );
 248                         break;
 249                     }
 250                 }
 251
 252                 /* we have a (likely) subtitle file */
 253                 if( b_found )
 254                 {
 255                     int i_prio = 0;
 256                     if( !i_prio && !strcmp( tmp_fname_trim, f_fname_trim ) )
 257                     {
 258                         /* matches the movie name exactly */
 259                         i_prio = 4;
 260                     }
 261                     if( !i_prio &&
 262                         ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
 263                     {
 264                         /* contains the movie name */
 265                         tmp += strlen( f_fname_trim );
 266                         if( whiteonly( tmp ) )
 267                         {
 268                             /* chars in front of the movie name */
 269                             i_prio = 2;
 270                         }
 271                         else
 272                         {
 273                             /* chars after (and possibly in front of)
 274                              * the movie name */
 275                             i_prio = 3;
 276                         }
 277                     }
 278                     if( !i_prio )
 279                     {
 280                         /* doesn't contain the movie name */
 281                         if( j == 0 ) i_prio = 1;
 282                     }
 283
 284                     if( i_prio >= fuzzy.i_int )
 285                     {
 286                         sprintf( tmpresult, "%s%s", j == 0 ? f_dir : psz_path,
 287                                  de->d_name );
 288                         msg_Dbg( p_this, "autodetected subtitle: %s with "
 289                                  "priority %d", de->d_name, i_prio );
 290                         if( ( f = fopen( tmpresult, "rt" ) ) )
 291                         {
 292                             fclose( f );
 293                             result[i_sub_count].priority = i_prio;
 294                             result[i_sub_count].psz_fname = strdup(tmpresult);
 295                             i_sub_count++;
 296                         }
 297                     }
 298                 }
 299                 if( i_sub_count >= MAX_SUBTITLE_FILES ) break;
 300             }
 301             closedir( d );
 302         }
 303     }
 304
 305     free( f_dir );
 306     free( f_fname );
 307     free( f_fname_noext );
 308     free( f_fname_trim );
 309
 310     free( tmp_fname_noext );
 311     free( tmp_fname_trim );
 312     free( tmp_fname_ext );
 313
 314     free( tmpresult );
 315
 316     qsort( result, i_sub_count, sizeof( subfn ), compare_sub_priority );
 317
 318     result2 = (char**)malloc( sizeof(char*) * ( i_sub_count + 1 ) );
 319     memset( result2, 0, sizeof(char*) * ( i_sub_count + 1 ) );
 320
 321     for( i = 0; i < i_sub_count; i++ )
 322     {
 323         result2[i] = result[i].psz_fname;
 324     }
 325     result2[i_sub_count] = NULL;
 326     free( result );
 327     return result2;
 328 }