subtitles.c 13.1 KB
Newer Older
1
/*****************************************************************************
2
 * subtitles.c : subtitles detection
3
 *****************************************************************************
4
 * Copyright (C) 2003-2009 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>
35
#include <vlc_fs.h>
36
#include <vlc_url.h>
37

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

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

46
#include <sys/stat.h>
47

48 49
#include <ctype.h> /* isalnum */

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

71
static void strcpy_trim( char *d, const char *s )
72 73 74 75
{
    /* 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
static void strcpy_strip_ext( char *d, const char *s )
99
{
100
    const char *tmp = strrchr(s, '.');
101 102
    if( !tmp )
    {
103 104
        strcpy(d, s);
        return;
105 106
    }
    else
107
        strlcpy(d, s, tmp - s + 1 );
108 109
    while( *d )
    {
110 111
        *d = tolower(*d);
        d++;
112 113
    }
}
114

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

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

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

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

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

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

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

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

    if( !tmp )
176
        return 0;
177
    tmp++;
178

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


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

195 196
    if( !psz_dir || !psz_path )
        return NULL;
197

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

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

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

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

230 231 232
    return subdirs;
}

233

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

257
    char **subdirs; /* list of subdirectories to look in */
258

259
    vlc_subfn_t *result = NULL; /* unsorted results */
260
    char **result2; /* sorted results */
261

262
    if( !psz_name_org )
263
        return NULL;
264

265
    char *psz_fname = make_path( psz_name_org );
266 267
    if( !psz_fname )
        return NULL;
268

269
    /* extract filename & dirname from psz_fname */
270
    tmp = strrchr( psz_fname, DIR_SEP_CHAR );
271 272
    if( tmp )
    {
273 274 275
        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 );
276 277 278
    }
    else
    {
279
#if defined (HAVE_UNISTD_H) && !defined (UNDER_CE)
280 281 282 283
        /* Get the current working directory */
        char *psz_cwd = getcwd( NULL, 0 );
#else
        char *psz_cwd = NULL;
284
#endif
285
        if( !psz_cwd )
286 287
        {
            free( psz_fname );
288
            return NULL;
289
        }
290

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

304
    i_fname_len = strlen( f_fname );
305

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

318 319
    strcpy_strip_ext( f_fname_noext, f_fname );
    strcpy_trim( f_fname_trim, f_fname_noext );
320

321
    i_fuzzy = var_GetInteger( p_this, "sub-autodetect-fuzzy" );
322

323 324 325
    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++ )
326
    {
327
        const char *psz_dir = j < 0 ? f_dir : subdirs[j];
328 329
        char **ppsz_dir_content;
        int i_dir_content;
330

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

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

340
        msg_Dbg( p_this, "looking for a subtitle file in %s", psz_dir );
341
        for( int a = 0; a < i_dir_content && i_sub_count < MAX_SUBTITLE_FILES ; a++ )
342
        {
343 344 345 346
            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];
347

348
            int i_prio;
349

350
            if( psz_name == NULL || psz_name[0] == '.' )
351
                continue;
352

353 354 355 356
            /* 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 );
357

358 359 360 361 362 363 364 365 366 367 368 369
            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 ) )
370
                {
371 372
                    /* chars in front of the movie name */
                    i_prio = SUB_PRIORITY_MATCH_RIGHT;
373
                }
374
                else
375
                {
376 377 378
                    /* chars after (and possibly in front of)
                     * the movie name */
                    i_prio = SUB_PRIORITY_MATCH_LEFT;
379
                }
380 381 382 383 384 385 386
            }
            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;
            }
387
            if( i_prio >= i_fuzzy )
388 389 390
            {
                char psz_path[strlen( psz_dir ) + strlen( psz_name ) + 1];
                struct stat st;
391

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

396
                if( !vlc_stat( psz_path, &st ) && S_ISREG( st.st_mode ) && result )
397
                {
398
                    msg_Dbg( p_this,
399 400 401 402 403 404 405 406 407 408 409
                            "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 );
410 411
                }
            }
412 413 414
        }
        if( ppsz_dir_content )
        {
415
            for( int a = 0; a < i_dir_content; a++ )
416
                free( ppsz_dir_content[a] );
417
            free( ppsz_dir_content );
418
        }
419
    }
420 421 422
    if( subdirs )
    {
        for( j = 0; subdirs[j]; j++ )
423
            free( subdirs[j] );
424 425 426 427 428 429
        free( subdirs );
    }
    free( f_fname );
    free( f_dir );
    free( f_fname_trim );
    free( f_fname_noext );
430
    free( psz_fname );
431

432 433
    if( !result )
        return NULL;
434

435
    qsort( result, i_sub_count, sizeof(vlc_subfn_t), compare_sub_priority );
436

437
    result2 = calloc( i_sub_count + 1, sizeof(char*) );
438

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

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

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

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

471 472
    for( j = 0; j < i_sub_count; j++ )
    {
473 474
        free( result[j].psz_fname );
        free( result[j].psz_ext );
475 476 477
    }
    free( result );

478 479
    return result2;
}
480