summaryrefslogtreecommitdiff
path: root/share/web_surfaces/shared/ardour.js
blob: 77e6bf49b93ac5f4d3656d32aad690373834ecdd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
/*
 * Copyright © 2020 Luciano Iam <lucianito@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

import { ANode, Message } from './message.js';
import { MessageChannel } from './channel.js';

export class Ardour {

	constructor () {
		this._callbacks = [];
		this._pendingRequest = null;
		this._channel = new MessageChannel(location.host);

		this._channel.onError = (error) => {
			this._fireCallbacks('error', error);
		};

		this._channel.onMessage = (msg) => {
			this._onChannelMessage(msg);
		};
	}

	addCallback (callback) {
		this._callbacks.push(callback);
	}

	async open () {
		this._channel.onClose = () => {
			this._fireCallbacks('error', new Error('Message channel unexpectedly closed'));
		};

		await this._channel.open();
	}

	close () {
		this._channel.onClose = () => {};
		this._channel.close();
	}

	send (msg) {
		this._channel.send(msg);
	}

	// Surface metadata API over HTTP

	async getAvailableSurfaces () {
		const response = await fetch('/surfaces.json');
		
		if (response.status == 200) {
			return await response.json();
		} else {
			throw this._fetchResponseStatusError(response.status);
		}
	}

	async getSurfaceManifest () {
		const response = await fetch('manifest.xml');

		if (response.status == 200) {
			const xmlText = await response.text();
			const xmlDoc = new DOMParser().parseFromString(xmlText, 'text/xml');
			return {
				name: xmlDoc.getElementsByTagName('Name')[0].getAttribute('value'),
				description: xmlDoc.getElementsByTagName('Description')[0].getAttribute('value'),
				version: xmlDoc.getElementsByTagName('Version')[0].getAttribute('value')
			}
		} else {
			throw this._fetchResponseStatusError(response.status);
		}
	}

	// Surface control API over WebSockets
	// clients need to call open() before calling these methods

	async getTempo () {
		return (await this._sendAndReceive(ANode.TEMPO))[0];
	}
	
	async getStripGain (stripId) {
		return (await this._sendAndReceive(ANode.STRIP_GAIN, [stripId]))[0];
	}

	async getStripPan (stripId) {
		return (await this._sendAndReceive(ANode.STRIP_PAN, [stripId]))[0];
	}

	async getStripMute (stripId) {
		return (await this._sendAndReceive(ANode.STRIP_MUTE, [stripId]))[0];
	}

	async getStripPluginEnable (stripId, pluginId) {
		return (await this._sendAndReceive(ANode.STRIP_PLUGIN_ENABLE, [stripId, pluginId]))[0];
	}

	async getStripPluginParamValue (stripId, pluginId, paramId) {
		return (await this._sendAndReceive(ANode.STRIP_PLUGIN_PARAM_VALUE, [stripId, pluginId, paramId]))[0];
	}

	setTempo (bpm) {
		this._send(ANode.TEMPO, [], [bpm]);
	}

	setStripGain (stripId, db) {
		this._send(ANode.STRIP_GAIN, [stripId], [db]);
	}

	setStripPan (stripId, value) {
		this._send(ANode.STRIP_PAN, [stripId], [value]);
	}

	setStripMute (stripId, value) {
		this._send(ANode.STRIP_MUTE, [stripId], [value]);
	}

	setStripPluginEnable (stripId, pluginId, value) {
		this._send(ANode.STRIP_PLUGIN_ENABLE, [stripId, pluginId], [value]);
	}

	setStripPluginParamValue (stripId, pluginId, paramId, value) {
		this._send(ANode.STRIP_PLUGIN_PARAM_VALUE, [stripId, pluginId, paramId], [value]);
	}

	// Private methods

	_send (node, addr, val) {
		const msg = new Message(node, addr, val);
		this._channel.send(msg);
		return msg;
	}

	async _sendAndReceive (node, addr, val) {
		return new Promise((resolve, reject) => {
			const hash = this._send(node, addr, val).hash;
			this._pendingRequest = {resolve: resolve, hash: hash};
		});
	}

	_onChannelMessage (msg) {
		if (this._pendingRequest && (this._pendingRequest.hash == msg.hash)) {
			this._pendingRequest.resolve(msg.val);
			this._pendingRequest = null;
		} else {
			this._fireCallbacks('message', msg);
			this._fireCallbacks(msg.node, ...msg.addr, ...msg.val);
		}
	}

	_fireCallbacks (name, ...args) {
		// name_with_underscores -> onNameWithUnderscores
		const method = 'on' + name.split('_').map((s) => {
			return s[0].toUpperCase() + s.slice(1).toLowerCase();
		}).join('');

		for (const callback of this._callbacks) {
			if (method in callback) {
				callback[method](...args)
			}
		}
	}

	_fetchResponseStatusError (status) {
		return new Error(`HTTP response status ${status}`);
	}

}