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>
40 #ifdef HAVE_SYS_TYPES_H
41 # include <sys/types.h>
45 #include <vlc_demux.h>
46 #include <vlc_charset.h>
50 /*****************************************************************************
52 *****************************************************************************/
53 static int Open ( vlc_object_t *p_this );
54 static void Close( vlc_object_t *p_this );
56 #define SUB_DELAY_LONGTEXT \
57 N_("Apply a delay to all subtitles (in 1/10s, eg 100 means 10s).")
58 #define SUB_FPS_LONGTEXT \
59 N_("Override the normal frames per second settings. " \
60 "This will only affect frame-based subtitle formats without a fixed value.")
61 #define SUB_TYPE_LONGTEXT \
62 N_("Force the subtiles format. Use \"auto\", the set of supported values varies.")
65 set_shortname( N_("Subtitles (asa demuxer)"))
66 set_description( N_("Text subtitles parser") )
67 set_capability( "demux", 50 )
68 set_category( CAT_INPUT )
69 set_subcategory( SUBCAT_INPUT_DEMUX )
70 add_float( "sub-fps", 0.0, NULL,
71 N_("Frames per second"),
72 SUB_FPS_LONGTEXT, true )
73 add_integer( "sub-delay", 0, NULL,
74 N_("Subtitles delay"),
75 SUB_DELAY_LONGTEXT, true )
76 add_string( "sub-type", "auto", NULL, N_("Subtitles format"),
77 SUB_TYPE_LONGTEXT, true )
78 set_callbacks( Open, Close )
80 add_shortcut( "asademux" )
83 /*****************************************************************************
85 *****************************************************************************/
100 int64_t i_next_demux_date;
101 int64_t i_microsecperframe;
107 subtitle_t *subtitle;
112 static int Demux( demux_t * );
113 static int Control( demux_t *, int, va_list );
115 static void Fix( demux_t * );
117 static int ProcessLine( demux_t *, void *, int64_t, int64_t,
118 const char *, size_t );
120 /*****************************************************************************
122 *****************************************************************************/
123 static int Open ( vlc_object_t *p_this )
125 demux_t *p_demux = (demux_t*)p_this;
128 input_thread_t *p_input;
133 struct asa_import_detect *p_detect = NULL;
135 if( strcmp( p_demux->psz_demux, "asademux" ) )
140 p_demux->pf_demux = Demux;
141 p_demux->pf_control = Control;
142 p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
145 p_sys->psz_header = NULL;
146 p_sys->i_subtitle = 0;
147 p_sys->i_subtitles = 0;
148 p_sys->i_subs_alloc = 0;
149 p_sys->subtitle = NULL;
150 p_sys->i_microsecperframe = 40000;
153 p_input = (input_thread_t *)vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
156 f_fps = var_GetFloat( p_input, "sub-original-fps" );
158 p_sys->i_microsecperframe = (int64_t)( (float)1000000 / f_fps );
160 msg_Dbg( p_demux, "Movie fps: %f", f_fps );
161 vlc_object_release( p_input );
164 /* Check for override of the fps */
165 f_fps = var_CreateGetFloat( p_demux, "sub-fps" );
168 p_sys->i_microsecperframe = (int64_t)( (float)1000000 / f_fps );
169 msg_Dbg( p_demux, "Override subtitle fps %f", f_fps );
172 /* Get or probe the type */
173 psz_type = var_CreateGetString( p_demux, "sub-type" );
176 for( p_detect = asa_det_first; p_detect; p_detect = p_detect->next )
178 if( !strcmp( p_detect->name, psz_type ) )
185 msg_Warn( p_demux, "unknown sub-type \"%s\"", psz_type );
190 /* Probe if unknown type */
196 msg_Dbg( p_demux, "autodetecting subtitle format" );
197 i_size = stream_Peek( p_demux->s, &p, 4096 );
201 msg_Warn( p_demux, "cannot process subtitles (no data?)" );
204 p_detect = asa_imports_detect( p, i_size );
209 msg_Err( p_demux, "failed to recognize subtitle type" );
215 msg_Err( p_demux, "detected %s subtitle format, no asa support", p_detect->name );
219 msg_Dbg( p_demux, "detected %s subtitle format", p_detect->name );
221 stream_Control( p_demux->s, STREAM_GET_SIZE, &i_ssize );
222 p_data = malloc( i_ssize );
228 if( stream_Read( p_demux->s, &p_data, i_ssize ) != i_ssize )
230 msg_Err( p_demux, "subtitle stream read error" );
235 asa_import( p_demux, p_data, i_ssize, p_sys->i_microsecperframe, p_detect,
239 msg_Dbg(p_demux, "loaded %d subtitles", p_sys->i_subtitles );
241 /* Fix subtitle (order and time) *** */
243 p_sys->i_subtitle = 0;
245 if( p_sys->i_subtitles > 0 )
247 p_sys->i_length = p_sys->subtitle[p_sys->i_subtitles-1].i_stop;
249 if( p_sys->i_length <= 0 )
250 p_sys->i_length = p_sys->subtitle[p_sys->i_subtitles-1].i_start+1;
253 /* *** add subtitle ES *** */
254 if( p_detect->fmt->target == ASAI_TARGET_SSA )
256 es_format_Init( &fmt, SPU_ES, VLC_CODEC_SSA );
260 es_format_Init( &fmt, SPU_ES, VLC_CODEC_SUBT );
262 p_sys->es = es_out_Add( p_demux->out, &fmt );
267 /*****************************************************************************
268 * ProcessLine: Callback for asa_import, fed one line
269 * (note: return values are not kept. nonzero signals abort to asa_import)
270 *****************************************************************************/
271 static int ProcessLine( demux_t *p_demux, void *p_arg,
272 int64_t i_start, int64_t i_stop,
273 const char *p_buffer, size_t i_buffer_length )
275 demux_sys_t *p_sys = p_demux->p_sys;
276 subtitle_t *p_subtitle;
281 if( p_sys->i_subtitles >= p_sys->i_subs_alloc )
283 p_sys->i_subs_alloc += 500;
284 if( !( p_sys->subtitle = realloc_or_free( p_sys->subtitle,
285 sizeof(subtitle_t) * p_sys->i_subs_alloc ) ) )
290 p_subtitle = &p_sys->subtitle[p_sys->i_subtitles];
292 psz_text = malloc( i_buffer_length + 1 );
295 memcpy( psz_text, p_buffer, i_buffer_length );
296 psz_text[i_buffer_length] = '\0';
298 p_subtitle->i_start = i_start;
299 p_subtitle->i_stop = i_stop;
300 p_subtitle->psz_text = psz_text;
302 p_sys->i_subtitles++;
306 /*****************************************************************************
307 * Close: Close subtitle demux
308 *****************************************************************************/
309 static void Close( vlc_object_t *p_this )
311 demux_t *p_demux = (demux_t*)p_this;
312 demux_sys_t *p_sys = p_demux->p_sys;
315 for( i = 0; i < p_sys->i_subtitles; i++ )
316 free( p_sys->subtitle[i].psz_text );
317 free( p_sys->subtitle );
322 /*****************************************************************************
324 *****************************************************************************/
325 static int Control( demux_t *p_demux, int i_query, va_list args )
327 demux_sys_t *p_sys = p_demux->p_sys;
333 case DEMUX_GET_LENGTH:
334 pi64 = (int64_t*)va_arg( args, int64_t * );
335 *pi64 = p_sys->i_length;
339 pi64 = (int64_t*)va_arg( args, int64_t * );
340 if( p_sys->i_subtitle < p_sys->i_subtitles )
342 *pi64 = p_sys->subtitle[p_sys->i_subtitle].i_start;
348 i64 = (int64_t)va_arg( args, int64_t );
349 p_sys->i_subtitle = 0;
350 while( p_sys->i_subtitle < p_sys->i_subtitles &&
351 p_sys->subtitle[p_sys->i_subtitle].i_start < i64 )
356 if( p_sys->i_subtitle >= p_sys->i_subtitles )
360 case DEMUX_GET_POSITION:
361 pf = (double*)va_arg( args, double * );
362 if( p_sys->i_subtitle >= p_sys->i_subtitles )
366 else if( p_sys->i_subtitles > 0 )
368 *pf = (double)p_sys->subtitle[p_sys->i_subtitle].i_start /
369 (double)p_sys->i_length;
377 case DEMUX_SET_POSITION:
378 f = (double)va_arg( args, double );
379 i64 = f * p_sys->i_length;
381 p_sys->i_subtitle = 0;
382 while( p_sys->i_subtitle < p_sys->i_subtitles &&
383 p_sys->subtitle[p_sys->i_subtitle].i_start < i64 )
387 if( p_sys->i_subtitle >= p_sys->i_subtitles )
391 case DEMUX_SET_NEXT_DEMUX_TIME:
392 p_sys->i_next_demux_date = (int64_t)va_arg( args, int64_t );
397 case DEMUX_GET_ATTACHMENTS:
398 case DEMUX_GET_TITLE_INFO:
402 msg_Err( p_demux, "unknown query in subtitle control" );
407 /*****************************************************************************
408 * Demux: Send subtitle to decoder
409 *****************************************************************************/
410 static int Demux( demux_t *p_demux )
412 demux_sys_t *p_sys = p_demux->p_sys;
415 if( p_sys->i_subtitle >= p_sys->i_subtitles )
418 i_maxdate = p_sys->i_next_demux_date - var_GetTime( p_demux->p_parent, "spu-delay" );;
419 if( i_maxdate <= 0 && p_sys->i_subtitle < p_sys->i_subtitles )
421 /* Should not happen */
422 i_maxdate = p_sys->subtitle[p_sys->i_subtitle].i_start + 1;
425 while( p_sys->i_subtitle < p_sys->i_subtitles &&
426 p_sys->subtitle[p_sys->i_subtitle].i_start < i_maxdate )
429 int i_len = strlen( p_sys->subtitle[p_sys->i_subtitle].psz_text ) + 1;
438 if( ( p_block = block_New( p_demux, i_len ) ) == NULL )
444 if( p_sys->subtitle[p_sys->i_subtitle].i_start < 0 )
450 p_block->i_pts = p_sys->subtitle[p_sys->i_subtitle].i_start;
451 p_block->i_dts = p_block->i_pts;
452 if( p_sys->subtitle[p_sys->i_subtitle].i_stop > 0 )
455 p_sys->subtitle[p_sys->i_subtitle].i_stop - p_block->i_pts;
458 memcpy( p_block->p_buffer,
459 p_sys->subtitle[p_sys->i_subtitle].psz_text, i_len );
460 if( p_block->i_pts > 0 )
462 es_out_Send( p_demux->out, p_sys->es, p_block );
466 block_Release( p_block );
472 p_sys->i_next_demux_date = 0;
477 /*****************************************************************************
478 * Fix: fix time stamp and order of subtitle
479 *****************************************************************************/
480 static void Fix( demux_t *p_demux )
482 demux_sys_t *p_sys = p_demux->p_sys;
486 /* *** fix order (to be sure...) *** */
487 /* We suppose that there are near in order and this durty bubble sort
488 * wont take too much time
493 for( i_index = 1; i_index < p_sys->i_subtitles; i_index++ )
495 if( p_sys->subtitle[i_index].i_start <
496 p_sys->subtitle[i_index - 1].i_start )
500 p_sys->subtitle + i_index - 1,
501 sizeof( subtitle_t ) );
502 memcpy( p_sys->subtitle + i_index - 1,
503 p_sys->subtitle + i_index,
504 sizeof( subtitle_t ) );
505 memcpy( p_sys->subtitle + i_index,
507 sizeof( subtitle_t ) );