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
#ifdef HAVE_UNISTD_H
#   include <unistd.h>
#endif
46
#include <sys/stat.h>
47

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

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

56 57

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

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

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

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

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

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

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

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

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

154 155 156
/*
 * Check if a file ends with a subtitle extension
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
157
int subtitles_Filter( const char *psz_dir_content )
158
{
159 160 161
    const char *tmp = strrchr( psz_dir_content, '.');
    if( tmp == NULL )
        return 0;
162 163
    else
    {
164 165 166
        int i;
        tmp++;

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


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

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

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

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

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

242

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

266
    char **tmp_subdirs, **subdirs; /* list of subdirectories to look in */
267 268

    subfn *result = NULL; /* unsorted results */
269
    char **result2; /* sorted results */
270

271 272
    char *psz_fname_original = strdup( psz_name );
    char *psz_fname = psz_fname_original;
273

274 275
    if( psz_fname == NULL ) return NULL;

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

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

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

314 315 316
    i_fname_len = strlen( f_fname );
    f_fname_noext = malloc(i_fname_len + 1);
    f_fname_trim = malloc(i_fname_len + 1 );
317

318 319
    strcpy_strip_ext( f_fname_noext, f_fname );
    strcpy_trim( f_fname_trim, f_fname_noext );
320

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

325
    var_Get( p_this, "sub-autodetect-fuzzy", &fuzzy );
326

327 328
    tmp_subdirs = paths_to_list( f_dir, psz_path );
    subdirs = tmp_subdirs;
329

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

337
        if( psz_dir == NULL )
338 339
            continue;

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

        if( i_dir_content != -1 )
345
        {
346 347
            int a;

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

356
                int i_prio = 0;
357

358 359
                if( psz_name == NULL )
                    continue;
360

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

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

398
                    sprintf( psz_path, "%s%s", psz_dir, psz_name );
399 400 401
                    msg_Dbg( p_this,
                                "autodetected subtitle: %s with priority %d",
                                psz_path, i_prio );
402 403

                    if( utf8_stat( psz_path, &st ) && S_ISREG( st.st_mode ) )
404
                    {
405 406 407
                        msg_Dbg( p_this,
                                "autodetected subtitle: %s with priority %d",
                                psz_path, i_prio );
408
                        result[i_sub_count].priority = i_prio;
409
                        result[i_sub_count].psz_fname = strdup( psz_path );
410 411
                        result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
                        i_sub_count++;
412 413 414
                    }
                    else
                    {
415
                        msg_Dbg( p_this, "fopen failed" );
416
                    }
417 418 419
                }
                if( i_sub_count >= MAX_SUBTITLE_FILES ) break;
            }
420
            for( a = 0; a < i_dir_content; a++ )
421 422
                free( ppsz_dir_content[a] );
            if( ppsz_dir_content ) free( ppsz_dir_content );
423
        }
424
        if( j >= 0 ) if( *subdirs ) free( *subdirs++ );
425
    }
426

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

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

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

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

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