Fixed subtitle duration when rate != default.
[vlc.git] / modules / codec / csri.c
1 /*****************************************************************************
2  * csri.c : Load CSRI subtitle renderer
3  *****************************************************************************
4  * Copyright (C) 2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: David Lamparter <equinox@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27
28 #ifdef HAVE_CONFIG_H
29 #   include "config.h"
30 #endif
31
32 #include <stdlib.h>
33 #include <string.h>
34
35 #include <vlc_common.h>
36 #include <vlc_plugin.h>
37 #include <vlc_vout.h>
38 #include <vlc_codec.h>
39 #include <vlc_osd.h>
40 #include <vlc_block.h>
41 #include <vlc_filter.h>
42 #include <vlc_stream.h>
43 #include <vlc_input.h>
44 #include <vlc_xml.h>
45
46 #include <math.h>
47
48 #ifdef HAVE_ERRNO_H
49 #   include <errno.h>
50 #endif
51
52 #include <csri/csri.h>
53 #include <csri/stream.h>
54
55 /*****************************************************************************
56  * Module descriptor
57  *****************************************************************************/
58 static int  Create ( vlc_object_t * );
59 static void Destroy( vlc_object_t * );
60
61 vlc_module_begin();
62     set_shortname( N_("Subtitles (advanced)"));
63     set_description( N_("Wrapper for subtitle renderers using CSRI/asa") );
64     set_capability( "decoder", 60 );
65     set_category( CAT_INPUT );
66     set_subcategory( SUBCAT_INPUT_SCODEC );
67     set_callbacks( Create, Destroy );
68 vlc_module_end();
69
70 /*****************************************************************************
71  * Local prototypes
72  *****************************************************************************/
73 static subpicture_t *DecodeBlock( decoder_t *, block_t ** );
74 static void DestroySubpicture( subpicture_t * );
75 static void PreRender( video_format_t *, spu_t *, subpicture_t *, mtime_t );
76 static subpicture_region_t *UpdateRegions( video_format_t *, spu_t *,
77                                            subpicture_t *, mtime_t );
78
79 /*****************************************************************************
80  * decoder_sys_t: decoder data
81  *****************************************************************************/
82 struct decoder_sys_t
83 {
84     subpicture_t *p_spu_final;
85     video_format_t fmt_cached;
86     csri_inst *p_instance;
87
88     struct csri_stream_ext *p_stream_ext;
89
90     void (*pf_push_packet)(csri_inst *inst, const void *packet,
91                            size_t packetlen, double pts_start,
92                            double pts_end);
93 };
94
95 struct subpicture_sys_t
96 {
97     decoder_t *p_dec;
98     void *p_subs_data;
99     int i_subs_len;
100 };
101
102 /*****************************************************************************
103  * Create: Open CSRI renderer
104  *****************************************************************************
105  * Comment me.
106  *****************************************************************************/
107 static int Create( vlc_object_t *p_this )
108 {
109     decoder_t *p_dec = (decoder_t *)p_this;
110     decoder_sys_t *p_sys;
111     csri_rend *p_render;
112     struct csri_stream_ext *p_stream_ext;
113
114     if( p_dec->fmt_in.i_codec != VLC_FOURCC('s','s','a',' ') )
115         return VLC_EGENERIC;
116
117     p_render = csri_renderer_default();
118     if (!p_render)
119     {
120         msg_Err( p_dec, "can't load csri renderer" );
121         return VLC_EGENERIC;
122     }
123     p_stream_ext = csri_query_ext(p_render, CSRI_EXT_STREAM_ASS);
124     if (!p_stream_ext)
125     {
126         msg_Err( p_dec, "csri renderer does not support ASS streaming" );
127         return VLC_EGENERIC;
128     }
129
130     p_dec->pf_decode_sub = DecodeBlock;
131
132     p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
133     if( !p_sys )
134         return VLC_ENOMEM;
135     memset( &p_sys->fmt_cached, 0, sizeof( p_sys->fmt_cached ) );
136
137     p_sys->p_stream_ext = p_stream_ext;
138     p_sys->pf_push_packet = p_stream_ext->push_packet;
139     p_sys->p_instance = p_stream_ext->init_stream( p_render,
140                                                    p_dec->fmt_in.p_extra,
141                                                    p_dec->fmt_in.p_extra ? strnlen( p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra ) : 0,
142                                                    NULL);
143     return VLC_SUCCESS;
144 }
145
146 /*****************************************************************************
147  * Destroy: finish
148  *****************************************************************************
149  * Comment me.
150  *****************************************************************************/
151 static void Destroy( vlc_object_t *p_this )
152 {
153     decoder_t *p_dec = (decoder_t *)p_this;
154     decoder_sys_t *p_sys = p_dec->p_sys;
155
156     if( p_sys->p_stream_ext->discard )
157         p_sys->p_stream_ext->discard( p_sys->p_instance, true );
158     free( p_sys );
159 }
160
161 /****************************************************************************
162  * DecodeBlock: the whole thing
163  ****************************************************************************
164  * This function must be fed with complete subtitles units.
165  ****************************************************************************/
166 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
167 {
168     decoder_sys_t *p_sys = p_dec->p_sys;
169
170     subpicture_t *p_spu = NULL;
171     block_t *p_block;
172
173     //msg_Dbg( p_dec, "DecodeBlock %p", (void *)pp_block);
174     if( !pp_block || *pp_block == NULL )
175         return NULL;
176
177     p_block = *pp_block;
178     if( p_block->i_rate != 0 )
179         p_block->i_length = p_block->i_length * p_block->i_rate / INPUT_RATE_DEFAULT;
180     *pp_block = NULL;
181
182     if( p_block->i_buffer == 0 || p_block->p_buffer[0] == '\0' )
183     {
184         block_Release( p_block );
185         return NULL;
186     }
187
188     p_spu = p_dec->pf_spu_buffer_new( p_dec );
189     if( !p_spu )
190     {
191         msg_Warn( p_dec, "can't get spu buffer" );
192         block_Release( p_block );
193         return NULL;
194     }
195
196     p_spu->p_sys = malloc( sizeof( subpicture_sys_t ));
197     if( !p_spu->p_sys )
198     {
199         p_dec->pf_spu_buffer_del( p_dec, p_spu );
200         block_Release( p_block );
201         return NULL;
202     }
203     p_spu->p_sys->p_dec = p_dec;
204
205     p_spu->p_sys->i_subs_len = p_block->i_buffer;
206     p_spu->p_sys->p_subs_data = malloc( p_block->i_buffer );
207     if( !p_spu->p_sys->p_subs_data )
208     {
209         free( p_spu->p_sys );
210         p_dec->pf_spu_buffer_del( p_dec, p_spu );
211         block_Release( p_block );
212         return NULL;
213     }
214     memcpy( p_spu->p_sys->p_subs_data, p_block->p_buffer,
215             p_block->i_buffer );
216
217     p_spu->i_x = 0;
218     p_spu->i_y = 0;
219     p_spu->i_start = p_block->i_pts;
220     p_spu->i_stop = p_block->i_pts + p_block->i_length;
221     p_spu->b_ephemer = false;
222     p_spu->b_absolute = false;
223     p_spu->b_pausable = true;
224
225     //msg_Dbg( p_dec, "BS %lf..%lf", p_spu->i_start * 0.000001, p_spu->i_stop * 0.000001);
226     p_sys->pf_push_packet( p_sys->p_instance,
227                            p_spu->p_sys->p_subs_data, p_spu->p_sys->i_subs_len,
228                            p_spu->i_start * 0.000001,
229                            p_spu->i_stop * 0.000001);
230
231     p_spu->pf_pre_render = PreRender;
232     p_spu->pf_update_regions = UpdateRegions;
233     p_spu->pf_destroy = DestroySubpicture;
234
235     block_Release( p_block );
236
237     return p_spu;
238 }
239
240 static void DestroySubpicture( subpicture_t *p_subpic )
241 {
242     //msg_Dbg( p_subpic->p_sys->p_dec, "drop spu %p", (void *)p_subpic );
243     free( p_subpic->p_sys->p_subs_data );
244     free( p_subpic->p_sys );
245 }
246
247 static void PreRender( video_format_t *p_fmt, spu_t *p_spu,
248                        subpicture_t *p_subpic, mtime_t ts )
249 {
250     decoder_t *p_dec = p_subpic->p_sys->p_dec;
251     p_dec->p_sys->p_spu_final = p_subpic;
252 }
253
254 static subpicture_region_t *UpdateRegions( video_format_t *p_fmt, spu_t *p_spu,
255                                            subpicture_t *p_subpic, mtime_t ts )
256 {
257     decoder_t *p_dec = p_subpic->p_sys->p_dec;
258     decoder_sys_t *p_sys = p_dec->p_sys;
259
260     subpicture_region_t *p_spu_region;
261     video_format_t fmt;
262
263     if( p_subpic != p_sys->p_spu_final )
264         return NULL;
265
266 #if 0
267     msg_Warn( p_dec, "---- fmt: %dx%d %dx%d chroma=%4.4s",
268             p_fmt->i_width, p_fmt->i_height,
269             p_fmt->i_visible_width, p_fmt->i_visible_height,
270             (const char*)&p_fmt->i_chroma );
271 #endif
272     /* XXX On x86 at least our RGBA is mapped to their BGRA
273      * TODO confirm that is the same on big endian cpu */
274     fmt = *p_fmt;
275     fmt.i_chroma = VLC_FOURCC('R','G','B','A');
276     fmt.i_width = fmt.i_visible_width;
277     fmt.i_height = fmt.i_visible_height;
278     fmt.i_bits_per_pixel = 0;
279     fmt.i_x_offset = fmt.i_y_offset = 0;
280     fmt.i_sar_num = 1;
281     fmt.i_sar_den = 1;
282
283     if( memcmp(&fmt, &p_sys->fmt_cached, sizeof(fmt)) )
284     {
285         //msg_Warn( p_dec, "---- fmt: new %dx%d", fmt.i_width, fmt.i_height );
286
287         struct csri_fmt csri_fmt;
288         memset(&csri_fmt, 0, sizeof(csri_fmt));
289         csri_fmt.pixfmt = CSRI_F_BGRA;
290         csri_fmt.width = fmt.i_width;
291         csri_fmt.height = fmt.i_height;
292         if( csri_request_fmt( p_sys->p_instance, &csri_fmt ) )
293             msg_Dbg( p_dec, "csri error: format not supported" );
294
295         p_sys->fmt_cached = fmt;
296     }
297
298     p_subpic->i_original_picture_height = fmt.i_height;
299     p_subpic->i_original_picture_width = fmt.i_width;
300
301     p_spu_region = p_subpic->pf_create_region( VLC_OBJECT(p_dec), &fmt );
302
303     if( p_spu_region )
304     {
305         struct csri_frame csri_frame;
306
307         /* */
308         p_spu_region->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
309         memset( p_spu_region->picture.Y_PIXELS, 0x00, p_spu_region->picture.Y_PITCH * p_sys->fmt_cached.i_height );
310
311         /* */
312         //msg_Dbg( p_dec, "TS %lf", ts * 0.000001 );
313         memset( &csri_frame, 0, sizeof(csri_frame) );
314         csri_frame.pixfmt = CSRI_F_BGRA;
315         csri_frame.planes[0] = (unsigned char*)p_spu_region->picture.Y_PIXELS;
316         csri_frame.strides[0] = p_spu_region->picture.Y_PITCH;
317         csri_render( p_sys->p_instance, &csri_frame, ts * 0.000001 );
318     }
319     return p_spu_region;
320 }
321