Jamoma API  0.6.0.a19
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 #ifndef __AUInput_h__
42 #define __AUInput_h__
43 
44 #include "AUScopeElement.h"
45 #include "AUBuffer.h"
46 
47 /*! @class AUInputElement */
48 class AUInputElement : public AUIOElement {
49 public:
50 
51  /*! @ctor AUInputElement */
52  AUInputElement(AUBase *audioUnit);
53  /*! @dtor ~AUInputElement */
54  virtual ~AUInputElement() { }
55 
56  // AUElement override
57  /*! @method SetStreamFormat */
58  virtual OSStatus SetStreamFormat(const CAStreamBasicDescription &desc);
59  /*! @method NeedsBufferSpace */
60  virtual bool NeedsBufferSpace() const { return IsCallback(); }
61 
62  /*! @method SetConnection */
63  void SetConnection(const AudioUnitConnection &conn);
64  /*! @method SetInputCallback */
65  void SetInputCallback(AURenderCallback proc, void *refCon);
66 
67  /*! @method IsActive */
68  bool IsActive() const { return mInputType != kNoInput; }
69  /*! @method IsCallback */
70  bool IsCallback() const { return mInputType == kFromCallback; }
71  /*! @method HasConnection */
72  bool HasConnection() const { return mInputType == kFromConnection; }
73 
74  /*! @method PullInput */
75  OSStatus PullInput( AudioUnitRenderActionFlags & ioActionFlags,
76  const AudioTimeStamp & inTimeStamp,
77  AudioUnitElement inElement,
78  UInt32 inNumberFrames);
79 
80  /*! @method PullInputWithBufferList */
81  OSStatus PullInputWithBufferList( AudioUnitRenderActionFlags & ioActionFlags,
82  const AudioTimeStamp & inTimeStamp,
83  AudioUnitElement inElement,
84  UInt32 nFrames,
85  AudioBufferList * inBufferList);
86 protected:
87  /*! @method Disconnect */
88  void Disconnect();
89 
90  enum EInputType { kNoInput, kFromConnection, kFromCallback };
91 
92  /*! @var mInputType */
93  EInputType mInputType;
94 
95  // if from callback:
96  /*! @var mInputProc */
97  AURenderCallback mInputProc;
98  /*! @var mInputProcRefCon */
99  void * mInputProcRefCon;
100 
101  // if from connection:
102  /*! @var mConnection */
103  AudioUnitConnection mConnection;
104  /*! @var mConnRenderProc */
105  AudioUnitRenderProc mConnRenderProc;
106  /*! @var mConnInstanceStorage */
107  void * mConnInstanceStorage; // for the input component
108 };
109 
110 
111 #endif // __AUInput_h__