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