subtitles.c 13 KB
Newer Older
1 2 3
/*****************************************************************************
 * subtitles.c
 *****************************************************************************
4
 * Copyright (C) 2003-2004 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
#include <ctype.h>

45 46 47
/**
 * What's between a directory and a filename?
 */
48 49 50 51 52 53
#if defined( WIN32 )
    #define DIRECTORY_SEPARATOR '\\'
#else
    #define DIRECTORY_SEPARATOR '/'
#endif

54 55 56
/**
 * We are not going to autodetect more subtitle files than this.
 */
57 58
#define MAX_SUBTITLE_FILES 128

59 60 61 62

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

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

94 95 96
static void strcpy_strip_ext( char *d, char *s )
{
    char *tmp = strrchr(s, '.');
97 98
    if( !tmp )
    {
99 100
        strcpy(d, s);
        return;
101 102 103
    }
    else
    {
104 105
        strncpy(d, s, tmp - s);
        d[tmp - s] = 0;
106 107 108
    }
    while( *d )
    {
109 110
        *d = tolower(*d);
        d++;
111 112
    }
}
113

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

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

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

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

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

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

160 161 162 163
/* Utility function for scandir */  
static int Filter( const struct dirent *p_dir_content )
{
    int i;
164 165
    char *tmp = NULL;

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
    if( p_dir_content == NULL || p_dir_content->d_name == NULL ) return VLC_FALSE;
    /* does it end with a subtitle extension? */
    tmp = strrchr( p_dir_content->d_name, '.');
    if( !tmp )
    {
        return VLC_FALSE;
    }
    else
    {
        for( i = 0; sub_exts[i]; i++ )
        {
            if( strcmp( sub_exts[i], tmp+1 ) == 0 )
            {
                return VLC_TRUE;
            }
        }
    }
    return VLC_FALSE;
}


187
/**
188
 * Convert a list of paths separated by ',' to a char**
189
 */
190
static char **paths_to_list( char *psz_dir, char *psz_path )
191
{
192
    unsigned int i, k, i_nb_subdirs;
193
    char **subdirs; /* list of subdirectories to look in */
194 195 196 197

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

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

207
    if( i_nb_subdirs > 0 )
208
    {
209 210
        char *psz_parser = NULL, *psz_temp = NULL;

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

254

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

278 279 280 281 282 283
    char tmp_fname_noext[PATH_MAX];
    char tmp_fname_trim[PATH_MAX];
    char tmp_fname_ext[PATH_MAX];

    struct dirent **pp_dir_content;
    char **tmp_subdirs, **subdirs; /* list of subdirectories to look in */
284 285

    subfn *result = NULL; /* unsorted results */
286
    char **result2; /* sorted results */
287

288 289
    char *psz_fname_original = strdup( psz_name );
    char *psz_fname = psz_fname_original;
290

291 292
    if( psz_fname == NULL ) return NULL;

293 294 295 296
    if( !strncmp( psz_fname, "file://", 7 ) )
    {
        psz_fname += 7;
    }
297

298 299 300 301
    /* extract filename & dirname from psz_fname */
    tmp = strrchr( psz_fname, DIRECTORY_SEPARATOR );
    if( tmp )
    {
302 303
        int dirlen = 0;

304
        f_fname = malloc( strlen(tmp) );
305 306
        if( f_fname )
            strcpy( f_fname, tmp+1 ); // we skip the seperator, so it will still fit in the allocated space
307
        dirlen = strlen(psz_fname) - strlen(tmp) + 1; // add the seperator
308
        f_dir = malloc( dirlen + 1 );
309 310
        if( f_dir )
        {
311
            strncpy( f_dir, psz_fname, dirlen );
312 313
            f_dir[dirlen] = 0;
        }
314 315 316
    }
    else
    {
317 318 319 320
        /* FIXME: we should check the CWD here */
        /* f_fname = strdup( psz_fname ); */
        if( psz_fname_original ) free( psz_fname_original );
        return NULL;
321 322
    }

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

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

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

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

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

339
    for( j = -1; (j == -1) || ( (j >= 0) && (subdirs != NULL) && (*subdirs != NULL) );
340
         j++)
341
    {
342 343
        pp_dir_content = NULL;
        i_dir_content = 0;
344

345 346 347
        if( j < 0 && f_dir == NULL )
            continue;

348
        /* parse psz_src dir */  
349
        if( ( i_dir_content = scandir( j < 0 ? f_dir : *subdirs, &pp_dir_content, Filter,
350
                                NULL ) ) != -1 )
351
        {
352 353
            int a;

354
            msg_Dbg( p_this, "looking for a subtitle file in %s", j < 0 ? f_dir : *subdirs );
355
            for( a = 0; a < i_dir_content; a++ )
356
            {
357 358 359 360
                int i_prio = 0;
                struct dirent *p_dir_content = pp_dir_content[a];
                char *psz_inUTF8 = FromLocale( p_dir_content->d_name );
                char *p_fixed_name = vlc_fix_readdir_charset( p_this, psz_inUTF8 );
361

362 363
                LocaleFree( psz_inUTF8 );

364
                /* retrieve various parts of the filename */
365 366
                strcpy_strip_ext( tmp_fname_noext, p_fixed_name );
                strcpy_get_ext( tmp_fname_ext, p_fixed_name );
367
                strcpy_trim( tmp_fname_trim, tmp_fname_noext );
368

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

401 402 403
                    asprintf( &tmpresult, "%s%s", j < 0 ? f_dir : *subdirs, p_fixed_name );
                    msg_Dbg( p_this, "autodetected subtitle: %s with priority %d", p_fixed_name, i_prio );
                    if( ( f = fopen( tmpresult, "rt" ) ) )
404
                    {
405 406 407 408 409 410
                        fclose( f );
                        result[i_sub_count].priority = i_prio;
                        result[i_sub_count].psz_fname = tmpresult;
                        result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
                        i_sub_count++;
                    } else free( tmpresult );
411 412
                }
                if( i_sub_count >= MAX_SUBTITLE_FILES ) break;
413
                free( p_fixed_name );
414
            }
415 416 417
            for( a = 0; a < i_dir_content; a++ )
                if( pp_dir_content[a] ) free( pp_dir_content[a] );
            if( pp_dir_content ) free( pp_dir_content );
418
        }
419
        if( j >= 0 ) free( *subdirs++ );
420
    }
421

422 423 424 425 426 427
    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 );

428 429 430
    qsort( result, i_sub_count, sizeof( subfn ), compare_sub_priority );

    result2 = (char**)malloc( sizeof(char*) * ( i_sub_count + 1 ) );
431 432
    if( result2 )
        memset( result2, 0, sizeof(char*) * ( i_sub_count + 1 ) );
433
    i_result2 = 0;
434

435
    for( j = 0; j < i_sub_count; j++ )
436
    {
437
        if( result[j].psz_ext && !strcasecmp( result[j].psz_ext, "sub" ) )
438
        {
439 440
            int i;
            for( i = 0; i < i_sub_count; i++ )
441
            {
442 443 444
                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" ) )
445 446
                    break;
            }
447
            if( i >= i_sub_count )
448
            {
449
                result2[i_result2] = result[j].psz_fname;
450 451 452 453 454
                i_result2++;
            }
        }
        else
        {
455
            result2[i_result2] = result[j].psz_fname;
456 457
            i_result2++;
        }
458
    }
459

460 461
    if( psz_fname_original ) free( psz_fname_original );
    if( result ) free( result );
462 463
    return result2;
}