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.33 2004/01/30 16:50:26 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 <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
 161     if( p_spu )
 162     {
 163         p_sys->i_spu = block_ChainExtract( p_spu, p_sys->buffer, 65536 );
 164         p_sys->i_pts = p_spu->i_pts;
 165         block_ChainRelease( p_spu );
 166
 167         if( ( p_sys->p_vout = FindVout( p_dec ) ) )
 168         {
 169             /* Parse and decode */
 170             E_(ParsePacket)( p_dec );
 171
 172             vlc_object_release( p_sys->p_vout );
 173         }
 174
 175         /* reinit context */
 176         p_sys->i_spu_size = 0;
 177         p_sys->i_rle_size = 0;
 178         p_sys->i_spu      = 0;
 179         p_sys->p_block    = NULL;
 180     }
 181 }
 182
 183 /*****************************************************************************
 184  * Packetize:
 185  *****************************************************************************/
 186 static block_t *Packetize( decoder_t *p_dec, block_t **pp_block )
 187 {
 188     decoder_sys_t *p_sys = p_dec->p_sys;
 189     block_t       *p_spu = Reassemble( p_dec, pp_block );
 190
 191     if( p_spu )
 192     {
 193         p_spu->i_dts = p_spu->i_pts;
 194         p_spu->i_length = 0;
 195
 196         /* reinit context */
 197         p_sys->i_spu_size = 0;
 198         p_sys->i_rle_size = 0;
 199         p_sys->i_spu      = 0;
 200         p_sys->p_block    = NULL;
 201
 202         return block_ChainGather( p_spu );
 203     }
 204     return NULL;
 205 }
 206
 207 /*****************************************************************************
 208  * Reassemble:
 209  *****************************************************************************/
 210 static block_t *Reassemble( decoder_t *p_dec, block_t **pp_block )
 211 {
 212     decoder_sys_t *p_sys = p_dec->p_sys;
 213     block_t *p_block;
 214
 215     if( pp_block == NULL || *pp_block == NULL )
 216     {
 217         return NULL;
 218     }
 219     p_block = *pp_block;
 220     *pp_block = NULL;
 221
 222     if( p_sys->i_spu_size <= 0 && ( p_block->i_pts <= 0 || p_block->i_buffer < 4 ) )
 223     {
 224         msg_Dbg( p_dec, "invalid starting packet (size < 4 or pts <=0)" );
 225         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 );
 226         block_Release( p_block );
 227         return NULL;
 228     }
 229
 230     block_ChainAppend( &p_sys->p_block, p_block );
 231     p_sys->i_spu += p_block->i_buffer;
 232
 233     if( p_sys->i_spu_size <= 0 )
 234     {
 235         p_sys->i_spu_size = ( p_block->p_buffer[0] << 8 )| p_block->p_buffer[1];
 236         p_sys->i_rle_size = ( ( p_block->p_buffer[2] << 8 )| p_block->p_buffer[3] ) - 4;
 237
 238         /* msg_Dbg( p_dec, "i_spu_size=%d i_rle=%d",
 239                     p_sys->i_spu_size, p_sys->i_rle_size ); */
 240         if( p_sys->i_spu_size <= 0 || p_sys->i_rle_size >= p_sys->i_spu_size )
 241         {
 242             p_sys->i_spu_size = 0;
 243             p_sys->i_rle_size = 0;
 244             p_sys->i_spu      = 0;
 245             p_sys->p_block    = NULL;
 246
 247             block_Release( p_block );
 248             return NULL;
 249         }
 250     }
 251
 252     if( p_sys->i_spu >= p_sys->i_spu_size )
 253     {
 254         /* We have a complete sub */
 255         msg_Dbg( p_dec, "SPU packets size=%d should be %d",
 256                  p_sys->i_spu, p_sys->i_spu_size );
 257
 258         return p_sys->p_block;
 259     }
 260     return NULL;
 261 }
 262
 263 /* following functions are local */
 264
 265 /*****************************************************************************
 266  * FindVout: Find a vout or wait for one to be created.
 267  *****************************************************************************/
 268 static vout_thread_t *FindVout( decoder_t *p_dec )
 269 {
 270     vout_thread_t *p_vout = NULL;
 271
 272     /* Find an available video output */
 273     do
 274     {
 275         if( p_dec->b_die || p_dec->b_error )
 276         {
 277             break;
 278         }
 279
 280         p_vout = vlc_object_find( p_dec, VLC_OBJECT_VOUT, FIND_ANYWHERE );
 281         if( p_vout )
 282         {
 283             break;
 284         }
 285
 286         msleep( VOUT_OUTMEM_SLEEP );
 287     }
 288     while( 1 );
 289
 290     return p_vout;
 291 }
 292