phaser/v3/src/sound/BaseSound.js

310 lines
9.7 KiB
JavaScript
Raw Normal View History

2017-11-14 15:00:24 +00:00
var Class = require('../utils/Class');
var Extend = require('../utils/object/Extend');
var EventDispatcher = require('../events/EventDispatcher');
var NOOP = require('../utils/NOOP');
2017-11-14 15:00:24 +00:00
// Phaser.Sound.BaseSound
var BaseSound = new Class({
initialize: function BaseSound(manager, key, config) {
/**
* Local reference to the sound manager.
*
* @private
2017-11-14 15:00:24 +00:00
* @property {Phaser.Sound.BaseSoundManager} manager
*/
this.manager = manager;
/**
* [description]
*
* @property {string} key
*/
2017-11-14 15:00:24 +00:00
this.key = key;
/**
* Flag indicating if sound is currently playing.
*
* @readonly
* @property {boolean} isPlaying
*/
this.isPlaying = false;
/**
* Flag indicating if sound is currently paused.
*
* @readonly
* @property {boolean} isPaused
*/
this.isPaused = false;
/**
* A property that holds the value of sound's actual playback rate,
* after its rate and detune values has been combined with global
* rate and detune values.
*
* @property {number} totalRate
*/
this.totalRate = 1;
/**
* A value representing the duration, in seconds.
* It could be total sound duration or a marker duration.
*
* @readonly
* @property {number} duration
*/
this.duration = this.duration || 0;
/**
* Duration of the entire sound.
*
* @readonly
* @property {number}
*/
this.totalDuration = this.totalDuration || 0;
/**
* [description]
*
* Default values will be set by properties' setters.
*
* @private
* @property {ISoundConfig} config
*/
this.config = {};
/**
* Reference to the currently used config.
* It could be default config or marker config.
*
* @private
* @property {ISoundConfig} currentConfig
*/
this.currentConfig = this.config;
/**
2017-12-07 19:57:05 +00:00
* Boolean indicating whether the sound is muted or not.
* Gets or sets the muted state of this sound.
*
* @property {boolean} mute
*/
2017-11-14 15:00:24 +00:00
this.mute = false;
/**
* Gets or sets the volume of this sound,
* a value between 0 (silence) and 1 (full volume).
*
* @property {number} volume
*/
2017-11-14 15:00:24 +00:00
this.volume = 1;
/**
* Defines the speed at which the audio asset will be played.
* Value of 1.0 plays the audio at full speed, 0.5 plays the audio
* at half speed and 2.0 doubles the audio's playback speed.
* This value gets multiplied by global rate to have the final playback speed.
*
* @property {number} rate
*/
2017-11-14 15:00:24 +00:00
this.rate = 1;
2017-11-16 15:41:48 +00:00
/**
* Represents detuning of sound in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).
* The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).
*
* @property {number} detune
*/
this.detune = 0;
/**
2017-12-07 19:56:34 +00:00
* Property representing the position of playback for this sound, in seconds.
* Setting it to a specific value moves current playback to that position.
* The value given is clamped to the range 0 to current marker duration.
* Setting seek of a stopped sound has no effect.
*
* @property {number} seek
*/
2017-11-14 15:00:24 +00:00
this.seek = 0;
/**
* [description]
*
* @property {boolean} loop
*/
2017-11-14 15:00:24 +00:00
this.loop = false;
this.config = Extend(this.config, config);
/**
* Object containing markers definitions.
*
* @readonly
* @property {{}} markers
*/
this.markers = {};
/**
* Currently playing marker.
* 'null' if whole sound is playing.
*
* @readonly
* @property {ISoundMarker} currentMarker
*/
this.currentMarker = null;
/**
* [description]
*
* @protected
* @property {Phaser.Tween}
*/
this.fadeTween = null; // TODO see how to use global tween
/**
* Event dispatches used to handle all sound instance
* relevant events.
*
* @property {Phaser.Events.EventDispatcher}
*/
2017-11-14 15:00:24 +00:00
this.events = new EventDispatcher();
},
addMarker: function (marker) {
if (!marker) {
console.error('addMarker - Marker object has to be provided!');
return false;
}
2017-11-23 11:34:43 +00:00
if (!marker.name || typeof marker.name !== 'string') {
console.error('addMarker - Marker has to have a valid name!');
return false;
2017-11-23 11:34:43 +00:00
}
2017-11-23 11:35:55 +00:00
if (this.markers[marker.name]) {
console.error('addMarker - Marker with name \'' + marker.name + '\' already exists for sound \'' + this.key + '\'!');
return false;
2017-11-23 11:35:55 +00:00
}
marker = Extend(true, {
name: '',
start: 0,
duration: this.totalDuration,
config: {
mute: false,
volume: 1,
rate: 1,
detune: 0,
seek: 0,
loop: false
}
}, marker);
this.markers[marker.name] = marker;
2017-11-23 11:35:55 +00:00
return true;
2017-11-14 15:00:24 +00:00
},
updateMarker: function (marker) {
if (!marker) {
console.error('updateMarker - Marker object has to be provided!');
return false;
}
if (!marker.name || typeof marker.name !== 'string') {
console.error('updateMarker - Marker has to have a valid name!');
return false;
}
if (!this.markers[marker.name]) {
console.error('updateMarker - Marker with name \'' + marker.name + '\' does not exist for sound \'' + this.key + '\'!');
return false;
}
this.markers[marker.name] = Extend(true, this.markers[marker.name], marker);
return true;
},
2017-11-14 15:00:24 +00:00
removeMarker: function (markerName) {
var marker = this.markers[markerName];
if (!marker) {
console.error('removeMarker - Marker with name \'' + marker.name + '\' does not exist for sound \'' + this.key + '\'!');
return null;
}
this.markers[markerName] = null;
return marker;
2017-11-14 15:00:24 +00:00
},
play: function (markerName, config) {
if (markerName === void 0) { markerName = ''; }
if (typeof markerName === 'object') {
config = markerName;
markerName = '';
}
if (typeof markerName !== 'string') {
console.error('Sound marker name has to be a string!');
return null;
}
if (!markerName) {
this.currentMarker = null;
this.currentConfig = this.config;
this.duration = this.totalDuration;
}
else {
if (!this.markers[markerName]) {
console.error('No marker with name \'' + markerName + '\' found for sound \'' + this.key + '\'!');
return null;
}
this.currentMarker = this.markers[markerName];
this.currentConfig = this.currentMarker.config;
this.duration = this.currentMarker.duration;
}
this.resetConfig();
this.currentConfig = Extend(this.currentConfig, config);
this.isPlaying = true;
this.isPaused = false;
2017-11-14 15:00:24 +00:00
return this;
},
pause: function () {
if (this.isPaused || !this.isPlaying) {
return false;
}
this.isPlaying = false;
this.isPaused = true;
return true;
2017-11-14 15:00:24 +00:00
},
resume: function () {
if (!this.isPaused || this.isPlaying) {
return false;
}
this.isPlaying = true;
this.isPaused = false;
return true;
2017-11-14 15:00:24 +00:00
},
stop: function () {
if (!this.isPaused && !this.isPlaying) {
return false;
}
this.isPlaying = false;
this.isPaused = false;
2017-12-07 19:17:38 +00:00
this.resetConfig();
return true;
2017-11-14 15:00:24 +00:00
},
2017-11-26 15:19:56 +00:00
/**
* @protected
2017-11-26 15:19:56 +00:00
*/
applyConfig: function () {
this.mute = this.currentConfig.mute;
this.volume = this.currentConfig.volume;
this.loop = this.currentConfig.loop;
this.rate = this.currentConfig.rate;
this.detune = this.currentConfig.detune;
// TODO assign other config values to buffer source
},
/**
* @protected
*/
resetConfig: function () {
this.currentConfig.seek = 0;
// TODO add delay
},
2017-11-14 15:00:24 +00:00
fadeTo: function (volume, duration) {
return null;
},
/**
* @protected
*/
update: NOOP,
2017-11-14 15:00:24 +00:00
destroy: function () {
this.manager.remove(this); // TODO replace with pendingRemove
this.manager = null;
this.key = '';
this.isPlaying = false;
this.isPaused = false;
this.config = null;
this.currentConfig = null;
this.markers = null;
this.currentMarker = null;
this.fadeTween = null;
this.events.destroy();
this.events = null;
},
/**
* @protected
*/
setRate: function () {
var cent = 1.0005777895065548; // Math.pow(2, 1/1200);
2017-12-04 21:05:29 +00:00
var totalDetune = this.currentConfig.detune + this.manager.detune;
var detuneRate = Math.pow(cent, totalDetune);
this.totalRate = this.currentConfig.rate * this.manager.rate * detuneRate;
2017-11-14 15:00:24 +00:00
}
});
module.exports = BaseSound;