subtitles.c 13 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 33
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

34
#include <vlc_common.h>
Clément Stenac's avatar
Clément Stenac committed
35 36
#include <vlc_input.h>
#include <vlc_charset.h>
37

38 39 40 41
#ifdef HAVE_DIRENT_H
#   include <dirent.h>
#endif

42
#include <limits.h>
43

44 45 46
#ifdef HAVE_UNISTD_H
#   include <unistd.h>
#endif
47
#include <sys/stat.h>
48

49
#include <ctype.h>
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
50
#include "input_internal.h"
51

52 53 54
/**
 * We are not going to autodetect more subtitle files than this.
 */
55 56
#define MAX_SUBTITLE_FILES 128

57 58

/**
59
 * The possible extensions for subtitle files we support
60
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
61
static const char const sub_exts[][6] = {
62 63
    "idx", "sub",  "srt",
    "ssa", "ass",  "smi",
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
64
    "utf", "utf8", "utf-8",
65 66 67 68
    "txt", "rt",   "aqt",
    "usf", "jss",  "cdg",
    "psb", "mpsub","mpl2",
    "pjs", "dks",
Laurent Aimar's avatar
Laurent Aimar committed
69
    ""
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
70 71
};

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

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

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

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

136 137 138 139 140 141 142 143 144
enum
{
    SUB_PRIORITY_NONE = 0,
    SUB_PRIORITY_MATCH_NONE = 1,
    SUB_PRIORITY_MATCH_RIGHT = 2,
    SUB_PRIORITY_MATCH_LEFT = 3,
    SUB_PRIORITY_MATCH_ALL = 4,
};
typedef struct
145 146 147
{
    int priority;
    char *psz_fname;
148
    char *psz_ext;
149
} vlc_subfn_t;
150 151 152

static int compare_sub_priority( const void *a, const void *b )
{
153 154 155 156
    const vlc_subfn_t *p0 = a;
    const vlc_subfn_t *p1 = b;

    if( p0->priority > p1->priority )
157 158
        return -1;

159
    if( p0->priority < p1->priority )
160 161
        return 1;

162
#ifndef UNDER_CE
163
    return strcoll( p0->psz_fname, p1->psz_fname);
164
#else
165
    return strcmp( p0->psz_fname, p1->psz_fname);
166
#endif
167 168
}

169 170 171
/*
 * Check if a file ends with a subtitle extension
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
172
int subtitles_Filter( const char *psz_dir_content )
173
{
174
    const char *tmp = strrchr( psz_dir_content, '.');
175 176 177
    int i;

    if( !tmp )
178
        return 0;
179
    tmp++;
180

181 182 183
    for( i = 0; sub_exts[i][0]; i++ )
        if( strcasecmp( sub_exts[i], tmp ) == 0 )
            return 1;
184
    return 0;
185 186 187
}


188
/**
189
 * Convert a list of paths separated by ',' to a char**
190
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
191
static char **paths_to_list( const char *psz_dir, char *psz_path )
192
{
193
    unsigned int i, k, i_nb_subdirs;
194
    char **subdirs; /* list of subdirectories to look in */
195
    char *psz_parser = psz_path;
196

197 198
    if( !psz_dir || !psz_path )
        return NULL;
199

200
    for( k = 0, i_nb_subdirs = 1; psz_path[k] != '\0'; k++ )
201
    {
202
        if( psz_path[k] == ',' )
203 204
            i_nb_subdirs++;
    }
205

206 207 208
    subdirs = calloc( i_nb_subdirs + 1, sizeof(char*) );
    if( !subdirs )
        return NULL;
209

210
    for( i = 0; psz_parser && *psz_parser != '\0' ; )
211 212 213 214
    {
        char *psz_subdir = psz_parser;
        psz_parser = strchr( psz_subdir, ',' );
        if( psz_parser )
215
        {
216 217
            *psz_parser++ = '\0';
            while( *psz_parser == ' ' )
218 219
                psz_parser++;
        }
220 221 222
        if( *psz_subdir == '\0' )
            continue;

223
        if( asprintf( &subdirs[i++], "%s%s%c",
224 225
                  psz_subdir[0] == '.' ? psz_dir : "",
                  psz_subdir,
226 227 228
                  psz_subdir[strlen(psz_subdir) - 1] == DIR_SEP_CHAR ?
                                           '\0' : DIR_SEP_CHAR ) == -1 )
            break;
229
    }
230 231
    subdirs[i] = NULL;

232 233 234
    return subdirs;
}

235

236 237 238
/**
 * Detect subtitle files.
 *
239
 * When called this function will split up the psz_name string into a
240 241 242 243 244 245 246
 * 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.
247
 * \param psz_name the complete filename to base the search on.
248 249 250 251
 * \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,
252
                         const char *psz_name_org )
253 254
{
    vlc_value_t fuzzy;
255
    int j, i_result2, i_sub_count, i_fname_len;
256 257 258
    char *f_dir = NULL, *f_fname = NULL, *f_fname_noext = NULL, *f_fname_trim = NULL;
    char *tmp = NULL;

259
    char **subdirs; /* list of subdirectories to look in */
260

261
    vlc_subfn_t *result = NULL; /* unsorted results */
262
    char **result2; /* sorted results */
263
    const char *psz_fname = psz_name_org;
264

265 266
    if( !psz_fname )
        return NULL;
267

268 269
    if( !strncmp( psz_fname, "file://", 7 ) )
        psz_fname += 7;
270

271
    /* extract filename & dirname from psz_fname */
272
    tmp = strrchr( psz_fname, DIR_SEP_CHAR );
273 274
    if( tmp )
    {
275 276 277
        const int i_dirlen = strlen(psz_fname)-strlen(tmp)+1; /* include the separator */
        f_fname = strdup( &tmp[1] );    /* skip the separator */
        f_dir = strndup( psz_fname, i_dirlen );
278 279 280
    }
    else
    {
281
#if defined (HAVE_UNISTD_H) && !defined (UNDER_CE)
282 283 284 285
        /* Get the current working directory */
        char *psz_cwd = getcwd( NULL, 0 );
#else
        char *psz_cwd = NULL;
286
#endif
287
        if( !psz_cwd )
288
            return NULL;
289

290
        f_fname = strdup( psz_fname );
291
        if( asprintf( &f_dir, "%s%c", psz_cwd, DIR_SEP_CHAR ) == -1 )
Rémi Duraffort's avatar
Rémi Duraffort committed
292
            f_dir = NULL; /* Assure that function will return in next test */
293 294 295 296
        free( psz_cwd );
    }
    if( !f_fname || !f_dir )
    {
297 298
        free( f_fname );
        free( f_dir );
299
        return NULL;
300 301
    }

302
    i_fname_len = strlen( f_fname );
303

304 305
    f_fname_noext = malloc(i_fname_len + 1);
    f_fname_trim = malloc(i_fname_len + 1 );
306 307
    if( !f_fname_noext || !f_fname_trim )
    {
308 309 310 311
        free( f_fname );
        free( f_dir );
        free( f_fname_noext );
        free( f_fname_trim );
312 313
        return NULL;
    }
314

315 316
    strcpy_strip_ext( f_fname_noext, f_fname );
    strcpy_trim( f_fname_trim, f_fname_noext );
317

318
    var_Get( p_this, "sub-autodetect-fuzzy", &fuzzy );
319

320 321 322
    result = calloc( MAX_SUBTITLE_FILES+1, sizeof(vlc_subfn_t) ); /* We check it later (simplify code) */
    subdirs = paths_to_list( f_dir, psz_path );
    for( j = -1, i_sub_count = 0; (j == -1) || ( j >= 0 && subdirs != NULL && subdirs[j] != NULL ); j++ )
323
    {
324
        const char *psz_dir = j < 0 ? f_dir : subdirs[j];
325 326
        char **ppsz_dir_content;
        int i_dir_content;
327
        int a;
328

329
        if( psz_dir == NULL || ( j >= 0 && !strcmp( psz_dir, f_dir ) ) )
330 331
            continue;

332
        /* parse psz_src dir */
333 334
        i_dir_content = utf8_scandir( psz_dir, &ppsz_dir_content,
                                      subtitles_Filter, NULL );
335 336
        if( i_dir_content < 0 )
            continue;
337

338 339
        msg_Dbg( p_this, "looking for a subtitle file in %s", psz_dir );
        for( a = 0; a < i_dir_content && i_sub_count < MAX_SUBTITLE_FILES ; a++ )
340
        {
341 342 343 344
            char *psz_name = ppsz_dir_content[a];
            char tmp_fname_noext[strlen( psz_name ) + 1];
            char tmp_fname_trim[strlen( psz_name ) + 1];
            char tmp_fname_ext[strlen( psz_name ) + 1];
345

346
            int i_prio;
347

348
            if( psz_name == NULL || psz_name[0] == '.' )
349
                continue;
350

351 352 353 354
            /* retrieve various parts of the filename */
            strcpy_strip_ext( tmp_fname_noext, psz_name );
            strcpy_get_ext( tmp_fname_ext, psz_name );
            strcpy_trim( tmp_fname_trim, tmp_fname_noext );
355

356 357 358 359 360 361 362 363 364 365 366 367
            i_prio = SUB_PRIORITY_NONE;
            if( i_prio == SUB_PRIORITY_NONE && !strcmp( tmp_fname_trim, f_fname_trim ) )
            {
                /* matches the movie name exactly */
                i_prio = SUB_PRIORITY_MATCH_ALL;
            }
            if( i_prio == SUB_PRIORITY_NONE &&
                ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
            {
                /* contains the movie name */
                tmp += strlen( f_fname_trim );
                if( whiteonly( tmp ) )
368
                {
369 370
                    /* chars in front of the movie name */
                    i_prio = SUB_PRIORITY_MATCH_RIGHT;
371
                }
372
                else
373
                {
374 375 376
                    /* chars after (and possibly in front of)
                     * the movie name */
                    i_prio = SUB_PRIORITY_MATCH_LEFT;
377
                }
378 379 380 381 382 383 384 385 386 387 388
            }
            if( i_prio == SUB_PRIORITY_NONE &&
                j == 0 )
            {
                /* doesn't contain the movie name, prefer files in f_dir over subdirs */
                i_prio = SUB_PRIORITY_MATCH_NONE;
            }
            if( i_prio >= fuzzy.i_int )
            {
                char psz_path[strlen( psz_dir ) + strlen( psz_name ) + 1];
                struct stat st;
389

390 391 392
                sprintf( psz_path, "%s%s", psz_dir, psz_name );
                if( !strcmp( psz_path, psz_fname ) )
                    continue;
Laurent Aimar's avatar
Laurent Aimar committed
393

394 395
                if( !utf8_stat( psz_path, &st ) && S_ISREG( st.st_mode ) && result )
                {
396
                    msg_Dbg( p_this,
397 398 399 400 401 402 403 404 405 406 407
                            "autodetected subtitle: %s with priority %d",
                            psz_path, i_prio );
                    result[i_sub_count].priority = i_prio;
                    result[i_sub_count].psz_fname = strdup( psz_path );
                    result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
                    i_sub_count++;
                }
                else
                {
                    msg_Dbg( p_this, "stat failed (autodetecting subtitle: %s with priority %d)",
                             psz_path, i_prio );
408 409
                }
            }
410 411 412
        }
        if( ppsz_dir_content )
        {
413
            for( a = 0; a < i_dir_content; a++ )
414
                free( ppsz_dir_content[a] );
415
            free( ppsz_dir_content );
416
        }
417
    }
418 419 420
    if( subdirs )
    {
        for( j = 0; subdirs[j]; j++ )
421
            free( subdirs[j] );
422 423 424 425 426 427
        free( subdirs );
    }
    free( f_fname );
    free( f_dir );
    free( f_fname_trim );
    free( f_fname_noext );
428

429 430
    if( !result )
        return NULL;
431

432
    qsort( result, i_sub_count, sizeof(vlc_subfn_t), compare_sub_priority );
433

434
    result2 = calloc( i_sub_count + 1, sizeof(char*) );
435

436
    for( j = 0, i_result2 = 0; j < i_sub_count && result2 != NULL; j++ )
437
    {
438
        bool b_reject = false;
439 440 441 442 443

        if( !result[j].psz_fname || !result[j].psz_ext ) /* memory out */
            break;

        if( !strcasecmp( result[j].psz_ext, "sub" ) )
444
        {
445 446
            int i;
            for( i = 0; i < i_sub_count; i++ )
447
            {
448
                if( result[i].psz_fname && result[i].psz_ext &&
449
                    !strncasecmp( result[j].psz_fname, result[i].psz_fname,
450
                                  strlen( result[j].psz_fname) - 3 ) &&
451
                    !strcasecmp( result[i].psz_ext, "idx" ) )
452 453
                    break;
            }
454
            if( i < i_sub_count )
455
                b_reject = true;
Laurent Aimar's avatar
Laurent Aimar committed
456
        }
457
        else if( !strcasecmp( result[j].psz_ext, "cdg" ) )
458
        {
459
            if( result[j].priority < SUB_PRIORITY_MATCH_ALL )
460
                b_reject = true;
461
        }
462 463 464 465

        /* */
        if( !b_reject )
            result2[i_result2++] = strdup( result[j].psz_fname );
466
    }
467

468 469
    for( j = 0; j < i_sub_count; j++ )
    {
470 471
        free( result[j].psz_fname );
        free( result[j].psz_ext );
472 473 474
    }
    free( result );

475 476
    return result2;
}
477