1 /*****************************************************************************
2 * subtitles.c : subtitles detection
3 *****************************************************************************
4 * Copyright (C) 2003-2009 the VideoLAN team
7 * Authors: Derk-Jan Hartman <hartman at videolan.org>
8 * This is adapted code from the GPL'ed MPlayer (http://mplayerhq.hu)
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.
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.
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 *****************************************************************************/
27 * This file contains functions to dectect subtitle files.
34 #include <vlc_common.h>
48 #include <ctype.h> /* isalnum */
50 #include "input_internal.h"
53 * We are not going to autodetect more subtitle files than this.
55 #define MAX_SUBTITLE_FILES 128
58 * The possible extensions for subtitle files we support
60 static const char const sub_exts[][6] = {
63 "utf", "utf8", "utf-8",
66 "psb", "mpsub","mpl2",
71 static void strcpy_trim( char *d, const char *s )
73 /* skip leading whitespace */
74 while( *s && !isalnum(*s) )
81 while( *s && isalnum(*s) )
87 /* trim excess whitespace */
88 while( *s && !isalnum(*s) )
98 static void strcpy_strip_ext( char *d, const char *s )
100 const char *tmp = strrchr(s, '.');
107 strlcpy(d, s, tmp - s + 1 );
115 static void strcpy_get_ext( char *d, const char *s )
117 const char *tmp = strrchr(s, '.');
121 strcpy( d, tmp + 1 );
124 static int whiteonly( const char *s )
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,
150 static int compare_sub_priority( const void *a, const void *b )
152 const vlc_subfn_t *p0 = a;
153 const vlc_subfn_t *p1 = b;
155 if( p0->priority > p1->priority )
158 if( p0->priority < p1->priority )
162 return strcoll( p0->psz_fname, p1->psz_fname);
164 return strcmp( p0->psz_fname, p1->psz_fname);
169 * Check if a file ends with a subtitle extension
171 int subtitles_Filter( const char *psz_dir_content )
173 const char *tmp = strrchr( psz_dir_content, '.');
179 for( int i = 0; sub_exts[i][0]; i++ )
180 if( strcasecmp( sub_exts[i], tmp ) == 0 )
187 * Convert a list of paths separated by ',' to a char**
189 static char **paths_to_list( const char *psz_dir, char *psz_path )
191 unsigned int i, k, i_nb_subdirs;
192 char **subdirs; /* list of subdirectories to look in */
193 char *psz_parser = psz_path;
195 if( !psz_dir || !psz_path )
198 for( k = 0, i_nb_subdirs = 1; psz_path[k] != '\0'; k++ )
200 if( psz_path[k] == ',' )
204 subdirs = calloc( i_nb_subdirs + 1, sizeof(char*) );
208 for( i = 0; psz_parser && *psz_parser != '\0' ; )
210 char *psz_subdir = psz_parser;
211 psz_parser = strchr( psz_subdir, ',' );
214 *psz_parser++ = '\0';
215 while( *psz_parser == ' ' )
218 if( *psz_subdir == '\0' )
221 if( asprintf( &subdirs[i++], "%s%s",
222 psz_subdir[0] == '.' ? psz_dir : "",
233 * Detect subtitle files.
235 * When called this function will split up the psz_name string into a
236 * directory, filename and extension. It then opens the directory
237 * in which the file resides and tries to find possible matches of
241 * \param p_this the calling \ref input_thread_t
242 * \param psz_path a list of subdirectories (separated by a ',') to look in.
243 * \param psz_name the complete filename to base the search on.
244 * \return a NULL terminated array of filenames with detected possible subtitles.
245 * The array contains max MAX_SUBTITLE_FILES items and you need to free it after use.
247 char **subtitles_Detect( input_thread_t *p_this, char *psz_path,
248 const char *psz_name_org )
251 int j, i_result2, i_sub_count, i_fname_len;
252 char *f_fname_noext = NULL, *f_fname_trim = NULL;
254 char **subdirs; /* list of subdirectories to look in */
256 vlc_subfn_t *result = NULL; /* unsorted results */
257 char **result2; /* sorted results */
262 char *psz_fname = make_path( psz_name_org );
266 /* extract filename & dirname from psz_fname */
267 char *f_dir = strdup( psz_fname );
274 char *f_fname = strrchr( f_dir, DIR_SEP_CHAR );
281 *(f_fname++) = 0; /* skip dir separator */
283 i_fname_len = strlen( f_fname );
285 f_fname_noext = malloc(i_fname_len + 1);
286 f_fname_trim = malloc(i_fname_len + 1 );
287 if( !f_fname_noext || !f_fname_trim )
290 free( f_fname_noext );
291 free( f_fname_trim );
296 strcpy_strip_ext( f_fname_noext, f_fname );
297 strcpy_trim( f_fname_trim, f_fname_noext );
299 i_fuzzy = var_GetInteger( p_this, "sub-autodetect-fuzzy" );
301 result = calloc( MAX_SUBTITLE_FILES+1, sizeof(vlc_subfn_t) ); /* We check it later (simplify code) */
302 subdirs = paths_to_list( f_dir, psz_path );
303 for( j = -1, i_sub_count = 0; (j == -1) || ( j >= 0 && subdirs != NULL && subdirs[j] != NULL ); j++ )
305 const char *psz_dir = j < 0 ? f_dir : subdirs[j];
306 char **ppsz_dir_content;
309 if( psz_dir == NULL || ( j >= 0 && !strcmp( psz_dir, f_dir ) ) )
312 /* parse psz_src dir */
313 i_dir_content = vlc_scandir( psz_dir, &ppsz_dir_content,
314 subtitles_Filter, NULL );
315 if( i_dir_content < 0 )
318 msg_Dbg( p_this, "looking for a subtitle file in %s", psz_dir );
319 for( int a = 0; a < i_dir_content && i_sub_count < MAX_SUBTITLE_FILES ; a++ )
321 char *psz_name = ppsz_dir_content[a];
322 char tmp_fname_noext[strlen( psz_name ) + 1];
323 char tmp_fname_trim[strlen( psz_name ) + 1];
324 char tmp_fname_ext[strlen( psz_name ) + 1];
329 if( psz_name == NULL || psz_name[0] == '.' )
332 /* retrieve various parts of the filename */
333 strcpy_strip_ext( tmp_fname_noext, psz_name );
334 strcpy_get_ext( tmp_fname_ext, psz_name );
335 strcpy_trim( tmp_fname_trim, tmp_fname_noext );
337 i_prio = SUB_PRIORITY_NONE;
338 if( i_prio == SUB_PRIORITY_NONE && !strcmp( tmp_fname_trim, f_fname_trim ) )
340 /* matches the movie name exactly */
341 i_prio = SUB_PRIORITY_MATCH_ALL;
343 if( i_prio == SUB_PRIORITY_NONE &&
344 ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
346 /* contains the movie name */
347 tmp += strlen( f_fname_trim );
348 if( whiteonly( tmp ) )
350 /* chars in front of the movie name */
351 i_prio = SUB_PRIORITY_MATCH_RIGHT;
355 /* chars after (and possibly in front of)
357 i_prio = SUB_PRIORITY_MATCH_LEFT;
360 if( i_prio == SUB_PRIORITY_NONE &&
363 /* doesn't contain the movie name, prefer files in f_dir over subdirs */
364 i_prio = SUB_PRIORITY_MATCH_NONE;
366 if( i_prio >= i_fuzzy )
368 char psz_path[strlen( psz_dir ) + strlen( psz_name ) + 2];
371 sprintf( psz_path, "%s"DIR_SEP"%s", psz_dir, psz_name );
372 if( !strcmp( psz_path, psz_fname ) )
375 if( !vlc_stat( psz_path, &st ) && S_ISREG( st.st_mode ) && result )
378 "autodetected subtitle: %s with priority %d",
380 result[i_sub_count].priority = i_prio;
381 result[i_sub_count].psz_fname = strdup( psz_path );
382 result[i_sub_count].psz_ext = strdup(tmp_fname_ext);
387 msg_Dbg( p_this, "stat failed (autodetecting subtitle: %s with priority %d)",
392 if( ppsz_dir_content )
394 for( int a = 0; a < i_dir_content; a++ )
395 free( ppsz_dir_content[a] );
396 free( ppsz_dir_content );
401 for( j = 0; subdirs[j]; j++ )
406 free( f_fname_trim );
407 free( f_fname_noext );
413 qsort( result, i_sub_count, sizeof(vlc_subfn_t), compare_sub_priority );
415 result2 = calloc( i_sub_count + 1, sizeof(char*) );
417 for( j = 0, i_result2 = 0; j < i_sub_count && result2 != NULL; j++ )
419 bool b_reject = false;
421 if( !result[j].psz_fname || !result[j].psz_ext ) /* memory out */
424 if( !strcasecmp( result[j].psz_ext, "sub" ) )
427 for( i = 0; i < i_sub_count; i++ )
429 if( result[i].psz_fname && result[i].psz_ext &&
430 !strncasecmp( result[j].psz_fname, result[i].psz_fname,
431 strlen( result[j].psz_fname) - 3 ) &&
432 !strcasecmp( result[i].psz_ext, "idx" ) )
435 if( i < i_sub_count )
438 else if( !strcasecmp( result[j].psz_ext, "cdg" ) )
440 if( result[j].priority < SUB_PRIORITY_MATCH_ALL )
446 result2[i_result2++] = strdup( result[j].psz_fname );
449 for( j = 0; j < i_sub_count; j++ )
451 free( result[j].psz_fname );
452 free( result[j].psz_ext );