plonk_IOSAudioHost.h

/*
 -------------------------------------------------------------------------------
 This file is part of the Plink, Plonk, Plank libraries
 by Martin Robinson
 
 http://code.google.com/p/pl-nk/
 
 Copyright University of the West of England, Bristol 2011-14
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
 * Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 * Neither the name of University of the West of England, Bristol nor 
   the names of its contributors may be used to endorse or promote products
   derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 DISCLAIMED. IN NO EVENT SHALL UNIVERSITY OF THE WEST OF ENGLAND, BRISTOL BE 
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 
 This software makes use of third party libraries. For more information see:
 doc/license.txt included in the distribution.
 -------------------------------------------------------------------------------
 */

#ifndef PLONK_IOSAUDIOHOST_H
#define PLONK_IOSAUDIOHOST_H

#include <AudioToolbox/AudioServices.h>
#include <AudioUnit/AudioUnit.h>

BEGIN_PLONK_NAMESPACE

class IOSUtilities
{
public:
    enum Locations
    {
        Bundle,         
        Documents,      
        Temporary       
    };
    
    static Text pathInDirectory (Locations location, const char *filename) throw();
};

typedef OSStatus (*RenderCallbackFunction)(void*                      refCon,
                                           UInt32                     inNumberFrames,
                                           AudioUnitRenderActionFlags *ioActionFlags,
                                           const AudioTimeStamp           *inTimeStamp,
                                           AudioBufferList            *ioData);

template<class SampleType>
class IOSAudioHostBase : public AudioHostBase<SampleType>
{
public:
    typedef typename AudioHostBase<SampleType>::BufferArray      BufferArray;
    typedef typename AudioHostBase<SampleType>::ConstBufferArray ConstBufferArray;
    typedef typename AudioHostBase<SampleType>::UnitType         UnitType;
    typedef NumericalArray<SampleType>                           Buffer;
    
    IOSAudioHostBase() throw();
    ~IOSAudioHostBase();
    
    Text getHostName() const throw();
    Text getNativeHostName() const throw();
    Text getInputName() const throw();
    Text getOutputName() const throw();
    double getCpuUsage() const throw() { return cpuUsage; }
    
    void startHost() throw();
    void stopHost() throw();
    void pauseHost() throw();
    void resumeHost() throw();
    
    virtual void hostInterruption (const bool flag) throw() { }
    inline bool wasInterrupted() throw() { return interrupted.getValue() != 0; }
    
    OSStatus renderCallback (UInt32                     inNumberFrames,
                             AudioUnitRenderActionFlags *ioActionFlags, 
                             const AudioTimeStamp               *inTimeStamp, 
                             AudioBufferList            *ioData) throw();
    
    void propertyCallback (AudioSessionPropertyID   inID,
                           UInt32                   inDataSize,
                           const void *             inPropertyValue) throw();
    
    void interruptionCallback (UInt32 inInterruption) throw();
    
    void setCustomRenderCallbacks (void* refCon, RenderCallbackFunction preRender, RenderCallbackFunction postRender) throw();

        
private:
    void setFormat() throw();    
    int setupRemoteIO() throw();
    void killRemoteIO() throw();
    void resetIO() throw();
    void restart() throw();
    void fixAudioRouteIfSetToReceiver() throw();

    AudioStreamBasicDescription format;
        AURenderCallbackStruct          inputProc;
        Float64                                         hwSampleRate;
        AudioUnit                                       rioUnit;
    
    int                                                 bufferSize;
        float                                           bufferDuration;
        double                                          reciprocalBufferDuration;
    Buffer                      convertBuffer;
        UInt32                                          audioInputIsAvailable;
        UInt32                                          numInputChannels;
        UInt32                                          numOutputChannels;
        double                                          cpuUsage;

    AtomicInt                   interrupted;
    
    void*                       customRenderCallbackRef;
    RenderCallbackFunction      customPreRender;
    RenderCallbackFunction      customPostRender;
};


// depracated but for backwards compatibility.
class IOSAudioHost : public IOSAudioHostBase<float>
{
public:
    IOSAudioHost() throw()
    {
    }
};

END_PLONK_NAMESPACE

#if defined(__OBJC__) || DOXYGEN 

@class PLAudioHost;

using namespace plonk;

@protocol PLAudioHostDelegate <NSObject>
@optional
- (FloatUnit)constructGraphFloat:(PLAudioHost*)host;
- (ShortUnit)constructGraphShort:(PLAudioHost*)host;
- (IntUnit)constructGraphInt:(PLAudioHost*)host;
- (DoubleUnit)constructGraphDouble:(PLAudioHost*)host;
- (Unit)constructGraph:(PLAudioHost*)host DEPRECATED_ATTRIBUTE;
- (void)hostStarting:(PLAudioHost*)host;
- (void)hostStopped:(PLAudioHost*)host;
- (void)hostPaused:(PLAudioHost*)host;
- (void)hostResuming:(PLAudioHost*)host;
- (void)hostInterruption:(PLAudioHost*)host withFlag:(BOOL)flag;
@end


@interface PLAudioHost : NSObject  
{
    void* peer;
    id<PLAudioHostDelegate> delegate;
    int type;
}

@property (nonatomic, assign) id delegate;                  
@property (nonatomic, readonly) NSString* hostName;         
@property (nonatomic, readonly) NSString* nativeHostName;   
@property (nonatomic, readonly) NSString* inputName;        
@property (nonatomic, readonly) NSString* outputName;       
@property (nonatomic, readonly) double cpuUsage;            
@property (nonatomic, readonly) BOOL isRunning;             
@property (nonatomic, readonly) BOOL isPaused;              
@property (nonatomic, readonly) BOOL wasInterrupted;        
@property (nonatomic, readonly) Dynamic outputUnit;         
@property (nonatomic) int numInputs;                        
@property (nonatomic) int numOutputs;                       
@property (nonatomic) int preferredHostBlockSize;           
@property (nonatomic) int preferredGraphBlockSize;          
@property (nonatomic) double preferredHostSampleRate;       

- (void)startHost;

- (void)stopHost;

- (void)pauseHost;

- (void)resumeHost;

- (void)setCustomRenderCallbacksWithRef:(void*)refCon pre:(RenderCallbackFunction)preFunc post:(RenderCallbackFunction)postFunc;

@end

#endif

#define PLANK_INLINING_FUNCTIONS 1
#include "plonk_IOSAudioHostInline.h"
#undef PLANK_INLINING_FUNCTIONS

#endif  // PLONK_IOSAUDIOHOST_H