1 /*****************************************************************************
2 * voc.c : Creative Voice File (.VOC) demux module for vlc
3 *****************************************************************************
4 * Copyright (C) 2005 Rémi Denis-Courmont
7 * Authors: Rémi Denis-Courmont <rem # videolan.org>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_demux.h>
36 /*****************************************************************************
38 *****************************************************************************/
39 static int Open ( vlc_object_t * );
40 static void Close( vlc_object_t * );
43 set_description( N_("VOC demuxer") )
44 set_category( CAT_INPUT )
45 set_subcategory( SUBCAT_INPUT_DEMUX )
46 set_capability( "demux", 10 )
47 set_callbacks( Open, Close )
50 /*****************************************************************************
52 *****************************************************************************/
53 static int Demux ( demux_t * );
54 static int Control( demux_t *, int i_query, va_list args );
61 int64_t i_block_start;
64 int64_t i_loop_offset;
65 unsigned i_loop_count;
66 unsigned i_silence_countdown;
71 static const char ct_header[] = "Creative Voice File\x1a";
73 /*****************************************************************************
74 * Open: check file and initializes structures
75 *****************************************************************************/
76 static int Open( vlc_object_t * p_this )
78 demux_t *p_demux = (demux_t*)p_this;
81 uint16_t i_data_offset, i_version;
83 if( stream_Peek( p_demux->s, &p_buf, 26 ) < 26 )
86 if( memcmp( p_buf, ct_header, 20 ) )
90 i_data_offset = GetWLE( p_buf );
91 if ( i_data_offset < 26 /* not enough room for full VOC header */ )
95 i_version = GetWLE( p_buf );
96 if( ( i_version != 0x10A ) && ( i_version != 0x114 ) )
97 return VLC_EGENERIC; /* unknown VOC version */
100 if( GetWLE( p_buf ) != (uint16_t)(0x1234 + ~i_version) )
103 /* We have a valid VOC header */
104 msg_Dbg( p_demux, "CT Voice file v%d.%d", i_version >> 8,
107 /* skip VOC header */
108 if( stream_Read( p_demux->s, NULL, i_data_offset ) < i_data_offset )
111 p_demux->pf_demux = Demux;
112 p_demux->pf_control = Control;
113 p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
117 p_sys->i_silence_countdown = p_sys->i_block_start = p_sys->i_block_end =
118 p_sys->i_loop_count = 0;
121 date_Init( &p_sys->pts, 1, 1 );
122 date_Set( &p_sys->pts, 1 );
124 es_format_Init( &p_sys->fmt, AUDIO_ES, 0 );
130 static int fmtcmp( es_format_t *ofmt, es_format_t *nfmt )
132 return (ofmt->audio.i_bitspersample != nfmt->audio.i_bitspersample)
133 || (ofmt->audio.i_rate != nfmt->audio.i_rate)
134 || (ofmt->audio.i_channels != nfmt->audio.i_channels);
139 * Converts old-style VOC sample rates to commonly used ones
140 * so as not to confuse sound card drivers.
141 * (I assume 16k, 24k and 32k are never found in .VOC files)
143 static unsigned int fix_voc_sr( unsigned int sr )
161 static int ReadBlockHeader( demux_t *p_demux )
165 int32_t i_block_size;
166 demux_sys_t *p_sys = p_demux->p_sys;
168 if( stream_Read( p_demux->s, buf, 4 ) < 4 )
169 return VLC_EGENERIC; /* EOF */
171 i_block_size = GetDWLE( buf ) >> 8;
172 msg_Dbg( p_demux, "new block: type: %u, size: %u",
173 (unsigned)*buf, i_block_size );
175 es_format_Init( &new_fmt, AUDIO_ES, 0 );
179 case 0: /* not possible : caught with earlier stream_Read */
183 if( i_block_size < 2 )
187 if( stream_Read( p_demux->s, buf, 2 ) < 2 )
192 msg_Err( p_demux, "unsupported compression" );
196 new_fmt.i_codec = VLC_CODEC_U8;
197 new_fmt.audio.i_rate = fix_voc_sr( 1000000L / (256L - buf[0]) );
198 new_fmt.audio.i_bytes_per_frame = 1;
199 new_fmt.audio.i_frame_length = 1;
200 new_fmt.audio.i_channels = 1;
201 new_fmt.audio.i_blockalign = 1;
202 new_fmt.audio.i_bitspersample = 8;
203 new_fmt.i_bitrate = new_fmt.audio.i_rate * 8;
206 case 2: /* data block with same format as the previous one */
207 if( p_sys->p_es == NULL )
208 goto corrupt; /* no previous block! */
210 memcpy( &new_fmt, &p_sys->fmt, sizeof( new_fmt ) );
213 case 3: /* silence block */
214 if( ( i_block_size != 3 )
215 || ( stream_Read( p_demux->s, buf, 3 ) < 3 ) )
219 p_sys->i_silence_countdown = GetWLE( buf );
221 new_fmt.i_codec = VLC_CODEC_U8;
222 new_fmt.audio.i_rate = fix_voc_sr( 1000000L / (256L - buf[0]) );
223 new_fmt.audio.i_bytes_per_frame = 1;
224 new_fmt.audio.i_frame_length = 1;
225 new_fmt.audio.i_channels = 1;
226 new_fmt.audio.i_blockalign = 1;
227 new_fmt.audio.i_bitspersample = 8;
228 new_fmt.i_bitrate = new_fmt.audio.i_rate * 8;
231 case 6: /* repeat block */
232 if( ( i_block_size != 2 )
233 || ( stream_Read( p_demux->s, buf, 2 ) < 2 ) )
237 p_sys->i_loop_count = GetWLE( buf );
238 p_sys->i_loop_offset = stream_Tell( p_demux->s );
241 case 7: /* repeat end block */
242 if( i_block_size != 0 )
245 if( p_sys->i_loop_count > 0 )
247 if( stream_Seek( p_demux->s, p_sys->i_loop_offset ) )
248 msg_Warn( p_demux, "cannot loop: seek failed" );
250 p_sys->i_loop_count--;
256 * Block 8 is a big kludge to add stereo support to block 1 :
257 * A block of type 8 is always followed by a block of type 1
258 * and specifies the number of channels in that 1-block
259 * (normally block 1 are always mono). In practice, block type 9
260 * is used for stereo rather than 8
262 if( ( i_block_size != 4 )
263 || ( stream_Read( p_demux->s, buf, 4 ) < 4 ) )
268 msg_Err( p_demux, "unsupported compression" );
272 new_fmt.i_codec = VLC_CODEC_U8;
273 new_fmt.audio.i_channels = buf[3] + 1; /* can't be nul */
274 new_fmt.audio.i_rate = 256000000L /
275 ((65536L - GetWLE(buf)) * new_fmt.audio.i_channels);
276 new_fmt.audio.i_bytes_per_frame = new_fmt.audio.i_channels;
277 new_fmt.audio.i_frame_length = 1;
278 new_fmt.audio.i_blockalign = new_fmt.audio.i_bytes_per_frame;
279 new_fmt.audio.i_bitspersample = 8 * new_fmt.audio.i_bytes_per_frame;
280 new_fmt.i_bitrate = new_fmt.audio.i_rate * 8;
282 /* read subsequent block 1 */
283 if( stream_Read( p_demux->s, buf, 4 ) < 4 )
284 return VLC_EGENERIC; /* EOF */
286 i_block_size = GetDWLE( buf ) >> 8;
287 msg_Dbg( p_demux, "new block: type: %u, size: %u",
288 (unsigned)*buf, i_block_size );
289 if( i_block_size < 2 )
293 if( stream_Read( p_demux->s, buf, 2 ) < 2 )
298 msg_Err( p_demux, "unsupported compression" );
304 case 9: /* newer data block with channel number and bits resolution */
305 if( i_block_size < 12 )
309 if( ( stream_Read( p_demux->s, buf, 8 ) < 8 )
310 || ( stream_Read( p_demux->s, NULL, 4 ) < 4 ) )
313 new_fmt.audio.i_rate = GetDWLE( buf );
314 new_fmt.audio.i_bitspersample = buf[4];
315 new_fmt.audio.i_channels = buf[5];
317 switch( GetWLE( &buf[6] ) ) /* format */
319 case 0x0000: /* PCM */
320 switch( new_fmt.audio.i_bitspersample )
323 new_fmt.i_codec = VLC_CODEC_U8;
327 new_fmt.i_codec = VLC_CODEC_U16L;
331 msg_Err( p_demux, "unsupported bit res.: %u bits",
332 new_fmt.audio.i_bitspersample );
337 case 0x0004: /* signed */
338 switch( new_fmt.audio.i_bitspersample )
341 new_fmt.i_codec = VLC_CODEC_S8;
345 new_fmt.i_codec = VLC_CODEC_S16L;
349 msg_Err( p_demux, "unsupported bit res.: %u bits",
350 new_fmt.audio.i_bitspersample );
356 msg_Err( p_demux, "unsupported compression" );
360 if( new_fmt.audio.i_channels == 0 )
362 msg_Err( p_demux, "0 channels detected" );
366 new_fmt.audio.i_bytes_per_frame = new_fmt.audio.i_channels
367 * (new_fmt.audio.i_bitspersample / 8);
368 new_fmt.audio.i_frame_length = 1;
369 new_fmt.audio.i_blockalign = new_fmt.audio.i_bytes_per_frame;
370 new_fmt.i_bitrate = 8 * new_fmt.audio.i_rate
371 * new_fmt.audio.i_bytes_per_frame;
375 msg_Dbg( p_demux, "unknown block type %u - skipping block",
377 case 4: /* blocks of non-audio types can be skipped */
379 if( stream_Read( p_demux->s, NULL, i_block_size ) < i_block_size )
385 p_sys->i_block_start = stream_Tell( p_demux->s );
386 p_sys->i_block_end = p_sys->i_block_start + i_block_size;
388 if( i_block_size || p_sys->i_silence_countdown )
390 /* we've read a block with data in it - update decoder */
391 msg_Dbg( p_demux, "fourcc: %4.4s, channels: %d, "
392 "freq: %d Hz, bitrate: %dKo/s, blockalign: %d, "
393 "bits/samples: %d", (char *)&new_fmt.i_codec,
394 new_fmt.audio.i_channels, new_fmt.audio.i_rate,
395 new_fmt.i_bitrate / 8192, new_fmt.audio.i_blockalign,
396 new_fmt.audio.i_bitspersample );
398 if( ( p_sys->p_es != NULL ) && fmtcmp( &p_sys->fmt, &new_fmt ) )
400 msg_Dbg( p_demux, "codec change needed" );
401 es_out_Del( p_demux->out, p_sys->p_es );
405 if( p_sys->p_es == NULL )
407 memcpy( &p_sys->fmt, &new_fmt, sizeof( p_sys->fmt ) );
408 date_Change( &p_sys->pts, p_sys->fmt.audio.i_rate, 1 );
409 p_sys->p_es = es_out_Add( p_demux->out, &p_sys->fmt );
416 msg_Err( p_demux, "corrupted file - halting demux" );
420 /*****************************************************************************
421 * Demux: read packet and send them to decoders
422 *****************************************************************************
423 * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
424 *****************************************************************************/
425 #define SAMPLES_BUFFER 1000
426 static int Demux( demux_t *p_demux )
428 demux_sys_t *p_sys = p_demux->p_sys;
432 if( p_sys->i_silence_countdown == 0 )
434 int64_t i_offset = stream_Tell( p_demux->s );
435 if( i_offset >= p_sys->i_block_end )
437 if( ReadBlockHeader( p_demux ) != VLC_SUCCESS )
442 i = ( p_sys->i_block_end - i_offset )
443 / p_sys->fmt.audio.i_bytes_per_frame;
444 if( i > SAMPLES_BUFFER )
447 p_block = stream_Block( p_demux->s,
448 p_sys->fmt.audio.i_bytes_per_frame * i );
449 if( p_block == NULL )
451 msg_Warn( p_demux, "cannot read data" );
456 { /* emulates silence from the stream */
457 i = p_sys->i_silence_countdown;
458 if( i > SAMPLES_BUFFER )
461 p_block = block_Alloc( i );
462 if( p_block == NULL )
465 memset( p_block->p_buffer, 0, i );
466 p_sys->i_silence_countdown -= i;
469 p_block->i_dts = p_block->i_pts = VLC_TS_0 + date_Get( &p_sys->pts );
471 es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block->i_pts );
473 es_out_Send( p_demux->out, p_sys->p_es, p_block );
475 date_Increment( &p_sys->pts, p_sys->fmt.audio.i_frame_length * i );
480 /*****************************************************************************
481 * Close: frees unused data
482 *****************************************************************************/
483 static void Close ( vlc_object_t * p_this )
485 demux_sys_t *p_sys = ((demux_t *)p_this)->p_sys;
490 /*****************************************************************************
492 *****************************************************************************/
493 static int Control( demux_t *p_demux, int i_query, va_list args )
495 demux_sys_t *p_sys = p_demux->p_sys;
497 return demux_vaControlHelper( p_demux->s, p_sys->i_block_start,
499 p_sys->fmt.i_bitrate,
500 p_sys->fmt.audio.i_blockalign,