subtitles.c 12.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
#ifdef HAVE_UNISTD_H
#   include <unistd.h>
#endif
41

42
#include <sys/stat.h>
43

44 45
#include <ctype.h> /* isalnum */

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
46
#include "input_internal.h"
47

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

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

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

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

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

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

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

static int compare_sub_priority( const void *a, const void *b )
{
148 149 150 151
    const vlc_subfn_t *p0 = a;
    const vlc_subfn_t *p1 = b;

    if( p0->priority > p1->priority )
152 153
        return -1;

154
    if( p0->priority < p1->priority )
155 156
        return 1;

157
#ifndef UNDER_CE
158
    return strcoll( p0->psz_fname, p1->psz_fname);
159
#else
160
    return strcmp( p0->psz_fname, p1->psz_fname);
161
#endif
162 163
}

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

    if( !tmp )
172
        return 0;
173
    tmp++;
174

175
    for( int i = 0; sub_exts[i][0]; i++ )
176 177
        if( strcasecmp( sub_exts[i], tmp ) == 0 )
            return 1;
178
    return 0;
179 180 181
}


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

191 192
    if( !psz_dir || !psz_path )
        return NULL;
193

194
    for( k = 0, i_nb_subdirs = 1; psz_path[k] != '\0'; k++ )
195
    {
196
        if( psz_path[k] == ',' )
197 198
            i_nb_subdirs++;
    }
199

200 201 202
    subdirs = calloc( i_nb_subdirs + 1, sizeof(char*) );
    if( !subdirs )
        return NULL;
203

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

217
        if( asprintf( &subdirs[i++], "%s%s",
218
                  psz_subdir[0] == '.' ? psz_dir : "",
219
                  psz_subdir ) == -1 )
220
            break;
221
    }
222 223
    subdirs[i] = NULL;

224 225 226
    return subdirs;
}

227

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

250
    char **subdirs; /* list of subdirectories to look in */
251

252
    vlc_subfn_t *result = NULL; /* unsorted results */
253
    char **result2; /* sorted results */
254

255
    if( !psz_name_org )
256
        return NULL;
257

258
    char *psz_fname = make_path( psz_name_org );
259 260
    if( !psz_fname )
        return NULL;
261

262
    /* extract filename & dirname from psz_fname */
263 264
    char *f_dir = strdup( psz_fname );
    if( f_dir == NULL )
265
    {
266 267
        free( psz_fname );
        return NULL;
268
    }
269

270 271
    char *f_fname = strrchr( f_dir, DIR_SEP_CHAR );
    if( !f_fname )
272
    {
273
        free( f_dir );
274
        free( psz_fname );
275
        return NULL;
276
    }
277
    *(f_fname++) = 0; /* skip dir separator */
278

279
    i_fname_len = strlen( f_fname );
280

281 282
    f_fname_noext = malloc(i_fname_len + 1);
    f_fname_trim = malloc(i_fname_len + 1 );
283 284
    if( !f_fname_noext || !f_fname_trim )
    {
285 286 287
        free( f_dir );
        free( f_fname_noext );
        free( f_fname_trim );
288
        free( psz_fname );
289 290
        return NULL;
    }
291

292 293
    strcpy_strip_ext( f_fname_noext, f_fname );
    strcpy_trim( f_fname_trim, f_fname_noext );
294

295
    i_fuzzy = var_GetInteger( p_this, "sub-autodetect-fuzzy" );
296

297 298 299
    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++ )
300
    {
301
        const char *psz_dir = (j < 0) ? f_dir : subdirs[j];
302
        if( psz_dir == NULL || ( j >= 0 && !strcmp( psz_dir, f_dir ) ) )
303 304
            continue;

305
        /* parse psz_src dir */
306 307
        DIR *dir = vlc_opendir( psz_dir );
        if( dir == NULL )
308
            continue;
309

310
        msg_Dbg( p_this, "looking for a subtitle file in %s", psz_dir );
311 312 313

        char *psz_name;
        while( (psz_name = vlc_readdir( dir )) && i_sub_count < MAX_SUBTITLE_FILES )
314
        {
315 316 317 318 319 320
            if( psz_name[0] == '.' || !subtitles_Filter( psz_name ) )
            {
                free( psz_name );
                continue;
            }

321 322 323
            char tmp_fname_noext[strlen( psz_name ) + 1];
            char tmp_fname_trim[strlen( psz_name ) + 1];
            char tmp_fname_ext[strlen( psz_name ) + 1];
324
            char *tmp;
325

326
            int i_prio;
327

328 329 330 331
            /* 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 );
332

333 334 335 336 337 338 339 340 341 342 343 344
            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 ) )
345
                {
346 347
                    /* chars in front of the movie name */
                    i_prio = SUB_PRIORITY_MATCH_RIGHT;
348
                }
349
                else
350
                {
351 352 353
                    /* chars after (and possibly in front of)
                     * the movie name */
                    i_prio = SUB_PRIORITY_MATCH_LEFT;
354
                }
355 356 357 358 359 360 361
            }
            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;
            }
362
            if( i_prio >= i_fuzzy )
363
            {
364
                char psz_path[strlen( psz_dir ) + strlen( psz_name ) + 2];
365
                struct stat st;
366

367
                sprintf( psz_path, "%s"DIR_SEP"%s", psz_dir, psz_name );
368
                if( !strcmp( psz_path, psz_fname ) )
369 370
                {
                    free( psz_name );
371
                    continue;
372
                }
Laurent Aimar's avatar
Laurent Aimar committed
373

374
                if( !vlc_stat( psz_path, &st ) && S_ISREG( st.st_mode ) && result )
375
                {
376
                    msg_Dbg( p_this,
377 378 379 380 381 382 383 384 385 386 387
                            "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 );
388 389
                }
            }
390
            free( psz_name );
391
        }
392
        closedir( dir );
393
    }
394 395 396
    if( subdirs )
    {
        for( j = 0; subdirs[j]; j++ )
397
            free( subdirs[j] );
398 399 400 401 402
        free( subdirs );
    }
    free( f_dir );
    free( f_fname_trim );
    free( f_fname_noext );
403
    free( psz_fname );
404

405 406
    if( !result )
        return NULL;
407

408
    qsort( result, i_sub_count, sizeof(vlc_subfn_t), compare_sub_priority );
409

410
    result2 = calloc( i_sub_count + 1, sizeof(char*) );
411

412
    for( j = 0, i_result2 = 0; j < i_sub_count && result2 != NULL; j++ )
413
    {
414
        bool b_reject = false;
415 416 417 418 419

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

        if( !strcasecmp( result[j].psz_ext, "sub" ) )
420
        {
421 422
            int i;
            for( i = 0; i < i_sub_count; i++ )
423
            {
424
                if( result[i].psz_fname && result[i].psz_ext &&
425
                    !strncasecmp( result[j].psz_fname, result[i].psz_fname,
426
                                  strlen( result[j].psz_fname) - 3 ) &&
427
                    !strcasecmp( result[i].psz_ext, "idx" ) )
428 429
                    break;
            }
430
            if( i < i_sub_count )
431
                b_reject = true;
Laurent Aimar's avatar
Laurent Aimar committed
432
        }
433
        else if( !strcasecmp( result[j].psz_ext, "cdg" ) )
434
        {
435
            if( result[j].priority < SUB_PRIORITY_MATCH_ALL )
436
                b_reject = true;
437
        }
438 439 440 441

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

444 445
    for( j = 0; j < i_sub_count; j++ )
    {
446 447
        free( result[j].psz_fname );
        free( result[j].psz_ext );
448 449 450
    }
    free( result );

451 452
    return result2;
}
453