9d0a0bcc071fa34469ce07ef5784a42c51d9af4e
[vlc.git] / src / input / subtitles.c
1 /*****************************************************************************
2  * subtitles.c
3  *****************************************************************************
4  * Copyright (C) 2003-2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Derk-Jan Hartman <hartman at videolan.org>
8  * This is adapted code from the GPL'ed MPlayer (http://mplayerhq.hu)
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /**
26  *  \file
27  *  This file contains functions to dectect subtitle files.
28  */
29
30 #ifdef HAVE_CONFIG_H
31 # include "config.h"
32 #endif
33
34 #include <vlc/vlc.h>
35 #include <vlc_input.h>
36 #include <vlc_charset.h>
37
38 #ifdef HAVE_DIRENT_H
39 #   include <dirent.h>
40 #endif
41
42 #ifdef HAVE_LIMITS_H
43 #   include <limits.h>
44 #endif
45
46 #ifdef HAVE_UNISTD_H
47 #   include <unistd.h>
48 #endif
49 #include <sys/stat.h>
50
51 #include <ctype.h>
52 #include "input_internal.h"
53
54 /**
55  * We are not going to autodetect more subtitle files than this.
56  */
57 #define MAX_SUBTITLE_FILES 128
58
59
60 /**
61  * The possible extensions for subtitle files we support
62  */
63 static const char const sub_exts[][6] = {
64     "utf", "utf8", "utf-8",
65     "sub", "srt", "smi",
66     "txt", "ssa", "idx",
67
68     "cdg",
69
70     ""
71 };
72
73 /* extensions from unsupported types */
74 /* rt, aqt, jss, js, ass */
75
76 static void strcpy_trim( char *d, const char *s )
77 {
78     /* skip leading whitespace */
79     while( *s && !isalnum(*s) )
80     {
81         s++;
82     }
83     for(;;)
84     {
85         /* copy word */
86         while( *s && isalnum(*s) )
87         {
88             *d = tolower(*s);
89             s++; d++;
90         }
91         if( *s == 0 ) break;
92         /* trim excess whitespace */
93         while( *s && !isalnum(*s) )
94         {
95             s++;
96         }
97         if( *s == 0 ) break;
98         *d++ = ' ';
99     }
100     *d = 0;
101 }
102
103 static void strcpy_strip_ext( char *d, const char *s )
104 {
105     const char *tmp = strrchr(s, '.');
106     if( !tmp )
107     {
108         strcpy(d, s);
109         return;
110     }
111     else
112         strlcpy(d, s, tmp - s + 1 );
113     while( *d )
114     {
115         *d = tolower(*d);
116         d++;
117     }
118 }
119
120 static void strcpy_get_ext( char *d, const char *s )
121 {
122     const char *tmp = strrchr(s, '.');
123     if( !tmp )
124         strcpy(d, "");
125     else
126         strcpy( d, tmp + 1 );
127 }
128
129 static int whiteonly( const char *s )
130 {
131     while( *s )
132     {
133         if( isalnum( *s ) )
134             return 0;
135         s++;
136     }
137     return 1;
138 }
139
140 enum
141 {
142     SUB_PRIORITY_NONE = 0,
143     SUB_PRIORITY_MATCH_NONE = 1,
144     SUB_PRIORITY_MATCH_RIGHT = 2,
145     SUB_PRIORITY_MATCH_LEFT = 3,
146     SUB_PRIORITY_MATCH_ALL = 4,
147 };
148 typedef struct
149 {
150     int priority;
151     char *psz_fname;
152     char *psz_ext;
153 } vlc_subfn_t;
154
155 static int compare_sub_priority( const void *a, const void *b )
156 {
157     const vlc_subfn_t *p0 = a;
158     const vlc_subfn_t *p1 = b;
159
160     if( p0->priority > p1->priority )
161         return -1;
162
163     if( p0->priority < p1->priority )
164         return 1;
165
166 #ifndef UNDER_CE
167     return strcoll( p0->psz_fname, p1->psz_fname);
168 #else
169     return strcmp( p0->psz_fname, p1->psz_fname);
170 #endif
171 }
172
173 /*
174  * Check if a file ends with a subtitle extension
175  */
176 int subtitles_Filter( const char *psz_dir_content )
177 {
178     const char *tmp = strrchr( psz_dir_content, '.');
179     int i;
180
181     if( !tmp )
182         return 0;
183     tmp++;
184
185     for( i = 0; sub_exts[i][0]; i++ )
186         if( strcasecmp( sub_exts[i], tmp ) == 0 )
187             return 1;
188     return 0;
189 }
190
191
192 /**
193  * Convert a list of paths separated by ',' to a char**
194  */
195 static char **paths_to_list( const char *psz_dir, char *psz_path )
196 {
197     unsigned int i, k, i_nb_subdirs;
198     char **subdirs; /* list of subdirectories to look in */
199     char *psz_parser = psz_path;
200
201     if( !psz_dir || !psz_path )
202         return NULL;
203
204     for( k = 0, i_nb_subdirs = 1; psz_path[k] != '\0'; k++ )
205     {
206         if( psz_path[k] == ',' )
207             i_nb_subdirs++;
208     }
209
210     subdirs = calloc( i_nb_subdirs + 1, sizeof(char*) );
211     if( !subdirs )
212         return NULL;
213
214     for( i = 0; psz_parser && *psz_parser != '\0' ; )
215     {
216         char *psz_subdir = psz_parser;
217         psz_parser = strchr( psz_subdir, ',' );
218         if( psz_parser )
219         {
220             *psz_parser++ = '\0';
221             while( *psz_parser == ' ' )
222                 psz_parser++;
223         }
224         if( *psz_subdir == '\0' )
225             continue;
226
227         asprintf( &subdirs[i++], "%s%s%c",
228                   psz_subdir[0] == '.' ? psz_dir : "",
229                   psz_subdir,
230                   psz_subdir[strlen(psz_subdir) - 1] == DIR_SEP_CHAR ? '\0' : DIR_SEP_CHAR );
231     }
232     subdirs[i] = NULL;
233
234     return subdirs;
235 }
236
237
238 /**
239  * Detect subtitle files.
240  *
241  * When called this function will split up the psz_name string into a
242  * directory, filename and extension. It then opens the directory
243  * in which the file resides and tries to find possible matches of
244  * subtitles files.
245  *
246  * \ingroup Demux
247  * \param p_this the calling \ref input_thread_t
248  * \param psz_path a list of subdirectories (separated by a ',') to look in.
249  * \param psz_name the complete filename to base the search on.
250  * \return a NULL terminated array of filenames with detected possible subtitles.
251  * The array contains max MAX_SUBTITLE_FILES items and you need to free it after use.
252  */
253 char **subtitles_Detect( input_thread_t *p_this, char *psz_path,
254                          const char *psz_name_org )
255 {
256     vlc_value_t fuzzy;
257     int j, i_result2, i_sub_count, i_fname_len;
258     char *f_dir = NULL, *f_fname = NULL, *f_fname_noext = NULL, *f_fname_trim = NULL;
259     char *tmp = NULL;
260
261     char **subdirs; /* list of subdirectories to look in */
262
263     vlc_subfn_t *result = NULL; /* unsorted results */
264     char **result2; /* sorted results */
265     const char *psz_fname = psz_name_org;
266
267     if( !psz_fname )
268         return NULL;
269
270     if( !strncmp( psz_fname, "file://", 7 ) )
271         psz_fname += 7;
272
273     /* extract filename & dirname from psz_fname */
274     tmp = strrchr( psz_fname, DIR_SEP_CHAR );
275     if( tmp )
276     {
277         const int i_dirlen = strlen(psz_fname)-strlen(tmp)+1; /* include the separator */
278         f_fname = strdup( &tmp[1] );    /* skip the separator */
279         f_dir = strndup( psz_fname, i_dirlen );
280     }
281     else
282     {
283 #ifdef HAVE_UNISTD_H
284         /* Get the current working directory */
285         char *psz_cwd = getcwd( NULL, 0 );
286 #else
287         char *psz_cwd = NULL;
288 #endif
289         if( !psz_cwd )
290             return NULL;
291
292         f_fname = strdup( psz_fname );
293         asprintf( &f_dir, "%s%c", psz_cwd, DIR_SEP_CHAR );
294         free( psz_cwd );
295     }
296     if( !f_fname || !f_dir )
297     {
298         free( f_fname );
299         free( f_dir );
300         return NULL;
301     }
302
303     i_fname_len = strlen( f_fname );
304
305     f_fname_noext = malloc(i_fname_len + 1);
306     f_fname_trim = malloc(i_fname_len + 1 );
307     if( !f_fname_noext || !f_fname_trim )
308     {
309         free( f_fname );
310         free( f_dir );
311         free( f_fname_noext );
312         free( f_fname_trim );
313         return NULL;
314     }
315
316     strcpy_strip_ext( f_fname_noext, f_fname );
317     strcpy_trim( f_fname_trim, f_fname_noext );
318
319     var_Get( p_this, "sub-autodetect-fuzzy", &fuzzy );
320
321     result = calloc( MAX_SUBTITLE_FILES+1, sizeof(vlc_subfn_t) ); /* We check it later (simplify code) */
322     subdirs = paths_to_list( f_dir, psz_path );
323     for( j = -1, i_sub_count = 0; (j == -1) || ( j >= 0 && subdirs != NULL && subdirs[j] != NULL ); j++ )
324     {
325         const char *psz_dir = j < 0 ? f_dir : subdirs[j];
326         char **ppsz_dir_content;
327         int i_dir_content;
328         int a;
329
330         if( psz_dir == NULL || ( j >= 0 && !strcmp( psz_dir, f_dir ) ) )
331             continue;
332
333         /* parse psz_src dir */
334         i_dir_content = utf8_scandir( psz_dir, &ppsz_dir_content,
335                                       subtitles_Filter, NULL );
336         if( i_dir_content < 0 )
337             continue;
338
339         msg_Dbg( p_this, "looking for a subtitle file in %s", psz_dir );
340         for( a = 0; a < i_dir_content && i_sub_count < MAX_SUBTITLE_FILES ; a++ )
341         {
342             char *psz_name = ppsz_dir_content[a];
343             char tmp_fname_noext[strlen( psz_name ) + 1];
344             char tmp_fname_trim[strlen( psz_name ) + 1];
345             char tmp_fname_ext[strlen( psz_name ) + 1];
346
347             int i_prio;
348
349             if( psz_name == NULL )
350                 continue;
351
352             /* retrieve various parts of the filename */
353             strcpy_strip_ext( tmp_fname_noext, psz_name );
354             strcpy_get_ext( tmp_fname_ext, psz_name );
355             strcpy_trim( tmp_fname_trim, tmp_fname_noext );
356
357             i_prio = SUB_PRIORITY_NONE;
358             if( i_prio == SUB_PRIORITY_NONE && !strcmp( tmp_fname_trim, f_fname_trim ) )
359             {
360                 /* matches the movie name exactly */
361                 i_prio = SUB_PRIORITY_MATCH_ALL;
362             }
363             if( i_prio == SUB_PRIORITY_NONE &&
364                 ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
365             {
366                 /* contains the movie name */
367                 tmp += strlen( f_fname_trim );
368                 if( whiteonly( tmp ) )
369                 {
370                     /* chars in front of the movie name */
371                     i_prio = SUB_PRIORITY_MATCH_RIGHT;
372                 }
373                 else
374                 {
375                     /* chars after (and possibly in front of)
376                      * the movie name */
377                     i_prio = SUB_PRIORITY_MATCH_LEFT;
378                 }
379             }
380             if( i_prio == SUB_PRIORITY_NONE &&
381                 j == 0 )
382             {
383                 /* doesn't contain the movie name, prefer files in f_dir over subdirs */
384                 i_prio = SUB_PRIORITY_MATCH_NONE;
385             }
386             if( i_prio >= fuzzy.i_int )
387             {
388                 char psz_path[strlen( psz_dir ) + strlen( psz_name ) + 1];
389                 struct stat st;
390
391                 sprintf( psz_path, "%s%s", psz_dir, psz_name );
392                 if( !strcmp( psz_path, psz_fname ) )
393                     continue;
394
395                 if( !utf8_stat( psz_path, &st ) && S_ISREG( st.st_mode ) && result )
396                 {
397                     msg_Dbg( p_this,
398                             "autodetected subtitle: %s with priority %d",
399                             psz_path, i_prio );
400                     result[i_sub_count].priority = i_prio;
401                     result[i_sub_count].psz_fname = strdup( psz_path );
402                     result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
403                     i_sub_count++;
404                 }
405                 else
406                 {
407                     msg_Dbg( p_this, "stat failed (autodetecting subtitle: %s with priority %d)",
408                              psz_path, i_prio );
409                 }
410             }
411         }
412         if( ppsz_dir_content )
413         {
414             for( a = 0; a < i_dir_content; a++ )
415                 free( ppsz_dir_content[a] );
416             free( ppsz_dir_content );
417         }
418     }
419     if( subdirs )
420     {
421         for( j = 0; subdirs[j]; j++ )
422             free( subdirs[j] );
423         free( subdirs );
424     }
425     free( f_fname );
426     free( f_dir );
427     free( f_fname_trim );
428     free( f_fname_noext );
429
430     if( !result )
431         return NULL;
432
433     qsort( result, i_sub_count, sizeof(vlc_subfn_t), compare_sub_priority );
434
435     result2 = calloc( i_sub_count + 1, sizeof(char*) );
436
437     for( j = 0, i_result2 = 0; j < i_sub_count && result2 != NULL; j++ )
438     {
439         vlc_bool_t b_reject = VLC_FALSE;
440
441         if( !result[j].psz_fname || !result[j].psz_ext ) /* memory out */
442             break;
443
444         if( !strcasecmp( result[j].psz_ext, "sub" ) )
445         {
446             int i;
447             for( i = 0; i < i_sub_count; i++ )
448             {
449                 if( result[i].psz_fname && result[i].psz_ext &&
450                     !strncasecmp( result[j].psz_fname, result[i].psz_fname,
451                                   strlen( result[j].psz_fname) - 3 ) &&
452                     !strcasecmp( result[i].psz_ext, "idx" ) )
453                     break;
454             }
455             if( i < i_sub_count )
456                 b_reject = VLC_TRUE;
457         }
458         else if( !strcasecmp( result[j].psz_ext, "cdg" ) )
459         {
460             if( result[j].priority < SUB_PRIORITY_MATCH_ALL )
461                 b_reject = VLC_TRUE;
462         }
463
464         /* */
465         if( !b_reject )
466             result2[i_result2++] = strdup( result[j].psz_fname );
467     }
468
469     for( j = 0; j < i_sub_count; j++ )
470     {
471         free( result[j].psz_fname );
472         free( result[j].psz_ext );
473     }
474     free( result );
475
476     return result2;
477 }
478