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