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

/*
 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

typedef enum {
        kAMM_FxOnly,                                    
        kAMM_FxPlusMusic,                               
        kAMM_FxPlusMusicIfNoOtherAudio, 
        kAMM_MediaPlayback,                             
        kAMM_PlayAndRecord                              
} tAudioManagerMode;

typedef enum {
        kAMStateUninitialised, 
        kAMStateInitialising,  
        kAMStateInitialised        
} 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;

extern NSString * const kCDN_AudioManagerInitialised;

@interface CDAsynchInitialiser : NSOperation {} 
@end

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
- (void) cdAudioSourceDidFinishPlaying:(CDLongAudioSource *) audioSource;
- (void) cdAudioSourceFileDidChange:(CDLongAudioSource *) audioSource;
@end

@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;

-(void) load:(NSString*) filePath;
-(void) play;
-(void) stop;
-(void) pause;
-(void) rewind;
-(void) resume;
-(BOOL) isPlaying;

@end

@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;

+ (CDAudioManager *) sharedManager;
+ (tAudioManagerState) sharedManagerState;
+ (void) configure: (tAudioManagerMode) mode;
+ (void) initAsynchronously: (tAudioManagerMode) mode;
- (id) init: (tAudioManagerMode) mode;
-(void) audioSessionInterrupted;
-(void) audioSessionResumed;
-(void) setResignBehavior:(tAudioManagerResignBehavior) resignBehavior autoHandle:(BOOL) autoHandle;
-(BOOL) isDeviceMuted;
-(BOOL) isOtherAudioPlaying;
-(void) setMode:(tAudioManagerMode) mode;
+(void) end;

- (void) applicationWillResignActive;
- (void) applicationDidBecomeActive;

//New AVAudioPlayer API
-(CDLongAudioSource*) audioSourceLoad:(NSString*) filePath channel:(tAudioSourceChannel) channel;
-(CDLongAudioSource*) audioSourceForChannel:(tAudioSourceChannel) channel;

//Legacy AVAudioPlayer API
-(void) playBackgroundMusic:(NSString*) filePath loop:(BOOL) loop;
-(void) preloadBackgroundMusic:(NSString*) filePath;
-(void) stopBackgroundMusic;
-(void) pauseBackgroundMusic;
-(void) rewindBackgroundMusic;
-(void) resumeBackgroundMusic;
-(BOOL) isBackgroundMusicPlaying;

-(void) setBackgroundMusicCompletionListener:(id) listener selector:(SEL) selector;

@end

@interface CDLongAudioSourceFader : CDPropertyModifier{}
@end

static const int kCDNoBuffer = -1;

@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