1 /*****************************************************************************
2 * subtitle_asa.c: Demux for subtitle text files using the asa engine.
3 *****************************************************************************
4 * Copyright (C) 1999-2007 the VideoLAN team
7 * Authors: David Lamparter <equinox at videolan dot org>
9 * Originated from subtitle.c
11 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
12 * Derk-Jan Hartman <hartman at videolan dot org>
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
27 *****************************************************************************/
29 /*****************************************************************************
31 *****************************************************************************/
34 #include <vlc_input.h>
38 #ifdef HAVE_SYS_TYPES_H
39 # include <sys/types.h>
43 #include <vlc_demux.h>
44 #include <vlc_charset.h>
48 /*****************************************************************************
50 *****************************************************************************/
51 static int Open ( vlc_object_t *p_this );
52 static void Close( vlc_object_t *p_this );
54 #define SUB_DELAY_LONGTEXT \
55 N_("Apply a delay to all subtitles (in 1/10s, eg 100 means 10s).")
56 #define SUB_FPS_LONGTEXT \
57 N_("Override the normal frames per second settings. " \
58 "This will only affect frame-based subtitle formats without a fixed value.")
59 #define SUB_TYPE_LONGTEXT \
60 N_("Force the subtiles format. Use \"auto\", the set of supported values varies.")
63 set_shortname( _("Subtitles (asa demuxer)"));
64 set_description( _("Text subtitles parser") );
65 set_capability( "demux2", 50 );
66 set_category( CAT_INPUT );
67 set_subcategory( SUBCAT_INPUT_DEMUX );
68 add_float( "sub-fps", 0.0, NULL,
69 N_("Frames per second"),
70 SUB_FPS_LONGTEXT, VLC_TRUE );
71 add_integer( "sub-delay", 0, NULL,
72 N_("Subtitles delay"),
73 SUB_DELAY_LONGTEXT, VLC_TRUE );
74 add_string( "sub-type", "auto", NULL, N_("Subtitles format"),
75 SUB_TYPE_LONGTEXT, VLC_TRUE );
76 set_callbacks( Open, Close );
78 add_shortcut( "asademux" );
81 /*****************************************************************************
83 *****************************************************************************/
98 int64_t i_next_demux_date;
99 int64_t i_microsecperframe;
105 subtitle_t *subtitle;
110 static int Demux( demux_t * );
111 static int Control( demux_t *, int, va_list );
113 static void Fix( demux_t * );
115 static int ProcessLine( demux_t *, void *, int64_t, int64_t,
116 const char *, size_t );
118 /*****************************************************************************
120 *****************************************************************************/
121 static int Open ( vlc_object_t *p_this )
123 demux_t *p_demux = (demux_t*)p_this;
126 input_thread_t *p_input;
131 struct asa_import_detect *p_detect = NULL;
133 if( strcmp( p_demux->psz_demux, "asademux" ) )
135 msg_Dbg( p_demux, "asademux discarded" );
139 p_demux->pf_demux = Demux;
140 p_demux->pf_control = Control;
141 p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
142 p_sys->psz_header = NULL;
143 p_sys->i_subtitle = 0;
144 p_sys->i_subtitles = 0;
145 p_sys->i_subs_alloc = 0;
146 p_sys->subtitle = NULL;
147 p_sys->i_microsecperframe = 40000;
150 p_input = (input_thread_t *)vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
153 f_fps = var_GetFloat( p_input, "sub-original-fps" );
155 p_sys->i_microsecperframe = (int64_t)( (float)1000000 / f_fps );
157 msg_Dbg( p_demux, "Movie fps: %f", f_fps );
158 vlc_object_release( p_input );
161 /* Check for override of the fps */
162 f_fps = var_CreateGetFloat( p_demux, "sub-fps" );
165 p_sys->i_microsecperframe = (int64_t)( (float)1000000 / f_fps );
166 msg_Dbg( p_demux, "Override subtitle fps %f", f_fps );
169 /* Get or probe the type */
170 psz_type = var_CreateGetString( p_demux, "sub-type" );
173 for( p_detect = asa_det_first; p_detect; p_detect = p_detect->next )
175 if( !strcmp( p_detect->name, psz_type ) )
182 msg_Warn( p_demux, "unknown sub-type \"%s\"", psz_type );
187 /* Probe if unknown type */
193 msg_Dbg( p_demux, "autodetecting subtitle format" );
194 i_size = stream_Peek( p_demux->s, &p, 4096 );
198 msg_Warn( p_demux, "cannot process subtitles (no data?)" );
201 p_detect = asa_imports_detect( p, i_size );
206 msg_Err( p_demux, "failed to recognize subtitle type" );
212 msg_Err( p_demux, "detected %s subtitle format, no asa support" );
216 msg_Dbg( p_demux, "detected %s subtitle format", p_detect->name );
218 stream_Control( p_demux->s, STREAM_GET_SIZE, &i_ssize );
219 p_data = malloc( i_ssize );
222 msg_Err( p_demux, "out of memory");
226 if( stream_Read( p_demux->s, &p_data, i_ssize ) != i_ssize )
228 msg_Err( p_demux, "subtitle stream read error" );
233 asa_import( p_demux, p_data, i_ssize, p_sys->i_microsecperframe, p_detect,
237 msg_Dbg(p_demux, "loaded %d subtitles", p_sys->i_subtitles );
239 /* Fix subtitle (order and time) *** */
241 p_sys->i_subtitle = 0;
243 if( p_sys->i_subtitles > 0 )
245 p_sys->i_length = p_sys->subtitle[p_sys->i_subtitles-1].i_stop;
247 if( p_sys->i_length <= 0 )
248 p_sys->i_length = p_sys->subtitle[p_sys->i_subtitles-1].i_start+1;
251 /* *** add subtitle ES *** */
252 if( p_detect->fmt->target == ASAI_TARGET_SSA )
254 es_format_Init( &fmt, SPU_ES, VLC_FOURCC( 's','s','a',' ' ) );
258 es_format_Init( &fmt, SPU_ES, VLC_FOURCC( 's','u','b','t' ) );
260 p_sys->es = es_out_Add( p_demux->out, &fmt );
265 /*****************************************************************************
266 * ProcessLine: Callback for asa_import, fed one line
267 * (note: return values are not kept. nonzero signals abort to asa_import)
268 *****************************************************************************/
269 static int ProcessLine( demux_t *p_demux, void *p_arg,
270 int64_t i_start, int64_t i_stop,
271 const char *p_buffer, size_t i_buffer_length )
273 demux_sys_t *p_sys = p_demux->p_sys;
274 subtitle_t *p_subtitle;
277 if( p_sys->i_subtitles >= p_sys->i_subs_alloc )
279 p_sys->i_subs_alloc += 500;
280 if( !( p_sys->subtitle = realloc( p_sys->subtitle, sizeof(subtitle_t)
281 * p_sys->i_subs_alloc ) ) )
283 msg_Err( p_demux, "out of memory");
287 p_subtitle = &p_sys->subtitle[p_sys->i_subtitles];
289 psz_text = malloc( i_buffer_length + 1 );
292 memcpy( psz_text, p_buffer, i_buffer_length );
293 psz_text[i_buffer_length] = '\0';
295 p_subtitle->i_start = i_start;
296 p_subtitle->i_stop = i_stop;
297 p_subtitle->psz_text = psz_text;
299 p_sys->i_subtitles++;
303 /*****************************************************************************
304 * Close: Close subtitle demux
305 *****************************************************************************/
306 static void Close( vlc_object_t *p_this )
308 demux_t *p_demux = (demux_t*)p_this;
309 demux_sys_t *p_sys = p_demux->p_sys;
312 for( i = 0; i < p_sys->i_subtitles; i++ )
313 free( p_sys->subtitle[i].psz_text );
314 free( p_sys->subtitle );
319 /*****************************************************************************
321 *****************************************************************************/
322 static int Control( demux_t *p_demux, int i_query, va_list args )
324 demux_sys_t *p_sys = p_demux->p_sys;
330 case DEMUX_GET_LENGTH:
331 pi64 = (int64_t*)va_arg( args, int64_t * );
332 *pi64 = p_sys->i_length;
336 pi64 = (int64_t*)va_arg( args, int64_t * );
337 if( p_sys->i_subtitle < p_sys->i_subtitles )
339 *pi64 = p_sys->subtitle[p_sys->i_subtitle].i_start;
345 i64 = (int64_t)va_arg( args, int64_t );
346 p_sys->i_subtitle = 0;
347 while( p_sys->i_subtitle < p_sys->i_subtitles &&
348 p_sys->subtitle[p_sys->i_subtitle].i_start < i64 )
353 if( p_sys->i_subtitle >= p_sys->i_subtitles )
357 case DEMUX_GET_POSITION:
358 pf = (double*)va_arg( args, double * );
359 if( p_sys->i_subtitle >= p_sys->i_subtitles )
363 else if( p_sys->i_subtitles > 0 )
365 *pf = (double)p_sys->subtitle[p_sys->i_subtitle].i_start /
366 (double)p_sys->i_length;
374 case DEMUX_SET_POSITION:
375 f = (double)va_arg( args, double );
376 i64 = f * p_sys->i_length;
378 p_sys->i_subtitle = 0;
379 while( p_sys->i_subtitle < p_sys->i_subtitles &&
380 p_sys->subtitle[p_sys->i_subtitle].i_start < i64 )
384 if( p_sys->i_subtitle >= p_sys->i_subtitles )
388 case DEMUX_SET_NEXT_DEMUX_TIME:
389 p_sys->i_next_demux_date = (int64_t)va_arg( args, int64_t );
394 case DEMUX_GET_ATTACHMENTS:
395 case DEMUX_GET_TITLE_INFO:
399 msg_Err( p_demux, "unknown query in subtitle control" );
404 /*****************************************************************************
405 * Demux: Send subtitle to decoder
406 *****************************************************************************/
407 static int Demux( demux_t *p_demux )
409 demux_sys_t *p_sys = p_demux->p_sys;
412 if( p_sys->i_subtitle >= p_sys->i_subtitles )
415 i_maxdate = p_sys->i_next_demux_date - var_GetTime( p_demux->p_parent, "spu-delay" );;
416 if( i_maxdate <= 0 && p_sys->i_subtitle < p_sys->i_subtitles )
418 /* Should not happen */
419 i_maxdate = p_sys->subtitle[p_sys->i_subtitle].i_start + 1;
422 while( p_sys->i_subtitle < p_sys->i_subtitles &&
423 p_sys->subtitle[p_sys->i_subtitle].i_start < i_maxdate )
426 int i_len = strlen( p_sys->subtitle[p_sys->i_subtitle].psz_text ) + 1;
435 if( ( p_block = block_New( p_demux, i_len ) ) == NULL )
441 if( p_sys->subtitle[p_sys->i_subtitle].i_start < 0 )
447 p_block->i_pts = p_sys->subtitle[p_sys->i_subtitle].i_start;
448 p_block->i_dts = p_block->i_pts;
449 if( p_sys->subtitle[p_sys->i_subtitle].i_stop > 0 )
452 p_sys->subtitle[p_sys->i_subtitle].i_stop - p_block->i_pts;
455 memcpy( p_block->p_buffer,
456 p_sys->subtitle[p_sys->i_subtitle].psz_text, i_len );
457 if( p_block->i_pts > 0 )
459 es_out_Send( p_demux->out, p_sys->es, p_block );
463 block_Release( p_block );
469 p_sys->i_next_demux_date = 0;
474 /*****************************************************************************
475 * Fix: fix time stamp and order of subtitle
476 *****************************************************************************/
477 static void Fix( demux_t *p_demux )
479 demux_sys_t *p_sys = p_demux->p_sys;
483 /* *** fix order (to be sure...) *** */
484 /* We suppose that there are near in order and this durty bubble sort
485 * wont take too much time
490 for( i_index = 1; i_index < p_sys->i_subtitles; i_index++ )
492 if( p_sys->subtitle[i_index].i_start <
493 p_sys->subtitle[i_index - 1].i_start )
497 p_sys->subtitle + i_index - 1,
498 sizeof( subtitle_t ) );
499 memcpy( p_sys->subtitle + i_index - 1,
500 p_sys->subtitle + i_index,
501 sizeof( subtitle_t ) );
502 memcpy( p_sys->subtitle + i_index,
504 sizeof( subtitle_t ) );