git.sesse.net Git - vlc/blob - modules/codec/kate.c

   1 /*****************************************************************************
   2  * kate.c : a decoder for the kate bitstream format
   3  *****************************************************************************
   4  * Copyright (C) 2000-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <vlc_common.h>
  32 #include <vlc_plugin.h>
  33 #include <vlc_input.h>
  34 #include <vlc_codec.h>
  35 #include <vlc_osd.h>
  36
  37 #include <kate/kate.h>
  38 #ifdef HAVE_TIGER
  39 # include <tiger/tiger.h>
  40 #endif
  41
  42 /* #define ENABLE_PACKETIZER */
  43 /* #define ENABLE_PROFILE */
  44
  45 #ifdef ENABLE_PROFILE
  46 # define PROFILE_START(name) int64_t profile_start_##name = mdate()
  47 # define PROFILE_STOP(name) fprintf( stderr, #name ": %f ms\n", (mdate() - profile_start_##name)/1000.0f )
  48 #else
  49 # define PROFILE_START(name) ((void)0)
  50 # define PROFILE_STOP(name) ((void)0)
  51 #endif
  52
  53 #define CHECK_TIGER_RET( statement )                                   \
  54     do                                                                 \
  55     {                                                                  \
  56         int i_ret = (statement);                                       \
  57         if( i_ret < 0 )                                                \
  58         {                                                              \
  59             msg_Dbg( p_dec, "Error in " #statement ": %d", i_ret );    \
  60         }                                                              \
  61     } while( 0 )
  62
  63 /*****************************************************************************
  64  * decoder_sys_t : decoder descriptor
  65  *****************************************************************************/
  66 struct decoder_sys_t
  67 {
  68 #ifdef ENABLE_PACKETIZER
  69     /* Module mode */
  70     bool b_packetizer;
  71 #endif
  72
  73     /*
  74      * Input properties
  75      */
  76     int i_num_headers;
  77     int i_headers;
  78
  79     /*
  80      * Kate properties
  81      */
  82     bool           b_ready;
  83     kate_info      ki;
  84     kate_comment   kc;
  85     kate_state     k;
  86
  87     /*
  88      * Common properties
  89      */
  90     mtime_t i_pts;
  91     mtime_t i_max_stop;
  92
  93     /* decoder_sys_t is shared between decoder and spu units */
  94     vlc_mutex_t lock;
  95     int         i_refcount;
  96
  97 #ifdef HAVE_TIGER
  98     /*
  99      * Tiger properties
 100      */
 101     tiger_renderer    *p_tr;
 102     mtime_t            last_render_ts;
 103     bool               b_dirty;
 104
 105     uint32_t           i_tiger_default_font_color;
 106     uint32_t           i_tiger_default_background_color;
 107     tiger_font_effect  e_tiger_default_font_effect;
 108     double             f_tiger_default_font_effect_strength;
 109     char              *psz_tiger_default_font_desc;
 110     double             f_tiger_quality;
 111 #endif
 112
 113     /*
 114      * Options
 115      */
 116     bool   b_formatted;
 117     bool   b_use_tiger;
 118 };
 119
 120 struct subpicture_sys_t
 121 {
 122     decoder_sys_t *p_dec_sys;
 123     mtime_t        i_start;
 124 };
 125
 126
 127 /*
 128  * This is a global list of existing decoders.
 129  * The reason for this list is that:
 130  *  - I want to be able to reconfigure Tiger when user prefs change
 131  *  - User prefs are variables which are not specific to a decoder (eg, if
 132  *    there are several decoders, there will still be one set of variables)
 133  *  - A callback set on those will not be passed a pointer to the decoder
 134  *    (as the decoder isn't known, and there could be multiple ones)
 135  *  - Creating variables in the decoder will create different ones, with
 136  *    values copied from the relevant user pref, so a callback on those
 137  *    won't be called when the user pref is changed
 138  * Therefore, each decoder will register/unregister itself with this list,
 139  * callbacks will be set for the user prefs, and these will in turn walk
 140  * through this list and tell each decoder to update the relevant variable.
 141  * HOWEVER.
 142  * VLC's variable system is still in my way as I can't get the value of
 143  * the user pref variables at decoder start *unless* I create my own vars
 144  * which inherit from the user ones, but those are utterly useless after
 145  * that first use, since they'll be detached from the ones the user can
 146  * change. So, I create them, read their values, and then destroy them.
 147  */
 148 static vlc_mutex_t kate_decoder_list_mutex = VLC_STATIC_MUTEX;
 149 static size_t kate_decoder_list_size = 0;
 150 static decoder_t **kate_decoder_list = NULL;
 151
 152 /*****************************************************************************
 153  * Local prototypes
 154  *****************************************************************************/
 155 static int  OpenDecoder   ( vlc_object_t * );
 156 static void CloseDecoder  ( vlc_object_t * );
 157 #ifdef ENABLE_PACKETIZER
 158 static int OpenPacketizer( vlc_object_t *p_this );
 159 #endif
 160
 161 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block );
 162 static int ProcessHeaders( decoder_t *p_dec );
 163 static subpicture_t *ProcessPacket( decoder_t *p_dec, kate_packet *p_kp,
 164                             block_t **pp_block );
 165 static subpicture_t *DecodePacket( decoder_t *p_dec, kate_packet *p_kp,
 166                             block_t *p_block );
 167 static void ParseKateComments( decoder_t * );
 168 static subpicture_t *SetupSimpleKateSPU( decoder_t *p_dec, subpicture_t *p_spu,
 169                             const kate_event *ev );
 170 static void DecSysRelease( decoder_sys_t *p_sys );
 171 static void DecSysHold( decoder_sys_t *p_sys );
 172 #ifdef HAVE_TIGER
 173 static uint32_t GetTigerColor( decoder_t *p_dec, const char *psz_prefix );
 174 static char *GetTigerString( decoder_t *p_dec, const char *psz_name );
 175 static int GetTigerInteger( decoder_t *p_dec, const char *psz_name );
 176 static double GetTigerFloat( decoder_t *p_dec, const char *psz_name );
 177 static void UpdateTigerFontColor( decoder_t *p_dec );
 178 static void UpdateTigerBackgroundColor( decoder_t *p_dec );
 179 static void UpdateTigerFontEffect( decoder_t *p_dec );
 180 static void UpdateTigerQuality( decoder_t *p_dec );
 181 static void UpdateTigerFontDesc( decoder_t *p_dec );
 182 static int TigerConfigurationCallback( vlc_object_t *p_this, const char *psz_var,
 183                                        vlc_value_t oldvar, vlc_value_t newval,
 184                                        void *p_data );
 185 static int OnConfigurationChanged( decoder_t *p_dec, const char *psz_var,
 186                                    vlc_value_t oldval, vlc_value_t newval);
 187 #endif
 188
 189 #define DEFAULT_NAME "Default"
 190 #define MAX_LINE 8192
 191
 192 /*****************************************************************************
 193  * Module descriptor.
 194  *****************************************************************************/
 195
 196 #define FORMAT_TEXT N_("Formatted Subtitles")
 197 #define FORMAT_LONGTEXT N_("Kate streams allow for text formatting. " \
 198  "VLC partly implements this, but you can choose to disable all formatting." \
 199  "Note that this has no effect is rendering via Tiger is enabled.")
 200
 201 #ifdef HAVE_TIGER
 202
 203 static const tiger_font_effect pi_font_effects[] = { tiger_font_plain, tiger_font_shadow, tiger_font_outline };
 204 static const char * const ppsz_font_effect_names[] = { N_("None"), N_("Shadow"), N_("Outline") };
 205
 206 /* nicked off freetype.c */
 207 static const int pi_color_values[] = {
 208   0x00000000, 0x00808080, 0x00C0C0C0, 0x00FFFFFF, 0x00800000,
 209   0x00FF0000, 0x00FF00FF, 0x00FFFF00, 0x00808000, 0x00008000, 0x00008080,
 210   0x0000FF00, 0x00800080, 0x00000080, 0x000000FF, 0x0000FFFF };
 211 static const char *const ppsz_color_descriptions[] = {
 212   N_("Black"), N_("Gray"), N_("Silver"), N_("White"), N_("Maroon"),
 213   N_("Red"), N_("Fuchsia"), N_("Yellow"), N_("Olive"), N_("Green"), N_("Teal"),
 214   N_("Lime"), N_("Purple"), N_("Navy"), N_("Blue"), N_("Aqua") };
 215
 216 #define TIGER_TEXT N_("Use Tiger for rendering")
 217 #define TIGER_LONGTEXT N_("Kate streams can be rendered using the Tiger library. " \
 218  "Disabling this will only render static text and bitmap based streams.")
 219
 220 #define TIGER_QUALITY_DEFAULT 1.0
 221 #define TIGER_QUALITY_TEXT N_("Rendering quality")
 222 #define TIGER_QUALITY_LONGTEXT N_("Select rendering quality, at the expense of speed. " \
 223  "0 is fastest, 1 is highest quality.")
 224
 225 #define TIGER_DEFAULT_FONT_EFFECT_DEFAULT 0
 226 #define TIGER_DEFAULT_FONT_EFFECT_TEXT N_("Default font effect")
 227 #define TIGER_DEFAULT_FONT_EFFECT_LONGTEXT N_("Add a font effect to text to improve readability " \
 228  "against different backgrounds.")
 229
 230 #define TIGER_DEFAULT_FONT_EFFECT_STRENGTH_DEFAULT 0.5
 231 #define TIGER_DEFAULT_FONT_EFFECT_STRENGTH_TEXT N_("Default font effect strength")
 232 #define TIGER_DEFAULT_FONT_EFFECT_STRENGTH_LONGTEXT N_("How pronounced to make the chosen font effect " \
 233  "(effect dependent).")
 234
 235 #define TIGER_DEFAULT_FONT_DESC_DEFAULT ""
 236 #define TIGER_DEFAULT_FONT_DESC_TEXT N_("Default font description")
 237 #define TIGER_DEFAULT_FONT_DESC_LONGTEXT N_("Which font description to use if the Kate stream " \
 238  "does not specify particular font parameters (name, size, etc) to use. " \
 239  "A blank name will let Tiger choose font parameters where appropriate.")
 240
 241 #define TIGER_DEFAULT_FONT_COLOR_DEFAULT 0x00ffffff
 242 #define TIGER_DEFAULT_FONT_COLOR_TEXT N_("Default font color")
 243 #define TIGER_DEFAULT_FONT_COLOR_LONGTEXT N_("Default font color to use if the Kate stream " \
 244  "does not specify a particular font color to use.")
 245
 246 #define TIGER_DEFAULT_FONT_ALPHA_DEFAULT 0xff
 247 #define TIGER_DEFAULT_FONT_ALPHA_TEXT N_("Default font alpha")
 248 #define TIGER_DEFAULT_FONT_ALPHA_LONGTEXT N_("Transparency of the default font color if the Kate stream " \
 249  "does not specify a particular font color to use.")
 250
 251 #define TIGER_DEFAULT_BACKGROUND_COLOR_DEFAULT 0x00ffffff
 252 #define TIGER_DEFAULT_BACKGROUND_COLOR_TEXT N_("Default background color")
 253 #define TIGER_DEFAULT_BACKGROUND_COLOR_LONGTEXT N_("Default background color if the Kate stream " \
 254  "does not specify a background color to use.")
 255
 256 #define TIGER_DEFAULT_BACKGROUND_ALPHA_DEFAULT 0
 257 #define TIGER_DEFAULT_BACKGROUND_ALPHA_TEXT N_("Default background alpha")
 258 #define TIGER_DEFAULT_BACKGROUND_ALPHA_LONGTEXT N_("Transparency of the default background color if the Kate stream " \
 259  "does not specify a particular background color to use.")
 260
 261 #endif
 262
 263 #define HELP_TEXT N_( \
 264     "Kate is a codec for text and image based overlays.\n" \
 265     "The Tiger rendering library is needed to render complex Kate streams, " \
 266     "but VLC can still render static text and image based subtitles if " \
 267     "it is not available.\n" \
 268     "Note that changing settings below will not take effect until a new stream is played. " \
 269     "This will hopefully be fixed soon." \
 270     )
 271
 272 vlc_module_begin ()
 273     set_shortname( N_("Kate"))
 274     set_description( N_("Kate overlay decoder") )
 275     set_help( HELP_TEXT )
 276     set_capability( "decoder", 50 )
 277     set_callbacks( OpenDecoder, CloseDecoder )
 278     set_category( CAT_INPUT )
 279     set_subcategory( SUBCAT_INPUT_SCODEC )
 280     add_shortcut( "kate" )
 281
 282     add_bool( "kate-formatted", true, NULL, FORMAT_TEXT, FORMAT_LONGTEXT,
 283               true )
 284
 285 #ifdef HAVE_TIGER
 286     add_bool( "kate-use-tiger", true, NULL, TIGER_TEXT, TIGER_LONGTEXT,
 287               true )
 288     add_float_with_range( "kate-tiger-quality",
 289                           TIGER_QUALITY_DEFAULT, 0.0f, 1.0f, TigerConfigurationCallback,
 290                           TIGER_QUALITY_TEXT, TIGER_QUALITY_LONGTEXT,
 291                           true )
 292
 293     set_section( N_("Tiger rendering defaults"), NULL );
 294     add_string( "kate-tiger-default-font-desc",
 295                 TIGER_DEFAULT_FONT_DESC_DEFAULT, TigerConfigurationCallback,
 296                 TIGER_DEFAULT_FONT_DESC_TEXT, TIGER_DEFAULT_FONT_DESC_LONGTEXT, true);
 297     add_integer_with_range( "kate-tiger-default-font-effect",
 298                             TIGER_DEFAULT_FONT_EFFECT_DEFAULT,
 299                             0, sizeof(pi_font_effects)/sizeof(pi_font_effects[0])-1, TigerConfigurationCallback,
 300                             TIGER_DEFAULT_FONT_EFFECT_TEXT, TIGER_DEFAULT_FONT_EFFECT_LONGTEXT,
 301                             true )
 302     change_integer_list( pi_font_effects, ppsz_font_effect_names, NULL );
 303     add_float_with_range( "kate-tiger-default-font-effect-strength",
 304               TIGER_DEFAULT_FONT_EFFECT_STRENGTH_DEFAULT, 0.0f, 1.0f, TigerConfigurationCallback,
 305               TIGER_DEFAULT_FONT_EFFECT_STRENGTH_TEXT, TIGER_DEFAULT_FONT_EFFECT_STRENGTH_LONGTEXT,
 306               true )
 307     add_integer_with_range( "kate-tiger-default-font-color",
 308                             TIGER_DEFAULT_FONT_COLOR_DEFAULT, 0, 0x00ffffff, TigerConfigurationCallback,
 309                             TIGER_DEFAULT_FONT_COLOR_TEXT, TIGER_DEFAULT_FONT_COLOR_LONGTEXT,
 310                             true);
 311     change_integer_list( pi_color_values, ppsz_color_descriptions, NULL );
 312     add_integer_with_range( "kate-tiger-default-font-alpha",
 313                             TIGER_DEFAULT_FONT_ALPHA_DEFAULT, 0, 255, TigerConfigurationCallback,
 314                             TIGER_DEFAULT_FONT_ALPHA_TEXT, TIGER_DEFAULT_FONT_ALPHA_LONGTEXT,
 315                             true);
 316     add_integer_with_range( "kate-tiger-default-background-color",
 317                             TIGER_DEFAULT_BACKGROUND_COLOR_DEFAULT, 0, 0x00ffffff, TigerConfigurationCallback,
 318                             TIGER_DEFAULT_BACKGROUND_COLOR_TEXT, TIGER_DEFAULT_BACKGROUND_COLOR_LONGTEXT,
 319                             true);
 320     change_integer_list( pi_color_values, ppsz_color_descriptions, NULL );
 321     add_integer_with_range( "kate-tiger-default-background-alpha",
 322                             TIGER_DEFAULT_BACKGROUND_ALPHA_DEFAULT, 0, 255, TigerConfigurationCallback,
 323                             TIGER_DEFAULT_BACKGROUND_ALPHA_TEXT, TIGER_DEFAULT_BACKGROUND_ALPHA_LONGTEXT,
 324                             true);
 325 #endif
 326
 327 #ifdef ENABLE_PACKETIZER
 328     add_submodule ()
 329     set_description( N_("Kate text subtitles packetizer") )
 330     set_capability( "packetizer", 100 )
 331     set_callbacks( OpenPacketizer, CloseDecoder )
 332     add_shortcut( "kate" )
 333 #endif
 334
 335 vlc_module_end ()
 336
 337 /*****************************************************************************
 338  * OpenDecoder: probe the decoder and return score
 339  *****************************************************************************
 340  * Tries to launch a decoder and return score so that the interface is able
 341  * to chose.
 342  *****************************************************************************/
 343 static int OpenDecoder( vlc_object_t *p_this )
 344 {
 345     decoder_t     *p_dec = (decoder_t*)p_this;
 346     decoder_sys_t *p_sys;
 347
 348     if( p_dec->fmt_in.i_codec != VLC_CODEC_KATE )
 349     {
 350         return VLC_EGENERIC;
 351     }
 352
 353     msg_Dbg( p_dec, "kate: OpenDecoder");
 354
 355     /* Set callbacks */
 356     p_dec->pf_decode_sub = (subpicture_t *(*)(decoder_t *, block_t **))
 357         DecodeBlock;
 358     p_dec->pf_packetize    = (block_t *(*)(decoder_t *, block_t **))
 359         DecodeBlock;
 360
 361     /* Allocate the memory needed to store the decoder's structure */
 362     if( ( p_dec->p_sys = p_sys = malloc(sizeof(*p_sys)) ) == NULL )
 363         return VLC_ENOMEM;
 364
 365     vlc_mutex_init( &p_sys->lock );
 366     p_sys->i_refcount = 0;
 367     DecSysHold( p_sys );
 368
 369     /* init of p_sys */
 370 #ifdef ENABLE_PACKETIZER
 371     p_sys->b_packetizer = false;
 372 #endif
 373     p_sys->b_ready = false;
 374     p_sys->i_pts = 0;
 375     p_sys->i_max_stop = VLC_TS_INVALID;
 376
 377     kate_comment_init( &p_sys->kc );
 378     kate_info_init( &p_sys->ki );
 379
 380     p_sys->i_num_headers = 0;
 381     p_sys->i_headers = 0;
 382
 383     /* retrieve options */
 384     p_sys->b_formatted = var_CreateGetBool( p_dec, "kate-formatted" );
 385
 386     vlc_mutex_lock( &kate_decoder_list_mutex );
 387
 388 #ifdef HAVE_TIGER
 389
 390     p_sys->b_use_tiger = var_CreateGetBool( p_dec, "kate-use-tiger" );
 391
 392     p_sys->p_tr = NULL;
 393     p_sys->last_render_ts = 0;
 394
 395     /* get initial value of configuration */
 396     p_sys->i_tiger_default_font_color = GetTigerColor( p_dec, "kate-tiger-default-font" );
 397     p_sys->i_tiger_default_background_color = GetTigerColor( p_dec, "kate-tiger-default-background" );
 398     p_sys->e_tiger_default_font_effect = GetTigerInteger( p_dec, "kate-tiger-default-font-effect" );
 399     p_sys->f_tiger_default_font_effect_strength = GetTigerFloat( p_dec, "kate-tiger-default-font-effect-strength" );
 400     p_sys->psz_tiger_default_font_desc = GetTigerString( p_dec, "kate-tiger-default-font-desc" );
 401     p_sys->f_tiger_quality = GetTigerFloat( p_dec, "kate-tiger-quality" );
 402
 403     if( p_sys->b_use_tiger )
 404     {
 405         int i_ret = tiger_renderer_create( &p_sys->p_tr );
 406         if( i_ret < 0 )
 407         {
 408             msg_Warn ( p_dec, "Failed to create Tiger renderer, falling back to basic rendering" );
 409             p_sys->p_tr = NULL;
 410             p_sys->b_use_tiger = false;
 411         }
 412
 413         CHECK_TIGER_RET( tiger_renderer_set_surface_clear_color( p_sys->p_tr, 1, 0, 0, 0, 0 ) );
 414
 415         UpdateTigerFontEffect( p_dec );
 416         UpdateTigerFontColor( p_dec );
 417         UpdateTigerBackgroundColor( p_dec );
 418         UpdateTigerQuality( p_dec );
 419         UpdateTigerFontDesc( p_dec );
 420     }
 421
 422 #else
 423
 424     p_sys->b_use_tiger = false;
 425
 426 #endif
 427
 428     es_format_Init( &p_dec->fmt_out, SPU_ES, 0 );
 429
 430     /* add the decoder to the global list */
 431     decoder_t **list = realloc( kate_decoder_list, (kate_decoder_list_size+1) * sizeof( *list ));
 432     if( list )
 433     {
 434         list[ kate_decoder_list_size++ ] = p_dec;
 435         kate_decoder_list = list;
 436     }
 437
 438     vlc_mutex_unlock( &kate_decoder_list_mutex );
 439
 440     return VLC_SUCCESS;
 441 }
 442
 443 #ifdef ENABLE_PACKETIZER
 444 static int OpenPacketizer( vlc_object_t *p_this )
 445 {
 446     decoder_t *p_dec = (decoder_t*)p_this;
 447
 448     int i_ret = OpenDecoder( p_this );
 449
 450     if( i_ret == VLC_SUCCESS )
 451     {
 452         p_dec->p_sys->b_packetizer = true;
 453         p_dec->fmt_out.i_codec = VLC_CODEC_KATE;
 454     }
 455
 456     return i_ret;
 457 }
 458 #endif
 459
 460 /****************************************************************************
 461  * DecodeBlock: the whole thing
 462  ****************************************************************************
 463  * This function must be fed with kate packets.
 464  ****************************************************************************/
 465 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
 466 {
 467     decoder_sys_t *p_sys = p_dec->p_sys;
 468     block_t *p_block;
 469     kate_packet kp;
 470
 471     if( !pp_block || !*pp_block )
 472         return NULL;
 473
 474     p_block = *pp_block;
 475
 476     if( p_block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
 477     {
 478 #ifdef HAVE_TIGER
 479         if( p_block->i_flags & BLOCK_FLAG_DISCONTINUITY)
 480         {
 481             /* Hmm, should we wait before flushing the renderer ? I think not, but not certain... */
 482             vlc_mutex_lock( &p_sys->lock );
 483             tiger_renderer_seek( p_sys->p_tr, 0 );
 484             vlc_mutex_unlock( &p_sys->lock );
 485         }
 486 #endif
 487         p_sys->i_max_stop = VLC_TS_INVALID;
 488         block_Release( p_block );
 489         return NULL;
 490     }
 491
 492     /* Block to Kate packet */
 493     kate_packet_wrap(&kp, p_block->i_buffer, p_block->p_buffer);
 494
 495     if( p_sys->i_headers == 0 && p_dec->fmt_in.i_extra )
 496     {
 497         /* Headers already available as extra data */
 498         p_sys->i_num_headers = ((unsigned char*)p_dec->fmt_in.p_extra)[0];
 499         p_sys->i_headers = p_sys->i_num_headers;
 500     }
 501     else if( kp.nbytes && (p_sys->i_headers==0 || p_sys->i_headers < p_sys->ki.num_headers ))
 502     {
 503         /* Backup headers as extra data */
 504         uint8_t *p_extra;
 505
 506         p_dec->fmt_in.p_extra =
 507             realloc( p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra + kp.nbytes + 2 );
 508         p_extra = (void*)(((unsigned char*)p_dec->fmt_in.p_extra) + p_dec->fmt_in.i_extra);
 509         *(p_extra++) = kp.nbytes >> 8;
 510         *(p_extra++) = kp.nbytes & 0xFF;
 511
 512         memcpy( p_extra, kp.data, kp.nbytes );
 513         p_dec->fmt_in.i_extra += kp.nbytes + 2;
 514
 515         block_Release( *pp_block );
 516         p_sys->i_num_headers = ((unsigned char*)p_dec->fmt_in.p_extra)[0];
 517         p_sys->i_headers++;
 518         return NULL;
 519     }
 520
 521     if( p_sys->i_headers == p_sys->i_num_headers && p_sys->i_num_headers>0 )
 522     {
 523         if( ProcessHeaders( p_dec ) != VLC_SUCCESS )
 524         {
 525             p_sys->i_headers = 0;
 526             p_dec->fmt_in.i_extra = 0;
 527             block_Release( *pp_block );
 528             return NULL;
 529         }
 530         else p_sys->i_headers++;
 531     }
 532
 533     return ProcessPacket( p_dec, &kp, pp_block );
 534 }
 535
 536 /*****************************************************************************
 537  * ProcessHeaders: process Kate headers.
 538  *****************************************************************************/
 539 static int ProcessHeaders( decoder_t *p_dec )
 540 {
 541     decoder_sys_t *p_sys = p_dec->p_sys;
 542     kate_packet kp;
 543     uint8_t *p_extra;
 544     int i_extra;
 545     int i_headeridx;
 546     int i_ret;
 547
 548     if( !p_dec->fmt_in.i_extra ) return VLC_EGENERIC;
 549
 550     p_extra = p_dec->fmt_in.p_extra;
 551     i_extra = p_dec->fmt_in.i_extra;
 552
 553     /* skip number of headers */
 554     ++p_extra;
 555     --i_extra;
 556
 557     /* Take care of the initial Kate header */
 558     kp.nbytes = *(p_extra++) << 8;
 559     kp.nbytes |= (*(p_extra++) & 0xFF);
 560     kp.data = p_extra;
 561     p_extra += kp.nbytes;
 562     i_extra -= (kp.nbytes + 2);
 563     if( i_extra < 0 )
 564     {
 565         msg_Err( p_dec, "header data corrupted");
 566         return VLC_EGENERIC;
 567     }
 568
 569     i_ret = kate_decode_headerin( &p_sys->ki, &p_sys->kc, &kp );
 570     if( i_ret < 0 )
 571     {
 572         msg_Err( p_dec, "this bitstream does not contain Kate data (%d)", i_ret );
 573         return VLC_EGENERIC;
 574     }
 575
 576     msg_Dbg( p_dec, "%s %s text, granule rate %f, granule shift %d",
 577              p_sys->ki.language, p_sys->ki.category,
 578              (double)p_sys->ki.gps_numerator/p_sys->ki.gps_denominator,
 579              p_sys->ki.granule_shift);
 580
 581     /* parse all remaining header packets */
 582     for( i_headeridx = 1; i_headeridx < p_sys->ki.num_headers; ++i_headeridx )
 583     {
 584         kp.nbytes = *(p_extra++) << 8;
 585         kp.nbytes |= (*(p_extra++) & 0xFF);
 586         kp.data = p_extra;
 587         p_extra += kp.nbytes;
 588         i_extra -= (kp.nbytes + 2);
 589         if( i_extra < 0 )
 590         {
 591             msg_Err( p_dec, "header %d data corrupted", i_headeridx );
 592             return VLC_EGENERIC;
 593         }
 594
 595         i_ret = kate_decode_headerin( &p_sys->ki, &p_sys->kc, &kp );
 596         if( i_ret < 0 )
 597         {
 598             msg_Err( p_dec, "Kate header %d is corrupted: %d", i_headeridx, i_ret );
 599             return VLC_EGENERIC;
 600         }
 601
 602         /* header 1 is comments */
 603         if( i_headeridx == 1 )
 604         {
 605             ParseKateComments( p_dec );
 606         }
 607     }
 608
 609 #ifdef ENABLE_PACKETIZER
 610     if( !p_sys->b_packetizer )
 611 #endif
 612     {
 613         /* We have all the headers, initialize decoder */
 614         msg_Dbg( p_dec, "we have all headers, initialize libkate for decoding" );
 615         i_ret = kate_decode_init( &p_sys->k, &p_sys->ki );
 616         if (i_ret < 0)
 617         {
 618             msg_Err( p_dec, "Kate failed to initialize for decoding: %d", i_ret );
 619             return VLC_EGENERIC;
 620         }
 621         p_sys->b_ready = true;
 622     }
 623 #ifdef ENABLE_PACKETIZER
 624     else
 625     {
 626         p_dec->fmt_out.i_extra = p_dec->fmt_in.i_extra;
 627         p_dec->fmt_out.p_extra =
 628             realloc( p_dec->fmt_out.p_extra, p_dec->fmt_out.i_extra );
 629         memcpy( p_dec->fmt_out.p_extra,
 630                 p_dec->fmt_in.p_extra, p_dec->fmt_out.i_extra );
 631     }
 632 #endif
 633
 634     return VLC_SUCCESS;
 635 }
 636
 637 /*****************************************************************************
 638  * ProcessPacket: processes a kate packet.
 639  *****************************************************************************/
 640 static subpicture_t *ProcessPacket( decoder_t *p_dec, kate_packet *p_kp,
 641                             block_t **pp_block )
 642 {
 643     decoder_sys_t *p_sys = p_dec->p_sys;
 644     block_t *p_block = *pp_block;
 645     subpicture_t *p_buf = NULL;
 646
 647     /* Date management */
 648     if( p_block->i_pts > 0 && p_block->i_pts != p_sys->i_pts )
 649     {
 650         p_sys->i_pts = p_block->i_pts;
 651     }
 652
 653     *pp_block = NULL; /* To avoid being fed the same packet again */
 654
 655 #ifdef ENABLE_PACKETIZER
 656     if( p_sys->b_packetizer )
 657     {
 658         /* Date management */
 659         p_block->i_dts = p_block->i_pts = p_sys->i_pts;
 660
 661         if( p_sys->i_headers >= p_sys->i_num_headers )
 662             p_block->i_length = p_sys->i_pts - p_block->i_pts;
 663         else
 664             p_block->i_length = 0;
 665
 666         p_buf = p_block;
 667     }
 668     else
 669 #endif
 670     {
 671         if( p_sys->i_headers >= p_sys->i_num_headers && p_sys->i_num_headers > 0)
 672             p_buf = DecodePacket( p_dec, p_kp, p_block );
 673         else
 674             p_buf = NULL;
 675
 676         if( p_block ) block_Release( p_block );
 677     }
 678
 679     return p_buf;
 680 }
 681
 682 /* nicked off blend.c */
 683 static inline void rgb_to_yuv( uint8_t *y, uint8_t *u, uint8_t *v,
 684                                int r, int g, int b )
 685 {
 686     *y = ( ( (  66 * r + 129 * g +  25 * b + 128 ) >> 8 ) + 16 );
 687     *u =   ( ( -38 * r -  74 * g + 112 * b + 128 ) >> 8 ) + 128 ;
 688     *v =   ( ( 112 * r -  94 * g -  18 * b + 128 ) >> 8 ) + 128 ;
 689 }
 690
 691 /*
 692   This retrieves the size of the video.
 693   The best case is when the original video size is known, as we can then
 694   scale images to match. In this case, since VLC autoscales, we want to
 695   return the original size and let VLC scale everything.
 696   if the original size is not known, then VLC can't resize, so we return
 697   the size of the incoming video. If sizes in the Kate stream are in
 698   relative units, it works fine. If they are absolute, you get what you
 699   ask for. Images aren't rescaled.
 700 */
 701 static void GetVideoSize( decoder_t *p_dec, int *w, int *h )
 702 {
 703     /* searching for vout to get its size is frowned upon, so we don't and
 704        use a default size if the original canvas size is not specified. */
 705 #if 1
 706     decoder_sys_t *p_sys = p_dec->p_sys;
 707     if( p_sys->ki.original_canvas_width > 0 && p_sys->ki.original_canvas_height > 0 )
 708     {
 709         *w = p_sys->ki.original_canvas_width;
 710         *h = p_sys->ki.original_canvas_height;
 711         msg_Dbg( p_dec, "original canvas %zu %zu",
 712                  p_sys->ki.original_canvas_width, p_sys->ki.original_canvas_height );
 713     }
 714     else
 715     {
 716         /* nothing, leave defaults */
 717         msg_Dbg( p_dec, "original canvas size unknown");
 718     }
 719 #else
 720     /* keep this just in case it might be allowed one day ;) */
 721     vout_thread_t *p_vout;
 722     p_vout = vlc_object_find( (vlc_object_t*)p_dec, VLC_OBJECT_VOUT, FIND_CHILD );
 723     if( p_vout )
 724     {
 725         decoder_sys_t *p_sys = p_dec->p_sys;
 726         if( p_sys->ki.original_canvas_width > 0 && p_sys->ki.original_canvas_height > 0 )
 727         {
 728             *w = p_sys->ki.original_canvas_width;
 729             *h = p_sys->ki.original_canvas_height;
 730         }
 731         else
 732         {
 733             *w = p_vout->fmt_in.i_width;
 734             *h = p_vout->fmt_in.i_height;
 735         }
 736         msg_Dbg( p_dec, "video: in %d %d, out %d %d, original canvas %zu %zu",
 737                  p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
 738                  p_vout->fmt_out.i_width, p_vout->fmt_out.i_height,
 739                  p_sys->ki.original_canvas_width, p_sys->ki.original_canvas_height );
 740         vlc_object_release( p_vout );
 741     }
 742 #endif
 743 }
 744
 745 static void CreateKateBitmap( picture_t *pic, const kate_bitmap *bitmap )
 746 {
 747     size_t y;
 748
 749     for( y=0; y<bitmap->height; ++y )
 750     {
 751         uint8_t *dest = pic->Y_PIXELS+pic->Y_PITCH*y;
 752         const uint8_t *src = bitmap->pixels+y*bitmap->width;
 753         memcpy( dest, src, bitmap->width );
 754     }
 755 }
 756
 757 static void CreateKatePalette( video_palette_t *fmt_palette, const kate_palette *palette )
 758 {
 759     size_t n;
 760
 761     fmt_palette->i_entries = palette->ncolors;
 762     for( n=0; n<palette->ncolors; ++n )
 763     {
 764         rgb_to_yuv(
 765             &fmt_palette->palette[n][0], &fmt_palette->palette[n][1], &fmt_palette->palette[n][2],
 766             palette->colors[n].r, palette->colors[n].g, palette->colors[n].b
 767         );
 768         fmt_palette->palette[n][3] = palette->colors[n].a;
 769     }
 770 }
 771
 772 static void SetupText( decoder_t *p_dec, subpicture_t *p_spu, const kate_event *ev )
 773 {
 774     decoder_sys_t *p_sys = p_dec->p_sys;
 775
 776     if( ev->text_encoding != kate_utf8 )
 777     {
 778         msg_Warn( p_dec, "Text isn't UTF-8, unsupported, ignored" );
 779         return;
 780     }
 781
 782     switch( ev->text_markup_type )
 783     {
 784         case kate_markup_none:
 785             p_spu->p_region->psz_text = strdup( ev->text ); /* no leak, this actually gets killed by the core */
 786             break;
 787         case kate_markup_simple:
 788             if( p_sys->b_formatted )
 789             {
 790                 /* the HTML renderer expects a top level text tag pair */
 791                 char *buffer = NULL;
 792                 if( asprintf( &buffer, "<text>%s</text>", ev->text ) >= 0 )
 793                 {
 794                     p_spu->p_region->psz_html = buffer;
 795                 }
 796                 break;
 797             }
 798             /* if not formatted, we fall through */
 799         default:
 800             /* we don't know about this one, so remove markup and display as text */
 801             {
 802                 char *copy = strdup( ev->text );
 803                 size_t len0 = strlen( copy ) + 1;
 804                 kate_text_remove_markup( ev->text_encoding, copy, &len0 );
 805                 p_spu->p_region->psz_text = copy;
 806             }
 807             break;
 808     }
 809 }
 810
 811 #ifdef HAVE_TIGER
 812
 813 static void TigerDestroySubpicture( subpicture_t *p_subpic )
 814 {
 815     DecSysRelease( p_subpic->p_sys->p_dec_sys );
 816 }
 817
 818 static void SubpictureReleaseRegions( subpicture_t *p_subpic )
 819 {
 820     if( p_subpic->p_region)
 821     {
 822         subpicture_region_ChainDelete( p_subpic->p_region );
 823         p_subpic->p_region = NULL;
 824     }
 825 }
 826
 827 /*
 828  * We get premultiplied alpha, but VLC doesn't expect this, so we demultiply
 829  * alpha to avoid double multiply (and thus thinner text than we should)).
 830  * Best would be to have VLC be able to handle premultiplied alpha, as it
 831  * would be faster to blend as well.
 832  *
 833  * Also, we flip color components around for big endian machines, as Tiger
 834  * outputs ARGB or ABGR (the one we selected here) in host endianness.
 835  */
 836 static void PostprocessTigerImage( plane_t *p_plane, unsigned int i_width )
 837 {
 838     PROFILE_START( tiger_renderer_postprocess );
 839     int y;
 840     for( y=0; y<p_plane->i_lines; ++y )
 841     {
 842         uint8_t *p_line = (uint8_t*)(p_plane->p_pixels + y*p_plane->i_pitch);
 843         unsigned int x;
 844         for( x=0; x<i_width; ++x )
 845         {
 846             uint8_t *p_pixel = p_line+x*4;
 847 #ifdef WORDS_BIGENDIAN
 848             uint8_t a = p_pixel[0];
 849 #else
 850             uint8_t a = p_pixel[3];
 851 #endif
 852             if( a )
 853             {
 854 #ifdef WORDS_BIGENDIAN
 855                 uint8_t tmp = p_pixel[2];
 856                 p_pixel[0] = p_pixel[3] * 255 / a;
 857                 p_pixel[3] = a;
 858                 p_pixel[2] = p_pixel[1] * 255 / a;
 859                 p_pixel[1] = tmp * 255 / a;
 860 #else
 861                 p_pixel[0] = p_pixel[0] * 255 / a;
 862                 p_pixel[1] = p_pixel[1] * 255 / a;
 863                 p_pixel[2] = p_pixel[2] * 255 / a;
 864 #endif
 865             }
 866             else
 867             {
 868                 p_pixel[0] = 0;
 869                 p_pixel[1] = 0;
 870                 p_pixel[2] = 0;
 871                 p_pixel[3] = 0;
 872             }
 873         }
 874     }
 875     PROFILE_STOP( tiger_renderer_postprocess );
 876 }
 877
 878 /* Tiger renders can end up looking a bit crap since they get overlaid on top of
 879    a subsampled YUV image, so there can be a fair amount of chroma bleeding.
 880    Looks good with white though since it's all luma. Hopefully that will be the
 881    common case. */
 882 static void TigerUpdateRegions( spu_t *p_spu, subpicture_t *p_subpic, const video_format_t *p_fmt, mtime_t ts )
 883 {
 884     decoder_sys_t *p_sys = p_subpic->p_sys->p_dec_sys;
 885     subpicture_region_t *p_r;
 886     video_format_t fmt;
 887     plane_t *p_plane;
 888     kate_float t;
 889     int i_ret;
 890
 891     VLC_UNUSED( p_spu );
 892
 893     PROFILE_START( TigerUpdateRegions );
 894
 895     /* do not render more than once per frame, libtiger renders all events at once */
 896     if (ts <= p_sys->last_render_ts)
 897     {
 898         SubpictureReleaseRegions( p_subpic );
 899         return;
 900     }
 901
 902     /* remember what frame we've rendered already */
 903     p_sys->last_render_ts = ts;
 904
 905     /* time in seconds from the start of the stream */
 906     t = (p_subpic->p_sys->i_start + ts - p_subpic->i_start ) / 1000000.0f;
 907
 908     /* it is likely that the current region (if any) can be kept as is; test for this */
 909     vlc_mutex_lock( &p_sys->lock );
 910     if( p_subpic->p_region && !p_sys->b_dirty && !tiger_renderer_is_dirty( p_sys->p_tr ))
 911     {
 912         PROFILE_START( tiger_renderer_update1 );
 913         i_ret = tiger_renderer_update( p_sys->p_tr, t, 1 );
 914         PROFILE_STOP( tiger_renderer_update1 );
 915         if( i_ret < 0 )
 916         {
 917             SubpictureReleaseRegions( p_subpic );
 918             vlc_mutex_unlock( &p_sys->lock );
 919             return;
 920         }
 921
 922         if( !tiger_renderer_is_dirty( p_sys->p_tr ) )
 923         {
 924             /* we can keep the current region list */
 925             PROFILE_STOP( TigerUpdateRegions );
 926             vlc_mutex_unlock( &p_sys->lock );
 927             return;
 928         }
 929     }
 930     vlc_mutex_unlock( &p_sys->lock );
 931
 932     /* we have to render again, reset current region list */
 933     SubpictureReleaseRegions( p_subpic );
 934
 935     /* create a full frame region - this will also tell Tiger the size of the frame */
 936     fmt = *p_fmt;
 937     fmt.i_chroma = VLC_CODEC_RGBA;
 938     fmt.i_width = fmt.i_visible_width;
 939     fmt.i_height = fmt.i_visible_height;
 940     fmt.i_bits_per_pixel = 0;
 941     fmt.i_x_offset = fmt.i_y_offset = 0;
 942
 943     p_r = subpicture_region_New( &fmt );
 944     if( !p_r )
 945     {
 946         return;
 947     }
 948
 949     p_r->i_x = 0;
 950     p_r->i_y = 0;
 951     p_r->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
 952
 953     vlc_mutex_lock( &p_sys->lock );
 954
 955     p_plane = &p_r->p_picture->p[0];
 956     i_ret = tiger_renderer_set_buffer( p_sys->p_tr, p_plane->p_pixels, fmt.i_width, p_plane->i_lines, p_plane->i_pitch, 1 );
 957     if( i_ret < 0 )
 958     {
 959         goto failure;
 960     }
 961
 962     PROFILE_START( tiger_renderer_update );
 963     i_ret = tiger_renderer_update( p_sys->p_tr, t, 1 );
 964     if( i_ret < 0 )
 965     {
 966         goto failure;
 967     }
 968     PROFILE_STOP( tiger_renderer_update );
 969
 970     PROFILE_START( tiger_renderer_render );
 971     i_ret = tiger_renderer_render( p_sys->p_tr );
 972     if( i_ret < 0 )
 973     {
 974         goto failure;
 975     }
 976     PROFILE_STOP( tiger_renderer_render );
 977
 978     PostprocessTigerImage( p_plane, fmt.i_width );
 979     p_subpic->p_region = p_r;
 980     p_sys->b_dirty = false;
 981
 982     PROFILE_STOP( TigerUpdateRegions );
 983
 984     vlc_mutex_unlock( &p_sys->lock );
 985
 986     return;
 987
 988 failure:
 989     vlc_mutex_unlock( &p_sys->lock );
 990     subpicture_region_ChainDelete( p_r );
 991 }
 992
 993 static uint32_t GetTigerColor( decoder_t *p_dec, const char *psz_prefix )
 994 {
 995     char *psz_tmp;
 996     uint32_t i_color = 0;
 997
 998     if( asprintf( &psz_tmp, "%s-color", psz_prefix ) >= 0 )
 999     {
1000         uint32_t i_rgb = var_CreateGetInteger( p_dec, psz_tmp );
1001         var_Destroy( p_dec, psz_tmp );
1002         free( psz_tmp );
1003         i_color |= i_rgb;
1004     }
1005
1006     if( asprintf( &psz_tmp, "%s-alpha", psz_prefix ) >= 0 )
1007     {
1008         uint32_t i_alpha = var_CreateGetInteger( p_dec, psz_tmp );
1009         var_Destroy( p_dec, psz_tmp );
1010         free( psz_tmp );
1011         i_color |= (i_alpha << 24);
1012     }
1013
1014     return i_color;
1015 }
1016
1017 static char *GetTigerString( decoder_t *p_dec, const char *psz_name )
1018 {
1019     char *psz_value = var_CreateGetString( p_dec, psz_name );
1020     if( psz_value)
1021     {
1022         psz_value = strdup( psz_value );
1023     }
1024     var_Destroy( p_dec, psz_name );
1025     return psz_value;
1026 }
1027
1028 static int GetTigerInteger( decoder_t *p_dec, const char *psz_name )
1029 {
1030     int i_value = var_CreateGetInteger( p_dec, psz_name );
1031     var_Destroy( p_dec, psz_name );
1032     return i_value;
1033 }
1034
1035 static double GetTigerFloat( decoder_t *p_dec, const char *psz_name )
1036 {
1037     double f_value = var_CreateGetFloat( p_dec, psz_name );
1038     var_Destroy( p_dec, psz_name );
1039     return f_value;
1040 }
1041
1042 static void UpdateTigerQuality( decoder_t *p_dec )
1043 {
1044     decoder_sys_t *p_sys = (decoder_sys_t*)p_dec->p_sys;
1045     CHECK_TIGER_RET( tiger_renderer_set_quality( p_sys->p_tr, p_sys->f_tiger_quality ) );
1046     p_sys->b_dirty = true;
1047 }
1048
1049 static void UpdateTigerFontDesc( decoder_t *p_dec )
1050 {
1051     decoder_sys_t *p_sys = (decoder_sys_t*)p_dec->p_sys;
1052     CHECK_TIGER_RET( tiger_renderer_set_default_font_description( p_sys->p_tr, p_sys->psz_tiger_default_font_desc ) );
1053     p_sys->b_dirty = true;
1054 }
1055
1056 static void UpdateTigerFontColor( decoder_t *p_dec )
1057 {
1058     decoder_sys_t *p_sys = (decoder_sys_t*)p_dec->p_sys;
1059     double f_a = ((p_sys->i_tiger_default_font_color >> 24) & 0xff) / 255.0;
1060     double f_r = ((p_sys->i_tiger_default_font_color >> 16) & 0xff) / 255.0;
1061     double f_g = ((p_sys->i_tiger_default_font_color >> 8) & 0xff) / 255.0;
1062     double f_b = (p_sys->i_tiger_default_font_color & 0xff) / 255.0;
1063     CHECK_TIGER_RET( tiger_renderer_set_default_font_color( p_sys->p_tr, f_r, f_g, f_b, f_a ) );
1064     p_sys->b_dirty = true;
1065 }
1066
1067 static void UpdateTigerBackgroundColor( decoder_t *p_dec )
1068 {
1069     decoder_sys_t *p_sys = (decoder_sys_t*)p_dec->p_sys;
1070     double f_a = ((p_sys->i_tiger_default_background_color >> 24) & 0xff) / 255.0;
1071     double f_r = ((p_sys->i_tiger_default_background_color >> 16) & 0xff) / 255.0;
1072     double f_g = ((p_sys->i_tiger_default_background_color >> 8) & 0xff) / 255.0;
1073     double f_b = (p_sys->i_tiger_default_background_color & 0xff) / 255.0;
1074     CHECK_TIGER_RET( tiger_renderer_set_default_background_fill_color( p_sys->p_tr, f_r, f_g, f_b, f_a ) );
1075     p_sys->b_dirty = true;
1076 }
1077
1078 static void UpdateTigerFontEffect( decoder_t *p_dec )
1079 {
1080     decoder_sys_t *p_sys = (decoder_sys_t*)p_dec->p_sys;
1081     CHECK_TIGER_RET( tiger_renderer_set_default_font_effect( p_sys->p_tr,
1082                                                              p_sys->e_tiger_default_font_effect,
1083                                                              p_sys->f_tiger_default_font_effect_strength ) );
1084     p_sys->b_dirty = true;
1085 }
1086
1087 static int OnConfigurationChanged( decoder_t *p_dec, const char *psz_var,
1088                                    vlc_value_t oldval, vlc_value_t newval )
1089 {
1090     decoder_sys_t *p_sys = (decoder_sys_t*)p_dec->p_sys;
1091
1092     VLC_UNUSED( oldval );
1093
1094     vlc_mutex_lock( &p_sys->lock );
1095
1096     msg_Dbg( p_dec, "OnConfigurationChanged: %s", psz_var );
1097
1098     if( !p_sys->b_use_tiger || !p_sys->p_tr )
1099     {
1100         vlc_mutex_unlock( &p_sys->lock );
1101         return VLC_SUCCESS;
1102     }
1103
1104 #define TEST_TIGER_VAR( name ) \
1105     if( !strcmp( name, psz_var ) )
1106
1107     TEST_TIGER_VAR( "kate-tiger-quality" )
1108     {
1109         p_sys->f_tiger_quality = newval.f_float;
1110         UpdateTigerQuality( p_dec );
1111     }
1112
1113     TEST_TIGER_VAR( "kate-tiger-default-font-desc" )
1114     {
1115         if( p_sys->psz_tiger_default_font_desc )
1116         {
1117             free( p_sys->psz_tiger_default_font_desc );
1118             p_sys->psz_tiger_default_font_desc = NULL;
1119         }
1120         if( newval.psz_string )
1121         {
1122             p_sys->psz_tiger_default_font_desc = strdup( newval.psz_string );
1123         }
1124         UpdateTigerFontDesc( p_dec );
1125     }
1126
1127     TEST_TIGER_VAR( "kate-tiger-default-font-color" )
1128     {
1129         p_sys->i_tiger_default_font_color = (p_sys->i_tiger_default_font_color & 0xff00000000) | newval.i_int;
1130         UpdateTigerFontColor( p_dec );
1131     }
1132
1133     TEST_TIGER_VAR( "kate-tiger-default-font-alpha" )
1134     {
1135         p_sys->i_tiger_default_font_color = (p_sys->i_tiger_default_font_color & 0x00ffffff) | (newval.i_int<<24);
1136         UpdateTigerFontColor( p_dec );
1137     }
1138
1139     TEST_TIGER_VAR( "kate-tiger-default-background-color" )
1140     {
1141         p_sys->i_tiger_default_background_color = (p_sys->i_tiger_default_background_color & 0xff00000000) | newval.i_int;
1142         UpdateTigerBackgroundColor( p_dec );
1143     }
1144
1145     TEST_TIGER_VAR( "kate-tiger-default-background-alpha" )
1146     {
1147         p_sys->i_tiger_default_background_color = (p_sys->i_tiger_default_background_color & 0x00ffffff) | (newval.i_int<<24);
1148         UpdateTigerBackgroundColor( p_dec );
1149     }
1150
1151     TEST_TIGER_VAR( "kate-tiger-default-font-effect" )
1152     {
1153         p_sys->e_tiger_default_font_effect = (tiger_font_effect)newval.i_int;
1154         UpdateTigerFontEffect( p_dec );
1155     }
1156
1157     TEST_TIGER_VAR( "kate-tiger-default-font-effect-strength" )
1158     {
1159         p_sys->f_tiger_default_font_effect_strength = newval.f_float;
1160         UpdateTigerFontEffect( p_dec );
1161     }
1162
1163 #undef TEST_TIGER_VAR
1164
1165     vlc_mutex_unlock( &p_sys->lock );
1166
1167     return VLC_SUCCESS;
1168 }
1169
1170 static int TigerConfigurationCallback( vlc_object_t *p_this, const char *psz_var,
1171                                        vlc_value_t oldval, vlc_value_t newval,
1172                                        void *p_data )
1173 {
1174     size_t i_idx;
1175
1176     VLC_UNUSED( p_this );
1177     VLC_UNUSED( oldval );
1178     VLC_UNUSED( newval );
1179     VLC_UNUSED( p_data );
1180
1181     vlc_mutex_lock( &kate_decoder_list_mutex );
1182
1183     /* Update all existing decoders from the global user prefs */
1184     for( i_idx = 0; i_idx < kate_decoder_list_size; i_idx++ )
1185     {
1186         decoder_t *p_dec = kate_decoder_list[ i_idx ];
1187         OnConfigurationChanged( p_dec, psz_var, oldval, newval );
1188     }
1189
1190     vlc_mutex_unlock( &kate_decoder_list_mutex );
1191
1192     return VLC_SUCCESS;
1193 }
1194
1195 #endif
1196
1197 /*****************************************************************************
1198  * DecodePacket: decodes a Kate packet.
1199  *****************************************************************************/
1200 static subpicture_t *DecodePacket( decoder_t *p_dec, kate_packet *p_kp, block_t *p_block )
1201 {
1202     decoder_sys_t *p_sys = p_dec->p_sys;
1203     const kate_event *ev = NULL;
1204     subpicture_t *p_spu = NULL;
1205     int i_ret;
1206
1207     if( !p_sys->b_ready )
1208     {
1209         msg_Err( p_dec, "Cannot decode Kate packet, decoder not initialized" );
1210         return NULL;
1211     }
1212
1213     i_ret = kate_decode_packetin( &p_sys->k, p_kp );
1214     if( i_ret < 0 )
1215     {
1216         msg_Err( p_dec, "Kate failed to decode packet: %d", i_ret );
1217         return NULL;
1218     }
1219
1220     i_ret = kate_decode_eventout( &p_sys->k, &ev );
1221     if( i_ret < 0 )
1222     {
1223         msg_Err( p_dec, "Kate failed to retrieve event: %d", i_ret );
1224         return NULL;
1225     }
1226     if( i_ret > 0 )
1227     {
1228         /* no event to go with this packet, this is normal */
1229         return NULL;
1230     }
1231
1232     /* we have an event */
1233
1234     /* Get a new spu */
1235     p_spu = decoder_NewSubpicture( p_dec );
1236     if( !p_spu )
1237     {
1238         /* this will happen for lyrics as there is no vout - so no error */
1239         /* msg_Err( p_dec, "Failed to allocate spu buffer" ); */
1240         return NULL;
1241     }
1242
1243     p_spu->i_start = p_block->i_pts;
1244     p_spu->i_stop = p_block->i_pts + INT64_C(1000000)*ev->duration*p_sys->ki.gps_denominator/p_sys->ki.gps_numerator;
1245     p_spu->b_ephemer = false;
1246     p_spu->b_absolute = false;
1247
1248 #ifdef HAVE_TIGER
1249     if( p_sys->b_use_tiger)
1250     {
1251         /* setup the structure to get our decoder struct back */
1252         p_spu->p_sys = malloc( sizeof( subpicture_sys_t ));
1253         if( !p_spu->p_sys )
1254         {
1255             decoder_DeleteSubpicture( p_dec, p_spu );
1256             return NULL;
1257         }
1258         p_spu->p_sys->p_dec_sys = p_sys;
1259         p_spu->p_sys->i_start = p_block->i_pts;
1260         DecSysHold( p_sys );
1261
1262         p_spu->i_stop = __MAX( p_sys->i_max_stop, p_spu->i_stop );
1263         p_spu->b_ephemer = true;
1264         p_spu->b_absolute = true;
1265
1266         /* add the event to tiger */
1267         vlc_mutex_lock( &p_sys->lock );
1268         CHECK_TIGER_RET( tiger_renderer_add_event( p_sys->p_tr, ev->ki, ev ) );
1269         vlc_mutex_unlock( &p_sys->lock );
1270
1271         /* hookup render/update routines */
1272         p_spu->pf_update_regions = TigerUpdateRegions;
1273         p_spu->pf_destroy = TigerDestroySubpicture;
1274     }
1275     else
1276 #endif
1277     {
1278         p_spu = SetupSimpleKateSPU( p_dec, p_spu, ev );
1279     }
1280
1281     return p_spu;
1282 }
1283
1284 /*****************************************************************************
1285  * SetupSimpleKateSPU: creates text/bitmap regions where appropriate
1286  *****************************************************************************/
1287 static subpicture_t *SetupSimpleKateSPU( decoder_t *p_dec, subpicture_t *p_spu,
1288                                          const kate_event *ev )
1289 {
1290     decoder_sys_t *p_sys = p_dec->p_sys;
1291     video_format_t fmt;
1292     subpicture_region_t *p_bitmap_region = NULL;
1293     video_palette_t palette;
1294     kate_tracker kin;
1295     bool b_tracker_valid = false;
1296     int i_ret;
1297
1298     /* these may be 0 for "not specified" */
1299     p_spu->i_original_picture_width = p_sys->ki.original_canvas_width;
1300     p_spu->i_original_picture_height = p_sys->ki.original_canvas_height;
1301
1302     /* Create a new subpicture region */
1303     memset( &fmt, 0, sizeof(video_format_t) );
1304
1305     if (p_sys->b_formatted)
1306     {
1307         i_ret = kate_tracker_init( &kin, &p_sys->ki, ev );
1308         if( i_ret < 0)
1309         {
1310             msg_Err( p_dec, "failed to initialize kate tracker, event will be unformatted: %d", i_ret );
1311         }
1312         else
1313         {
1314             int w = 720, h = 576; /* give sensible defaults just in case we fail to get the actual size */
1315             GetVideoSize(p_dec, &w, &h);
1316             i_ret = kate_tracker_update(&kin, 0, w, h, 0, 0, w, h);
1317             if( i_ret < 0)
1318             {
1319                 kate_tracker_clear(&kin);
1320                 msg_Err( p_dec, "failed to update kate tracker, event will be unformatted: %d", i_ret );
1321             }
1322             else
1323             {
1324                 // TODO: parse tracker and set style, init fmt
1325                 b_tracker_valid = true;
1326             }
1327         }
1328     }
1329
1330     if (ev->bitmap && ev->bitmap->type==kate_bitmap_type_paletted && ev->palette) {
1331
1332         /* create a separate region for the bitmap */
1333         memset( &fmt, 0, sizeof(video_format_t) );
1334         fmt.i_chroma = VLC_CODEC_YUVP;
1335         fmt.i_aspect = 0;
1336         fmt.i_width = fmt.i_visible_width = ev->bitmap->width;
1337         fmt.i_height = fmt.i_visible_height = ev->bitmap->height;
1338         fmt.i_x_offset = fmt.i_y_offset = 0;
1339         fmt.p_palette = &palette;
1340         CreateKatePalette( fmt.p_palette, ev->palette );
1341
1342         p_bitmap_region = subpicture_region_New( &fmt );
1343         if( !p_bitmap_region )
1344         {
1345             msg_Err( p_dec, "cannot allocate SPU region" );
1346             decoder_DeleteSubpicture( p_dec, p_spu );
1347             return NULL;
1348         }
1349
1350         /* create the bitmap */
1351         CreateKateBitmap( p_bitmap_region->p_picture, ev->bitmap );
1352
1353         msg_Dbg(p_dec, "Created bitmap, %zux%zu, %zu colors", ev->bitmap->width, ev->bitmap->height, ev->palette->ncolors);
1354     }
1355
1356     /* text region */
1357     fmt.i_chroma = VLC_CODEC_TEXT;
1358     fmt.i_aspect = 0;
1359     fmt.i_width = fmt.i_height = 0;
1360     fmt.i_x_offset = fmt.i_y_offset = 0;
1361     p_spu->p_region = subpicture_region_New( &fmt );
1362     if( !p_spu->p_region )
1363     {
1364         msg_Err( p_dec, "cannot allocate SPU region" );
1365         decoder_DeleteSubpicture( p_dec, p_spu );
1366         return NULL;
1367     }
1368
1369     SetupText( p_dec, p_spu, ev );
1370
1371     /* default positioning */
1372     p_spu->p_region->i_align = SUBPICTURE_ALIGN_BOTTOM;
1373     if (p_bitmap_region)
1374     {
1375         p_bitmap_region->i_align = SUBPICTURE_ALIGN_BOTTOM;
1376     }
1377     p_spu->p_region->i_x = 0;
1378     p_spu->p_region->i_y = 10;
1379
1380     /* override if tracker info present */
1381     if (b_tracker_valid)
1382     {
1383         if (kin.has.region)
1384         {
1385             p_spu->p_region->i_x = kin.region_x;
1386             p_spu->p_region->i_y = kin.region_y;
1387             if (p_bitmap_region)
1388             {
1389                 p_bitmap_region->i_x = kin.region_x;
1390                 p_bitmap_region->i_y = kin.region_y;
1391             }
1392             p_spu->b_absolute = true;
1393         }
1394
1395         kate_tracker_clear(&kin);
1396     }
1397
1398     /* if we have a bitmap, chain it before the text */
1399     if (p_bitmap_region)
1400     {
1401         p_bitmap_region->p_next = p_spu->p_region;
1402         p_spu->p_region = p_bitmap_region;
1403     }
1404
1405     return p_spu;
1406 }
1407
1408 /*****************************************************************************
1409  * ParseKateComments:
1410  *****************************************************************************/
1411 static void ParseKateComments( decoder_t *p_dec )
1412 {
1413     char *psz_name, *psz_value, *psz_comment;
1414     int i = 0;
1415
1416     while ( i < p_dec->p_sys->kc.comments )
1417     {
1418         psz_comment = strdup( p_dec->p_sys->kc.user_comments[i] );
1419         if( !psz_comment )
1420             break;
1421         psz_name = psz_comment;
1422         psz_value = strchr( psz_comment, '=' );
1423         if( psz_value )
1424         {
1425             *psz_value = '\0';
1426             psz_value++;
1427
1428             if( !p_dec->p_description )
1429                 p_dec->p_description = vlc_meta_New();
1430             if( p_dec->p_description )
1431                 vlc_meta_AddExtra( p_dec->p_description, psz_name, psz_value );
1432         }
1433         free( psz_comment );
1434         i++;
1435     }
1436 }
1437
1438 /*****************************************************************************
1439  * CloseDecoder: clean up the decoder
1440  *****************************************************************************/
1441 static void CloseDecoder( vlc_object_t *p_this )
1442 {
1443     decoder_t *p_dec = (decoder_t *)p_this;
1444     size_t     i_index;
1445
1446     /* remove the decoder from the global list */
1447     vlc_mutex_lock( &kate_decoder_list_mutex );
1448     for( i_index = 0; i_index < kate_decoder_list_size; i_index++ )
1449     {
1450         if( kate_decoder_list[ i_index ] == p_dec )
1451         {
1452             kate_decoder_list[ i_index ] = kate_decoder_list[ --kate_decoder_list_size ];
1453             break;
1454         }
1455     }
1456     vlc_mutex_unlock( &kate_decoder_list_mutex );
1457
1458     msg_Dbg( p_dec, "Closing Kate decoder" );
1459     DecSysRelease( p_dec->p_sys );
1460 }
1461
1462 static void DecSysHold( decoder_sys_t *p_sys )
1463 {
1464     vlc_mutex_lock( &p_sys->lock );
1465     p_sys->i_refcount++;
1466     vlc_mutex_unlock( &p_sys->lock );
1467 }
1468
1469 static void DecSysRelease( decoder_sys_t *p_sys )
1470 {
1471     vlc_mutex_lock( &p_sys->lock );
1472     p_sys->i_refcount--;
1473     if( p_sys->i_refcount > 0)
1474     {
1475         vlc_mutex_unlock( &p_sys->lock );
1476         return;
1477     }
1478
1479     vlc_mutex_unlock( &p_sys->lock );
1480     vlc_mutex_destroy( &p_sys->lock );
1481
1482 #ifdef HAVE_TIGER
1483     if( p_sys->p_tr )
1484         tiger_renderer_destroy( p_sys->p_tr );
1485     if( p_sys->psz_tiger_default_font_desc )
1486         free( p_sys->psz_tiger_default_font_desc );
1487 #endif
1488
1489     if (p_sys->b_ready)
1490         kate_clear( &p_sys->k );
1491     kate_info_clear( &p_sys->ki );
1492     kate_comment_clear( &p_sys->kc );
1493
1494     free( p_sys );
1495 }
1496