/*

 <codex> 

 <abstract>Part of CoreAudio Utility Classes</abstract>

 <\codex>

*/

#ifndef __AUInput_h__

#define __AUInput_h__

#include "AUScopeElement.h"

#include "AUBuffer.h"

/*! @class AUInputElement */

class AUInputElement : public AUIOElement {

public:

    /*! @ctor AUInputElement */

                        AUInputElement(AUBase *audioUnit);

    /*! @dtor ~AUInputElement */

    virtual             ~AUInputElement() { }

    // AUElement override

    /*! @method SetStreamFormat */

    virtual OSStatus    SetStreamFormat(const CAStreamBasicDescription &desc);

    /*! @method NeedsBufferSpace */

    virtual bool        NeedsBufferSpace() const { return IsCallback(); }

    /*! @method SetConnection */

    void                SetConnection(const AudioUnitConnection &conn);

    /*! @method SetInputCallback */

    void                SetInputCallback(AURenderCallback proc, void *refCon);

    /*! @method IsActive */

    bool                IsActive() const { return mInputType != kNoInput; }

    /*! @method IsCallback */

    bool                IsCallback() const { return mInputType == kFromCallback; }

    /*! @method HasConnection */

    bool                HasConnection() const { return mInputType == kFromConnection; }

    /*! @method PullInput */

    OSStatus            PullInput(  AudioUnitRenderActionFlags &    ioActionFlags,

                                    const AudioTimeStamp &          inTimeStamp,

                                    AudioUnitElement                inElement,

                                    UInt32                          inNumberFrames);

    /*! @method PullInputWithBufferList */

    OSStatus            PullInputWithBufferList(    AudioUnitRenderActionFlags &    ioActionFlags,

                                                    const AudioTimeStamp &          inTimeStamp,

                                                    AudioUnitElement                inElement,

                                                    UInt32                          nFrames,

                                                    AudioBufferList *               inBufferList);

protected:

    /*! @method Disconnect */

    void                Disconnect();

    enum EInputType { kNoInput, kFromConnection, kFromCallback };

    /*! @var mInputType */

    EInputType                  mInputType;

    // if from callback:

    /*! @var mInputProc */

    AURenderCallback            mInputProc;

    /*! @var mInputProcRefCon */

    void *                      mInputProcRefCon;

    // if from connection:

    /*! @var mConnection */

    AudioUnitConnection         mConnection;

#if !CA_USE_AUDIO_PLUGIN_ONLY

    /*! @var mConnRenderProc */

    AudioUnitRenderProc         mConnRenderProc;

#endif

    /*! @var mConnInstanceStorage */

    void *                      mConnInstanceStorage;       // for the input component

};

#endif // __AUInput_h__