Source: effects/audealize.js

  1. /*
  2. audealize.js: implements a high-level audio effect node in Web Audio API. To use it, simply instantiate the Web Audio Node in your Web Audio graph, and give a reverb word or an eq word.
  4. Depends: reverb.js, equalizer.js, data.js, descriptor.js
  5. */
  7. /**
  8.  * <b>The Audealize AudioNode </b>(See {@tutorial gettingstarted}) <br>
  9.  *
  10.  * Enables semantic control of EQ and reverb effects <br><br>
  11.  *
  12.  * To use, instantiate the node in your web audio graph, then set
  13.  * {@link Audealize~eq_descriptor} or {@link Audealize~reverb_descriptor} <br>
  14.  * <br>
  15.  *
  16.  * This node can optionally look for synonyms if an unkown descriptor is given.
  17.  * <br>
  18.  * <i>To utilize this functionality, get an API key from
  19.  * <a
  20.  * href="http://words.bighugelabs.com/api.php">http://words.bighugelabs.com/api.php</a>
  21.  * and pass as an argument to the
  22.  * constructor.
  23.  *
  24.  *
  25.  * @class
  26.  * @name Audealize
  27.  * @param {AudioContext} context - The Web Audio context
  28.  * @param {string} api_key - (optional) API key for Thesaurus service provided
  29.  * by
  30.  * <a href="http://words.bighugelabs.com/api.php">words.bighugelabs.com</a>
  31.  * (See {@tutorial synonyms})
  32.  * @param {Object} opts - (optional) Initial vlaues for
  33.  * eq_descriptor, reverb_descriptor, eq_amount, reverb_amount, eq_on, reverb_on
  34.  */
  35. function Audealize (context, api_key = '', opts = {}) {
  36.   this.input = context.createGain();
  37.   this.output = context.createGain();
  39.   var curve = new Array(40).fill(0.0);
  40.   this.eq = new Equalizer(context, { 'curve': curve });
  42.   this.reverb = new Reverb(context);
  44.   this.api_key = api_key || null;
  46.   this.parameters = new Object();
  47.   this.parameters.eq_descriptor = opts.eq_descriptor || 'bright';
  48.   this.parameters.reverb_descriptor = opts.reverb_descriptor || 'crisp';
  49.   this.parameters.eq_amount = opts.eq_amount || 1;
  50.   this.parameters.reverb_amount = opts.reverb_amount || 0.7;
  51.   this.parameters.eq_on = opts.eq_on || true;
  52.   this.parameters.reverb_on = opts.reverb_on || true;
  54.   // start out dry
  55.   this.reverb.wetdry = 0;
  57.   this.input.connect(this.eq.input);
  58.   this.eq.connect(this.reverb.input);
  59.   this.reverb.connect(this.output);
  60. }
  62. Audealize.prototype = Object.create(null, {
  63.   /**
  64.    * Connect output of this node to the input of another AudioNode
  65.    * @function
  66.    * @name Audealize~connect
  67.    * @param {AudioNode} dest - The node to connect to
  68.    */
  69.   connect: {
  70.     value: function(dest) {
  71.       this.output.connect(dest.input ? dest.input : dest);
  72.     }
  73.   },
  75.   /**
  76.    * Disconnect the output of this node
  77.    * @function
  78.    * @name Audealize~disconnect
  79.    */
  80.   disconnect: {value: function() { this.output.disconnect(); }},
  82.   /**
  83.    * The EQ {@link Descriptor}. <br>
  84.    * Set with a string or {@link Descriptor}. Changes to this paramter will
  85.    * cause the effect settings to be changed immediately to match. <br>
  86.    * If set with a descriptor not present in the EQ dictionary, the node
  87.    * will attempt to find synonyms in the dictionary. (See {@tutorial synonyms})
  88.    * <br>
  89.    * If none are found, the descriptor will revert to its previous value.
  90.    * @member
  91.    * @name Audealize~eq_descriptor
  92.    * @type Descriptor
  93.    */
  94.   eq_descriptor: {
  95.     get: function() {
  96.       return new Descriptor(this.parameters.eq_descriptor, 'eq');
  97.     },
  98.     set: function(word) {
  99.       word = word.word ? word.word : word.toLowerCase();
  101.       if (word in descriptors['eq']) {
  102.         console.log('(Audealize) Changed eq setting to ' + word);
  103.         this.eq.curve = descriptors['eq'][word]['settings'];
  104.         this.parameters.eq_descriptor = word;
  105.       } else {
  106.         var synonyms = this.get_synonyms(word);
  107.         if (synonyms.length > 0) {
  108.  
  109.           for (var i in synonyms) {
  110.             var syn = synonyms[i];
  111.             if (syn in descriptors['eq']) {
  112.               this.parameters.eq_descriptor = syn;
  113.               this.eq.curve =
  114.                 descriptors['eq'][syn]['settings'];
  115.               console.log('(Audealize) Found EQ synonym ' + syn);
  116.               return;
  117.             }
  118.           }
  119.         }
  120.         console.log('(Audealize) Descriptor not found');
  121.       }
  122.     }
  123.   },
  125.   /**
  126.    * The reverb {@link Descriptor}. <br>
  127.    * Set with a string or {@link Descriptor}. Changes to this paramter will
  128.    * cause the effect settings to be changed immediately to match. <br>
  129.    * If set with a descriptor not present in the reverb dictionary, the node
  130.    * will attempt to find synonyms in the dictionary.
  131.    * (See {@tutorial synonyms}) <br>
  132.    * If none are found, the descriptor will revert to its previous value.
  133.    * @member
  134.    * @name Audealize~reverb_descriptor
  135.    * @type Descriptor
  136.    */
  137.   reverb_descriptor: {
  138.     get: function() {
  139.       return new Descriptor(this.parameters.reverb_descriptor, 'reverb');
  140.     },
  141.     set: function(word) {
  142.       word = word.word ? word.word : word.toLowerCase();
  144.       if (word in descriptors['reverb']) {
  145.         this.reverb.settings = descriptors['reverb'][word]['settings'];
  146.         this.reverb.wetdry = this.parameters.reverb_amount;
  147.         this.parameters.reverb_descriptor = word;
  148.         console.log('(Audealize) Changed reverb setting to ' + word);
  149.       } else {
  150.         var synonyms = this.get_synonyms(word);
  151.         
  152.         if (synonyms.length > 0) { 
  153.           for (var i in synonyms) {
  154.             var syn = synonyms[i];
  155.             if (syn in descriptors['reverb']) {
  156.               this.parameters.eq_descriptor = syn;
  157.               this.eq.curve = descriptors['reverb'][syn]['settings'];
  158.               console.log('(Audealize) Found reverb synonym ' + syn);
  159.               return;
  160.             }
  161.           }
  162.         }  
  163.         console.log('(Audealize) Descriptor not found');
  164.       }
  165.     }
  166.   },
  168.   /**
  169.    * The intensity of the EQ effect. <br>
  170.    * Scales the gain values of each filter in the equalizer. <br>
  171.    * Default = 1.0. A value of 0.0 means the EQ curve will be flat at 0dB. <br>
  172.    * Negative values can be used to achieve the inverse effect of the
  173.    * descriptor. (e.g. If eq_descriptor = 'bright' and eq_amount = -1, the sound
  174.    * will the opposite of bright)
  175.    * @member
  176.    * @name Audealize~eq_amount
  177.    * @type number
  178.    */
  179.   eq_amount: {
  180.     get: function() { return this.parameters.eq_amount; },
  181.     set: function(amount) {
  182.       this.parameters.eq_amount = amount;
  183.       this.eq.range = amount;
  184.     }
  185.   },
  187.   /**
  188.    * The ratio of reverb to dry signal. <br>
  189.    * 1 = reverb only. 0 = dry signal only. <br>
  190.    * Set with a number [0,1]
  191.    * @member
  192.    * @name Audealize~reverb_amount
  193.    * @type number
  194.    */
  195.   reverb_amount: {
  196.     get: function() { return this.parameters.reverb_amount; },
  197.     set: function(amount) {
  198.       amount = Math.max(amount, 1);
  199.       amount = Math.min(amount, 0);
  200.       this.parameters.reverb_amount = amount;
  201.       this.reverb.wetdry = amount;
  202.     }
  203.   },
  205.   /**
  206.    * The on/off state of the eq effect. <br>
  207.    * If true, EQ is enabled.
  208.    * @member
  209.    * @name Audealize~eq_on
  210.    * @type boolean
  211.    */
  212.   eq_on: {
  213.     get: function() { return this.parameters.eq_on; },
  214.     set: function(on) {
  215.       this.parameters.eq_on = on;
  216.       if (on) {
  217.         this.eq.range = this.parameters.eq_amount;
  218.       } else {
  219.         this.eq.range = 0;
  220.       }
  221.     }
  222.   },
  224.   /**
  225.     * The on/off state of the reverb effect. <br>
  226.     * If true, reverb is enabled.
  227.     * @member
  228.     * @name Audealize~reverb_on
  229.     * @type boolean
  230.     */
  231.   reverb_on: {
  232.     get: function() { return this.parameters.reverb_on; },
  233.     set: function(on) {
  234.       this.parameters.reverb_on = on;
  235.       if (on) {
  236.         this.reverb.wetdry = this.parameters.reverb_amount;
  237.       } else {
  238.         this.reverb.wetdry = 0;
  239.       }
  240.     }
  241.   },
  243.   // For internal use only
  244.   get_synonyms: {
  245.     value: function(word) {
  246.       if (this.api_key == null) {
  247.         return [];
  248.       }
  249.       console.log('(Audealize) Looking for synonyms of ' + word);
  251.       // Thesaurus service provided by words.bighugelabs.com
  252.       var url = 'http://words.bighugelabs.com/api/2/' + this.api_key + '/';
  253.       word = word.replace(/' '/g, '%20');
  254.       var fullurl = url + word + '/json';
  255.       var response = '';
  257.       $.ajax({
  258.         url: fullurl,
  259.         success: function (repl, status) {
  260.           response = repl;
  261.         },
  262.         type: 'POST',
  263.         dataType: 'json',
  264.         async: false
  265.       });  // .fail(function (x) { console.log(x) })
  267.       var synonyms = [];
  269.       for (var mainkey in response) { // part of speech
  270.         for (var subkey in response[mainkey]) { // syn, sim, ant, etc..
  271.           if (subkey !== 'ant') { // don't want to include antonyms
  272.             for (var syn in response[mainkey][subkey]) {
  273.               synonyms.push(response[mainkey][subkey][syn]);
  274.             }
  275.           }
  276.         }
  277.       }
  278.       if (synonyms.length == 0) {
  279.         console.log('(Audealize) No synonyms found');
  280.       }
  281.       return synonyms;
  282.     }
  283.   }
  284. });