git.sesse.net Git - vlc/blob - 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 #ifdef HAVE_CONFIG_H
  31 # include "config.h"
  32 #endif
  33
  34 #include <vlc_common.h>
  35 #include <vlc_plugin.h>
  36 #include <vlc_input.h>
  37 #include <vlc_codec.h>
  38 #include <vlc_osd.h>
  39 #include <vlc_charset.h>
  40 #include <vlc_interface.h>
  41 #include "xtag.h"
  42
  43 #undef  CMML_DEBUG
  44
  45 /*****************************************************************************
  46  * decoder_sys_t : decoder descriptor
  47  *****************************************************************************/
  48 struct decoder_sys_t
  49 {
  50     intf_thread_t *     p_intf;
  51 };
  52
  53 /*****************************************************************************
  54  * Local prototypes
  55  *****************************************************************************/
  56 static int           OpenDecoder   ( vlc_object_t * );
  57 static void          CloseDecoder  ( vlc_object_t * );
  58
  59 static subpicture_t *DecodeBlock   ( decoder_t *, block_t ** );
  60
  61 static void          ParseText     ( decoder_t *, block_t * );
  62
  63 /*****************************************************************************
  64  * Exported prototypes
  65  *****************************************************************************/
  66 int  OpenIntf  ( vlc_object_t * );
  67 void CloseIntf ( vlc_object_t * );
  68
  69 /*****************************************************************************
  70  * Module descriptor.
  71  *****************************************************************************/
  72 vlc_module_begin();
  73     set_description( N_("CMML annotations decoder") );
  74     set_capability( "decoder", 50 );
  75     set_callbacks( OpenDecoder, CloseDecoder );
  76     add_shortcut( "cmml" );
  77
  78     add_submodule();
  79         set_capability( "interface", 0 );
  80         set_callbacks( OpenIntf, CloseIntf );
  81 vlc_module_end();
  82
  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
  87  * to chose.
  88  *****************************************************************************/
  89 static int OpenDecoder( vlc_object_t *p_this )
  90 {
  91     decoder_t *p_dec = (decoder_t*)p_this;
  92     input_thread_t * p_input;
  93     decoder_sys_t *p_sys;
  94     vlc_value_t val;
  95
  96     if( p_dec->fmt_in.i_codec != VLC_FOURCC('c','m','m','l') )
  97     {
  98         return VLC_EGENERIC;
  99     }
 100
 101     p_dec->pf_decode_sub = DecodeBlock;
 102
 103 #ifdef CMML_DEBUG
 104     msg_Dbg( p_dec, "i am at %p", p_dec );
 105 #endif
 106
 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 )
 110     {
 111         return VLC_EGENERIC;
 112     }
 113
 114     /* Let other interested modules know that we're a CMML decoder
 115      * We have to set this variable on the input thread, because there's
 116      * typically more than one decoder running so we can't find the CMML
 117      * decoder succesfully with vlc_object_find.  (Any hints on how to achieve
 118      * this would be rather appreciated ;) */
 119     p_input = vlc_object_find( p_dec, VLC_OBJECT_INPUT, FIND_ANYWHERE );
 120 #ifdef CMML_DEBUG
 121     msg_Dbg( p_dec, "p_input is at %p", p_input );
 122 #endif
 123     val.p_address = p_dec;
 124     var_Create( p_input, "has-cmml-decoder",
 125                 VLC_VAR_ADDRESS|VLC_VAR_DOINHERIT );
 126     if( var_Set( p_input, "has-cmml-decoder", val ) != VLC_SUCCESS )
 127     {
 128         msg_Dbg( p_dec, "var_Set of has-cmml-decoder failed" );
 129     }
 130     vlc_object_release( p_input );
 131
 132     /* initialise the CMML responder interface */
 133     p_sys->p_intf = intf_Create( p_dec, "cmml" );
 134     intf_RunThread( p_sys->p_intf );
 135
 136     return VLC_SUCCESS;
 137 }
 138
 139 /****************************************************************************
 140  * DecodeBlock: the whole thing
 141  ****************************************************************************
 142  * This function must be fed with complete subtitles units.
 143  ****************************************************************************/
 144 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
 145 {
 146     subpicture_t *p_spu;
 147
 148     if( !pp_block || *pp_block == NULL )
 149     {
 150         return NULL;
 151     }
 152
 153     ParseText( p_dec, *pp_block );
 154
 155     block_Release( *pp_block );
 156     *pp_block = NULL;
 157
 158     /* allocate an empty subpicture to return.  the actual subpicture
 159      * displaying is done in the DisplayAnchor function in intf.c (called from
 160      * DisplayPendingAnchor, which in turn is called from the main RunIntf
 161      * loop). */
 162     p_spu = decoder_NewSubpicture( p_dec );
 163     if( !p_spu )
 164     {
 165         msg_Dbg( p_dec, "couldn't allocate new subpicture" );
 166         return NULL;
 167     }
 168
 169     return p_spu;
 170 }
 171
 172 /*****************************************************************************
 173  * CloseDecoder: clean up the decoder
 174  *****************************************************************************/
 175 static void CloseDecoder( vlc_object_t *p_this )
 176 {
 177     decoder_t *p_dec = (decoder_t *)p_this;
 178     decoder_sys_t *p_sys = p_dec->p_sys;
 179     intf_thread_t *p_intf;
 180
 181     /* Destroy the interface object/thread */
 182     p_intf = vlc_object_find( p_dec, VLC_OBJECT_INTF, FIND_CHILD );
 183     if( p_intf != NULL )
 184     {
 185 #ifdef CMML_DEBUG
 186         msg_Dbg( p_dec, "CMML decoder is freeing interface thread" );
 187 #endif
 188         intf_StopThread( p_intf );
 189         vlc_object_detach( p_intf );
 190         vlc_object_release( p_intf );
 191         vlc_object_release( p_intf );
 192     }
 193
 194     p_sys->p_intf = NULL;
 195
 196     free( p_sys );
 197 }
 198
 199 /*****************************************************************************
 200  * ParseText: parse an text subtitle packet and send it to the video output
 201  *****************************************************************************/
 202 static void ParseText( decoder_t *p_dec, block_t *p_block )
 203 {
 204     char *psz_subtitle, *psz_cmml, *psz_url;
 205     XTag *p_clip_parser, *p_anchor;
 206     vlc_value_t val;
 207
 208     /* We cannot display a subpicture with no date */
 209     if( p_block->i_pts == 0 )
 210     {
 211         msg_Warn( p_dec, "subtitle without a date" );
 212         return;
 213     }
 214
 215     /* Check validity of packet data */
 216     if( p_block->i_buffer <= 1 ||  p_block->p_buffer[0] == '\0' )
 217     {
 218         msg_Warn( p_dec, "empty subtitle" );
 219         return;
 220     }
 221
 222     /* get anchor text from CMML */
 223
 224     /* Copy the whole CMML tag into our own buffer:
 225        allocate i_buffer bytes + 1 for the terminating \0 */
 226     if ( (psz_cmml = malloc( p_block->i_buffer + 1 )) == NULL )
 227         return;
 228     psz_cmml = memcpy( psz_cmml, p_block->p_buffer, p_block->i_buffer );
 229     psz_cmml[p_block->i_buffer] = '\0'; /* terminate the string */
 230 #ifdef CMML_DEBUG
 231     msg_Dbg( p_dec, "psz_cmml is \"%s\"", psz_cmml );
 232 #endif
 233
 234     /* Parse the <clip> part of the CMML */
 235     p_clip_parser = xtag_new_parse( psz_cmml, p_block->i_buffer );
 236     if( !p_clip_parser )
 237     {
 238         msg_Warn( p_dec, "couldn't initialise <clip> parser" );
 239         free( psz_cmml );
 240         return;
 241     }
 242
 243     /* Parse the anchor tag and get its contents */
 244     p_anchor = xtag_first_child( p_clip_parser, "a" );
 245     if( p_anchor != NULL )
 246     {
 247         psz_subtitle = xtag_get_pcdata( p_anchor );
 248     }
 249     else
 250     {
 251         psz_subtitle = strdup( " " );
 252     }
 253
 254 #ifdef CMML_DEBUG
 255     msg_Dbg( p_dec, "psz_subtitle is \"%s\"", psz_subtitle );
 256 #endif
 257
 258     /* get URL from the current clip, if one exists */
 259     psz_url = xtag_get_attribute( p_anchor, "href" );
 260 #ifdef CMML_DEBUG
 261     msg_Dbg( p_dec, "psz_url is \"%s\"", psz_url );
 262 #endif
 263     if( psz_url )
 264     {
 265         char *psz_tmp = strdup( psz_url );
 266
 267         val.p_address = psz_tmp;
 268         if( var_Set( p_dec, "psz-current-anchor-url", val ) != VLC_SUCCESS )
 269         {
 270             (void) var_Create( p_dec, "psz-current-anchor-url",
 271                                VLC_VAR_ADDRESS|VLC_VAR_DOINHERIT );
 272             msg_Dbg( p_dec, "creating psz-current-anchor-url" );
 273             if( var_Set( p_dec, "psz-current-anchor-url", val ) != VLC_SUCCESS )
 274                 msg_Dbg( p_dec, "var_Set of psz-current-anchor-url failed" );
 275         }
 276     }
 277
 278     if( psz_subtitle )
 279     {
 280         char *psz_tmp = strdup( psz_subtitle );
 281
 282         val.p_address = psz_tmp;
 283         if( var_Set( p_dec, "psz-current-anchor-description", val ) != VLC_SUCCESS )
 284         {
 285             (void) var_Create( p_dec, "psz-current-anchor-description",
 286                                VLC_VAR_ADDRESS|VLC_VAR_DOINHERIT );
 287             msg_Dbg( p_dec, "creating psz-current-anchor-description" );
 288             if( var_Set( p_dec, "psz-current-anchor-description", val ) != VLC_SUCCESS )
 289                 msg_Dbg( p_dec, "var_Set of psz-current-anchor-description failed" );
 290         }
 291
 292     }
 293
 294     free( psz_subtitle );
 295     free( psz_cmml );
 296     free( p_anchor );
 297     free( p_clip_parser );
 298     free( psz_url );
 299 }
 300