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