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
#include <vlc/vlc.h>
Clément Stenac's avatar
Clément Stenac committed
31 32
#include <vlc_input.h>
#include <vlc_charset.h>
33

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

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

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

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

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

55 56

/**
57
 * The possible extensions for subtitle files we support
58
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
59 60 61
static const char const sub_exts[][6] = {
    "utf", "utf8", "utf-8",
    "sub", "srt", "smi",
Laurent Aimar's avatar
Laurent Aimar committed
62 63 64 65 66
    "txt", "ssa", "idx",

    "cdg",

    ""
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
67 68
};

69 70
/* extensions from unsupported types */
/* rt, aqt, jss, js, ass */
71

72 73 74 75 76
static void strcpy_trim( char *d, char *s )
{
    /* 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 100 101
static void strcpy_strip_ext( char *d, char *s )
{
    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 117 118 119 120
static void strcpy_get_ext( char *d, char *s )
{
    char *tmp = strrchr(s, '.');
    if( !tmp )
    {
121 122
        strcpy(d, "");
        return;
123 124 125 126 127 128 129
    } else strcpy( d, tmp + 1 );
}

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

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

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

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

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

162 163 164
/*
 * Check if a file ends with a subtitle extension
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
165
int subtitles_Filter( const char *psz_dir_content )
166
{
167 168 169
    const char *tmp = strrchr( psz_dir_content, '.');
    if( tmp == NULL )
        return 0;
170 171
    else
    {
172 173 174
        int i;
        tmp++;

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
175
        for( i = 0; sub_exts[i][0]; i++ )
176
            if( strcasecmp( sub_exts[i], tmp ) == 0 )
177
                return 1;
178
    }
179
    return 0;
180 181 182
}


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

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

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

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

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

250

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

274
    char **tmp_subdirs, **subdirs; /* list of subdirectories to look in */
275 276

    subfn *result = NULL; /* unsorted results */
277
    char **result2; /* sorted results */
278

279 280
    char *psz_fname_original = strdup( psz_name );
    char *psz_fname = psz_fname_original;
281

282 283
    if( psz_fname == NULL ) return NULL;

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

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

295
        f_fname = malloc( strlen(tmp) );
296
        if( f_fname )
297 298
            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
299
        f_dir = malloc( dirlen + 1 );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
300 301
        if( f_dir != NULL )
            strlcpy( f_dir, psz_fname, dirlen );
302 303 304
    }
    else
    {
305
        /* Get the current working directory */
306
        int dirlen;
307 308 309 310 311 312 313 314
#ifdef HAVE_UNISTD_H
        f_dir = getcwd( NULL, 0 );
#endif
        if( f_dir == NULL )
        {
            if( psz_fname_original ) free( psz_fname_original );
            return NULL;
        }
315 316
        dirlen = strlen( f_dir );
        f_dir = (char *)realloc(f_dir, dirlen +2 );
317
        f_dir[dirlen] = DIR_SEP_CHAR;
318
        f_dir[dirlen+1] = '\0';
319
        f_fname = strdup( psz_fname );
320 321
    }

322 323 324
    i_fname_len = strlen( f_fname );
    f_fname_noext = malloc(i_fname_len + 1);
    f_fname_trim = malloc(i_fname_len + 1 );
325

326 327
    strcpy_strip_ext( f_fname_noext, f_fname );
    strcpy_trim( f_fname_trim, f_fname_noext );
328

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

333
    var_Get( p_this, "sub-autodetect-fuzzy", &fuzzy );
334

335 336
    tmp_subdirs = paths_to_list( f_dir, psz_path );
    subdirs = tmp_subdirs;
337

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

345
        if( psz_dir == NULL )
346 347
            continue;

348
        /* parse psz_src dir */
349 350
        i_dir_content = utf8_scandir( psz_dir, &ppsz_dir_content,
                                      subtitles_Filter, NULL );
351 352

        if( i_dir_content != -1 )
353
        {
354 355
            int a;

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

364
                int i_prio = 0;
365

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

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

374
                if( !i_prio && !strcmp( tmp_fname_trim, f_fname_trim ) )
375
                {
376 377
                    /* matches the movie name exactly */
                    i_prio = 4;
378
                }
379 380
                if( !i_prio &&
                    ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
381
                {
382 383 384
                    /* contains the movie name */
                    tmp += strlen( f_fname_trim );
                    if( whiteonly( tmp ) )
385
                    {
386 387
                        /* chars in front of the movie name */
                        i_prio = 2;
388
                    }
389
                    else
390
                    {
391 392 393
                        /* chars after (and possibly in front of)
                         * the movie name */
                        i_prio = 3;
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 )
                {
403
                    char psz_path[strlen( psz_dir ) + strlen( psz_name ) + 1];
404
                    struct stat st;
405

406
                    sprintf( psz_path, "%s%s", psz_dir, psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
407 408 409
                    if( !strcmp( psz_path, psz_fname ) )
                        continue;

410 411 412
                    msg_Dbg( p_this,
                                "autodetected subtitle: %s with priority %d",
                                psz_path, i_prio );
413

414
                    if( !utf8_stat( psz_path, &st ) && S_ISREG( st.st_mode ) )
415
                    {
416 417 418
                        msg_Dbg( p_this,
                                "autodetected subtitle: %s with priority %d",
                                psz_path, i_prio );
419
                        result[i_sub_count].priority = i_prio;
420
                        result[i_sub_count].psz_fname = strdup( psz_path );
421 422
                        result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
                        i_sub_count++;
423 424 425
                    }
                    else
                    {
426
                        msg_Dbg( p_this, "stat failed" );
427
                    }
428 429 430
                }
                if( i_sub_count >= MAX_SUBTITLE_FILES ) break;
            }
431
            for( a = 0; a < i_dir_content; a++ )
432 433
                free( ppsz_dir_content[a] );
            if( ppsz_dir_content ) free( ppsz_dir_content );
434
        }
435
        if( j >= 0 ) if( *subdirs ) free( *subdirs++ );
436
    }
437

438 439 440 441 442 443
    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 );

444 445 446
    qsort( result, i_sub_count, sizeof( subfn ), compare_sub_priority );

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

451
    for( j = 0; j < i_sub_count; j++ )
452
    {
453
        if( result[j].psz_ext && !strcasecmp( result[j].psz_ext, "sub" ) )
454
        {
455 456
            int i;
            for( i = 0; i < i_sub_count; i++ )
457
            {
458
                if( result[i].psz_fname && result[j].psz_fname &&
459 460
                    !strncasecmp( result[j].psz_fname, result[i].psz_fname,
                                sizeof( result[j].psz_fname) - 4 ) &&
461
                    !strcasecmp( result[i].psz_ext, "idx" ) )
462 463
                    break;
            }
464
            if( i >= i_sub_count )
465
            {
466
                result2[i_result2] = result[j].psz_fname;
467 468 469
                i_result2++;
            }
        }
Laurent Aimar's avatar
Laurent Aimar committed
470 471 472 473 474 475 476 477
        else if( result[j].psz_ext && !strcasecmp( result[j].psz_ext, "cdg" ) )
        {
            if( result[j].priority == 4 )
            {
                result2[i_result2] = result[j].psz_fname;
                i_result2++;
            }
        }
478 479
        else
        {
480
            result2[i_result2] = result[j].psz_fname;
481 482
            i_result2++;
        }
483
    }
484

485 486
    if( psz_fname_original ) free( psz_fname_original );
    if( result ) free( result );
487 488
    return result2;
}