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 *****************************************************************************/
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_input.h>
36 #include <vlc_memory.h>
38 #include <vlc_demux.h>
39 #include <vlc_charset.h>
43 /*****************************************************************************
45 *****************************************************************************/
46 static int Open ( vlc_object_t *p_this );
47 static void Close( vlc_object_t *p_this );
49 #define SUB_DELAY_LONGTEXT \
50 N_("Apply a delay to all subtitles (in 1/10s, eg 100 means 10s).")
51 #define SUB_FPS_LONGTEXT \
52 N_("Override the normal frames per second settings. " \
53 "This will only affect frame-based subtitle formats without a fixed value.")
54 #define SUB_TYPE_LONGTEXT \
55 N_("Force the subtiles format. Use \"auto\", the set of supported values varies.")
58 set_shortname( N_("Subtitles (asa demuxer)"))
59 set_description( N_("Text subtitles parser") )
60 set_capability( "demux", 50 )
61 set_category( CAT_INPUT )
62 set_subcategory( SUBCAT_INPUT_DEMUX )
63 add_float( "sub-fps", 0.0, NULL,
64 N_("Frames per second"),
65 SUB_FPS_LONGTEXT, true )
66 add_integer( "sub-delay", 0, NULL,
67 N_("Subtitles delay"),
68 SUB_DELAY_LONGTEXT, true )
69 add_string( "sub-type", "auto", NULL, N_("Subtitles format"),
70 SUB_TYPE_LONGTEXT, true )
71 set_callbacks( Open, Close )
73 add_shortcut( "asademux" )
76 /*****************************************************************************
78 *****************************************************************************/
93 int64_t i_next_demux_date;
94 int64_t i_microsecperframe;
100 subtitle_t *subtitle;
105 static int Demux( demux_t * );
106 static int Control( demux_t *, int, va_list );
108 static void Fix( demux_t * );
110 static int ProcessLine( demux_t *, void *, int64_t, int64_t,
111 const char *, size_t );
113 /*****************************************************************************
115 *****************************************************************************/
116 static int Open ( vlc_object_t *p_this )
118 demux_t *p_demux = (demux_t*)p_this;
121 input_thread_t *p_input;
126 struct asa_import_detect *p_detect = NULL;
128 if( strcmp( p_demux->psz_demux, "asademux" ) )
133 p_demux->pf_demux = Demux;
134 p_demux->pf_control = Control;
135 p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
138 p_sys->psz_header = NULL;
139 p_sys->i_subtitle = 0;
140 p_sys->i_subtitles = 0;
141 p_sys->i_subs_alloc = 0;
142 p_sys->subtitle = NULL;
143 p_sys->i_microsecperframe = 40000;
146 p_input = (input_thread_t *)vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
149 f_fps = var_GetFloat( p_input, "sub-original-fps" );
151 p_sys->i_microsecperframe = (int64_t)( (float)1000000 / f_fps );
153 msg_Dbg( p_demux, "Movie fps: %f", f_fps );
154 vlc_object_release( p_input );
157 /* Check for override of the fps */
158 f_fps = var_CreateGetFloat( p_demux, "sub-fps" );
161 p_sys->i_microsecperframe = (int64_t)( (float)1000000 / f_fps );
162 msg_Dbg( p_demux, "Override subtitle fps %f", f_fps );
165 /* Get or probe the type */
166 psz_type = var_CreateGetString( p_demux, "sub-type" );
169 for( p_detect = asa_det_first; p_detect; p_detect = p_detect->next )
171 if( !strcmp( p_detect->name, psz_type ) )
178 msg_Warn( p_demux, "unknown sub-type \"%s\"", psz_type );
183 /* Probe if unknown type */
189 msg_Dbg( p_demux, "autodetecting subtitle format" );
190 i_size = stream_Peek( p_demux->s, &p, 4096 );
194 msg_Warn( p_demux, "cannot process subtitles (no data?)" );
197 p_detect = asa_imports_detect( p, i_size );
202 msg_Err( p_demux, "failed to recognize subtitle type" );
208 msg_Err( p_demux, "detected %s subtitle format, no asa support", p_detect->name );
212 msg_Dbg( p_demux, "detected %s subtitle format", p_detect->name );
214 stream_Control( p_demux->s, STREAM_GET_SIZE, &i_ssize );
215 p_data = malloc( i_ssize );
221 if( stream_Read( p_demux->s, &p_data, i_ssize ) != i_ssize )
223 msg_Err( p_demux, "subtitle stream read error" );
228 asa_import( p_demux, p_data, i_ssize, p_sys->i_microsecperframe, p_detect,
232 msg_Dbg(p_demux, "loaded %d subtitles", p_sys->i_subtitles );
234 /* Fix subtitle (order and time) *** */
236 p_sys->i_subtitle = 0;
238 if( p_sys->i_subtitles > 0 )
240 p_sys->i_length = p_sys->subtitle[p_sys->i_subtitles-1].i_stop;
242 if( p_sys->i_length <= 0 )
243 p_sys->i_length = p_sys->subtitle[p_sys->i_subtitles-1].i_start + VLC_TS_0;
246 /* *** add subtitle ES *** */
247 if( p_detect->fmt->target == ASAI_TARGET_SSA )
249 es_format_Init( &fmt, SPU_ES, VLC_CODEC_SSA );
253 es_format_Init( &fmt, SPU_ES, VLC_CODEC_SUBT );
255 p_sys->es = es_out_Add( p_demux->out, &fmt );
260 /*****************************************************************************
261 * ProcessLine: Callback for asa_import, fed one line
262 * (note: return values are not kept. nonzero signals abort to asa_import)
263 *****************************************************************************/
264 static int ProcessLine( demux_t *p_demux, void *p_arg,
265 int64_t i_start, int64_t i_stop,
266 const char *p_buffer, size_t i_buffer_length )
268 demux_sys_t *p_sys = p_demux->p_sys;
269 subtitle_t *p_subtitle;
274 if( p_sys->i_subtitles >= p_sys->i_subs_alloc )
276 p_sys->i_subs_alloc += 500;
277 if( !( p_sys->subtitle = realloc_or_free( p_sys->subtitle,
278 sizeof(subtitle_t) * p_sys->i_subs_alloc ) ) )
283 p_subtitle = &p_sys->subtitle[p_sys->i_subtitles];
285 psz_text = malloc( i_buffer_length + 1 );
288 memcpy( psz_text, p_buffer, i_buffer_length );
289 psz_text[i_buffer_length] = '\0';
291 p_subtitle->i_start = i_start;
292 p_subtitle->i_stop = i_stop;
293 p_subtitle->psz_text = psz_text;
295 p_sys->i_subtitles++;
299 /*****************************************************************************
300 * Close: Close subtitle demux
301 *****************************************************************************/
302 static void Close( vlc_object_t *p_this )
304 demux_t *p_demux = (demux_t*)p_this;
305 demux_sys_t *p_sys = p_demux->p_sys;
308 for( i = 0; i < p_sys->i_subtitles; i++ )
309 free( p_sys->subtitle[i].psz_text );
310 free( p_sys->subtitle );
315 /*****************************************************************************
317 *****************************************************************************/
318 static int Control( demux_t *p_demux, int i_query, va_list args )
320 demux_sys_t *p_sys = p_demux->p_sys;
326 case DEMUX_GET_LENGTH:
327 pi64 = (int64_t*)va_arg( args, int64_t * );
328 *pi64 = p_sys->i_length;
332 pi64 = (int64_t*)va_arg( args, int64_t * );
333 if( p_sys->i_subtitle < p_sys->i_subtitles )
335 *pi64 = p_sys->subtitle[p_sys->i_subtitle].i_start;
341 i64 = (int64_t)va_arg( args, int64_t );
342 p_sys->i_subtitle = 0;
343 while( p_sys->i_subtitle < p_sys->i_subtitles &&
344 p_sys->subtitle[p_sys->i_subtitle].i_start < i64 )
349 if( p_sys->i_subtitle >= p_sys->i_subtitles )
353 case DEMUX_GET_POSITION:
354 pf = (double*)va_arg( args, double * );
355 if( p_sys->i_subtitle >= p_sys->i_subtitles )
359 else if( p_sys->i_subtitles > 0 )
361 *pf = (double)p_sys->subtitle[p_sys->i_subtitle].i_start /
362 (double)p_sys->i_length;
370 case DEMUX_SET_POSITION:
371 f = (double)va_arg( args, double );
372 i64 = f * p_sys->i_length;
374 p_sys->i_subtitle = 0;
375 while( p_sys->i_subtitle < p_sys->i_subtitles &&
376 p_sys->subtitle[p_sys->i_subtitle].i_start < i64 )
380 if( p_sys->i_subtitle >= p_sys->i_subtitles )
384 case DEMUX_SET_NEXT_DEMUX_TIME:
385 p_sys->i_next_demux_date = (int64_t)va_arg( args, int64_t );
390 case DEMUX_GET_ATTACHMENTS:
391 case DEMUX_GET_TITLE_INFO:
395 msg_Err( p_demux, "unknown query in subtitle control" );
400 /*****************************************************************************
401 * Demux: Send subtitle to decoder
402 *****************************************************************************/
403 static int Demux( demux_t *p_demux )
405 demux_sys_t *p_sys = p_demux->p_sys;
408 if( p_sys->i_subtitle >= p_sys->i_subtitles )
411 i_maxdate = p_sys->i_next_demux_date - var_GetTime( p_demux->p_parent, "spu-delay" );;
412 if( i_maxdate <= 0 && p_sys->i_subtitle < p_sys->i_subtitles )
414 /* Should not happen */
415 i_maxdate = p_sys->subtitle[p_sys->i_subtitle].i_start + 1;
418 while( p_sys->i_subtitle < p_sys->i_subtitles &&
419 p_sys->subtitle[p_sys->i_subtitle].i_start < i_maxdate )
422 int i_len = strlen( p_sys->subtitle[p_sys->i_subtitle].psz_text ) + 1;
431 if( ( p_block = block_New( p_demux, i_len ) ) == NULL )
437 if( p_sys->subtitle[p_sys->i_subtitle].i_start < 0 )
443 p_block->i_pts = VLC_TS_0 + p_sys->subtitle[p_sys->i_subtitle].i_start;
444 p_block->i_dts = VLC_TS_0 + p_block->i_pts;
445 if( p_sys->subtitle[p_sys->i_subtitle].i_stop >= 0 )
448 p_sys->subtitle[p_sys->i_subtitle].i_stop - p_block->i_pts;
451 memcpy( p_block->p_buffer,
452 p_sys->subtitle[p_sys->i_subtitle].psz_text, i_len );
453 if( p_block->i_pts > VLC_TS_INVALID )
455 es_out_Send( p_demux->out, p_sys->es, p_block );
459 block_Release( p_block );
465 p_sys->i_next_demux_date = 0;
470 /*****************************************************************************
471 * Fix: fix time stamp and order of subtitle
472 *****************************************************************************/
473 static void Fix( demux_t *p_demux )
475 demux_sys_t *p_sys = p_demux->p_sys;
479 /* *** fix order (to be sure...) *** */
480 /* We suppose that there are near in order and this durty bubble sort
481 * wont take too much time
486 for( i_index = 1; i_index < p_sys->i_subtitles; i_index++ )
488 if( p_sys->subtitle[i_index].i_start <
489 p_sys->subtitle[i_index - 1].i_start )
493 p_sys->subtitle + i_index - 1,
494 sizeof( subtitle_t ) );
495 memcpy( p_sys->subtitle + i_index - 1,
496 p_sys->subtitle + i_index,
497 sizeof( subtitle_t ) );
498 memcpy( p_sys->subtitle + i_index,
500 sizeof( subtitle_t ) );