Jamoma API  0.6.0.a19
MusicDeviceBase.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 __MusicDeviceBase_h__
42 #define __MusicDeviceBase_h__
43 
44 #include "AUMIDIBase.h"
45 
46 // ________________________________________________________________________
47 // MusicDeviceBase
48 //
49 
50 /*! @class MusicDeviceBase */
51 class MusicDeviceBase : public AUBase, public AUMIDIBase {
52 public:
53  /*! @ctor MusicDeviceBase */
54  MusicDeviceBase( AudioComponentInstance inInstance,
55  UInt32 numInputs,
56  UInt32 numOutputs,
57  UInt32 numGroups = 0,
58  UInt32 numParts = 0);
59 
60  /*! @method PrepareInstrument */
61  virtual OSStatus PrepareInstrument(MusicDeviceInstrumentID inInstrument) { return noErr; }
62 
63  /*! @method ReleaseInstrument */
64  virtual OSStatus ReleaseInstrument(MusicDeviceInstrumentID inInstrument) { return noErr; }
65 
66  /*! @method StartNote */
67  virtual OSStatus StartNote( MusicDeviceInstrumentID inInstrument,
68  MusicDeviceGroupID inGroupID,
69  NoteInstanceID * outNoteInstanceID,
70  UInt32 inOffsetSampleFrame,
71  const MusicDeviceNoteParams &inParams) = 0;
72 
73  /*! @method StopNote */
74  virtual OSStatus StopNote( MusicDeviceGroupID inGroupID,
75  NoteInstanceID inNoteInstanceID,
76  UInt32 inOffsetSampleFrame) = 0;
77 
78  /*! @method GetPropertyInfo */
79  virtual OSStatus GetPropertyInfo(AudioUnitPropertyID inID,
80  AudioUnitScope inScope,
81  AudioUnitElement inElement,
82  UInt32 & outDataSize,
83  Boolean & outWritable);
84 
85  /*! @method GetProperty */
86  virtual OSStatus GetProperty( AudioUnitPropertyID inID,
87  AudioUnitScope inScope,
88  AudioUnitElement inElement,
89  void * outData);
90 
91  /*! @method SetProperty */
92  virtual OSStatus SetProperty( AudioUnitPropertyID inID,
93  AudioUnitScope inScope,
94  AudioUnitElement inElement,
95  const void * inData,
96  UInt32 inDataSize);
97 
98  /*! @method HandleNoteOn */
99  virtual OSStatus HandleNoteOn( UInt8 inChannel,
100  UInt8 inNoteNumber,
101  UInt8 inVelocity,
102  UInt32 inStartFrame);
103 
104  /*! @method HandleNoteOff */
105  virtual OSStatus HandleNoteOff( UInt8 inChannel,
106  UInt8 inNoteNumber,
107  UInt8 inVelocity,
108  UInt32 inStartFrame);
109 
110  /*! @method GetInstrumentCount */
111  virtual OSStatus GetInstrumentCount ( UInt32 &outInstCount) const;
112 
113 #if !TARGET_OS_IPHONE
114  // component dispatcher
115  /*! @method ComponentEntryDispatch */
116  static OSStatus ComponentEntryDispatch( ComponentParameters * params,
117  MusicDeviceBase * This);
118 #endif
119 private:
120  OSStatus HandleStartNoteMessage (MusicDeviceInstrumentID inInstrument, MusicDeviceGroupID inGroupID, NoteInstanceID *outNoteInstanceID, UInt32 inOffsetSampleFrame, const MusicDeviceNoteParams *inParams);
121 };
122 
123 #endif // __MusicDeviceBase_h__