1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2003 VideoLAN
5 * $Id: subtitles.c,v 1.2 2003/10/01 22:44:58 hartman Exp $
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
23 *****************************************************************************/
27 * This file contains functions to dectect subtitle files.
32 #include <vlc/input.h>
39 * What's between a directory and a filename?
42 #define DIRECTORY_SEPARATOR '\\'
44 #define DIRECTORY_SEPARATOR '/'
48 * We are not going to autodetect more subtitle files than this.
50 #define MAX_SUBTITLE_FILES 128
53 * This determines how fuzzy the returned results will be.
55 * Currently set to 3, other options are:
57 * 1 = any subtitle file
58 * 2 = any sub file containing movie name
59 * 3 = sub file matching movie name exactly
60 * 4 = sub file matching movie name with additional chars
65 * The possible extentions for subtitle files we support
67 static const char * sub_exts[] = { "utf", "utf8", "utf-8", "sub", "srt", "smi", "txt", "ssa", NULL};
68 /* extensions from unsupported types */
69 /* rt, aqt, jss, js, ass */
71 static void strcpy_trim( char *d, 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, char *s )
100 char *tmp = strrchr(s, '.');
107 strncpy(d, s, tmp - s);
117 static void strcpy_get_ext( char *d, char *s )
119 char *tmp = strrchr(s, '.');
124 } else strcpy( d, tmp + 1 );
127 static int whiteonly( char *s )
131 if( isalnum( *s ) ) return 0;
137 typedef struct _subfn
143 static int compare_sub_priority( const void *a, const void *b )
145 if (((subfn*)a)->priority > ((subfn*)b)->priority) {
147 } else if (((subfn*)a)->priority < ((subfn*)b)->priority) {
150 return strcoll(((subfn*)a)->psz_fname, ((subfn*)b)->psz_fname);
155 * Detect subtitle files.
157 * When called this function will split up the psz_fname string into a
158 * directory, filename and extension. It then opens the directory
159 * in which the file resides and tries to find possible matches of
162 * \brief Use a filename to find subtitle files.
164 * \param p_this the calling \ref input_thread_t
165 * \param psz_path a subdirectory to look into. This is not used atm.
166 * \param psz_fname the complete filename to base the search on.
167 * \return an array of filenames with detected possbile subtitles. You
168 * need to free this after use.
170 char** subtitles_Detect( input_thread_t *p_this, char *psz_path, char *psz_fname )
172 /* variables to be used for derivatives of psz_fname */
173 char *f_dir, *f_fname, *f_fname_noext, *f_fname_trim, *tmp;
174 /* variables to be used for derivatives FILE *f */
175 char *tmp_fname_noext, *tmp_fname_trim, *tmp_fname_ext, *tmpresult;
177 int len, i, j, i_sub_count;
178 subfn *result; /* unsorted results */
179 char **result2; /* sorted results */
186 len = ( strlen( psz_fname ) > 256 ? strlen( psz_fname ) : 256 ) +
187 ( strlen( psz_path ) > 256 ? strlen( psz_path ) : 256 ) + 2;
189 f_dir = (char*)malloc(len);
190 f_fname = (char*)malloc(len);
191 f_fname_noext = (char*)malloc(len);
192 f_fname_trim = (char*)malloc(len);
194 tmp_fname_noext = (char*)malloc(len);
195 tmp_fname_trim = (char*)malloc(len);
196 tmp_fname_ext = (char*)malloc(len);
198 tmpresult = (char*)malloc(len);
200 result = (subfn*)malloc( sizeof(subfn) * MAX_SUBTITLE_FILES );
201 memset( result, 0, sizeof(subfn) * MAX_SUBTITLE_FILES );
203 /* extract filename & dirname from psz_fname */
204 tmp = strrchr( psz_fname, DIRECTORY_SEPARATOR );
208 strcpy( f_fname, tmp + 1 );
209 pos = tmp - psz_fname;
210 strncpy( f_dir, psz_fname, pos + 1 );
215 strcpy( f_fname, psz_fname );
219 strcpy_strip_ext( f_fname_noext, f_fname );
220 strcpy_trim( f_fname_trim, f_fname_noext );
222 for( j = 0; j <= 1; j++)
224 d = opendir( j == 0 ? f_dir : psz_path );
228 while( ( de = readdir( d ) ) )
230 /* retrieve various parts of the filename */
231 strcpy_strip_ext( tmp_fname_noext, de->d_name );
232 strcpy_get_ext( tmp_fname_ext, de->d_name );
233 strcpy_trim( tmp_fname_trim, tmp_fname_noext );
235 /* does it end with a subtitle extension? */
237 for( i = 0; sub_exts[i]; i++ )
239 if( strcmp(sub_exts[i], tmp_fname_ext ) == 0 )
242 msg_Dbg( p_this, "found a possible subtitle: %s", de->d_name );
247 /* we have a (likely) subtitle file */
251 if( !i_prio && strcmp( tmp_fname_trim, f_fname_trim ) == 0 )
253 /* matches the movie name exactly */
256 if( !i_prio && ( tmp = strstr( tmp_fname_trim, f_fname_trim ) ) )
258 /* contains the movie name */
259 tmp += strlen( f_fname_trim );
260 if( whiteonly( tmp ) )
262 /* chars in front of the movie name */
267 /* chars after (and possibly in front of) the movie name */
273 /* doesn't contain the movie name */
274 if( j == 0 ) i_prio = 1;
277 if( i_prio >= SUB_FUZZY )
279 sprintf( tmpresult, "%s%s", j == 0 ? f_dir : psz_path, de->d_name );
280 msg_Dbg( p_this, "autodetected subtitle: %s with priority %d", de->d_name, i_prio );
281 if( ( f = fopen( tmpresult, "rt" ) ) )
284 result[i_sub_count].priority = i_prio;
285 result[i_sub_count].psz_fname = strdup( tmpresult );
291 if( i_sub_count >= MAX_SUBTITLE_FILES ) break;
299 free( f_fname_noext );
300 free( f_fname_trim );
302 free( tmp_fname_noext );
303 free( tmp_fname_trim );
304 free( tmp_fname_ext );
308 qsort( result, i_sub_count, sizeof( subfn ), compare_sub_priority );
310 result2 = (char**)malloc( sizeof(char*) * ( i_sub_count + 1 ) );
311 memset( result2, 0, sizeof(char*) * ( i_sub_count + 1 ) );
313 for( i = 0; i < i_sub_count; i++ )
315 result2[i] = result[i].psz_fname;
317 result2[i_sub_count] = NULL;