1 /*****************************************************************************
2 * spudec.c : SPU decoder thread
3 *****************************************************************************
4 * Copyright (C) 2000-2001, 2006 VLC authors and VideoLAN
5 * $Id: f487c94c9ab6d7abb7c35e8aa72c28e9b802637e $
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 it
11 * under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19 *
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * 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 #define DVDSUBTRANS_DISABLE_TEXT N_("Disable DVD subtitle transparency")
46 #define DVDSUBTRANS_DISABLE_LONGTEXT N_("Removes all transparency effects " \
47 "used in DVD subtitles.")
48
49 vlc_module_begin ()
50 set_description( N_("DVD subtitles decoder") )
51 set_shortname( N_("DVD subtitles") )
52 set_capability( "spu decoder", 75 )
53 set_category( CAT_INPUT )
54 set_subcategory( SUBCAT_INPUT_SCODEC )
55 set_callbacks( DecoderOpen, Close )
56
57 add_bool( "dvdsub-transparency", false,
58 DVDSUBTRANS_DISABLE_TEXT, DVDSUBTRANS_DISABLE_LONGTEXT, true )
59 add_submodule ()
60 set_description( N_("DVD subtitles packetizer") )
61 set_capability( "packetizer", 50 )
62 set_callbacks( PacketizerOpen, Close )
63 vlc_module_end ()
64
65 /*****************************************************************************
66 * Local prototypes
67 *****************************************************************************/
68 static block_t * Reassemble( decoder_t *, block_t * );
69 static int Decode ( decoder_t *, block_t * );
70 static block_t * Packetize ( decoder_t *, block_t ** );
71
72 /*****************************************************************************
73 * DecoderOpen
74 *****************************************************************************
75 * Tries to launch a decoder and return score so that the interface is able
76 * to chose.
77 *****************************************************************************/
DecoderOpen(vlc_object_t * p_this)78 static int DecoderOpen( vlc_object_t *p_this )
79 {
80 decoder_t *p_dec = (decoder_t*)p_this;
81 decoder_sys_t *p_sys;
82
83 if( p_dec->fmt_in.i_codec != VLC_CODEC_SPU )
84 return VLC_EGENERIC;
85
86 p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
87
88 p_sys->b_packetizer = false;
89 p_sys->b_disabletrans = var_InheritBool( p_dec, "dvdsub-transparency" );
90 p_sys->i_spu_size = 0;
91 p_sys->i_spu = 0;
92 p_sys->p_block = NULL;
93
94 p_dec->fmt_out.i_codec = VLC_CODEC_SPU;
95
96 p_dec->pf_decode = Decode;
97 p_dec->pf_packetize = NULL;
98
99 return VLC_SUCCESS;
100 }
101
102 /*****************************************************************************
103 * PacketizerOpen
104 *****************************************************************************
105 * Tries to launch a decoder and return score so that the interface is able
106 * to chose.
107 *****************************************************************************/
PacketizerOpen(vlc_object_t * p_this)108 static int PacketizerOpen( vlc_object_t *p_this )
109 {
110 decoder_t *p_dec = (decoder_t*)p_this;
111
112 if( DecoderOpen( p_this ) )
113 {
114 return VLC_EGENERIC;
115 }
116 p_dec->pf_packetize = Packetize;
117 p_dec->p_sys->b_packetizer = true;
118 es_format_Copy( &p_dec->fmt_out, &p_dec->fmt_in );
119 p_dec->fmt_out.i_codec = VLC_CODEC_SPU;
120
121 return VLC_SUCCESS;
122 }
123
124 /*****************************************************************************
125 * Close:
126 *****************************************************************************/
Close(vlc_object_t * p_this)127 static void Close( vlc_object_t *p_this )
128 {
129 decoder_t *p_dec = (decoder_t*)p_this;
130 decoder_sys_t *p_sys = p_dec->p_sys;
131
132 if( p_sys->p_block )
133 {
134 block_ChainRelease( p_sys->p_block );
135 }
136
137 free( p_sys );
138 }
139
140 /*****************************************************************************
141 * Decode:
142 *****************************************************************************/
Decode(decoder_t * p_dec,block_t * p_block)143 static int Decode( decoder_t *p_dec, block_t *p_block )
144 {
145 decoder_sys_t *p_sys = p_dec->p_sys;
146 block_t *p_spu_block;
147
148 if( p_block == NULL ) /* No Drain */
149 return VLCDEC_SUCCESS;
150 p_spu_block = Reassemble( p_dec, p_block );
151
152 if( ! p_spu_block )
153 {
154 return VLCDEC_SUCCESS;
155 }
156
157 /* FIXME: what the, we shouldn’t need to allocate 64k of buffer --sam. */
158 p_sys->i_spu = block_ChainExtract( p_spu_block, p_sys->buffer, 65536 );
159 p_sys->i_pts = p_spu_block->i_pts;
160 block_ChainRelease( p_spu_block );
161
162 /* Parse and decode */
163 ParsePacket( p_dec, decoder_QueueSub );
164
165 /* reinit context */
166 p_sys->i_spu_size = 0;
167 p_sys->i_rle_size = 0;
168 p_sys->i_spu = 0;
169 p_sys->p_block = NULL;
170
171 return VLCDEC_SUCCESS;
172 }
173
174 /*****************************************************************************
175 * Packetize:
176 *****************************************************************************/
Packetize(decoder_t * p_dec,block_t ** pp_block)177 static block_t *Packetize( decoder_t *p_dec, block_t **pp_block )
178 {
179 decoder_sys_t *p_sys = p_dec->p_sys;
180 if( pp_block == NULL ) /* No Drain */
181 return NULL;
182 block_t *p_block = *pp_block; *pp_block = NULL;
183 if( p_block == NULL )
184 return NULL;
185
186 block_t *p_spu = Reassemble( p_dec, p_block );
187
188 if( ! p_spu )
189 {
190 return NULL;
191 }
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
205 /*****************************************************************************
206 * Reassemble:
207 *****************************************************************************/
Reassemble(decoder_t * p_dec,block_t * p_block)208 static block_t *Reassemble( decoder_t *p_dec, block_t *p_block )
209 {
210 decoder_sys_t *p_sys = p_dec->p_sys;
211
212 if( p_block->i_flags & BLOCK_FLAG_CORRUPTED )
213 {
214 block_Release( p_block );
215 return NULL;
216 }
217
218 if( p_sys->i_spu_size <= 0 &&
219 ( p_block->i_pts <= VLC_TS_INVALID || p_block->i_buffer < 4 ) )
220 {
221 msg_Dbg( p_dec, "invalid starting packet (size < 4 or pts <=0)" );
222 msg_Dbg( p_dec, "spu size: %d, i_pts: %"PRId64" i_buffer: %zu",
223 p_sys->i_spu_size, p_block->i_pts, p_block->i_buffer );
224 block_Release( p_block );
225 return NULL;
226 }
227
228 block_ChainAppend( &p_sys->p_block, p_block );
229 p_sys->i_spu += p_block->i_buffer;
230
231 if( p_sys->i_spu_size <= 0 )
232 {
233 p_sys->i_spu_size = ( p_block->p_buffer[0] << 8 )|
234 p_block->p_buffer[1];
235 p_sys->i_rle_size = ( ( p_block->p_buffer[2] << 8 )|
236 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
241 if( p_sys->i_spu_size <= 0 || p_sys->i_rle_size >= p_sys->i_spu_size )
242 {
243 p_sys->i_spu_size = 0;
244 p_sys->i_rle_size = 0;
245 p_sys->i_spu = 0;
246 p_sys->p_block = NULL;
247
248 block_Release( p_block );
249 return NULL;
250 }
251 }
252
253 if( p_sys->i_spu >= p_sys->i_spu_size )
254 {
255 /* We have a complete sub */
256 if( p_sys->i_spu > p_sys->i_spu_size )
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