Debian Codegraph @

wasm/browser/src/events.js

raw
1 import EE3 from "eventemitter3/umd/eventemitter3.min.js";
2
3 /**
4 * @template PublicEvents
5 * @readonly
6 * @enum {number}
7 * @property {string} "play" called anytime performance goes from pause/stop to a running state.
8 * @property {string} "pause" called after any successful csound.pause() calls.
9 * @property {string} "stop" called after end of performance or after a successful csound.stop().
10 * @property {string} "realtimePerformanceStarted" called at the start of realtime performance but not on resume or render.
11 * @property {string} "realtimePerformancePaused" only called if csound.pause() was successfully called during performance.
12 * @property {string} "realtimePerformanceResumed" only called if csound.resume() was successfully called after a pause.
13 * @property {string} "realtimePerformanceEnded" called after end of performance or after a successful csound.stop().
14 * @property {string} "renderStarted" called at the start of offline/non-realtime render to disk.
15 * @property {string} "renderEnded" called at the end of offline/non-realtime render to disk.
16 * @property {string} "onAudioNodeCreated" called when an audioNode is created from the AudioContext before realtime performance.
17 * the event callback will include the audioNode itself, which is needed if autoConnect is set to false.
18 * @property {string} "message" the main entrypoint to csound's messaging (-m) system,
19 * a default event listener will print the message to the browser console, this default
20 * listener can be removed by the user.
21 * @suppress {misplacedTypeAnnotation}
22 */
23
24 export class PublicEventAPI {
25 constructor(parent) {
26 this.parent = parent;
27 this.eventEmitter = new EE3();
28 this.currentDerivedPlayState = undefined;
29 this.decorateAPI = this.decorateAPI.bind(this);
30 this.triggerRealtimePerformanceStarted = this.triggerRealtimePerformanceStarted.bind(this);
31 this.triggerRealtimePerformancePaused = this.triggerRealtimePerformancePaused.bind(this);
32 this.triggerRealtimePerformanceResumed = this.triggerRealtimePerformanceResumed.bind(this);
33 this.triggerRealtimePerformanceEnded = this.triggerRealtimePerformanceEnded.bind(this);
34 this.triggerRenderStarted = this.triggerRenderStarted.bind(this);
35 this.triggerRenderEnded = this.triggerRenderEnded.bind(this);
36 this.triggerOnAudioNodeCreated = this.triggerOnAudioNodeCreated.bind(this);
37 this.terminateInstance = this.terminateInstance.bind(this);
38 }
39
40 terminateInstance() {
41 this.eventEmitter.removeAllListeners([
42 "play",
43 "pause",
44 "stop",
45 "realtimePerformanceStarted",
46 "realtimePerformancePaused",
47 "realtimePerformanceResumed",
48 "realtimePerformanceEnded",
49 "renderStarted",
50 "renderEnded",
51 "onAudioNodeCreated",
52 "message",
53 ]);
54 Object.keys(this).forEach((key) => delete this[key]);
55 }
56
57 triggerRealtimePerformanceStarted() {
58 this.eventEmitter.emit("realtimePerformanceStarted");
59 if (this.currentDerivedPlayState !== "play") {
60 this.eventEmitter.emit("play");
61 this.currentDerivedPlayState = "play";
62 }
63 }
64
65 triggerRealtimePerformancePaused() {
66 this.eventEmitter.emit("realtimePerformancePaused");
67 if (this.currentDerivedPlayState !== "pause") {
68 this.eventEmitter.emit("pause");
69 this.currentDerivedPlayState = "pause";
70 }
71 }
72
73 triggerRealtimePerformanceResumed() {
74 this.eventEmitter.emit("realtimePerformanceResumed");
75 if (this.currentDerivedPlayState !== "play") {
76 this.eventEmitter.emit("play");
77 this.currentDerivedPlayState = "play";
78 }
79 }
80
81 triggerRealtimePerformanceEnded() {
82 this.eventEmitter.emit("realtimePerformanceEnded");
83 if (this.currentDerivedPlayState !== "stop") {
84 this.eventEmitter.emit("stop");
85 this.currentDerivedPlayState = "stop";
86 }
87 }
88
89 triggerRenderStarted() {
90 this.eventEmitter.emit("renderStarted");
91 if (this.currentDerivedPlayState !== "stop") {
92 this.eventEmitter.emit("stop");
93 this.currentDerivedPlayState = "stop";
94 }
95 }
96
97 triggerRenderEnded() {
98 this.eventEmitter.emit("renderEnded");
99 if (this.currentDerivedPlayState !== "stop") {
100 this.eventEmitter.emit("stop");
101 this.currentDerivedPlayState = "stop";
102 }
103 }
104
105 triggerOnAudioNodeCreated(audioNode) {
106 this.eventEmitter.emit("onAudioNodeCreated", audioNode);
107 }
108
109 triggerMessage({ log }) {
110 this.eventEmitter.emit("message", log);
111 }
112
113 decorateAPI(exportApi) {
114 /**
115 * Returns an array listing the events for which the emitter has registered listeners.
116 * The values in the array are strings.
117 * @function
118 * @name eventNames
119 * @memberof CsoundObj
120 * @return {Array<string>}
121 */
122 exportApi.eventNames = this.eventEmitter.eventNames.bind(this.eventEmitter);
123 /**
124 * Returns the number of listeners listening to the event named eventName.
125 * @function
126 * @name listenerCount
127 * @memberof CsoundObj
128 * @return {number}
129 */
130 exportApi.listenerCount = this.eventEmitter.listenerCount.bind(this.eventEmitter);
131 /**
132 * Returns a copy of the array of listeners for the event named eventName.
133 * @function
134 * @name listeners
135 * @memberof CsoundObj
136 * @param {PublicEvents} eventName
137 * @return {Array.<function()>}
138 */
139 exportApi.listeners = this.eventEmitter.listeners.bind(this.eventEmitter);
140 /**
141 * Alias for removeListener()
142 * @function
143 * @name off
144 * @memberof CsoundObj
145 * @param {PublicEvents} eventName
146 * @param {function()} listener
147 * @return {EventEmitter}
148 */
149 exportApi.off = this.eventEmitter.off.bind(this.eventEmitter);
150 /**
151 * Adds the listener function to the end of the listeners array for the event named eventName.
152 * No checks are made to see if the listener has already been added.
153 * Multiple calls passing the same combination of eventName and listener
154 * will result in the listener being added, and called, multiple times.
155 * @function
156 * @name on
157 * @memberof CsoundObj
158 * @param {PublicEvents} eventName
159 * @param {function()} listener
160 * @return {EventEmitter}
161 */
162 exportApi.on = this.eventEmitter.on.bind(this.eventEmitter);
163 /**
164 * Alias for "on"
165 * @function
166 * @name addListener
167 * @memberof CsoundObj
168 * @param {PublicEvents} eventName
169 * @param {function()} listener
170 * @return {EventEmitter}
171 */
172 exportApi.addListener = this.eventEmitter.on.bind(this.eventEmitter);
173 /**
174 * Adds a one-time listener function for the event named eventName.
175 * The next time eventName is triggered, this listener is removed and then invoked.
176 * @function
177 * @name once
178 * @memberof CsoundObj
179 * @param {PublicEvents} eventName
180 * @param {function()} listener
181 * @return {EventEmitter}
182 */
183 exportApi.once = this.eventEmitter.once.bind(this.eventEmitter);
184 /**
185 * Removes all listeners, or those of the specified eventName.
186 * It is bad practice to remove listeners added elsewhere in the code,
187 * particularly when the EventEmitter instance was created by some other
188 * component or module.
189 * Returns a reference to the EventEmitter, so that calls can be chained.
190 * @function
191 * @name removeAllListeners
192 * @memberof CsoundObj
193 * @param {PublicEvents} eventName
194 * @return {EventEmitter}
195 */
196 exportApi.removeAllListeners = this.eventEmitter.removeAllListeners.bind(this.eventEmitter);
197 /**
198 * Removes the specified listener from the listener array for the event named eventName.
199 * removeListener() will remove, at most, one instance of a listener from the listener array.
200 * If any single listener has been added multiple times to the listener array for the specified eventName,
201 * then removeListener() must be called multiple times to remove each instance.
202 * Removes the specified listener from the listener array for the event named eventName.
203 * @function
204 * @name removeListener
205 * @memberof CsoundObj
206 * @param {PublicEvents} eventName
207 * @param {function()} listener
208 * @return {EventEmitter}
209 */
210 exportApi.removeListener = this.eventEmitter.removeListener.bind(this.eventEmitter);
211 return exportApi;
212 }
213 }