1 /*****************************************************************************
2 * speex.c: speex decoder/packetizer/encoder module making use of libspeex.
3 *****************************************************************************
4 * Copyright (C) 2003 VideoLAN
5 * $Id: speex.c,v 1.13 2004/02/22 15:57:41 fenrir Exp $
7 * Authors: Gildas Bazin <gbazin@netcourrier.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 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 General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
28 #include <vlc/decoder.h>
29 #include <vlc/input.h>
30 #include "vlc_playlist.h"
34 #include "speex_header.h"
35 #include "speex_stereo.h"
36 #include "speex_callbacks.h"
38 /*****************************************************************************
39 * decoder_sys_t : speex decoder descriptor
40 *****************************************************************************/
44 vlc_bool_t b_packetizer;
50 int i_frame_in_packet;
56 SpeexHeader *p_header;
57 SpeexStereoState stereo;
63 audio_date_t end_date;
67 static int pi_channels_maps[6] =
70 AOUT_CHAN_CENTER, AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
71 AOUT_CHAN_CENTER | AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
72 AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARLEFT
73 | AOUT_CHAN_REARRIGHT,
74 AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
75 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
78 /****************************************************************************
80 ****************************************************************************/
81 static int OpenDecoder ( vlc_object_t * );
82 static int OpenPacketizer( vlc_object_t * );
83 static void CloseDecoder ( vlc_object_t * );
85 static void *DecodeBlock ( decoder_t *, block_t ** );
86 static int ProcessHeader ( decoder_t *, ogg_packet * );
87 static void *ProcessPacket( decoder_t *, ogg_packet *, block_t ** );
89 static aout_buffer_t *DecodePacket( decoder_t *, ogg_packet * );
90 static block_t *SendPacket( decoder_t *, ogg_packet *, block_t * );
92 static void ParseSpeexComments( decoder_t *, ogg_packet * );
94 static int OpenEncoder ( vlc_object_t * );
95 static void CloseEncoder ( vlc_object_t * );
96 static block_t *Headers ( encoder_t * );
97 static block_t *Encode ( encoder_t *, aout_buffer_t * );
99 /*****************************************************************************
101 *****************************************************************************/
103 set_description( _("Speex audio decoder") );
104 set_capability( "decoder", 100 );
105 set_callbacks( OpenDecoder, CloseDecoder );
108 set_description( _("Speex audio packetizer") );
109 set_capability( "packetizer", 100 );
110 set_callbacks( OpenPacketizer, CloseDecoder );
113 set_description( _("Speex audio encoder") );
114 set_capability( "encoder", 100 );
115 set_callbacks( OpenEncoder, CloseEncoder );
118 /*****************************************************************************
119 * OpenDecoder: probe the decoder and return score
120 *****************************************************************************/
121 static int OpenDecoder( vlc_object_t *p_this )
123 decoder_t *p_dec = (decoder_t*)p_this;
124 decoder_sys_t *p_sys = p_dec->p_sys;
126 if( p_dec->fmt_in.i_codec != VLC_FOURCC('s','p','x',' ') )
131 /* Allocate the memory needed to store the decoder's structure */
132 if( ( p_dec->p_sys = p_sys =
133 (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
135 msg_Err( p_dec, "out of memory" );
138 p_dec->p_sys->b_packetizer = VLC_FALSE;
140 aout_DateSet( &p_sys->end_date, 0 );
142 /* Set output properties */
143 p_dec->fmt_out.i_cat = AUDIO_ES;
144 p_dec->fmt_out.i_codec = AOUT_FMT_S16_NE;
147 p_dec->pf_decode_audio = (aout_buffer_t *(*)(decoder_t *, block_t **))
149 p_dec->pf_packetize = (block_t *(*)(decoder_t *, block_t **))
152 p_sys->i_headers = 0;
153 p_sys->p_state = NULL;
154 p_sys->p_header = NULL;
155 p_sys->i_frame_in_packet = 0;
160 static int OpenPacketizer( vlc_object_t *p_this )
162 decoder_t *p_dec = (decoder_t*)p_this;
164 int i_ret = OpenDecoder( p_this );
166 if( i_ret == VLC_SUCCESS )
168 p_dec->p_sys->b_packetizer = VLC_TRUE;
169 p_dec->fmt_out.i_codec = VLC_FOURCC('s','p','x',' ');
175 /****************************************************************************
176 * DecodeBlock: the whole thing
177 ****************************************************************************
178 * This function must be fed with ogg packets.
179 ****************************************************************************/
180 static void *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
182 decoder_sys_t *p_sys = p_dec->p_sys;
183 ogg_packet oggpacket;
185 if( !pp_block ) return NULL;
189 /* Block to Ogg packet */
190 oggpacket.packet = (*pp_block)->p_buffer;
191 oggpacket.bytes = (*pp_block)->i_buffer;
195 if( p_sys->b_packetizer ) return NULL;
197 /* Block to Ogg packet */
198 oggpacket.packet = NULL;
202 oggpacket.granulepos = -1;
205 oggpacket.packetno = 0;
207 if( p_sys->i_headers == 0 )
209 /* Take care of the initial Speex header */
210 if( ProcessHeader( p_dec, &oggpacket ) != VLC_SUCCESS )
212 msg_Err( p_dec, "initial Speex header is corrupted" );
213 block_Release( *pp_block );
219 return ProcessPacket( p_dec, &oggpacket, pp_block );
222 if( p_sys->i_headers == 1 )
224 /* The next packet in order is the comments header */
225 ParseSpeexComments( p_dec, &oggpacket );
228 return ProcessPacket( p_dec, &oggpacket, pp_block );
231 return ProcessPacket( p_dec, &oggpacket, pp_block );
234 /*****************************************************************************
235 * ProcessHeader: processes the inital Speex header packet.
236 *****************************************************************************/
237 static int ProcessHeader( decoder_t *p_dec, ogg_packet *p_oggpacket )
239 decoder_sys_t *p_sys = p_dec->p_sys;
242 SpeexHeader *p_header;
244 SpeexCallback callback;
246 p_sys->p_header = p_header =
247 speex_packet_to_header( p_oggpacket->packet, p_oggpacket->bytes );
250 msg_Err( p_dec, "cannot read Speex header" );
253 if( p_header->mode >= SPEEX_NB_MODES )
255 msg_Err( p_dec, "mode number %d does not (yet/any longer) exist in "
256 "this version of libspeex.", p_header->mode );
260 p_mode = speex_mode_list[p_header->mode];
262 if( p_header->speex_version_id > 1 )
264 msg_Err( p_dec, "this file was encoded with Speex bit-stream "
265 "version %d, which I don't know how to decode.",
266 p_header->speex_version_id );
270 if( p_mode->bitstream_version < p_header->mode_bitstream_version )
272 msg_Err( p_dec, "file encoded with a newer version of Speex." );
275 if( p_mode->bitstream_version > p_header->mode_bitstream_version )
277 msg_Err( p_dec, "file encoded with an older version of Speex." );
281 msg_Dbg( p_dec, "Speex %d Hz audio using %s mode %s%s",
282 p_header->rate, p_mode->modeName,
283 ( p_header->nb_channels == 1 ) ? " (mono" : " (stereo",
284 p_header->vbr ? ", VBR)" : ")" );
286 /* Take care of speex decoder init */
287 speex_bits_init( &p_sys->bits );
288 p_sys->p_state = p_state = speex_decoder_init( p_mode );
291 msg_Err( p_dec, "decoder initialization failed" );
295 if( p_header->nb_channels == 2 )
297 SpeexStereoState stereo = SPEEX_STEREO_STATE_INIT;
298 p_sys->stereo = stereo;
299 callback.callback_id = SPEEX_INBAND_STEREO;
300 callback.func = speex_std_stereo_request_handler;
301 callback.data = &p_sys->stereo;
302 speex_decoder_ctl( p_state, SPEEX_SET_HANDLER, &callback );
305 /* Setup the format */
306 p_dec->fmt_out.audio.i_physical_channels =
307 p_dec->fmt_out.audio.i_original_channels =
308 pi_channels_maps[p_header->nb_channels];
309 p_dec->fmt_out.audio.i_channels = p_header->nb_channels;
310 p_dec->fmt_out.audio.i_rate = p_header->rate;
312 aout_DateInit( &p_sys->end_date, p_header->rate );
317 /*****************************************************************************
318 * ProcessPacket: processes a Speex packet.
319 *****************************************************************************/
320 static void *ProcessPacket( decoder_t *p_dec, ogg_packet *p_oggpacket,
323 decoder_sys_t *p_sys = p_dec->p_sys;
324 block_t *p_block = *pp_block;
326 /* Date management */
327 if( p_block && p_block->i_pts > 0 &&
328 p_block->i_pts != aout_DateGet( &p_sys->end_date ) )
330 aout_DateSet( &p_sys->end_date, p_block->i_pts );
333 if( !aout_DateGet( &p_sys->end_date ) )
335 /* We've just started the stream, wait for the first PTS. */
336 if( p_block ) block_Release( p_block );
340 *pp_block = NULL; /* To avoid being fed the same packet again */
342 if( p_sys->b_packetizer )
344 return SendPacket( p_dec, p_oggpacket, p_block );
348 aout_buffer_t *p_aout_buffer;
350 if( p_sys->i_headers >= p_sys->p_header->extra_headers + 2 )
351 p_aout_buffer = DecodePacket( p_dec, p_oggpacket );
353 p_aout_buffer = NULL; /* Skip headers */
357 block_Release( p_block );
359 return p_aout_buffer;
363 /*****************************************************************************
364 * DecodePacket: decodes a Speex packet.
365 *****************************************************************************/
366 static aout_buffer_t *DecodePacket( decoder_t *p_dec, ogg_packet *p_oggpacket )
368 decoder_sys_t *p_sys = p_dec->p_sys;
370 if( p_oggpacket->bytes )
372 /* Copy Ogg packet to Speex bitstream */
373 speex_bits_read_from( &p_sys->bits, p_oggpacket->packet,
374 p_oggpacket->bytes );
375 p_sys->i_frame_in_packet = 0;
378 /* Decode one frame at a time */
379 if( p_sys->i_frame_in_packet < p_sys->p_header->frames_per_packet )
381 aout_buffer_t *p_aout_buffer;
385 p_dec->pf_aout_buffer_new( p_dec, p_sys->p_header->frame_size );
391 i_ret = speex_decode( p_sys->p_state, &p_sys->bits,
392 (int16_t *)p_aout_buffer->p_buffer );
401 msg_Warn( p_dec, "decoding error: corrupted stream?" );
405 if( speex_bits_remaining( &p_sys->bits ) < 0 )
407 msg_Warn( p_dec, "decoding overflow: corrupted stream?" );
410 if( p_sys->p_header->nb_channels == 2 )
411 speex_decode_stereo( (int16_t *)p_aout_buffer->p_buffer,
412 p_sys->p_header->frame_size, &p_sys->stereo );
414 /* Date management */
415 p_aout_buffer->start_date = aout_DateGet( &p_sys->end_date );
416 p_aout_buffer->end_date =
417 aout_DateIncrement( &p_sys->end_date, p_sys->p_header->frame_size);
419 p_sys->i_frame_in_packet++;
421 return p_aout_buffer;
429 /*****************************************************************************
430 * SendPacket: send an ogg packet to the stream output.
431 *****************************************************************************/
432 static block_t *SendPacket( decoder_t *p_dec, ogg_packet *p_oggpacket,
435 decoder_sys_t *p_sys = p_dec->p_sys;
437 /* Date management */
438 p_block->i_dts = p_block->i_pts = aout_DateGet( &p_sys->end_date );
440 if( p_sys->i_headers >= p_sys->p_header->extra_headers + 2 )
442 aout_DateIncrement( &p_sys->end_date,
443 p_sys->p_header->frame_size ) -
446 p_block->i_length = 0;
451 /*****************************************************************************
452 * ParseSpeexComments: FIXME should be done in demuxer
453 *****************************************************************************/
454 #define readint(buf, base) (((buf[base+3]<<24)&0xff000000)| \
455 ((buf[base+2]<<16)&0xff0000)| \
456 ((buf[base+1]<<8)&0xff00)| \
459 static void ParseSpeexComments( decoder_t *p_dec, ogg_packet *p_oggpacket )
461 input_thread_t *p_input = (input_thread_t *)p_dec->p_parent;
462 decoder_sys_t *p_sys = p_dec->p_sys;
464 input_info_category_t *p_cat =
465 input_InfoCategory( p_input, _("Speex comment") );
466 playlist_t *p_playlist = vlc_object_find( p_dec, VLC_OBJECT_PLAYLIST,
468 playlist_item_t *p_item;
470 char *p_buf = (char *)p_oggpacket->packet;
474 p_mode = speex_mode_list[p_sys->p_header->mode];
475 input_AddInfo( p_cat, _("Mode"), "%s%s",
476 p_mode->modeName, p_sys->p_header->vbr ? " VBR" : "" );
478 vlc_mutex_lock( &p_playlist->object_lock );
479 p_item = playlist_ItemGetByPos( p_playlist, -1 );
480 vlc_mutex_unlock( &p_playlist->object_lock );
483 msg_Err(p_dec, "unable to find item" );
486 vlc_mutex_lock( &p_item->lock );
488 playlist_ItemAddInfo( p_item, _("Speex comment") , _("Mode"),"%s%s",
489 p_mode->modeName, p_sys->p_header->vbr ? " VBR" : "" );
491 if( p_oggpacket->bytes < 8 )
493 msg_Warn( p_dec, "invalid/corrupted comments" );
497 i_len = readint( p_buf, 0 ); p_buf += 4;
498 if( i_len > p_oggpacket->bytes - 4 )
500 msg_Warn( p_dec, "invalid/corrupted comments" );
504 input_AddInfo( p_cat, p_buf, "" );
505 playlist_ItemAddInfo( p_item , _("Speex comment") , p_buf , "" );
507 vlc_mutex_unlock( &p_item->lock );
509 if( p_playlist ) vlc_object_release( p_playlist );
511 /* TODO: finish comments parsing */
514 /*****************************************************************************
515 * CloseDecoder: speex decoder destruction
516 *****************************************************************************/
517 static void CloseDecoder( vlc_object_t *p_this )
519 decoder_t * p_dec = (decoder_t *)p_this;
520 decoder_sys_t *p_sys = p_dec->p_sys;
524 speex_decoder_destroy( p_sys->p_state );
525 speex_bits_destroy( &p_sys->bits );
528 if( p_sys->p_header ) free( p_sys->p_header );
532 /*****************************************************************************
533 * encoder_sys_t: encoder descriptor
534 *****************************************************************************/
535 #define MAX_FRAME_SIZE 2000
536 #define MAX_FRAME_BYTES 2000
546 char *p_buffer_out[MAX_FRAME_BYTES];
553 SpeexStereoState stereo;
556 int i_frames_per_packet;
557 int i_frames_in_packet;
569 /*****************************************************************************
570 * OpenEncoder: probe the encoder and return score
571 *****************************************************************************/
572 static int OpenEncoder( vlc_object_t *p_this )
574 encoder_t *p_enc = (encoder_t *)p_this;
575 encoder_sys_t *p_sys;
576 SpeexMode *p_speex_mode = &speex_nb_mode;
579 if( p_enc->fmt_out.i_codec != VLC_FOURCC('s','p','x',' ') )
584 /* Allocate the memory needed to store the decoder's structure */
585 if( ( p_sys = (encoder_sys_t *)malloc(sizeof(encoder_sys_t)) ) == NULL )
587 msg_Err( p_enc, "out of memory" );
590 p_enc->p_sys = p_sys;
591 p_enc->pf_header = Headers;
592 p_enc->pf_encode_audio = Encode;
593 p_enc->fmt_in.i_codec = AOUT_FMT_S16_NE;
595 speex_init_header( &p_sys->header, p_enc->fmt_in.audio.i_rate,
598 p_sys->header.frames_per_packet = 1;
599 p_sys->header.vbr = 1;
600 p_sys->header.nb_channels = p_enc->fmt_in.audio.i_channels;
602 /* Create a new encoder state in narrowband mode */
603 p_sys->p_state = speex_encoder_init( p_speex_mode );
605 /* Set the quality to 8 (15 kbps) */
607 speex_encoder_ctl( p_sys->p_state, SPEEX_SET_QUALITY, &i_quality );
609 /*Initialization of the structure that holds the bits*/
610 speex_bits_init( &p_sys->bits );
612 p_sys->i_frames_in_packet = 0;
613 p_sys->i_samples_delay = 0;
614 p_sys->i_headers = 0;
617 speex_encoder_ctl( p_sys->p_state, SPEEX_GET_FRAME_SIZE,
618 &p_sys->i_frame_length );
620 p_sys->i_frame_size = p_sys->i_frame_length *
621 sizeof(int16_t) * p_enc->fmt_in.audio.i_channels;
622 p_sys->p_buffer = malloc( p_sys->i_frame_size );
624 msg_Dbg( p_enc, "encoding: frame size:%d, channels:%d, samplerate:%d",
625 p_sys->i_frame_size, p_enc->fmt_in.audio.i_channels,
626 p_enc->fmt_in.audio.i_rate );
631 /****************************************************************************
632 * Headers: spits out the headers
633 ****************************************************************************
634 * This function spits out ogg packets.
635 ****************************************************************************/
636 static block_t *Headers( encoder_t *p_enc )
638 encoder_sys_t *p_sys = p_enc->p_sys;
639 block_t *p_block, *p_chain = NULL;
641 /* Create speex headers */
642 if( !p_sys->i_headers )
648 p_buffer = speex_header_to_packet( &p_sys->header, &i_buffer );
649 p_block = block_New( p_enc, i_buffer );
650 memcpy( p_block->p_buffer, p_buffer, i_buffer );
651 p_block->i_dts = p_block->i_pts = p_block->i_length = 0;
652 block_ChainAppend( &p_chain, p_block );
655 p_block = block_New( p_enc, sizeof("ENCODER=VLC media player") );
656 memcpy( p_block->p_buffer, "ENCODER=VLC media player",
658 p_block->i_dts = p_block->i_pts = p_block->i_length = 0;
659 block_ChainAppend( &p_chain, p_block );
661 p_sys->i_headers = 2;
667 /****************************************************************************
668 * Encode: the whole thing
669 ****************************************************************************
670 * This function spits out ogg packets.
671 ****************************************************************************/
672 static block_t *Encode( encoder_t *p_enc, aout_buffer_t *p_aout_buf )
674 encoder_sys_t *p_sys = p_enc->p_sys;
675 block_t *p_block, *p_chain = NULL;
677 char *p_buffer = p_aout_buf->p_buffer;
678 int i_samples = p_aout_buf->i_nb_samples;
679 int i_samples_delay = p_sys->i_samples_delay;
681 p_sys->i_pts = p_aout_buf->start_date -
682 (mtime_t)1000000 * (mtime_t)p_sys->i_samples_delay /
683 (mtime_t)p_enc->fmt_in.audio.i_rate;
685 p_sys->i_samples_delay += i_samples;
687 while( p_sys->i_samples_delay >= p_sys->i_frame_length )
692 if( i_samples_delay )
694 /* Take care of the left-over from last time */
695 int i_delay_size = i_samples_delay * 2 *
696 p_enc->fmt_in.audio.i_channels;
697 int i_size = p_sys->i_frame_size - i_delay_size;
699 p_samples = (int16_t *)p_sys->p_buffer;
700 memcpy( p_sys->p_buffer + i_delay_size, p_buffer, i_size );
701 p_buffer -= i_delay_size;
702 i_samples += i_samples_delay;
707 p_samples = (int16_t *)p_buffer;
710 /* Encode current frame */
711 if( p_enc->fmt_in.audio.i_channels == 2 )
712 speex_encode_stereo( p_samples, p_sys->i_frame_length,
716 if( p_sys->preprocess )
717 speex_preprocess( p_sys->preprocess, p_samples, NULL );
720 speex_encode( p_sys->p_state, p_samples, &p_sys->bits );
722 p_buffer += p_sys->i_frame_size;
723 p_sys->i_samples_delay -= p_sys->i_frame_length;
724 i_samples -= p_sys->i_frame_length;
726 p_sys->i_frames_in_packet++;
728 if( p_sys->i_frames_in_packet < p_sys->header.frames_per_packet )
731 p_sys->i_frames_in_packet = 0;
733 speex_bits_insert_terminator( &p_sys->bits );
734 i_out = speex_bits_write( &p_sys->bits, p_sys->p_buffer_out,
736 speex_bits_reset( &p_sys->bits );
738 p_block = block_New( p_enc, i_out );
739 memcpy( p_block->p_buffer, p_sys->p_buffer_out, i_out );
741 p_block->i_length = (mtime_t)1000000 *
742 (mtime_t)p_sys->i_frame_length * p_sys->header.frames_per_packet /
743 (mtime_t)p_enc->fmt_in.audio.i_rate;
745 p_block->i_dts = p_block->i_pts = p_sys->i_pts;
748 p_sys->i_pts += p_block->i_length;
749 block_ChainAppend( &p_chain, p_block );
753 /* Backup the remaining raw samples */
756 memcpy( p_sys->p_buffer + i_samples_delay * 2 *
757 p_enc->fmt_in.audio.i_channels, p_buffer,
758 i_samples * 2 * p_enc->fmt_in.audio.i_channels );
764 /*****************************************************************************
765 * CloseEncoder: encoder destruction
766 *****************************************************************************/
767 static void CloseEncoder( vlc_object_t *p_this )
769 encoder_t *p_enc = (encoder_t *)p_this;
770 encoder_sys_t *p_sys = p_enc->p_sys;
772 speex_encoder_destroy( p_sys->p_state );
773 speex_bits_destroy( &p_sys->bits );
775 if( p_sys->p_buffer ) free( p_sys->p_buffer );