forked from insurgentgames/teh-internets
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CocosDenshion.m
868 lines (746 loc) · 28.4 KB
/
CocosDenshion.m
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
/* CocosDenshion Sound Engine
*
* Copyright (C) 2009 Steve Oldmeadow
*
* For independent entities this program is free software; you can redistribute
* it and/or modify it under the terms of the 'cocos2d for iPhone' license with
* the additional proviso that 'cocos2D for iPhone' must be credited in a manner
* that can be be observed by end users, for example, in the credits or during
* start up. Failure to include such notice is deemed to be acceptance of a
* non independent license (see below).
*
* For the purpose of this software non independent entities are defined as
* those where the annual revenue of the entity employing, partnering, or
* affiliated in any way with the Licensee is greater than $250,000 USD annually.
*
* Non independent entities may license this software or a derivation of it
* by a donation of $500 USD per application to the cocos2d for iPhone project.
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*/
#import "CocosDenshion.h"
#import "CDOpenALSupport.h"
//Audio session interruption callback - used if sound engine is
//handling audio session interruption automatically
extern void interruptionListenerCallback (void *inUserData, UInt32 interruptionState ) {
CDSoundEngine *controller = (CDSoundEngine *) inUserData;
if (interruptionState == kAudioSessionBeginInterruption) {
[controller audioSessionInterrupted];
} else if (interruptionState == kAudioSessionEndInterruption) {
[controller audioSessionResumed];
}
}
@interface CDSoundEngine (PrivateMethods)
-(ALuint) _startSound:(int) soundId channelId:(int) channelId pitchVal:(float) pitchVal panVal:(float) panVal gainVal:(float) gainVal looping:(BOOL) looping checkState:(BOOL) checkState;
- (BOOL) _initOpenAL;
@end
@implementation CDUtilities
+(NSString*) fullPathFromRelativePath:(NSString*) relPath
{
// do not convert an absolute path (starting with '/')
if(([relPath length] > 0) && ([relPath characterAtIndex:0] == '/'))
{
return relPath;
}
NSMutableArray *imagePathComponents = [NSMutableArray arrayWithArray:[relPath pathComponents]];
NSString *file = [imagePathComponents lastObject];
[imagePathComponents removeLastObject];
NSString *imageDirectory = [NSString pathWithComponents:imagePathComponents];
NSString *fullpath = [[NSBundle mainBundle] pathForResource:file ofType:nil inDirectory:imageDirectory];
if (fullpath == nil)
fullpath = relPath;
return fullpath;
}
@end
@implementation CDSoundEngine
static Float32 _mixerSampleRate;
static BOOL _mixerRateSet = NO;
@synthesize lastErrorCode, functioning, asynchLoadProgress;
+ (void) setMixerSampleRate:(Float32) sampleRate {
_mixerRateSet = YES;
_mixerSampleRate = sampleRate;
}
/**
* Internal method called during init
*/
- (BOOL) _initOpenAL
{
//ALenum error;
context = NULL;
ALCdevice *newDevice = NULL;
//_buffers = new ALuint[CD_MAX_BUFFERS];
_buffers = (ALuint *)malloc( sizeof(_buffers[0]) * CD_MAX_BUFFERS );
if(!_buffers) {
CDLOG(@"Denshion::CDSoundEngine - buffer memory allocation failed");
return FALSE;
}
//_sources = new ALuint[CD_MAX_SOURCES];
_sources = (ALuint *)malloc( sizeof(_sources[0]) * CD_MAX_SOURCES );
if(!_sources) {
CDLOG(@"Denshion::CDSoundEngine - source memory allocation failed");
return FALSE;
}
//Set the mixer rate for the audio mixer
if (!_mixerRateSet) {
_mixerSampleRate = CD_SAMPLE_RATE_DEFAULT;
}
alcMacOSXMixerOutputRateProc(_mixerSampleRate);
CDLOG(@"Denshion::CDSoundEngine - mixer output rate set to %0.2f",_mixerSampleRate);
// Create a new OpenAL Device
// Pass NULL to specify the system's default output device
newDevice = alcOpenDevice(NULL);
if (newDevice != NULL)
{
// Create a new OpenAL Context
// The new context will render to the OpenAL Device just created
context = alcCreateContext(newDevice, 0);
if (context != NULL)
{
// Make the new context the Current OpenAL Context
alcMakeContextCurrent(context);
//Don't want a distance model
alDistanceModel(AL_NONE);
// Create some OpenAL Buffer Objects
alGenBuffers(CD_MAX_BUFFERS, _buffers);
if((lastErrorCode = alGetError()) != AL_NO_ERROR) {
CDLOG(@"Denshion::CDSoundEngine - Error Generating Buffers: %x", lastErrorCode);
return FALSE;//No buffers
}
// Create some OpenAL Source Objects
alGenSources(CD_MAX_SOURCES, _sources);
if((lastErrorCode = alGetError()) != AL_NO_ERROR) {
CDLOG(@"Denshion::CDSoundEngine - Error generating sources! %x\n", lastErrorCode);
return FALSE;//No sources
}
}
} else {
return FALSE;//No device
}
alGetError();//Clear error
return TRUE;
}
- (void) dealloc {
ALCcontext *currentContext = NULL;
ALCdevice *device = NULL;
CDLOG(@"Denshion::CDSoundEngine - Deallocing sound engine.");
free(_bufferStates);
free(_channelGroups);
free(_sourceBufferAttachments);
// Delete the Sources
alDeleteSources(CD_MAX_SOURCES, _sources);
if((lastErrorCode = alGetError()) != AL_NO_ERROR) {
CDLOG(@"Denshion::CDSoundEngine - Error deleting sources! %x\n", lastErrorCode);
}
// Delete the Buffers
alDeleteBuffers(CD_MAX_BUFFERS, _buffers);
if((lastErrorCode = alGetError()) != AL_NO_ERROR) {
CDLOG(@"Denshion::CDSoundEngine - Error deleting buffers! %x\n", lastErrorCode);
}
//Get active context
currentContext = alcGetCurrentContext();
//Get device for active context
device = alcGetContextsDevice(currentContext);
//Release context
alcDestroyContext(currentContext);
//Close device
alcCloseDevice(device);
free(_buffers);
free(_sources);
#ifdef CD_USE_STATIC_BUFFERS
//First free all the data
for (int i=0; i < CD_MAX_BUFFERS; i++) {
if (_bufferData[i]) {
free(_bufferData[i]);
}
}
//Now free the array
free(_bufferData);
#endif
[super dealloc];
}
/**
* Call this initialiser if you want the sound engine to automatically handle audio session interruption.
* If you are using the sound engine in conjunction with another audio api such as AVAudioPlayer or
* AudioQueue then you probably do not want the sound engine to handle audio session interruption
* for you.
*
* The audioSessionCategory should be one of the audio session category enumeration values such as
* kAudioSessionCategory_AmbientSound. Your choice is dependent on how you want your audio to interact
* with other audio on the device.
*
* Please note that audio session interruption is different to application interruption. Known triggers are
* alarm notification from clock, incoming phone call that is rejected and video playback ending.
*/
- (id)init:(int[]) channelGroupDefinitions channelGroupTotal:(int) channelGroupTotal audioSessionCategory:(UInt32) audioSessionCategory
{
if ((self = [super init])) {
_mute = NO;
asynchLoadProgress = 0.0f;
_audioSessionCategory = audioSessionCategory;
_handleAudioSession = (_audioSessionCategory != CD_IGNORE_AUDIO_SESSION);
if (_handleAudioSession) {
CDLOG(@"Denshion::CDSoundEngine - Sound engine will handle audio session interruption");
//Set up audio session
OSStatus result = AudioSessionInitialize(NULL, NULL,interruptionListenerCallback, self);
result = AudioSessionSetProperty(kAudioSessionProperty_AudioCategory, sizeof(_audioSessionCategory), &_audioSessionCategory);
#pragma unused(result)
}
//Set up channel groups
//_channelGroups = new channelGroup[channelGroupTotal];
_channelGroups = (channelGroup *)malloc( sizeof(_channelGroups[0]) * channelGroupTotal);
if(!_channelGroups) {
CDLOG(@"Denshion::CDSoundEngine - channel groups memory allocation failed");
}
_channelGroupTotal = channelGroupTotal;
int channelCount = 0;
for (int i=0; i < channelGroupTotal; i++) {
_channelGroups[i].startIndex = channelCount;
_channelGroups[i].endIndex = _channelGroups[i].startIndex + channelGroupDefinitions[i] - 1;
_channelGroups[i].currentIndex = _channelGroups[i].startIndex;
_channelGroups[i].mute = false;
channelCount += channelGroupDefinitions[i];
CDLOG(@"Denshion::CDSoundEngine - channel def %i %i %i %i",i,_channelGroups[i].startIndex, _channelGroups[i].endIndex, _channelGroups[i].currentIndex);
}
NSAssert(channelCount <= CD_MAX_SOURCES,@"requested total channels exceeds CD_MAX_SOURCES");
_channelTotal = channelCount;
//Set up buffer states
//_bufferStates = new int[CD_MAX_BUFFERS];
_bufferStates = (int *)malloc( sizeof(_bufferStates[0]) * CD_MAX_BUFFERS);
if(!_bufferStates) {
CDLOG(@"Denshion::CDSoundEngine - buffer states memory allocation failed");
}
for (int i=0; i < CD_MAX_BUFFERS; i++) {
_bufferStates[i] = CD_BS_EMPTY;
}
//_sourceBufferAttachments = new ALuint[CD_MAX_SOURCES];
_sourceBufferAttachments = (ALuint *)malloc( sizeof(_sourceBufferAttachments[0]) * CD_MAX_SOURCES);
if(!_sourceBufferAttachments) {
CDLOG(@"Denshion::CDSoundEngine - source buffer attachments memory allocation failed");
}
#ifdef CD_USE_STATIC_BUFFERS
CDLOG(@"Denshion::CDSoundEngine - using static buffers");
_bufferData = (ALvoid **)malloc(sizeof(_bufferData[0]) * CD_MAX_BUFFERS);
for (int i=0; i < CD_MAX_BUFFERS; i++) {
_bufferData[i] = NULL;
}
#endif
// Initialize our OpenAL environment
if ([self _initOpenAL]) {
functioning = TRUE;
} else {
//Something went wrong with OpenAL
functioning = FALSE;
}
}
return self;
}
/**
* If you call this initialiser the sound engine won't handle audio session interruption and resumption.
*/
- (id)init:(int[]) channelGroupDefinitions channelGroupTotal:(int) channelGroupTotal {
return [self init:channelGroupDefinitions channelGroupTotal:channelGroupTotal audioSessionCategory:CD_IGNORE_AUDIO_SESSION];
}
/**
* Delete the buffer identified by soundId
* @return true if buffer deleted successfully, otherwise false
*/
- (BOOL) unloadBuffer:(int) soundId
{
//Ensure soundId is within array bounds otherwise memory corruption will occur
if (soundId < 0 || soundId >= CD_MAX_BUFFERS) {
CDLOG(@"Denshion::CDSoundEngine - soundId is outside array bounds, maybe you need to increase CD_MAX_BUFFERS");
return FALSE;
}
//Before a buffer can be deleted any sources that are attached to it must be stopped
for (int i=0; i < _channelTotal; i++) {
//Note: tried getting the AL_BUFFER attribute of the source instead but doesn't
//appear to work on a device - just returned zero.
if (_buffers[soundId] == _sourceBufferAttachments[i]) {
CDLOG(@"Denshion::CDSoundEngine - Found attached source %i %i %i",i,_buffers[soundId],_sourceBufferAttachments[i]);
#ifdef CD_USE_STATIC_BUFFERS
//When using static buffers a crash may occur if a source is playing with a buffer that is about
//to be deleted even though we stop the source and successfully delete the buffer. Crash is confirmed
//on 2.2.1 and 3.1.2, however, it will only occur if a source is used rapidly after having its prior
//data deleted. To avoid any possibility of the crash we wait for the source to finish playing.
ALint state;
alGetSourcei(_sources[i], AL_SOURCE_STATE, &state);
if (state == AL_PLAYING) {
CDLOG(@"Denshion::CDSoundEngine - waiting for source to complete playing before removing buffer data");
alSourcei(_sources[i], AL_LOOPING, FALSE);//Turn off looping otherwise loops will never end
while (state == AL_PLAYING) {
alGetSourcei(_sources[i], AL_SOURCE_STATE, &state);
usleep(10000);
}
}
#endif
//Stop source and detach
alSourceStop(_sources[i]);
if((lastErrorCode = alGetError()) != AL_NO_ERROR) {
CDLOG(@"Denshion::CDSoundEngine - error stopping source: %x\n", lastErrorCode);
}
alSourcei(_sources[i], AL_BUFFER, 0);//Attach to "NULL" buffer to detach
if((lastErrorCode = alGetError()) != AL_NO_ERROR) {
CDLOG(@"Denshion::CDSoundEngine - error detaching buffer: %x\n", lastErrorCode);
} else {
//Record that source is now attached to nothing
_sourceBufferAttachments[i] = 0;
}
}
}
alDeleteBuffers(1, &_buffers[soundId]);
if((lastErrorCode = alGetError()) != AL_NO_ERROR) {
CDLOG(@"Denshion::CDSoundEngine - error deleting buffer: %x\n", lastErrorCode);
_bufferStates[soundId] = CD_BS_FAILED;
return FALSE;
} else {
#ifdef CD_USE_STATIC_BUFFERS
//Free previous data, if alDeleteBuffer has returned without error then no
if (_bufferData[soundId]) {
CDLOG(@"Denshion::CDSoundEngine - freeing static data for soundId %i @ %i",soundId,_bufferData[soundId]);
free(_bufferData[soundId]);//Free the old data
_bufferData[soundId] = NULL;
}
#endif
}
alGenBuffers(1, &_buffers[soundId]);
if((lastErrorCode = alGetError()) != AL_NO_ERROR) {
CDLOG(@"Denshion::CDSoundEngine - error regenerating buffer: %x\n", lastErrorCode);
_bufferStates[soundId] = CD_BS_FAILED;
return FALSE;
} else {
//We now have an empty buffer
_bufferStates[soundId] = CD_BS_EMPTY;
CDLOG(@"Denshion::CDSoundEngine - buffer %i successfully unloaded\n",soundId);
return TRUE;
}
}
/**
* Load buffers asynchronously
* Check asynchLoadProgress for progress. asynchLoadProgress represents fraction of completion. When it equals 1.0 loading
* is complete. NB: asynchLoadProgress is simply based on the number of load requests, it does not take into account
* file sizes.
* @param An array of CDBufferLoadRequest objects
*/
- (void) loadBuffersAsynchronously:(NSArray *) loadRequests {
@synchronized(self) {
asynchLoadProgress = 0.0f;
CDAsynchBufferLoader *loaderOp = [[[CDAsynchBufferLoader alloc] init:loadRequests soundEngine:self] autorelease];
NSOperationQueue *opQ = [[[NSOperationQueue alloc] init] autorelease]; //This is going to leak?
[opQ addOperation:loaderOp];
}
}
/**
* Load sound data for later play back.
* @return TRUE if buffer loaded okay for play back otherwise false
*/
- (BOOL) loadBuffer:(int) soundId filePath:(NSString*) filePath
{
ALenum format;
ALvoid* data;
ALsizei size;
ALsizei freq;
CDLOG(@"Denshion::CDSoundEngine - Loading openAL buffer %i %@", soundId, filePath);
if (!functioning) {
//OpenAL initialisation has previously failed
CDLOG(@"Denshion::CDSoundEngine - Loading buffer failed because sound engine state != functioning");
return FALSE;
}
//Ensure soundId is within array bounds otherwise memory corruption will occur
if (soundId < 0 || soundId >= CD_MAX_BUFFERS) {
CDLOG(@"Denshion::CDSoundEngine - soundId is outside array bounds, maybe you need to increase CD_MAX_BUFFERS");
return FALSE;
}
CFURLRef fileURL = nil;
NSString *path = [CDUtilities fullPathFromRelativePath:filePath];
if (path) {
fileURL = (CFURLRef)[[NSURL fileURLWithPath:path] retain];
}
if (fileURL)
{
if (_bufferStates[soundId] != CD_BS_EMPTY) {
CDLOG(@"Denshion::CDSoundEngine - non empty buffer, regenerating");
if (![self unloadBuffer:soundId]) {
//Deletion of buffer failed, delete buffer routine has set buffer state and lastErrorCode
CFRelease(fileURL);//Thanks clang ;)
return FALSE;
}
}
data = CDGetOpenALAudioData(fileURL, &size, &format, &freq);
CDLOG(@"Denshion::CDSoundEngine - size %i frequency %i format %i %i", size, freq, format, data);
#ifdef CD_DEBUG
//Check that sample rate matches mixer rate and warn if they do not
if (freq != (int)_mixerSampleRate) {
CDLOG(@"Denshion::CDSoundEngine - WARNING sample rate does not match mixer sample rate performance will not be optimal.");
}
#endif
CFRelease(fileURL);
if(data == NULL) {
CDLOG(@"Denshion::CDSoundEngine - error loading sound data is null");
_bufferStates[soundId] = CD_BS_FAILED;
return FALSE;
}
#ifdef CD_USE_STATIC_BUFFERS
alBufferDataStaticProc(_buffers[soundId], format, data, size, freq);
_bufferData[soundId] = data;//Save the pointer to the new data
#else
alBufferData(_buffers[soundId], format, data, size, freq);
free(data);//Data can be freed here because alBufferData performs a memcpy
#endif
if((lastErrorCode = alGetError()) != AL_NO_ERROR) {
CDLOG(@"Denshion::CDSoundEngine - error attaching audio to buffer: %x\n", lastErrorCode);
_bufferStates[soundId] = CD_BS_FAILED;
return FALSE;
}
} else {
CDLOG(@"Denshion: Could not find file!\n");
//Don't change buffer state here as it will be the same as before method was called
return FALSE;
}
_bufferStates[soundId] = CD_BS_LOADED;
CDLOG(@"Denshion::CDSoundEngine - =============== Buffer Loaded ===============");
return TRUE;
}
- (ALfloat) masterGain {
ALfloat gain;
alGetListenerf(AL_GAIN, &gain);
return gain;
}
/**
* Overall gain setting multiplier. e.g 0.5 is half the gain.
*/
- (void) setMasterGain:(ALfloat) newGainValue {
alListenerf(AL_GAIN, newGainValue);
}
- (BOOL) mute {
return _mute;
}
/**
* Setting mute silences all sounds but playing sounds continue to advance playback
*/
- (void) setMute:(BOOL) newMuteValue {
_mute = newMuteValue;
if (_mute) {
//Remember what the gain was
_preMuteGain = self.masterGain;
//Set gain to 0
self.masterGain = 0.0f;
} else {
self.masterGain = _preMuteGain;
}
}
/**
* Play a sound.
* @param soundId the id of the sound to play (buffer id).
* @param channelGroupId the channel group that will be used to play the sound.
* @param pitch pitch multiplier. e.g 1.0 is unaltered, 0.5 is 1 octave lower.
* @param pan stereo position. -1 is fully left, 0 is centre and 1 is fully right.
* @param gain gain multiplier. e.g. 1.0 is unaltered, 0.5 is half the gain
* @param loop should the sound be looped or one shot.
* @return the id of the source being used to play the sound or CD_MUTE if the sound engine is muted or non functioning
* or CD_NO_SOURCE if a problem occurs setting up the source
*
*/
- (ALuint)playSound:(int) soundId channelGroupId:(int)channelGroupId pitch:(float) pitch pan:(float) pan gain:(float) gain loop:(BOOL) loop {
#ifdef CD_DEBUG
//Sanity check parameters - only in DEBUG
NSAssert(soundId >= 0, @"soundId can not be negative");
NSAssert(soundId < CD_MAX_BUFFERS, @"soundId exceeds limit");
NSAssert(channelGroupId >= 0, @"channelGroupId can not be negative");
NSAssert(channelGroupId < _channelGroupTotal, @"channelGroupId exceeds limit");
NSAssert(pitch > 0, @"pitch must be greater than zero");
NSAssert(pan >= -1 && pan <= 1, @"pan must be between -1 and 1");
NSAssert(gain >= 0, @"gain can not be negative");
#endif
//If mute or initialisation has failed or buffer is not loaded then do nothing
if (_mute || !functioning || _bufferStates[soundId] != CD_BS_LOADED || _channelGroups[channelGroupId].mute) {
#ifdef CD_DEBUG
if (!functioning) {
CDLOG(@"Denshion::CDSoundEngine - sound playback aborted because sound engine is not functioning");
} else if (_bufferStates[soundId] != CD_BS_LOADED) {
CDLOG(@"Denshion::CDSoundEngine - sound playback aborted because buffer %i is not loaded", soundId);
}
#endif
return CD_MUTE;
}
//Work out which channel we can use
int channel = _channelGroups[channelGroupId].currentIndex;
if (channel != CD_CHANNEL_GROUP_NON_INTERRUPTIBLE) {
if (_channelGroups[channelGroupId].startIndex != _channelGroups[channelGroupId].endIndex) {
_channelGroups[channelGroupId].currentIndex++;
if(_channelGroups[channelGroupId].currentIndex > _channelGroups[channelGroupId].endIndex) {
_channelGroups[channelGroupId].currentIndex = _channelGroups[channelGroupId].startIndex;
}
}
return [self _startSound:soundId channelId:channel pitchVal:pitch panVal:pan gainVal:gain looping:loop checkState:TRUE];
} else {
//Channel group is non interruptible therefore we must search for the first non playing channel/source if there are any
int checkingIndex = _channelGroups[channelGroupId].startIndex;
ALint state = 0;
while ((checkingIndex <= _channelGroups[channelGroupId].endIndex) && (channel == CD_CHANNEL_GROUP_NON_INTERRUPTIBLE)) {
//Check if source is playing
alGetSourcei(_sources[checkingIndex], AL_SOURCE_STATE, &state);
if (state != AL_PLAYING) {
channel = checkingIndex;
}
checkingIndex++;
}
if (channel != CD_CHANNEL_GROUP_NON_INTERRUPTIBLE) {
//Found a free channel
return [self _startSound:soundId channelId:channel pitchVal:pitch panVal:pan gainVal:gain looping:loop checkState:FALSE];
} else {
//Didn't find a free channel
return CD_NO_SOURCE;
}
}
}
- (ALuint)_startSound:(int) soundId channelId:(int) channelId pitchVal:(float) pitchVal panVal:(float) panVal gainVal:(float) gainVal looping:(BOOL) looping checkState:(BOOL) checkState
{
ALint state;
ALuint source = _sources[channelId];
ALuint buffer = _buffers[soundId];
alGetError();//Clear the error code
//If we are in interruptible mode then we check the state to see if the source
//is already playing and if so stop it. Otherwise in non interruptible mode
//we already know that the source is not playing.
if (checkState) {
alGetSourcei(source, AL_SOURCE_STATE, &state);
if (state == AL_PLAYING) {
alSourceStop(source);
}
}
alSourcei(source, AL_BUFFER, buffer);//Attach to sound
alSourcef(source, AL_PITCH, pitchVal);//Set pitch
alSourcei(source, AL_LOOPING, looping);//Set looping
alSourcef(source, AL_GAIN, gainVal);//Set gain/volume
float sourcePosAL[] = {panVal, 0.0f, 0.0f};//Set position - just using left and right panning
alSourcefv(source, AL_POSITION, sourcePosAL);
alSourcePlay(source);
if((lastErrorCode = alGetError()) == AL_NO_ERROR) {
//Everything was okay
_sourceBufferAttachments[channelId] = buffer;//Keep track of which buffer source is attached to as alGetSourcei on AL_BUFFER does not seem to work
return source;
} else {
//Something went wrong - set error code and return failure code
return CD_NO_SOURCE;
}
}
/**
* Stop all sounds playing within a channel group
*/
- (void) stopChannelGroup:(int) channelGroupId {
if (!functioning) {
return;
}
for (int i=_channelGroups[channelGroupId].startIndex; i <= _channelGroups[channelGroupId].endIndex; i++) {
alSourceStop(_sources[i]);
}
alGetError();//Clear error in case we stopped any sounds that couldn't be stopped
}
/**
* Stop a sound playing.
* @param sourceId an OpenAL source identifier i.e. the return value of playSound
*/
- (void)stopSound:(ALuint) sourceId {
if (!functioning) {
return;
}
alSourceStop(sourceId);
alGetError();//Clear error in case we stopped any sounds that couldn't be stopped
}
- (void) stopAllSounds {
for (int i=0; i < _channelTotal; i++) {
alSourceStop(_sources[i]);
}
alGetError();//Clear error in case we stopped any sounds that couldn't be stopped
}
/**
* Set a channel group as non interruptible. Default is that channel groups are interruptible.
* Non interruptible means that if a request to play a sound is made for a channel group and there are
* no free channels available then the play request will be ignored and CD_NO_SOURCE will be returned.
*/
- (void) setChannelGroupNonInterruptible:(int) channelGroupId isNonInterruptible:(BOOL) isNonInterruptible {
if (isNonInterruptible) {
_channelGroups[channelGroupId].currentIndex = CD_CHANNEL_GROUP_NON_INTERRUPTIBLE;
} else {
_channelGroups[channelGroupId].currentIndex = _channelGroups[channelGroupId].startIndex;
}
}
/**
* Set the mute property for a channel group. If mute is turned on any sounds in that channel group
* will be stopped and further sounds in that channel group will play. However, turning mute off
* will not restart any sounds that were playing when mute was turned on. Also the mute setting
* for the sound engine must be taken into account. If the sound engine is mute no sounds will play
* no matter what the channel group mute setting is.
*/
- (void) setChannelGroupMute:(int) channelGroupId mute:(BOOL) mute {
if (mute) {
_channelGroups[channelGroupId].mute = true;
[self stopChannelGroup:channelGroupId];
} else {
_channelGroups[channelGroupId].mute = false;
}
}
/**
* Return the mute property for the channel group identified by channelGroupId
*/
- (BOOL) channelGroupMute:(int) channelGroupId {
if (_channelGroups[channelGroupId].mute) {
return YES;
} else {
return NO;
}
}
-(ALCcontext *) openALContext {
return context;
}
//Code to handle audio session interruption. Thanks to Andy Fitter and Ben Britten.
-(void)audioSessionInterrupted
{
CDLOG(@"Denshion::CDSoundEngine - Audio session interrupted");
ALenum error = AL_NO_ERROR;
// Deactivate the current audio session
AudioSessionSetActive(NO);
// set the current context to NULL will 'shutdown' openAL
alcMakeContextCurrent(NULL);
if((error = alGetError()) != AL_NO_ERROR) {
CDLOG(@"Denshion::CDSoundEngine - Error making context current %x\n", error);
}
// now suspend your context to 'pause' your sound world
alcSuspendContext(context);
if((error = alGetError()) != AL_NO_ERROR) {
CDLOG(@"Denshion::CDSoundEngine - Error suspending context %x\n", error);
}
#pragma unused(error)
}
//Code to handle audio session resumption. Thanks to Andy Fitter and Ben Britten.
-(void)audioSessionResumed
{
ALenum error = AL_NO_ERROR;
CDLOG(@"Denshion::CDSoundEngine - Audio session resumed");
// Reset audio session
OSStatus result = AudioSessionSetProperty ( kAudioSessionProperty_AudioCategory, sizeof(_audioSessionCategory), &_audioSessionCategory );
// Reactivate the current audio session
result = AudioSessionSetActive(YES);
#pragma unused(result)
// Restore open al context
alcMakeContextCurrent(context);
if((error = alGetError()) != AL_NO_ERROR) {
CDLOG(@"Denshion::CDSoundEngine - Error making context current%x\n", error);
}
// 'unpause' my context
alcProcessContext(context);
if((error = alGetError()) != AL_NO_ERROR) {
CDLOG(@"Denshion::CDSoundEngine - Error processing context%x\n", error);
}
#pragma unused(error)
}
@end
///////////////////////////////////////////////////////////////////////////////////////
@implementation CDSourceWrapper
-(void) setSourceId:(ALuint) newSourceId {
if ((newSourceId != CD_NO_SOURCE) && (newSourceId != CD_MUTE)) {
sourceId = newSourceId;
} else {
CDLOG(@"Denshion::CDSourceWrapper - Attempt to assign CD_MUTE or CD_NO_SOURCE to a source wrapper");
}
}
- (ALuint) sourceId {
return sourceId;
}
- (void) setPitch:(float) newPitchValue {
lastPitch = newPitchValue;
alSourcef(sourceId, AL_PITCH, newPitchValue);
}
- (void) setGain:(float) newGainValue {
lastGain = newGainValue;
alSourcef(sourceId, AL_GAIN, newGainValue);
}
- (void) setPan:(float) newPanValue {
lastPan = newPanValue;
float sourcePosAL[] = {newPanValue, 0.0f, 0.0f};//Set position - just using left and right panning
alSourcefv(sourceId, AL_POSITION, sourcePosAL);
}
- (void) setLooping:(BOOL) newLoopingValue {
lastLooping = newLoopingValue;
alSourcei(sourceId, AL_LOOPING, newLoopingValue);
}
- (BOOL) isPlaying {
ALint state;
alGetSourcei(sourceId, AL_SOURCE_STATE, &state);
return (state == AL_PLAYING);
}
//alGetSource does not appear to work for pitch, pan and gain values
//So we just remember the last value set
- (float) pitch {
/*
//This does not work on simulator or device
ALfloat pitchVal;
alGetSourcef(sourceId, AL_PITCH, &pitchVal);
return pitchVal;
*/
return lastPitch;
}
- (float) pan {
return lastPan;
}
- (float) gain {
return lastGain;
}
- (BOOL) looping {
return lastLooping;
}
@end
////////////////////////////////////////////////////////////////////////////
@implementation CDAsynchBufferLoader
-(id) init:(NSArray *)loadRequests soundEngine:(CDSoundEngine *) theSoundEngine {
if ([super init] ) {
_loadRequests = loadRequests;
[_loadRequests retain];
_soundEngine = theSoundEngine;
[_soundEngine retain];
return self;
} else {
return nil;
}
}
-(void) main {
CDLOG(@"Denshion::CDAsynchBufferLoader - loading buffers");
[super main];
_soundEngine.asynchLoadProgress = 0.0f;
if ([_loadRequests count] > 0) {
float increment = 1.0f / [_loadRequests count];
//Iterate over load request and load
for (CDBufferLoadRequest *loadRequest in _loadRequests) {
[_soundEngine loadBuffer:loadRequest.soundId filePath:loadRequest.filePath];
_soundEngine.asynchLoadProgress += increment;
}
}
//Completed
_soundEngine.asynchLoadProgress = 1.0f;
}
-(void) dealloc {
[_loadRequests release];
[_soundEngine release];
[super dealloc];
}
@end
///////////////////////////////////////////////////////////////////////////////////////
@implementation CDBufferLoadRequest
@synthesize filePath, soundId;
-(id) init:(int) theSoundId filePath:(NSString *) theFilePath {
if ([super init]) {
soundId = theSoundId;
filePath = theFilePath;
[filePath retain];
return self;
} else {
return nil;
}
}
-(void) dealloc {
[filePath release];
[super dealloc];
}
@end