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 *****************************************************************************/
35 #include <vlc_plugin.h>
36 #include <vlc_input.h>
37 #include <vlc_codec.h>
39 #include <vlc_charset.h>
40 #include <vlc_interface.h>
45 /*****************************************************************************
46 * decoder_sys_t : decoder descriptor
47 *****************************************************************************/
50 intf_thread_t * p_intf;
53 /*****************************************************************************
55 *****************************************************************************/
56 static int OpenDecoder ( vlc_object_t * );
57 static void CloseDecoder ( vlc_object_t * );
59 static subpicture_t *DecodeBlock ( decoder_t *, block_t ** );
61 static void ParseText ( decoder_t *, block_t * );
63 /*****************************************************************************
65 *****************************************************************************/
66 int OpenIntf ( vlc_object_t * );
67 void CloseIntf ( vlc_object_t * );
69 /*****************************************************************************
71 *****************************************************************************/
73 set_description( N_("CMML annotations decoder") );
74 set_capability( "decoder", 50 );
75 set_callbacks( OpenDecoder, CloseDecoder );
76 add_shortcut( "cmml" );
79 set_capability( "interface", 0 );
80 set_callbacks( OpenIntf, CloseIntf );
83 /*****************************************************************************
84 * OpenDecoder: probe the decoder and return score
85 *****************************************************************************
86 * Tries to launch a decoder and return score so that the interface is able
88 *****************************************************************************/
89 static int OpenDecoder( vlc_object_t *p_this )
91 decoder_t *p_dec = (decoder_t*)p_this;
92 input_thread_t * p_input;
96 if( p_dec->fmt_in.i_codec != VLC_FOURCC('c','m','m','l') )
101 p_dec->pf_decode_sub = DecodeBlock;
104 msg_Dbg( p_dec, "i am at %p", p_dec );
107 /* Allocate the memory needed to store the decoder's structure */
108 if( ( p_dec->p_sys = p_sys =
109 (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
111 msg_Err( p_dec, "out of memory" );
115 /* Let other interested modules know that we're a CMML decoder
116 * We have to set this variable on the input thread, because there's
117 * typically more than one decoder running so we can't find the CMML
118 * decoder succesfully with vlc_object_find. (Any hints on how to achieve
119 * this would be rather appreciated ;) */
120 p_input = vlc_object_find( p_dec, VLC_OBJECT_INPUT, FIND_ANYWHERE );
122 msg_Dbg( p_dec, "p_input is at %p", p_input );
124 val.p_address = p_dec;
125 var_Create( p_input, "has-cmml-decoder",
126 VLC_VAR_ADDRESS|VLC_VAR_DOINHERIT );
127 if( var_Set( p_input, "has-cmml-decoder", val ) != VLC_SUCCESS )
129 msg_Dbg( p_dec, "var_Set of has-cmml-decoder failed" );
131 vlc_object_release( p_input );
133 /* initialise the CMML responder interface */
134 p_sys->p_intf = intf_Create( p_dec, "cmml", 0, NULL );
135 intf_RunThread( p_sys->p_intf );
140 /****************************************************************************
141 * DecodeBlock: the whole thing
142 ****************************************************************************
143 * This function must be fed with complete subtitles units.
144 ****************************************************************************/
145 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
149 if( !pp_block || *pp_block == NULL )
154 ParseText( p_dec, *pp_block );
156 block_Release( *pp_block );
159 /* allocate an empty subpicture to return. the actual subpicture
160 * displaying is done in the DisplayAnchor function in intf.c (called from
161 * DisplayPendingAnchor, which in turn is called from the main RunIntf
163 p_spu = p_dec->pf_spu_buffer_new( p_dec );
166 msg_Dbg( p_dec, "couldn't allocate new subpicture" );
173 /*****************************************************************************
174 * CloseDecoder: clean up the decoder
175 *****************************************************************************/
176 static void CloseDecoder( vlc_object_t *p_this )
178 decoder_t *p_dec = (decoder_t *)p_this;
179 decoder_sys_t *p_sys = p_dec->p_sys;
180 intf_thread_t *p_intf;
182 /* Destroy the interface object/thread */
183 p_intf = vlc_object_find( p_dec, VLC_OBJECT_INTF, FIND_CHILD );
187 msg_Dbg( p_dec, "CMML decoder is freeing interface thread" );
189 intf_StopThread( p_intf );
190 vlc_object_detach( p_intf );
191 vlc_object_release( p_intf );
192 vlc_object_release( p_intf );
195 p_sys->p_intf = NULL;
200 /*****************************************************************************
201 * ParseText: parse an text subtitle packet and send it to the video output
202 *****************************************************************************/
203 static void ParseText( decoder_t *p_dec, block_t *p_block )
205 char *psz_subtitle, *psz_cmml, *psz_url;
206 XTag *p_clip_parser, *p_anchor;
209 /* We cannot display a subpicture with no date */
210 if( p_block->i_pts == 0 )
212 msg_Warn( p_dec, "subtitle without a date" );
216 /* Check validity of packet data */
217 if( p_block->i_buffer <= 1 || p_block->p_buffer[0] == '\0' )
219 msg_Warn( p_dec, "empty subtitle" );
223 /* get anchor text from CMML */
225 /* Copy the whole CMML tag into our own buffer:
226 allocate i_buffer bytes + 1 for the terminating \0 */
227 if ( (psz_cmml = malloc( p_block->i_buffer + 1 )) == NULL )
229 psz_cmml = memcpy( psz_cmml, p_block->p_buffer, p_block->i_buffer );
230 psz_cmml[p_block->i_buffer] = '\0'; /* terminate the string */
232 msg_Dbg( p_dec, "psz_cmml is \"%s\"", psz_cmml );
235 /* Parse the <clip> part of the CMML */
236 p_clip_parser = xtag_new_parse( psz_cmml, p_block->i_buffer );
239 msg_Warn( p_dec, "couldn't initialise <clip> parser" );
244 /* Parse the anchor tag and get its contents */
245 p_anchor = xtag_first_child( p_clip_parser, "a" );
246 if( p_anchor != NULL )
248 psz_subtitle = xtag_get_pcdata( p_anchor );
252 psz_subtitle = strdup( " " );
256 msg_Dbg( p_dec, "psz_subtitle is \"%s\"", psz_subtitle );
259 /* get URL from the current clip, if one exists */
260 psz_url = xtag_get_attribute( p_anchor, "href" );
262 msg_Dbg( p_dec, "psz_url is \"%s\"", psz_url );
266 char *psz_tmp = strdup( psz_url );
268 val.p_address = psz_tmp;
269 if( var_Set( p_dec, "psz-current-anchor-url", val ) != VLC_SUCCESS )
271 (void) var_Create( p_dec, "psz-current-anchor-url",
272 VLC_VAR_ADDRESS|VLC_VAR_DOINHERIT );
273 msg_Dbg( p_dec, "creating psz-current-anchor-url" );
274 if( var_Set( p_dec, "psz-current-anchor-url", val ) != VLC_SUCCESS )
275 msg_Dbg( p_dec, "var_Set of psz-current-anchor-url failed" );
281 char *psz_tmp = strdup( psz_subtitle );
283 val.p_address = psz_tmp;
284 if( var_Set( p_dec, "psz-current-anchor-description", val ) != VLC_SUCCESS )
286 (void) var_Create( p_dec, "psz-current-anchor-description",
287 VLC_VAR_ADDRESS|VLC_VAR_DOINHERIT );
288 msg_Dbg( p_dec, "creating psz-current-anchor-description" );
289 if( var_Set( p_dec, "psz-current-anchor-description", val ) != VLC_SUCCESS )
290 msg_Dbg( p_dec, "var_Set of psz-current-anchor-description failed" );
295 free( psz_subtitle );
298 free( p_clip_parser );