Changeset 908

Timestamp:

03/29/10 20:43:53 (3 years ago)

Author:

jeroen

Message:

added ducking to audiodescription plugin.

Location:

plugins/audiodescription/v4

Files:

• audiodescription.swf (modified) (previous)
• audiodescription.xml (modified) (2 diffs)
• build.sh (modified) (1 diff)
• com/jeroenwijering/plugins/Audiodescription.as (modified) (9 diffs)

plugins/audiodescription/v4/audiodescription.xml

@@ -12 +12 @@
         <flashvars>
                 <flashvar>
+                        <name>debug</name>
+                        <default>false</default>
+                        <description>When set to 'true', the plugin renders the waveform and ducking percentage on screen.</description>
+                </flashvar>
+                <flashvar>
+                        <name>ducking</name>
+                        <default>60</default>
+                        <description>The volume percentage the original audio is ducked (0 to 100).</description>
+                </flashvar>
+                <flashvar>
                         <name>file</name>
                         <default></default>
                         <description>Location of the audiodescription MP3 to play.</description>
+                </flashvar>
+                <flashvar>
+                        <name>gain</name>
+                        <default>1</default>
+                        <description>Gain of the audiodescription compared to the original audio. Set a value of e.g. 2 if the audiodescription is very soft.</description>
                 </flashvar>
                 <flashvar>
@@ -24 +39 @@
                         <name>volume</name>
                         <default>90</default>
-                        <description>Volume of the audiodescription. Crank this even more up to have the AD overrule the default sound.</description>
+                        <description>Start volume of both the original audio and the audiodescription. Overrides the global volume flashvar.</description>
                 </flashvar>
         </flashvars>

plugins/audiodescription/v4/build.sh

@@ -5 +5 @@
 
 echo "Compiling with MXMLC..."
-$FLEXPATH/bin/mxmlc ./com/jeroenwijering/plugins/Audiodescription.as -sp ./ -o ./audiodescription.swf -use-network=false
+$FLEXPATH/bin/mxmlc ./com/jeroenwijering/plugins/Audiodescription.as -sp ./ -o ./audiodescription.swf -use-network=false -target-player="10.0.0"

plugins/audiodescription/v4/com/jeroenwijering/plugins/Audiodescription.as

@@ -12 +12 @@
 import flash.media.*;
 import flash.net.*;
+import flash.utils.ByteArray;
 
 
@@ -25 +26 @@
         /** Reference to the dock button. **/
         private var button:MovieClip;
+        /** Sound channel object. **/
+        private var channel:SoundChannel;
+        /** Current volume. **/
+        private var current:Number = -1;
         /** List with configuration settings. **/
         public var config:Object = {
+                ducking:80,
+                debug:false,
                 file:undefined,
+                gain:1,
                 state:true,
                 volume:90
-        }
+        };
+        /** Array with ducking samples, used for the ducking. **/
+        private var ducks:Array;
+        /** Reference to the icon. **/
+        private var icon:Bitmap;
+        /** Array with waveform samples, used for the ducking. **/
+        private var waves:Array;
+        /** A bunch of clips drawn for the debug menu. **/
+        private var clips:Object;
+        /** sound object to be instantiated. **/
+        private var sound:Sound;
         /** Reference to the MVC view. **/
         private var view:AbstractView;
-        /** Reference to the icon. **/
-        private var icon:Bitmap;
-        /** sound object to be instantiated. **/
-        private var sound:Sound;
-        /** Sound channel object. **/
-        private var channel:SoundChannel;
+        /** Volume of the original audio. **/
+        private var original:Number;
 
 
@@ -58 +72 @@
                 }
                 setState(config['state']);
+                if(config['debug']) {
+                        drawClips();
+                }
         };
 
@@ -67 +84 @@
 
 
+        /** Extract a waveform of the sound when it's completed. **/
+        private function completeHandler(evt:Event):void {
+                var arr:ByteArray;
+                var bts:Number = 4410;
+                var pos:Number;
+                // load a sound sample every .1 second.
+                while(bts == 4410) {
+                        arr = new ByteArray();
+                        bts = sound.extract(arr,4410);
+                        arr.position = 0;
+                        if(arr.bytesAvailable > 7) {
+                                waves.push(arr.readFloat());
+                        }
+                }
+                if(config['debug']) { drawWave() };
+                // quantify the ducking and add some margin.
+                var i:Number = 0;
+                while(i<waves.length) {
+                        if(waves[i] == 0) {
+                                ducks.push(0);
+                                i++;
+                        } else {
+                                ducks[i-1] = ducks[i] = 1;
+                                ducks.push(1,1,1);
+                                i += 3;
+                        }
+                }
+                // Smooth out the ducking.
+                var tmp:Array = new Array(ducks[0],ducks[1]);
+                for(i=2; i < ducks.length-2; i++) {
+                        tmp.push((ducks[i-2] + ducks[i-1] + ducks[i] + ducks[i+1] + ducks[i+2])/5);
+                }
+                ducks.push(ducks[ducks.length-2],ducks[ducks.length-1]);
+                ducks = tmp;
+                if(config['debug']) { drawDucks() };
+        };
+
+
+        /** Draw the overall clips. **/
+        private function drawClips():void {
+                var back:MovieClip = new MovieClip();
+                back.graphics.beginFill(0x000000,0.8);
+                back.graphics.drawRect(0,0,view.config['width'],100);
+                addChild(back);
+                var wave:MovieClip = new MovieClip();
+                wave.y = 50;
+                addChild(wave);
+                var duck:MovieClip = new MovieClip();
+                addChild(duck);
+                var line:MovieClip = new MovieClip();
+                line.graphics.beginFill(0xFF0000);
+                line.graphics.drawRect(0,0,1,100);
+                addChild(line);
+                clips = {back:back,wave:wave,duck:duck,line:line};
+        };
+
+
+        /** Draw the audiodescription waveform. **/
+        private function drawDucks():void {
+                clips.duck.graphics.clear();
+                clips.duck.graphics.moveTo(0,0);
+                clips.duck.graphics.lineStyle(1,0x0000FF);
+                for(var i:Number=0; i<ducks.length; i++) {
+                        clips.duck.graphics.lineTo(i,100 - config['volume'] + ducks[i]*config['ducking']);
+                }
+                clips.duck.width = view.config['width'];
+        };
+
+
+        /** Draw the audiodescription waveform. **/
+        private function drawWave():void {
+                clips.wave.graphics.clear();
+                clips.wave.graphics.moveTo(0,0);
+                clips.wave.graphics.lineStyle(1,0x00FF00);
+                for(var i:Number=0; i<waves.length; i++) {
+                        clips.wave.graphics.lineTo(i,waves[i]*50);
+                }
+                clips.wave.width = view.config['width'];
+        };
+
+
         /** Check for captions with a new item. **/
         private function itemHandler(evt:ControllerEvent=null):void {
                 var file:String;
-                if (view.playlist[view.config['item']]['audiodescription.file']){
+                if (view.playlist[view.config['item']]['audiodescription.file']) {
                         file = view.playlist[view.config['item']]['audiodescription.file'];
-                } else if (view.playlist[view.config['item']]['audiodescription']){
+                } else if (view.playlist[view.config['item']]['audiodescription']) {
                         file = view.playlist[view.config['item']]['audiodescription']; 
                 } else if(view.config['audiodescription.file']) {
                         file = view.config['audiodescription.file'];
                 } else if(view.config['audio']) {
-                        // Legacy support
+                        // Legacy support (this is how 3.x did it).
                         file = view.config['audio'];
                 }
@@ -83 +181 @@
                         config['file'] = file;
                 }
+                ducks = new Array();
+                waves = new Array();
         };
 
@@ -93 +193 @@
                 cke.flush();
                 setVolume();
-                if(stt) { 
-                        if(button) { 
-                                button.field.text = 'is on'; 
+                if(stt) {
+                        if(button) {
+                                button.field.text = 'is on';
                         } else {
                                 icon.alpha = 1;
                         }
                 } else {
-                        if(button) { 
-                                button.field.text = 'is off'; 
+                        if(button) {
+                                button.field.text = 'is off';
                         } else {
                                 icon.alpha = 0.3;
@@ -111 +211 @@
         /** Set the volume level. **/
         private function setVolume():void {
-                var trf:SoundTransform = new SoundTransform(config['volume']/100);
+                var trf:SoundTransform = new SoundTransform(config['volume']*config['gain']/100);
                 if(!config['state']) { trf.volume = 0; }
                 if(channel) { channel.soundTransform = trf; }
@@ -131 +231 @@
                                         try {
                                                 sound = new Sound(new URLRequest(config['file']));
+                                                sound.addEventListener(Event.COMPLETE,completeHandler);
                                                 channel = sound.play();
                                                 setVolume();
@@ -150 +251 @@
                         setVolume();
                 }
+                if(ducks.length > 0 && ducks[Math.round(pos*10)] != current) {
+                        current = ducks[Math.round(pos*10)];
+                        view.sendEvent(ViewEvent.VOLUME,config['volume']-ducks[Math.round(pos*10)]*config['ducking']);
+                }
+                if(config['debug']) { 
+                        clips.line.x = Math.round(evt.data.position/evt.data.duration*view.config['width']);
+                }
         };