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
  95     if( p_dec->fmt_in.i_codec != VLC_FOURCC('c','m','m','l') )
  96         return VLC_EGENERIC;
  97
  98     p_dec->pf_decode_sub = DecodeBlock;
  99
 100     /* Allocate the memory needed to store the decoder's structure */
 101     if( ( p_dec->p_sys = p_sys = malloc( sizeof(*p_sys) ) ) == NULL )
 102         return VLC_ENOMEM;
 103
 104     /* Let other interested modules know that we're a CMML decoder
 105      * We have to set this variable on the input thread, because there's
 106      * typically more than one decoder running so we can't find the CMML
 107      * decoder succesfully with vlc_object_find.  (Any hints on how to achieve
 108      * this would be rather appreciated ;) */
 109     p_input = vlc_object_find( p_dec, VLC_OBJECT_INPUT, FIND_ANYWHERE );
 110     if( p_input )
 111     {
 112         vlc_value_t val;
 113
 114 #ifdef CMML_DEBUG
 115         msg_Dbg( p_dec, "p_input is at %p", p_input );
 116 #endif
 117         val.p_address = p_dec;
 118         var_Create( p_input, "has-cmml-decoder",
 119                     VLC_VAR_ADDRESS|VLC_VAR_DOINHERIT );
 120
 121         if( var_Set( p_input, "has-cmml-decoder", val ) != VLC_SUCCESS )
 122             msg_Dbg( p_dec, "var_Set of has-cmml-decoder failed" );
 123         vlc_object_release( p_input );
 124     }
 125
 126     /* initialise the CMML responder interface */
 127     p_sys->p_intf = intf_Create( p_dec, "cmml" );
 128     if( p_sys->p_intf )
 129         intf_RunThread( p_sys->p_intf );
 130
 131     p_dec->fmt_out.i_cat = SPU_ES;
 132     p_dec->fmt_out.i_codec = 0;
 133
 134     return VLC_SUCCESS;
 135 }
 136
 137 /****************************************************************************
 138  * DecodeBlock: the whole thing
 139  ****************************************************************************
 140  * This function must be fed with complete subtitles units.
 141  ****************************************************************************/
 142 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
 143 {
 144     subpicture_t *p_spu;
 145
 146     if( !pp_block || *pp_block == NULL )
 147     {
 148         return NULL;
 149     }
 150
 151     ParseText( p_dec, *pp_block );
 152
 153     block_Release( *pp_block );
 154     *pp_block = NULL;
 155
 156     /* allocate an empty subpicture to return.  the actual subpicture
 157      * displaying is done in the DisplayAnchor function in intf.c (called from
 158      * DisplayPendingAnchor, which in turn is called from the main RunIntf
 159      * loop). */
 160     p_spu = decoder_NewSubpicture( p_dec );
 161     if( !p_spu )
 162     {
 163         msg_Dbg( p_dec, "couldn't allocate new subpicture" );
 164         return NULL;
 165     }
 166
 167     return p_spu;
 168 }
 169
 170 /*****************************************************************************
 171  * CloseDecoder: clean up the decoder
 172  *****************************************************************************/
 173 static void CloseDecoder( vlc_object_t *p_this )
 174 {
 175     decoder_t *p_dec = (decoder_t *)p_this;
 176     decoder_sys_t *p_sys = p_dec->p_sys;
 177
 178     /* Destroy the interface object/thread */
 179     if( p_sys->p_intf != NULL )
 180     {
 181         intf_thread_t *p_intf = p_sys->p_intf;
 182         intf_StopThread( p_intf );
 183         vlc_object_detach( p_intf );
 184         vlc_object_release( p_intf );
 185     }
 186
 187     free( p_sys );
 188 }
 189
 190 /*****************************************************************************
 191  * ParseText: parse an text subtitle packet and send it to the video output
 192  *****************************************************************************/
 193 static void ParseText( decoder_t *p_dec, block_t *p_block )
 194 {
 195     char *psz_subtitle, *psz_cmml, *psz_url;
 196     XTag *p_clip_parser, *p_anchor;
 197     vlc_value_t val;
 198
 199     /* We cannot display a subpicture with no date */
 200     if( p_block->i_pts == 0 )
 201     {
 202         msg_Warn( p_dec, "subtitle without a date" );
 203         return;
 204     }
 205
 206     /* Check validity of packet data */
 207     if( p_block->i_buffer <= 1 ||  p_block->p_buffer[0] == '\0' )
 208     {
 209         msg_Warn( p_dec, "empty subtitle" );
 210         return;
 211     }
 212
 213     /* get anchor text from CMML */
 214
 215     /* Copy the whole CMML tag into our own buffer:
 216        allocate i_buffer bytes + 1 for the terminating \0 */
 217     if( (psz_cmml = malloc( p_block->i_buffer + 1 )) == NULL )
 218         return;
 219     memcpy( psz_cmml, p_block->p_buffer, p_block->i_buffer );
 220     psz_cmml[p_block->i_buffer] = '\0'; /* terminate the string */
 221 #ifdef CMML_DEBUG
 222     msg_Dbg( p_dec, "psz_cmml is \"%s\"", psz_cmml );
 223 #endif
 224
 225     /* Parse the <clip> part of the CMML */
 226     p_clip_parser = xtag_new_parse( psz_cmml, p_block->i_buffer );
 227     if( !p_clip_parser )
 228     {
 229         msg_Warn( p_dec, "couldn't initialise <clip> parser" );
 230         free( psz_cmml );
 231         return;
 232     }
 233
 234     /* Parse the anchor tag and get its contents */
 235     p_anchor = xtag_first_child( p_clip_parser, "a" );
 236     if( p_anchor != NULL )
 237     {
 238         psz_subtitle = xtag_get_pcdata( p_anchor );
 239     }
 240     else
 241     {
 242         psz_subtitle = strdup( " " );
 243     }
 244
 245 #ifdef CMML_DEBUG
 246     msg_Dbg( p_dec, "psz_subtitle is \"%s\"", psz_subtitle );
 247 #endif
 248
 249     /* get URL from the current clip, if one exists */
 250     psz_url = xtag_get_attribute( p_anchor, "href" );
 251 #ifdef CMML_DEBUG
 252     msg_Dbg( p_dec, "psz_url is \"%s\"", psz_url );
 253 #endif
 254     if( psz_url )
 255     {
 256         char *psz_tmp = strdup( psz_url );
 257
 258         val.p_address = psz_tmp;
 259         if( var_Set( p_dec, "psz-current-anchor-url", val ) != VLC_SUCCESS )
 260         {
 261             var_Create( p_dec, "psz-current-anchor-url",
 262                         VLC_VAR_ADDRESS | VLC_VAR_DOINHERIT );
 263             msg_Dbg( p_dec, "creating psz-current-anchor-url" );
 264             if( var_Set( p_dec, "psz-current-anchor-url", val ) != VLC_SUCCESS )
 265                 msg_Dbg( p_dec, "var_Set of psz-current-anchor-url failed" );
 266         }
 267     }
 268
 269     if( psz_subtitle )
 270     {
 271         char *psz_tmp = strdup( psz_subtitle );
 272
 273         val.p_address = psz_tmp;
 274         if( var_Set( p_dec, "psz-current-anchor-description", val ) != VLC_SUCCESS )
 275         {
 276             var_Create( p_dec, "psz-current-anchor-description",
 277                         VLC_VAR_ADDRESS | VLC_VAR_DOINHERIT );
 278             msg_Dbg( p_dec, "creating psz-current-anchor-description" );
 279             if( var_Set( p_dec, "psz-current-anchor-description", val ) != VLC_SUCCESS )
 280                 msg_Dbg( p_dec, "var_Set of psz-current-anchor-description failed" );
 281         }
 282
 283     }
 284
 285     free( psz_subtitle );
 286     free( psz_cmml );
 287     free( p_anchor );
 288     free( p_clip_parser );
 289     free( psz_url );
 290 }
 291