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
10 * Author: Andre Pang <Andre.Pang@csiro.au>
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.
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.
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 *****************************************************************************/
27 /*****************************************************************************
29 *****************************************************************************/
31 #include <vlc_input.h>
32 #include <vlc_codec.h>
34 #include <vlc_charset.h>
35 #include <vlc_interface.h>
40 /*****************************************************************************
41 * decoder_sys_t : decoder descriptor
42 *****************************************************************************/
45 intf_thread_t * p_intf;
48 /*****************************************************************************
50 *****************************************************************************/
51 static int OpenDecoder ( vlc_object_t * );
52 static void CloseDecoder ( vlc_object_t * );
54 static subpicture_t *DecodeBlock ( decoder_t *, block_t ** );
56 static void ParseText ( decoder_t *, block_t * );
58 /*****************************************************************************
60 *****************************************************************************/
61 int E_(OpenIntf) ( vlc_object_t * );
62 void E_(CloseIntf) ( vlc_object_t * );
64 /*****************************************************************************
66 *****************************************************************************/
68 set_description( _("CMML annotations decoder") );
69 set_capability( "decoder", 50 );
70 set_callbacks( OpenDecoder, CloseDecoder );
71 add_shortcut( "cmml" );
74 set_capability( "interface", 0 );
75 set_callbacks( E_(OpenIntf), E_(CloseIntf) );
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
83 *****************************************************************************/
84 static int OpenDecoder( vlc_object_t *p_this )
86 decoder_t *p_dec = (decoder_t*)p_this;
87 input_thread_t * p_input;
91 if( p_dec->fmt_in.i_codec != VLC_FOURCC('c','m','m','l') )
96 p_dec->pf_decode_sub = DecodeBlock;
99 msg_Dbg( p_dec, "i am at %p", p_dec );
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 )
106 msg_Err( p_dec, "out of memory" );
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 );
117 msg_Dbg( p_dec, "p_input is at %p", p_input );
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 )
124 msg_Dbg( p_dec, "var_Set of has-cmml-decoder failed" );
126 vlc_object_release( p_input );
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 );
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 )
144 if( !pp_block || *pp_block == NULL )
149 ParseText( p_dec, *pp_block );
151 block_Release( *pp_block );
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
158 p_spu = p_dec->pf_spu_buffer_new( p_dec );
161 msg_Dbg( p_dec, "couldn't allocate new subpicture" );
168 /*****************************************************************************
169 * CloseDecoder: clean up the decoder
170 *****************************************************************************/
171 static void CloseDecoder( vlc_object_t *p_this )
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;
177 /* Destroy the interface object/thread */
178 p_intf = vlc_object_find( p_dec, VLC_OBJECT_INTF, FIND_CHILD );
182 msg_Dbg( p_dec, "CMML decoder is freeing interface thread" );
184 intf_StopThread( p_intf );
185 vlc_object_detach( p_intf );
186 vlc_object_release( p_intf );
187 intf_Destroy( p_intf );
190 p_sys->p_intf = NULL;
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 )
200 char *psz_subtitle, *psz_cmml, *psz_url;
201 XTag *p_clip_parser, *p_anchor;
204 /* We cannot display a subpicture with no date */
205 if( p_block->i_pts == 0 )
207 msg_Warn( p_dec, "subtitle without a date" );
211 /* Check validity of packet data */
212 if( p_block->i_buffer <= 1 || p_block->p_buffer[0] == '\0' )
214 msg_Warn( p_dec, "empty subtitle" );
218 /* get anchor text from CMML */
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 )
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 */
227 msg_Dbg( p_dec, "psz_cmml is \"%s\"", psz_cmml );
230 /* Parse the <clip> part of the CMML */
231 p_clip_parser = xtag_new_parse( psz_cmml, p_block->i_buffer );
234 msg_Warn( p_dec, "couldn't initialise <clip> parser" );
239 /* Parse the anchor tag and get its contents */
240 p_anchor = xtag_first_child( p_clip_parser, "a" );
241 if( p_anchor != NULL )
243 psz_subtitle = xtag_get_pcdata( p_anchor );
247 psz_subtitle = strdup( " " );
251 msg_Dbg( p_dec, "psz_subtitle is \"%s\"", psz_subtitle );
254 /* get URL from the current clip, if one exists */
255 psz_url = xtag_get_attribute( p_anchor, "href" );
257 msg_Dbg( p_dec, "psz_url is \"%s\"", psz_url );
261 char *psz_tmp = strdup( psz_url );
263 val.p_address = psz_tmp;
264 if( var_Set( p_dec, "psz-current-anchor-url", val ) != VLC_SUCCESS )
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" );
276 char *psz_tmp = strdup( psz_subtitle );
278 val.p_address = psz_tmp;
279 if( var_Set( p_dec, "psz-current-anchor-description", val ) != VLC_SUCCESS )
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" );
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 );