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