subtitles.c 12.4 KB
Newer Older
1 2 3
/*****************************************************************************
 * subtitles.c
 *****************************************************************************
4
 * Copyright (C) 2003-2004 the VideoLAN team
5
 * $Id$
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 *
 * Authors: Derk-Jan Hartman <hartman at videolan.org>
 * This is adapted code from the GPL'ed MPlayer (http://mplayerhq.hu)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

25 26 27 28 29
/**
 *  \file
 *  This file contains functions to dectect subtitle files.
 */

30 31 32 33
#include <stdlib.h>
#include <vlc/vlc.h>
#include <vlc/input.h>

34 35 36 37
#ifdef HAVE_DIRENT_H
#   include <dirent.h>
#endif

38 39
#include <ctype.h>

40 41 42
/**
 * What's between a directory and a filename?
 */
43 44 45 46 47 48
#if defined( WIN32 )
    #define DIRECTORY_SEPARATOR '\\'
#else
    #define DIRECTORY_SEPARATOR '/'
#endif

49 50 51
/**
 * We are not going to autodetect more subtitle files than this.
 */
52 53
#define MAX_SUBTITLE_FILES 128

54 55 56 57

/**
 * The possible extentions for subtitle files we support
 */
58
static const char * sub_exts[] = {  "utf", "utf8", "utf-8", "sub", "srt", "smi", "txt", "ssa", "idx", NULL};
59 60
/* extensions from unsupported types */
/* rt, aqt, jss, js, ass */
61 62 63 64 65 66

static void strcpy_trim( char *d, char *s )
{
    /* skip leading whitespace */
    while( *s && !isalnum(*s) )
    {
67
        s++;
68 69 70
    }
    for(;;)
    {
71 72
        /* copy word */
        while( *s && isalnum(*s) )
73
        {
74 75 76 77 78 79
            *d = tolower(*s);
            s++; d++;
        }
        if (*s == 0) break;
        /* trim excess whitespace */
        while( *s && !isalnum(*s) )
80
        {
81 82 83 84
            s++;
        }
        if( *s == 0 ) break;
        *d++ = ' ';
85 86 87
    }
    *d = 0;
}
88

89 90 91 92
static void strcpy_strip_ext( char *d, char *s )
{
    char *tmp = strrchr(s, '.');
    if( !tmp ) {
93 94
        strcpy(d, s);
        return;
95 96 97
    }
    else
    {
98 99
        strncpy(d, s, tmp - s);
        d[tmp - s] = 0;
100 101 102
    }
    while( *d )
    {
103 104
        *d = tolower(*d);
        d++;
105 106
    }
}
107

108 109 110 111 112
static void strcpy_get_ext( char *d, char *s )
{
    char *tmp = strrchr(s, '.');
    if( !tmp )
    {
113 114
        strcpy(d, "");
        return;
115 116 117 118 119 120 121
    } else strcpy( d, tmp + 1 );
}

static int whiteonly( char *s )
{
  while ( *s )
  {
122 123
        if( isalnum( *s ) ) return 0;
        s++;
124 125 126 127
  }
  return 1;
}

128
typedef struct _subfn
129 130 131
{
    int priority;
    char *psz_fname;
132
    char *psz_ext;
133 134 135 136
} subfn;

static int compare_sub_priority( const void *a, const void *b )
{
137 138 139
    if (((subfn*)a)->priority > ((subfn*)b)->priority)
    {
        return -1;
140
    }
141 142 143 144 145 146

    if (((subfn*)a)->priority < ((subfn*)b)->priority)
    {
        return 1;
    }

147
#ifndef UNDER_CE
148
    return strcoll(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
149 150 151
#else
    return strcmp(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
#endif
152 153
}

154
/**
155
 * Convert a list of paths separated by ',' to a char**
156
 */
157
static char **paths_to_list( char *psz_dir, char *psz_path )
158
{
159
    unsigned int i, k, i_nb_subdirs;
160
    char **subdirs; /* list of subdirectories to look in */
161
    
162 163 164
    i_nb_subdirs = 1;
    for( k = 0; k < strlen( psz_path ); k++ )
    {
165
        if( psz_path[k] == ',' )
166 167 168 169
        {
            i_nb_subdirs++;
        }
    }
170
                                                                                                                            
171
    if( i_nb_subdirs > 0 )
172
    {
173 174 175 176
        char *psz_parser, *psz_temp;
                                                                                                                            
        subdirs = (char**)malloc( sizeof(char*) * ( i_nb_subdirs + 1 ) );
        memset( subdirs, 0, sizeof(char*) * ( i_nb_subdirs + 1 ) );
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
        i = 0;
        psz_parser = psz_path;
        while( psz_parser && *psz_parser )
        {
            char *psz_subdir;
            psz_subdir = psz_parser;
            psz_parser = strchr( psz_subdir, ',' );
            if( psz_parser )
            {
                *psz_parser = '\0';
                psz_parser++;
                while( *psz_parser == ' ' )
                {
                    psz_parser++;
                }
            }
193
            if( strlen( psz_subdir ) > 0 )
194
            {
195 196 197 198 199 200 201 202 203 204 205 206
                psz_temp = (char *)malloc( strlen(psz_dir)
                                           + strlen(psz_subdir) + 2 );
                if( psz_temp )
                {
                    sprintf( psz_temp, "%s%s%c", 
                             psz_subdir[0] == '.' ? psz_dir : "", 
                             psz_subdir,
                             psz_subdir[strlen(psz_subdir) - 1] == 
                              DIRECTORY_SEPARATOR ? '\0' : DIRECTORY_SEPARATOR );
                    subdirs[i] = psz_temp;
                    i++;
                }
207 208
            }
        }
209 210 211
        subdirs[i] = NULL;
    }
    else
212 213 214
    {
        subdirs = NULL;
    }
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
    return subdirs;
}

/**
 * Detect subtitle files.
 *
 * When called this function will split up the psz_fname string into a
 * directory, filename and extension. It then opens the directory
 * in which the file resides and tries to find possible matches of
 * subtitles files.
 *
 * \ingroup Demux
 * \param p_this the calling \ref input_thread_t
 * \param psz_path a list of subdirectories (separated by a ',') to look in.
 * \param psz_fname the complete filename to base the search on.
 * \return a NULL terminated array of filenames with detected possible subtitles.
 * The array contains max MAX_SUBTITLE_FILES items and you need to free it after use.
 */
char **subtitles_Detect( input_thread_t *p_this, char *psz_path,
                         char *psz_fname )
{
    /* variables to be used for derivatives of psz_fname */
    char *f_dir, *f_fname, *f_fname_noext, *f_fname_trim, *tmp;
    /* variables to be used for derivatives FILE *f */
    char *tmp_fname_noext, *tmp_fname_trim, *tmp_fname_ext, *tmpresult;
    vlc_value_t fuzzy;
241
    int len, i, j, i_sub_count, i_result2;
242 243 244 245 246 247 248
    subfn *result; /* unsorted results */
    char **result2; /* sorted results */
    char **tmp_subdirs, **subdirs; /* list of subdirectories to look in */

    FILE *f;
    DIR *d;
    struct dirent *de;
249

250 251 252 253 254
    if( !strncmp( psz_fname, "file://", 7 ) )
    {
        psz_fname += 7;
    }

255
    i_sub_count = 0;
256
    len = strlen( psz_fname ) > 256 ? strlen( psz_fname ) : 256;
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276

    f_dir = (char*)malloc(len);
    f_fname = (char*)malloc(len);
    f_fname_noext = (char*)malloc(len);
    f_fname_trim = (char*)malloc(len);

    tmp_fname_noext = (char*)malloc(len);
    tmp_fname_trim = (char*)malloc(len);
    tmp_fname_ext = (char*)malloc(len);

    tmpresult = (char*)malloc(len);

    result = (subfn*)malloc( sizeof(subfn) * MAX_SUBTITLE_FILES );
    memset( result, 0, sizeof(subfn) * MAX_SUBTITLE_FILES );

    /* extract filename & dirname from psz_fname */
    tmp = strrchr( psz_fname, DIRECTORY_SEPARATOR );
    if( tmp )
    {
        int pos;
277 278 279 280 281
        strncpy( f_fname, tmp + 1, len - 1 );
        f_fname[len - 1] = 0;
        pos = tmp - psz_fname + 1;
        strncpy( f_dir, psz_fname, __MIN(pos,len-1) );
        f_dir[__MIN(pos,len-1)] = 0;
282 283 284
    }
    else
    {
285 286
        strncpy( f_fname, psz_fname, len - 1 );
        f_fname[len - 1] = 0;
287
        strcpy( f_dir, "" );
288 289 290 291
    }

    strcpy_strip_ext( f_fname_noext, f_fname );
    strcpy_trim( f_fname_trim, f_fname_noext );
292
    var_Get( p_this, "sub-autodetect-fuzzy", &fuzzy );
293

294 295
    tmp_subdirs = paths_to_list( f_dir, psz_path );
    subdirs = tmp_subdirs;
296

297 298
    for( j = -1; j == -1 || ( j >= 0 && subdirs != NULL && *subdirs != NULL );
         j++)
299
    {
300
        d = opendir( j < 0 ? f_dir : *subdirs );
301
        if( d )
302 303
        {
            int b_found;
304
            msg_Dbg( p_this, "looking for a subtitle file in %s", 
305
                     j < 0 ? f_dir : *subdirs );
306
            while( ( de = readdir( d ) ) )
307
            {
308 309 310 311 312 313 314 315
                /* retrieve various parts of the filename */
                strcpy_strip_ext( tmp_fname_noext, de->d_name );
                strcpy_get_ext( tmp_fname_ext, de->d_name );
                strcpy_trim( tmp_fname_trim, tmp_fname_noext );

                /* does it end with a subtitle extension? */
                b_found = 0;
                for( i = 0; sub_exts[i]; i++ )
316
                {
317
                    if( strcmp( sub_exts[i], tmp_fname_ext ) == 0 )
318
                    {
319
                        b_found = 1;
320 321
                        msg_Dbg( p_this, "found a possible subtitle: %s",
                                 de->d_name );
322 323 324 325 326 327
                        break;
                    }
                }

                /* we have a (likely) subtitle file */
                if( b_found )
328
                {
329
                    int i_prio = 0;
330
                    if( !i_prio && !strcmp( tmp_fname_trim, f_fname_trim ) )
331
                    {
332 333 334
                        /* matches the movie name exactly */
                        i_prio = 4;
                    }
335 336
                    if( !i_prio &&
                        ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
337
                    {
338
                        /* contains the movie name */
339 340 341 342 343 344 345 346
                        tmp += strlen( f_fname_trim );
                        if( whiteonly( tmp ) )
                        {
                            /* chars in front of the movie name */
                            i_prio = 2;
                        }
                        else
                        {
Clément Stenac's avatar
Clément Stenac committed
347 348
                            /* chars after (and possibly in front of)
                             * the movie name */
349 350
                            i_prio = 3;
                        }
351 352
                    }
                    if( !i_prio )
353
                    {
354 355 356 357 358
                        /* doesn't contain the movie name */
                        if( j == 0 ) i_prio = 1;
                    }

                    if( i_prio >= fuzzy.i_int )
359
                    {
360
                        sprintf( tmpresult, "%s%s", j == -1 ? f_dir : *subdirs,
361 362 363
                                 de->d_name );
                        msg_Dbg( p_this, "autodetected subtitle: %s with "
                                 "priority %d", de->d_name, i_prio );
364
                        if( ( f = fopen( tmpresult, "rt" ) ) )
365
                        {
366 367
                            fclose( f );
                            result[i_sub_count].priority = i_prio;
368
                            result[i_sub_count].psz_fname = strdup(tmpresult);
369
                            result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
370 371 372 373 374 375 376 377
                            i_sub_count++;
                        }
                    }
                }
                if( i_sub_count >= MAX_SUBTITLE_FILES ) break;
            }
            closedir( d );
        }
378
        if( j >= 0 ) free( *subdirs++ );
379
    }
380

381
    if( tmp_subdirs ) free( tmp_subdirs );
382

383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
    free( f_dir );
    free( f_fname );
    free( f_fname_noext );
    free( f_fname_trim );

    free( tmp_fname_noext );
    free( tmp_fname_trim );
    free( tmp_fname_ext );

    free( tmpresult );

    qsort( result, i_sub_count, sizeof( subfn ), compare_sub_priority );

    result2 = (char**)malloc( sizeof(char*) * ( i_sub_count + 1 ) );
    memset( result2, 0, sizeof(char*) * ( i_sub_count + 1 ) );
398
    i_result2 = 0;
399 400 401

    for( i = 0; i < i_sub_count; i++ )
    {
402 403 404 405 406 407
        if( result[i].psz_ext && !strcasecmp( result[i].psz_ext, "sub" ) )
        {
            int j;
            for( j = 0; j < i_sub_count; j++ )
            {
                if( result[j].psz_fname && result[i].psz_fname &&
408 409
                    !strncasecmp( result[i].psz_fname, result[j].psz_fname, sizeof( result[i].psz_fname) - 4 ) && 
                    !strcasecmp( result[j].psz_ext, "idx" ) )
410 411 412 413 414 415 416 417 418 419 420 421 422 423
                    break;
                
            }
            if( j >= i_sub_count )
            {
                result2[i_result2] = result[i].psz_fname;
                i_result2++;
            }
        }
        else
        {
            result2[i_result2] = result[i].psz_fname;
            i_result2++;
        }
424 425 426 427
    }
    free( result );
    return result2;
}