2 * $Logfile: /Freespace2/code/Sound/rtvoice.cpp $
7 * C module file for real-time voice
10 * Revision 1.1 2002/05/03 03:28:10 root
14 * 2 10/07/98 10:54a Dave
17 * 1 10/07/98 10:51a Dave
19 * 24 4/24/98 2:17a Lawrance
20 * Clear out record buffer when recording begins
22 * 23 4/21/98 4:44p Dave
23 * Implement Vasudan ships in multiplayer. Added a debug function to bash
24 * player rank. Fixed a few rtvoice buffer overrun problems. Fixed ui
25 * problem in options screen.
27 * 22 4/21/98 10:30a Dave
28 * allocate 8 second buffers for rtvoice
30 * 21 4/17/98 5:27p Dave
31 * More work on the multi options screen. Fixed many minor ui todo bugs.
33 * 20 4/17/98 10:38a Lawrance
34 * reduce num output streams to 1
36 * 19 3/25/98 9:56a Dave
37 * Increase buffer size to handle 8 seconds of voice data.
39 * 18 3/22/98 7:13p Lawrance
40 * Get streaming of recording voice working
42 * 17 3/09/98 5:22p Dave
43 * Fixed a rtvoice bug which caused bogus output when given size 0 input.
45 * 16 2/26/98 2:54p Lawrance
46 * Don't recreate capture buffer each time recording starts... just use
49 * 15 2/24/98 11:56p Lawrance
50 * Change real-time voice code to provide the uncompressed size on decode.
52 * 14 2/24/98 10:13p Dave
53 * Put in initial support for multiplayer voice streaming.
55 * 13 2/24/98 10:47a Lawrance
56 * Play voice through normal channels
58 * 12 2/23/98 6:54p Lawrance
59 * Make interface to real-time voice more generic and useful.
61 * 11 2/19/98 12:47a Lawrance
62 * Use a global code_info
64 * 10 2/16/98 7:31p Lawrance
65 * get compression/decompression of voice working
67 * 9 2/15/98 11:59p Lawrance
68 * Change the order of some code when opening a stream
70 * 8 2/15/98 11:10p Lawrance
71 * more work on real-time voice system
73 * 7 2/15/98 4:43p Lawrance
74 * work on real-time voice
76 * 6 2/09/98 8:07p Lawrance
77 * get buffer create working
79 * 5 2/04/98 6:08p Lawrance
80 * Read function pointers from dsound.dll, further work on
83 * 4 2/03/98 11:53p Lawrance
84 * Adding support for DirectSoundCapture
86 * 3 2/03/98 4:07p Lawrance
87 * check return codes from waveIn calls
89 * 2 1/31/98 5:48p Lawrance
90 * Start on real-time voice recording
102 typedef struct rtv_format
110 #define MAX_RTV_FORMATS 5
111 static rtv_format Rtv_formats[MAX_RTV_FORMATS] =
120 static int Rtv_do_compression=1; // flag to indicate whether compression should be done
121 static int Rtv_recording_format; // recording format, index into Rtv_formats[]
122 static int Rtv_playback_format; // playback format, index into Rtv_formats[]
124 #define RTV_BUFFER_TIME 8 // length of buffer in seconds
126 static int Rtv_recording_inited=0; // The input stream has been inited
127 static int Rtv_playback_inited=0; // The output stream has been inited
129 static int Rtv_recording=0; // Voice is currently being recorded
131 #define MAX_RTV_OUT_BUFFERS 1
132 #define RTV_OUT_FLAG_USED (1<<0)
133 typedef struct rtv_out_buffer
135 int ds_handle; // handle to directsound buffer
136 int flags; // see RTV_OUT_FLAG_ #defines above
138 static rtv_out_buffer Rtv_output_buffers[MAX_RTV_OUT_BUFFERS]; // data for output buffers
140 static struct t_CodeInfo Rtv_code_info; // Parms will need to be transmitted with packets
142 // recording timer data
143 static int Rtv_record_timer_id; // unique id for callback timer
144 static int Rtv_callback_time; // callback time in ms
146 void (*Rtv_callback)();
148 // recording/encoding buffers
149 static unsigned char *Rtv_capture_raw_buffer;
150 static unsigned char *Rtv_capture_compressed_buffer;
151 static int Rtv_capture_compressed_buffer_size;
152 static int Rtv_capture_raw_buffer_size;
154 static unsigned char *Encode_buffer1=NULL;
155 static unsigned char *Encode_buffer2=NULL;
157 // playback/decoding buffers
158 static unsigned char *Rtv_playback_uncompressed_buffer;
159 static int Rtv_playback_uncompressed_buffer_size;
161 static unsigned char *Decode_buffer=NULL;
162 static int Decode_buffer_size;
164 /////////////////////////////////////////////////////////////////////////////////////////////////
166 /////////////////////////////////////////////////////////////////////////////////////////////////
168 void CALLBACK TimeProc(unsigned int id, unsigned int msg, unsigned long userdata, unsigned long dw1, unsigned long dw2)
170 if ( !Rtv_callback ) {
174 nprintf(("Alan","In callback\n"));
178 // Try to pick the most appropriate recording format
180 // exit: 0 => success
182 int rtvoice_pick_record_format()
186 for (i=0; i<MAX_RTV_FORMATS; i++) {
187 if ( dscap_create_buffer(Rtv_formats[i].frequency, Rtv_formats[i].bits_per_sample, 1, RTV_BUFFER_TIME) == 0 ) {
188 dscap_release_buffer();
189 Rtv_recording_format=i;
194 if ( i == MAX_RTV_FORMATS ) {
201 // input: qos => new quality of service (1..10)
202 void rtvoice_set_qos(int qos)
204 InitEncoder(e_cCodec1, qos, Encode_buffer1, Encode_buffer2);
207 // Init the recording portion of the real-time voice system
208 // input: qos => quality of service (1..10) 1 is highest compression, 10 is highest quality
209 // exit: 0 => success
210 // !0 => failure, recording not possible
211 int rtvoice_init_recording(int qos)
213 if ( !Rtv_recording_inited ) {
214 if ( rtvoice_pick_record_format() ) {
218 Rtv_capture_raw_buffer_size = Rtv_formats[Rtv_recording_format].frequency * (RTV_BUFFER_TIME) * fl2i(Rtv_formats[Rtv_recording_format].bits_per_sample/8.0f);
220 if ( Encode_buffer1 ) {
221 free(Encode_buffer1);
225 if ( dscap_create_buffer(Rtv_formats[Rtv_recording_format].frequency, Rtv_formats[Rtv_recording_format].bits_per_sample, 1, RTV_BUFFER_TIME) ) {
229 Encode_buffer1 = (unsigned char*)malloc(Rtv_capture_raw_buffer_size);
230 Assert(Encode_buffer1);
232 if ( Encode_buffer2 ) {
233 free(Encode_buffer2);
236 Encode_buffer2 = (unsigned char*)malloc(Rtv_capture_raw_buffer_size);
237 Assert(Encode_buffer2);
239 // malloc out the voice data buffer for raw (uncompressed) recorded sound
240 if ( Rtv_capture_raw_buffer ) {
241 free(Rtv_capture_raw_buffer);
242 Rtv_capture_raw_buffer=NULL;
244 Rtv_capture_raw_buffer = (unsigned char*)malloc(Rtv_capture_raw_buffer_size);
246 // malloc out voice data buffer for compressed recorded sound
247 if ( Rtv_capture_compressed_buffer ) {
248 free(Rtv_capture_compressed_buffer);
249 Rtv_capture_compressed_buffer=NULL;
251 Rtv_capture_compressed_buffer_size=Rtv_capture_raw_buffer_size; // be safe and allocate same as uncompressed
252 Rtv_capture_compressed_buffer = (unsigned char*)malloc(Rtv_capture_compressed_buffer_size);
254 InitEncoder(e_cCodec1, qos, Encode_buffer1, Encode_buffer2);
256 Rtv_recording_inited=1;
261 // Stop a stream from recording
262 void rtvoice_stop_recording()
264 if ( !Rtv_recording ) {
270 if ( Rtv_record_timer_id ) {
271 timeKillEvent(Rtv_record_timer_id);
272 Rtv_record_timer_id = 0;
278 // Close down the real-time voice recording system
279 void rtvoice_close_recording()
281 if ( Rtv_recording ) {
282 rtvoice_stop_recording();
285 if ( Encode_buffer1 ) {
286 free(Encode_buffer1);
290 if ( Encode_buffer2 ) {
291 free(Encode_buffer2);
295 if ( Rtv_capture_raw_buffer ) {
296 free(Rtv_capture_raw_buffer);
297 Rtv_capture_raw_buffer=NULL;
300 if ( Rtv_capture_compressed_buffer ) {
301 free(Rtv_capture_compressed_buffer);
302 Rtv_capture_compressed_buffer=NULL;
305 Rtv_recording_inited=0;
308 // Open a stream for recording (recording begins immediately)
309 // exit: 0 => success
311 int rtvoice_start_recording( void (*user_callback)(), int callback_time )
313 if ( !dscap_supported() ) {
317 Assert(Rtv_recording_inited);
319 if ( Rtv_recording ) {
323 if ( dscap_start_record() ) {
327 if ( user_callback ) {
328 Rtv_record_timer_id = timeSetEvent(callback_time, callback_time, TimeProc, 0, TIME_PERIODIC);
329 if ( !Rtv_record_timer_id ) {
333 Rtv_callback = user_callback;
334 Rtv_callback_time = callback_time;
337 Rtv_record_timer_id = 0;
344 // compress voice data using specialized codec
345 int rtvoice_compress(unsigned char *data_in, int size_in, unsigned char *data_out, int size_out)
349 Rtv_code_info.Code = e_cCodec1;
350 Rtv_code_info.Gain = 0;
354 nprintf(("Network","RTVOICE => 0 bytes size in !\n"));
356 compressed_size = Encode(data_in, data_out, size_in, size_out, &Rtv_code_info);
358 nprintf(("SOUND","RTVOICE => Sound compressed to %d bytes (%0.2f percent)\n", compressed_size, (compressed_size*100.0f)/size_in));
361 return compressed_size;
364 // For 8-bit formats (unsigned, 0 to 255)
365 // For 16-bit formats (signed, -32768 to 32767)
366 int rtvoice_16to8(unsigned char *data, int size)
369 unsigned short sample16;
370 unsigned char sample8, *dest, *src;
377 for (i=0; i<size; i+=2) {
379 sample16 |= src[1] << 8;
382 sample8 = (unsigned char)(sample16>>8);
391 // Convert voice sample from 22KHz to 11KHz
392 int rtvoice_22to11(unsigned char *data, int size)
395 unsigned char *dest, *src;
400 for (i=0; i<size; i+=2) {
401 *(dest+new_size) = *(src+i);
408 // Convert voice data to 8bit, 11KHz if necessary
409 int rtvoice_maybe_convert_data(unsigned char *data, int size)
412 switch ( Rtv_recording_format ) {
417 // convert samples to 8 bit from 16 bit
418 new_size = rtvoice_16to8(data,new_size);
422 new_size = rtvoice_22to11(data,new_size);
425 // convert to 11Khz, 8 bit
426 new_size = rtvoice_16to8(data,new_size);
427 new_size = rtvoice_22to11(data,new_size);
430 Int3(); // should never happen
437 // Retrieve the recorded voice data
438 // input: outbuf => output parameter, recorded voice stored here
439 // compressed_size => output parameter, size in bytes of recorded voice after compression
440 // uncompressed_size => output parameter, size in bytes of recorded voice before compression
441 // gain => output parameter, gain value which must be passed to decoder
442 // outbuf_raw => output optional parameter, pointer to the raw sound data making up the compressed chunk
443 // outbuf_size_raw => output optional parameter, size of the outbuf_raw buffer
445 // NOTE: function converts voice data into compressed format
446 void rtvoice_get_data(unsigned char **outbuf, int *compressed_size, int *uncompressed_size, double *gain, unsigned char **outbuf_raw, int *outbuf_size_raw)
448 int max_size, raw_size, csize;
449 max_size = dscap_max_buffersize();
452 *uncompressed_size=0;
455 if ( max_size < 0 ) {
459 raw_size = dscap_get_raw_data(Rtv_capture_raw_buffer, max_size);
461 // convert data to 8bit, 11KHz if necessary
462 raw_size = rtvoice_maybe_convert_data(Rtv_capture_raw_buffer, raw_size);
463 *uncompressed_size=raw_size;
465 // compress voice data
466 if ( Rtv_do_compression ) {
467 csize = rtvoice_compress(Rtv_capture_raw_buffer, raw_size, Rtv_capture_compressed_buffer, Rtv_capture_compressed_buffer_size);
468 *gain = Rtv_code_info.Gain;
469 *compressed_size = csize;
470 *outbuf = Rtv_capture_compressed_buffer;
472 *gain = Rtv_code_info.Gain;
473 *compressed_size = raw_size;
474 *outbuf = Rtv_capture_raw_buffer;
477 // NOTE : if we are not doing compression, then the raw buffer and size are going to be the same as the compressed
480 // assign the raw buffer and size if necessary
481 if(outbuf_raw != NULL){
482 *outbuf_raw = Rtv_capture_raw_buffer;
484 if(outbuf_size_raw != NULL){
485 *outbuf_size_raw = raw_size;
489 /////////////////////////////////////////////////////////////////////////////////////////////////
491 /////////////////////////////////////////////////////////////////////////////////////////////////
493 // return the size that the decode buffer should be
494 int rtvoice_get_decode_buffer_size()
496 return Decode_buffer_size;
499 // uncompress the data into PCM format
500 void rtvoice_uncompress(unsigned char *data_in, int size_in, double gain, unsigned char *data_out, int size_out)
502 Rtv_code_info.Gain = gain;
503 Decode(&Rtv_code_info, data_in, data_out, size_in, size_out);
506 // Close down the real-time voice playback system
507 void rtvoice_close_playback()
509 if ( Decode_buffer ) {
514 if ( Rtv_playback_uncompressed_buffer ) {
515 free(Rtv_playback_uncompressed_buffer);
516 Rtv_playback_uncompressed_buffer=NULL;
519 Rtv_playback_inited=0;
522 // Clear out the Rtv_output_buffers[] array
523 void rtvoice_reset_out_buffers()
527 for ( i=0; i<MAX_RTV_OUT_BUFFERS; i++ ) {
528 Rtv_output_buffers[i].flags=0;
529 Rtv_output_buffers[i].ds_handle=-1;
533 // Init the playback portion of the real-time voice system
534 // exit: 0 => success
535 // !0 => failure, playback not possible
536 int rtvoice_init_playback()
538 rtv_format *rtvf=NULL;
540 if ( !Rtv_playback_inited ) {
542 rtvoice_reset_out_buffers();
544 Rtv_playback_format=0;
545 rtvf = &Rtv_formats[Rtv_playback_format];
546 Decode_buffer_size = rtvf->frequency * (RTV_BUFFER_TIME) * fl2i(rtvf->bits_per_sample/8.0f);
548 if ( Decode_buffer ) {
553 Decode_buffer = (unsigned char*)malloc(Decode_buffer_size);
554 Assert(Decode_buffer);
556 if ( Rtv_playback_uncompressed_buffer ) {
557 free(Rtv_playback_uncompressed_buffer);
558 Rtv_playback_uncompressed_buffer=NULL;
561 Rtv_playback_uncompressed_buffer_size=Decode_buffer_size;
562 Rtv_playback_uncompressed_buffer = (unsigned char*)malloc(Rtv_playback_uncompressed_buffer_size);
563 Assert(Rtv_playback_uncompressed_buffer);
565 InitDecoder(1, Decode_buffer);
567 Rtv_playback_inited=1;
573 int rtvoice_find_free_output_buffer()
577 for ( i=0; i<MAX_RTV_OUT_BUFFERS; i++ ) {
578 if ( !(Rtv_output_buffers[i].flags & RTV_OUT_FLAG_USED) ) {
583 if ( i == MAX_RTV_OUT_BUFFERS ) {
587 Rtv_output_buffers[i].flags |= RTV_OUT_FLAG_USED;
592 // Open a stream for real-time voice output
593 int rtvoice_create_playback_buffer()
596 rtv_format *rtvf=NULL;
598 rtvf = &Rtv_formats[Rtv_playback_format];
599 index = rtvoice_find_free_output_buffer();
606 Rtv_output_buffers[index].ds_handle = ds_create_buffer(rtvf->frequency, rtvf->bits_per_sample, 1, RTV_BUFFER_TIME);
607 if ( Rtv_output_buffers[index].ds_handle == -1 ) {
614 void rtvoice_stop_playback(int index)
616 Assert(index >=0 && index < MAX_RTV_OUT_BUFFERS);
618 if ( Rtv_output_buffers[index].flags & RTV_OUT_FLAG_USED ) {
619 if ( Rtv_output_buffers[index].ds_handle != -1 ) {
620 ds_stop_easy(Rtv_output_buffers[index].ds_handle);
625 void rtvoice_stop_playback_all()
629 for ( i = 0; i < MAX_RTV_OUT_BUFFERS; i++ ) {
630 rtvoice_stop_playback(i);
634 // Close a stream that was opened for real-time voice output
635 void rtvoice_free_playback_buffer(int index)
637 Assert(index >=0 && index < MAX_RTV_OUT_BUFFERS);
639 if ( Rtv_output_buffers[index].flags & RTV_OUT_FLAG_USED ) {
640 Rtv_output_buffers[index].flags=0;
641 if ( Rtv_output_buffers[index].ds_handle != -1 ) {
642 ds_stop_easy(Rtv_output_buffers[index].ds_handle);
643 ds_unload_buffer(Rtv_output_buffers[index].ds_handle, -1);
645 Rtv_output_buffers[index].ds_handle=-1;
649 // Play compressed sound data
650 // exit: >=0 => handle to playing sound
651 // -1 => error, voice not played
652 int rtvoice_play_compressed(int index, unsigned char *data, int size, int uncompressed_size, double gain)
656 ds_handle = Rtv_output_buffers[index].ds_handle;
658 // Stop any currently playing voice output
659 ds_stop_easy(ds_handle);
661 Assert(uncompressed_size <= Rtv_playback_uncompressed_buffer_size);
663 // uncompress the data into PCM format
664 if ( Rtv_do_compression ) {
665 rtvoice_uncompress(data, size, gain, Rtv_playback_uncompressed_buffer, uncompressed_size);
669 if ( ds_lock_data(ds_handle, Rtv_playback_uncompressed_buffer, uncompressed_size) ) {
674 rval = ds_play(ds_handle, -1, -100, DS_MUST_PLAY, ds_convert_volume(Master_voice_volume), 0, 0);
678 // Play uncompressed (raw) sound data
679 // exit: >=0 => handle to playing sound
680 // -1 => error, voice not played
681 int rtvoice_play_uncompressed(int index, unsigned char *data, int size)
685 ds_handle = Rtv_output_buffers[index].ds_handle;
687 // Stop any currently playing voice output
688 ds_stop_easy(ds_handle);
691 if ( ds_lock_data(ds_handle, data, size) ) {
696 rval = ds_play(ds_handle, -1, -100, DS_MUST_PLAY, ds_convert_volume(Master_voice_volume), 0, 0);