Add README

[sound.git] / sound.js

diff --git a/sound.js b/sound.js
index 843be80670bcda818c25042a1b75f0dad78e527e..23039273b02897c7a3d2aeb3e4fcbc3bd022ddb1 100644 (file)
--- a/sound.js
+++ b/sound.js
@@ -1,11 +1,33 @@
-function Sound() {
+/* Copyright (c) 2014 Jer Noble
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+function Sound(src) {
+
+       if (Sound.audioContext === undefined) {
+               var AudioContext = window.AudioContext || window.webkitAudioContext || window.mozAudioContext;
+               Sound.audioContext = new AudioContext();
+       }

 
 

-       if (Sound.audioContext === undefined)
-               Sound.audioContext = new webkitAudioContext();
-
-       this._src = null;

        this._networkState = this.NETWORK.EMPTY;
        this._networkState = this.NETWORK.EMPTY;

-       this._preload = true;
+       this._preload = this.PRELOAD.AUTO;

        this._buffered = {};
        this._readyState = this.READY.NOTHING;
        this._seeking = false;
        this._buffered = {};
        this._readyState = this.READY.NOTHING;
        this._seeking = false;


@@ -15,7 +37,7 @@ function Sound() {
        this._played = {};
        this._seekable = {};
        this._ended = false;
        this._played = {};
        this._seekable = {};
        this._ended = false;

-       this._autoplay = false;
+       this._autoplay = true;

        this._loop = false;
        this._volume = 1;
        this._muted = false;
        this._loop = false;
        this._volume = 1;
        this._muted = false;


@@ -26,11 +48,14 @@ function Sound() {
        this.gainNode = null;
 
        this.ajax = null;
        this.gainNode = null;
 
        this.ajax = null;

-       this.eventListeners = { }; 
-       this.shouldBePlaying = 0;
+       this.eventListeners = { };

        this.startTime = 0;
        this.nextStartTime = 0;
        this.startTime = 0;
        this.nextStartTime = 0;

-       this.load();
+
+       this.autoplaying = false;
+       this.delayingTheLoadEvent = false;
+
+       this.setSrc(src);

 }
 
 Sound.prototype = {
 }
 
 Sound.prototype = {


@@ -58,6 +83,12 @@ Sound.prototype = {
                ENOUGH_DATA: 4,
        },
 
                ENOUGH_DATA: 4,
        },
 

+       PRELOAD: {
+               NONE: 0,
+               METADATA: 1,
+               AUTO: 2,
+       },
+

        load: function() {
                if (this.ajax)
                        this.ajax.abort();
        load: function() {
                if (this.ajax)
                        this.ajax.abort();


@@ -75,9 +106,21 @@ Sound.prototype = {
 
                this.setPlaybackRate(this.defaultPlaybackRate);
                this._error = null;
 
                this.setPlaybackRate(this.defaultPlaybackRate);
                this._error = null;

-               this._autoplay = true;
+               this.autoplaying = true;

                this.stopInternal();
 
                this.stopInternal();
 

+               this.selectResource();
+               
+       },
+
+       selectResource: function() {
+               this._networkState = this.NETWORK.NO_SOURCE;
+               this.delayingTheLoadEvent = true;
+
+               setTimeout(this.selectResourceAsync.bind(this), 0);
+       },
+
+       selectResourceAsync: function() {

                if (!this._src) {
                        this._networkState = this.NETWORK.EMPTY;
                        return;
                if (!this._src) {
                        this._networkState = this.NETWORK.EMPTY;
                        return;


@@ -86,6 +129,17 @@ Sound.prototype = {
                this._networkState = this.NETWORK.LOADING;
                this.dispatchEventAsync(new CustomEvent('loadstart'));
 
                this._networkState = this.NETWORK.LOADING;
                this.dispatchEventAsync(new CustomEvent('loadstart'));
 

+               setTimeout(this.fetchResource(), 0);
+       },
+
+       fetchResource: function() {
+               if (this._preload === this.PRELOAD.NONE) {
+                       this._networkState = this.NETWORK.IDLE;
+                       this.dispatchEventAsync(new CustomEvent('suspend'));
+                       this.delayingTheLoadEvent = false;
+                       return;
+               }
+

                this.ajax = new XMLHttpRequest();
                this.ajax.open("GET", this._src, true);
                this.ajax.responseType = "arraybuffer";
                this.ajax = new XMLHttpRequest();
                this.ajax.open("GET", this._src, true);
                this.ajax.responseType = "arraybuffer";


@@ -93,18 +147,21 @@ Sound.prototype = {
                        if (!this.ajax.response)
                                return;
                        
                        if (!this.ajax.response)
                                return;
                        

+                       this._networkState = this.NETWORK.IDLE;
+                       this.dispatchEventAsync(new CustomEvent('suspend'));

                        this.setReadyState(this.READY.FUTURE_DATA);
 
                        try {
                                Sound.audioContext.decodeAudioData(
                        this.setReadyState(this.READY.FUTURE_DATA);
 
                        try {
                                Sound.audioContext.decodeAudioData(

-                                       this.ajax.response, 
+                                       this.ajax.response,

                                        function(buffer) {
                                                this.buffer = buffer;
                                        function(buffer) {
                                                this.buffer = buffer;

-                                               if (this.shouldBePlaying)
+                                               if (this.autoplaying && this._paused && this._autoplay)

                                                        this.play();
                                                        this.play();

-                                       }.bind(this), 
-                                       function(error) { 
-                                               console.log("Error in creating buffer for sound '" + this._src + "': " + error); 
+                                               this.dispatchEventAsync(new CustomEvent('canplaythrough'));
+                                       }.bind(this),
+                                       function(error) {
+                                               console.log("Error in creating buffer for sound '" + this._src + "': " + error);

                                        }.bind(this)
                                );
                        } catch(exception) {
                                        }.bind(this)
                                );
                        } catch(exception) {


@@ -114,12 +171,21 @@ Sound.prototype = {
                this.ajax.onprogress = function() {
                        this.dispatchEventAsync(new CustomEvent('progress'));
                }.bind(this);
                this.ajax.onprogress = function() {
                        this.dispatchEventAsync(new CustomEvent('progress'));
                }.bind(this);

+               this.ajax.onerror = function() {
+                       this.error = { code: MediaError.MEDIA_ERR_SRC_NOT_SUPPORTED };
+                       this._networkState = this.NETWORK.NO_SOURCE;
+                       this.dispatchEventAsync(new CustomEvent('error'));
+                       this.delayingTheLoadEvent = false;
+               }.bind(this);

                this.ajax.send();
        },
 
        play: function() {
                this.ajax.send();
        },
 
        play: function() {

+               if (this._networkState === this.NETWORK.EMPTY)
+                       this.loadResource();
+

                if (!this.buffer) {
                if (!this.buffer) {

-                       this.shouldBePlaying = true;                    
+                       this.autoplaying = true;

                        return;
                }
 
                        return;
                }
 


@@ -147,7 +213,7 @@ Sound.prototype = {
 
        playInternal: function() {
                this.gainNode = Sound.audioContext.createGainNode();
 
        playInternal: function() {
                this.gainNode = Sound.audioContext.createGainNode();

-               this.gainNode.gain.value = this._volume;
+               this.gainNode.gain.value = this._muted ? 0 : this._volume;

                this.gainNode.connect(Sound.audioContext.destination);
 
                this.node = Sound.audioContext.createBufferSource();
                this.gainNode.connect(Sound.audioContext.destination);
 
                this.node = Sound.audioContext.createBufferSource();


@@ -160,6 +226,9 @@ Sound.prototype = {
 
 
        pause: function() {
 
 
        pause: function() {

+               if (this._networkState === this.NETWORK.EMPTY)
+                       this.loadResource();
+

                this._autoplay = false;
 
                if (!this._paused) {
                this._autoplay = false;
 
                if (!this._paused) {


@@ -187,6 +256,13 @@ Sound.prototype = {
        },
 
        onended: function() {
        },
 
        onended: function() {

+               if (this._loop) {
+                       this.stopInternal();
+                       this.setCurrentTime(0);
+                       this.playInternal();
+                       return;
+               }
+

                this._ended = true;
                this.nextStartTime = 0;
                this.stopInternal();
                this._ended = true;
                this.nextStartTime = 0;
                this.stopInternal();


@@ -237,7 +313,8 @@ Sound.prototype = {
 
        setSrc: function(src) {
                this._src = src;
 
        setSrc: function(src) {
                this._src = src;

-               this.load();
+               if (this._src)
+                       this.load();

        },
 
        getCurrentSrc: function() {
        },
 
        getCurrentSrc: function() {


@@ -257,21 +334,30 @@ Sound.prototype = {
        },
 
        getPreload: function() {
        },
 
        getPreload: function() {

-               if (!this._preload)
-                       return 'none';
-               return 'auto';
+               switch (this._preload) {
+                       case this.PRELOAD.NONE: return 'none';
+                       case this.PRELOAD.METADATA: return 'metadata';
+                       case this.PRELOAD.AUTO: return 'auto';
+                       default: return '';
+               }

        },
 
        setPreload: function(preload) {
                switch (preload) {
        },
 
        setPreload: function(preload) {
                switch (preload) {

-               case 'none':
-                       this._preload = false;
-                       break;
-               default:
-                       this._preload = true;
-                       if (!this.buffer)
-                               load();
-                       break;
+                       default:
+                       case 'none':
+                               this._preload = this.PRELOAD.NONE;
+                               break;
+                       case 'metadata':
+                               this._preload = this.PRELOAD.METADATA;
+                               if (this._networkState === this.NETWORK.EMPTY)
+                                       this.load();
+                               break;
+                       case 'auto':
+                               this._preload = this.PRELOAD.auto;
+                               if (this._networkState === this.NETWORK.EMPTY)
+                                       this.load();
+                               break;

                }
        },
 
                }
        },
 


@@ -281,7 +367,7 @@ Sound.prototype = {
                return this.nextStartTime + Sound.audioContext.currentTIme - this.startTime;
        },
 
                return this.nextStartTime + Sound.audioContext.currentTIme - this.startTime;
        },
 

-       setCurrentTime: function(time) { 
+       setCurrentTime: function(time) {

                this.nextStartTime = time;
                this.dispatchEventAsync(new CustomEvent('timeupdate'));
                if (!this.node)
                this.nextStartTime = time;
                this.dispatchEventAsync(new CustomEvent('timeupdate'));
                if (!this.node)


@@ -320,7 +406,7 @@ Sound.prototype = {
        },
 
        setVolume: function(volume) {
        },
 
        setVolume: function(volume) {

-               if (this._volume == volume)
+               if (this._volume === volume)

                        return;
 
                this._volume = volume;
                        return;
 
                this._volume = volume;


@@ -335,7 +421,7 @@ Sound.prototype = {
        },
 
        setMuted: function(muted) {
        },
 
        setMuted: function(muted) {

-               if (this._muted == muted)
+               if (this._muted === muted)

                        return;
 
                this._muted = muted;
                        return;
 
                this._muted = muted;


@@ -344,6 +430,27 @@ Sound.prototype = {
                if (this.gainNode)
                        this.gainNode.gain.value = this._muted ? 0 : this._volume;
        },
                if (this.gainNode)
                        this.gainNode.gain.value = this._muted ? 0 : this._volume;
        },

+
+       getAutoplay: function() {
+               return this._autoplay;
+       },
+
+       setAutoplay: function(autoplay) {
+               if (this._autoplay === autoplay)
+                       return;
+
+               this._autoplay = autoplay;
+               if (this._autoplay && this._networkState === this.NETWORK.EMPTY)
+                       this.load();
+       },
+
+       getLoop: function() {
+               return this._loop;
+       },
+
+       setLoop: function(loop) {
+               this._loop = loop;
+       },

 };
 
 Object.defineProperty(Sound.prototype, 'src', {
 };
 
 Object.defineProperty(Sound.prototype, 'src', {


@@ -441,8 +548,17 @@ Object.defineProperty(Sound.prototype, 'defaultMuted', {
        set: Sound.prototype.setDefaultMuted,
 });
 
        set: Sound.prototype.setDefaultMuted,
 });
 

+Object.defineProperty(Sound.prototype, 'preload', {
+       get: Sound.prototype.getPreload,
+       set: Sound.prototype.setPreload,
+});
+

 document.createElement = function(elementName) {
        if (elementName === "Audio" || elementName === "audio")
                return new Sound();
        return Document.prototype.createElement.call(this, elementName);
 document.createElement = function(elementName) {
        if (elementName === "Audio" || elementName === "audio")
                return new Sound();
        return Document.prototype.createElement.call(this, elementName);

+};
+
+window.Audio = function(src) {
+       return new Sound(src);

 };
\ No newline at end of file
 };
\ No newline at end of file