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: spudec.c,v 1.29 2003/11/22 20:15:34 fenrir Exp $
   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 <stdlib.h>                                      /* malloc(), free() */
  29
  30 #include <vlc/vlc.h>
  31 #include <vlc/vout.h>
  32 #include <vlc/decoder.h>
  33 #include <vlc/input.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
  43 static void Close  ( vlc_object_t * );
  44
  45 vlc_module_begin();
  46     set_description( _("DVD subtitles decoder") );
  47     set_capability( "decoder", 50 );
  48     set_callbacks( DecoderOpen, Close );
  49
  50     add_submodule();
  51     set_description( _("DVD subtitles packetizer") );
  52     set_capability( "packetizer", 50 );
  53     set_callbacks( PacketizerOpen, Close );
  54 vlc_module_end();
  55
  56 /*****************************************************************************
  57  * Local prototypes
  58  *****************************************************************************/
  59 static vout_thread_t *FindVout( decoder_t *);
  60
  61 static block_t *Reassemble( decoder_t *, block_t ** );
  62
  63 static void     Decode   ( decoder_t *, block_t ** );
  64 static block_t *Packetize( decoder_t *, block_t ** );
  65
  66 /*****************************************************************************
  67  * DecoderOpen
  68  *****************************************************************************
  69  * Tries to launch a decoder and return score so that the interface is able
  70  * to chose.
  71  *****************************************************************************/
  72 static int DecoderOpen( vlc_object_t *p_this )
  73 {
  74     decoder_t     *p_dec = (decoder_t*)p_this;
  75     decoder_sys_t *p_sys;
  76
  77     if( p_dec->fmt_in.i_codec != VLC_FOURCC( 's','p','u',' ' ) &&
  78         p_dec->fmt_in.i_codec != VLC_FOURCC( 's','p','u','b' ) )
  79     {
  80         return VLC_EGENERIC;
  81     }
  82
  83     p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
  84
  85     p_sys->b_packetizer = VLC_FALSE;
  86     p_sys->i_spu_size = 0;
  87     p_sys->i_spu      = 0;
  88     p_sys->p_block    = NULL;
  89     p_sys->p_vout     = NULL;
  90
  91     es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
  92
  93     p_dec->pf_decode_sub = Decode;
  94     p_dec->pf_packetize  = Packetize;
  95
  96     return VLC_SUCCESS;
  97 }
  98
  99 /*****************************************************************************
 100  * PacketizerOpen
 101  *****************************************************************************
 102  * Tries to launch a decoder and return score so that the interface is able
 103  * to chose.
 104  *****************************************************************************/
 105 static int PacketizerOpen( vlc_object_t *p_this )
 106 {
 107     decoder_t *p_dec = (decoder_t*)p_this;
 108
 109     if( DecoderOpen( p_this ) )
 110     {
 111         return VLC_EGENERIC;
 112     }
 113     p_dec->p_sys->b_packetizer = VLC_TRUE;
 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->b_packetizer )
 127     {
 128         /* FIXME check if it's ok to not lock vout */
 129         if( p_sys->p_vout != NULL && p_sys->p_vout->p_subpicture != NULL )
 130         {
 131             subpicture_t *  p_subpic;
 132             int             i_subpic;
 133
 134             for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
 135             {
 136                 p_subpic = &p_sys->p_vout->p_subpicture[i_subpic];
 137
 138                 if( p_subpic != NULL &&
 139                     ( ( p_subpic->i_status == RESERVED_SUBPICTURE ) ||
 140                       ( p_subpic->i_status == READY_SUBPICTURE ) ) )
 141                 {
 142                     vout_DestroySubPicture( p_sys->p_vout, p_subpic );
 143                 }
 144             }
 145         }
 146     }
 147
 148     if( p_sys->p_block )
 149     {
 150         block_ChainRelease( p_sys->p_block );
 151     }
 152
 153     free( p_sys );
 154 }
 155
 156 /*****************************************************************************
 157  * Decode:
 158  *****************************************************************************/
 159 static void     Decode   ( decoder_t *p_dec, block_t **pp_block )
 160 {
 161     decoder_sys_t *p_sys = p_dec->p_sys;
 162     block_t       *p_spu = Reassemble( p_dec, pp_block );
 163
 164     if( p_spu )
 165     {
 166         p_sys->i_spu = block_ChainExtract( p_spu, p_sys->buffer, 65536 );
 167         p_sys->i_pts = p_spu->i_pts;
 168         block_ChainRelease( p_spu );
 169
 170         if( ( p_sys->p_vout = FindVout( p_dec ) ) )
 171         {
 172             /* Parse and decode */
 173             E_(ParsePacket)( p_dec );
 174
 175             vlc_object_release( p_sys->p_vout );
 176         }
 177
 178         /* reinit context */
 179         p_sys->i_spu_size = 0;
 180         p_sys->i_rle_size = 0;
 181         p_sys->i_spu      = 0;
 182         p_sys->p_block    = NULL;
 183     }
 184 }
 185
 186 /*****************************************************************************
 187  * Packetize:
 188  *****************************************************************************/
 189 static block_t *Packetize( decoder_t *p_dec, block_t **pp_block )
 190 {
 191     decoder_sys_t *p_sys = p_dec->p_sys;
 192     block_t       *p_spu = Reassemble( p_dec, pp_block );
 193
 194     if( p_spu )
 195     {
 196         p_spu->i_dts = p_spu->i_pts;
 197         p_spu->i_length = 0;
 198
 199         /* reinit context */
 200         p_sys->i_spu_size = 0;
 201         p_sys->i_rle_size = 0;
 202         p_sys->i_spu      = 0;
 203         p_sys->p_block    = NULL;
 204
 205         return block_ChainGather( p_spu );
 206     }
 207     return NULL;
 208 }
 209
 210 /*****************************************************************************
 211  * Reassemble:
 212  *****************************************************************************/
 213 static block_t *Reassemble( decoder_t *p_dec, block_t **pp_block )
 214 {
 215     decoder_sys_t *p_sys = p_dec->p_sys;
 216     block_t *p_block;
 217
 218     if( pp_block == NULL || *pp_block == NULL )
 219     {
 220         return NULL;
 221     }
 222     p_block = *pp_block;
 223     *pp_block = NULL;
 224
 225     if( p_sys->i_spu_size <= 0 && ( p_block->i_pts <= 0 || p_block->i_buffer < 4 ) )
 226     {
 227         msg_Dbg( p_dec, "invalid starting packet (size < 4 or pts <=0)" );
 228         block_Release( p_block );
 229         return NULL;
 230     }
 231
 232     block_ChainAppend( &p_sys->p_block, p_block );
 233     p_sys->i_spu += p_block->i_buffer;
 234
 235     if( p_sys->i_spu_size <= 0 )
 236     {
 237         p_sys->i_spu_size = ( p_block->p_buffer[0] << 8 )| p_block->p_buffer[1];
 238         p_sys->i_rle_size = ( ( p_block->p_buffer[2] << 8 )| p_block->p_buffer[3] ) - 4;
 239
 240         msg_Dbg( p_dec, "i_spu_size=%d i_rle=%d", p_sys->i_spu_size, p_sys->i_rle_size );
 241
 242         if( p_sys->i_spu_size <= 0 || p_sys->i_rle_size >= p_sys->i_spu_size )
 243         {
 244             p_sys->i_spu_size = 0;
 245             p_sys->i_rle_size = 0;
 246             p_sys->i_spu      = 0;
 247             p_sys->p_block    = NULL;
 248
 249             block_Release( p_block );
 250             return NULL;
 251         }
 252     }
 253
 254     if( p_sys->i_spu >= p_sys->i_spu_size )
 255     {
 256         /* We have a complete sub */
 257         msg_Dbg( p_dec, "SPU packets size=%d should be %d",
 258                  p_sys->i_spu, p_sys->i_spu_size );
 259
 260         return p_sys->p_block;
 261     }
 262     return NULL;
 263 }
 264
 265 /* following functions are local */
 266
 267 /*****************************************************************************
 268  * FindVout: Find a vout or wait for one to be created.
 269  *****************************************************************************/
 270 static vout_thread_t *FindVout( decoder_t *p_dec )
 271 {
 272     vout_thread_t *p_vout = NULL;
 273
 274     /* Find an available video output */
 275     do
 276     {
 277         if( p_dec->b_die || p_dec->b_error )
 278         {
 279             break;
 280         }
 281
 282         p_vout = vlc_object_find( p_dec, VLC_OBJECT_VOUT, FIND_ANYWHERE );
 283         if( p_vout )
 284         {
 285             break;
 286         }
 287
 288         msleep( VOUT_OUTMEM_SLEEP );
 289     }
 290     while( 1 );
 291
 292     return p_vout;
 293 }
 294