--- /dev/null
+/*
+ Copyright (c) 2010 Steve Oldmeadow
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+
+ $Id$
+ */
+
+#import "CocosDenshion.h"
+#if __IPHONE_OS_VERSION_MIN_REQUIRED >= 30000
+ #import <AVFoundation/AVFoundation.h>
+#else
+ #import "CDXMacOSXSupport.h"
+#endif
+
+/** Different modes of the engine */
+typedef enum {
+ kAMM_FxOnly, //!Other apps will be able to play audio
+ kAMM_FxPlusMusic, //!Only this app will play audio
+ kAMM_FxPlusMusicIfNoOtherAudio, //!If another app is playing audio at start up then allow it to continue and don't play music
+ kAMM_MediaPlayback, //!This app takes over audio e.g music player app
+ kAMM_PlayAndRecord //!App takes over audio and has input and output
+} tAudioManagerMode;
+
+/** Possible states of the engine */
+typedef enum {
+ kAMStateUninitialised, //!Audio manager has not been initialised - do not use
+ kAMStateInitialising, //!Audio manager is in the process of initialising - do not use
+ kAMStateInitialised //!Audio manager is initialised - safe to use
+} tAudioManagerState;
+
+typedef enum {
+ kAMRBDoNothing, //Audio manager will not do anything on resign or becoming active
+ kAMRBStopPlay, //Background music is stopped on resign and resumed on become active
+ kAMRBStop //Background music is stopped on resign but not resumed - maybe because you want to do this from within your game
+} tAudioManagerResignBehavior;
+
+/** Notifications */
+extern NSString * const kCDN_AudioManagerInitialised;
+
+@interface CDAsynchInitialiser : NSOperation {}
+@end
+
+/** CDAudioManager supports two long audio source channels called left and right*/
+typedef enum {
+ kASC_Left = 0,
+ kASC_Right = 1
+} tAudioSourceChannel;
+
+typedef enum {
+ kLAS_Init,
+ kLAS_Loaded,
+ kLAS_Playing,
+ kLAS_Paused,
+ kLAS_Stopped,
+} tLongAudioSourceState;
+
+@class CDLongAudioSource;
+@protocol CDLongAudioSourceDelegate <NSObject>
+@optional
+/** The audio source completed playing */
+- (void) cdAudioSourceDidFinishPlaying:(CDLongAudioSource *) audioSource;
+/** The file used to load the audio source has changed */
+- (void) cdAudioSourceFileDidChange:(CDLongAudioSource *) audioSource;
+@end
+
+/**
+ CDLongAudioSource represents an audio source that has a long duration which makes
+ it costly to load into memory for playback as an effect using CDSoundEngine. Examples
+ include background music and narration tracks. The audio file may or may not be compressed.
+ Bear in mind that current iDevices can only use hardware to decode a single compressed
+ audio file at a time and playing multiple compressed files will result in a performance drop
+ as software decompression will take place.
+ @since v0.99
+ */
+@interface CDLongAudioSource : NSObject <AVAudioPlayerDelegate, CDAudioInterruptProtocol>{
+ AVAudioPlayer *audioSourcePlayer;
+ NSString *audioSourceFilePath;
+ NSInteger numberOfLoops;
+ float volume;
+ id<CDLongAudioSourceDelegate> delegate;
+ BOOL mute;
+ BOOL enabled_;
+ BOOL backgroundMusic;
+@public
+ BOOL systemPaused;//Used for auto resign handling
+ NSTimeInterval systemPauseLocation;//Used for auto resign handling
+@protected
+ tLongAudioSourceState state;
+}
+@property (readonly) AVAudioPlayer *audioSourcePlayer;
+@property (readonly) NSString *audioSourceFilePath;
+@property (readwrite, nonatomic) NSInteger numberOfLoops;
+@property (readwrite, nonatomic) float volume;
+@property (assign) id<CDLongAudioSourceDelegate> delegate;
+/* This long audio source functions as background music */
+@property (readwrite, nonatomic) BOOL backgroundMusic;
+
+/** Loads the file into the audio source */
+-(void) load:(NSString*) filePath;
+/** Plays the audio source */
+-(void) play;
+/** Stops playing the audio soruce */
+-(void) stop;
+/** Pauses the audio source */
+-(void) pause;
+/** Rewinds the audio source */
+-(void) rewind;
+/** Resumes playing the audio source if it was paused */
+-(void) resume;
+/** Returns whether or not the audio source is playing */
+-(BOOL) isPlaying;
+
+@end
+
+/**
+ CDAudioManager manages audio requirements for a game. It provides access to a CDSoundEngine object
+ for playing sound effects. It provides access to two CDLongAudioSource object (left and right channel)
+ for playing long duration audio such as background music and narration tracks. Additionally it manages
+ the audio session to take care of things like audio session interruption and interacting with the audio
+ of other apps that are running on the device.
+
+ Requirements:
+ - Firmware: OS 2.2 or greater
+ - Files: CDAudioManager.*, CocosDenshion.*
+ - Frameworks: OpenAL, AudioToolbox, AVFoundation
+ @since v0.8
+ */
+@interface CDAudioManager : NSObject <CDLongAudioSourceDelegate, CDAudioInterruptProtocol, AVAudioSessionDelegate> {
+ CDSoundEngine *soundEngine;
+ CDLongAudioSource *backgroundMusic;
+ NSMutableArray *audioSourceChannels;
+ NSString* _audioSessionCategory;
+ BOOL _audioWasPlayingAtStartup;
+ tAudioManagerMode _mode;
+ SEL backgroundMusicCompletionSelector;
+ id backgroundMusicCompletionListener;
+ BOOL willPlayBackgroundMusic;
+ BOOL _mute;
+ BOOL _resigned;
+ BOOL _interrupted;
+ BOOL _audioSessionActive;
+ BOOL enabled_;
+
+ //For handling resign/become active
+ BOOL _isObservingAppEvents;
+ tAudioManagerResignBehavior _resignBehavior;
+}
+
+@property (readonly) CDSoundEngine *soundEngine;
+@property (readonly) CDLongAudioSource *backgroundMusic;
+@property (readonly) BOOL willPlayBackgroundMusic;
+
+/** Returns the shared singleton */
++ (CDAudioManager *) sharedManager;
++ (tAudioManagerState) sharedManagerState;
+/** Configures the shared singleton with a mode*/
++ (void) configure: (tAudioManagerMode) mode;
+/** Initializes the engine asynchronously with a mode */
++ (void) initAsynchronously: (tAudioManagerMode) mode;
+/** Initializes the engine synchronously with a mode, channel definition and a total number of channels */
+- (id) init: (tAudioManagerMode) mode;
+-(void) audioSessionInterrupted;
+-(void) audioSessionResumed;
+-(void) setResignBehavior:(tAudioManagerResignBehavior) resignBehavior autoHandle:(BOOL) autoHandle;
+/** Returns true is audio is muted at a hardware level e.g user has ringer switch set to off */
+-(BOOL) isDeviceMuted;
+/** Returns true if another app is playing audio such as the iPod music player */
+-(BOOL) isOtherAudioPlaying;
+/** Sets the way the audio manager interacts with the operating system such as whether it shares output with other apps or obeys the mute switch */
+-(void) setMode:(tAudioManagerMode) mode;
+/** Shuts down the shared audio manager instance so that it can be reinitialised */
++(void) end;
+
+/** Call if you want to use built in resign behavior but need to do some additional audio processing on resign active. */
+- (void) applicationWillResignActive;
+/** Call if you want to use built in resign behavior but need to do some additional audio processing on become active. */
+- (void) applicationDidBecomeActive;
+
+//New AVAudioPlayer API
+/** Loads the data from the specified file path to the channel's audio source */
+-(CDLongAudioSource*) audioSourceLoad:(NSString*) filePath channel:(tAudioSourceChannel) channel;
+/** Retrieves the audio source for the specified channel */
+-(CDLongAudioSource*) audioSourceForChannel:(tAudioSourceChannel) channel;
+
+//Legacy AVAudioPlayer API
+/** Plays music in background. The music can be looped or not
+ It is recommended to use .aac files as background music since they are decoded by the device (hardware).
+ */
+-(void) playBackgroundMusic:(NSString*) filePath loop:(BOOL) loop;
+/** Preloads a background music */
+-(void) preloadBackgroundMusic:(NSString*) filePath;
+/** Stops playing the background music */
+-(void) stopBackgroundMusic;
+/** Pauses the background music */
+-(void) pauseBackgroundMusic;
+/** Rewinds the background music */
+-(void) rewindBackgroundMusic;
+/** Resumes playing the background music */
+-(void) resumeBackgroundMusic;
+/** Returns whether or not the background music is playing */
+-(BOOL) isBackgroundMusicPlaying;
+
+-(void) setBackgroundMusicCompletionListener:(id) listener selector:(SEL) selector;
+
+@end
+
+/** Fader for long audio source objects */
+@interface CDLongAudioSourceFader : CDPropertyModifier{}
+@end
+
+static const int kCDNoBuffer = -1;
+
+/** Allows buffers to be associated with file names */
+@interface CDBufferManager:NSObject{
+ NSMutableDictionary* loadedBuffers;
+ NSMutableArray *freedBuffers;
+ CDSoundEngine *soundEngine;
+ int nextBufferId;
+}
+
+-(id) initWithEngine:(CDSoundEngine *) theSoundEngine;
+-(int) bufferForFile:(NSString*) filePath create:(BOOL) create;
+-(void) releaseBufferForFile:(NSString *) filePath;
+
+@end
+
--- /dev/null
+/*
+ Copyright (c) 2010 Steve Oldmeadow
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+
+ $Id$
+ */
+
+
+#import "CDAudioManager.h"
+
+NSString * const kCDN_AudioManagerInitialised = @"kCDN_AudioManagerInitialised";
+
+//NSOperation object used to asynchronously initialise
+@implementation CDAsynchInitialiser
+
+-(void) main {
+ [super main];
+ [CDAudioManager sharedManager];
+}
+
+@end
+
+@implementation CDLongAudioSource
+
+@synthesize audioSourcePlayer, audioSourceFilePath, delegate, backgroundMusic;
+
+-(id) init {
+ if ((self = [super init])) {
+ state = kLAS_Init;
+ volume = 1.0f;
+ mute = NO;
+ enabled_ = YES;
+ }
+ return self;
+}
+
+-(void) dealloc {
+ CDLOGINFO(@"Denshion::CDLongAudioSource - deallocating %@", self);
+ [audioSourcePlayer release];
+ [audioSourceFilePath release];
+ [super dealloc];
+}
+
+-(void) load:(NSString*) filePath {
+ //We have alread loaded a file previously, check if we are being asked to load the same file
+ if (state == kLAS_Init || ![filePath isEqualToString:audioSourceFilePath]) {
+ CDLOGINFO(@"Denshion::CDLongAudioSource - Loading new audio source %@",filePath);
+ //New file
+ if (state != kLAS_Init) {
+ [audioSourceFilePath release];//Release old file path
+ [audioSourcePlayer release];//Release old AVAudioPlayer, they can't be reused
+ }
+ audioSourceFilePath = [filePath copy];
+ NSError *error = nil;
+ NSString *path = [CDUtilities fullPathFromRelativePath:audioSourceFilePath];
+ audioSourcePlayer = [(AVAudioPlayer*)[AVAudioPlayer alloc] initWithContentsOfURL:[NSURL fileURLWithPath:path] error:&error];
+ if (error == nil) {
+ [audioSourcePlayer prepareToPlay];
+ audioSourcePlayer.delegate = self;
+ if (delegate && [delegate respondsToSelector:@selector(cdAudioSourceFileDidChange:)]) {
+ //Tell our delegate the file has changed
+ [delegate cdAudioSourceFileDidChange:self];
+ }
+ } else {
+ CDLOG(@"Denshion::CDLongAudioSource - Error initialising audio player: %@",error);
+ }
+ } else {
+ //Same file - just return it to a consistent state
+ [self pause];
+ [self rewind];
+ }
+ audioSourcePlayer.volume = volume;
+ audioSourcePlayer.numberOfLoops = numberOfLoops;
+ state = kLAS_Loaded;
+}
+
+-(void) play {
+ if (enabled_) {
+ self->systemPaused = NO;
+ [audioSourcePlayer play];
+ } else {
+ CDLOGINFO(@"Denshion::CDLongAudioSource long audio source didn't play because it is disabled");
+ }
+}
+
+-(void) stop {
+ [audioSourcePlayer stop];
+}
+
+-(void) pause {
+ [audioSourcePlayer pause];
+}
+
+-(void) rewind {
+ [audioSourcePlayer setCurrentTime:0];
+}
+
+-(void) resume {
+ [audioSourcePlayer play];
+}
+
+-(BOOL) isPlaying {
+ if (state != kLAS_Init) {
+ return [audioSourcePlayer isPlaying];
+ } else {
+ return NO;
+ }
+}
+
+-(void) setVolume:(float) newVolume
+{
+ volume = newVolume;
+ if (state != kLAS_Init && !mute) {
+ audioSourcePlayer.volume = newVolume;
+ }
+}
+
+-(float) volume
+{
+ return volume;
+}
+
+#pragma mark Audio Interrupt Protocol
+-(BOOL) mute
+{
+ return mute;
+}
+
+-(void) setMute:(BOOL) muteValue
+{
+ if (mute != muteValue) {
+ if (mute) {
+ //Turn sound back on
+ audioSourcePlayer.volume = volume;
+ } else {
+ audioSourcePlayer.volume = 0.0f;
+ }
+ mute = muteValue;
+ }
+}
+
+-(BOOL) enabled
+{
+ return enabled_;
+}
+
+-(void) setEnabled:(BOOL)enabledValue
+{
+ if (enabledValue != enabled_) {
+ enabled_ = enabledValue;
+ if (!enabled_) {
+ //"Stop" the sounds
+ [self pause];
+ [self rewind];
+ }
+ }
+}
+
+-(NSInteger) numberOfLoops {
+ return numberOfLoops;
+}
+
+-(void) setNumberOfLoops:(NSInteger) loopCount
+{
+ audioSourcePlayer.numberOfLoops = loopCount;
+ numberOfLoops = loopCount;
+}
+
+- (void)audioPlayerDidFinishPlaying:(AVAudioPlayer *)player successfully:(BOOL)flag {
+ CDLOGINFO(@"Denshion::CDLongAudioSource - audio player finished");
+#if TARGET_IPHONE_SIMULATOR
+ CDLOGINFO(@"Denshion::CDLongAudioSource - workaround for OpenAL clobbered audio issue");
+ //This is a workaround for an issue in all simulators (tested to 3.1.2). Problem is
+ //that OpenAL audio playback is clobbered when an AVAudioPlayer stops. Workaround
+ //is to keep the player playing on an endless loop with 0 volume and then when
+ //it is played again reset the volume and set loop count appropriately.
+ //NB: this workaround is not foolproof but it is good enough for most situations.
+ player.numberOfLoops = -1;
+ player.volume = 0;
+ [player play];
+#endif
+ if (delegate && [delegate respondsToSelector:@selector(cdAudioSourceDidFinishPlaying:)]) {
+ [delegate cdAudioSourceDidFinishPlaying:self];
+ }
+}
+
+-(void)audioPlayerBeginInterruption:(AVAudioPlayer *)player {
+ CDLOGINFO(@"Denshion::CDLongAudioSource - audio player interrupted");
+}
+
+-(void)audioPlayerEndInterruption:(AVAudioPlayer *)player {
+ CDLOGINFO(@"Denshion::CDLongAudioSource - audio player resumed");
+ if (self.backgroundMusic) {
+ //Check if background music can play as rules may have changed during
+ //the interruption. This is to address a specific issue in 4.x when
+ //fast task switching
+ if([CDAudioManager sharedManager].willPlayBackgroundMusic) {
+ [player play];
+ }
+ } else {
+ [player play];
+ }
+}
+
+@end
+
+
+@interface CDAudioManager (PrivateMethods)
+-(BOOL) audioSessionSetActive:(BOOL) active;
+-(BOOL) audioSessionSetCategory:(NSString*) category;
+-(void) badAlContextHandler;
+@end
+
+
+@implementation CDAudioManager
+#define BACKGROUND_MUSIC_CHANNEL kASC_Left
+
+@synthesize soundEngine, willPlayBackgroundMusic;
+static CDAudioManager *sharedManager;
+static tAudioManagerState _sharedManagerState = kAMStateUninitialised;
+static tAudioManagerMode configuredMode;
+static BOOL configured = FALSE;
+
+-(BOOL) audioSessionSetActive:(BOOL) active {
+ NSError *activationError = nil;
+ if ([[AVAudioSession sharedInstance] setActive:active error:&activationError]) {
+ _audioSessionActive = active;
+ CDLOGINFO(@"Denshion::CDAudioManager - Audio session set active %i succeeded", active);
+ return YES;
+ } else {
+ //Failed
+ CDLOG(@"Denshion::CDAudioManager - Audio session set active %i failed with error %@", active, activationError);
+ return NO;
+ }
+}
+
+-(BOOL) audioSessionSetCategory:(NSString*) category {
+ NSError *categoryError = nil;
+ if ([[AVAudioSession sharedInstance] setCategory:category error:&categoryError]) {
+ CDLOGINFO(@"Denshion::CDAudioManager - Audio session set category %@ succeeded", category);
+ return YES;
+ } else {
+ //Failed
+ CDLOG(@"Denshion::CDAudioManager - Audio session set category %@ failed with error %@", category, categoryError);
+ return NO;
+ }
+}
+
+// Init
++ (CDAudioManager *) sharedManager
+{
+ @synchronized(self) {
+ if (!sharedManager) {
+ if (!configured) {
+ //Set defaults here
+ configuredMode = kAMM_FxPlusMusicIfNoOtherAudio;
+ }
+ sharedManager = [[CDAudioManager alloc] init:configuredMode];
+ _sharedManagerState = kAMStateInitialised;//This is only really relevant when using asynchronous initialisation
+ [[NSNotificationCenter defaultCenter] postNotificationName:kCDN_AudioManagerInitialised object:nil];
+ }
+ }
+ return sharedManager;
+}
+
++ (tAudioManagerState) sharedManagerState {
+ return _sharedManagerState;
+}
+
+/**
+ * Call this to set up audio manager asynchronously. Initialisation is finished when sharedManagerState == kAMStateInitialised
+ */
++ (void) initAsynchronously: (tAudioManagerMode) mode {
+ @synchronized(self) {
+ if (_sharedManagerState == kAMStateUninitialised) {
+ _sharedManagerState = kAMStateInitialising;
+ [CDAudioManager configure:mode];
+ CDAsynchInitialiser *initOp = [[[CDAsynchInitialiser alloc] init] autorelease];
+ NSOperationQueue *opQ = [[[NSOperationQueue alloc] init] autorelease];
+ [opQ addOperation:initOp];
+ }
+ }
+}
+
++ (id) alloc
+{
+ @synchronized(self) {
+ NSAssert(sharedManager == nil, @"Attempted to allocate a second instance of a singleton.");
+ return [super alloc];
+ }
+ return nil;
+}
+
+/*
+ * Call this method before accessing the shared manager in order to configure the shared audio manager
+ */
++ (void) configure: (tAudioManagerMode) mode {
+ configuredMode = mode;
+ configured = TRUE;
+}
+
+-(BOOL) isOtherAudioPlaying {
+ UInt32 isPlaying = 0;
+ UInt32 varSize = sizeof(isPlaying);
+ AudioSessionGetProperty (kAudioSessionProperty_OtherAudioIsPlaying, &varSize, &isPlaying);
+ return (isPlaying != 0);
+}
+
+-(void) setMode:(tAudioManagerMode) mode {
+
+ _mode = mode;
+ switch (_mode) {
+
+ case kAMM_FxOnly:
+ //Share audio with other app
+ CDLOGINFO(@"Denshion::CDAudioManager - Audio will be shared");
+ //_audioSessionCategory = kAudioSessionCategory_AmbientSound;
+ _audioSessionCategory = AVAudioSessionCategoryAmbient;
+ willPlayBackgroundMusic = NO;
+ break;
+
+ case kAMM_FxPlusMusic:
+ //Use audio exclusively - if other audio is playing it will be stopped
+ CDLOGINFO(@"Denshion::CDAudioManager - Audio will be exclusive");
+ //_audioSessionCategory = kAudioSessionCategory_SoloAmbientSound;
+ _audioSessionCategory = AVAudioSessionCategorySoloAmbient;
+ willPlayBackgroundMusic = YES;
+ break;
+
+ case kAMM_MediaPlayback:
+ //Use audio exclusively, ignore mute switch and sleep
+ CDLOGINFO(@"Denshion::CDAudioManager - Media playback mode, audio will be exclusive");
+ //_audioSessionCategory = kAudioSessionCategory_MediaPlayback;
+ _audioSessionCategory = AVAudioSessionCategoryPlayback;
+ willPlayBackgroundMusic = YES;
+ break;
+
+ case kAMM_PlayAndRecord:
+ //Use audio exclusively, ignore mute switch and sleep, has inputs and outputs
+ CDLOGINFO(@"Denshion::CDAudioManager - Play and record mode, audio will be exclusive");
+ //_audioSessionCategory = kAudioSessionCategory_PlayAndRecord;
+ _audioSessionCategory = AVAudioSessionCategoryPlayAndRecord;
+ willPlayBackgroundMusic = YES;
+ break;
+
+ default:
+ //kAudioManagerFxPlusMusicIfNoOtherAudio
+ if ([self isOtherAudioPlaying]) {
+ CDLOGINFO(@"Denshion::CDAudioManager - Other audio is playing audio will be shared");
+ //_audioSessionCategory = kAudioSessionCategory_AmbientSound;
+ _audioSessionCategory = AVAudioSessionCategoryAmbient;
+ willPlayBackgroundMusic = NO;
+ } else {
+ CDLOGINFO(@"Denshion::CDAudioManager - Other audio is not playing audio will be exclusive");
+ //_audioSessionCategory = kAudioSessionCategory_SoloAmbientSound;
+ _audioSessionCategory = AVAudioSessionCategorySoloAmbient;
+ willPlayBackgroundMusic = YES;
+ }
+
+ break;
+ }
+
+ [self audioSessionSetCategory:_audioSessionCategory];
+
+}
+
+/**
+ * This method is used to work around various bugs introduced in 4.x OS versions. In some circumstances the
+ * audio session is interrupted but never resumed, this results in the loss of OpenAL audio when following
+ * standard practices. If we detect this situation then we will attempt to resume the audio session ourselves.
+ * Known triggers: lock the device then unlock it (iOS 4.2 gm), playback a song using MPMediaPlayer (iOS 4.0)
+ */
+- (void) badAlContextHandler {
+ if (_interrupted && alcGetCurrentContext() == NULL) {
+ CDLOG(@"Denshion::CDAudioManager - bad OpenAL context detected, attempting to resume audio session");
+ [self audioSessionResumed];
+ }
+}
+
+- (id) init: (tAudioManagerMode) mode {
+ if ((self = [super init])) {
+
+ //Initialise the audio session
+ AVAudioSession* session = [AVAudioSession sharedInstance];
+ session.delegate = self;
+
+ _mode = mode;
+ backgroundMusicCompletionSelector = nil;
+ _isObservingAppEvents = FALSE;
+ _mute = NO;
+ _resigned = NO;
+ _interrupted = NO;
+ enabled_ = YES;
+ _audioSessionActive = NO;
+ [self setMode:mode];
+ soundEngine = [[CDSoundEngine alloc] init];
+
+ //Set up audioSource channels
+ audioSourceChannels = [[NSMutableArray alloc] init];
+ CDLongAudioSource *leftChannel = [[CDLongAudioSource alloc] init];
+ leftChannel.backgroundMusic = YES;
+ CDLongAudioSource *rightChannel = [[CDLongAudioSource alloc] init];
+ rightChannel.backgroundMusic = NO;
+ [audioSourceChannels insertObject:leftChannel atIndex:kASC_Left];
+ [audioSourceChannels insertObject:rightChannel atIndex:kASC_Right];
+ [leftChannel release];
+ [rightChannel release];
+ //Used to support legacy APIs
+ backgroundMusic = [self audioSourceForChannel:BACKGROUND_MUSIC_CHANNEL];
+ backgroundMusic.delegate = self;
+
+ //Add handler for bad al context messages, these are posted by the sound engine.
+ [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(badAlContextHandler) name:kCDN_BadAlContext object:nil];
+
+ }
+ return self;
+}
+
+-(void) dealloc {
+ CDLOGINFO(@"Denshion::CDAudioManager - deallocating");
+ [self stopBackgroundMusic];
+ [soundEngine release];
+ [[NSNotificationCenter defaultCenter] removeObserver:self];
+ [self audioSessionSetActive:NO];
+ [audioSourceChannels release];
+ [super dealloc];
+}
+
+/** Retrieves the audio source for the specified channel */
+-(CDLongAudioSource*) audioSourceForChannel:(tAudioSourceChannel) channel
+{
+ return (CDLongAudioSource*)[audioSourceChannels objectAtIndex:channel];
+}
+
+/** Loads the data from the specified file path to the channel's audio source */
+-(CDLongAudioSource*) audioSourceLoad:(NSString*) filePath channel:(tAudioSourceChannel) channel
+{
+ CDLongAudioSource *audioSource = [self audioSourceForChannel:channel];
+ if (audioSource) {
+ [audioSource load:filePath];
+ }
+ return audioSource;
+}
+
+-(BOOL) isBackgroundMusicPlaying {
+ return [self.backgroundMusic isPlaying];
+}
+
+//NB: originally I tried using a route change listener and intended to store the current route,
+//however, on a 3gs running 3.1.2 no route change is generated when the user switches the
+//ringer mute switch to off (i.e. enables sound) therefore polling is the only reliable way to
+//determine ringer switch state
+-(BOOL) isDeviceMuted {
+
+#if TARGET_IPHONE_SIMULATOR
+ //Calling audio route stuff on the simulator causes problems
+ return NO;
+#else
+ CFStringRef newAudioRoute;
+ UInt32 propertySize = sizeof (CFStringRef);
+
+ AudioSessionGetProperty (
+ kAudioSessionProperty_AudioRoute,
+ &propertySize,
+ &newAudioRoute
+ );
+
+ if (newAudioRoute == NULL) {
+ //Don't expect this to happen but playing safe otherwise a null in the CFStringCompare will cause a crash
+ return YES;
+ } else {
+ CFComparisonResult newDeviceIsMuted = CFStringCompare (
+ newAudioRoute,
+ (CFStringRef) @"",
+ 0
+ );
+
+ return (newDeviceIsMuted == kCFCompareEqualTo);
+ }
+#endif
+}
+
+#pragma mark Audio Interrupt Protocol
+
+-(BOOL) mute {
+ return _mute;
+}
+
+-(void) setMute:(BOOL) muteValue {
+ if (muteValue != _mute) {
+ _mute = muteValue;
+ [soundEngine setMute:muteValue];
+ for( CDLongAudioSource *audioSource in audioSourceChannels) {
+ audioSource.mute = muteValue;
+ }
+ }
+}
+
+-(BOOL) enabled {
+ return enabled_;
+}
+
+-(void) setEnabled:(BOOL) enabledValue {
+ if (enabledValue != enabled_) {
+ enabled_ = enabledValue;
+ [soundEngine setEnabled:enabled_];
+ for( CDLongAudioSource *audioSource in audioSourceChannels) {
+ audioSource.enabled = enabled_;
+ }
+ }
+}
+
+-(CDLongAudioSource*) backgroundMusic
+{
+ return backgroundMusic;
+}
+
+//Load background music ready for playing
+-(void) preloadBackgroundMusic:(NSString*) filePath
+{
+ [self.backgroundMusic load:filePath];
+}
+
+-(void) playBackgroundMusic:(NSString*) filePath loop:(BOOL) loop
+{
+ [self.backgroundMusic load:filePath];
+
+ if (!willPlayBackgroundMusic || _mute) {
+ CDLOGINFO(@"Denshion::CDAudioManager - play bgm aborted because audio is not exclusive or sound is muted");
+ return;
+ }
+
+ if (loop) {
+ [self.backgroundMusic setNumberOfLoops:-1];
+ } else {
+ [self.backgroundMusic setNumberOfLoops:0];
+ }
+ [self.backgroundMusic play];
+}
+
+-(void) stopBackgroundMusic
+{
+ [self.backgroundMusic stop];
+}
+
+-(void) pauseBackgroundMusic
+{
+ [self.backgroundMusic pause];
+}
+
+-(void) resumeBackgroundMusic
+{
+ if (!willPlayBackgroundMusic || _mute) {
+ CDLOGINFO(@"Denshion::CDAudioManager - resume bgm aborted because audio is not exclusive or sound is muted");
+ return;
+ }
+
+ [self.backgroundMusic resume];
+}
+
+-(void) rewindBackgroundMusic
+{
+ [self.backgroundMusic rewind];
+}
+
+-(void) setBackgroundMusicCompletionListener:(id) listener selector:(SEL) selector {
+ backgroundMusicCompletionListener = listener;
+ backgroundMusicCompletionSelector = selector;
+}
+
+/*
+ * Call this method to have the audio manager automatically handle application resign and
+ * become active. Pass a tAudioManagerResignBehavior to indicate the desired behavior
+ * for resigning and becoming active again.
+ *
+ * If autohandle is YES then the applicationWillResignActive and applicationDidBecomActive
+ * methods are automatically called, otherwise you must call them yourself at the appropriate time.
+ *
+ * Based on idea of Dominique Bongard
+ */
+-(void) setResignBehavior:(tAudioManagerResignBehavior) resignBehavior autoHandle:(BOOL) autoHandle {
+
+ if (!_isObservingAppEvents && autoHandle) {
+ [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(applicationWillResignActive:) name:@"UIApplicationWillResignActiveNotification" object:nil];
+ [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(applicationDidBecomeActive:) name:@"UIApplicationDidBecomeActiveNotification" object:nil];
+ [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(applicationWillTerminate:) name:@"UIApplicationWillTerminateNotification" object:nil];
+ _isObservingAppEvents = TRUE;
+ }
+ _resignBehavior = resignBehavior;
+}
+
+- (void) applicationWillResignActive {
+ self->_resigned = YES;
+
+ //Set the audio sesssion to one that allows sharing so that other audio won't be clobbered on resume
+ [self audioSessionSetCategory:AVAudioSessionCategoryAmbient];
+
+ switch (_resignBehavior) {
+
+ case kAMRBStopPlay:
+
+ for( CDLongAudioSource *audioSource in audioSourceChannels) {
+ if (audioSource.isPlaying) {
+ audioSource->systemPaused = YES;
+ audioSource->systemPauseLocation = audioSource.audioSourcePlayer.currentTime;
+ [audioSource stop];
+ } else {
+ //Music is either paused or stopped, if it is paused it will be restarted
+ //by OS so we will stop it.
+ audioSource->systemPaused = NO;
+ [audioSource stop];
+ }
+ }
+ break;
+
+ case kAMRBStop:
+ //Stop music regardless of whether it is playing or not because if it was paused
+ //then the OS would resume it
+ for( CDLongAudioSource *audioSource in audioSourceChannels) {
+ [audioSource stop];
+ }
+
+ default:
+ break;
+
+ }
+ CDLOGINFO(@"Denshion::CDAudioManager - handled resign active");
+}
+
+//Called when application resigns active only if setResignBehavior has been called
+- (void) applicationWillResignActive:(NSNotification *) notification
+{
+ [self applicationWillResignActive];
+}
+
+- (void) applicationDidBecomeActive {
+
+ if (self->_resigned) {
+ _resigned = NO;
+ //Reset the mode incase something changed with audio while we were inactive
+ [self setMode:_mode];
+ switch (_resignBehavior) {
+
+ case kAMRBStopPlay:
+
+ //Music had been stopped but stop maintains current time
+ //so playing again will continue from where music was before resign active.
+ //We check if music can be played because while we were inactive the user might have
+ //done something that should force music to not play such as starting a track in the iPod
+ if (self.willPlayBackgroundMusic) {
+ for( CDLongAudioSource *audioSource in audioSourceChannels) {
+ if (audioSource->systemPaused) {
+ [audioSource resume];
+ audioSource->systemPaused = NO;
+ }
+ }
+ }
+ break;
+
+ default:
+ break;
+
+ }
+ CDLOGINFO(@"Denshion::CDAudioManager - audio manager handled become active");
+ }
+}
+
+//Called when application becomes active only if setResignBehavior has been called
+- (void) applicationDidBecomeActive:(NSNotification *) notification
+{
+ [self applicationDidBecomeActive];
+}
+
+//Called when application terminates only if setResignBehavior has been called
+- (void) applicationWillTerminate:(NSNotification *) notification
+{
+ CDLOGINFO(@"Denshion::CDAudioManager - audio manager handling terminate");
+ [self stopBackgroundMusic];
+}
+
+/** The audio source completed playing */
+- (void) cdAudioSourceDidFinishPlaying:(CDLongAudioSource *) audioSource {
+ CDLOGINFO(@"Denshion::CDAudioManager - audio manager got told background music finished");
+ if (backgroundMusicCompletionSelector != nil) {
+ [backgroundMusicCompletionListener performSelector:backgroundMusicCompletionSelector];
+ }
+}
+
+-(void) beginInterruption {
+ CDLOGINFO(@"Denshion::CDAudioManager - begin interruption");
+ [self audioSessionInterrupted];
+}
+
+-(void) endInterruption {
+ CDLOGINFO(@"Denshion::CDAudioManager - end interruption");
+ [self audioSessionResumed];
+}
+
+#if __IPHONE_OS_VERSION_MAX_ALLOWED >= 40000
+-(void) endInterruptionWithFlags:(NSUInteger)flags {
+ CDLOGINFO(@"Denshion::CDAudioManager - interruption ended with flags %i",flags);
+ if (flags == AVAudioSessionInterruptionFlags_ShouldResume) {
+ [self audioSessionResumed];
+ }
+}
+#endif
+
+-(void)audioSessionInterrupted
+{
+ if (!_interrupted) {
+ CDLOGINFO(@"Denshion::CDAudioManager - Audio session interrupted");
+ _interrupted = YES;
+
+ // Deactivate the current audio session
+ [self audioSessionSetActive:NO];
+
+ if (alcGetCurrentContext() != NULL) {
+ CDLOGINFO(@"Denshion::CDAudioManager - Setting OpenAL context to NULL");
+
+ ALenum error = AL_NO_ERROR;
+
+ // set the current context to NULL will 'shutdown' openAL
+ alcMakeContextCurrent(NULL);
+
+ if((error = alGetError()) != AL_NO_ERROR) {
+ CDLOG(@"Denshion::CDAudioManager - Error making context current %x\n", error);
+ }
+ #pragma unused(error)
+ }
+ }
+}
+
+-(void)audioSessionResumed
+{
+ if (_interrupted) {
+ CDLOGINFO(@"Denshion::CDAudioManager - Audio session resumed");
+ _interrupted = NO;
+
+ BOOL activationResult = NO;
+ // Reactivate the current audio session
+ activationResult = [self audioSessionSetActive:YES];
+
+ //This code is to handle a problem with iOS 4.0 and 4.01 where reactivating the session can fail if
+ //task switching is performed too rapidly. A test case that reliably reproduces the issue is to call the
+ //iPhone and then hang up after two rings (timing may vary ;))
+ //Basically we keep waiting and trying to let the OS catch up with itself but the number of tries is
+ //limited.
+ if (!activationResult) {
+ CDLOG(@"Denshion::CDAudioManager - Failure reactivating audio session, will try wait-try cycle");
+ int activateCount = 0;
+ while (!activationResult && activateCount < 10) {
+ [NSThread sleepForTimeInterval:0.5];
+ activationResult = [self audioSessionSetActive:YES];
+ activateCount++;
+ CDLOGINFO(@"Denshion::CDAudioManager - Reactivation attempt %i status = %i",activateCount,activationResult);
+ }
+ }
+
+ if (alcGetCurrentContext() == NULL) {
+ CDLOGINFO(@"Denshion::CDAudioManager - Restoring OpenAL context");
+ ALenum error = AL_NO_ERROR;
+ // Restore open al context
+ alcMakeContextCurrent([soundEngine openALContext]);
+ if((error = alGetError()) != AL_NO_ERROR) {
+ CDLOG(@"Denshion::CDAudioManager - Error making context current%x\n", error);
+ }
+ #pragma unused(error)
+ }
+ }
+}
+
++(void) end {
+ [sharedManager release];
+ sharedManager = nil;
+}
+
+@end
+
+///////////////////////////////////////////////////////////////////////////////////////
+@implementation CDLongAudioSourceFader
+
+-(void) _setTargetProperty:(float) newVal {
+ ((CDLongAudioSource*)target).volume = newVal;
+}
+
+-(float) _getTargetProperty {
+ return ((CDLongAudioSource*)target).volume;
+}
+
+-(void) _stopTarget {
+ //Pause instead of stop as stop releases resources and causes problems in the simulator
+ [((CDLongAudioSource*)target) pause];
+}
+
+-(Class) _allowableType {
+ return [CDLongAudioSource class];
+}
+
+@end
+///////////////////////////////////////////////////////////////////////////////////////
+@implementation CDBufferManager
+
+-(id) initWithEngine:(CDSoundEngine *) theSoundEngine {
+ if ((self = [super init])) {
+ soundEngine = theSoundEngine;
+ loadedBuffers = [[NSMutableDictionary alloc] initWithCapacity:CD_BUFFERS_START];
+ freedBuffers = [[NSMutableArray alloc] init];
+ nextBufferId = 0;
+ }
+ return self;
+}
+
+-(void) dealloc {
+ [loadedBuffers release];
+ [freedBuffers release];
+ [super dealloc];
+}
+
+-(int) bufferForFile:(NSString*) filePath create:(BOOL) create {
+
+ NSNumber* soundId = (NSNumber*)[loadedBuffers objectForKey:filePath];
+ if(soundId == nil)
+ {
+ if (create) {
+ NSNumber* bufferId = nil;
+ //First try to get a buffer from the free buffers
+ if ([freedBuffers count] > 0) {
+ bufferId = [[[freedBuffers lastObject] retain] autorelease];
+ [freedBuffers removeLastObject];
+ CDLOGINFO(@"Denshion::CDBufferManager reusing buffer id %i",[bufferId intValue]);
+ } else {
+ bufferId = [[NSNumber alloc] initWithInt:nextBufferId];
+ [bufferId autorelease];
+ CDLOGINFO(@"Denshion::CDBufferManager generating new buffer id %i",[bufferId intValue]);
+ nextBufferId++;
+ }
+
+ if ([soundEngine loadBuffer:[bufferId intValue] filePath:filePath]) {
+ //File successfully loaded
+ CDLOGINFO(@"Denshion::CDBufferManager buffer loaded %@ %@",bufferId,filePath);
+ [loadedBuffers setObject:bufferId forKey:filePath];
+ return [bufferId intValue];
+ } else {
+ //File didn't load, put buffer id on free list
+ [freedBuffers addObject:bufferId];
+ return kCDNoBuffer;
+ }
+ } else {
+ //No matching buffer was found
+ return kCDNoBuffer;
+ }
+ } else {
+ return [soundId intValue];
+ }
+}
+
+-(void) releaseBufferForFile:(NSString *) filePath {
+ int bufferId = [self bufferForFile:filePath create:NO];
+ if (bufferId != kCDNoBuffer) {
+ [soundEngine unloadBuffer:bufferId];
+ [loadedBuffers removeObjectForKey:filePath];
+ NSNumber *freedBufferId = [[NSNumber alloc] initWithInt:bufferId];
+ [freedBufferId autorelease];
+ [freedBuffers addObject:freedBufferId];
+ }
+}
+@end
+
+
+
--- /dev/null
+/*
+ Copyright (c) 2010 Steve Oldmeadow
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+
+ $Id$
+ */
+#define COCOSDENSHION_VERSION "Aphex.rc"
+
+
+/**
+ If enabled code useful for debugging such as parameter check assertions will be performed.
+ If you experience any problems you should enable this and test your code with a debug build.
+ */
+//#define CD_DEBUG 1
+
+/**
+ The total number of sounds/buffers that can be loaded assuming memory is sufficient
+ */
+//Number of buffers slots that will be initially created
+#define CD_BUFFERS_START 64
+//Number of buffers that will be added
+#define CD_BUFFERS_INCREMENT 16
+
+/**
+ If enabled, OpenAL code will use static buffers. When static buffers are used the audio
+ data is managed outside of OpenAL, this eliminates a memcpy operation which leads to
+ higher performance when loading sounds.
+
+ However, the downside is that when the audio data is freed you must
+ be certain that it is no longer being accessed otherwise your app will crash. Testing on OS 2.2.1
+ and 3.1.2 has shown that this may occur if a buffer is being used by a source with state = AL_PLAYING
+ when the buffer is deleted. If the data is freed too quickly after the source is stopped then
+ a crash will occur. The implemented workaround is that when static buffers are used the unloadBuffer code will wait for
+ any playing sources to finish playing before the associated buffer and data are deleted, however, this delay may negate any
+ performance gains that are achieved during loading.
+
+ Performance tests on a 1st gen iPod running OS 2.2.1 loading the CocosDenshionDemo sounds were ~0.14 seconds without
+ static buffers and ~0.12 seconds when using static buffers.
+
+ */
+//#define CD_USE_STATIC_BUFFERS 1
+
+
--- /dev/null
+/*
+
+ Disclaimer: IMPORTANT: This Apple software is supplied to you by
+ Apple Inc. ("Apple") in consideration of your agreement to the
+ following terms, and your use, installation, modification or
+ redistribution of this Apple software constitutes acceptance of these
+ terms. If you do not agree with these terms, please do not use,
+ install, modify or redistribute this Apple software.
+
+ In consideration of your agreement to abide by the following terms, and
+ subject to these terms, Apple grants you a personal, non-exclusive
+ license, under Apple's copyrights in this original Apple software (the
+ "Apple Software"), to use, reproduce, modify and redistribute the Apple
+ Software, with or without modifications, in source and/or binary forms;
+ provided that if you redistribute the Apple Software in its entirety and
+ without modifications, you must retain this notice and the following
+ text and disclaimers in all such redistributions of the Apple Software.
+ Neither the name, trademarks, service marks or logos of Apple Inc.
+ may be used to endorse or promote products derived from the Apple
+ Software without specific prior written permission from Apple. Except
+ as expressly stated in this notice, no other rights or licenses, express
+ or implied, are granted by Apple herein, including but not limited to
+ any patent rights that may be infringed by your derivative works or by
+ other works in which the Apple Software may be incorporated.
+
+ The Apple Software is provided by Apple on an "AS IS" basis. APPLE
+ MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
+ THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
+ FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
+ OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
+
+ IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
+ OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
+ MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
+ AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
+ STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGE.
+
+ Copyright (C) 2009 Apple Inc. All Rights Reserved.
+
+ $Id$
+ */
+
+/*
+ This file contains code from version 1.1 and 1.4 of MyOpenALSupport.h taken from Apple's oalTouch version.
+ The 1.4 version code is used for loading IMA4 files, however, this code causes very noticeable clicking
+ when used to load wave files that are looped so the 1.1 version code is used specifically for loading
+ wav files.
+ */
+
+#ifndef __CD_OPENAL_H
+#define __CD_OPENAL_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+#import <OpenAL/al.h>
+#import <OpenAL/alc.h>
+#import <CoreFoundation/CFURL.h>
+
+
+//Taken from oalTouch MyOpenALSupport 1.1
+void* CDloadWaveAudioData(CFURLRef inFileURL, ALsizei *outDataSize, ALenum *outDataFormat, ALsizei* outSampleRate);
+void* CDloadCafAudioData(CFURLRef inFileURL, ALsizei *outDataSize, ALenum *outDataFormat, ALsizei* outSampleRate);
+void* CDGetOpenALAudioData(CFURLRef inFileURL, ALsizei *outDataSize, ALenum *outDataFormat, ALsizei* outSampleRate);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
+
+
--- /dev/null
+/*
+
+ Disclaimer: IMPORTANT: This Apple software is supplied to you by
+ Apple Inc. ("Apple") in consideration of your agreement to the
+ following terms, and your use, installation, modification or
+ redistribution of this Apple software constitutes acceptance of these
+ terms. If you do not agree with these terms, please do not use,
+ install, modify or redistribute this Apple software.
+
+ In consideration of your agreement to abide by the following terms, and
+ subject to these terms, Apple grants you a personal, non-exclusive
+ license, under Apple's copyrights in this original Apple software (the
+ "Apple Software"), to use, reproduce, modify and redistribute the Apple
+ Software, with or without modifications, in source and/or binary forms;
+ provided that if you redistribute the Apple Software in its entirety and
+ without modifications, you must retain this notice and the following
+ text and disclaimers in all such redistributions of the Apple Software.
+ Neither the name, trademarks, service marks or logos of Apple Inc.
+ may be used to endorse or promote products derived from the Apple
+ Software without specific prior written permission from Apple. Except
+ as expressly stated in this notice, no other rights or licenses, express
+ or implied, are granted by Apple herein, including but not limited to
+ any patent rights that may be infringed by your derivative works or by
+ other works in which the Apple Software may be incorporated.
+
+ The Apple Software is provided by Apple on an "AS IS" basis. APPLE
+ MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
+ THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
+ FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
+ OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
+
+ IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
+ OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
+ MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
+ AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
+ STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGE.
+
+ Copyright (C) 2009 Apple Inc. All Rights Reserved.
+
+ $Id: CDOpenALSupport.h 16 2010-03-11 06:22:10Z steveoldmeadow $
+ */
+
+#import "CDOpenALSupport.h"
+#import "CocosDenshion.h"
+#import <AudioToolbox/AudioToolbox.h>
+#import <AudioToolbox/ExtendedAudioFile.h>
+
+//Taken from oalTouch MyOpenALSupport 1.1
+void* CDloadWaveAudioData(CFURLRef inFileURL, ALsizei *outDataSize, ALenum *outDataFormat, ALsizei* outSampleRate)
+{
+ OSStatus err = noErr;
+ UInt64 fileDataSize = 0;
+ AudioStreamBasicDescription theFileFormat;
+ UInt32 thePropertySize = sizeof(theFileFormat);
+ AudioFileID afid = 0;
+ void* theData = NULL;
+
+ // Open a file with ExtAudioFileOpen()
+ err = AudioFileOpenURL(inFileURL, kAudioFileReadPermission, 0, &afid);
+ if(err) { CDLOG(@"MyGetOpenALAudioData: AudioFileOpenURL FAILED, Error = %ld\n", err); goto Exit; }
+
+ // Get the audio data format
+ err = AudioFileGetProperty(afid, kAudioFilePropertyDataFormat, &thePropertySize, &theFileFormat);
+ if(err) { CDLOG(@"MyGetOpenALAudioData: AudioFileGetProperty(kAudioFileProperty_DataFormat) FAILED, Error = %ld\n", err); goto Exit; }
+
+ if (theFileFormat.mChannelsPerFrame > 2) {
+ CDLOG(@"MyGetOpenALAudioData - Unsupported Format, channel count is greater than stereo\n"); goto Exit;
+ }
+
+ if ((theFileFormat.mFormatID != kAudioFormatLinearPCM) || (!TestAudioFormatNativeEndian(theFileFormat))) {
+ CDLOG(@"MyGetOpenALAudioData - Unsupported Format, must be little-endian PCM\n"); goto Exit;
+ }
+
+ if ((theFileFormat.mBitsPerChannel != 8) && (theFileFormat.mBitsPerChannel != 16)) {
+ CDLOG(@"MyGetOpenALAudioData - Unsupported Format, must be 8 or 16 bit PCM\n"); goto Exit;
+ }
+
+
+ thePropertySize = sizeof(fileDataSize);
+ err = AudioFileGetProperty(afid, kAudioFilePropertyAudioDataByteCount, &thePropertySize, &fileDataSize);
+ if(err) { CDLOG(@"MyGetOpenALAudioData: AudioFileGetProperty(kAudioFilePropertyAudioDataByteCount) FAILED, Error = %ld\n", err); goto Exit; }
+
+ // Read all the data into memory
+ UInt32 dataSize = (UInt32)fileDataSize;
+ theData = malloc(dataSize);
+ if (theData)
+ {
+ AudioFileReadBytes(afid, false, 0, &dataSize, theData);
+ if(err == noErr)
+ {
+ // success
+ *outDataSize = (ALsizei)dataSize;
+ //This fix was added by me, however, 8 bit sounds have a clipping sound at the end so aren't really usable (SO)
+ if (theFileFormat.mBitsPerChannel == 16) {
+ *outDataFormat = (theFileFormat.mChannelsPerFrame > 1) ? AL_FORMAT_STEREO16 : AL_FORMAT_MONO16;
+ } else {
+ *outDataFormat = (theFileFormat.mChannelsPerFrame > 1) ? AL_FORMAT_STEREO8 : AL_FORMAT_MONO8;
+ }
+ *outSampleRate = (ALsizei)theFileFormat.mSampleRate;
+ }
+ else
+ {
+ // failure
+ free (theData);
+ theData = NULL; // make sure to return NULL
+ CDLOG(@"MyGetOpenALAudioData: ExtAudioFileRead FAILED, Error = %ld\n", err); goto Exit;
+ }
+ }
+
+Exit:
+ // Dispose the ExtAudioFileRef, it is no longer needed
+ if (afid) AudioFileClose(afid);
+ return theData;
+}
+
+//Taken from oalTouch MyOpenALSupport 1.4
+void* CDloadCafAudioData(CFURLRef inFileURL, ALsizei *outDataSize, ALenum *outDataFormat, ALsizei* outSampleRate)
+{
+ OSStatus status = noErr;
+ BOOL abort = NO;
+ SInt64 theFileLengthInFrames = 0;
+ AudioStreamBasicDescription theFileFormat;
+ UInt32 thePropertySize = sizeof(theFileFormat);
+ ExtAudioFileRef extRef = NULL;
+ void* theData = NULL;
+ AudioStreamBasicDescription theOutputFormat;
+ UInt32 dataSize = 0;
+
+ // Open a file with ExtAudioFileOpen()
+ status = ExtAudioFileOpenURL(inFileURL, &extRef);
+ if (status != noErr)
+ {
+ CDLOG(@"MyGetOpenALAudioData: ExtAudioFileOpenURL FAILED, Error = %ld\n", status);
+ abort = YES;
+ }
+ if (abort)
+ goto Exit;
+
+ // Get the audio data format
+ status = ExtAudioFileGetProperty(extRef, kExtAudioFileProperty_FileDataFormat, &thePropertySize, &theFileFormat);
+ if (status != noErr)
+ {
+ CDLOG(@"MyGetOpenALAudioData: ExtAudioFileGetProperty(kExtAudioFileProperty_FileDataFormat) FAILED, Error = %ld\n", status);
+ abort = YES;
+ }
+ if (abort)
+ goto Exit;
+
+ if (theFileFormat.mChannelsPerFrame > 2)
+ {
+ CDLOG(@"MyGetOpenALAudioData - Unsupported Format, channel count is greater than stereo\n");
+ abort = YES;
+ }
+ if (abort)
+ goto Exit;
+
+ // Set the client format to 16 bit signed integer (native-endian) data
+ // Maintain the channel count and sample rate of the original source format
+ theOutputFormat.mSampleRate = theFileFormat.mSampleRate;
+ theOutputFormat.mChannelsPerFrame = theFileFormat.mChannelsPerFrame;
+
+ theOutputFormat.mFormatID = kAudioFormatLinearPCM;
+ theOutputFormat.mBytesPerPacket = 2 * theOutputFormat.mChannelsPerFrame;
+ theOutputFormat.mFramesPerPacket = 1;
+ theOutputFormat.mBytesPerFrame = 2 * theOutputFormat.mChannelsPerFrame;
+ theOutputFormat.mBitsPerChannel = 16;
+ theOutputFormat.mFormatFlags = kAudioFormatFlagsNativeEndian | kAudioFormatFlagIsPacked | kAudioFormatFlagIsSignedInteger;
+
+ // Set the desired client (output) data format
+ status = ExtAudioFileSetProperty(extRef, kExtAudioFileProperty_ClientDataFormat, sizeof(theOutputFormat), &theOutputFormat);
+ if (status != noErr)
+ {
+ CDLOG(@"MyGetOpenALAudioData: ExtAudioFileSetProperty(kExtAudioFileProperty_ClientDataFormat) FAILED, Error = %ld\n", status);
+ abort = YES;
+ }
+ if (abort)
+ goto Exit;
+
+ // Get the total frame count
+ thePropertySize = sizeof(theFileLengthInFrames);
+ status = ExtAudioFileGetProperty(extRef, kExtAudioFileProperty_FileLengthFrames, &thePropertySize, &theFileLengthInFrames);
+ if (status != noErr)
+ {
+ CDLOG(@"MyGetOpenALAudioData: ExtAudioFileGetProperty(kExtAudioFileProperty_FileLengthFrames) FAILED, Error = %ld\n", status);
+ abort = YES;
+ }
+ if (abort)
+ goto Exit;
+
+ // Read all the data into memory
+ dataSize = (UInt32) theFileLengthInFrames * theOutputFormat.mBytesPerFrame;
+ theData = malloc(dataSize);
+ if (theData)
+ {
+ AudioBufferList theDataBuffer;
+ theDataBuffer.mNumberBuffers = 1;
+ theDataBuffer.mBuffers[0].mDataByteSize = dataSize;
+ theDataBuffer.mBuffers[0].mNumberChannels = theOutputFormat.mChannelsPerFrame;
+ theDataBuffer.mBuffers[0].mData = theData;
+
+ // Read the data into an AudioBufferList
+ status = ExtAudioFileRead(extRef, (UInt32*)&theFileLengthInFrames, &theDataBuffer);
+ if(status == noErr)
+ {
+ // success
+ *outDataSize = (ALsizei)dataSize;
+ *outDataFormat = (theOutputFormat.mChannelsPerFrame > 1) ? AL_FORMAT_STEREO16 : AL_FORMAT_MONO16;
+ *outSampleRate = (ALsizei)theOutputFormat.mSampleRate;
+ }
+ else
+ {
+ // failure
+ free (theData);
+ theData = NULL; // make sure to return NULL
+ CDLOG(@"MyGetOpenALAudioData: ExtAudioFileRead FAILED, Error = %ld\n", status);
+ abort = YES;
+ }
+ }
+ if (abort)
+ goto Exit;
+
+Exit:
+ // Dispose the ExtAudioFileRef, it is no longer needed
+ if (extRef) ExtAudioFileDispose(extRef);
+ return theData;
+}
+
+void* CDGetOpenALAudioData(CFURLRef inFileURL, ALsizei *outDataSize, ALenum *outDataFormat, ALsizei* outSampleRate) {
+
+ CFStringRef extension = CFURLCopyPathExtension(inFileURL);
+ CFComparisonResult isWavFile = 0;
+ if (extension != NULL) {
+ isWavFile = CFStringCompare (extension,(CFStringRef)@"wav", kCFCompareCaseInsensitive);
+ CFRelease(extension);
+ }
+
+ if (isWavFile == kCFCompareEqualTo) {
+ return CDloadWaveAudioData(inFileURL, outDataSize, outDataFormat, outSampleRate);
+ } else {
+ return CDloadCafAudioData(inFileURL, outDataSize, outDataFormat, outSampleRate);
+ }
+}
+
--- /dev/null
+/*
+ Copyright (c) 2010 Steve Oldmeadow
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+
+ $Id$
+ */
+
+
+
+/**
+@file
+@b IMPORTANT
+There are 3 different ways of using CocosDenshion. Depending on which you choose you
+will need to include different files and frameworks.
+
+@par SimpleAudioEngine
+This is recommended for basic audio requirements. If you just want to play some sound fx
+and some background music and have no interest in learning the lower level workings then
+this is the interface to use.
+
+Requirements:
+ - Firmware: OS 2.2 or greater
+ - Files: SimpleAudioEngine.*, CocosDenshion.*
+ - Frameworks: OpenAL, AudioToolbox, AVFoundation
+
+@par CDAudioManager
+CDAudioManager is basically a thin wrapper around an AVAudioPlayer object used for playing
+background music and a CDSoundEngine object used for playing sound effects. It manages the
+audio session for you deals with audio session interruption. It is fairly low level and it
+is expected you have some understanding of the underlying technologies. For example, for
+many use cases regarding background music it is expected you will work directly with the
+backgroundMusic AVAudioPlayer which is exposed as a property.
+
+Requirements:
+ - Firmware: OS 2.2 or greater
+ - Files: CDAudioManager.*, CocosDenshion.*
+ - Frameworks: OpenAL, AudioToolbox, AVFoundation
+
+@par CDSoundEngine
+CDSoundEngine is a sound engine built upon OpenAL and derived from Apple's oalTouch
+example. It can playback up to 32 sounds simultaneously with control over pitch, pan
+and gain. It can be set up to handle audio session interruption automatically. You
+may decide to use CDSoundEngine directly instead of CDAudioManager or SimpleAudioEngine
+because you require OS 2.0 compatibility.
+
+Requirements:
+ - Firmware: OS 2.0 or greater
+ - Files: CocosDenshion.*
+ - Frameworks: OpenAL, AudioToolbox
+
+*/
+
+#import <OpenAL/al.h>
+#import <OpenAL/alc.h>
+#import <AudioToolbox/AudioToolbox.h>
+#import <Foundation/Foundation.h>
+#import "CDConfig.h"
+
+
+#if !defined(CD_DEBUG) || CD_DEBUG == 0
+#define CDLOG(...) do {} while (0)
+#define CDLOGINFO(...) do {} while (0)
+
+#elif CD_DEBUG == 1
+#define CDLOG(...) NSLog(__VA_ARGS__)
+#define CDLOGINFO(...) do {} while (0)
+
+#elif CD_DEBUG > 1
+#define CDLOG(...) NSLog(__VA_ARGS__)
+#define CDLOGINFO(...) NSLog(__VA_ARGS__)
+#endif // CD_DEBUG
+
+
+#import "CDOpenALSupport.h"
+
+//Tested source limit on 2.2.1 and 3.1.2 with up to 128 sources and appears to work. Older OS versions e.g 2.2 may support only 32
+#define CD_SOURCE_LIMIT 32 //Total number of sources we will ever want, may actually get less
+#define CD_NO_SOURCE 0xFEEDFAC //Return value indicating playback failed i.e. no source
+#define CD_IGNORE_AUDIO_SESSION 0xBEEFBEE //Used internally to indicate audio session will not be handled
+#define CD_MUTE 0xFEEDBAB //Return value indicating sound engine is muted or non functioning
+#define CD_NO_SOUND = -1;
+
+#define CD_SAMPLE_RATE_HIGH 44100
+#define CD_SAMPLE_RATE_MID 22050
+#define CD_SAMPLE_RATE_LOW 16000
+#define CD_SAMPLE_RATE_BASIC 8000
+#define CD_SAMPLE_RATE_DEFAULT 44100
+
+extern NSString * const kCDN_BadAlContext;
+extern NSString * const kCDN_AsynchLoadComplete;
+
+extern float const kCD_PitchDefault;
+extern float const kCD_PitchLowerOneOctave;
+extern float const kCD_PitchHigherOneOctave;
+extern float const kCD_PanDefault;
+extern float const kCD_PanFullLeft;
+extern float const kCD_PanFullRight;
+extern float const kCD_GainDefault;
+
+enum bufferState {
+ CD_BS_EMPTY = 0,
+ CD_BS_LOADED = 1,
+ CD_BS_FAILED = 2
+};
+
+typedef struct _sourceGroup {
+ int startIndex;
+ int currentIndex;
+ int totalSources;
+ bool enabled;
+ bool nonInterruptible;
+ int *sourceStatuses;//pointer into array of source status information
+} sourceGroup;
+
+typedef struct _bufferInfo {
+ ALuint bufferId;
+ int bufferState;
+ void* bufferData;
+ ALenum format;
+ ALsizei sizeInBytes;
+ ALsizei frequencyInHertz;
+} bufferInfo;
+
+typedef struct _sourceInfo {
+ bool usable;
+ ALuint sourceId;
+ ALuint attachedBufferId;
+} sourceInfo;
+
+#pragma mark CDAudioTransportProtocol
+
+@protocol CDAudioTransportProtocol <NSObject>
+/** Play the audio */
+-(BOOL) play;
+/** Pause the audio, retain resources */
+-(BOOL) pause;
+/** Stop the audio, release resources */
+-(BOOL) stop;
+/** Return playback to beginning */
+-(BOOL) rewind;
+@end
+
+#pragma mark CDAudioInterruptProtocol
+
+@protocol CDAudioInterruptProtocol <NSObject>
+/** Is audio mute */
+-(BOOL) mute;
+/** If YES then audio is silenced but not stopped, calls to start new audio will proceed but silently */
+-(void) setMute:(BOOL) muteValue;
+/** Is audio enabled */
+-(BOOL) enabled;
+/** If NO then all audio is stopped and any calls to start new audio will be ignored */
+-(void) setEnabled:(BOOL) enabledValue;
+@end
+
+#pragma mark CDUtilities
+/**
+ Collection of utilities required by CocosDenshion
+ */
+@interface CDUtilities : NSObject
+{
+}
+
+/** Fundamentally the same as the corresponding method is CCFileUtils but added to break binding to cocos2d */
++(NSString*) fullPathFromRelativePath:(NSString*) relPath;
+
+@end
+
+
+#pragma mark CDSoundEngine
+
+/** CDSoundEngine is built upon OpenAL and works with SDK 2.0.
+ CDSoundEngine is a sound engine built upon OpenAL and derived from Apple's oalTouch
+ example. It can playback up to 32 sounds simultaneously with control over pitch, pan
+ and gain. It can be set up to handle audio session interruption automatically. You
+ may decide to use CDSoundEngine directly instead of CDAudioManager or SimpleAudioEngine
+ because you require OS 2.0 compatibility.
+
+ Requirements:
+ - Firmware: OS 2.0 or greater
+ - Files: CocosDenshion.*
+ - Frameworks: OpenAL, AudioToolbox
+
+ @since v0.8
+ */
+@class CDSoundSource;
+@interface CDSoundEngine : NSObject <CDAudioInterruptProtocol> {
+
+ bufferInfo *_buffers;
+ sourceInfo *_sources;
+ sourceGroup *_sourceGroups;
+ ALCcontext *context;
+ NSUInteger _sourceGroupTotal;
+ UInt32 _audioSessionCategory;
+ BOOL _handleAudioSession;
+ ALfloat _preMuteGain;
+ NSObject *_mutexBufferLoad;
+ BOOL mute_;
+ BOOL enabled_;
+
+ ALenum lastErrorCode_;
+ BOOL functioning_;
+ float asynchLoadProgress_;
+ BOOL getGainWorks_;
+
+ //For managing dynamic allocation of sources and buffers
+ int sourceTotal_;
+ int bufferTotal;
+
+}
+
+@property (readwrite, nonatomic) ALfloat masterGain;
+@property (readonly) ALenum lastErrorCode;//Last OpenAL error code that was generated
+@property (readonly) BOOL functioning;//Is the sound engine functioning
+@property (readwrite) float asynchLoadProgress;
+@property (readonly) BOOL getGainWorks;//Does getting the gain for a source work
+/** Total number of sources available */
+@property (readonly) int sourceTotal;
+/** Total number of source groups that have been defined */
+@property (readonly) NSUInteger sourceGroupTotal;
+
+/** Sets the sample rate for the audio mixer. For best performance this should match the sample rate of your audio content */
++(void) setMixerSampleRate:(Float32) sampleRate;
+
+/** Initializes the engine with a group definition and a total number of groups */
+-(id)init;
+
+/** Plays a sound in a channel group with a pitch, pan and gain. The sound could played looped or not */
+-(ALuint) playSound:(int) soundId sourceGroupId:(int)sourceGroupId pitch:(float) pitch pan:(float) pan gain:(float) gain loop:(BOOL) loop;
+
+/** Creates and returns a sound source object for the specified sound within the specified source group.
+ */
+-(CDSoundSource *) soundSourceForSound:(int) soundId sourceGroupId:(int) sourceGroupId;
+
+/** Stops playing a sound */
+- (void) stopSound:(ALuint) sourceId;
+/** Stops playing a source group */
+- (void) stopSourceGroup:(int) sourceGroupId;
+/** Stops all playing sounds */
+-(void) stopAllSounds;
+-(void) defineSourceGroups:(NSArray*) sourceGroupDefinitions;
+-(void) defineSourceGroups:(int[]) sourceGroupDefinitions total:(NSUInteger) total;
+-(void) setSourceGroupNonInterruptible:(int) sourceGroupId isNonInterruptible:(BOOL) isNonInterruptible;
+-(void) setSourceGroupEnabled:(int) sourceGroupId enabled:(BOOL) enabled;
+-(BOOL) sourceGroupEnabled:(int) sourceGroupId;
+-(BOOL) loadBufferFromData:(int) soundId soundData:(ALvoid*) soundData format:(ALenum) format size:(ALsizei) size freq:(ALsizei) freq;
+-(BOOL) loadBuffer:(int) soundId filePath:(NSString*) filePath;
+-(void) loadBuffersAsynchronously:(NSArray *) loadRequests;
+-(BOOL) unloadBuffer:(int) soundId;
+-(ALCcontext *) openALContext;
+
+/** Returns the duration of the buffer in seconds or a negative value if the buffer id is invalid */
+-(float) bufferDurationInSeconds:(int) soundId;
+/** Returns the size of the buffer in bytes or a negative value if the buffer id is invalid */
+-(ALsizei) bufferSizeInBytes:(int) soundId;
+/** Returns the sampling frequency of the buffer in hertz or a negative value if the buffer id is invalid */
+-(ALsizei) bufferFrequencyInHertz:(int) soundId;
+
+/** Used internally, never call unless you know what you are doing */
+-(void) _soundSourcePreRelease:(CDSoundSource *) soundSource;
+
+@end
+
+#pragma mark CDSoundSource
+/** CDSoundSource is a wrapper around an OpenAL sound source.
+ It allows you to manipulate properties such as pitch, gain, pan and looping while the
+ sound is playing. CDSoundSource is based on the old CDSourceWrapper class but with much
+ added functionality.
+
+ @since v1.0
+ */
+@interface CDSoundSource : NSObject <CDAudioTransportProtocol, CDAudioInterruptProtocol> {
+ ALenum lastError;
+@public
+ ALuint _sourceId;
+ ALuint _sourceIndex;
+ CDSoundEngine* _engine;
+ int _soundId;
+ float _preMuteGain;
+ BOOL enabled_;
+ BOOL mute_;
+}
+@property (readwrite, nonatomic) float pitch;
+@property (readwrite, nonatomic) float gain;
+@property (readwrite, nonatomic) float pan;
+@property (readwrite, nonatomic) BOOL looping;
+@property (readonly) BOOL isPlaying;
+@property (readwrite, nonatomic) int soundId;
+/** Returns the duration of the attached buffer in seconds or a negative value if the buffer is invalid */
+@property (readonly) float durationInSeconds;
+
+/** Stores the last error code that occurred. Check against AL_NO_ERROR */
+@property (readonly) ALenum lastError;
+/** Do not init yourself, get an instance from the sourceForSound factory method on CDSoundEngine */
+-(id)init:(ALuint) theSourceId sourceIndex:(int) index soundEngine:(CDSoundEngine*) engine;
+
+@end
+
+#pragma mark CDAudioInterruptTargetGroup
+
+/** Container for objects that implement audio interrupt protocol i.e. they can be muted and enabled.
+ Setting mute and enabled for the group propagates to all children.
+ Designed to be used with your CDSoundSource objects to get them to comply with global enabled and mute settings
+ if that is what you want to do.*/
+@interface CDAudioInterruptTargetGroup : NSObject <CDAudioInterruptProtocol> {
+ BOOL mute_;
+ BOOL enabled_;
+ NSMutableArray *children_;
+}
+-(void) addAudioInterruptTarget:(NSObject<CDAudioInterruptProtocol>*) interruptibleTarget;
+@end
+
+#pragma mark CDAsynchBufferLoader
+
+/** CDAsynchBufferLoader
+ TODO
+ */
+@interface CDAsynchBufferLoader : NSOperation {
+ NSArray *_loadRequests;
+ CDSoundEngine *_soundEngine;
+}
+
+-(id) init:(NSArray *)loadRequests soundEngine:(CDSoundEngine *) theSoundEngine;
+
+@end
+
+#pragma mark CDBufferLoadRequest
+
+/** CDBufferLoadRequest */
+@interface CDBufferLoadRequest: NSObject
+{
+ NSString *filePath;
+ int soundId;
+ //id loader;
+}
+
+@property (readonly) NSString *filePath;
+@property (readonly) int soundId;
+
+- (id)init:(int) theSoundId filePath:(const NSString *) theFilePath;
+@end
+
+/** Interpolation type */
+typedef enum {
+ kIT_Linear, //!Straight linear interpolation fade
+ kIT_SCurve, //!S curved interpolation
+ kIT_Exponential //!Exponential interpolation
+} tCDInterpolationType;
+
+#pragma mark CDFloatInterpolator
+@interface CDFloatInterpolator: NSObject
+{
+ float start;
+ float end;
+ float lastValue;
+ tCDInterpolationType interpolationType;
+}
+@property (readwrite, nonatomic) float start;
+@property (readwrite, nonatomic) float end;
+@property (readwrite, nonatomic) tCDInterpolationType interpolationType;
+
+/** Return a value between min and max based on t which represents fractional progress where 0 is the start
+ and 1 is the end */
+-(float) interpolate:(float) t;
+-(id) init:(tCDInterpolationType) type startVal:(float) startVal endVal:(float) endVal;
+
+@end
+
+#pragma mark CDPropertyModifier
+
+/** Base class for classes that modify properties such as pitch, pan and gain */
+@interface CDPropertyModifier: NSObject
+{
+ CDFloatInterpolator *interpolator;
+ float startValue;
+ float endValue;
+ id target;
+ BOOL stopTargetWhenComplete;
+
+}
+@property (readwrite, nonatomic) BOOL stopTargetWhenComplete;
+@property (readwrite, nonatomic) float startValue;
+@property (readwrite, nonatomic) float endValue;
+@property (readwrite, nonatomic) tCDInterpolationType interpolationType;
+
+-(id) init:(id) theTarget interpolationType:(tCDInterpolationType) type startVal:(float) startVal endVal:(float) endVal;
+/** Set to a fractional value between 0 and 1 where 0 equals the start and 1 equals the end*/
+-(void) modify:(float) t;
+
+-(void) _setTargetProperty:(float) newVal;
+-(float) _getTargetProperty;
+-(void) _stopTarget;
+-(Class) _allowableType;
+
+@end
+
+#pragma mark CDSoundSourceFader
+
+/** Fader for CDSoundSource objects */
+@interface CDSoundSourceFader : CDPropertyModifier{}
+@end
+
+#pragma mark CDSoundSourcePanner
+
+/** Panner for CDSoundSource objects */
+@interface CDSoundSourcePanner : CDPropertyModifier{}
+@end
+
+#pragma mark CDSoundSourcePitchBender
+
+/** Pitch bender for CDSoundSource objects */
+@interface CDSoundSourcePitchBender : CDPropertyModifier{}
+@end
+
+#pragma mark CDSoundEngineFader
+
+/** Fader for CDSoundEngine objects */
+@interface CDSoundEngineFader : CDPropertyModifier{}
+@end
+
+
+
+
--- /dev/null
+/*
+ Copyright (c) 2010 Steve Oldmeadow
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+
+ $Id$
+ */
+
+#import "CocosDenshion.h"
+
+typedef ALvoid AL_APIENTRY (*alBufferDataStaticProcPtr) (const ALint bid, ALenum format, ALvoid* data, ALsizei size, ALsizei freq);
+ALvoid alBufferDataStaticProc(const ALint bid, ALenum format, ALvoid* data, ALsizei size, ALsizei freq)
+{
+ static alBufferDataStaticProcPtr proc = NULL;
+
+ if (proc == NULL) {
+ proc = (alBufferDataStaticProcPtr) alcGetProcAddress(NULL, (const ALCchar*) "alBufferDataStatic");
+ }
+
+ if (proc)
+ proc(bid, format, data, size, freq);
+
+ return;
+}
+
+typedef ALvoid AL_APIENTRY (*alcMacOSXMixerOutputRateProcPtr) (const ALdouble value);
+ALvoid alcMacOSXMixerOutputRateProc(const ALdouble value)
+{
+ static alcMacOSXMixerOutputRateProcPtr proc = NULL;
+
+ if (proc == NULL) {
+ proc = (alcMacOSXMixerOutputRateProcPtr) alcGetProcAddress(NULL, (const ALCchar*) "alcMacOSXMixerOutputRate");
+ }
+
+ if (proc)
+ proc(value);
+
+ return;
+}
+
+NSString * const kCDN_BadAlContext = @"kCDN_BadAlContext";
+NSString * const kCDN_AsynchLoadComplete = @"kCDN_AsynchLoadComplete";
+float const kCD_PitchDefault = 1.0f;
+float const kCD_PitchLowerOneOctave = 0.5f;
+float const kCD_PitchHigherOneOctave = 2.0f;
+float const kCD_PanDefault = 0.0f;
+float const kCD_PanFullLeft = -1.0f;
+float const kCD_PanFullRight = 1.0f;
+float const kCD_GainDefault = 1.0f;
+
+@interface CDSoundEngine (PrivateMethods)
+-(BOOL) _initOpenAL;
+-(void) _testGetGain;
+-(void) _dumpSourceGroupsInfo;
+-(void) _getSourceIndexForSourceGroup;
+-(void) _freeSourceGroups;
+-(BOOL) _setUpSourceGroups:(int[]) definitions total:(NSUInteger) total;
+@end
+
+#pragma mark -
+#pragma mark CDUtilities
+
+@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
+
+#pragma mark -
+#pragma mark CDSoundEngine
+
+@implementation CDSoundEngine
+
+static Float32 _mixerSampleRate;
+static BOOL _mixerRateSet = NO;
+
+@synthesize lastErrorCode = lastErrorCode_;
+@synthesize functioning = functioning_;
+@synthesize asynchLoadProgress = asynchLoadProgress_;
+@synthesize getGainWorks = getGainWorks_;
+@synthesize sourceTotal = sourceTotal_;
+
++ (void) setMixerSampleRate:(Float32) sampleRate {
+ _mixerRateSet = YES;
+ _mixerSampleRate = sampleRate;
+}
+
+- (void) _testGetGain {
+ float testValue = 0.7f;
+ ALuint testSourceId = _sources[0].sourceId;
+ alSourcef(testSourceId, AL_GAIN, 0.0f);//Start from know value
+ alSourcef(testSourceId, AL_GAIN, testValue);
+ ALfloat gainVal;
+ alGetSourcef(testSourceId, AL_GAIN, &gainVal);
+ getGainWorks_ = (gainVal == testValue);
+}
+
+//Generate sources one at a time until we fail
+-(void) _generateSources {
+
+ _sources = (sourceInfo*)malloc( sizeof(_sources[0]) * CD_SOURCE_LIMIT);
+ BOOL hasFailed = NO;
+ sourceTotal_ = 0;
+ alGetError();//Clear error
+ while (!hasFailed && sourceTotal_ < CD_SOURCE_LIMIT) {
+ alGenSources(1, &(_sources[sourceTotal_].sourceId));
+ if (alGetError() == AL_NO_ERROR) {
+ //Now try attaching source to null buffer
+ alSourcei(_sources[sourceTotal_].sourceId, AL_BUFFER, 0);
+ if (alGetError() == AL_NO_ERROR) {
+ _sources[sourceTotal_].usable = true;
+ sourceTotal_++;
+ } else {
+ hasFailed = YES;
+ }
+ } else {
+ _sources[sourceTotal_].usable = false;
+ hasFailed = YES;
+ }
+ }
+ //Mark the rest of the sources as not usable
+ for (int i=sourceTotal_; i < CD_SOURCE_LIMIT; i++) {
+ _sources[i].usable = false;
+ }
+}
+
+-(void) _generateBuffers:(int) startIndex endIndex:(int) endIndex {
+ if (_buffers) {
+ alGetError();
+ for (int i=startIndex; i <= endIndex; i++) {
+ alGenBuffers(1, &_buffers[i].bufferId);
+ _buffers[i].bufferData = NULL;
+ if (alGetError() == AL_NO_ERROR) {
+ _buffers[i].bufferState = CD_BS_EMPTY;
+ } else {
+ _buffers[i].bufferState = CD_BS_FAILED;
+ CDLOG(@"Denshion::CDSoundEngine - buffer creation failed %i",i);
+ }
+ }
+ }
+}
+
+/**
+ * Internal method called during init
+ */
+- (BOOL) _initOpenAL
+{
+ //ALenum error;
+ context = NULL;
+ ALCdevice *newDevice = NULL;
+
+ //Set the mixer rate for the audio mixer
+ if (!_mixerRateSet) {
+ _mixerSampleRate = CD_SAMPLE_RATE_DEFAULT;
+ }
+ alcMacOSXMixerOutputRateProc(_mixerSampleRate);
+ CDLOGINFO(@"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);
+
+ // Create some OpenAL Buffer Objects
+ [self _generateBuffers:0 endIndex:bufferTotal-1];
+
+ // Create some OpenAL Source Objects
+ [self _generateSources];
+
+ }
+ } else {
+ return FALSE;//No device
+ }
+ alGetError();//Clear error
+ return TRUE;
+}
+
+- (void) dealloc {
+
+ ALCcontext *currentContext = NULL;
+ ALCdevice *device = NULL;
+
+ [self stopAllSounds];
+
+ CDLOGINFO(@"Denshion::CDSoundEngine - Deallocing sound engine.");
+ [self _freeSourceGroups];
+
+ // Delete the Sources
+ CDLOGINFO(@"Denshion::CDSoundEngine - deleting sources.");
+ for (int i=0; i < sourceTotal_; i++) {
+ alSourcei(_sources[i].sourceId, AL_BUFFER, 0);//Detach from current buffer
+ alDeleteSources(1, &(_sources[i].sourceId));
+ if((lastErrorCode_ = alGetError()) != AL_NO_ERROR) {
+ CDLOG(@"Denshion::CDSoundEngine - Error deleting source! %x\n", lastErrorCode_);
+ }
+ }
+
+ // Delete the Buffers
+ CDLOGINFO(@"Denshion::CDSoundEngine - deleting buffers.");
+ for (int i=0; i < bufferTotal; i++) {
+ alDeleteBuffers(1, &_buffers[i].bufferId);
+#ifdef CD_USE_STATIC_BUFFERS
+ if (_buffers[i].bufferData) {
+ free(_buffers[i].bufferData);
+ }
+#endif
+ }
+ CDLOGINFO(@"Denshion::CDSoundEngine - free buffers.");
+ free(_buffers);
+ currentContext = alcGetCurrentContext();
+ //Get device for active context
+ device = alcGetContextsDevice(currentContext);
+ //Release context
+ CDLOGINFO(@"Denshion::CDSoundEngine - destroy context.");
+ alcDestroyContext(currentContext);
+ //Close device
+ CDLOGINFO(@"Denshion::CDSoundEngine - close device.");
+ alcCloseDevice(device);
+ CDLOGINFO(@"Denshion::CDSoundEngine - free sources.");
+ free(_sources);
+
+ //Release mutexes
+ [_mutexBufferLoad release];
+
+ [super dealloc];
+}
+
+-(NSUInteger) sourceGroupTotal {
+ return _sourceGroupTotal;
+}
+
+-(void) _freeSourceGroups
+{
+ CDLOGINFO(@"Denshion::CDSoundEngine freeing source groups");
+ if(_sourceGroups) {
+ for (int i=0; i < _sourceGroupTotal; i++) {
+ if (_sourceGroups[i].sourceStatuses) {
+ free(_sourceGroups[i].sourceStatuses);
+ CDLOGINFO(@"Denshion::CDSoundEngine freed source statuses %i",i);
+ }
+ }
+ free(_sourceGroups);
+ }
+}
+
+-(BOOL) _redefineSourceGroups:(int[]) definitions total:(NSUInteger) total
+{
+ if (_sourceGroups) {
+ //Stop all sounds
+ [self stopAllSounds];
+ //Need to free source groups
+ [self _freeSourceGroups];
+ }
+ return [self _setUpSourceGroups:definitions total:total];
+}
+
+-(BOOL) _setUpSourceGroups:(int[]) definitions total:(NSUInteger) total
+{
+ _sourceGroups = (sourceGroup *)malloc( sizeof(_sourceGroups[0]) * total);
+ if(!_sourceGroups) {
+ CDLOG(@"Denshion::CDSoundEngine - source groups memory allocation failed");
+ return NO;
+ }
+
+ _sourceGroupTotal = total;
+ int sourceCount = 0;
+ for (int i=0; i < _sourceGroupTotal; i++) {
+
+ _sourceGroups[i].startIndex = 0;
+ _sourceGroups[i].currentIndex = _sourceGroups[i].startIndex;
+ _sourceGroups[i].enabled = false;
+ _sourceGroups[i].nonInterruptible = false;
+ _sourceGroups[i].totalSources = definitions[i];
+ _sourceGroups[i].sourceStatuses = malloc(sizeof(_sourceGroups[i].sourceStatuses[0]) * _sourceGroups[i].totalSources);
+ if (_sourceGroups[i].sourceStatuses) {
+ for (int j=0; j < _sourceGroups[i].totalSources; j++) {
+ //First bit is used to indicate whether source is locked, index is shifted back 1 bit
+ _sourceGroups[i].sourceStatuses[j] = (sourceCount + j) << 1;
+ }
+ }
+ sourceCount += definitions[i];
+ }
+ return YES;
+}
+
+-(void) defineSourceGroups:(int[]) sourceGroupDefinitions total:(NSUInteger) total {
+ [self _redefineSourceGroups:sourceGroupDefinitions total:total];
+}
+
+-(void) defineSourceGroups:(NSArray*) sourceGroupDefinitions {
+ CDLOGINFO(@"Denshion::CDSoundEngine - source groups defined by NSArray.");
+ NSUInteger totalDefs = [sourceGroupDefinitions count];
+ int* defs = (int *)malloc( sizeof(int) * totalDefs);
+ int currentIndex = 0;
+ for (id currentDef in sourceGroupDefinitions) {
+ if ([currentDef isKindOfClass:[NSNumber class]]) {
+ defs[currentIndex] = (int)[(NSNumber*)currentDef integerValue];
+ CDLOGINFO(@"Denshion::CDSoundEngine - found definition %i.",defs[currentIndex]);
+ } else {
+ CDLOG(@"Denshion::CDSoundEngine - warning, did not understand source definition.");
+ defs[currentIndex] = 0;
+ }
+ currentIndex++;
+ }
+ [self _redefineSourceGroups:defs total:totalDefs];
+ free(defs);
+}
+
+- (id)init
+{
+ if ((self = [super init])) {
+
+ //Create mutexes
+ _mutexBufferLoad = [[NSObject alloc] init];
+
+ asynchLoadProgress_ = 0.0f;
+
+ bufferTotal = CD_BUFFERS_START;
+ _buffers = (bufferInfo *)malloc( sizeof(_buffers[0]) * bufferTotal);
+
+ // Initialize our OpenAL environment
+ if ([self _initOpenAL]) {
+ //Set up the default source group - a single group that contains all the sources
+ int sourceDefs[1];
+ sourceDefs[0] = self.sourceTotal;
+ [self _setUpSourceGroups:sourceDefs total:1];
+
+ functioning_ = YES;
+ //Synchronize premute gain
+ _preMuteGain = self.masterGain;
+ mute_ = NO;
+ enabled_ = YES;
+ //Test whether get gain works for sources
+ [self _testGetGain];
+ } else {
+ //Something went wrong with OpenAL
+ functioning_ = NO;
+ }
+ }
+
+ return self;
+}
+
+/**
+ * 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 >= bufferTotal) {
+ 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 < sourceTotal_; 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].bufferId == _sources[i].attachedBufferId) {
+
+ CDLOG(@"Denshion::CDSoundEngine - Found attached source %i %i %i",i,_buffers[soundId].bufferId,_sources[i].sourceId);
+#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].sourceId, AL_SOURCE_STATE, &state);
+
+ if (state == AL_PLAYING) {
+ CDLOG(@"Denshion::CDSoundEngine - waiting for source to complete playing before removing buffer data");
+ alSourcei(_sources[i].sourceId, AL_LOOPING, FALSE);//Turn off looping otherwise loops will never end
+ while (state == AL_PLAYING) {
+ alGetSourcei(_sources[i].sourceId, AL_SOURCE_STATE, &state);
+ usleep(10000);
+ }
+ }
+#endif
+ //Stop source and detach
+ alSourceStop(_sources[i].sourceId);
+ if((lastErrorCode_ = alGetError()) != AL_NO_ERROR) {
+ CDLOG(@"Denshion::CDSoundEngine - error stopping source: %x\n", lastErrorCode_);
+ }
+
+ alSourcei(_sources[i].sourceId, 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
+ _sources[i].attachedBufferId = 0;
+ }
+ }
+ }
+
+ alDeleteBuffers(1, &_buffers[soundId].bufferId);
+ if((lastErrorCode_ = alGetError()) != AL_NO_ERROR) {
+ CDLOG(@"Denshion::CDSoundEngine - error deleting buffer: %x\n", lastErrorCode_);
+ _buffers[soundId].bufferState = CD_BS_FAILED;
+ return FALSE;
+ } else {
+#ifdef CD_USE_STATIC_BUFFERS
+ //Free previous data, if alDeleteBuffer has returned without error then no
+ if (_buffers[soundId].bufferData) {
+ CDLOGINFO(@"Denshion::CDSoundEngine - freeing static data for soundId %i @ %i",soundId,_buffers[soundId].bufferData);
+ free(_buffers[soundId].bufferData);//Free the old data
+ _buffers[soundId].bufferData = NULL;
+ }
+#endif
+ }
+
+ alGenBuffers(1, &_buffers[soundId].bufferId);
+ if((lastErrorCode_ = alGetError()) != AL_NO_ERROR) {
+ CDLOG(@"Denshion::CDSoundEngine - error regenerating buffer: %x\n", lastErrorCode_);
+ _buffers[soundId].bufferState = CD_BS_FAILED;
+ return FALSE;
+ } else {
+ //We now have an empty buffer
+ _buffers[soundId].bufferState = CD_BS_EMPTY;
+ CDLOGINFO(@"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];
+ [opQ addOperation:loaderOp];
+ }
+}
+
+-(BOOL) _resizeBuffers:(int) increment {
+
+ void * tmpBufferInfos = realloc( _buffers, sizeof(_buffers[0]) * (bufferTotal + increment) );
+
+ if(!tmpBufferInfos) {
+ free(tmpBufferInfos);
+ return NO;
+ } else {
+ _buffers = tmpBufferInfos;
+ int oldBufferTotal = bufferTotal;
+ bufferTotal = bufferTotal + increment;
+ [self _generateBuffers:oldBufferTotal endIndex:bufferTotal-1];
+ return YES;
+ }
+}
+
+-(BOOL) loadBufferFromData:(int) soundId soundData:(ALvoid*) soundData format:(ALenum) format size:(ALsizei) size freq:(ALsizei) freq {
+
+ @synchronized(_mutexBufferLoad) {
+
+ 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) {
+ CDLOG(@"Denshion::CDSoundEngine - soundId is negative");
+ return FALSE;
+ }
+
+ if (soundId >= bufferTotal) {
+ //Need to resize the buffers
+ int requiredIncrement = CD_BUFFERS_INCREMENT;
+ while (bufferTotal + requiredIncrement < soundId) {
+ requiredIncrement += CD_BUFFERS_INCREMENT;
+ }
+ CDLOGINFO(@"Denshion::CDSoundEngine - attempting to resize buffers by %i for sound %i",requiredIncrement,soundId);
+ if (![self _resizeBuffers:requiredIncrement]) {
+ CDLOG(@"Denshion::CDSoundEngine - buffer resize failed");
+ return FALSE;
+ }
+ }
+
+ if (soundData)
+ {
+ if (_buffers[soundId].bufferState != CD_BS_EMPTY) {
+ CDLOGINFO(@"Denshion::CDSoundEngine - non empty buffer, regenerating");
+ if (![self unloadBuffer:soundId]) {
+ //Deletion of buffer failed, delete buffer routine has set buffer state and lastErrorCode
+ return NO;
+ }
+ }
+
+#ifdef CD_DEBUG
+ //Check that sample rate matches mixer rate and warn if they do not
+ if (freq != (int)_mixerSampleRate) {
+ CDLOGINFO(@"Denshion::CDSoundEngine - WARNING sample rate does not match mixer sample rate performance may not be optimal.");
+ }
+#endif
+
+#ifdef CD_USE_STATIC_BUFFERS
+ alBufferDataStaticProc(_buffers[soundId].bufferId, format, soundData, size, freq);
+ _buffers[soundId].bufferData = data;//Save the pointer to the new data
+#else
+ alBufferData(_buffers[soundId].bufferId, format, soundData, size, freq);
+#endif
+ if((lastErrorCode_ = alGetError()) != AL_NO_ERROR) {
+ CDLOG(@"Denshion::CDSoundEngine - error attaching audio to buffer: %x", lastErrorCode_);
+ _buffers[soundId].bufferState = CD_BS_FAILED;
+ return FALSE;
+ }
+ } else {
+ CDLOG(@"Denshion::CDSoundEngine Buffer data is null!");
+ _buffers[soundId].bufferState = CD_BS_FAILED;
+ return FALSE;
+ }
+
+ _buffers[soundId].format = format;
+ _buffers[soundId].sizeInBytes = size;
+ _buffers[soundId].frequencyInHertz = freq;
+ _buffers[soundId].bufferState = CD_BS_LOADED;
+ CDLOGINFO(@"Denshion::CDSoundEngine Buffer %i loaded format:%i freq:%i size:%i",soundId,format,freq,size);
+ return TRUE;
+ }//end mutex
+}
+
+/**
+ * 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
+{
+
+ ALvoid* data;
+ ALenum format;
+ ALsizei size;
+ ALsizei freq;
+
+ CDLOGINFO(@"Denshion::CDSoundEngine - Loading openAL buffer %i %@", soundId, filePath);
+
+ CFURLRef fileURL = nil;
+ NSString *path = [CDUtilities fullPathFromRelativePath:filePath];
+ if (path) {
+ fileURL = (CFURLRef)[[NSURL fileURLWithPath:path] retain];
+ }
+
+ if (fileURL)
+ {
+ data = CDGetOpenALAudioData(fileURL, &size, &format, &freq);
+ CFRelease(fileURL);
+ BOOL result = [self loadBufferFromData:soundId soundData:data format:format size:size freq:freq];
+#ifndef CD_USE_STATIC_BUFFERS
+ free(data);//Data can be freed here because alBufferData performs a memcpy
+#endif
+ return result;
+ } else {
+ CDLOG(@"Denshion::CDSoundEngine Could not find file!\n");
+ //Don't change buffer state here as it will be the same as before method was called
+ return FALSE;
+ }
+}
+
+-(BOOL) validateBufferId:(int) soundId {
+ if (soundId < 0 || soundId >= bufferTotal) {
+ CDLOGINFO(@"Denshion::CDSoundEngine - validateBufferId buffer outside range %i",soundId);
+ return NO;
+ } else if (_buffers[soundId].bufferState != CD_BS_LOADED) {
+ CDLOGINFO(@"Denshion::CDSoundEngine - validateBufferId invalide buffer state %i",soundId);
+ return NO;
+ } else {
+ return YES;
+ }
+}
+
+-(float) bufferDurationInSeconds:(int) soundId {
+ if ([self validateBufferId:soundId]) {
+ float factor = 0.0f;
+ switch (_buffers[soundId].format) {
+ case AL_FORMAT_MONO8:
+ factor = 1.0f;
+ break;
+ case AL_FORMAT_MONO16:
+ factor = 0.5f;
+ break;
+ case AL_FORMAT_STEREO8:
+ factor = 0.5f;
+ break;
+ case AL_FORMAT_STEREO16:
+ factor = 0.25f;
+ break;
+ }
+ return (float)_buffers[soundId].sizeInBytes/(float)_buffers[soundId].frequencyInHertz * factor;
+ } else {
+ return -1.0f;
+ }
+}
+
+-(ALsizei) bufferSizeInBytes:(int) soundId {
+ if ([self validateBufferId:soundId]) {
+ return _buffers[soundId].sizeInBytes;
+ } else {
+ return -1.0f;
+ }
+}
+
+-(ALsizei) bufferFrequencyInHertz:(int) soundId {
+ if ([self validateBufferId:soundId]) {
+ return _buffers[soundId].frequencyInHertz;
+ } else {
+ return -1.0f;
+ }
+}
+
+- (ALfloat) masterGain {
+ if (mute_) {
+ //When mute the real gain will always be 0 therefore return the preMuteGain value
+ return _preMuteGain;
+ } else {
+ ALfloat gain;
+ alGetListenerf(AL_GAIN, &gain);
+ return gain;
+ }
+}
+
+/**
+ * Overall gain setting multiplier. e.g 0.5 is half the gain.
+ */
+- (void) setMasterGain:(ALfloat) newGainValue {
+ if (mute_) {
+ _preMuteGain = newGainValue;
+ } else {
+ alListenerf(AL_GAIN, newGainValue);
+ }
+}
+
+#pragma mark CDSoundEngine AudioInterrupt protocol
+- (BOOL) mute {
+ return mute_;
+}
+
+/**
+ * Setting mute silences all sounds but playing sounds continue to advance playback
+ */
+- (void) setMute:(BOOL) newMuteValue {
+
+ if (newMuteValue == mute_) {
+ return;
+ }
+
+ mute_ = newMuteValue;
+ if (mute_) {
+ //Remember what the gain was
+ _preMuteGain = self.masterGain;
+ //Set gain to 0 - do not use the property as this will adjust preMuteGain when muted
+ alListenerf(AL_GAIN, 0.0f);
+ } else {
+ //Restore gain to what it was before being muted
+ self.masterGain = _preMuteGain;
+ }
+}
+
+- (BOOL) enabled {
+ return enabled_;
+}
+
+- (void) setEnabled:(BOOL)enabledValue
+{
+ if (enabled_ == enabledValue) {
+ return;
+ }
+ enabled_ = enabledValue;
+ if (enabled_ == NO) {
+ [self stopAllSounds];
+ }
+}
+
+-(void) _lockSource:(int) sourceIndex lock:(BOOL) lock {
+ BOOL found = NO;
+ for (int i=0; i < _sourceGroupTotal && !found; i++) {
+ if (_sourceGroups[i].sourceStatuses) {
+ for (int j=0; j < _sourceGroups[i].totalSources && !found; j++) {
+ //First bit is used to indicate whether source is locked, index is shifted back 1 bit
+ if((_sourceGroups[i].sourceStatuses[j] >> 1)==sourceIndex) {
+ if (lock) {
+ //Set first bit to lock this source
+ _sourceGroups[i].sourceStatuses[j] |= 1;
+ } else {
+ //Unset first bit to unlock this source
+ _sourceGroups[i].sourceStatuses[j] &= ~1;
+ }
+ found = YES;
+ }
+ }
+ }
+ }
+}
+
+-(int) _getSourceIndexForSourceGroup:(int)sourceGroupId
+{
+ //Ensure source group id is valid to prevent memory corruption
+ if (sourceGroupId < 0 || sourceGroupId >= _sourceGroupTotal) {
+ CDLOG(@"Denshion::CDSoundEngine invalid source group id %i",sourceGroupId);
+ return CD_NO_SOURCE;
+ }
+
+ int sourceIndex = -1;//Using -1 to indicate no source found
+ BOOL complete = NO;
+ ALint sourceState = 0;
+ sourceGroup *thisSourceGroup = &_sourceGroups[sourceGroupId];
+ thisSourceGroup->currentIndex = thisSourceGroup->startIndex;
+ while (!complete) {
+ //Iterate over sources looking for one that is not locked, first bit indicates if source is locked
+ if ((thisSourceGroup->sourceStatuses[thisSourceGroup->currentIndex] & 1) == 0) {
+ //This source is not locked
+ sourceIndex = thisSourceGroup->sourceStatuses[thisSourceGroup->currentIndex] >> 1;//shift back to get the index
+ if (thisSourceGroup->nonInterruptible) {
+ //Check if this source is playing, if so it can't be interrupted
+ alGetSourcei(_sources[sourceIndex].sourceId, AL_SOURCE_STATE, &sourceState);
+ if (sourceState != AL_PLAYING) {
+ //complete = YES;
+ //Set start index so next search starts at the next position
+ thisSourceGroup->startIndex = thisSourceGroup->currentIndex + 1;
+ break;
+ } else {
+ sourceIndex = -1;//The source index was no good because the source was playing
+ }
+ } else {
+ //complete = YES;
+ //Set start index so next search starts at the next position
+ thisSourceGroup->startIndex = thisSourceGroup->currentIndex + 1;
+ break;
+ }
+ }
+ thisSourceGroup->currentIndex++;
+ if (thisSourceGroup->currentIndex >= thisSourceGroup->totalSources) {
+ //Reset to the beginning
+ thisSourceGroup->currentIndex = 0;
+ }
+ if (thisSourceGroup->currentIndex == thisSourceGroup->startIndex) {
+ //We have looped around and got back to the start
+ complete = YES;
+ }
+ }
+
+ //Reset start index to beginning if beyond bounds
+ if (thisSourceGroup->startIndex >= thisSourceGroup->totalSources) {
+ thisSourceGroup->startIndex = 0;
+ }
+
+ if (sourceIndex >= 0) {
+ return sourceIndex;
+ } else {
+ return CD_NO_SOURCE;
+ }
+
+}
+
+/**
+ * Play a sound.
+ * @param soundId the id of the sound to play (buffer id).
+ * @param SourceGroupId the source 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 sourceGroupId:(int)sourceGroupId 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 < bufferTotal, @"soundId exceeds limit");
+ NSAssert(sourceGroupId >= 0, @"sourceGroupId can not be negative");
+ NSAssert(sourceGroupId < _sourceGroupTotal, @"sourceGroupId 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 (!enabled_ || !functioning_ || _buffers[soundId].bufferState != CD_BS_LOADED || _sourceGroups[sourceGroupId].enabled) {
+#ifdef CD_DEBUG
+ if (!functioning_) {
+ CDLOGINFO(@"Denshion::CDSoundEngine - sound playback aborted because sound engine is not functioning");
+ } else if (_buffers[soundId].bufferState != CD_BS_LOADED) {
+ CDLOGINFO(@"Denshion::CDSoundEngine - sound playback aborted because buffer %i is not loaded", soundId);
+ }
+#endif
+ return CD_MUTE;
+ }
+
+ int sourceIndex = [self _getSourceIndexForSourceGroup:sourceGroupId];//This method ensures sourceIndex is valid
+
+ if (sourceIndex != CD_NO_SOURCE) {
+ ALint state;
+ ALuint source = _sources[sourceIndex].sourceId;
+ ALuint buffer = _buffers[soundId].bufferId;
+ alGetError();//Clear the error code
+ alGetSourcei(source, AL_SOURCE_STATE, &state);
+ if (state == AL_PLAYING) {
+ alSourceStop(source);
+ }
+ alSourcei(source, AL_BUFFER, buffer);//Attach to sound
+ alSourcef(source, AL_PITCH, pitch);//Set pitch
+ alSourcei(source, AL_LOOPING, loop);//Set looping
+ alSourcef(source, AL_GAIN, gain);//Set gain/volume
+ float sourcePosAL[] = {pan, 0.0f, 0.0f};//Set position - just using left and right panning
+ alSourcefv(source, AL_POSITION, sourcePosAL);
+ alGetError();//Clear the error code
+ alSourcePlay(source);
+ if((lastErrorCode_ = alGetError()) == AL_NO_ERROR) {
+ //Everything was okay
+ _sources[sourceIndex].attachedBufferId = buffer;
+ return source;
+ } else {
+ if (alcGetCurrentContext() == NULL) {
+ CDLOGINFO(@"Denshion::CDSoundEngine - posting bad OpenAL context message");
+ [[NSNotificationCenter defaultCenter] postNotificationName:kCDN_BadAlContext object:nil];
+ }
+ return CD_NO_SOURCE;
+ }
+ } else {
+ return CD_NO_SOURCE;
+ }
+}
+
+-(BOOL) _soundSourceAttachToBuffer:(CDSoundSource*) soundSource soundId:(int) soundId {
+ //Attach the source to the buffer
+ ALint state;
+ ALuint source = soundSource->_sourceId;
+ ALuint buffer = _buffers[soundId].bufferId;
+ alGetSourcei(source, AL_SOURCE_STATE, &state);
+ if (state == AL_PLAYING) {
+ alSourceStop(source);
+ }
+ alGetError();//Clear the error code
+ alSourcei(source, AL_BUFFER, buffer);//Attach to sound data
+ if((lastErrorCode_ = alGetError()) == AL_NO_ERROR) {
+ _sources[soundSource->_sourceIndex].attachedBufferId = buffer;
+ //_sourceBufferAttachments[soundSource->_sourceIndex] = buffer;//Keep track of which
+ soundSource->_soundId = soundId;
+ return YES;
+ } else {
+ return NO;
+ }
+}
+
+/**
+ * Get a sound source for the specified sound in the specified source group
+ */
+-(CDSoundSource *) soundSourceForSound:(int) soundId sourceGroupId:(int) sourceGroupId
+{
+ if (!functioning_) {
+ return nil;
+ }
+ //Check if a source is available
+ int sourceIndex = [self _getSourceIndexForSourceGroup:sourceGroupId];
+ if (sourceIndex != CD_NO_SOURCE) {
+ CDSoundSource *result = [[CDSoundSource alloc] init:_sources[sourceIndex].sourceId sourceIndex:sourceIndex soundEngine:self];
+ [self _lockSource:sourceIndex lock:YES];
+ //Try to attach to the buffer
+ if ([self _soundSourceAttachToBuffer:result soundId:soundId]) {
+ //Set to a known state
+ result.pitch = 1.0f;
+ result.pan = 0.0f;
+ result.gain = 1.0f;
+ result.looping = NO;
+ return [result autorelease];
+ } else {
+ //Release the sound source we just created, this will also unlock the source
+ [result release];
+ return nil;
+ }
+ } else {
+ //No available source within that source group
+ return nil;
+ }
+}
+
+-(void) _soundSourcePreRelease:(CDSoundSource *) soundSource {
+ CDLOGINFO(@"Denshion::CDSoundEngine _soundSourcePreRelease %i",soundSource->_sourceIndex);
+ //Unlock the sound source's source
+ [self _lockSource:soundSource->_sourceIndex lock:NO];
+}
+
+/**
+ * Stop all sounds playing within a source group
+ */
+- (void) stopSourceGroup:(int) sourceGroupId {
+
+ if (!functioning_ || sourceGroupId >= _sourceGroupTotal || sourceGroupId < 0) {
+ return;
+ }
+ int sourceCount = _sourceGroups[sourceGroupId].totalSources;
+ for (int i=0; i < sourceCount; i++) {
+ int sourceIndex = _sourceGroups[sourceGroupId].sourceStatuses[i] >> 1;
+ alSourceStop(_sources[sourceIndex].sourceId);
+ }
+ 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 < sourceTotal_; i++) {
+ alSourceStop(_sources[i].sourceId);
+ }
+ alGetError();//Clear error in case we stopped any sounds that couldn't be stopped
+}
+
+/**
+ * Set a source group as non interruptible. Default is that source groups are interruptible.
+ * Non interruptible means that if a request to play a sound is made for a source group and there are
+ * no free sources available then the play request will be ignored and CD_NO_SOURCE will be returned.
+ */
+- (void) setSourceGroupNonInterruptible:(int) sourceGroupId isNonInterruptible:(BOOL) isNonInterruptible {
+ //Ensure source group id is valid to prevent memory corruption
+ if (sourceGroupId < 0 || sourceGroupId >= _sourceGroupTotal) {
+ CDLOG(@"Denshion::CDSoundEngine setSourceGroupNonInterruptible invalid source group id %i",sourceGroupId);
+ return;
+ }
+
+ if (isNonInterruptible) {
+ _sourceGroups[sourceGroupId].nonInterruptible = true;
+ } else {
+ _sourceGroups[sourceGroupId].nonInterruptible = false;
+ }
+}
+
+/**
+ * Set the mute property for a source group. If mute is turned on any sounds in that source group
+ * will be stopped and further sounds in that source 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 source group mute setting is.
+ */
+- (void) setSourceGroupEnabled:(int) sourceGroupId enabled:(BOOL) enabled {
+ //Ensure source group id is valid to prevent memory corruption
+ if (sourceGroupId < 0 || sourceGroupId >= _sourceGroupTotal) {
+ CDLOG(@"Denshion::CDSoundEngine setSourceGroupEnabled invalid source group id %i",sourceGroupId);
+ return;
+ }
+
+ if (enabled) {
+ _sourceGroups[sourceGroupId].enabled = true;
+ [self stopSourceGroup:sourceGroupId];
+ } else {
+ _sourceGroups[sourceGroupId].enabled = false;
+ }
+}
+
+/**
+ * Return the mute property for the source group identified by sourceGroupId
+ */
+- (BOOL) sourceGroupEnabled:(int) sourceGroupId {
+ return _sourceGroups[sourceGroupId].enabled;
+}
+
+-(ALCcontext *) openALContext {
+ return context;
+}
+
+- (void) _dumpSourceGroupsInfo {
+#ifdef CD_DEBUG
+ CDLOGINFO(@"-------------- source Group Info --------------");
+ for (int i=0; i < _sourceGroupTotal; i++) {
+ CDLOGINFO(@"Group: %i start:%i total:%i",i,_sourceGroups[i].startIndex, _sourceGroups[i].totalSources);
+ CDLOGINFO(@"----- mute:%i nonInterruptible:%i",_sourceGroups[i].enabled, _sourceGroups[i].nonInterruptible);
+ CDLOGINFO(@"----- Source statuses ----");
+ for (int j=0; j < _sourceGroups[i].totalSources; j++) {
+ CDLOGINFO(@"Source status:%i index=%i locked=%i",j,_sourceGroups[i].sourceStatuses[j] >> 1, _sourceGroups[i].sourceStatuses[j] & 1);
+ }
+ }
+#endif
+}
+
+@end
+
+///////////////////////////////////////////////////////////////////////////////////////
+@implementation CDSoundSource
+
+@synthesize lastError;
+
+//Macro for handling the al error code
+#define CDSOUNDSOURCE_UPDATE_LAST_ERROR (lastError = alGetError())
+#define CDSOUNDSOURCE_ERROR_HANDLER ( CDSOUNDSOURCE_UPDATE_LAST_ERROR == AL_NO_ERROR)
+
+-(id)init:(ALuint) theSourceId sourceIndex:(int) index soundEngine:(CDSoundEngine*) engine {
+ if ((self = [super init])) {
+ _sourceId = theSourceId;
+ _engine = engine;
+ _sourceIndex = index;
+ enabled_ = YES;
+ mute_ = NO;
+ _preMuteGain = self.gain;
+ }
+ return self;
+}
+
+-(void) dealloc
+{
+ CDLOGINFO(@"Denshion::CDSoundSource deallocated %i",self->_sourceIndex);
+
+ //Notify sound engine we are about to release
+ [_engine _soundSourcePreRelease:self];
+ [super dealloc];
+}
+
+- (void) setPitch:(float) newPitchValue {
+ alSourcef(_sourceId, AL_PITCH, newPitchValue);
+ CDSOUNDSOURCE_UPDATE_LAST_ERROR;
+}
+
+- (void) setGain:(float) newGainValue {
+ if (!mute_) {
+ alSourcef(_sourceId, AL_GAIN, newGainValue);
+ } else {
+ _preMuteGain = newGainValue;
+ }
+ CDSOUNDSOURCE_UPDATE_LAST_ERROR;
+}
+
+- (void) setPan:(float) newPanValue {
+ float sourcePosAL[] = {newPanValue, 0.0f, 0.0f};//Set position - just using left and right panning
+ alSourcefv(_sourceId, AL_POSITION, sourcePosAL);
+ CDSOUNDSOURCE_UPDATE_LAST_ERROR;
+
+}
+
+- (void) setLooping:(BOOL) newLoopingValue {
+ alSourcei(_sourceId, AL_LOOPING, newLoopingValue);
+ CDSOUNDSOURCE_UPDATE_LAST_ERROR;
+
+}
+
+- (BOOL) isPlaying {
+ ALint state;
+ alGetSourcei(_sourceId, AL_SOURCE_STATE, &state);
+ CDSOUNDSOURCE_UPDATE_LAST_ERROR;
+ return (state == AL_PLAYING);
+}
+
+- (float) pitch {
+ ALfloat pitchVal;
+ alGetSourcef(_sourceId, AL_PITCH, &pitchVal);
+ CDSOUNDSOURCE_UPDATE_LAST_ERROR;
+ return pitchVal;
+}
+
+- (float) pan {
+ ALfloat sourcePosAL[] = {0.0f,0.0f,0.0f};
+ alGetSourcefv(_sourceId, AL_POSITION, sourcePosAL);
+ CDSOUNDSOURCE_UPDATE_LAST_ERROR;
+ return sourcePosAL[0];
+}
+
+- (float) gain {
+ if (!mute_) {
+ ALfloat val;
+ alGetSourcef(_sourceId, AL_GAIN, &val);
+ CDSOUNDSOURCE_UPDATE_LAST_ERROR;
+ return val;
+ } else {
+ return _preMuteGain;
+ }
+}
+
+- (BOOL) looping {
+ ALfloat val;
+ alGetSourcef(_sourceId, AL_LOOPING, &val);
+ CDSOUNDSOURCE_UPDATE_LAST_ERROR;
+ return val;
+}
+
+-(BOOL) stop {
+ alSourceStop(_sourceId);
+ return CDSOUNDSOURCE_ERROR_HANDLER;
+}
+
+-(BOOL) play {
+ if (enabled_) {
+ alSourcePlay(_sourceId);
+ CDSOUNDSOURCE_UPDATE_LAST_ERROR;
+ if (lastError != AL_NO_ERROR) {
+ if (alcGetCurrentContext() == NULL) {
+ CDLOGINFO(@"Denshion::CDSoundSource - posting bad OpenAL context message");
+ [[NSNotificationCenter defaultCenter] postNotificationName:kCDN_BadAlContext object:nil];
+ }
+ return NO;
+ } else {
+ return YES;
+ }
+ } else {
+ return NO;
+ }
+}
+
+-(BOOL) pause {
+ alSourcePause(_sourceId);
+ return CDSOUNDSOURCE_ERROR_HANDLER;
+}
+
+-(BOOL) rewind {
+ alSourceRewind(_sourceId);
+ return CDSOUNDSOURCE_ERROR_HANDLER;
+}
+
+-(void) setSoundId:(int) soundId {
+ [_engine _soundSourceAttachToBuffer:self soundId:soundId];
+}
+
+-(int) soundId {
+ return _soundId;
+}
+
+-(float) durationInSeconds {
+ return [_engine bufferDurationInSeconds:_soundId];
+}
+
+#pragma mark CDSoundSource AudioInterrupt protocol
+- (BOOL) mute {
+ return mute_;
+}
+
+/**
+ * Setting mute silences all sounds but playing sounds continue to advance playback
+ */
+- (void) setMute:(BOOL) newMuteValue {
+
+ if (newMuteValue == mute_) {
+ return;
+ }
+
+ if (newMuteValue) {
+ //Remember what the gain was
+ _preMuteGain = self.gain;
+ self.gain = 0.0f;
+ mute_ = newMuteValue;//Make sure this is done after setting the gain property as the setter behaves differently depending on mute value
+ } else {
+ //Restore gain to what it was before being muted
+ mute_ = newMuteValue;
+ self.gain = _preMuteGain;
+ }
+}
+
+- (BOOL) enabled {
+ return enabled_;
+}
+
+- (void) setEnabled:(BOOL)enabledValue
+{
+ if (enabled_ == enabledValue) {
+ return;
+ }
+ enabled_ = enabledValue;
+ if (enabled_ == NO) {
+ [self stop];
+ }
+}
+
+@end
+
+////////////////////////////////////////////////////////////////////////////
+#pragma mark -
+#pragma mark CDAudioInterruptTargetGroup
+
+@implementation CDAudioInterruptTargetGroup
+
+-(id) init {
+ if ((self = [super init])) {
+ children_ = [[NSMutableArray alloc] initWithCapacity:32];
+ enabled_ = YES;
+ mute_ = NO;
+ }
+ return self;
+}
+
+-(void) addAudioInterruptTarget:(NSObject<CDAudioInterruptProtocol>*) interruptibleTarget {
+ //Synchronize child with group settings;
+ [interruptibleTarget setMute:mute_];
+ [interruptibleTarget setEnabled:enabled_];
+ [children_ addObject:interruptibleTarget];
+}
+
+-(void) removeAudioInterruptTarget:(NSObject<CDAudioInterruptProtocol>*) interruptibleTarget {
+ [children_ removeObjectIdenticalTo:interruptibleTarget];
+}
+
+- (BOOL) mute {
+ return mute_;
+}
+
+/**
+ * Setting mute silences all sounds but playing sounds continue to advance playback
+ */
+- (void) setMute:(BOOL) newMuteValue {
+
+ if (newMuteValue == mute_) {
+ return;
+ }
+
+ for (NSObject<CDAudioInterruptProtocol>* target in children_) {
+ [target setMute:newMuteValue];
+ }
+}
+
+- (BOOL) enabled {
+ return enabled_;
+}
+
+- (void) setEnabled:(BOOL)enabledValue
+{
+ if (enabledValue == enabled_) {
+ return;
+ }
+
+ for (NSObject<CDAudioInterruptProtocol>* target in children_) {
+ [target setEnabled:enabledValue];
+ }
+}
+
+@end
+
+
+
+////////////////////////////////////////////////////////////////////////////
+
+#pragma mark -
+#pragma mark CDAsynchBufferLoader
+
+@implementation CDAsynchBufferLoader
+
+-(id) init:(NSArray *)loadRequests soundEngine:(CDSoundEngine *) theSoundEngine {
+ if ((self = [super init])) {
+ _loadRequests = loadRequests;
+ [_loadRequests retain];
+ _soundEngine = theSoundEngine;
+ [_soundEngine retain];
+ }
+ return self;
+}
+
+-(void) main {
+ CDLOGINFO(@"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;
+ [[NSNotificationCenter defaultCenter] postNotificationName:kCDN_AsynchLoadComplete object:nil];
+
+}
+
+-(void) dealloc {
+ [_loadRequests release];
+ [_soundEngine release];
+ [super dealloc];
+}
+
+@end
+
+
+///////////////////////////////////////////////////////////////////////////////////////
+#pragma mark -
+#pragma mark CDBufferLoadRequest
+
+@implementation CDBufferLoadRequest
+
+@synthesize filePath, soundId;
+
+-(id) init:(int) theSoundId filePath:(const NSString *) theFilePath {
+ if ((self = [super init])) {
+ soundId = theSoundId;
+ filePath = [theFilePath copy];//TODO: is retain necessary or does copy set retain count
+ [filePath retain];
+ }
+ return self;
+}
+
+-(void) dealloc {
+ [filePath release];
+ [super dealloc];
+}
+
+@end
+
+///////////////////////////////////////////////////////////////////////////////////////
+#pragma mark -
+#pragma mark CDFloatInterpolator
+
+@implementation CDFloatInterpolator
+@synthesize start,end,interpolationType;
+
+-(float) interpolate:(float) t {
+
+ if (t < 1.0f) {
+ switch (interpolationType) {
+ case kIT_Linear:
+ //Linear interpolation
+ return ((end - start) * t) + start;
+
+ case kIT_SCurve:
+ //Cubic s curve t^2 * (3 - 2t)
+ return ((float)(t * t * (3.0 - (2.0 * t))) * (end - start)) + start;
+
+ case kIT_Exponential:
+ //Formulas taken from EaseAction
+ if (end > start) {
+ //Fade in
+ float logDelta = (t==0) ? 0 : powf(2, 10 * (t/1 - 1)) - 1 * 0.001f;
+ return ((end - start) * logDelta) + start;
+ } else {
+ //Fade Out
+ float logDelta = (-powf(2, -10 * t/1) + 1);
+ return ((end - start) * logDelta) + start;
+ }
+ default:
+ return 0.0f;
+ }
+ } else {
+ return end;
+ }
+}
+
+-(id) init:(tCDInterpolationType) type startVal:(float) startVal endVal:(float) endVal {
+ if ((self = [super init])) {
+ start = startVal;
+ end = endVal;
+ interpolationType = type;
+ }
+ return self;
+}
+
+@end
+
+///////////////////////////////////////////////////////////////////////////////////////
+#pragma mark -
+#pragma mark CDPropertyModifier
+
+@implementation CDPropertyModifier
+
+@synthesize stopTargetWhenComplete;
+
+-(id) init:(id) theTarget interpolationType:(tCDInterpolationType) type startVal:(float) startVal endVal:(float) endVal {
+ if ((self = [super init])) {
+ if (target) {
+ //Release the previous target if there is one
+ [target release];
+ }
+ target = theTarget;
+#if CD_DEBUG
+ //Check target is of the required type
+ if (![theTarget isMemberOfClass:[self _allowableType]] ) {
+ CDLOG(@"Denshion::CDPropertyModifier target is not of type %@",[self _allowableType]);
+ NSAssert([theTarget isKindOfClass:[CDSoundEngine class]], @"CDPropertyModifier target not of required type");
+ }
+#endif
+ [target retain];
+ startValue = startVal;
+ endValue = endVal;
+ if (interpolator) {
+ //Release previous interpolator if there is one
+ [interpolator release];
+ }
+ interpolator = [[CDFloatInterpolator alloc] init:type startVal:startVal endVal:endVal];
+ stopTargetWhenComplete = NO;
+ }
+ return self;
+}
+
+-(void) dealloc {
+ CDLOGINFO(@"Denshion::CDPropertyModifier deallocated %@",self);
+ [target release];
+ [interpolator release];
+ [super dealloc];
+}
+
+-(void) modify:(float) t {
+ if (t < 1.0) {
+ [self _setTargetProperty:[interpolator interpolate:t]];
+ } else {
+ //At the end
+ [self _setTargetProperty:endValue];
+ if (stopTargetWhenComplete) {
+ [self _stopTarget];
+ }
+ }
+}
+
+-(float) startValue {
+ return startValue;
+}
+
+-(void) setStartValue:(float) startVal
+{
+ startValue = startVal;
+ interpolator.start = startVal;
+}
+
+-(float) endValue {
+ return startValue;
+}
+
+-(void) setEndValue:(float) endVal
+{
+ endValue = endVal;
+ interpolator.end = endVal;
+}
+
+-(tCDInterpolationType) interpolationType {
+ return interpolator.interpolationType;
+}
+
+-(void) setInterpolationType:(tCDInterpolationType) interpolationType {
+ interpolator.interpolationType = interpolationType;
+}
+
+-(void) _setTargetProperty:(float) newVal {
+
+}
+
+-(float) _getTargetProperty {
+ return 0.0f;
+}
+
+-(void) _stopTarget {
+
+}
+
+-(Class) _allowableType {
+ return [NSObject class];
+}
+@end
+
+///////////////////////////////////////////////////////////////////////////////////////
+#pragma mark -
+#pragma mark CDSoundSourceFader
+
+@implementation CDSoundSourceFader
+
+-(void) _setTargetProperty:(float) newVal {
+ ((CDSoundSource*)target).gain = newVal;
+}
+
+-(float) _getTargetProperty {
+ return ((CDSoundSource*)target).gain;
+}
+
+-(void) _stopTarget {
+ [((CDSoundSource*)target) stop];
+}
+
+-(Class) _allowableType {
+ return [CDSoundSource class];
+}
+
+@end
+
+///////////////////////////////////////////////////////////////////////////////////////
+#pragma mark -
+#pragma mark CDSoundSourcePanner
+
+@implementation CDSoundSourcePanner
+
+-(void) _setTargetProperty:(float) newVal {
+ ((CDSoundSource*)target).pan = newVal;
+}
+
+-(float) _getTargetProperty {
+ return ((CDSoundSource*)target).pan;
+}
+
+-(void) _stopTarget {
+ [((CDSoundSource*)target) stop];
+}
+
+-(Class) _allowableType {
+ return [CDSoundSource class];
+}
+
+@end
+
+///////////////////////////////////////////////////////////////////////////////////////
+#pragma mark -
+#pragma mark CDSoundSourcePitchBender
+
+@implementation CDSoundSourcePitchBender
+
+-(void) _setTargetProperty:(float) newVal {
+ ((CDSoundSource*)target).pitch = newVal;
+}
+
+-(float) _getTargetProperty {
+ return ((CDSoundSource*)target).pitch;
+}
+
+-(void) _stopTarget {
+ [((CDSoundSource*)target) stop];
+}
+
+-(Class) _allowableType {
+ return [CDSoundSource class];
+}
+
+@end
+
+///////////////////////////////////////////////////////////////////////////////////////
+#pragma mark -
+#pragma mark CDSoundEngineFader
+
+@implementation CDSoundEngineFader
+
+-(void) _setTargetProperty:(float) newVal {
+ ((CDSoundEngine*)target).masterGain = newVal;
+}
+
+-(float) _getTargetProperty {
+ return ((CDSoundEngine*)target).masterGain;
+}
+
+-(void) _stopTarget {
+ [((CDSoundEngine*)target) stopAllSounds];
+}
+
+-(Class) _allowableType {
+ return [CDSoundEngine class];
+}
+
+@end
+
+
--- /dev/null
+/*
+ Copyright (c) 2010 Steve Oldmeadow
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+
+ $Id$
+ */
+
+
+#import "CDAudioManager.h"
+
+/**
+ A wrapper to the CDAudioManager object.
+ This is recommended for basic audio requirements. If you just want to play some sound fx
+ and some background music and have no interest in learning the lower level workings then
+ this is the interface to use.
+
+ Requirements:
+ - Firmware: OS 2.2 or greater
+ - Files: SimpleAudioEngine.*, CocosDenshion.*
+ - Frameworks: OpenAL, AudioToolbox, AVFoundation
+ @since v0.8
+ */
+@interface SimpleAudioEngine : NSObject <CDAudioInterruptProtocol> {
+
+ BOOL mute_;
+ BOOL enabled_;
+}
+
+/** Background music volume. Range is 0.0f to 1.0f. This will only have an effect if willPlayBackgroundMusic returns YES */
+@property (readwrite) float backgroundMusicVolume;
+/** Effects volume. Range is 0.0f to 1.0f */
+@property (readwrite) float effectsVolume;
+/** If NO it indicates background music will not be played either because no background music is loaded or the audio session does not permit it.*/
+@property (readonly) BOOL willPlayBackgroundMusic;
+
+/** returns the shared instance of the SimpleAudioEngine object */
++ (SimpleAudioEngine*) sharedEngine;
+
+/** Preloads a music file so it will be ready to play as background music */
+-(void) preloadBackgroundMusic:(NSString*) filePath;
+
+/** plays background music in a loop*/
+-(void) playBackgroundMusic:(NSString*) filePath;
+/** plays background music, if loop is true the music will repeat otherwise it will be played once */
+-(void) playBackgroundMusic:(NSString*) filePath loop:(BOOL) loop;
+/** stops playing background music */
+-(void) stopBackgroundMusic;
+/** pauses the background music */
+-(void) pauseBackgroundMusic;
+/** resume background music that has been paused */
+-(void) resumeBackgroundMusic;
+/** rewind the background music */
+-(void) rewindBackgroundMusic;
+/** returns whether or not the background music is playing */
+-(BOOL) isBackgroundMusicPlaying;
+
+/** plays an audio effect with a file path*/
+-(ALuint) playEffect:(NSString*) filePath;
+/** stop a sound that is playing, note you must pass in the soundId that is returned when you started playing the sound with playEffect */
+-(void) stopEffect:(ALuint) soundId;
+/** plays an audio effect with a file path, pitch, pan and gain */
+-(ALuint) playEffect:(NSString*) filePath pitch:(Float32) pitch pan:(Float32) pan gain:(Float32) gain;
+/** preloads an audio effect */
+-(void) preloadEffect:(NSString*) filePath;
+/** unloads an audio effect from memory */
+-(void) unloadEffect:(NSString*) filePath;
+/** Gets a CDSoundSource object set up to play the specified file. */
+-(CDSoundSource *) soundSourceForFile:(NSString*) filePath;
+
+/** Shuts down the shared audio engine instance so that it can be reinitialised */
++(void) end;
+
+@end
--- /dev/null
+/*
+ Copyright (c) 2010 Steve Oldmeadow
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+
+ $Id$
+ */
+
+#import "SimpleAudioEngine.h"
+
+@implementation SimpleAudioEngine
+
+static SimpleAudioEngine *sharedEngine = nil;
+static CDSoundEngine* soundEngine = nil;
+static CDAudioManager *am = nil;
+static CDBufferManager *bufferManager = nil;
+
+// Init
++ (SimpleAudioEngine *) sharedEngine
+{
+ @synchronized(self) {
+ if (!sharedEngine)
+ sharedEngine = [[SimpleAudioEngine alloc] init];
+ }
+ return sharedEngine;
+}
+
++ (id) alloc
+{
+ @synchronized(self) {
+ NSAssert(sharedEngine == nil, @"Attempted to allocate a second instance of a singleton.");
+ return [super alloc];
+ }
+ return nil;
+}
+
+-(id) init
+{
+ if((self=[super init])) {
+ am = [CDAudioManager sharedManager];
+ soundEngine = am.soundEngine;
+ bufferManager = [[CDBufferManager alloc] initWithEngine:soundEngine];
+ mute_ = NO;
+ enabled_ = YES;
+ }
+ return self;
+}
+
+// Memory
+- (void) dealloc
+{
+ am = nil;
+ soundEngine = nil;
+ bufferManager = nil;
+ [super dealloc];
+}
+
++(void) end
+{
+ am = nil;
+ [CDAudioManager end];
+ [bufferManager release];
+ [sharedEngine release];
+ sharedEngine = nil;
+}
+
+#pragma mark SimpleAudioEngine - background music
+
+-(void) preloadBackgroundMusic:(NSString*) filePath {
+ [am preloadBackgroundMusic:filePath];
+}
+
+-(void) playBackgroundMusic:(NSString*) filePath
+{
+ [am playBackgroundMusic:filePath loop:TRUE];
+}
+
+-(void) playBackgroundMusic:(NSString*) filePath loop:(BOOL) loop
+{
+ [am playBackgroundMusic:filePath loop:loop];
+}
+
+-(void) stopBackgroundMusic
+{
+ [am stopBackgroundMusic];
+}
+
+-(void) pauseBackgroundMusic {
+ [am pauseBackgroundMusic];
+}
+
+-(void) resumeBackgroundMusic {
+ [am resumeBackgroundMusic];
+}
+
+-(void) rewindBackgroundMusic {
+ [am rewindBackgroundMusic];
+}
+
+-(BOOL) isBackgroundMusicPlaying {
+ return [am isBackgroundMusicPlaying];
+}
+
+-(BOOL) willPlayBackgroundMusic {
+ return [am willPlayBackgroundMusic];
+}
+
+#pragma mark SimpleAudioEngine - sound effects
+
+-(ALuint) playEffect:(NSString*) filePath
+{
+ return [self playEffect:filePath pitch:1.0f pan:0.0f gain:1.0f];
+}
+
+-(ALuint) playEffect:(NSString*) filePath pitch:(Float32) pitch pan:(Float32) pan gain:(Float32) gain
+{
+ int soundId = [bufferManager bufferForFile:filePath create:YES];
+ if (soundId != kCDNoBuffer) {
+ return [soundEngine playSound:soundId sourceGroupId:0 pitch:pitch pan:pan gain:gain loop:false];
+ } else {
+ return CD_MUTE;
+ }
+}
+
+-(void) stopEffect:(ALuint) soundId {
+ [soundEngine stopSound:soundId];
+}
+
+-(void) preloadEffect:(NSString*) filePath
+{
+ int soundId = [bufferManager bufferForFile:filePath create:YES];
+ if (soundId == kCDNoBuffer) {
+ CDLOG(@"Denshion::SimpleAudioEngine sound failed to preload %@",filePath);
+ }
+}
+
+-(void) unloadEffect:(NSString*) filePath
+{
+ CDLOGINFO(@"Denshion::SimpleAudioEngine unloadedEffect %@",filePath);
+ [bufferManager releaseBufferForFile:filePath];
+}
+
+#pragma mark Audio Interrupt Protocol
+-(BOOL) mute
+{
+ return mute_;
+}
+
+-(void) setMute:(BOOL) muteValue
+{
+ if (mute_ != muteValue) {
+ mute_ = muteValue;
+ am.mute = mute_;
+ }
+}
+
+-(BOOL) enabled
+{
+ return enabled_;
+}
+
+-(void) setEnabled:(BOOL) enabledValue
+{
+ if (enabled_ != enabledValue) {
+ enabled_ = enabledValue;
+ am.enabled = enabled_;
+ }
+}
+
+
+#pragma mark SimpleAudioEngine - BackgroundMusicVolume
+-(float) backgroundMusicVolume
+{
+ return am.backgroundMusic.volume;
+}
+
+-(void) setBackgroundMusicVolume:(float) volume
+{
+ am.backgroundMusic.volume = volume;
+}
+
+#pragma mark SimpleAudioEngine - EffectsVolume
+-(float) effectsVolume
+{
+ return am.soundEngine.masterGain;
+}
+
+-(void) setEffectsVolume:(float) volume
+{
+ am.soundEngine.masterGain = volume;
+}
+
+-(CDSoundSource *) soundSourceForFile:(NSString*) filePath {
+ int soundId = [bufferManager bufferForFile:filePath create:YES];
+ if (soundId != kCDNoBuffer) {
+ CDSoundSource *result = [soundEngine soundSourceForSound:soundId sourceGroupId:0];
+ CDLOGINFO(@"Denshion::SimpleAudioEngine sound source created for %@",filePath);
+ return result;
+ } else {
+ return nil;
+ }
+}
+
+@end
--- /dev/null
+//
+// FontLabel.h
+// FontLabel
+//
+// Created by Kevin Ballard on 5/8/09.
+// Copyright © 2009 Zynga Game Networks
+//
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// 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.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+#import <Foundation/Foundation.h>
+#import <UIKit/UIKit.h>
+
+@class ZFont;
+@class ZAttributedString;
+
+@interface FontLabel : UILabel {
+ void *reserved; // works around a bug in UILabel
+ ZFont *zFont;
+ ZAttributedString *zAttributedText;
+}
+@property (nonatomic, setter=setCGFont:) CGFontRef cgFont __AVAILABILITY_INTERNAL_DEPRECATED;
+@property (nonatomic, assign) CGFloat pointSize __AVAILABILITY_INTERNAL_DEPRECATED;
+@property (nonatomic, retain, setter=setZFont:) ZFont *zFont;
+// if attributedText is nil, fall back on using the inherited UILabel properties
+// if attributedText is non-nil, the font/text/textColor
+// in addition, adjustsFontSizeToFitWidth does not work with attributed text
+@property (nonatomic, copy) ZAttributedString *zAttributedText;
+// -initWithFrame:fontName:pointSize: uses FontManager to look up the font name
+- (id)initWithFrame:(CGRect)frame fontName:(NSString *)fontName pointSize:(CGFloat)pointSize;
+- (id)initWithFrame:(CGRect)frame zFont:(ZFont *)font;
+- (id)initWithFrame:(CGRect)frame font:(CGFontRef)font pointSize:(CGFloat)pointSize __AVAILABILITY_INTERNAL_DEPRECATED;
+@end
--- /dev/null
+//
+// FontLabel.m
+// FontLabel
+//
+// Created by Kevin Ballard on 5/8/09.
+// Copyright © 2009 Zynga Game Networks
+//
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// 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.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+#import "FontLabel.h"
+#import "FontManager.h"
+#import "FontLabelStringDrawing.h"
+#import "ZFont.h"
+
+@interface ZFont (ZFontPrivate)
+@property (nonatomic, readonly) CGFloat ratio;
+@end
+
+@implementation FontLabel
+@synthesize zFont;
+@synthesize zAttributedText;
+
+- (id)initWithFrame:(CGRect)frame fontName:(NSString *)fontName pointSize:(CGFloat)pointSize {
+ return [self initWithFrame:frame zFont:[[FontManager sharedManager] zFontWithName:fontName pointSize:pointSize]];
+}
+
+- (id)initWithFrame:(CGRect)frame zFont:(ZFont *)font {
+ if ((self = [super initWithFrame:frame])) {
+ zFont = [font retain];
+ }
+ return self;
+}
+
+- (id)initWithFrame:(CGRect)frame font:(CGFontRef)font pointSize:(CGFloat)pointSize {
+ return [self initWithFrame:frame zFont:[ZFont fontWithCGFont:font size:pointSize]];
+}
+
+- (CGFontRef)cgFont {
+ return self.zFont.cgFont;
+}
+
+- (void)setCGFont:(CGFontRef)font {
+ if (self.zFont.cgFont != font) {
+ self.zFont = [ZFont fontWithCGFont:font size:self.zFont.pointSize];
+ }
+}
+
+- (CGFloat)pointSize {
+ return self.zFont.pointSize;
+}
+
+- (void)setPointSize:(CGFloat)pointSize {
+ if (self.zFont.pointSize != pointSize) {
+ self.zFont = [ZFont fontWithCGFont:self.zFont.cgFont size:pointSize];
+ }
+}
+
+- (void)setZAttributedText:(ZAttributedString *)attStr {
+ if (zAttributedText != attStr) {
+ [zAttributedText release];
+ zAttributedText = [attStr copy];
+ [self setNeedsDisplay];
+ }
+}
+
+- (void)drawTextInRect:(CGRect)rect {
+ if (self.zFont == NULL && self.zAttributedText == nil) {
+ [super drawTextInRect:rect];
+ return;
+ }
+
+ if (self.zAttributedText == nil) {
+ // this method is documented as setting the text color for us, but that doesn't appear to be the case
+ if (self.highlighted) {
+ [(self.highlightedTextColor ?: [UIColor whiteColor]) setFill];
+ } else {
+ [(self.textColor ?: [UIColor blackColor]) setFill];
+ }
+
+ ZFont *actualFont = self.zFont;
+ CGSize origSize = rect.size;
+ if (self.numberOfLines == 1) {
+ origSize.height = actualFont.leading;
+ CGPoint point = CGPointMake(rect.origin.x,
+ rect.origin.y + roundf(((rect.size.height - actualFont.leading) / 2.0f)));
+ CGSize size = [self.text sizeWithZFont:actualFont];
+ if (self.adjustsFontSizeToFitWidth && self.minimumFontSize < actualFont.pointSize) {
+ if (size.width > origSize.width) {
+ CGFloat desiredRatio = (origSize.width * actualFont.ratio) / size.width;
+ CGFloat desiredPointSize = desiredRatio * actualFont.pointSize / actualFont.ratio;
+ actualFont = [actualFont fontWithSize:MAX(MAX(desiredPointSize, self.minimumFontSize), 1.0f)];
+ size = [self.text sizeWithZFont:actualFont];
+ }
+ if (!CGSizeEqualToSize(origSize, size)) {
+ switch (self.baselineAdjustment) {
+ case UIBaselineAdjustmentAlignCenters:
+ point.y += roundf((origSize.height - size.height) / 2.0f);
+ break;
+ case UIBaselineAdjustmentAlignBaselines:
+ point.y += (self.zFont.ascender - actualFont.ascender);
+ break;
+ case UIBaselineAdjustmentNone:
+ break;
+ }
+ }
+ }
+ size.width = MIN(size.width, origSize.width);
+ // adjust the point for alignment
+ switch (self.textAlignment) {
+ case UITextAlignmentLeft:
+ break;
+ case UITextAlignmentCenter:
+ point.x += (origSize.width - size.width) / 2.0f;
+ break;
+ case UITextAlignmentRight:
+ point.x += origSize.width - size.width;
+ break;
+ }
+ [self.text drawAtPoint:point forWidth:size.width withZFont:actualFont lineBreakMode:self.lineBreakMode];
+ } else {
+ CGSize size = [self.text sizeWithZFont:actualFont constrainedToSize:origSize lineBreakMode:self.lineBreakMode numberOfLines:self.numberOfLines];
+ CGPoint point = rect.origin;
+ point.y += roundf((rect.size.height - size.height) / 2.0f);
+ rect = (CGRect){point, CGSizeMake(rect.size.width, size.height)};
+ [self.text drawInRect:rect withZFont:actualFont lineBreakMode:self.lineBreakMode alignment:self.textAlignment numberOfLines:self.numberOfLines];
+ }
+ } else {
+ ZAttributedString *attStr = self.zAttributedText;
+ if (self.highlighted) {
+ // modify the string to change the base color
+ ZMutableAttributedString *mutStr = [[attStr mutableCopy] autorelease];
+ NSRange activeRange = NSMakeRange(0, attStr.length);
+ while (activeRange.length > 0) {
+ NSRange effective;
+ UIColor *color = [attStr attribute:ZForegroundColorAttributeName atIndex:activeRange.location
+ longestEffectiveRange:&effective inRange:activeRange];
+ if (color == nil) {
+ [mutStr addAttribute:ZForegroundColorAttributeName value:[UIColor whiteColor] range:effective];
+ }
+ activeRange.location += effective.length, activeRange.length -= effective.length;
+ }
+ attStr = mutStr;
+ }
+ CGSize size = [attStr sizeConstrainedToSize:rect.size lineBreakMode:self.lineBreakMode numberOfLines:self.numberOfLines];
+ CGPoint point = rect.origin;
+ point.y += roundf((rect.size.height - size.height) / 2.0f);
+ rect = (CGRect){point, CGSizeMake(rect.size.width, size.height)};
+ [attStr drawInRect:rect withLineBreakMode:self.lineBreakMode alignment:self.textAlignment numberOfLines:self.numberOfLines];
+ }
+}
+
+- (CGRect)textRectForBounds:(CGRect)bounds limitedToNumberOfLines:(NSInteger)numberOfLines {
+ if (self.zFont == NULL && self.zAttributedText == nil) {
+ return [super textRectForBounds:bounds limitedToNumberOfLines:numberOfLines];
+ }
+
+ if (numberOfLines == 1) {
+ // if numberOfLines == 1 we need to use the version that converts spaces
+ CGSize size;
+ if (self.zAttributedText == nil) {
+ size = [self.text sizeWithZFont:self.zFont];
+ } else {
+ size = [self.zAttributedText size];
+ }
+ bounds.size.width = MIN(bounds.size.width, size.width);
+ bounds.size.height = MIN(bounds.size.height, size.height);
+ } else {
+ if (numberOfLines > 0) bounds.size.height = MIN(bounds.size.height, self.zFont.leading * numberOfLines);
+ if (self.zAttributedText == nil) {
+ bounds.size = [self.text sizeWithZFont:self.zFont constrainedToSize:bounds.size lineBreakMode:self.lineBreakMode];
+ } else {
+ bounds.size = [self.zAttributedText sizeConstrainedToSize:bounds.size lineBreakMode:self.lineBreakMode];
+ }
+ }
+ return bounds;
+}
+
+- (void)dealloc {
+ [zFont release];
+ [zAttributedText release];
+ [super dealloc];
+}
+@end
--- /dev/null
+//
+// FontLabelStringDrawing.h
+// FontLabel
+//
+// Created by Kevin Ballard on 5/5/09.
+// Copyright © 2009 Zynga Game Networks
+//
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// 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.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+#import <UIKit/UIKit.h>
+#import "ZAttributedString.h"
+
+@class ZFont;
+
+@interface NSString (FontLabelStringDrawing)
+// CGFontRef-based methods
+- (CGSize)sizeWithCGFont:(CGFontRef)font pointSize:(CGFloat)pointSize __AVAILABILITY_INTERNAL_DEPRECATED;
+- (CGSize)sizeWithCGFont:(CGFontRef)font pointSize:(CGFloat)pointSize constrainedToSize:(CGSize)size __AVAILABILITY_INTERNAL_DEPRECATED;
+- (CGSize)sizeWithCGFont:(CGFontRef)font pointSize:(CGFloat)pointSize constrainedToSize:(CGSize)size
+ lineBreakMode:(UILineBreakMode)lineBreakMode __AVAILABILITY_INTERNAL_DEPRECATED;
+- (CGSize)drawAtPoint:(CGPoint)point withCGFont:(CGFontRef)font pointSize:(CGFloat)pointSize __AVAILABILITY_INTERNAL_DEPRECATED;
+- (CGSize)drawInRect:(CGRect)rect withCGFont:(CGFontRef)font pointSize:(CGFloat)pointSize __AVAILABILITY_INTERNAL_DEPRECATED;
+- (CGSize)drawInRect:(CGRect)rect withCGFont:(CGFontRef)font pointSize:(CGFloat)pointSize
+ lineBreakMode:(UILineBreakMode)lineBreakMode __AVAILABILITY_INTERNAL_DEPRECATED;
+- (CGSize)drawInRect:(CGRect)rect withCGFont:(CGFontRef)font pointSize:(CGFloat)pointSize
+ lineBreakMode:(UILineBreakMode)lineBreakMode alignment:(UITextAlignment)alignment __AVAILABILITY_INTERNAL_DEPRECATED;
+
+// ZFont-based methods
+- (CGSize)sizeWithZFont:(ZFont *)font;
+- (CGSize)sizeWithZFont:(ZFont *)font constrainedToSize:(CGSize)size;
+- (CGSize)sizeWithZFont:(ZFont *)font constrainedToSize:(CGSize)size lineBreakMode:(UILineBreakMode)lineBreakMode;
+- (CGSize)sizeWithZFont:(ZFont *)font constrainedToSize:(CGSize)size lineBreakMode:(UILineBreakMode)lineBreakMode
+ numberOfLines:(NSUInteger)numberOfLines;
+- (CGSize)drawAtPoint:(CGPoint)point withZFont:(ZFont *)font;
+- (CGSize)drawAtPoint:(CGPoint)point forWidth:(CGFloat)width withZFont:(ZFont *)font lineBreakMode:(UILineBreakMode)lineBreakMode;
+- (CGSize)drawInRect:(CGRect)rect withZFont:(ZFont *)font;
+- (CGSize)drawInRect:(CGRect)rect withZFont:(ZFont *)font lineBreakMode:(UILineBreakMode)lineBreakMode;
+- (CGSize)drawInRect:(CGRect)rect withZFont:(ZFont *)font lineBreakMode:(UILineBreakMode)lineBreakMode
+ alignment:(UITextAlignment)alignment;
+- (CGSize)drawInRect:(CGRect)rect withZFont:(ZFont *)font lineBreakMode:(UILineBreakMode)lineBreakMode
+ alignment:(UITextAlignment)alignment numberOfLines:(NSUInteger)numberOfLines;
+@end
+
+@interface ZAttributedString (ZAttributedStringDrawing)
+- (CGSize)size;
+- (CGSize)sizeConstrainedToSize:(CGSize)size;
+- (CGSize)sizeConstrainedToSize:(CGSize)size lineBreakMode:(UILineBreakMode)lineBreakMode;
+- (CGSize)sizeConstrainedToSize:(CGSize)size lineBreakMode:(UILineBreakMode)lineBreakMode
+ numberOfLines:(NSUInteger)numberOfLines;
+- (CGSize)drawAtPoint:(CGPoint)point;
+- (CGSize)drawAtPoint:(CGPoint)point forWidth:(CGFloat)width lineBreakMode:(UILineBreakMode)lineBreakMode;
+- (CGSize)drawInRect:(CGRect)rect;
+- (CGSize)drawInRect:(CGRect)rect withLineBreakMode:(UILineBreakMode)lineBreakMode;
+- (CGSize)drawInRect:(CGRect)rect withLineBreakMode:(UILineBreakMode)lineBreakMode alignment:(UITextAlignment)alignment;
+- (CGSize)drawInRect:(CGRect)rect withLineBreakMode:(UILineBreakMode)lineBreakMode alignment:(UITextAlignment)alignment
+ numberOfLines:(NSUInteger)numberOfLines;
+@end
--- /dev/null
+//
+// FontLabelStringDrawing.m
+// FontLabel
+//
+// Created by Kevin Ballard on 5/5/09.
+// Copyright © 2009 Zynga Game Networks
+//
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// 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.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+#import "FontLabelStringDrawing.h"
+#import "ZFont.h"
+#import "ZAttributedStringPrivate.h"
+
+@interface ZFont (ZFontPrivate)
+@property (nonatomic, readonly) CGFloat ratio;
+@end
+
+#define kUnicodeHighSurrogateStart 0xD800
+#define kUnicodeHighSurrogateEnd 0xDBFF
+#define kUnicodeHighSurrogateMask kUnicodeHighSurrogateStart
+#define kUnicodeLowSurrogateStart 0xDC00
+#define kUnicodeLowSurrogateEnd 0xDFFF
+#define kUnicodeLowSurrogateMask kUnicodeLowSurrogateStart
+#define kUnicodeSurrogateTypeMask 0xFC00
+#define UnicharIsHighSurrogate(c) ((c & kUnicodeSurrogateTypeMask) == kUnicodeHighSurrogateMask)
+#define UnicharIsLowSurrogate(c) ((c & kUnicodeSurrogateTypeMask) == kUnicodeLowSurrogateMask)
+#define ConvertSurrogatePairToUTF32(high, low) ((UInt32)((high - 0xD800) * 0x400 + (low - 0xDC00) + 0x10000))
+
+typedef enum {
+ kFontTableFormat4 = 4,
+ kFontTableFormat12 = 12,
+} FontTableFormat;
+
+typedef struct fontTable {
+ NSUInteger retainCount;
+ CFDataRef cmapTable;
+ FontTableFormat format;
+ union {
+ struct {
+ UInt16 segCountX2;
+ UInt16 *endCodes;
+ UInt16 *startCodes;
+ UInt16 *idDeltas;
+ UInt16 *idRangeOffsets;
+ } format4;
+ struct {
+ UInt32 nGroups;
+ struct {
+ UInt32 startCharCode;
+ UInt32 endCharCode;
+ UInt32 startGlyphCode;
+ } *groups;
+ } format12;
+ } cmap;
+} fontTable;
+
+static FontTableFormat supportedFormats[] = { kFontTableFormat4, kFontTableFormat12 };
+static size_t supportedFormatsCount = sizeof(supportedFormats) / sizeof(FontTableFormat);
+
+static fontTable *newFontTable(CFDataRef cmapTable, FontTableFormat format) {
+ fontTable *table = (struct fontTable *)malloc(sizeof(struct fontTable));
+ table->retainCount = 1;
+ table->cmapTable = CFRetain(cmapTable);
+ table->format = format;
+ return table;
+}
+
+static fontTable *retainFontTable(fontTable *table) {
+ if (table != NULL) {
+ table->retainCount++;
+ }
+ return table;
+}
+
+static void releaseFontTable(fontTable *table) {
+ if (table != NULL) {
+ if (table->retainCount <= 1) {
+ CFRelease(table->cmapTable);
+ free(table);
+ } else {
+ table->retainCount--;
+ }
+ }
+}
+
+static const void *fontTableRetainCallback(CFAllocatorRef allocator, const void *value) {
+ return retainFontTable((fontTable *)value);
+}
+
+static void fontTableReleaseCallback(CFAllocatorRef allocator, const void *value) {
+ releaseFontTable((fontTable *)value);
+}
+
+static const CFDictionaryValueCallBacks kFontTableDictionaryValueCallBacks = {
+ .version = 0,
+ .retain = &fontTableRetainCallback,
+ .release = &fontTableReleaseCallback,
+ .copyDescription = NULL,
+ .equal = NULL
+};
+
+// read the cmap table from the font
+// we only know how to understand some of the table formats at the moment
+static fontTable *readFontTableFromCGFont(CGFontRef font) {
+ CFDataRef cmapTable = CGFontCopyTableForTag(font, 'cmap');
+ NSCAssert1(cmapTable != NULL, @"CGFontCopyTableForTag returned NULL for 'cmap' tag in font %@",
+ (font ? [(id)CFCopyDescription(font) autorelease] : @"(null)"));
+ const UInt8 * const bytes = CFDataGetBytePtr(cmapTable);
+ NSCAssert1(OSReadBigInt16(bytes, 0) == 0, @"cmap table for font %@ has bad version number",
+ (font ? [(id)CFCopyDescription(font) autorelease] : @"(null)"));
+ UInt16 numberOfSubtables = OSReadBigInt16(bytes, 2);
+ const UInt8 *unicodeSubtable = NULL;
+ //UInt16 unicodeSubtablePlatformID;
+ UInt16 unicodeSubtablePlatformSpecificID;
+ FontTableFormat unicodeSubtableFormat;
+ const UInt8 * const encodingSubtables = &bytes[4];
+ for (UInt16 i = 0; i < numberOfSubtables; i++) {
+ const UInt8 * const encodingSubtable = &encodingSubtables[8 * i];
+ UInt16 platformID = OSReadBigInt16(encodingSubtable, 0);
+ UInt16 platformSpecificID = OSReadBigInt16(encodingSubtable, 2);
+ // find the best subtable
+ // best is defined by a combination of encoding and format
+ // At the moment we only support format 4, so ignore all other format tables
+ // We prefer platformID == 0, but we will also accept Microsoft's unicode format
+ if (platformID == 0 || (platformID == 3 && platformSpecificID == 1)) {
+ BOOL preferred = NO;
+ if (unicodeSubtable == NULL) {
+ preferred = YES;
+ } else if (platformID == 0 && platformSpecificID > unicodeSubtablePlatformSpecificID) {
+ preferred = YES;
+ }
+ if (preferred) {
+ UInt32 offset = OSReadBigInt32(encodingSubtable, 4);
+ const UInt8 *subtable = &bytes[offset];
+ UInt16 format = OSReadBigInt16(subtable, 0);
+ for (size_t i = 0; i < supportedFormatsCount; i++) {
+ if (format == supportedFormats[i]) {
+ if (format >= 8) {
+ // the version is a fixed-point
+ UInt16 formatFrac = OSReadBigInt16(subtable, 2);
+ if (formatFrac != 0) {
+ // all the current formats with a Fixed version are always *.0
+ continue;
+ }
+ }
+ unicodeSubtable = subtable;
+ //unicodeSubtablePlatformID = platformID;
+ unicodeSubtablePlatformSpecificID = platformSpecificID;
+ unicodeSubtableFormat = format;
+ break;
+ }
+ }
+ }
+ }
+ }
+ fontTable *table = NULL;
+ if (unicodeSubtable != NULL) {
+ table = newFontTable(cmapTable, unicodeSubtableFormat);
+ switch (unicodeSubtableFormat) {
+ case kFontTableFormat4:
+ // subtable format 4
+ //UInt16 length = OSReadBigInt16(unicodeSubtable, 2);
+ //UInt16 language = OSReadBigInt16(unicodeSubtable, 4);
+ table->cmap.format4.segCountX2 = OSReadBigInt16(unicodeSubtable, 6);
+ //UInt16 searchRange = OSReadBigInt16(unicodeSubtable, 8);
+ //UInt16 entrySelector = OSReadBigInt16(unicodeSubtable, 10);
+ //UInt16 rangeShift = OSReadBigInt16(unicodeSubtable, 12);
+ table->cmap.format4.endCodes = (UInt16*)&unicodeSubtable[14];
+ table->cmap.format4.startCodes = (UInt16*)&((UInt8*)table->cmap.format4.endCodes)[table->cmap.format4.segCountX2+2];
+ table->cmap.format4.idDeltas = (UInt16*)&((UInt8*)table->cmap.format4.startCodes)[table->cmap.format4.segCountX2];
+ table->cmap.format4.idRangeOffsets = (UInt16*)&((UInt8*)table->cmap.format4.idDeltas)[table->cmap.format4.segCountX2];
+ //UInt16 *glyphIndexArray = &idRangeOffsets[segCountX2];
+ break;
+ case kFontTableFormat12:
+ table->cmap.format12.nGroups = OSReadBigInt32(unicodeSubtable, 12);
+ table->cmap.format12.groups = (void *)&unicodeSubtable[16];
+ break;
+ default:
+ releaseFontTable(table);
+ table = NULL;
+ }
+ }
+ CFRelease(cmapTable);
+ return table;
+}
+
+// outGlyphs must be at least size n
+static void mapCharactersToGlyphsInFont(const fontTable *table, unichar characters[], size_t charLen, CGGlyph outGlyphs[], size_t *outGlyphLen) {
+ if (table != NULL) {
+ NSUInteger j = 0;
+ switch (table->format) {
+ case kFontTableFormat4: {
+ for (NSUInteger i = 0; i < charLen; i++, j++) {
+ unichar c = characters[i];
+ UInt16 segOffset;
+ BOOL foundSegment = NO;
+ for (segOffset = 0; segOffset < table->cmap.format4.segCountX2; segOffset += 2) {
+ UInt16 endCode = OSReadBigInt16(table->cmap.format4.endCodes, segOffset);
+ if (endCode >= c) {
+ foundSegment = YES;
+ break;
+ }
+ }
+ if (!foundSegment) {
+ // no segment
+ // this is an invalid font
+ outGlyphs[j] = 0;
+ } else {
+ UInt16 startCode = OSReadBigInt16(table->cmap.format4.startCodes, segOffset);
+ if (!(startCode <= c)) {
+ // the code falls in a hole between segments
+ outGlyphs[j] = 0;
+ } else {
+ UInt16 idRangeOffset = OSReadBigInt16(table->cmap.format4.idRangeOffsets, segOffset);
+ if (idRangeOffset == 0) {
+ UInt16 idDelta = OSReadBigInt16(table->cmap.format4.idDeltas, segOffset);
+ outGlyphs[j] = (c + idDelta) % 65536;
+ } else {
+ // use the glyphIndexArray
+ UInt16 glyphOffset = idRangeOffset + 2 * (c - startCode);
+ outGlyphs[j] = OSReadBigInt16(&((UInt8*)table->cmap.format4.idRangeOffsets)[segOffset], glyphOffset);
+ }
+ }
+ }
+ }
+ break;
+ }
+ case kFontTableFormat12: {
+ UInt32 lastSegment = UINT32_MAX;
+ for (NSUInteger i = 0; i < charLen; i++, j++) {
+ unichar c = characters[i];
+ UInt32 c32 = c;
+ if (UnicharIsHighSurrogate(c)) {
+ if (i+1 < charLen) { // do we have another character after this one?
+ unichar cc = characters[i+1];
+ if (UnicharIsLowSurrogate(cc)) {
+ c32 = ConvertSurrogatePairToUTF32(c, cc);
+ i++;
+ }
+ }
+ }
+ // Start the heuristic search
+ // If this is an ASCII char, just do a linear search
+ // Otherwise do a hinted, modified binary search
+ // Start the first pivot at the last range found
+ // And when moving the pivot, limit the movement by increasing
+ // powers of two. This should help with locality
+ __typeof__(table->cmap.format12.groups[0]) *foundGroup = NULL;
+ if (c32 <= 0x7F) {
+ // ASCII
+ for (UInt32 idx = 0; idx < table->cmap.format12.nGroups; idx++) {
+ __typeof__(table->cmap.format12.groups[idx]) *group = &table->cmap.format12.groups[idx];
+ if (c32 < OSSwapBigToHostInt32(group->startCharCode)) {
+ // we've fallen into a hole
+ break;
+ } else if (c32 <= OSSwapBigToHostInt32(group->endCharCode)) {
+ // this is the range
+ foundGroup = group;
+ break;
+ }
+ }
+ } else {
+ // heuristic search
+ UInt32 maxJump = (lastSegment == UINT32_MAX ? UINT32_MAX / 2 : 8);
+ UInt32 lowIdx = 0, highIdx = table->cmap.format12.nGroups; // highIdx is the first invalid idx
+ UInt32 pivot = (lastSegment == UINT32_MAX ? lowIdx + (highIdx - lowIdx) / 2 : lastSegment);
+ while (highIdx > lowIdx) {
+ __typeof__(table->cmap.format12.groups[pivot]) *group = &table->cmap.format12.groups[pivot];
+ if (c32 < OSSwapBigToHostInt32(group->startCharCode)) {
+ highIdx = pivot;
+ } else if (c32 > OSSwapBigToHostInt32(group->endCharCode)) {
+ lowIdx = pivot + 1;
+ } else {
+ // we've hit the range
+ foundGroup = group;
+ break;
+ }
+ if (highIdx - lowIdx > maxJump * 2) {
+ if (highIdx == pivot) {
+ pivot -= maxJump;
+ } else {
+ pivot += maxJump;
+ }
+ maxJump *= 2;
+ } else {
+ pivot = lowIdx + (highIdx - lowIdx) / 2;
+ }
+ }
+ if (foundGroup != NULL) lastSegment = pivot;
+ }
+ if (foundGroup == NULL) {
+ outGlyphs[j] = 0;
+ } else {
+ outGlyphs[j] = (CGGlyph)(OSSwapBigToHostInt32(foundGroup->startGlyphCode) +
+ (c32 - OSSwapBigToHostInt32(foundGroup->startCharCode)));
+ }
+ }
+ break;
+ }
+ }
+ if (outGlyphLen != NULL) *outGlyphLen = j;
+ } else {
+ // we have no table, so just null out the glyphs
+ bzero(outGlyphs, charLen*sizeof(CGGlyph));
+ if (outGlyphLen != NULL) *outGlyphLen = 0;
+ }
+}
+
+static BOOL mapGlyphsToAdvancesInFont(ZFont *font, size_t n, CGGlyph glyphs[], CGFloat outAdvances[]) {
+ int advances[n];
+ if (CGFontGetGlyphAdvances(font.cgFont, glyphs, n, advances)) {
+ CGFloat ratio = font.ratio;
+
+ for (size_t i = 0; i < n; i++) {
+ outAdvances[i] = advances[i]*ratio;
+ }
+ return YES;
+ } else {
+ bzero(outAdvances, n*sizeof(CGFloat));
+ }
+ return NO;
+}
+
+static id getValueOrDefaultForRun(ZAttributeRun *run, NSString *key) {
+ id value = [run.attributes objectForKey:key];
+ if (value == nil) {
+ static NSDictionary *defaultValues = nil;
+ if (defaultValues == nil) {
+ defaultValues = [[NSDictionary alloc] initWithObjectsAndKeys:
+ [ZFont fontWithUIFont:[UIFont systemFontOfSize:12]], ZFontAttributeName,
+ [UIColor blackColor], ZForegroundColorAttributeName,
+ [UIColor clearColor], ZBackgroundColorAttributeName,
+ [NSNumber numberWithInt:ZUnderlineStyleNone], ZUnderlineStyleAttributeName,
+ nil];
+ }
+ value = [defaultValues objectForKey:key];
+ }
+ return value;
+}
+
+static void readRunInformation(NSArray *attributes, NSUInteger len, CFMutableDictionaryRef fontTableMap,
+ NSUInteger index, ZAttributeRun **currentRun, NSUInteger *nextRunStart,
+ ZFont **currentFont, fontTable **currentTable) {
+ *currentRun = [attributes objectAtIndex:index];
+ *nextRunStart = ([attributes count] > index+1 ? [[attributes objectAtIndex:index+1] index] : len);
+ *currentFont = getValueOrDefaultForRun(*currentRun, ZFontAttributeName);
+ if (!CFDictionaryGetValueIfPresent(fontTableMap, (*currentFont).cgFont, (const void **)currentTable)) {
+ *currentTable = readFontTableFromCGFont((*currentFont).cgFont);
+ CFDictionarySetValue(fontTableMap, (*currentFont).cgFont, *currentTable);
+ releaseFontTable(*currentTable);
+ }
+}
+
+static CGSize drawOrSizeTextConstrainedToSize(BOOL performDraw, NSString *string, NSArray *attributes, CGSize constrainedSize, NSUInteger maxLines,
+ UILineBreakMode lineBreakMode, UITextAlignment alignment, BOOL ignoreColor) {
+ NSUInteger len = [string length];
+ NSUInteger idx = 0;
+ CGPoint drawPoint = CGPointZero;
+ CGSize retValue = CGSizeZero;
+ CGContextRef ctx = (performDraw ? UIGraphicsGetCurrentContext() : NULL);
+
+ BOOL convertNewlines = (maxLines == 1);
+
+ // Extract the characters from the string
+ // Convert newlines to spaces if necessary
+ unichar *characters = (unichar *)malloc(sizeof(unichar) * len);
+ if (convertNewlines) {
+ NSCharacterSet *charset = [NSCharacterSet newlineCharacterSet];
+ NSRange range = NSMakeRange(0, len);
+ size_t cIdx = 0;
+ while (range.length > 0) {
+ NSRange newlineRange = [string rangeOfCharacterFromSet:charset options:0 range:range];
+ if (newlineRange.location == NSNotFound) {
+ [string getCharacters:&characters[cIdx] range:range];
+ cIdx += range.length;
+ break;
+ } else {
+ NSUInteger delta = newlineRange.location - range.location;
+ if (newlineRange.location > range.location) {
+ [string getCharacters:&characters[cIdx] range:NSMakeRange(range.location, delta)];
+ }
+ cIdx += delta;
+ characters[cIdx] = (unichar)' ';
+ cIdx++;
+ delta += newlineRange.length;
+ range.location += delta, range.length -= delta;
+ if (newlineRange.length == 1 && range.length >= 1 &&
+ [string characterAtIndex:newlineRange.location] == (unichar)'\r' &&
+ [string characterAtIndex:range.location] == (unichar)'\n') {
+ // CRLF sequence, skip the LF
+ range.location += 1, range.length -= 1;
+ }
+ }
+ }
+ len = cIdx;
+ } else {
+ [string getCharacters:characters range:NSMakeRange(0, len)];
+ }
+
+ // Create storage for glyphs and advances
+ CGGlyph *glyphs;
+ CGFloat *advances;
+ {
+ NSUInteger maxRunLength = 0;
+ ZAttributeRun *a = [attributes objectAtIndex:0];
+ for (NSUInteger i = 1; i < [attributes count]; i++) {
+ ZAttributeRun *b = [attributes objectAtIndex:i];
+ maxRunLength = MAX(maxRunLength, b.index - a.index);
+ a = b;
+ }
+ maxRunLength = MAX(maxRunLength, len - a.index);
+ maxRunLength++; // for a potential ellipsis
+ glyphs = (CGGlyph *)malloc(sizeof(CGGlyph) * maxRunLength);
+ advances = (CGFloat *)malloc(sizeof(CGFloat) * maxRunLength);
+ }
+
+ // Use this table to cache all fontTable objects
+ CFMutableDictionaryRef fontTableMap = CFDictionaryCreateMutable(NULL, 0, &kCFTypeDictionaryKeyCallBacks,
+ &kFontTableDictionaryValueCallBacks);
+
+ // Fetch initial style values
+ NSUInteger currentRunIdx = 0;
+ ZAttributeRun *currentRun;
+ NSUInteger nextRunStart;
+ ZFont *currentFont;
+ fontTable *currentTable;
+
+#define READ_RUN() readRunInformation(attributes, len, fontTableMap, \
+ currentRunIdx, ¤tRun, &nextRunStart, \
+ ¤tFont, ¤tTable)
+
+ READ_RUN();
+
+ // fetch the glyphs for the first run
+ size_t glyphCount;
+ NSUInteger glyphIdx;
+
+#define READ_GLYPHS() do { \
+ mapCharactersToGlyphsInFont(currentTable, &characters[currentRun.index], (nextRunStart - currentRun.index), glyphs, &glyphCount); \
+ mapGlyphsToAdvancesInFont(currentFont, (nextRunStart - currentRun.index), glyphs, advances); \
+ glyphIdx = 0; \
+ } while (0)
+
+ READ_GLYPHS();
+
+ NSMutableCharacterSet *alphaCharset = [NSMutableCharacterSet alphanumericCharacterSet];
+ [alphaCharset addCharactersInString:@"([{'\"\u2019\u02BC"];
+
+ // scan left-to-right looking for newlines or until we hit the width constraint
+ // When we hit a wrapping point, calculate truncation as follows:
+ // If we have room to draw at least one more character on the next line, no truncation
+ // Otherwise apply the truncation algorithm to the current line.
+ // After calculating any truncation, draw.
+ // Each time we hit the end of an attribute run, calculate the new font and make sure
+ // it fits (vertically) within the size constraint. If not, truncate this line.
+ // When we draw, iterate over the attribute runs for this line and draw each run separately
+ BOOL lastLine = NO; // used to indicate truncation and to stop the iterating
+ NSUInteger lineCount = 1;
+ while (idx < len && !lastLine) {
+ if (maxLines > 0 && lineCount == maxLines) {
+ lastLine = YES;
+ }
+ // scan left-to-right
+ struct {
+ NSUInteger index;
+ NSUInteger glyphIndex;
+ NSUInteger currentRunIdx;
+ } indexCache = { idx, glyphIdx, currentRunIdx };
+ CGSize lineSize = CGSizeMake(0, currentFont.leading);
+ CGFloat lineAscender = currentFont.ascender;
+ struct {
+ NSUInteger index;
+ NSUInteger glyphIndex;
+ NSUInteger currentRunIdx;
+ CGSize lineSize;
+ } lastWrapCache = {0, 0, 0, CGSizeZero};
+ BOOL inAlpha = NO; // used for calculating wrap points
+
+ BOOL finishLine = NO;
+ for (;idx <= len && !finishLine;) {
+ NSUInteger skipCount = 0;
+ if (idx == len) {
+ finishLine = YES;
+ lastLine = YES;
+ } else {
+ if (idx >= nextRunStart) {
+ // cycle the font and table and grab the next set of glyphs
+ do {
+ currentRunIdx++;
+ READ_RUN();
+ } while (idx >= nextRunStart);
+ READ_GLYPHS();
+ // re-scan the characters to synchronize the glyph index
+ for (NSUInteger j = currentRun.index; j < idx; j++) {
+ if (UnicharIsHighSurrogate(characters[j]) && j+1<len && UnicharIsLowSurrogate(characters[j+1])) {
+ j++;
+ }
+ glyphIdx++;
+ }
+ if (currentFont.leading > lineSize.height) {
+ lineSize.height = currentFont.leading;
+ if (retValue.height + currentFont.ascender > constrainedSize.height) {
+ lastLine = YES;
+ finishLine = YES;
+ }
+ }
+ lineAscender = MAX(lineAscender, currentFont.ascender);
+ }
+ unichar c = characters[idx];
+ // Mark a wrap point before spaces and after any stretch of non-alpha characters
+ BOOL markWrap = NO;
+ if (c == (unichar)' ') {
+ markWrap = YES;
+ } else if ([alphaCharset characterIsMember:c]) {
+ if (!inAlpha) {
+ markWrap = YES;
+ inAlpha = YES;
+ }
+ } else {
+ inAlpha = NO;
+ }
+ if (markWrap) {
+ lastWrapCache = (__typeof__(lastWrapCache)){
+ .index = idx,
+ .glyphIndex = glyphIdx,
+ .currentRunIdx = currentRunIdx,
+ .lineSize = lineSize
+ };
+ }
+ // process the line
+ if (c == (unichar)'\n' || c == 0x0085) { // U+0085 is the NEXT_LINE unicode character
+ finishLine = YES;
+ skipCount = 1;
+ } else if (c == (unichar)'\r') {
+ finishLine = YES;
+ // check for CRLF
+ if (idx+1 < len && characters[idx+1] == (unichar)'\n') {
+ skipCount = 2;
+ } else {
+ skipCount = 1;
+ }
+ } else if (lineSize.width + advances[glyphIdx] > constrainedSize.width) {
+ finishLine = YES;
+ if (retValue.height + lineSize.height + currentFont.ascender > constrainedSize.height) {
+ lastLine = YES;
+ }
+ // walk backwards if wrapping is necessary
+ if (lastWrapCache.index > indexCache.index && lineBreakMode != UILineBreakModeCharacterWrap &&
+ (!lastLine || lineBreakMode != UILineBreakModeClip)) {
+ // we're doing some sort of word wrapping
+ idx = lastWrapCache.index;
+ lineSize = lastWrapCache.lineSize;
+ if (!lastLine) {
+ // re-check if this is the last line
+ if (lastWrapCache.currentRunIdx != currentRunIdx) {
+ currentRunIdx = lastWrapCache.currentRunIdx;
+ READ_RUN();
+ READ_GLYPHS();
+ }
+ if (retValue.height + lineSize.height + currentFont.ascender > constrainedSize.height) {
+ lastLine = YES;
+ }
+ }
+ glyphIdx = lastWrapCache.glyphIndex;
+ // skip any spaces
+ for (NSUInteger j = idx; j < len && characters[j] == (unichar)' '; j++) {
+ skipCount++;
+ }
+ }
+ }
+ }
+ if (finishLine) {
+ // TODO: support head/middle truncation
+ if (lastLine && idx < len && lineBreakMode == UILineBreakModeTailTruncation) {
+ // truncate
+ unichar ellipsis = 0x2026; // ellipsis (…)
+ CGGlyph ellipsisGlyph;
+ mapCharactersToGlyphsInFont(currentTable, &ellipsis, 1, &ellipsisGlyph, NULL);
+ CGFloat ellipsisWidth;
+ mapGlyphsToAdvancesInFont(currentFont, 1, &ellipsisGlyph, &ellipsisWidth);
+ while ((idx - indexCache.index) > 1 && lineSize.width + ellipsisWidth > constrainedSize.width) {
+ // we have more than 1 character and we're too wide, so back up
+ idx--;
+ if (UnicharIsHighSurrogate(characters[idx]) && UnicharIsLowSurrogate(characters[idx+1])) {
+ idx--;
+ }
+ if (idx < currentRun.index) {
+ ZFont *oldFont = currentFont;
+ do {
+ currentRunIdx--;
+ READ_RUN();
+ } while (idx < currentRun.index);
+ READ_GLYPHS();
+ glyphIdx = glyphCount-1;
+ if (oldFont != currentFont) {
+ mapCharactersToGlyphsInFont(currentTable, &ellipsis, 1, &ellipsisGlyph, NULL);
+ mapGlyphsToAdvancesInFont(currentFont, 1, &ellipsisGlyph, &ellipsisWidth);
+ }
+ } else {
+ glyphIdx--;
+ }
+ lineSize.width -= advances[glyphIdx];
+ }
+ // skip any spaces before truncating
+ while ((idx - indexCache.index) > 1 && characters[idx-1] == (unichar)' ') {
+ idx--;
+ if (idx < currentRun.index) {
+ currentRunIdx--;
+ READ_RUN();
+ READ_GLYPHS();
+ glyphIdx = glyphCount-1;
+ } else {
+ glyphIdx--;
+ }
+ lineSize.width -= advances[glyphIdx];
+ }
+ lineSize.width += ellipsisWidth;
+ glyphs[glyphIdx] = ellipsisGlyph;
+ idx++;
+ glyphIdx++;
+ }
+ retValue.width = MAX(retValue.width, lineSize.width);
+ retValue.height += lineSize.height;
+
+ // draw
+ if (performDraw) {
+ switch (alignment) {
+ case UITextAlignmentLeft:
+ drawPoint.x = 0;
+ break;
+ case UITextAlignmentCenter:
+ drawPoint.x = (constrainedSize.width - lineSize.width) / 2.0f;
+ break;
+ case UITextAlignmentRight:
+ drawPoint.x = constrainedSize.width - lineSize.width;
+ break;
+ }
+ NSUInteger stopGlyphIdx = glyphIdx;
+ NSUInteger lastRunIdx = currentRunIdx;
+ NSUInteger stopCharIdx = idx;
+ idx =
projects / tanks-ios.git / commitdiff