]> git.sesse.net Git - vlc/blob - src/input/subtitles.c
Fixed picture leaks when unlinking a non displayed picture.
[vlc] / src / input / subtitles.c
1 /*****************************************************************************
2  * subtitles.c : subtitles detection
3  *****************************************************************************
4  * Copyright (C) 2003-2009 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_common.h>
35 #include <vlc_fs.h>
36 #include <vlc_url.h>
37
38 #ifdef HAVE_DIRENT_H
39 #   include <dirent.h>
40 #endif
41
42 #ifdef HAVE_UNISTD_H
43 #   include <unistd.h>
44 #endif
45
46 #include <sys/stat.h>
47
48 #include <ctype.h> /* isalnum */
49
50 #include "input_internal.h"
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 const sub_exts[][6] = {
61     "idx", "sub",  "srt",
62     "ssa", "ass",  "smi",
63     "utf", "utf8", "utf-8",
64     "txt", "rt",   "aqt",
65     "usf", "jss",  "cdg",
66     "psb", "mpsub","mpl2",
67     "pjs", "dks",
68     ""
69 };
70
71 static void strcpy_trim( char *d, const char *s )
72 {
73     /* skip leading whitespace */
74     while( *s && !isalnum(*s) )
75     {
76         s++;
77     }
78     for(;;)
79     {
80         /* copy word */
81         while( *s && isalnum(*s) )
82         {
83             *d = tolower(*s);
84             s++; d++;
85         }
86         if( *s == 0 ) break;
87         /* trim excess whitespace */
88         while( *s && !isalnum(*s) )
89         {
90             s++;
91         }
92         if( *s == 0 ) break;
93         *d++ = ' ';
94     }
95     *d = 0;
96 }
97
98 static void strcpy_strip_ext( char *d, const char *s )
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( *d )
109     {
110         *d = tolower(*d);
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     while( *s )
127     {
128         if( isalnum( *s ) )
129             return 0;
130         s++;
131     }
132     return 1;
133 }
134
135 enum
136 {
137     SUB_PRIORITY_NONE        = 0,
138     SUB_PRIORITY_MATCH_NONE  = 1,
139     SUB_PRIORITY_MATCH_RIGHT = 2,
140     SUB_PRIORITY_MATCH_LEFT  = 3,
141     SUB_PRIORITY_MATCH_ALL   = 4,
142 };
143 typedef struct
144 {
145     int priority;
146     char *psz_fname;
147     char *psz_ext;
148 } vlc_subfn_t;
149
150 static int compare_sub_priority( const void *a, const void *b )
151 {
152     const vlc_subfn_t *p0 = a;
153     const vlc_subfn_t *p1 = b;
154
155     if( p0->priority > p1->priority )
156         return -1;
157
158     if( p0->priority < p1->priority )
159         return 1;
160
161 #ifndef UNDER_CE
162     return strcoll( p0->psz_fname, p1->psz_fname);
163 #else
164     return strcmp( p0->psz_fname, p1->psz_fname);
165 #endif
166 }
167
168 /*
169  * Check if a file ends with a subtitle extension
170  */
171 int subtitles_Filter( const char *psz_dir_content )
172 {
173     const char *tmp = strrchr( psz_dir_content, '.');
174
175     if( !tmp )
176         return 0;
177     tmp++;
178
179     for( int i = 0; sub_exts[i][0]; i++ )
180         if( strcasecmp( sub_exts[i], tmp ) == 0 )
181             return 1;
182     return 0;
183 }
184
185
186 /**
187  * Convert a list of paths separated by ',' to a char**
188  */
189 static char **paths_to_list( const char *psz_dir, char *psz_path )
190 {
191     unsigned int i, k, i_nb_subdirs;
192     char **subdirs; /* list of subdirectories to look in */
193     char *psz_parser = psz_path;
194
195     if( !psz_dir || !psz_path )
196         return NULL;
197
198     for( k = 0, i_nb_subdirs = 1; psz_path[k] != '\0'; k++ )
199     {
200         if( psz_path[k] == ',' )
201             i_nb_subdirs++;
202     }
203
204     subdirs = calloc( i_nb_subdirs + 1, sizeof(char*) );
205     if( !subdirs )
206         return NULL;
207
208     for( i = 0; psz_parser && *psz_parser != '\0' ; )
209     {
210         char *psz_subdir = psz_parser;
211         psz_parser = strchr( psz_subdir, ',' );
212         if( psz_parser )
213         {
214             *psz_parser++ = '\0';
215             while( *psz_parser == ' ' )
216                 psz_parser++;
217         }
218         if( *psz_subdir == '\0' )
219             continue;
220
221         if( asprintf( &subdirs[i++], "%s%s%c",
222                   psz_subdir[0] == '.' ? psz_dir : "",
223                   psz_subdir,
224                   psz_subdir[strlen(psz_subdir) - 1] == DIR_SEP_CHAR ?
225                                            '\0' : DIR_SEP_CHAR ) == -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_dir = NULL, *f_fname = NULL, *f_fname_noext = NULL, *f_fname_trim = NULL;
255     char *tmp = NULL;
256
257     char **subdirs; /* list of subdirectories to look in */
258
259     vlc_subfn_t *result = NULL; /* unsorted results */
260     char **result2; /* sorted results */
261
262     if( !psz_name_org )
263         return NULL;
264
265     char *psz_fname = make_path( psz_name_org );
266     if( !psz_fname )
267         return NULL;
268
269     /* extract filename & dirname from psz_fname */
270     tmp = strrchr( psz_fname, DIR_SEP_CHAR );
271     if( tmp )
272     {
273         const int i_dirlen = strlen(psz_fname)-strlen(tmp)+1; /* include the separator */
274         f_fname = strdup( &tmp[1] );    /* skip the separator */
275         f_dir = strndup( psz_fname, i_dirlen );
276     }
277     else
278     {
279 #if defined (HAVE_UNISTD_H) && !defined (UNDER_CE)
280         /* Get the current working directory */
281         char *psz_cwd = getcwd( NULL, 0 );
282 #else
283         char *psz_cwd = NULL;
284 #endif
285         if( !psz_cwd )
286         {
287             free( psz_fname );
288             return NULL;
289         }
290
291         f_fname = strdup( psz_fname );
292         if( asprintf( &f_dir, "%s%c", psz_cwd, DIR_SEP_CHAR ) == -1 )
293             f_dir = NULL; /* Assure that function will return in next test */
294         free( psz_cwd );
295     }
296     if( !f_fname || !f_dir )
297     {
298         free( f_fname );
299         free( f_dir );
300         free( psz_fname );
301         return NULL;
302     }
303
304     i_fname_len = strlen( f_fname );
305
306     f_fname_noext = malloc(i_fname_len + 1);
307     f_fname_trim = malloc(i_fname_len + 1 );
308     if( !f_fname_noext || !f_fname_trim )
309     {
310         free( f_fname );
311         free( f_dir );
312         free( f_fname_noext );
313         free( f_fname_trim );
314         free( psz_fname );
315         return NULL;
316     }
317
318     strcpy_strip_ext( f_fname_noext, f_fname );
319     strcpy_trim( f_fname_trim, f_fname_noext );
320
321     i_fuzzy = var_GetInteger( p_this, "sub-autodetect-fuzzy" );
322
323     result = calloc( MAX_SUBTITLE_FILES+1, sizeof(vlc_subfn_t) ); /* We check it later (simplify code) */
324     subdirs = paths_to_list( f_dir, psz_path );
325     for( j = -1, i_sub_count = 0; (j == -1) || ( j >= 0 && subdirs != NULL && subdirs[j] != NULL ); j++ )
326     {
327         const char *psz_dir = j < 0 ? f_dir : subdirs[j];
328         char **ppsz_dir_content;
329         int i_dir_content;
330
331         if( psz_dir == NULL || ( j >= 0 && !strcmp( psz_dir, f_dir ) ) )
332             continue;
333
334         /* parse psz_src dir */
335         i_dir_content = vlc_scandir( psz_dir, &ppsz_dir_content,
336                                       subtitles_Filter, NULL );
337         if( i_dir_content < 0 )
338             continue;
339
340         msg_Dbg( p_this, "looking for a subtitle file in %s", psz_dir );
341         for( int a = 0; a < i_dir_content && i_sub_count < MAX_SUBTITLE_FILES ; a++ )
342         {
343             char *psz_name = ppsz_dir_content[a];
344             char tmp_fname_noext[strlen( psz_name ) + 1];
345             char tmp_fname_trim[strlen( psz_name ) + 1];
346             char tmp_fname_ext[strlen( psz_name ) + 1];
347
348             int i_prio;
349
350             if( psz_name == NULL || psz_name[0] == '.' )
351                 continue;
352
353             /* retrieve various parts of the filename */
354             strcpy_strip_ext( tmp_fname_noext, psz_name );
355             strcpy_get_ext( tmp_fname_ext, psz_name );
356             strcpy_trim( tmp_fname_trim, tmp_fname_noext );
357
358             i_prio = SUB_PRIORITY_NONE;
359             if( i_prio == SUB_PRIORITY_NONE && !strcmp( tmp_fname_trim, f_fname_trim ) )
360             {
361                 /* matches the movie name exactly */
362                 i_prio = SUB_PRIORITY_MATCH_ALL;
363             }
364             if( i_prio == SUB_PRIORITY_NONE &&
365                 ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
366             {
367                 /* contains the movie name */
368                 tmp += strlen( f_fname_trim );
369                 if( whiteonly( tmp ) )
370                 {
371                     /* chars in front of the movie name */
372                     i_prio = SUB_PRIORITY_MATCH_RIGHT;
373                 }
374                 else
375                 {
376                     /* chars after (and possibly in front of)
377                      * the movie name */
378                     i_prio = SUB_PRIORITY_MATCH_LEFT;
379                 }
380             }
381             if( i_prio == SUB_PRIORITY_NONE &&
382                 j == 0 )
383             {
384                 /* doesn't contain the movie name, prefer files in f_dir over subdirs */
385                 i_prio = SUB_PRIORITY_MATCH_NONE;
386             }
387             if( i_prio >= i_fuzzy )
388             {
389                 char psz_path[strlen( psz_dir ) + strlen( psz_name ) + 1];
390                 struct stat st;
391
392                 sprintf( psz_path, "%s%s", psz_dir, psz_name );
393                 if( !strcmp( psz_path, psz_fname ) )
394                     continue;
395
396                 if( !vlc_stat( psz_path, &st ) && S_ISREG( st.st_mode ) && result )
397                 {
398                     msg_Dbg( p_this,
399                             "autodetected subtitle: %s with priority %d",
400                             psz_path, i_prio );
401                     result[i_sub_count].priority = i_prio;
402                     result[i_sub_count].psz_fname = strdup( psz_path );
403                     result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
404                     i_sub_count++;
405                 }
406                 else
407                 {
408                     msg_Dbg( p_this, "stat failed (autodetecting subtitle: %s with priority %d)",
409                              psz_path, i_prio );
410                 }
411             }
412         }
413         if( ppsz_dir_content )
414         {
415             for( int a = 0; a < i_dir_content; a++ )
416                 free( ppsz_dir_content[a] );
417             free( ppsz_dir_content );
418         }
419     }
420     if( subdirs )
421     {
422         for( j = 0; subdirs[j]; j++ )
423             free( subdirs[j] );
424         free( subdirs );
425     }
426     free( f_fname );
427     free( f_dir );
428     free( f_fname_trim );
429     free( f_fname_noext );
430     free( psz_fname );
431
432     if( !result )
433         return NULL;
434
435     qsort( result, i_sub_count, sizeof(vlc_subfn_t), compare_sub_priority );
436
437     result2 = calloc( i_sub_count + 1, sizeof(char*) );
438
439     for( j = 0, i_result2 = 0; j < i_sub_count && result2 != NULL; j++ )
440     {
441         bool b_reject = false;
442
443         if( !result[j].psz_fname || !result[j].psz_ext ) /* memory out */
444             break;
445
446         if( !strcasecmp( result[j].psz_ext, "sub" ) )
447         {
448             int i;
449             for( i = 0; i < i_sub_count; i++ )
450             {
451                 if( result[i].psz_fname && result[i].psz_ext &&
452                     !strncasecmp( result[j].psz_fname, result[i].psz_fname,
453                                   strlen( result[j].psz_fname) - 3 ) &&
454                     !strcasecmp( result[i].psz_ext, "idx" ) )
455                     break;
456             }
457             if( i < i_sub_count )
458                 b_reject = true;
459         }
460         else if( !strcasecmp( result[j].psz_ext, "cdg" ) )
461         {
462             if( result[j].priority < SUB_PRIORITY_MATCH_ALL )
463                 b_reject = true;
464         }
465
466         /* */
467         if( !b_reject )
468             result2[i_result2++] = strdup( result[j].psz_fname );
469     }
470
471     for( j = 0; j < i_sub_count; j++ )
472     {
473         free( result[j].psz_fname );
474         free( result[j].psz_ext );
475     }
476     free( result );
477
478     return result2;
479 }
480