subtitles.c 11.9 KB
Newer Older
1
/*****************************************************************************
2
 * subtitles.c : subtitles detection
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
4
 * Copyright (C) 2003-2009 VLC authors and VideoLAN
5
 * $Id$
6 7 8 9
 *
 * Authors: Derk-Jan Hartman <hartman at videolan.org>
 * This is adapted code from the GPL'ed MPlayer (http://mplayerhq.hu)
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
10 11 12
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
13 14 15 16
 * (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
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
17 18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
19
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
20 21 22
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 24
 *****************************************************************************/

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

30 31 32 33
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

34
#include <ctype.h> /* isalnum() */
35
#include <unistd.h>
36
#include <sys/stat.h>
37

38 39 40
#include <vlc_common.h>
#include <vlc_fs.h>
#include <vlc_url.h>
41

42
#include "input_internal.h"
43

44 45 46
/**
 * We are not going to autodetect more subtitle files than this.
 */
47 48
#define MAX_SUBTITLE_FILES 128

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

63
static void strcpy_trim( char *d, const char *s )
64
{
65 66
    unsigned char c;

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

92
static void strcpy_strip_ext( char *d, const char *s )
93
{
94 95
    unsigned char c;

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
    while( (c = *d) != '\0' )
105
    {
106
        *d = tolower(c);
107
        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
    unsigned char c;

    while( (c = *s) != '\0' )
125
    {
126
        if( isalnum( c ) )
127
            return 0;
128
        s++;
129 130
    }
    return 1;
131 132
}

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

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

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

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

159
#ifdef HAVE_STRCOLL
160
    return strcoll( p0->psz_fname, p1->psz_fname);
161
#else
162
    return strcmp( p0->psz_fname, p1->psz_fname);
163
#endif
164 165
}

166 167 168
/*
 * Check if a file ends with a subtitle extension
 */
169
int subtitles_Filter( const char *psz_dir_content )
170
{
171
    const char *tmp = strrchr( psz_dir_content, '.');
172 173

    if( !tmp )
174
        return 0;
175
    tmp++;
176

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


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

193 194
    if( !psz_dir || !psz_path )
        return NULL;
195

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

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

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

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

226 227 228
    return subdirs;
}

229

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

254
    char **subdirs; /* list of subdirectories to look in */
255

256
    vlc_subfn_t *result = NULL; /* unsorted results */
257
    char **result2; /* sorted results */
258

259
    if( !psz_name_org )
260
        return NULL;
261

262
    char *psz_fname = vlc_uri2path( psz_name_org );
263 264
    if( !psz_fname )
        return NULL;
265

266
    /* extract filename & dirname from psz_fname */
267 268
    char *f_dir = strdup( psz_fname );
    if( f_dir == NULL )
269
    {
270 271
        free( psz_fname );
        return NULL;
272
    }
273

274
    const char *f_fname = strrchr( psz_fname, DIR_SEP_CHAR );
275
    if( !f_fname )
276
    {
277
        free( f_dir );
278
        free( psz_fname );
279
        return NULL;
280
    }
281 282
    f_fname++; /* Skip the '/' */
    f_dir[f_fname - psz_fname] = 0; /* keep dir separator in f_dir */
283

284
    i_fname_len = strlen( f_fname );
285

286 287
    f_fname_noext = malloc(i_fname_len + 1);
    f_fname_trim = malloc(i_fname_len + 1 );
288 289
    if( !f_fname_noext || !f_fname_trim )
    {
290 291 292
        free( f_dir );
        free( f_fname_noext );
        free( f_fname_trim );
293
        free( psz_fname );
294 295
        return NULL;
    }
296

297 298
    strcpy_strip_ext( f_fname_noext, f_fname );
    strcpy_trim( f_fname_trim, f_fname_noext );
299

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

308
        /* parse psz_src dir */
309 310
        DIR *dir = vlc_opendir( psz_dir );
        if( dir == NULL )
311
            continue;
312

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

315
        const char *psz_name;
316
        while( (psz_name = vlc_readdir( dir )) && i_sub_count < MAX_SUBTITLE_FILES )
317
        {
318 319 320
            if( psz_name[0] == '.' || !subtitles_Filter( 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 325
            const char *tmp;
            int i_prio = SUB_PRIORITY_NONE;
326

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

332
            if( !strcmp( tmp_fname_trim, f_fname_trim ) )
333 334 335 336
            {
                /* matches the movie name exactly */
                i_prio = SUB_PRIORITY_MATCH_ALL;
            }
337
            else if( (tmp = strstr( tmp_fname_trim, f_fname_trim )) )
338 339 340 341
            {
                /* contains the movie name */
                tmp += strlen( f_fname_trim );
                if( whiteonly( tmp ) )
342
                {
343 344
                    /* chars in front of the movie name */
                    i_prio = SUB_PRIORITY_MATCH_RIGHT;
345
                }
346
                else
347
                {
348 349 350
                    /* chars after (and possibly in front of)
                     * the movie name */
                    i_prio = SUB_PRIORITY_MATCH_LEFT;
351
                }
352
            }
353
            else if( j == -1 )
354 355 356 357
            {
                /* doesn't contain the movie name, prefer files in f_dir over subdirs */
                i_prio = SUB_PRIORITY_MATCH_NONE;
            }
358
            if( i_prio >= i_fuzzy )
359 360
            {
                struct stat st;
361
                char *path;
362

363
                if( asprintf( &path, "%s"DIR_SEP"%s", psz_dir, psz_name ) < 0 )
364
                    continue;
Laurent Aimar's avatar
Laurent Aimar committed
365

366 367 368
                if( strcmp( path, psz_fname )
                 && vlc_stat( path, &st ) == 0
                 && S_ISREG( st.st_mode ) && result )
369
                {
370
                    msg_Dbg( p_this,
371
                            "autodetected subtitle: %s with priority %d",
372
                            path, i_prio );
373
                    result[i_sub_count].priority = i_prio;
374 375
                    result[i_sub_count].psz_fname = path;
                    path = NULL;
376 377 378
                    result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
                    i_sub_count++;
                }
379
                free( path );
380
            }
381
        }
382
        closedir( dir );
383
    }
384 385 386
    if( subdirs )
    {
        for( j = 0; subdirs[j]; j++ )
387
            free( subdirs[j] );
388 389 390 391 392
        free( subdirs );
    }
    free( f_dir );
    free( f_fname_trim );
    free( f_fname_noext );
393
    free( psz_fname );
394

395 396
    if( !result )
        return NULL;
397

398
    qsort( result, i_sub_count, sizeof(vlc_subfn_t), compare_sub_priority );
399

400
    result2 = calloc( i_sub_count + 1, sizeof(char*) );
401

402
    for( j = 0, i_result2 = 0; j < i_sub_count && result2 != NULL; j++ )
403
    {
404
        bool b_reject = false;
405 406 407 408 409

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

        if( !strcasecmp( result[j].psz_ext, "sub" ) )
410
        {
411 412
            int i;
            for( i = 0; i < i_sub_count; i++ )
413
            {
414
                if( result[i].psz_fname && result[i].psz_ext &&
415
                    !strncasecmp( result[j].psz_fname, result[i].psz_fname,
416
                                  strlen( result[j].psz_fname) - 3 ) &&
417
                    !strcasecmp( result[i].psz_ext, "idx" ) )
418 419
                    break;
            }
420
            if( i < i_sub_count )
421
                b_reject = true;
Laurent Aimar's avatar
Laurent Aimar committed
422
        }
423
        else if( !strcasecmp( result[j].psz_ext, "cdg" ) )
424
        {
425
            if( result[j].priority < SUB_PRIORITY_MATCH_ALL )
426
                b_reject = true;
427
        }
428 429 430 431

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

434 435
    for( j = 0; j < i_sub_count; j++ )
    {
436 437
        free( result[j].psz_fname );
        free( result[j].psz_ext );
438 439 440
    }
    free( result );

441 442
    return result2;
}
443