subtitles.c 13.5 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 41 42
#ifdef HAVE_LIMITS_H  
#   include <limits.h>  
#endif

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

47 48
#include <ctype.h>

49 50 51
/**
 * What's between a directory and a filename?
 */
52 53 54 55 56 57
#if defined( WIN32 )
    #define DIRECTORY_SEPARATOR '\\'
#else
    #define DIRECTORY_SEPARATOR '/'
#endif

58 59 60
/**
 * We are not going to autodetect more subtitle files than this.
 */
61 62
#define MAX_SUBTITLE_FILES 128

63 64 65 66

/**
 * The possible extentions for subtitle files we support
 */
67
static const char * sub_exts[] = {  "utf", "utf8", "utf-8", "sub", "srt", "smi", "txt", "ssa", "idx", NULL};
68 69
/* extensions from unsupported types */
/* rt, aqt, jss, js, ass */
70

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

118 119 120 121 122
static void strcpy_get_ext( char *d, char *s )
{
    char *tmp = strrchr(s, '.');
    if( !tmp )
    {
123 124
        strcpy(d, "");
        return;
125 126 127 128 129 130 131
    } else strcpy( d, tmp + 1 );
}

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

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

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

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

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

164
/* Utility function for scandir */  
165
static int Filter( const char *psz_dir_content )
166 167
{
    /* does it end with a subtitle extension? */
168 169 170
    const char *tmp = strrchr( psz_dir_content, '.');
    if( tmp == NULL )
        return 0;
171 172
    else
    {
173 174 175
        int i;
        tmp++;

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


184
/**
185
 * Convert a list of paths separated by ',' to a char**
186
 */
187
static char **paths_to_list( 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 192 193 194

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

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

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

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

251

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

275 276 277 278 279
    char tmp_fname_noext[PATH_MAX];
    char tmp_fname_trim[PATH_MAX];
    char tmp_fname_ext[PATH_MAX];

    char **tmp_subdirs, **subdirs; /* list of subdirectories to look in */
280 281

    subfn *result = NULL; /* unsorted results */
282
    char **result2; /* sorted results */
283

284 285
    char *psz_fname_original = strdup( psz_name );
    char *psz_fname = psz_fname_original;
286

287 288
    if( psz_fname == NULL ) return NULL;

289 290 291 292
    if( !strncmp( psz_fname, "file://", 7 ) )
    {
        psz_fname += 7;
    }
293

294 295 296 297
    /* extract filename & dirname from psz_fname */
    tmp = strrchr( psz_fname, DIRECTORY_SEPARATOR );
    if( tmp )
    {
298 299
        int dirlen = 0;

300
        f_fname = malloc( strlen(tmp) );
301 302
        if( f_fname )
            strcpy( f_fname, tmp+1 ); // we skip the seperator, so it will still fit in the allocated space
303
        dirlen = strlen(psz_fname) - strlen(tmp) + 1; // add the seperator
304
        f_dir = malloc( dirlen + 1 );
305 306
        if( f_dir )
        {
307
            strncpy( f_dir, psz_fname, dirlen );
308 309
            f_dir[dirlen] = 0;
        }
310 311 312
    }
    else
    {
313
        /* Get the current working directory */
314
        int dirlen;
315 316 317 318 319 320 321 322
#ifdef HAVE_UNISTD_H
        f_dir = getcwd( NULL, 0 );
#endif
        if( f_dir == NULL )
        {
            if( psz_fname_original ) free( psz_fname_original );
            return NULL;
        }
323 324 325 326
        dirlen = strlen( f_dir );
        f_dir = (char *)realloc(f_dir, dirlen +2 );
        f_dir[dirlen] = DIRECTORY_SEPARATOR;
        f_dir[dirlen+1] = '\0';
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
327
        f_fname = FromLocaleDup( psz_fname );
328 329
    }

330 331 332
    i_fname_len = strlen( f_fname );
    f_fname_noext = malloc(i_fname_len + 1);
    f_fname_trim = malloc(i_fname_len + 1 );
333

334 335
    strcpy_strip_ext( f_fname_noext, f_fname );
    strcpy_trim( f_fname_trim, f_fname_noext );
336

337
    result = (subfn*)malloc( sizeof(subfn) * MAX_SUBTITLE_FILES );
338 339 340
    if( result )
        memset( result, 0, sizeof(subfn) * MAX_SUBTITLE_FILES );

341
    var_Get( p_this, "sub-autodetect-fuzzy", &fuzzy );
342

343 344
    tmp_subdirs = paths_to_list( f_dir, psz_path );
    subdirs = tmp_subdirs;
345

346
    for( j = -1; (j == -1) || ( (j >= 0) && (subdirs != NULL) && (*subdirs != NULL) );
347
         j++)
348
    {
349 350 351
        const char *psz_dir = j < 0 ? f_dir : *subdirs;
        char **ppsz_dir_content;
        int i_dir_content;
352

353
        if( psz_dir == NULL )
354 355
            continue;

356
        /* parse psz_src dir */
357 358
        i_dir_content = utf8_scandir( psz_dir, &ppsz_dir_content, Filter,
                                      NULL );
359 360

        if( i_dir_content != -1 )
361
        {
362 363
            int a;

364
            msg_Dbg( p_this, "looking for a subtitle file in %s", psz_dir );
365
            for( a = 0; a < i_dir_content; a++ )
366
            {
367
                char *psz_name = vlc_fix_readdir_charset( p_this, ppsz_dir_content[a] );
368
                int i_prio = 0;
369

370 371
                if( psz_name == NULL )
                    continue;
372

373
                /* retrieve various parts of the filename */
374 375
                strcpy_strip_ext( tmp_fname_noext, psz_name );
                strcpy_get_ext( tmp_fname_ext, psz_name );
376
                strcpy_trim( tmp_fname_trim, tmp_fname_noext );
377

378
                if( !i_prio && !strcmp( tmp_fname_trim, f_fname_trim ) )
379
                {
380 381
                    /* matches the movie name exactly */
                    i_prio = 4;
382
                }
383 384
                if( !i_prio &&
                    ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
385
                {
386 387 388
                    /* contains the movie name */
                    tmp += strlen( f_fname_trim );
                    if( whiteonly( tmp ) )
389
                    {
390 391
                        /* chars in front of the movie name */
                        i_prio = 2;
392
                    }
393
                    else
394
                    {
395 396 397
                        /* chars after (and possibly in front of)
                         * the movie name */
                        i_prio = 3;
398
                    }
399 400 401 402 403 404 405 406 407
                }
                if( !i_prio )
                {
                    /* doesn't contain the movie name */
                    if( j == 0 ) i_prio = 1;
                }
                if( i_prio >= fuzzy.i_int )
                {
                    FILE *f;
408
                    char psz_path[strlen( psz_dir ) + strlen( psz_name ) + 1];
409

410 411
                    sprintf( psz_path, "%s%s", psz_dir, psz_name );
                    msg_Dbg( p_this, "autodetected subtitle: %s with priority %d", psz_path, i_prio );
412
                    /* FIXME: a portable wrapper for stat() or access() would be more suited */
413
                    if( ( f = utf8_fopen( psz_path, "rt" ) ) )
414
                    {
415
                        fclose( f );
416
                        msg_Dbg( p_this, "autodetected subtitle: %s with priority %d", psz_path, i_prio );
417
                        result[i_sub_count].priority = i_prio;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
418
                        result[i_sub_count].psz_fname = psz_path;
419 420
                        result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
                        i_sub_count++;
421 422 423
                    }
                    else
                    {
424
                        msg_Dbg( p_this, "fopen failed" );
425
                        free( psz_path );
426
                    }
427 428
                }
                if( i_sub_count >= MAX_SUBTITLE_FILES ) break;
429
                free( psz_name );
430
            }
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 459 460
                if( result[i].psz_fname && result[j].psz_fname &&
                    !strncasecmp( result[j].psz_fname, result[i].psz_fname, sizeof( result[j].psz_fname) - 4 ) && 
                    !strcasecmp( result[i].psz_ext, "idx" ) )
461 462
                    break;
            }
463
            if( i >= i_sub_count )
464
            {
465
                result2[i_result2] = result[j].psz_fname;
466 467 468 469 470
                i_result2++;
            }
        }
        else
        {
471
            result2[i_result2] = result[j].psz_fname;
472 473
            i_result2++;
        }
474
    }
475

476 477
    if( psz_fname_original ) free( psz_fname_original );
    if( result ) free( result );
478 479
    return result2;
}