subtitles.c 13.3 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
#include <stdlib.h>
#include <vlc/vlc.h>
#include <vlc/input.h>
33
#include "charset.h"
34

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

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

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

47 48
#include <ctype.h>

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

54 55

/**
56
 * The possible extensions for subtitle files we support
57
 */
58
static const char * sub_exts[] = {  "utf", "utf8", "utf-8", "sub", "srt", "smi", "txt", "ssa", "idx", NULL };
59 60
/* extensions from unsupported types */
/* rt, aqt, jss, js, ass */
61

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

89 90 91
static void strcpy_strip_ext( char *d, char *s )
{
    char *tmp = strrchr(s, '.');
92 93
    if( !tmp )
    {
94 95
        strcpy(d, s);
        return;
96 97
    }
    else
98
        strlcpy(d, s, tmp - s + 1 );
99 100
    while( *d )
    {
101 102
        *d = tolower(*d);
        d++;
103 104
    }
}
105

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

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

126
typedef struct _subfn
127 128 129
{
    int priority;
    char *psz_fname;
130
    char *psz_ext;
131 132 133 134
} subfn;

static int compare_sub_priority( const void *a, const void *b )
{
135 136 137
    if (((subfn*)a)->priority > ((subfn*)b)->priority)
    {
        return -1;
138
    }
139 140 141 142 143 144

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

145
#ifndef UNDER_CE
146
    return strcoll(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
147 148 149
#else
    return strcmp(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
#endif
150 151
}

152 153 154
/*
 * Check if a file ends with a subtitle extension
 */
155
static int subtitles_Filter( const char *psz_dir_content )
156
{
157 158 159
    const char *tmp = strrchr( psz_dir_content, '.');
    if( tmp == NULL )
        return 0;
160 161
    else
    {
162 163 164
        int i;
        tmp++;

165
        for( i = 0; sub_exts[i]; i++ )
166 167
            if( strcmp( sub_exts[i], tmp ) == 0 )
                return 1;
168
    }
169
    return 0;
170 171 172
}


173
/**
174
 * Convert a list of paths separated by ',' to a char**
175
 */
176
static char **paths_to_list( char *psz_dir, char *psz_path )
177
{
178
    unsigned int i, k, i_nb_subdirs;
179
    char **subdirs; /* list of subdirectories to look in */
180 181 182 183

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

184 185 186
    i_nb_subdirs = 1;
    for( k = 0; k < strlen( psz_path ); k++ )
    {
187
        if( psz_path[k] == ',' )
188 189 190 191
        {
            i_nb_subdirs++;
        }
    }
192

193
    if( i_nb_subdirs > 0 )
194
    {
195 196
        char *psz_parser = NULL, *psz_temp = NULL;

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

240

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

264
    char **tmp_subdirs, **subdirs; /* list of subdirectories to look in */
265 266

    subfn *result = NULL; /* unsorted results */
267
    char **result2; /* sorted results */
268

269 270
    char *psz_fname_original = strdup( psz_name );
    char *psz_fname = psz_fname_original;
271

272 273
    if( psz_fname == NULL ) return NULL;

274 275 276 277
    if( !strncmp( psz_fname, "file://", 7 ) )
    {
        psz_fname += 7;
    }
278

279
    /* extract filename & dirname from psz_fname */
280
    tmp = strrchr( psz_fname, DIR_SEP_CHAR );
281 282
    if( tmp )
    {
283 284
        int dirlen = 0;

285
        f_fname = malloc( strlen(tmp) );
286
        if( f_fname )
287 288
            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
289
        f_dir = malloc( dirlen + 1 );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
290 291
        if( f_dir != NULL )
            strlcpy( f_dir, psz_fname, dirlen );
292 293 294
    }
    else
    {
295
        /* Get the current working directory */
296
        int dirlen;
297 298 299 300 301 302 303 304
#ifdef HAVE_UNISTD_H
        f_dir = getcwd( NULL, 0 );
#endif
        if( f_dir == NULL )
        {
            if( psz_fname_original ) free( psz_fname_original );
            return NULL;
        }
305 306
        dirlen = strlen( f_dir );
        f_dir = (char *)realloc(f_dir, dirlen +2 );
307
        f_dir[dirlen] = DIR_SEP_CHAR;
308
        f_dir[dirlen+1] = '\0';
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
309
        f_fname = FromLocaleDup( psz_fname );
310 311
    }

312 313 314
    i_fname_len = strlen( f_fname );
    f_fname_noext = malloc(i_fname_len + 1);
    f_fname_trim = malloc(i_fname_len + 1 );
315

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

319
    result = (subfn*)malloc( sizeof(subfn) * MAX_SUBTITLE_FILES );
320 321 322
    if( result )
        memset( result, 0, sizeof(subfn) * MAX_SUBTITLE_FILES );

323
    var_Get( p_this, "sub-autodetect-fuzzy", &fuzzy );
324

325 326
    tmp_subdirs = paths_to_list( f_dir, psz_path );
    subdirs = tmp_subdirs;
327

328 329
    for( j = -1; (j == -1) || ( (j >= 0) && (subdirs != NULL) &&
        (*subdirs != NULL) ); j++)
330
    {
331 332 333
        const char *psz_dir = j < 0 ? f_dir : *subdirs;
        char **ppsz_dir_content;
        int i_dir_content;
334

335
        if( psz_dir == NULL )
336 337
            continue;

338
        /* parse psz_src dir */
339 340
        i_dir_content = utf8_scandir( psz_dir, &ppsz_dir_content,
                                      subtitles_Filter, NULL );
341 342

        if( i_dir_content != -1 )
343
        {
344 345
            int a;

346
            msg_Dbg( p_this, "looking for a subtitle file in %s", psz_dir );
347
            for( a = 0; a < i_dir_content; a++ )
348
            {
349
                char *psz_name = ppsz_dir_content[a];
350 351 352 353
                char tmp_fname_noext[strlen( psz_name ) + 1];
                char tmp_fname_trim[strlen( psz_name ) + 1];
                char tmp_fname_ext[strlen( psz_name ) + 1];

354
                int i_prio = 0;
355

356 357
                if( psz_name == NULL )
                    continue;
358

359
                /* retrieve various parts of the filename */
360 361
                strcpy_strip_ext( tmp_fname_noext, psz_name );
                strcpy_get_ext( tmp_fname_ext, psz_name );
362
                strcpy_trim( tmp_fname_trim, tmp_fname_noext );
363

364
                if( !i_prio && !strcmp( tmp_fname_trim, f_fname_trim ) )
365
                {
366 367
                    /* matches the movie name exactly */
                    i_prio = 4;
368
                }
369 370
                if( !i_prio &&
                    ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
371
                {
372 373 374
                    /* contains the movie name */
                    tmp += strlen( f_fname_trim );
                    if( whiteonly( tmp ) )
375
                    {
376 377
                        /* chars in front of the movie name */
                        i_prio = 2;
378
                    }
379
                    else
380
                    {
381 382 383
                        /* chars after (and possibly in front of)
                         * the movie name */
                        i_prio = 3;
384
                    }
385 386 387 388 389 390 391 392 393
                }
                if( !i_prio )
                {
                    /* doesn't contain the movie name */
                    if( j == 0 ) i_prio = 1;
                }
                if( i_prio >= fuzzy.i_int )
                {
                    FILE *f;
394
                    char psz_path[strlen( psz_dir ) + strlen( psz_name ) + 1];
395

396
                    sprintf( psz_path, "%s%s", psz_dir, psz_name );
397 398 399
                    msg_Dbg( p_this,
                                "autodetected subtitle: %s with priority %d",
                                psz_path, i_prio );
400
                    /* FIXME: a portable wrapper for stat() or access() would be more suited */
401
                    if( ( f = utf8_fopen( psz_path, "rt" ) ) )
402
                    {
403
                        fclose( f );
404 405 406
                        msg_Dbg( p_this,
                                "autodetected subtitle: %s with priority %d",
                                psz_path, i_prio );
407
                        result[i_sub_count].priority = i_prio;
408
                        result[i_sub_count].psz_fname = strdup( psz_path );
409 410
                        result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
                        i_sub_count++;
411 412 413
                    }
                    else
                    {
414
                        msg_Dbg( p_this, "fopen failed" );
415
                    }
416 417 418
                }
                if( i_sub_count >= MAX_SUBTITLE_FILES ) break;
            }
419
            for( a = 0; a < i_dir_content; a++ )
420 421
                free( ppsz_dir_content[a] );
            if( ppsz_dir_content ) free( ppsz_dir_content );
422
        }
423
        if( j >= 0 ) if( *subdirs ) free( *subdirs++ );
424
    }
425

426 427 428 429 430 431
    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 );

432 433 434
    qsort( result, i_sub_count, sizeof( subfn ), compare_sub_priority );

    result2 = (char**)malloc( sizeof(char*) * ( i_sub_count + 1 ) );
435 436
    if( result2 )
        memset( result2, 0, sizeof(char*) * ( i_sub_count + 1 ) );
437
    i_result2 = 0;
438

439
    for( j = 0; j < i_sub_count; j++ )
440
    {
441
        if( result[j].psz_ext && !strcasecmp( result[j].psz_ext, "sub" ) )
442
        {
443 444
            int i;
            for( i = 0; i < i_sub_count; i++ )
445
            {
446
                if( result[i].psz_fname && result[j].psz_fname &&
447 448
                    !strncasecmp( result[j].psz_fname, result[i].psz_fname,
                                sizeof( result[j].psz_fname) - 4 ) &&
449
                    !strcasecmp( result[i].psz_ext, "idx" ) )
450 451
                    break;
            }
452
            if( i >= i_sub_count )
453
            {
454
                result2[i_result2] = result[j].psz_fname;
455 456 457 458 459
                i_result2++;
            }
        }
        else
        {
460
            result2[i_result2] = result[j].psz_fname;
461 462
            i_result2++;
        }
463
    }
464

465 466
    if( psz_fname_original ) free( psz_fname_original );
    if( result ) free( result );
467 468
    return result2;
}