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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { raceTimeout } from 'vs/base/common/async';
import { Disposable } from 'vs/base/common/lifecycle';
import { FileAccess } from 'vs/base/common/network';
import { IAccessibilityService } from 'vs/platform/accessibility/common/accessibility';
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
import { Event } from 'vs/base/common/event';
import { localize } from 'vs/nls';
import { IObservable, observableFromEvent, derived } from 'vs/base/common/observable';
export const IAudioCueService = createDecorator<IAudioCueService>('audioCue');
export interface IAudioCueService {
readonly _serviceBrand: undefined;
playAudioCue(cue: AudioCue): Promise<void>;
playAudioCues(cues: AudioCue[]): Promise<void>;
isEnabled(cue: AudioCue): IObservable<boolean>;
playSound(cue: Sound): Promise<void>;
}
export class AudioCueService extends Disposable implements IAudioCueService {
readonly _serviceBrand: undefined;
private readonly screenReaderAttached = observableFromEvent(
this.accessibilityService.onDidChangeScreenReaderOptimized,
() => /** @description accessibilityService.onDidChangeScreenReaderOptimized */ this.accessibilityService.isScreenReaderOptimized()
);
constructor(
@IConfigurationService private readonly configurationService: IConfigurationService,
@IAccessibilityService private readonly accessibilityService: IAccessibilityService
) {
super();
}
public async playAudioCue(cue: AudioCue): Promise<void> {
if (this.isEnabled(cue).get()) {
await this.playSound(cue.sound);
}
}
public async playAudioCues(cues: AudioCue[]): Promise<void> {
// Some audio cues might reuse sounds. Don't play the same sound twice.
const sounds = new Set(cues.filter(cue => this.isEnabled(cue).get()).map(cue => cue.sound));
await Promise.all(Array.from(sounds).map(sound => this.playSound(sound)));
}
private getVolumeInPercent(): number {
const volume = this.configurationService.getValue<number>('audioCues.volume');
if (typeof volume !== 'number') {
return 50;
}
return Math.max(Math.min(volume, 100), 0);
}
public async playSound(sound: Sound): Promise<void> {
const url = FileAccess.asBrowserUri(
`vs/workbench/contrib/audioCues/browser/media/${sound.fileName}`,
require
).toString();
const audio = new Audio(url);
audio.volume = this.getVolumeInPercent() / 100;
try {
try {
// Don't play when loading takes more than 1s, due to loading, decoding or playing issues.
// Delayed sounds are very confusing.
await raceTimeout(audio.play(), 1000);
} catch (e) {
console.error('Error while playing sound', e);
}
} finally {
audio.remove();
}
}
private readonly obsoleteAudioCuesEnabled = observableFromEvent(
Event.filter(this.configurationService.onDidChangeConfiguration, (e) =>
e.affectsConfiguration('audioCues.enabled')
),
() => /** @description config: audioCues.enabled */ this.configurationService.getValue<'on' | 'off' | 'auto'>('audioCues.enabled')
);
private readonly isEnabledCache = new Cache((cue: AudioCue) => {
const settingObservable = observableFromEvent(
Event.filter(this.configurationService.onDidChangeConfiguration, (e) =>
e.affectsConfiguration(cue.settingsKey)
),
() => this.configurationService.getValue<'on' | 'off' | 'auto'>(cue.settingsKey)
);
return derived('audio cue enabled', reader => {
const setting = settingObservable.read(reader);
if (
setting === 'on' ||
(setting === 'auto' && this.screenReaderAttached.read(reader))
) {
return true;
}
const obsoleteSetting = this.obsoleteAudioCuesEnabled.read(reader);
if (
obsoleteSetting === 'on' ||
(obsoleteSetting === 'auto' && this.screenReaderAttached.read(reader))
) {
return true;
}
return false;
});
});
public isEnabled(cue: AudioCue): IObservable<boolean> {
return this.isEnabledCache.get(cue);
}
}
class Cache<TArg, TValue> {
private readonly map = new Map<TArg, TValue>();
constructor(private readonly getValue: (value: TArg) => TValue) {
}
public get(arg: TArg): TValue {
if (this.map.has(arg)) {
return this.map.get(arg)!;
}
const value = this.getValue(arg);
this.map.set(arg, value);
return value;
}
}
/**
* Corresponds to the audio files in ./media.
*/
export class Sound {
private static register(options: { fileName: string }): Sound {
const sound = new Sound(options.fileName);
return sound;
}
public static readonly error = Sound.register({ fileName: 'error.opus' });
public static readonly warning = Sound.register({ fileName: 'warning.opus' });
public static readonly foldedArea = Sound.register({ fileName: 'foldedAreas.opus' });
public static readonly break = Sound.register({ fileName: 'break.opus' });
public static readonly quickFixes = Sound.register({ fileName: 'quickFixes.opus' });
private constructor(public readonly fileName: string) { }
}
export class AudioCue {
private static _audioCues = new Set<AudioCue>();
private static register(options: {
name: string;
sound: Sound;
settingsKey: string;
}): AudioCue {
const audioCue = new AudioCue(options.sound, options.name, options.settingsKey);
AudioCue._audioCues.add(audioCue);
return audioCue;
}
public static get allAudioCues() {
return [...this._audioCues];
}
public static readonly error = AudioCue.register({
name: localize('audioCues.lineHasError.name', 'Error on Line'),
sound: Sound.error,
settingsKey: 'audioCues.lineHasError',
});
public static readonly warning = AudioCue.register({
name: localize('audioCues.lineHasWarning.name', 'Warning on Line'),
sound: Sound.warning,
settingsKey: 'audioCues.lineHasWarning',
});
public static readonly foldedArea = AudioCue.register({
name: localize('audioCues.lineHasFoldedArea.name', 'Folded Area on Line'),
sound: Sound.foldedArea,
settingsKey: 'audioCues.lineHasFoldedArea',
});
public static readonly break = AudioCue.register({
name: localize('audioCues.lineHasBreakpoint.name', 'Breakpoint on Line'),
sound: Sound.break,
settingsKey: 'audioCues.lineHasBreakpoint',
});
public static readonly inlineSuggestion = AudioCue.register({
name: localize('audioCues.lineHasInlineSuggestion.name', 'Inline Suggestion on Line'),
sound: Sound.quickFixes,
settingsKey: 'audioCues.lineHasInlineSuggestion',
});
public static readonly onDebugBreak = AudioCue.register({
name: localize('audioCues.onDebugBreak.name', 'Debugger Stopped on Breakpoint'),
sound: Sound.break,
settingsKey: 'audioCues.onDebugBreak',
});
public static readonly noInlayHints = AudioCue.register({
name: localize('audioCues.noInlayHints', 'No Inlay Hints on Line'),
sound: Sound.error,
settingsKey: 'audioCues.noInlayHints'
});
private constructor(
public readonly sound: Sound,
public readonly name: string,
public readonly settingsKey: string,
) { }
}
|
