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