/Users/rquesada/progs/cocos2d-iphone/CocosDenshion/CocosDenshion/CocosDenshion.h

Go to the documentation of this file.

/*
 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 <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>
-(BOOL) play;
-(BOOL) pause;
-(BOOL) stop;
-(BOOL) rewind;
@end

#pragma mark CDAudioInterruptProtocol

@protocol CDAudioInterruptProtocol <NSObject>
-(BOOL) mute;
-(void) setMute:(BOOL) muteValue;
-(BOOL) enabled;
-(void) setEnabled:(BOOL) enabledValue;
@end

#pragma mark CDUtilities

@interface CDUtilities : NSObject
{
}       

+(NSString*) fullPathFromRelativePath:(NSString*) relPath;

@end


#pragma mark CDSoundEngine

@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
@property (readonly) int sourceTotal;
@property (readonly) NSUInteger sourceGroupTotal;

+(void) setMixerSampleRate:(Float32) sampleRate;

-(id)init;

-(ALuint) playSound:(int) soundId sourceGroupId:(int)sourceGroupId pitch:(float) pitch pan:(float) pan gain:(float) gain loop:(BOOL) loop;

-(CDSoundSource *) soundSourceForSound:(int) soundId sourceGroupId:(int) sourceGroupId;

- (void) stopSound:(ALuint) sourceId;
- (void) stopSourceGroup:(int) sourceGroupId;
-(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;

-(float) bufferDurationInSeconds:(int) soundId;
-(ALsizei) bufferSizeInBytes:(int) soundId;
-(ALsizei) bufferFrequencyInHertz:(int) soundId;

-(void) _soundSourcePreRelease:(CDSoundSource *) soundSource;

@end

#pragma mark CDSoundSource

@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;
@property (readonly) float durationInSeconds;

@property (readonly) ALenum lastError;
-(id)init:(ALuint) theSourceId sourceIndex:(int) index soundEngine:(CDSoundEngine*) engine;

@end

#pragma mark CDAudioInterruptTargetGroup

@interface CDAudioInterruptTargetGroup : NSObject <CDAudioInterruptProtocol> {
        BOOL mute_;
        BOOL enabled_;
        NSMutableArray *children_;
}
-(void) addAudioInterruptTarget:(NSObject<CDAudioInterruptProtocol>*) interruptibleTarget;
@end

#pragma mark CDAsynchBufferLoader

@interface CDAsynchBufferLoader : NSOperation {
        NSArray *_loadRequests;
        CDSoundEngine *_soundEngine;
}       

-(id) init:(NSArray *)loadRequests soundEngine:(CDSoundEngine *) theSoundEngine;

@end

#pragma mark 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

typedef enum {
        kIT_Linear,                     
        kIT_SCurve,                     
        kIT_Exponential         
} 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;

-(float) interpolate:(float) t;
-(id) init:(tCDInterpolationType) type startVal:(float) startVal endVal:(float) endVal;

@end

#pragma mark CDPropertyModifier

@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;
-(void) modify:(float) t;

-(void) _setTargetProperty:(float) newVal;
-(float) _getTargetProperty;
-(void) _stopTarget;
-(Class) _allowableType;

@end

#pragma mark CDSoundSourceFader

@interface CDSoundSourceFader : CDPropertyModifier{}
@end

#pragma mark CDSoundSourcePanner

@interface CDSoundSourcePanner : CDPropertyModifier{}
@end

#pragma mark CDSoundSourcePitchBender

@interface CDSoundSourcePitchBender : CDPropertyModifier{}
@end

#pragma mark CDSoundEngineFader

@interface CDSoundEngineFader : CDPropertyModifier{}
@end