/[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 2938 - (show annotations) (download) (as text)
Mon Jul 11 17:10:40 2016 UTC (7 years, 8 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 5761 byte(s)
* Fixed behavior of built-in instrument script functions play_note()
  and note_off(), which must be distinguished engine internally
  from "real" MIDI note on/off events in order to avoid
  misbehaviors like hanging notes.
* Bumped version (2.0.0.svn13).

1 /*
2 * Copyright (c) 2016 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 /// Optional synthesis parameters that might be overridden (by calling real-time instrument script functions like change_vol(), change_pitch(), etc.).
32 struct _Override {
33 float Volume; ///< as linear amplification ratio (1.0 being neutral)
34 float Pitch; ///< as linear frequency ratio (1.0 being neutral)
35 float Pan; ///< between -1.0 (most left) and +1.0 (most right) and 0.0 being neutral.
36 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.
37 float Cutoff; ///< between 0.0 and 1.0
38 float Resonance; ///< between 0.0 and 1.0
39 } Override;
40 /// Sampler format specific informations and variables.
41 union _Format {
42 /// Gigasampler/GigaStudio format specifics.
43 struct _Gig {
44 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.
45 uint8_t DimBits; ///< Used only in conjunction with DimMask: Dimension bits that shall be selected.
46 } Gig;
47 } Format;
48 protected:
49 NoteBase() : hostKey(0), parentNoteID(0), pChildNotes(NULL) {
50 Override.Volume = 1.f;
51 Override.Pitch = 1.f;
52 Override.Pan = 0.f;
53 Override.PanSources = 0;
54 Override.Cutoff = 1.f;
55 Override.Resonance = 1.f;
56 Format = _Format();
57 }
58 };
59
60 /**
61 * Contains the voices caused by one specific note, as well as basic
62 * informations about the note itself. You can see a Note object as one
63 * specific event in time where one or more voices were spawned at the same
64 * time and all those voices due to the same cause.
65 *
66 * For example when you press down and hold the sustain pedal, and then
67 * trigger the same note on the keyboard multiple times, for each key
68 * strokes a separate Note instance is created.
69 *
70 * If your instrument contains a real-time instrument script, then that
71 * script might also trigger additional voices programmatically (by
72 * calling the built-in script function play_note()). Each time the script
73 * calls play_note() a new Note instance is created and the script may then
74 * further control the voices of specific notes independently from each
75 * other. For example for each key stroke on your keyboard the instrument
76 * script might trigger 3 additional notes programmatically and assign a
77 * different tuning filter parameters for each one of the 3 notes
78 * independently.
79 */
80 template<class V>
81 class Note : public NoteBase {
82 public:
83 RTList<V>* pActiveVoices; ///< Contains the active voices associated with this note.
84
85 Note() : NoteBase(), pActiveVoices(NULL) {}
86
87 virtual ~Note() {
88 if (pChildNotes) delete pChildNotes;
89 if (pActiveVoices) delete pActiveVoices;
90 }
91
92 void init(Pool<V>* pVoicePool, Pool<note_id_t>* pNoteIDPool) {
93 if (pActiveVoices) delete pActiveVoices;
94 pActiveVoices = new RTList<V>(pVoicePool);
95 if (pChildNotes) delete pChildNotes;
96 pChildNotes = new RTList<note_id_t>(pNoteIDPool);
97 }
98
99 void reset() {
100 hostKey = 0;
101 parentNoteID = 0;
102 if (pChildNotes)
103 pChildNotes->clear();
104 cause = Event();
105 eventID = 0;
106 Override.Volume = 1.f;
107 Override.Pitch = 1.f;
108 Override.Pan = 0.f;
109 Override.PanSources = 0;
110 Override.Cutoff = 1.f;
111 Override.Resonance = 1.f;
112 Format = _Format();
113 if (pActiveVoices) {
114 typename RTList<V>::Iterator itVoice = pActiveVoices->first();
115 typename RTList<V>::Iterator itVoicesEnd = pActiveVoices->end();
116 for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key
117 itVoice->VoiceFreed();
118 }
119 pActiveVoices->clear();
120 }
121 }
122 };
123
124 } // namespace LinuxSampler
125
126 #endif // LS_NOTE_H

  ViewVC Help
Powered by ViewVC