subtitles.c 13.6 KB
Newer Older
1 2 3
/*****************************************************************************
 * subtitles.c
 *****************************************************************************
4
 * Copyright (C) 2003-2006 the VideoLAN team
5
 * $Id$
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * 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
Antoine Cellerier's avatar
Antoine Cellerier committed
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 24
 *****************************************************************************/

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

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

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

39 40
#ifdef HAVE_LIMITS_H
#   include <limits.h>
41 42
#endif

43 44 45 46
#ifdef HAVE_UNISTD_H
#   include <unistd.h>
#endif

47 48
#include <ctype.h>

49 50 51
/**
 * What's between a directory and a filename?
 */
52 53 54 55 56 57
#if defined( WIN32 )
    #define DIRECTORY_SEPARATOR '\\'
#else
    #define DIRECTORY_SEPARATOR '/'
#endif

58 59 60
/**
 * We are not going to autodetect more subtitle files than this.
 */
61 62
#define MAX_SUBTITLE_FILES 128

63 64

/**
65
 * The possible extensions for subtitle files we support
66
 */
67
static const char * sub_exts[] = {  "utf", "utf8", "utf-8", "sub", "srt", "smi", "txt", "ssa", "idx", NULL };
68 69
/* extensions from unsupported types */
/* rt, aqt, jss, js, ass */
70

71 72 73 74 75
static void strcpy_trim( char *d, char *s )
{
    /* skip leading whitespace */
    while( *s && !isalnum(*s) )
    {
76
        s++;
77 78 79
    }
    for(;;)
    {
80 81
        /* copy word */
        while( *s && isalnum(*s) )
82
        {
83 84 85
            *d = tolower(*s);
            s++; d++;
        }
86
        if( *s == 0 ) break;
87 88
        /* trim excess whitespace */
        while( *s && !isalnum(*s) )
89
        {
90 91 92 93
            s++;
        }
        if( *s == 0 ) break;
        *d++ = ' ';
94 95 96
    }
    *d = 0;
}
97

98 99 100
static void strcpy_strip_ext( char *d, char *s )
{
    char *tmp = strrchr(s, '.');
101 102
    if( !tmp )
    {
103 104
        strcpy(d, s);
        return;
105 106
    }
    else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
107
        strlcpy(d, s, tmp - s);
108 109
    while( *d )
    {
110 111
        *d = tolower(*d);
        d++;
112 113
    }
}
114

115 116 117 118 119
static void strcpy_get_ext( char *d, char *s )
{
    char *tmp = strrchr(s, '.');
    if( !tmp )
    {
120 121
        strcpy(d, "");
        return;
122 123 124 125 126 127 128
    } else strcpy( d, tmp + 1 );
}

static int whiteonly( char *s )
{
  while ( *s )
  {
129 130
        if( isalnum( *s ) ) return 0;
        s++;
131 132 133 134
  }
  return 1;
}

135
typedef struct _subfn
136 137 138
{
    int priority;
    char *psz_fname;
139
    char *psz_ext;
140 141 142 143
} subfn;

static int compare_sub_priority( const void *a, const void *b )
{
144 145 146
    if (((subfn*)a)->priority > ((subfn*)b)->priority)
    {
        return -1;
147
    }
148 149 150 151 152 153

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

154
#ifndef UNDER_CE
155
    return strcoll(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
156 157 158
#else
    return strcmp(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
#endif
159 160
}

161
/* Utility function for scandir */
162
static int Filter( const char *psz_dir_content )
163 164
{
    /* does it end with a subtitle extension? */
165 166 167
    const char *tmp = strrchr( psz_dir_content, '.');
    if( tmp == NULL )
        return 0;
168 169
    else
    {
170 171 172
        int i;
        tmp++;

173
        for( i = 0; sub_exts[i]; i++ )
174 175
            if( strcmp( sub_exts[i], tmp ) == 0 )
                return 1;
176
    }
177
    return 0;
178 179 180
}


181
/**
182
 * Convert a list of paths separated by ',' to a char**
183
 */
184
static char **paths_to_list( char *psz_dir, char *psz_path )
185
{
186
    unsigned int i, k, i_nb_subdirs;
187
    char **subdirs; /* list of subdirectories to look in */
188 189 190 191

    if( !psz_dir ) return NULL;
    if( !psz_path ) return NULL;

192 193 194
    i_nb_subdirs = 1;
    for( k = 0; k < strlen( psz_path ); k++ )
    {
195
        if( psz_path[k] == ',' )
196 197 198 199
        {
            i_nb_subdirs++;
        }
    }
200

201
    if( i_nb_subdirs > 0 )
202
    {
203 204
        char *psz_parser = NULL, *psz_temp = NULL;

205 206
        subdirs = (char**)malloc( sizeof(char*) * ( i_nb_subdirs + 1 ) );
        memset( subdirs, 0, sizeof(char*) * ( i_nb_subdirs + 1 ) );
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
        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++;
                }
            }
223
            if( strlen( psz_subdir ) > 0 )
224
            {
225 226 227 228
                psz_temp = (char *)malloc( strlen(psz_dir)
                                           + strlen(psz_subdir) + 2 );
                if( psz_temp )
                {
229
                    sprintf( psz_temp, "%s%s%c",
230
                             psz_subdir[0] == '.' ? psz_dir : "",
231
                             psz_subdir,
232
                             psz_subdir[strlen(psz_subdir) - 1] ==
233 234 235 236
                              DIRECTORY_SEPARATOR ? '\0' : DIRECTORY_SEPARATOR );
                    subdirs[i] = psz_temp;
                    i++;
                }
237 238
            }
        }
239 240 241
        subdirs[i] = NULL;
    }
    else
242 243 244
    {
        subdirs = NULL;
    }
245 246 247
    return subdirs;
}

248

249 250 251
/**
 * Detect subtitle files.
 *
252
 * When called this function will split up the psz_name string into a
253 254 255 256 257 258 259
 * 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.
260
 * \param psz_name the complete filename to base the search on.
261 262 263 264
 * \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,
265
                         char *psz_name )
266 267
{
    vlc_value_t fuzzy;
268
    int j, i_result2, i_sub_count = 0, i_fname_len = 0;
269 270 271
    char *f_dir = NULL, *f_fname = NULL, *f_fname_noext = NULL, *f_fname_trim = NULL;
    char *tmp = NULL;

272
    char **tmp_subdirs, **subdirs; /* list of subdirectories to look in */
273 274

    subfn *result = NULL; /* unsorted results */
275
    char **result2; /* sorted results */
276

277 278
    char *psz_fname_original = strdup( psz_name );
    char *psz_fname = psz_fname_original;
279

280 281
    if( psz_fname == NULL ) return NULL;

282 283 284 285
    if( !strncmp( psz_fname, "file://", 7 ) )
    {
        psz_fname += 7;
    }
286

287 288 289 290
    /* extract filename & dirname from psz_fname */
    tmp = strrchr( psz_fname, DIRECTORY_SEPARATOR );
    if( tmp )
    {
291 292
        int dirlen = 0;

293
        f_fname = malloc( strlen(tmp) );
294
        if( f_fname )
295 296
            strcpy( f_fname, tmp+1 ); // we skip the separator, so it will still fit in the allocated space
        dirlen = strlen(psz_fname) - strlen(tmp) + 2; // add the separator
297
        f_dir = malloc( dirlen + 1 );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
298 299
        if( f_dir != NULL )
            strlcpy( f_dir, psz_fname, dirlen );
300 301 302
    }
    else
    {
303
        /* Get the current working directory */
304
        int dirlen;
305 306 307 308 309 310 311 312
#ifdef HAVE_UNISTD_H
        f_dir = getcwd( NULL, 0 );
#endif
        if( f_dir == NULL )
        {
            if( psz_fname_original ) free( psz_fname_original );
            return NULL;
        }
313 314 315 316
        dirlen = strlen( f_dir );
        f_dir = (char *)realloc(f_dir, dirlen +2 );
        f_dir[dirlen] = DIRECTORY_SEPARATOR;
        f_dir[dirlen+1] = '\0';
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
317
        f_fname = FromLocaleDup( psz_fname );
318 319
    }

320 321 322
    i_fname_len = strlen( f_fname );
    f_fname_noext = malloc(i_fname_len + 1);
    f_fname_trim = malloc(i_fname_len + 1 );
323

324 325
    strcpy_strip_ext( f_fname_noext, f_fname );
    strcpy_trim( f_fname_trim, f_fname_noext );
326

327
    result = (subfn*)malloc( sizeof(subfn) * MAX_SUBTITLE_FILES );
328 329 330
    if( result )
        memset( result, 0, sizeof(subfn) * MAX_SUBTITLE_FILES );

331
    var_Get( p_this, "sub-autodetect-fuzzy", &fuzzy );
332

333 334
    tmp_subdirs = paths_to_list( f_dir, psz_path );
    subdirs = tmp_subdirs;
335

336 337
    for( j = -1; (j == -1) || ( (j >= 0) && (subdirs != NULL) &&
        (*subdirs != NULL) ); j++)
338
    {
339 340 341
        const char *psz_dir = j < 0 ? f_dir : *subdirs;
        char **ppsz_dir_content;
        int i_dir_content;
342

343
        if( psz_dir == NULL )
344 345
            continue;

346
        /* parse psz_src dir */
347 348
        i_dir_content = utf8_scandir( psz_dir, &ppsz_dir_content, Filter,
                                      NULL );
349 350

        if( i_dir_content != -1 )
351
        {
352 353
            int a;

354
            msg_Dbg( p_this, "looking for a subtitle file in %s", psz_dir );
355
            for( a = 0; a < i_dir_content; a++ )
356
            {
357 358
                char *psz_name = vlc_fix_readdir_charset( p_this,
                                                          ppsz_dir_content[a] );
359 360 361 362
                char tmp_fname_noext[strlen( psz_name ) + 1];
                char tmp_fname_trim[strlen( psz_name ) + 1];
                char tmp_fname_ext[strlen( psz_name ) + 1];

363
                int i_prio = 0;
364

365 366
                if( psz_name == NULL )
                    continue;
367

368
                /* retrieve various parts of the filename */
369 370
                strcpy_strip_ext( tmp_fname_noext, psz_name );
                strcpy_get_ext( tmp_fname_ext, psz_name );
371
                strcpy_trim( tmp_fname_trim, tmp_fname_noext );
372

373
                if( !i_prio && !strcmp( tmp_fname_trim, f_fname_trim ) )
374
                {
375 376
                    /* matches the movie name exactly */
                    i_prio = 4;
377
                }
378 379
                if( !i_prio &&
                    ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
380
                {
381 382 383
                    /* contains the movie name */
                    tmp += strlen( f_fname_trim );
                    if( whiteonly( tmp ) )
384
                    {
385 386
                        /* chars in front of the movie name */
                        i_prio = 2;
387
                    }
388
                    else
389
                    {
390 391 392
                        /* chars after (and possibly in front of)
                         * the movie name */
                        i_prio = 3;
393
                    }
394 395 396 397 398 399 400 401 402
                }
                if( !i_prio )
                {
                    /* doesn't contain the movie name */
                    if( j == 0 ) i_prio = 1;
                }
                if( i_prio >= fuzzy.i_int )
                {
                    FILE *f;
403
                    char psz_path[strlen( psz_dir ) + strlen( psz_name ) + 1];
404

405
                    sprintf( psz_path, "%s%s", psz_dir, psz_name );
406 407 408
                    msg_Dbg( p_this,
                                "autodetected subtitle: %s with priority %d",
                                psz_path, i_prio );
409
                    /* FIXME: a portable wrapper for stat() or access() would be more suited */
410
                    if( ( f = utf8_fopen( psz_path, "rt" ) ) )
411
                    {
412
                        fclose( f );
413 414 415
                        msg_Dbg( p_this,
                                "autodetected subtitle: %s with priority %d",
                                psz_path, i_prio );
416
                        result[i_sub_count].priority = i_prio;
417
                        result[i_sub_count].psz_fname = strdup( psz_path );
418 419
                        result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
                        i_sub_count++;
420 421 422
                    }
                    else
                    {
423
                        msg_Dbg( p_this, "fopen failed" );
424
                    }
425 426
                }
                if( i_sub_count >= MAX_SUBTITLE_FILES ) break;
427
                free( psz_name );
428
            }
429
            for( a = 0; a < i_dir_content; a++ )
430 431
                free( ppsz_dir_content[a] );
            if( ppsz_dir_content ) free( ppsz_dir_content );
432
        }
433
        if( j >= 0 ) if( *subdirs ) free( *subdirs++ );
434
    }
435

436 437 438 439 440 441
    if( tmp_subdirs )   free( tmp_subdirs );
    if( f_fname_trim )  free( f_fname_trim );
    if( f_fname_noext ) free( f_fname_noext );
    if( f_fname ) free( f_fname );
    if( f_dir )   free( f_dir );

442 443 444
    qsort( result, i_sub_count, sizeof( subfn ), compare_sub_priority );

    result2 = (char**)malloc( sizeof(char*) * ( i_sub_count + 1 ) );
445 446
    if( result2 )
        memset( result2, 0, sizeof(char*) * ( i_sub_count + 1 ) );
447
    i_result2 = 0;
448

449
    for( j = 0; j < i_sub_count; j++ )
450
    {
451
        if( result[j].psz_ext && !strcasecmp( result[j].psz_ext, "sub" ) )
452
        {
453 454
            int i;
            for( i = 0; i < i_sub_count; i++ )
455
            {
456
                if( result[i].psz_fname && result[j].psz_fname &&
457 458
                    !strncasecmp( result[j].psz_fname, result[i].psz_fname,
                                sizeof( result[j].psz_fname) - 4 ) &&
459
                    !strcasecmp( result[i].psz_ext, "idx" ) )
460 461
                    break;
            }
462
            if( i >= i_sub_count )
463
            {
464
                result2[i_result2] = result[j].psz_fname;
465 466 467 468 469
                i_result2++;
            }
        }
        else
        {
470
            result2[i_result2] = result[j].psz_fname;
471 472
            i_result2++;
        }
473
    }
474

475 476
    if( psz_fname_original ) free( psz_fname_original );
    if( result ) free( result );
477 478
    return result2;
}