platform/mac/SuperColliderAU/AUSDK/AUInputElement.h

   1 /*      Copyright © 2007 Apple Inc. All Rights Reserved.
   2
   3         Disclaimer: IMPORTANT:  This Apple software is supplied to you by
   4                         Apple Inc. ("Apple") in consideration of your agreement to the
   5                         following terms, and your use, installation, modification or
   6                         redistribution of this Apple software constitutes acceptance of these
   7                         terms.  If you do not agree with these terms, please do not use,
   8                         install, modify or redistribute this Apple software.
   9
  10                         In consideration of your agreement to abide by the following terms, and
  11                         subject to these terms, Apple grants you a personal, non-exclusive
  12                         license, under Apple's copyrights in this original Apple software (the
  13                         "Apple Software"), to use, reproduce, modify and redistribute the Apple
  14                         Software, with or without modifications, in source and/or binary forms;
  15                         provided that if you redistribute the Apple Software in its entirety and
  16                         without modifications, you must retain this notice and the following
  17                         text and disclaimers in all such redistributions of the Apple Software.
  18                         Neither the name, trademarks, service marks or logos of Apple Inc.
  19                         may be used to endorse or promote products derived from the Apple
  20                         Software without specific prior written permission from Apple.  Except
  21                         as expressly stated in this notice, no other rights or licenses, express
  22                         or implied, are granted by Apple herein, including but not limited to
  23                         any patent rights that may be infringed by your derivative works or by
  24                         other works in which the Apple Software may be incorporated.
  25
  26                         The Apple Software is provided by Apple on an "AS IS" basis.  APPLE
  27                         MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
  28                         THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
  29                         FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
  30                         OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
  31
  32                         IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
  33                         OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  34                         SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  35                         INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
  36                         MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
  37                         AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
  38                         STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
  39                         POSSIBILITY OF SUCH DAMAGE.
  40 */
  41 /*=============================================================================
  42         AUInputElement.h
  43
  44 =============================================================================*/
  45
  46 #ifndef __AUInput_h__
  47 #define __AUInput_h__
  48
  49 #include "AUScopeElement.h"
  50 #include "AUBuffer.h"
  51
  52 /*! @class AUInputElement */
  53 class AUInputElement : public AUIOElement {
  54 public:
  55
  56         /*! @ctor AUInputElement */
  57                                                 AUInputElement(AUBase *audioUnit);
  58         /*! @dtor ~AUInputElement */
  59         virtual                         ~AUInputElement() { }
  60
  61         // AUElement override
  62         /*! @method SetStreamFormat */
  63         virtual OSStatus        SetStreamFormat(const CAStreamBasicDescription &desc);
  64         /*! @method NeedsBufferSpace */
  65         virtual bool            NeedsBufferSpace() const { return IsCallback(); }
  66
  67         /*! @method SetConnection */
  68         void                            SetConnection(const AudioUnitConnection &conn);
  69         /*! @method SetInputCallback */
  70         void                            SetInputCallback(ProcPtr proc, void *refCon);
  71
  72         /*! @method IsActive */
  73         bool                            IsActive() const { return mInputType != kNoInput; }
  74         /*! @method IsCallback */
  75         bool                            IsCallback() const { return mInputType == kFromCallback; }
  76         /*! @method HasConnection */
  77         bool                            HasConnection() const { return mInputType == kFromConnection; }
  78
  79         /*! @method PullInput */
  80         ComponentResult         PullInput(      AudioUnitRenderActionFlags &    ioActionFlags,
  81                                                                         const AudioTimeStamp &                  inTimeStamp,
  82                                                                         AudioUnitElement                                inElement,
  83                                                                         UInt32                                                  inNumberFrames);
  84
  85 #if 0
  86         // prepare an input element's I/O buffer for PullInput -- uses its mBufferPtr
  87         AudioBufferList &       PrepareNullInputBuffer(UInt32 nFrames) {
  88                                                         return mIOBuffer.PrepareNullInputBuffer(nFrames);
  89                                                 }
  90
  91         AudioBufferList &       PrepareNonNullInputBuffer(UInt32 nFrames) {
  92                                                         return mIOBuffer.PrepareNonNullInputBuffer(nFrames);
  93                                                 }
  94
  95         // valid after PullInput
  96         const AudioBufferList & GetInputBuffer() { return mIOBuffer.GetBuffer(); }
  97
  98 #endif
  99
 100 protected:
 101         /*! @method Disconnect */
 102         void                            Disconnect();
 103
 104         enum EInputType { kNoInput, kFromConnection, kFromCallback };
 105
 106         /*! @var mInputType */
 107         EInputType                                      mInputType;
 108
 109         // if from callback:
 110         /*! @var mInputProc */
 111         ProcPtr                                         mInputProc;
 112         /*! @var mInputProcRefCon */
 113         void *                                          mInputProcRefCon;
 114
 115         // if from connection:
 116         /*! @var mConnection */
 117         AudioUnitConnection                     mConnection;
 118         /*! @var mConnRenderProc */
 119         ProcPtr                                         mConnRenderProc;
 120         /*! @var mConnInstanceStorage */
 121         void *                                          mConnInstanceStorage;           // for the input component
 122 };
 123
 124
 125 #endif // __AUInput_h__