Merge pull request phaserjs#1205 from codevinsky/feature/audiosprite

Phaser.AudioSprite

Author: photonstorm

src/gameobjects/GameObjectCreator.js

@@ -124,6 +124,16 @@ Phaser.GameObjectCreator.prototype = {
         return this.game.sound.add(key, volume, loop, connect);
 
     },
+    /**
+     * Creates a new AudioSprite object.
+     *
+     * @method Phaser.GameObjectCreator#audioSrpite
+     * @param {string} key - The Game.cache key of the sound that this object will use.
+     * @return {Phaser.AudioSprite} The newly created audioSprite object.
+     */
+    audiosprite: function(key) {
+        return this.game.sound.addSprite(key);
+    },
 
     /**
     * Creates a new Sound object.

src/gameobjects/GameObjectFactory.js

@@ -179,6 +179,17 @@ Phaser.GameObjectFactory.prototype = {
 
     },
 
+    /**
+     * Creates a new AudioSprite object.
+     *
+     * @method Phaser.GameObjectCreator#audioSrpite
+     * @param {string} key - The Game.cache key of the sound that this object will use.
+     * @return {Phaser.AudioSprite} The newly created audioSprite object.
+     */
+    audiosprite: function(key) {
+        return this.game.sound.addSprite(key);
+    },
+
     /**
     * Creates a new TileSprite object.
     *

src/loader/Loader.js

@@ -8,7 +8,7 @@
 /**
 * The Loader handles loading all external content such as Images, Sounds, Texture Atlases and data files.
 * It uses a combination of Image() loading and xhr and provides progress and completion callbacks.
-* 
+*
 * @class Phaser.Loader
 * @constructor
 * @param {Phaser.Game} game - A reference to the currently running game.
@@ -48,7 +48,7 @@ Phaser.Loader = function (game) {
     * You can optionally link a sprite to the preloader.
     * If you do so the Sprites width or height will be cropped based on the percentage loaded.
     * This property is an object containing: sprite, rect, direction, width and height
-    * 
+    *
     * @property {object} preloadSprite
     */
     this.preloadSprite = null;
@@ -94,10 +94,10 @@ Phaser.Loader = function (game) {
     this.onLoadComplete = new Phaser.Signal();
 
     /**
-    * @property {Phaser.Signal} onPackComplete - This event is dispatched when an asset pack has either loaded or failed. 
+    * @property {Phaser.Signal} onPackComplete - This event is dispatched when an asset pack has either loaded or failed.
     */
     this.onPackComplete = new Phaser.Signal();
-    
+
     /**
     * @property {boolean} useXDomainRequest - If true and if the browser supports XDomainRequest, it will be used in preference for xhr when loading json files. It is enabled automatically if the browser is IE9, but you can disable it as required.
     */
@@ -215,7 +215,7 @@ Phaser.Loader.prototype = {
     /**
     * Check whether asset exists with a specific key.
     * Use Phaser.Cache to access loaded assets, e.g. Phaser.Cache#checkImageKey
-    * 
+    *
     * @method Phaser.Loader#checkKeyExists
     * @param {string} type - The type asset you want to check.
     * @param {string} key - Key of the asset you want to check.
@@ -614,6 +614,21 @@ Phaser.Loader.prototype = {
 
     },
 
+    /**
+     * Add a new audiosprite file to the loader.
+     *
+     * @method Phaser.Loader#audiosprite
+     * @param {string} key - Unique asset key of the audio file.
+     * @param {Array|string} urls - An array containing the URLs of the audio files, i.e.: [ 'audiosprite.mp3', 'audiosprite.ogg', 'audiosprite.m4a' ] or a single string containing just one URL.
+     * @param {string} atlasurl - the url containing the audiosprite configuration json
+     * @return {Phaser.Loader} This Loader instance.
+     */
+    audiosprite: function(key, urls, atlasurl) {
+        this.audio(key, urls);
+        this.json(key + '-audioatlas', atlasurl);
+        return this;
+    },
+
     /**
     * Add a new tilemap loading request.
     *
@@ -1000,7 +1015,7 @@ Phaser.Loader.prototype = {
             console.warn('Phaser.Loader loadPackList invalid index ' + this._packIndex);
             return;
         }
-        
+
         var pack = this._packList[this._packIndex];
 
         if (pack.data !== null)
@@ -1179,7 +1194,7 @@ Phaser.Loader.prototype = {
             console.warn('Phaser.Loader loadFile invalid index ' + this._fileIndex);
             return;
         }
-        
+
         var file = this._fileList[this._fileIndex];
         var _this = this;
 
@@ -1263,7 +1278,7 @@ Phaser.Loader.prototype = {
                     this._ajax.onerror = function () {
                         return _this.dataLoadError(_this._fileIndex);
                     };
-                       
+
                     this._ajax.ontimeout = function () {
                         return _this.dataLoadError(_this._fileIndex);
                     };
@@ -1276,7 +1291,7 @@ Phaser.Loader.prototype = {
 
                     this._ajax.open('GET', this.baseURL + file.url, true);
 
-                    //  Note: The xdr.send() call is wrapped in a timeout to prevent an issue with the interface where some requests are lost 
+                    //  Note: The xdr.send() call is wrapped in a timeout to prevent an issue with the interface where some requests are lost
                     //  if multiple XDomainRequests are being sent at the same time.
                     setTimeout(function () {
                         this._ajax.send();
@@ -1325,7 +1340,7 @@ Phaser.Loader.prototype = {
 
     /**
     * Starts the xhr loader.
-    * 
+    *
     * @method Phaser.Loader#xhrLoad
     * @private
     * @param {number} index - The index of the file to load from the file list.
@@ -1355,7 +1370,7 @@ Phaser.Loader.prototype = {
 
     /**
     * Private method ONLY used by loader.
-    * 
+    *
     * @method Phaser.Loader#getAudioURL
     * @private
     * @param {array|string} urls - Either an array of audio file URLs or a string containing a single URL path.

src/sound/AudioSprite.js

@@ -0,0 +1,76 @@
+/**
+ * @author       Jeremy Dowell <jeremy@codevinsky.com>
+ * @copyright    2014 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * The AudioSprite class constructor.
+ *
+ * @class Phaser.AudioSprite
+ * @constructor
+ * @param {Phaser.Game} game - Reference to the current game instance.
+ * @param {string} key - Asset key for the sound.
+ */
+
+Phaser.AudioSprite = function(game, key) {
+    this.game = game;
+    this.key = key;
+    this.config = this.game.cache.getJSON(key + '-audioatlas');
+    this.autoplayKey = null;
+    this.autoplay = null;
+    this.sounds = {};
+    for (var k in this.config.spritemap) {
+        var marker = this.config.spritemap[k];
+        var s = this.game.add.sound(this.key);
+        if (marker.loop) {
+            s.addMarker(k, marker.start, (marker.end - marker.start), null, true);
+        } else {
+            s.addMarker(k, marker.start, (marker.end - marker.start), null, false);
+        }
+        this.sounds[k] = s;
+    }
+    if (this.config.autoplay) {
+        this.autoplayKey = this.config.autoplay;
+        this.play(this.autoplayKey);
+        this.autoplay = this.sounds[this.autoplayKey];
+    }
+};
+
+Phaser.AudioSprite.prototype = {
+    /**
+     * Play a sound with the given name
+     * @method Phaser.AudioSprite#play
+     * @param {string} [marker] - The name of sound to play
+     * @param {number} [volume=1] - Volume of the sound you want to play. If none is given it will use the volume given to the Sound when it was created (which defaults to 1 if none was specified).
+     * @return {Phaser.Sound} This sound instance.
+     */
+    play: function(marker, volume) {
+        volume = typeof volume === 'undefined' ? 1 : volume;
+        return this.sounds[marker].play(marker, null, volume);
+    },
+    /**
+     * Play a sound with the given name
+     * @method Phaser.AudioSprite#stop
+     * @param {string} [marker=''] - The name of sound to stop. If none is given, stop all sounds in the audiosprite
+     * @return {Phaser.Sound} This sound instance.
+     */
+    stop: function(marker) {
+        if (!marker) {
+            for (var key in this.sounds) {
+                this.sounds[key].stop();
+            }
+        } else {
+            this.sounds[marker].stop();
+        }
+    },
+    /**
+     * Get a sound with the given name
+     * @method Phaser.AudioSprite#play
+     * @param {string} [marker] - The name of sound to get
+     * @return {Phaser.Sound} This sound instance.
+     */
+    get: function(marker) {
+        return this.sounds[marker];
+    }
+};

src/sound/SoundManager.js

@@ -366,6 +366,18 @@ Phaser.SoundManager.prototype = {
 
     },
 
+    /**
+     * Adds a new AudioSprite into the SoundManager.
+     *
+     * @method Phaser.SoundManager#add
+     * @param {string} key - Asset key for the sound.
+     * @return {Phaser.AudioSprite} The new AudioSprite instance.
+     */
+    addSprite: function(key) {
+        var audioSprite = new Phaser.AudioSprite(this.game, key);
+        return audioSprite;
+    },
+
     /**
     * Removes a Sound from the SoundManager. The removed Sound is destroyed before removal.
     *