Changed subpicture_region_t->picture into a picture_t *
[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 <string.h>
33 #include <math.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_input.h>
41
42 #include <csri/csri.h>
43 #include <csri/stream.h>
44
45 /*****************************************************************************
46  * Module descriptor
47  *****************************************************************************/
48 static int  Create ( vlc_object_t * );
49 static void Destroy( vlc_object_t * );
50
51 vlc_module_begin();
52     set_shortname( N_("Subtitles (advanced)"));
53     set_description( N_("Wrapper for subtitle renderers using CSRI/asa") );
54     set_capability( "decoder", 60 );
55     set_category( CAT_INPUT );
56     set_subcategory( SUBCAT_INPUT_SCODEC );
57     set_callbacks( Create, Destroy );
58 vlc_module_end();
59
60 /*****************************************************************************
61  * Local prototypes
62  *****************************************************************************/
63 static subpicture_t *DecodeBlock( decoder_t *, block_t ** );
64 static void DestroySubpicture( subpicture_t * );
65 static void PreRender( spu_t *, subpicture_t *, const video_format_t * );
66 static void UpdateRegions( spu_t *, subpicture_t *,
67                            const video_format_t *,  mtime_t );
68
69 /*****************************************************************************
70  * decoder_sys_t: decoder data
71  *****************************************************************************/
72 struct decoder_sys_t
73 {
74     subpicture_t *p_spu_final;
75     video_format_t fmt_cached;
76     csri_inst *p_instance;
77
78     struct csri_stream_ext *p_stream_ext;
79
80     void (*pf_push_packet)(csri_inst *inst, const void *packet,
81                            size_t packetlen, double pts_start,
82                            double pts_end);
83 };
84
85 struct subpicture_sys_t
86 {
87     decoder_t *p_dec;
88     void *p_subs_data;
89     int i_subs_len;
90 };
91
92 /*****************************************************************************
93  * Create: Open CSRI renderer
94  *****************************************************************************
95  * Comment me.
96  *****************************************************************************/
97 static int Create( vlc_object_t *p_this )
98 {
99     decoder_t *p_dec = (decoder_t *)p_this;
100     decoder_sys_t *p_sys;
101     csri_rend *p_render;
102     struct csri_stream_ext *p_stream_ext;
103
104     if( p_dec->fmt_in.i_codec != VLC_FOURCC('s','s','a',' ') )
105         return VLC_EGENERIC;
106
107     p_render = csri_renderer_default();
108     if (!p_render)
109     {
110         msg_Err( p_dec, "can't load csri renderer" );
111         return VLC_EGENERIC;
112     }
113     p_stream_ext = csri_query_ext(p_render, CSRI_EXT_STREAM_ASS);
114     if (!p_stream_ext)
115     {
116         msg_Err( p_dec, "csri renderer does not support ASS streaming" );
117         return VLC_EGENERIC;
118     }
119
120     p_dec->pf_decode_sub = DecodeBlock;
121
122     p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
123     if( !p_sys )
124         return VLC_ENOMEM;
125     memset( &p_sys->fmt_cached, 0, sizeof( p_sys->fmt_cached ) );
126
127     p_sys->p_stream_ext = p_stream_ext;
128     p_sys->pf_push_packet = p_stream_ext->push_packet;
129     p_sys->p_instance = p_stream_ext->init_stream( p_render,
130                                                    p_dec->fmt_in.p_extra,
131                                                    p_dec->fmt_in.p_extra ? strnlen( p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra ) : 0,
132                                                    NULL);
133     return VLC_SUCCESS;
134 }
135
136 /*****************************************************************************
137  * Destroy: finish
138  *****************************************************************************
139  * Comment me.
140  *****************************************************************************/
141 static void Destroy( vlc_object_t *p_this )
142 {
143     decoder_t *p_dec = (decoder_t *)p_this;
144     decoder_sys_t *p_sys = p_dec->p_sys;
145
146     if( p_sys->p_stream_ext->discard )
147         p_sys->p_stream_ext->discard( p_sys->p_instance, true );
148     free( p_sys );
149 }
150
151 /****************************************************************************
152  * DecodeBlock: the whole thing
153  ****************************************************************************
154  * This function must be fed with complete subtitles units.
155  ****************************************************************************/
156 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
157 {
158     decoder_sys_t *p_sys = p_dec->p_sys;
159
160     subpicture_t *p_spu = NULL;
161     block_t *p_block;
162
163     //msg_Dbg( p_dec, "DecodeBlock %p", (void *)pp_block);
164     if( !pp_block || *pp_block == NULL )
165         return NULL;
166
167     p_block = *pp_block;
168     if( p_block->i_rate != 0 )
169         p_block->i_length = p_block->i_length * p_block->i_rate / INPUT_RATE_DEFAULT;
170     *pp_block = NULL;
171
172     if( p_block->i_buffer == 0 || p_block->p_buffer[0] == '\0' )
173     {
174         block_Release( p_block );
175         return NULL;
176     }
177
178     p_spu = p_dec->pf_spu_buffer_new( p_dec );
179     if( !p_spu )
180     {
181         msg_Warn( p_dec, "can't get spu buffer" );
182         block_Release( p_block );
183         return NULL;
184     }
185
186     p_spu->p_sys = malloc( sizeof( subpicture_sys_t ));
187     if( !p_spu->p_sys )
188     {
189         p_dec->pf_spu_buffer_del( p_dec, p_spu );
190         block_Release( p_block );
191         return NULL;
192     }
193     p_spu->p_sys->p_dec = p_dec;
194
195     p_spu->p_sys->i_subs_len = p_block->i_buffer;
196     p_spu->p_sys->p_subs_data = malloc( p_block->i_buffer );
197     if( !p_spu->p_sys->p_subs_data )
198     {
199         free( p_spu->p_sys );
200         p_dec->pf_spu_buffer_del( p_dec, p_spu );
201         block_Release( p_block );
202         return NULL;
203     }
204     memcpy( p_spu->p_sys->p_subs_data, p_block->p_buffer,
205             p_block->i_buffer );
206
207     p_spu->i_start = p_block->i_pts;
208     p_spu->i_stop = p_block->i_pts + p_block->i_length;
209     p_spu->b_ephemer = false;
210     p_spu->b_absolute = false;
211
212     //msg_Dbg( p_dec, "BS %lf..%lf", p_spu->i_start * 0.000001, p_spu->i_stop * 0.000001);
213     p_sys->pf_push_packet( p_sys->p_instance,
214                            p_spu->p_sys->p_subs_data, p_spu->p_sys->i_subs_len,
215                            p_spu->i_start * 0.000001,
216                            p_spu->i_stop * 0.000001);
217
218     p_spu->pf_pre_render = PreRender;
219     p_spu->pf_update_regions = UpdateRegions;
220     p_spu->pf_destroy = DestroySubpicture;
221
222     block_Release( p_block );
223
224     return p_spu;
225 }
226
227 static void DestroySubpicture( subpicture_t *p_subpic )
228 {
229     //msg_Dbg( p_subpic->p_sys->p_dec, "drop spu %p", (void *)p_subpic );
230     free( p_subpic->p_sys->p_subs_data );
231     free( p_subpic->p_sys );
232 }
233
234 static void PreRender( spu_t *p_spu, subpicture_t *p_subpic,
235                        const video_format_t *p_fmt )
236 {
237     decoder_t *p_dec = p_subpic->p_sys->p_dec;
238     p_dec->p_sys->p_spu_final = p_subpic;
239     VLC_UNUSED(p_fmt);
240     VLC_UNUSED(p_spu);
241 }
242
243 static void UpdateRegions( spu_t *p_spu, subpicture_t *p_subpic,
244                            const video_format_t *p_fmt, mtime_t ts )
245 {
246     decoder_t *p_dec = p_subpic->p_sys->p_dec;
247     decoder_sys_t *p_sys = p_dec->p_sys;
248
249     subpicture_region_t *p_spu_region;
250     video_format_t fmt;
251
252     /* TODO maybe checking if we really need redrawing */
253     while( p_subpic->p_region )
254     {
255         subpicture_region_t *p_region = p_subpic->p_region;
256         p_subpic->p_region = p_region->p_next;
257         spu_DestroyRegion( p_spu, p_region );
258     }
259     p_subpic->p_region = NULL;
260
261     /* FIXME check why this is needed */
262     if( p_subpic != p_sys->p_spu_final )
263         return;
264
265 #if 0
266     msg_Warn( p_dec, "---- fmt: %dx%d %dx%d chroma=%4.4s",
267             p_fmt->i_width, p_fmt->i_height,
268             p_fmt->i_visible_width, p_fmt->i_visible_height,
269             (const char*)&p_fmt->i_chroma );
270 #endif
271     /* XXX On x86 at least our RGBA is mapped to their BGRA
272      * TODO confirm that is the same on big endian cpu */
273     fmt = *p_fmt;
274     fmt.i_chroma = VLC_FOURCC('R','G','B','A');
275     fmt.i_width = fmt.i_visible_width;
276     fmt.i_height = fmt.i_visible_height;
277     fmt.i_bits_per_pixel = 0;
278     fmt.i_x_offset = fmt.i_y_offset = 0;
279     fmt.i_sar_num = 1;
280     fmt.i_sar_den = 1;
281
282     if( memcmp(&fmt, &p_sys->fmt_cached, sizeof(fmt)) )
283     {
284         //msg_Warn( p_dec, "---- fmt: new %dx%d", fmt.i_width, fmt.i_height );
285
286         struct csri_fmt csri_fmt;
287         memset(&csri_fmt, 0, sizeof(csri_fmt));
288         csri_fmt.pixfmt = CSRI_F_BGRA;
289         csri_fmt.width = fmt.i_width;
290         csri_fmt.height = fmt.i_height;
291         if( csri_request_fmt( p_sys->p_instance, &csri_fmt ) )
292             msg_Dbg( p_dec, "csri error: format not supported" );
293
294         p_sys->fmt_cached = fmt;
295     }
296
297     p_subpic->i_original_picture_height = fmt.i_height;
298     p_subpic->i_original_picture_width = fmt.i_width;
299
300     p_spu_region = p_subpic->p_region = p_subpic->pf_create_region( VLC_OBJECT(p_dec), &fmt );
301
302     if( p_spu_region )
303     {
304         struct csri_frame csri_frame;
305
306         /* */
307         p_spu_region->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
308         memset( p_spu_region->p_picture->Y_PIXELS, 0x00, p_spu_region->p_picture->Y_PITCH * p_sys->fmt_cached.i_height );
309
310         /* */
311         //msg_Dbg( p_dec, "TS %lf", ts * 0.000001 );
312         memset( &csri_frame, 0, sizeof(csri_frame) );
313         csri_frame.pixfmt = CSRI_F_BGRA;
314         csri_frame.planes[0] = (unsigned char*)p_spu_region->p_picture->Y_PIXELS;
315         csri_frame.strides[0] = p_spu_region->p_picture->Y_PITCH;
316         csri_render( p_sys->p_instance, &csri_frame, ts * 0.000001 );
317     }
318 }
319