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