/[svn]/linuxsampler/trunk/src/engines/common/Note.h
ViewVC logotype

Contents of /linuxsampler/trunk/src/engines/common/Note.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3118 - (show annotations) (download) (as text)
Fri Apr 21 13:33:03 2017 UTC (5 months, 3 weeks ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 6836 byte(s)
* NKSP: Fixed crash when using built-in script array variable "%ALL_EVENTS".
* NKSP: Added built-in function "change_amp_lfo_depth()".
* NKSP: Added built-in function "change_amp_lfo_freq()".
* NKSP: Added built-in function "change_pitch_lfo_depth()".
* NKSP: Added built-in function "change_pitch_lfo_freq()".
* Bumped version (2.0.0.svn44).

1 /*
2 * Copyright (c) 2016 - 2017 Christian Schoenebeck
3 *
4 * http://www.linuxsampler.org
5 *
6 * This file is part of LinuxSampler and released under the same terms.
7 * See README file for details.
8 */
9
10 #ifndef LS_NOTE_H
11 #define LS_NOTE_H
12
13 #include "../../common/Pool.h"
14 #include "Event.h"
15
16 namespace LinuxSampler {
17
18 /**
19 * Abstract base class of its deriving @c Note class, this class (NoteBase)
20 * is not intended to be instantiated directly. It just provides access to
21 * the parts of a Note object which do not depend on any C++ template
22 * parameter.
23 */
24 class NoteBase {
25 public:
26 int hostKey; ///< Key on which this is @c Note is allocated on. This is usually the note-on event's note number, however in case of a child note this will rather be the parent note's key instead!
27 note_id_t parentNoteID; ///< If not null: unique ID of the parent note of this note (see comments of field @c pChildNotes).
28 RTList<note_id_t>* pChildNotes; ///< Note ID list of "child" notes of this note. These are special notes that must be released once this note gets released.
29 Event cause; ///< Copy of the original event (usually a note-on event) which caused this note.
30 event_id_t eventID; ///< Unique ID of the actual original @c Event which caused this note.
31 sched_time_t triggerSchedTime; ///< Engine's scheduler time when this note was launched.
32 /// Optional synthesis parameters that might be overridden (by calling real-time instrument script functions like change_vol(), change_pitch(), etc.).
33 struct _Override {
34 float Volume; ///< as linear amplification ratio (1.0 being neutral)
35 float Pitch; ///< as linear frequency ratio (1.0 being neutral)
36 float Pan; ///< between -1.0 (most left) and +1.0 (most right) and 0.0 being neutral.
37 int64_t PanSources; ///< Might be used for calculating an average pan value in differential way: amount of times the Pan value had been changed and shall be calculated relatively upon.
38 float Cutoff; ///< between 0.0 and 1.0
39 float Resonance; ///< between 0.0 and 1.0
40 float Attack; ///< between 0.0 and 1.0
41 float Decay; ///< between 0.0 and 1.0
42 float Release; ///< between 0.0 and 1.0
43 float AmpLFODepth; ///< between 0.0 and 1.0
44 float AmpLFOFreq; ///< between 0.0 and 1.0
45 float PitchLFODepth; ///< between 0.0 and 1.0
46 float PitchLFOFreq; ///< between 0.0 and 1.0
47 } Override;
48 /// Sampler format specific informations and variables.
49 union _Format {
50 /// Gigasampler/GigaStudio format specifics.
51 struct _Gig {
52 uint8_t DimMask; ///< May be used to override the Dimension zone to be selected for a new voice: each 1 bit means that respective bit shall be overridden by taking the respective bit from DimBits instead.
53 uint8_t DimBits; ///< Used only in conjunction with DimMask: Dimension bits that shall be selected.
54 } Gig;
55 } Format;
56 protected:
57 NoteBase() : hostKey(0), parentNoteID(0), pChildNotes(NULL) {
58 Override.Volume = 1.f;
59 Override.Pitch = 1.f;
60 Override.Pan = 0.f;
61 Override.PanSources = 0;
62 Override.Cutoff = 1.f;
63 Override.Resonance = 1.f;
64 Override.Attack = 1.f;
65 Override.Decay = 1.f;
66 Override.Release = 1.f;
67 Override.AmpLFODepth = 1.f;
68 Override.AmpLFOFreq = 1.f;
69 Override.PitchLFODepth = 1.f;
70 Override.PitchLFOFreq = 1.f;
71
72 Format = _Format();
73 }
74 };
75
76 /**
77 * Contains the voices caused by one specific note, as well as basic
78 * informations about the note itself. You can see a Note object as one
79 * specific event in time where one or more voices were spawned at the same
80 * time and all those voices due to the same cause.
81 *
82 * For example when you press down and hold the sustain pedal, and then
83 * trigger the same note on the keyboard multiple times, for each key
84 * strokes a separate Note instance is created.
85 *
86 * If your instrument contains a real-time instrument script, then that
87 * script might also trigger additional voices programmatically (by
88 * calling the built-in script function play_note()). Each time the script
89 * calls play_note() a new Note instance is created and the script may then
90 * further control the voices of specific notes independently from each
91 * other. For example for each key stroke on your keyboard the instrument
92 * script might trigger 3 additional notes programmatically and assign a
93 * different tuning filter parameters for each one of the 3 notes
94 * independently.
95 */
96 template<class V>
97 class Note : public NoteBase {
98 public:
99 RTList<V>* pActiveVoices; ///< Contains the active voices associated with this note.
100
101 Note() : NoteBase(), pActiveVoices(NULL) {}
102
103 virtual ~Note() {
104 if (pChildNotes) delete pChildNotes;
105 if (pActiveVoices) delete pActiveVoices;
106 }
107
108 void init(Pool<V>* pVoicePool, Pool<note_id_t>* pNoteIDPool) {
109 if (pActiveVoices) delete pActiveVoices;
110 pActiveVoices = new RTList<V>(pVoicePool);
111 if (pChildNotes) delete pChildNotes;
112 pChildNotes = new RTList<note_id_t>(pNoteIDPool);
113 }
114
115 void reset() {
116 hostKey = 0;
117 parentNoteID = 0;
118 if (pChildNotes)
119 pChildNotes->clear();
120 cause = Event();
121 eventID = 0;
122 Override.Volume = 1.f;
123 Override.Pitch = 1.f;
124 Override.Pan = 0.f;
125 Override.PanSources = 0;
126 Override.Cutoff = 1.f;
127 Override.Resonance = 1.f;
128 Override.Attack = 1.f;
129 Override.Decay = 1.f;
130 Override.Release = 1.f;
131 Override.AmpLFODepth = 1.f;
132 Override.AmpLFOFreq = 1.f;
133 Override.PitchLFODepth = 1.f;
134 Override.PitchLFOFreq = 1.f;
135 Format = _Format();
136 if (pActiveVoices) {
137 typename RTList<V>::Iterator itVoice = pActiveVoices->first();
138 typename RTList<V>::Iterator itVoicesEnd = pActiveVoices->end();
139 for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key
140 itVoice->VoiceFreed();
141 }
142 pActiveVoices->clear();
143 }
144 }
145 };
146
147 } // namespace LinuxSampler
148
149 #endif // LS_NOTE_H

  ViewVC Help
Powered by ViewVC