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