]> git.sesse.net Git - vlc/blob - modules/codec/cmml/cmml.c
Remove interface b_block property.
[vlc] / modules / codec / cmml / cmml.c
1 /*****************************************************************************
2  * cmml.c : CMML annotations/metadata decoder
3  *****************************************************************************
4  * Copyright (C) 2003-2004 Commonwealth Scientific and Industrial Research
5  *                         Organisation (CSIRO) Australia
6  * Copyright (C) 2004 the VideoLAN team
7  *
8  * $Id$
9  *
10  * Author: Andre Pang <Andre.Pang@csiro.au>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 /*****************************************************************************
28  * Preamble
29  *****************************************************************************/
30 #include <vlc/vlc.h>
31 #include <vlc_input.h>
32 #include <vlc_codec.h>
33 #include <vlc_osd.h>
34 #include <vlc_charset.h>
35 #include <vlc_interface.h>
36 #include "xtag.h"
37
38 #undef  CMML_DEBUG
39
40 /*****************************************************************************
41  * decoder_sys_t : decoder descriptor
42  *****************************************************************************/
43 struct decoder_sys_t
44 {
45     intf_thread_t *     p_intf;
46 };
47
48 /*****************************************************************************
49  * Local prototypes
50  *****************************************************************************/
51 static int           OpenDecoder   ( vlc_object_t * );
52 static void          CloseDecoder  ( vlc_object_t * );
53
54 static subpicture_t *DecodeBlock   ( decoder_t *, block_t ** );
55
56 static void          ParseText     ( decoder_t *, block_t * );
57
58 /*****************************************************************************
59  * Exported prototypes
60  *****************************************************************************/
61 int  E_(OpenIntf)  ( vlc_object_t * );
62 void E_(CloseIntf) ( vlc_object_t * );
63
64 /*****************************************************************************
65  * Module descriptor.
66  *****************************************************************************/
67 vlc_module_begin();
68     set_description( _("CMML annotations decoder") );
69     set_capability( "decoder", 50 );
70     set_callbacks( OpenDecoder, CloseDecoder );
71     add_shortcut( "cmml" );
72
73     add_submodule();
74         set_capability( "interface", 0 );
75         set_callbacks( E_(OpenIntf), E_(CloseIntf) );
76 vlc_module_end();
77
78 /*****************************************************************************
79  * OpenDecoder: probe the decoder and return score
80  *****************************************************************************
81  * Tries to launch a decoder and return score so that the interface is able
82  * to chose.
83  *****************************************************************************/
84 static int OpenDecoder( vlc_object_t *p_this )
85 {
86     decoder_t *p_dec = (decoder_t*)p_this;
87     input_thread_t * p_input;
88     decoder_sys_t *p_sys;
89     vlc_value_t val;
90
91     if( p_dec->fmt_in.i_codec != VLC_FOURCC('c','m','m','l') )
92     {
93         return VLC_EGENERIC;
94     }
95
96     p_dec->pf_decode_sub = DecodeBlock;
97
98 #ifdef CMML_DEBUG
99     msg_Dbg( p_dec, "i am at %p", p_dec );
100 #endif
101
102     /* Allocate the memory needed to store the decoder's structure */
103     if( ( p_dec->p_sys = p_sys =
104           (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
105     {
106         msg_Err( p_dec, "out of memory" );
107         return VLC_EGENERIC;
108     }
109
110     /* Let other interested modules know that we're a CMML decoder
111      * We have to set this variable on the input thread, because there's
112      * typically more than one decoder running so we can't find the CMML
113      * decoder succesfully with vlc_object_find.  (Any hints on how to achieve
114      * this would be rather appreciated ;) */
115     p_input = vlc_object_find( p_dec, VLC_OBJECT_INPUT, FIND_ANYWHERE );
116 #ifdef CMML_DEBUG
117     msg_Dbg( p_dec, "p_input is at %p", p_input );
118 #endif
119     val.p_address = p_dec;
120     var_Create( p_input, "has-cmml-decoder",
121                 VLC_VAR_ADDRESS|VLC_VAR_DOINHERIT );
122     if( var_Set( p_input, "has-cmml-decoder", val ) != VLC_SUCCESS )
123     {
124         msg_Dbg( p_dec, "var_Set of has-cmml-decoder failed" );
125     }
126     vlc_object_release( p_input );
127
128     /* initialise the CMML responder interface */
129     p_sys->p_intf = intf_Create( p_dec, "cmml", 0, NULL );
130     intf_RunThread( p_sys->p_intf );
131
132     return VLC_SUCCESS;
133 }
134
135 /****************************************************************************
136  * DecodeBlock: the whole thing
137  ****************************************************************************
138  * This function must be fed with complete subtitles units.
139  ****************************************************************************/
140 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
141 {
142     subpicture_t *p_spu;
143
144     if( !pp_block || *pp_block == NULL )
145     {
146         return NULL;
147     }
148
149     ParseText( p_dec, *pp_block );
150
151     block_Release( *pp_block );
152     *pp_block = NULL;
153
154     /* allocate an empty subpicture to return.  the actual subpicture
155      * displaying is done in the DisplayAnchor function in intf.c (called from
156      * DisplayPendingAnchor, which in turn is called from the main RunIntf
157      * loop). */
158     p_spu = p_dec->pf_spu_buffer_new( p_dec );
159     if( !p_spu )
160     {
161         msg_Dbg( p_dec, "couldn't allocate new subpicture" );
162         return NULL;
163     }
164
165     return p_spu;
166 }
167
168 /*****************************************************************************
169  * CloseDecoder: clean up the decoder
170  *****************************************************************************/
171 static void CloseDecoder( vlc_object_t *p_this )
172 {
173     decoder_t *p_dec = (decoder_t *)p_this;
174     decoder_sys_t *p_sys = p_dec->p_sys;
175     intf_thread_t *p_intf;
176
177     /* Destroy the interface object/thread */
178     p_intf = vlc_object_find( p_dec, VLC_OBJECT_INTF, FIND_CHILD );
179     if( p_intf != NULL )
180     {
181 #ifdef CMML_DEBUG
182         msg_Dbg( p_dec, "CMML decoder is freeing interface thread" );
183 #endif
184         intf_StopThread( p_intf );
185         vlc_object_detach( p_intf );
186         vlc_object_release( p_intf );
187         intf_Destroy( p_intf );
188     }
189
190     p_sys->p_intf = NULL;
191
192     free( p_sys );
193 }
194
195 /*****************************************************************************
196  * ParseText: parse an text subtitle packet and send it to the video output
197  *****************************************************************************/
198 static void ParseText( decoder_t *p_dec, block_t *p_block )
199 {
200     char *psz_subtitle, *psz_cmml, *psz_url;
201     XTag *p_clip_parser, *p_anchor;
202     vlc_value_t val;
203
204     /* We cannot display a subpicture with no date */
205     if( p_block->i_pts == 0 )
206     {
207         msg_Warn( p_dec, "subtitle without a date" );
208         return;
209     }
210
211     /* Check validity of packet data */
212     if( p_block->i_buffer <= 1 ||  p_block->p_buffer[0] == '\0' )
213     {
214         msg_Warn( p_dec, "empty subtitle" );
215         return;
216     }
217
218     /* get anchor text from CMML */
219
220     /* Copy the whole CMML tag into our own buffer:
221        allocate i_buffer bytes + 1 for the terminating \0 */
222     if ( (psz_cmml = malloc( p_block->i_buffer + 1 )) == NULL )
223         return;
224     psz_cmml = memcpy( psz_cmml, p_block->p_buffer, p_block->i_buffer );
225     psz_cmml[p_block->i_buffer] = '\0'; /* terminate the string */
226 #ifdef CMML_DEBUG
227     msg_Dbg( p_dec, "psz_cmml is \"%s\"", psz_cmml );
228 #endif
229  
230     /* Parse the <clip> part of the CMML */
231     p_clip_parser = xtag_new_parse( psz_cmml, p_block->i_buffer );
232     if( !p_clip_parser )
233     {
234         msg_Warn( p_dec, "couldn't initialise <clip> parser" );
235         free( psz_cmml );
236         return;
237     }
238
239     /* Parse the anchor tag and get its contents */
240     p_anchor = xtag_first_child( p_clip_parser, "a" );
241     if( p_anchor != NULL )
242     {
243         psz_subtitle = xtag_get_pcdata( p_anchor );
244     }
245     else
246     {
247         psz_subtitle = strdup( " " );
248     }
249
250 #ifdef CMML_DEBUG
251     msg_Dbg( p_dec, "psz_subtitle is \"%s\"", psz_subtitle );
252 #endif
253
254     /* get URL from the current clip, if one exists */
255     psz_url = xtag_get_attribute( p_anchor, "href" );
256 #ifdef CMML_DEBUG
257     msg_Dbg( p_dec, "psz_url is \"%s\"", psz_url );
258 #endif
259     if( psz_url )
260     {
261         char *psz_tmp = strdup( psz_url );
262  
263         val.p_address = psz_tmp;
264         if( var_Set( p_dec, "psz-current-anchor-url", val ) != VLC_SUCCESS )
265         {
266             (void) var_Create( p_dec, "psz-current-anchor-url",
267                                VLC_VAR_ADDRESS|VLC_VAR_DOINHERIT );
268             msg_Dbg( p_dec, "creating psz-current-anchor-url" );
269             if( var_Set( p_dec, "psz-current-anchor-url", val ) != VLC_SUCCESS )
270                 msg_Dbg( p_dec, "var_Set of psz-current-anchor-url failed" );
271         }
272     }
273
274     if( psz_subtitle )
275     {
276         char *psz_tmp = strdup( psz_subtitle );
277
278         val.p_address = psz_tmp;
279         if( var_Set( p_dec, "psz-current-anchor-description", val ) != VLC_SUCCESS )
280         {
281             (void) var_Create( p_dec, "psz-current-anchor-description",
282                                VLC_VAR_ADDRESS|VLC_VAR_DOINHERIT );
283             msg_Dbg( p_dec, "creating psz-current-anchor-description" );
284             if( var_Set( p_dec, "psz-current-anchor-description", val ) != VLC_SUCCESS )
285                 msg_Dbg( p_dec, "var_Set of psz-current-anchor-description failed" );
286         }
287
288     }
289
290     if( psz_subtitle ) free( psz_subtitle );
291     if( psz_cmml ) free( psz_cmml );
292     if( p_anchor ) free( p_anchor );
293     if( p_clip_parser ) free( p_clip_parser );
294     if( psz_url ) free( psz_url );
295 }
296