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

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