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

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