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 #include <vlc/vlc.h>
  29 #include <vlc_codec.h>
  30
  31 #include "spudec.h"
  32
  33 /*****************************************************************************
  34  * Module descriptor.
  35  *****************************************************************************/
  36 static int  DecoderOpen   ( vlc_object_t * );
  37 static int  PacketizerOpen( vlc_object_t * );
  38 static void Close         ( vlc_object_t * );
  39
  40 vlc_module_begin();
  41     set_description( _("DVD subtitles decoder") );
  42     set_capability( "decoder", 50 );
  43     set_category( CAT_INPUT );
  44     set_subcategory( SUBCAT_INPUT_SCODEC );
  45     set_callbacks( DecoderOpen, Close );
  46
  47     add_submodule();
  48     set_description( _("DVD subtitles packetizer") );
  49     set_capability( "packetizer", 50 );
  50     set_callbacks( PacketizerOpen, Close );
  51 vlc_module_end();
  52
  53 /*****************************************************************************
  54  * Local prototypes
  55  *****************************************************************************/
  56 static block_t *      Reassemble( decoder_t *, block_t ** );
  57 static subpicture_t * Decode    ( decoder_t *, block_t ** );
  58 static block_t *      Packetize ( decoder_t *, block_t ** );
  59
  60 /*****************************************************************************
  61  * DecoderOpen
  62  *****************************************************************************
  63  * Tries to launch a decoder and return score so that the interface is able
  64  * to chose.
  65  *****************************************************************************/
  66 static int DecoderOpen( vlc_object_t *p_this )
  67 {
  68     decoder_t     *p_dec = (decoder_t*)p_this;
  69     decoder_sys_t *p_sys;
  70
  71     if( p_dec->fmt_in.i_codec != VLC_FOURCC( 's','p','u',' ' ) &&
  72         p_dec->fmt_in.i_codec != VLC_FOURCC( 's','p','u','b' ) )
  73     {
  74         return VLC_EGENERIC;
  75     }
  76
  77     p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
  78
  79     p_sys->b_packetizer = VLC_FALSE;
  80     p_sys->i_spu_size = 0;
  81     p_sys->i_spu      = 0;
  82     p_sys->p_block    = NULL;
  83
  84     es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
  85
  86     p_dec->pf_decode_sub = Decode;
  87     p_dec->pf_packetize  = NULL;
  88
  89     return VLC_SUCCESS;
  90 }
  91
  92 /*****************************************************************************
  93  * PacketizerOpen
  94  *****************************************************************************
  95  * Tries to launch a decoder and return score so that the interface is able
  96  * to chose.
  97  *****************************************************************************/
  98 static int PacketizerOpen( vlc_object_t *p_this )
  99 {
 100     decoder_t *p_dec = (decoder_t*)p_this;
 101
 102     if( DecoderOpen( p_this ) )
 103     {
 104         return VLC_EGENERIC;
 105     }
 106     p_dec->pf_packetize  = Packetize;
 107     p_dec->p_sys->b_packetizer = VLC_TRUE;
 108     es_format_Copy( &p_dec->fmt_out, &p_dec->fmt_in );
 109     p_dec->fmt_out.i_codec = VLC_FOURCC( 's','p','u',' ' );
 110
 111     return VLC_SUCCESS;
 112 }
 113
 114 /*****************************************************************************
 115  * Close:
 116  *****************************************************************************/
 117 static void Close( vlc_object_t *p_this )
 118 {
 119     decoder_t     *p_dec = (decoder_t*)p_this;
 120     decoder_sys_t *p_sys = p_dec->p_sys;
 121
 122     if( p_sys->p_block )
 123     {
 124         block_ChainRelease( p_sys->p_block );
 125     }
 126
 127     free( p_sys );
 128 }
 129
 130 /*****************************************************************************
 131  * Decode:
 132  *****************************************************************************/
 133 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
 134 {
 135     decoder_sys_t *p_sys = p_dec->p_sys;
 136     block_t       *p_spu_block;
 137     subpicture_t  *p_spu;
 138
 139     p_spu_block = Reassemble( p_dec, pp_block );
 140
 141     if( ! p_spu_block )
 142     {
 143         return NULL;
 144     }
 145
 146     /* FIXME: what the, we shouldn’t need to allocate 64k of buffer --sam. */
 147     p_sys->i_spu = block_ChainExtract( p_spu_block, p_sys->buffer, 65536 );
 148     p_sys->i_pts = p_spu_block->i_pts;
 149     block_ChainRelease( p_spu_block );
 150
 151     /* Parse and decode */
 152     p_spu = E_(ParsePacket)( p_dec );
 153
 154     /* reinit context */
 155     p_sys->i_spu_size = 0;
 156     p_sys->i_rle_size = 0;
 157     p_sys->i_spu      = 0;
 158     p_sys->p_block    = NULL;
 159
 160     return p_spu;
 161 }
 162
 163 /*****************************************************************************
 164  * Packetize:
 165  *****************************************************************************/
 166 static block_t *Packetize( decoder_t *p_dec, block_t **pp_block )
 167 {
 168     decoder_sys_t *p_sys = p_dec->p_sys;
 169     block_t       *p_spu = Reassemble( p_dec, pp_block );
 170
 171     if( ! p_spu )
 172     {
 173         return NULL;
 174     }
 175
 176     p_spu->i_dts = p_spu->i_pts;
 177     p_spu->i_length = 0;
 178
 179     /* reinit context */
 180     p_sys->i_spu_size = 0;
 181     p_sys->i_rle_size = 0;
 182     p_sys->i_spu      = 0;
 183     p_sys->p_block    = NULL;
 184
 185     return block_ChainGather( p_spu );
 186 }
 187
 188 /*****************************************************************************
 189  * Reassemble:
 190  *****************************************************************************/
 191 static block_t *Reassemble( decoder_t *p_dec, block_t **pp_block )
 192 {
 193     decoder_sys_t *p_sys = p_dec->p_sys;
 194     block_t *p_block;
 195
 196     if( pp_block == NULL || *pp_block == NULL ) return NULL;
 197     p_block = *pp_block;
 198     *pp_block = NULL;
 199
 200     if( p_sys->i_spu_size <= 0 &&
 201         ( p_block->i_pts <= 0 || p_block->i_buffer < 4 ) )
 202     {
 203         msg_Dbg( p_dec, "invalid starting packet (size < 4 or pts <=0)" );
 204         msg_Dbg( p_dec, "spu size: %d, i_pts: "I64Fd" i_buffer: %d",
 205                  p_sys->i_spu_size, p_block->i_pts, p_block->i_buffer );
 206         block_Release( p_block );
 207         return NULL;
 208     }
 209
 210     block_ChainAppend( &p_sys->p_block, p_block );
 211     p_sys->i_spu += p_block->i_buffer;
 212
 213     if( p_sys->i_spu_size <= 0 )
 214     {
 215         p_sys->i_spu_size = ( p_block->p_buffer[0] << 8 )|
 216             p_block->p_buffer[1];
 217         p_sys->i_rle_size = ( ( p_block->p_buffer[2] << 8 )|
 218             p_block->p_buffer[3] ) - 4;
 219
 220         /* msg_Dbg( p_dec, "i_spu_size=%d i_rle=%d",
 221                     p_sys->i_spu_size, p_sys->i_rle_size ); */
 222
 223         if( p_sys->i_spu_size <= 0 || p_sys->i_rle_size >= p_sys->i_spu_size )
 224         {
 225             p_sys->i_spu_size = 0;
 226             p_sys->i_rle_size = 0;
 227             p_sys->i_spu      = 0;
 228             p_sys->p_block    = NULL;
 229
 230             block_Release( p_block );
 231             return NULL;
 232         }
 233     }
 234
 235     if( p_sys->i_spu >= p_sys->i_spu_size )
 236     {
 237         /* We have a complete sub */
 238         if( p_sys->i_spu > p_sys->i_spu_size )
 239             msg_Dbg( p_dec, "SPU packets size=%d should be %d",
 240                      p_sys->i_spu, p_sys->i_spu_size );
 241
 242         return p_sys->p_block;
 243     }
 244     return NULL;
 245 }