File: sound.c

package info (click to toggle)
searchandrescue 0.8.2-10
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,656 kB
  • ctags: 6,111
  • sloc: ansic: 89,072; cpp: 7,691; sh: 90; makefile: 80
file content (974 lines) | stat: -rw-r--r-- 21,412 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <sys/types.h>

#ifdef HAVE_Y2
# include <Y2/Y.h>	/* We get Y_H defined by #including this. */
# include <Y2/Ylib.h>
# include <Y2/Ymixercodes.h>
#endif	/* HAVE_Y2 */

#include "../include/string.h"
#include "../include/disk.h"

#include "sound.h"
#include "sar.h"


#ifdef Y_H
/* Default values for Y. */
# ifndef DEF_Y_CONNECT_ARG
#  define DEF_Y_CONNECT_ARG		"127.0.0.1:9433"
# endif
# ifndef DEF_Y_AUDIO_MODE_NAME
#  define DEF_Y_AUDIO_MODE_NAME		"Default"
# endif
#endif	/* Y_H */


snd_recorder_struct *SoundInit(
	void *core,
	int type,
	const char *connect_arg,
	const char *start_arg,
	void *window
);
int SoundManageEvents(snd_recorder_struct *recorder);
void SoundShutdown(snd_recorder_struct *recorder);

int SoundChangeMode(
	snd_recorder_struct *recorder, const char *mode_name
);

snd_play_struct *SoundStartPlay(
	snd_recorder_struct *recorder,
	const char *object,
	float volume_left, float volume_right,
	int sample_rate,
	snd_flags_t options
);
void SoundStartPlayVoid(
	snd_recorder_struct *recorder,
	const char *object,
	float volume_left, float volume_right,
	int sample_rate,
	snd_flags_t options
);

void SoundPlayMute(
	snd_recorder_struct *recorder,
	snd_play_struct *snd_play,
	int mute
);
void SoundChangePlayVolume(
	snd_recorder_struct *recorder,
	snd_play_struct *snd_play,
	float volume_left, float volume_right
);
void SoundChangePlaySampleRate(
	snd_recorder_struct *recorder,
	snd_play_struct *snd_play,
	int sample_rate
);

void SoundStopPlay(
	snd_recorder_struct *recorder,
	snd_play_struct *snd_play
);

int SoundMusicStartPlay(
	snd_recorder_struct *recorder,
	const char *object,     /* Full path to object. */
	int repeats             /* Number of repeats, -1 for infinate. */
);
int SoundMusicIsPlaying(snd_recorder_struct *recorder);
void SoundMusicStopPlay(snd_recorder_struct *recorder);

#ifdef Y_H
static int SoundGetYMixerCode(const char *channel_name);
#endif
void SoundMixerGet(
	snd_recorder_struct *recorder, const char *channel_name,
	float *left, float *right	/* 0.0 to 1.0 */
);
void SoundMixerSet(
	snd_recorder_struct *recorder, const char *channel_name,
	float left, float right		/* 0.0 to 1.0 */
);


#define MAX(a,b)        (((a) > (b)) ? (a) : (b))
#define MIN(a,b)        (((a) < (b)) ? (a) : (b))
#define CLIP(a,l,h)     (MIN(MAX((a),(l)),(h)))


/*
 *	Initializes sound server and returns a newly allocated
 *	recorder structure.
 */
snd_recorder_struct *SoundInit(
	void *core,
	int type,
	const char *connect_arg,
	const char *start_arg,
	void *window
)
{
	snd_recorder_struct *recorder;
	const sar_option_struct *opt;
	sar_core_struct *core_ptr = SAR_CORE(core);
	if(core_ptr == NULL)
	    return(NULL);

	opt = &core_ptr->option;

	recorder = (snd_recorder_struct *)calloc(
	    1, sizeof(snd_recorder_struct)
	);
	if(recorder == NULL)
	    return(NULL);

	recorder->type = type;
	recorder->con = NULL;
	recorder->sample_rate = 0;
	recorder->sample_size = 0;
	recorder->channels = 0;
	recorder->bytes_per_cycle = 0;
	recorder->background_music_sndobj = NULL;

	/* Initialize by sound server type. */
	switch(type)
	{
	  case SNDSERV_TYPE_Y:
#ifdef Y_H
	    if(connect_arg == NULL)
		connect_arg = (const char *)getenv("RECORDER");
	    if(connect_arg == NULL)
		connect_arg = DEF_Y_CONNECT_ARG;

	    /* Connect to sound server. */
#ifdef __MSW__
	    recorder->con = (void *)YOpenConnectionWin32(
		start_arg, connect_arg, opt->sound_priority, window
	    );
#else
	    recorder->con = (void *)YOpenConnection(
		start_arg, connect_arg
	    );
#endif
	    /* Failed to connect? */
	    if(recorder->con == NULL)
	    {
		free(recorder);
		return(NULL);
	    }

	    /* Record sound server type. */
	    recorder->type = type;

	    if(opt->runtime_debug)
		printf(
"SoundInit(): Initialized sound server at \"%s\".\n",
		    connect_arg
		);
#endif	/* Y_H */
	    if(recorder->con == NULL)
	    {
		fprintf(
		    stderr,
		    "SoundInit(): No sound support.\n"
		);
		free(recorder);
		return(NULL);
	    }
	    break;

	  default:
	    fprintf(
		stderr,
		"SoundInit(): Unsupported sound server type `%i'.\n",
		type
	    );
	    free(recorder);
	    return(NULL);
	    break;
	}

	return(recorder);
}


/*
 *	Manages sound server events.
 *
 *	Returns the number of events recieved or -1 on error.
 *
 *	If -1 is returned then recorder has become invalid and should
 *	not be referenced again. This usually means the sound server
 *	has shut down, the connection to the sound server was broken, or 
 *	some other fatal error occured.
 */
int SoundManageEvents(snd_recorder_struct *recorder)
{
	int events_handled = 0;


	if(recorder == NULL)
	    return(-1);

	switch(recorder->type)
	{
	  case SNDSERV_TYPE_Y:
#ifdef Y_H

/* Macro to return the YID of a given pointer to a snd_play_struct. */
#define GET_SND_PLAY_YID(p)		\
 (((p) != NULL) ? (YID)((snd_play_struct *)(p)->data) : YIDNULL)

/* Macro to set the given snd_play_struct pointer's member data to
 * YIDNULL.
 */
#define SET_SND_PLAY_YID_NULL(p)	\
 { if((p) != NULL) (p)->data = (void *)YIDNULL; }

	    if(recorder->con != NULL)
	    {
		YConnection *con = (YConnection *)recorder->con;
		YEvent event;
		YEventSoundKill *kill;
		YEventMixer *mixer;

		/* Begin queued Y events. */
		while(YGetNextEvent(
		    con,
		    &event,
		    False		/* Do not block. */
		) > 0)
		{
		    events_handled++;

		    switch(event.type)
		    {
		      case YDisconnect: case YShutdown:
			/* Y server has disconnected or shutdown, the
			 * connection structure needs to be closed,
			 * deallocated, and set to NULL.
			 */
			YCloseConnection(con, False);
			recorder->con = con = NULL;

if(event.type == YShutdown)
 fprintf(
  stderr,
  "Lost connection to Y server: Y server has shut down.\n"
 );
else
 fprintf(
  stderr,
  "Lost connection to Y server: Y server has disconnected us.\n"
 );

			/* Deallocate recorder structure and return
			 * indicating that the recorder should not be 
			 * referenced again.
			 */
			free(recorder);
			return(-1);
			break;

		      /* Sound object has stopped playing. */
		      case YSoundObjectKill:
			kill = &event.kill;
			if(kill->yid != YIDNULL)
			{
			    YID yid = kill->yid;

			    /* Begin checking which sound object this is. */
			    /* Background music? */
			    if(yid == GET_SND_PLAY_YID(recorder->background_music_sndobj))
			    {
				SET_SND_PLAY_YID_NULL(recorder->background_music_sndobj);
				SoundStopPlay(
				    recorder,
				    recorder->background_music_sndobj
				);
				recorder->background_music_sndobj = NULL;
			    }
			}
			break; 

		      case YMixerChannel:
			mixer = &event.mixer;
			switch(mixer->code)
			{
			  case YMixerCodeVolume:
			    break;
			  case YMixerCodeSynth:
			    break;
			  case YMixerCodePCM:
			    break;
			}
			break;
		    }
		}	/* Handle queued Y events. */
	    }
#undef SET_SND_PLAY_YID_NULL
#undef GET_SND_PLAY_YID
#endif  /* Y_H */
	    break;

	  default:
	    free(recorder);
	    return(-1);
	    break;
	}

	return(events_handled);
}

/*
 *      Shuts down the sound server, all resources on the given recorder
 *	structure will be deallocated and the recorder structure itself
 *	will be deallocated. The recorder should not be referenced again
 *	after this call.
 */
void SoundShutdown(
	snd_recorder_struct *recorder
)
{
	if(recorder == NULL)
	    return;

	/* Stop related resources first. */
	SoundMusicStopPlay(recorder);

	/* Shut down sound server by type. */
	switch(recorder->type)
	{
	  case SNDSERV_TYPE_Y:
#ifdef Y_H
	    if(recorder->con != NULL)
	    {
		YConnection *con = (YConnection *)recorder->con;

		/* Close connection to server. */
		YCloseConnection(con, False);
		recorder->con = con = NULL;
	    }
#endif  /* Y_H */
	    break;

	}

	/* Deallocate recorder structure. */
	free(recorder);

}



/*
 *	Changes audio mode to the one specified by mode_name.
 *
 *	Returns 0 on success or -1 on error.
 */
int SoundChangeMode(
	snd_recorder_struct *recorder, const char *mode_name
)
{
	if(recorder == NULL)
	    return(-1);

	switch(recorder->type)
	{
	  case SNDSERV_TYPE_Y:
#ifdef Y_H
	    if(recorder->con != NULL)
	    {
		YConnection *con = (YConnection *)recorder->con;
		YAudioModeValuesStruct **ptr, *yaudio_mode;
		int i, total_yaudio_modes;

		int sample_rate = 0;
		int sample_size = 0;
		int channels = 0;
		int fragment_size_bytes = 0;


		if(mode_name == NULL)
		    mode_name = DEF_Y_AUDIO_MODE_NAME;

		/* Get listing of available Audio mode. */
		ptr = YGetAudioModes(con, &total_yaudio_modes);

		/* Check if specified Audio mode is in list. */
		for(i = 0; i < total_yaudio_modes; i++)  
		{
		    yaudio_mode = ptr[i];
		    if(yaudio_mode == NULL)
			continue;

		    if(yaudio_mode->name == NULL)
			continue;

		    /* Audio mode names match? */
		    if(!strcasecmp(yaudio_mode->name, mode_name))
		    {
			sample_rate = yaudio_mode->sample_rate;
			sample_size = yaudio_mode->sample_size;
			channels = yaudio_mode->sample_rate;
			fragment_size_bytes = yaudio_mode->fragment_size_bytes;
			break;
		    }
		}
		/* Free Audio modes listing. */
		YFreeAudioModesList(ptr, total_yaudio_modes);

	        /* Audio mode name in list? */
	        if(i >= total_yaudio_modes)
		{
		    /* Could not match audio mode name from server's list
		     * of audio mode names. So we need to return -1 here.
		     */
		    return(-1);
		}

	        /* Change Audio mode. */
		if(YChangeAudioModePreset(con, mode_name))
		    return(-1);

		/* Record new Audio values on our recorder structure. */
		recorder->sample_rate = sample_rate;
		recorder->sample_size = sample_size;
		recorder->channels = channels;
		recorder->bytes_per_cycle = fragment_size_bytes;
	    }
#endif	/* Y_H */
	    break;

	}

	return(0);
}


/*
 *	Plays a sound object by given object path. Returns a dynamically
 *	allocated structure containing the play information or NULL on failure.
 */
snd_play_struct *SoundStartPlay(
	snd_recorder_struct *recorder,
	const char *object,	/* Full path to sound object. */
	float volume_left,     /* Volume, from 0.0 to 1.0. */
	float volume_right,
	int sample_rate,        /* Applied sample rate, can be 0. */
	snd_flags_t options     /* Any of SND_PLAY_OPTION_*. */
)
{
	snd_play_struct *snd_play = NULL;


	if((recorder == NULL) || (object == NULL))
	    return(snd_play);

	switch(recorder->type)
	{
	  case SNDSERV_TYPE_Y:
#ifdef Y_H
	    if(recorder->con != NULL)
	    {
		YConnection *con = (YConnection *)recorder->con;
		YID yid;
		YEventSoundPlay value;

		/* Set up sound play values. */
		value.flags = YPlayValuesFlagPosition |
			      YPlayValuesFlagTotalRepeats |
			      YPlayValuesFlagVolume |
			      YPlayValuesFlagSampleRate;
		value.position = 0;
		value.total_repeats = ((options & SND_PLAY_OPTION_REPEATING) ?
		    -1 : 1
		);
		value.left_volume = CLIP(
		    (options & SND_PLAY_OPTION_MUTE) ? 0.0 : volume_left,
		    0.0, 1.0
		);
		value.right_volume = CLIP(
		    (options & SND_PLAY_OPTION_MUTE) ? 0.0 : volume_right,
		    0.0, 1.0
		);
		value.sample_rate = sample_rate;

		/* Start playing sound object. */
		yid = YStartPlaySoundObject(
		    con,
		    object,
		    &value
		);
		if(yid == YIDNULL)
		    return(NULL);

		/* Allocate sound play structure. */
		snd_play = (snd_play_struct *)calloc(
		    1, sizeof(snd_play_struct)
		);
		if(snd_play == NULL)
		    return(NULL);

		/* Record values. */
		snd_play->data = (void *)yid;
		snd_play->volume_left = (float)value.left_volume;
		snd_play->volume_right = (float)value.right_volume;
		snd_play->sample_rate = sample_rate;
		snd_play->options = options;
	    }
#endif	/* Y_H */
	    break;

	}

	return(snd_play);
}

/*
 *	Same as SoundStartPlay() except no reference is returned and there
 *	is no way to control the sound object being played after it has
 *	started playing (except for calling SoundShutdown()).
 */
void SoundStartPlayVoid(
	snd_recorder_struct *recorder,
	const char *object,	/* Full path to sound object. */
	float volume_left,	/* Volume, from 0.0 to 1.0. */
	float volume_right,
	int sample_rate,        /* Applied sample rate, can be 0. */
	snd_flags_t options     /* Any of SND_PLAY_OPTION_*. */
)
{
	if((recorder == NULL) || (object == NULL))
	    return;

	switch(recorder->type)
	{
	  case SNDSERV_TYPE_Y:
#ifdef Y_H
	    if(recorder->con != NULL)
	    {
		YConnection *con = (YConnection *)recorder->con;
		YID yid;
		YEventSoundPlay value;

		/* Set up sound play values. */
		value.flags = YPlayValuesFlagPosition |
			      YPlayValuesFlagTotalRepeats |
			      YPlayValuesFlagVolume |
			      YPlayValuesFlagSampleRate;
		value.position = 0;
		value.total_repeats = ((options & SND_PLAY_OPTION_REPEATING) ?
		    -1 : 1
		);
		value.left_volume = CLIP(
		    (options & SND_PLAY_OPTION_MUTE) ? 0.0 : volume_left,
		    0.0, 1.0
		);
		value.right_volume = CLIP(
		    (options & SND_PLAY_OPTION_MUTE) ? 0.0 : volume_right,
		    0.0, 1.0
		);
		value.sample_rate = sample_rate;

		/* Start playing sound object. */
		yid = YStartPlaySoundObject(con, object, &value);
		if(yid == YIDNULL)
		    return;
	    }
#endif  /* Y_H */
	    break;

	}
}

/*
 *	Mutes or unmutes a sound object already playing.
 */
void SoundPlayMute(
	snd_recorder_struct *recorder, snd_play_struct *snd_play,
	int mute
)
{
	if((recorder == NULL) || (snd_play == NULL))
	    return;

	if(mute)
	    snd_play->options |= SND_PLAY_OPTION_MUTE;
	else
	    snd_play->options &= ~SND_PLAY_OPTION_MUTE;

	SoundChangePlayVolume(
	    recorder, snd_play,
	    snd_play->volume_left, snd_play->volume_right
	);
}

/*
 *	Changes the volume of the sound object already playing.
 */
void SoundChangePlayVolume(
	snd_recorder_struct *recorder, snd_play_struct *snd_play,
	float volume_left,     /* Volume, from 0.0 to 1.0. */
	float volume_right
)
{
	if((recorder == NULL) || (snd_play == NULL))
	    return;

	/* Change in volume? */
	if((volume_left == snd_play->volume_left) &&
	   (volume_right == snd_play->volume_right)
	)
	    return;

	switch(recorder->type)   
	{
	  case SNDSERV_TYPE_Y:
#ifdef Y_H
	    if((recorder->con != NULL) &&
	       (snd_play->data != NULL)
	    )
	    {
		YConnection *con = (YConnection *)recorder->con;
		YID yid = (YID)snd_play->data;
		YEventSoundPlay value;


		/* Set up sound play values. */
		value.flags = YPlayValuesFlagVolume;
		value.left_volume = CLIP(
		    (snd_play->options & SND_PLAY_OPTION_MUTE) ? 0.0 : volume_left,
		    0.0, 1.0
		);
		value.right_volume = CLIP(
		    (snd_play->options & SND_PLAY_OPTION_MUTE) ? 0.0 : volume_right,
		    0.0, 1.0
		);

		/* Change play sound object values. */
		YSetPlaySoundObjectValues(con, yid, &value);

		/* Record values. */
		snd_play->volume_left = (float)value.left_volume;
		snd_play->volume_right = (float)value.right_volume;
	    }
#endif  /* Y_H */
	    break;

	}
}

/*
 *      Changes the sample rate of the sound object already playing.
 */
void SoundChangePlaySampleRate(
	snd_recorder_struct *recorder,
	snd_play_struct *snd_play,
	int sample_rate         /* Applied sample rate, can be 0. */
)
{
	if((recorder == NULL) || (snd_play == NULL))
	    return;

	/* Change in applied sample rate? */
	if(sample_rate == snd_play->sample_rate)
	    return;

	switch(recorder->type)
	{
	  case SNDSERV_TYPE_Y:
#ifdef Y_H
	    if((recorder->con != NULL) &&
	       (snd_play->data != NULL)
	    )
	    {
		YConnection *con = (YConnection *)recorder->con;
		YID yid = (YID)snd_play->data;
		YEventSoundPlay value;


		if(sample_rate < 0)
		    sample_rate = 0;

		/* Set up sound play values. */
		value.flags = YPlayValuesFlagSampleRate;
		value.sample_rate = sample_rate;

		/* Change play sound object values. */
		YSetPlaySoundObjectValues(con, yid, &value);

		/* Record values. */
		snd_play->sample_rate = sample_rate;
	    }
#endif  /* Y_H */
	    break;

	}
}

/*
 *	Stops a sound object already playing and deallocates the given
 *	snd_play structure. The snd_play structure should not be
 *	referenced again after this call. The snd_play structure will be
 *	deallocated even if recorder is NULL. However recorder should 
 *	always be given if available.
 */
void SoundStopPlay(
	snd_recorder_struct *recorder, snd_play_struct *snd_play
)
{
#define DO_FREE_PLAY_STRUCT	\
{ if(snd_play != NULL) { free(snd_play); snd_play = NULL; } }

	if(recorder == NULL)
	{
	    DO_FREE_PLAY_STRUCT
	    return;
	}

	if(snd_play == NULL)
	    return;

	switch(recorder->type)
	{       
	  case SNDSERV_TYPE_Y:
#ifdef Y_H
	    if((recorder->con != NULL) &&
	       ((YID)snd_play->data != YIDNULL)
	    )
	    {
		YConnection *con = (YConnection *)recorder->con;
		YID yid = (YID)snd_play->data;

		YDestroyPlaySoundObject(con, yid);
		snd_play->data = (void *)YIDNULL;
	    }
#endif	/* Y_H */
	    break;

	}

	DO_FREE_PLAY_STRUCT
#undef DO_FREE_PLAY_STRUCT
}


/*
 *	Starts playing the given background music sound object specified
 *	by object. If an existing background music sound object is being
 *	played then it will be stopped first.
 *
 *	The given repeats can be -1 for infinate repeating (only stopped
 *	when another background music sound object begins to play or when
 *	the sound server shuts down).
 *
 *	Returns non-zero on error.
 */
int SoundMusicStartPlay(
	snd_recorder_struct *recorder,
	const char *object,     /* Full path to object. */
	int repeats             /* Number of repeats, -1 for infinate. */
)
{
	snd_play_struct *snd_play = NULL;


	if((recorder == NULL) || (object == NULL))
	    return(-1);

	/* Stop currently playing background music if any. */
	SoundMusicStopPlay(recorder);

	/* Unable to destroy background music sound object? */
	if(recorder->background_music_sndobj != NULL)
	    return(-1);


	switch(recorder->type)
	{
	  case SNDSERV_TYPE_Y:
#ifdef Y_H
	    if(recorder->con != NULL)
	    {
		YConnection *con = (YConnection *)recorder->con;
		YID yid;
		YEventSoundPlay value;


		/* Set up sound play values. */
		value.flags = YPlayValuesFlagPosition |
			      YPlayValuesFlagTotalRepeats |
			      YPlayValuesFlagVolume |
			      YPlayValuesFlagSampleRate;
		value.position = 0;
		value.total_repeats = repeats;
		value.left_volume = 1.0;
		value.right_volume = 1.0;
		value.sample_rate = recorder->sample_rate;

		/* Start playing sound object. */
		yid = YStartPlaySoundObject(con, object, &value);
		if(yid == YIDNULL)
		    return(-1);

		/* Allocate background music sound play structure. */
		recorder->background_music_sndobj = snd_play = (snd_play_struct *)calloc(
		    1, sizeof(snd_play_struct)
		);
		if(snd_play == NULL)
		    return(-1);

		/* Record values. */
		snd_play->data = (void *)yid;
		snd_play->volume_left = (float)value.left_volume;
		snd_play->volume_right = (float)value.right_volume;
		snd_play->sample_rate = value.sample_rate;
		snd_play->options = 0;
	    }
#endif  /* Y_H */
	    break;

	}

	return(0);
}

/*
 *	Returns true if there is a background music sound object playing
 *	on the specified recorder.
 */
int SoundMusicIsPlaying(snd_recorder_struct *recorder)
{
	return((recorder != NULL) ?
	    (recorder->background_music_sndobj != NULL) : 0
	);
}

/*
 *	Stops playing the background music sound object (if any).
 */
void SoundMusicStopPlay(snd_recorder_struct *recorder)
{
	if(recorder == NULL)
	    return;

	if(recorder->background_music_sndobj != NULL)
	{
	    SoundStopPlay(
		recorder,
		recorder->background_music_sndobj
	    );
	    recorder->background_music_sndobj = NULL;
	}
/* printf("SoundMusicStopPlay()\n"); */
}


#ifdef Y_H
/*
 *	Returns one of YMixerCode* based on channel_name or -1 on
 *	error.
 */
static int SoundGetYMixerCode(const char *channel_name)
{
	if(channel_name == NULL)
	    return(-1);

	if(!strcasecmp(channel_name, "volume"))
	    return(YMixerCodeVolume);
	else if(!strcasecmp(channel_name, "midi"))
	    return(YMixerCodeSynth);
	else if(!strcasecmp(channel_name, "wav"))
	    return(YMixerCodePCM);
	else
	    return(-1);
}
#endif

/*
 *	Obtains the mixer channel's values.
 */
void SoundMixerGet(
	snd_recorder_struct *recorder, const char *channel_name,
	float *left, float *right       /* 0.0 to 1.0 */
)
{
	if(left != NULL)
	    *left = 0.0f;
	if(right != NULL)
	    *right = 0.0f;

	if(recorder == NULL)
	    return;

	switch(recorder->type)
	{
	  case SNDSERV_TYPE_Y:
#ifdef Y_H
	    if(recorder->con != NULL)
	    {
		YConnection *con = (YConnection *)recorder->con;
		int mixer_channel_code = SoundGetYMixerCode(channel_name);
		Coefficient v[2];

		if(mixer_channel_code > -1)
		{
		    YGetMixerChannel(
			con, mixer_channel_code,
			&v[0], &v[1]
		    );
		    if(left != NULL)
			*left = (float)v[0];
		    if(right != NULL)
			*right = (float)v[1];
		}
	    }
#endif	/* Y_H */
	    break;
	}
}

/*
 *	Sets the mixer channel value.
 */
void SoundMixerSet(
	snd_recorder_struct *recorder, const char *channel_name,
	float left, float right         /* 0.0 to 1.0 */
)
{
	if(recorder == NULL)
	    return;

	switch(recorder->type)
	{
	  case SNDSERV_TYPE_Y:
#ifdef Y_H
	    if(recorder->con != NULL)
	    {
		YConnection *con = (YConnection *)recorder->con;
		int mixer_channel_code = SoundGetYMixerCode(channel_name);
		Coefficient v[2];

		if(mixer_channel_code > -1)
		{
		    v[0] = left;
		    v[1] = right;
		    YSetMixerChannel(
			con, mixer_channel_code,
			v[0], v[1]
		    );
/*printf("Set %i: %.2f %.2f\n", mixer_channel_code, v[0], v[1]);*/
		}
	    }
#endif  /* Y_H */
	    break;
	}
}