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

   1 /*****************************************************************************
   2  * spudec.c : SPU decoder thread
   3  *****************************************************************************
   4  * Copyright (C) 2000-2001, 2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Sam Hocevar <sam@zoy.org>
   8  *          Laurent Aimar <fenrir@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33 #include <vlc_plugin.h>
  34 #include <vlc_codec.h>
  35
  36 #include "spudec.h"
  37
  38 /*****************************************************************************
  39  * Module descriptor.
  40  *****************************************************************************/
  41 static int  DecoderOpen   ( vlc_object_t * );
  42 static int  PacketizerOpen( vlc_object_t * );
  43 static void Close         ( vlc_object_t * );
  44
  45 #define DVDSUBTRANS_DISABLE_TEXT N_("Disable DVD subtitle transparency")
  46 #define DVDSUBTRANS_DISABLE_LONGTEXT N_("Removes all transparency effects " \
  47                                         "used in DVD subtitles.")
  48
  49 vlc_module_begin ()
  50     set_description( N_("DVD subtitles decoder") )
  51     set_capability( "decoder", 50 )
  52     set_category( CAT_INPUT )
  53     set_subcategory( SUBCAT_INPUT_SCODEC )
  54     set_callbacks( DecoderOpen, Close )
  55
  56     add_bool( "dvdsub-transparency", false, NULL,
  57               DVDSUBTRANS_DISABLE_TEXT, DVDSUBTRANS_DISABLE_LONGTEXT, true )
  58     add_submodule ()
  59     set_description( N_("DVD subtitles packetizer") )
  60     set_capability( "packetizer", 50 )
  61     set_callbacks( PacketizerOpen, Close )
  62 vlc_module_end ()
  63
  64 /*****************************************************************************
  65  * Local prototypes
  66  *****************************************************************************/
  67 static block_t *      Reassemble( decoder_t *, block_t ** );
  68 static subpicture_t * Decode    ( decoder_t *, block_t ** );
  69 static block_t *      Packetize ( decoder_t *, block_t ** );
  70
  71 /*****************************************************************************
  72  * DecoderOpen
  73  *****************************************************************************
  74  * Tries to launch a decoder and return score so that the interface is able
  75  * to chose.
  76  *****************************************************************************/
  77 static int DecoderOpen( vlc_object_t *p_this )
  78 {
  79     decoder_t     *p_dec = (decoder_t*)p_this;
  80     decoder_sys_t *p_sys;
  81
  82     if( p_dec->fmt_in.i_codec != VLC_CODEC_SPU )
  83         return VLC_EGENERIC;
  84
  85     p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
  86
  87     p_sys->b_packetizer = false;
  88     p_sys->b_disabletrans = var_InheritBool( p_dec, "dvdsub-transparency" );
  89     p_sys->i_spu_size = 0;
  90     p_sys->i_spu      = 0;
  91     p_sys->p_block    = NULL;
  92
  93     es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_CODEC_SPU );
  94
  95     p_dec->pf_decode_sub = Decode;
  96     p_dec->pf_packetize  = NULL;
  97
  98     return VLC_SUCCESS;
  99 }
 100
 101 /*****************************************************************************
 102  * PacketizerOpen
 103  *****************************************************************************
 104  * Tries to launch a decoder and return score so that the interface is able
 105  * to chose.
 106  *****************************************************************************/
 107 static int PacketizerOpen( vlc_object_t *p_this )
 108 {
 109     decoder_t *p_dec = (decoder_t*)p_this;
 110
 111     if( DecoderOpen( p_this ) )
 112     {
 113         return VLC_EGENERIC;
 114     }
 115     p_dec->pf_packetize  = Packetize;
 116     p_dec->p_sys->b_packetizer = true;
 117     es_format_Copy( &p_dec->fmt_out, &p_dec->fmt_in );
 118     p_dec->fmt_out.i_codec = VLC_CODEC_SPU;
 119
 120     return VLC_SUCCESS;
 121 }
 122
 123 /*****************************************************************************
 124  * Close:
 125  *****************************************************************************/
 126 static void Close( vlc_object_t *p_this )
 127 {
 128     decoder_t     *p_dec = (decoder_t*)p_this;
 129     decoder_sys_t *p_sys = p_dec->p_sys;
 130
 131     if( p_sys->p_block )
 132     {
 133         block_ChainRelease( p_sys->p_block );
 134     }
 135
 136     free( p_sys );
 137 }
 138
 139 /*****************************************************************************
 140  * Decode:
 141  *****************************************************************************/
 142 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
 143 {
 144     decoder_sys_t *p_sys = p_dec->p_sys;
 145     block_t       *p_spu_block;
 146     subpicture_t  *p_spu;
 147
 148     p_spu_block = Reassemble( p_dec, pp_block );
 149
 150     if( ! p_spu_block )
 151     {
 152         return NULL;
 153     }
 154
 155     /* FIXME: what the, we shouldn’t need to allocate 64k of buffer --sam. */
 156     p_sys->i_spu = block_ChainExtract( p_spu_block, p_sys->buffer, 65536 );
 157     p_sys->i_pts = p_spu_block->i_pts;
 158     block_ChainRelease( p_spu_block );
 159
 160     /* Parse and decode */
 161     p_spu = ParsePacket( p_dec );
 162
 163     /* reinit context */
 164     p_sys->i_spu_size = 0;
 165     p_sys->i_rle_size = 0;
 166     p_sys->i_spu      = 0;
 167     p_sys->p_block    = NULL;
 168
 169     return p_spu;
 170 }
 171
 172 /*****************************************************************************
 173  * Packetize:
 174  *****************************************************************************/
 175 static block_t *Packetize( decoder_t *p_dec, block_t **pp_block )
 176 {
 177     decoder_sys_t *p_sys = p_dec->p_sys;
 178     block_t       *p_spu = Reassemble( p_dec, pp_block );
 179
 180     if( ! p_spu )
 181     {
 182         return NULL;
 183     }
 184
 185     p_spu->i_dts = p_spu->i_pts;
 186     p_spu->i_length = 0;
 187
 188     /* reinit context */
 189     p_sys->i_spu_size = 0;
 190     p_sys->i_rle_size = 0;
 191     p_sys->i_spu      = 0;
 192     p_sys->p_block    = NULL;
 193
 194     return block_ChainGather( p_spu );
 195 }
 196
 197 /*****************************************************************************
 198  * Reassemble:
 199  *****************************************************************************/
 200 static block_t *Reassemble( decoder_t *p_dec, block_t **pp_block )
 201 {
 202     decoder_sys_t *p_sys = p_dec->p_sys;
 203     block_t *p_block;
 204
 205     if( pp_block == NULL || *pp_block == NULL ) return NULL;
 206     p_block = *pp_block;
 207     *pp_block = NULL;
 208
 209     if( p_sys->i_spu_size <= 0 &&
 210         ( p_block->i_pts <= VLC_TS_INVALID || p_block->i_buffer < 4 ) )
 211     {
 212         msg_Dbg( p_dec, "invalid starting packet (size < 4 or pts <=0)" );
 213         msg_Dbg( p_dec, "spu size: %d, i_pts: %"PRId64" i_buffer: %zu",
 214                  p_sys->i_spu_size, p_block->i_pts, p_block->i_buffer );
 215         block_Release( p_block );
 216         return NULL;
 217     }
 218
 219     block_ChainAppend( &p_sys->p_block, p_block );
 220     p_sys->i_spu += p_block->i_buffer;
 221
 222     if( p_sys->i_spu_size <= 0 )
 223     {
 224         p_sys->i_spu_size = ( p_block->p_buffer[0] << 8 )|
 225             p_block->p_buffer[1];
 226         p_sys->i_rle_size = ( ( p_block->p_buffer[2] << 8 )|
 227             p_block->p_buffer[3] ) - 4;
 228
 229         /* msg_Dbg( p_dec, "i_spu_size=%d i_rle=%d",
 230                     p_sys->i_spu_size, p_sys->i_rle_size ); */
 231
 232         if( p_sys->i_spu_size <= 0 || p_sys->i_rle_size >= p_sys->i_spu_size )
 233         {
 234             p_sys->i_spu_size = 0;
 235             p_sys->i_rle_size = 0;
 236             p_sys->i_spu      = 0;
 237             p_sys->p_block    = NULL;
 238
 239             block_Release( p_block );
 240             return NULL;
 241         }
 242     }
 243
 244     if( p_sys->i_spu >= p_sys->i_spu_size )
 245     {
 246         /* We have a complete sub */
 247         if( p_sys->i_spu > p_sys->i_spu_size )
 248             msg_Dbg( p_dec, "SPU packets size=%d should be %d",
 249                      p_sys->i_spu, p_sys->i_spu_size );
 250
 251         return p_sys->p_block;
 252     }
 253     return NULL;
 254 }