201 lines
No EOL
8.2 KiB
JavaScript
201 lines
No EOL
8.2 KiB
JavaScript
//
|
|
// autoReverbEntity.js
|
|
// examples/entityScripts
|
|
//
|
|
// This is an example of an entity script which will Probe the area around you for objects that could reflect audio,
|
|
// and use that to modify the reverb settings. It can be applied to any entity, although it works best on a zone entity.
|
|
//
|
|
// Created by Philip Rosedale on May 17, 2016
|
|
// Copyright 2016 High Fidelity, Inc.
|
|
//
|
|
// Distributed under the Apache License, Version 2.0.
|
|
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
|
|
//
|
|
// Distributed under the Apache License, Version 2.0.
|
|
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
|
|
//
|
|
/*global print, MyAvatar, Entities, AnimationCache, SoundCache, Scene, Camera, Overlays, Audio, HMD, AvatarList, AvatarManager, Controller, UndoStack, Window, Account, GlobalServices, Script, ScriptDiscoveryService, LODManager, Menu, Vec3, Quat, AudioDevice, Paths, Clipboard, Settings, XMLHttpRequest, randFloat, randInt, pointInExtents, vec3equal, setEntityCustomData, getEntityCustomData */
|
|
(function () {
|
|
"use strict";
|
|
|
|
var UPDATE_INTERVAL_MSECS = 200; // How often do we update the reverb settings?
|
|
var MAX_PICK_DISTANCE = 20; // Greatest distance that could affect reverb
|
|
|
|
var MIN_REVERB_TIME = 0.25;
|
|
var MAX_REVERB_TIME = 2.0;
|
|
var REVERB_DISTANCE_MULTIPLIER = 0.09;
|
|
|
|
var MIN_MIX = 0;
|
|
var MIX_MULTIPLIER = 7.5;
|
|
var MAX_MIX = 75;
|
|
|
|
var MIN_GAIN = -28;
|
|
var GAIN_MULTIPLIER = 2.0;
|
|
|
|
var ROOM_SIZE = 50.0;
|
|
|
|
var audioOptions = new AudioEffectOptions({
|
|
//bandwidth: 10000,
|
|
//preDelay: 20,
|
|
//lateDelay: 0,
|
|
reverbTime: MIN_REVERB_TIME,
|
|
//earlyDiffusion: 100,
|
|
//lateDiffusion: 100,
|
|
roomSize: ROOM_SIZE,
|
|
//density: 100,
|
|
//bassMult: 1.5,
|
|
//bassFreq: 250,
|
|
//highGain: -6,
|
|
//highFreq: 3000,
|
|
//modRate: 2.3,
|
|
//modDepth: 50,
|
|
earlyGain: MIN_GAIN,
|
|
lateGain: MIN_GAIN,
|
|
//earlyMixLeft: 20,
|
|
//earlyMixRight: 20,
|
|
//lateMixLeft: 90,
|
|
//lateMixRight: 90,
|
|
wetDryMix: 10
|
|
});
|
|
|
|
var lastGain = -24;
|
|
var lastMix = 10;
|
|
var lastReverbTime = MIN_REVERB_TIME;
|
|
var wantDebug = true;
|
|
|
|
// This is a little trick for implementing entity scripts. Many of the entity callbacks will have the JavaScript
|
|
// "this" variable set, but if you connect to a signal like update, "this" won't correctly point to the instance
|
|
// of your entity script, and so we set "_this" and use it in cases we need to access "this". We need to define
|
|
// the variable in this scope so that it's not share among all entities.
|
|
|
|
var _this; // this is important here... or else the _this will be globally scoped.
|
|
|
|
//
|
|
// Create your desired set of test pick rays to check for nearby objects that will reflect audio
|
|
// This example has 10 - one up, one down, and eight in the cardinal directions in X/Z plane
|
|
//
|
|
var pickRays = [
|
|
{ x: 0, y: 1, z: 0 }, // Straight Up
|
|
{ x: 0, y: -1, z: 0 }, // Straight down
|
|
Vec3.normalize({ x: 1, y: 1, z: 0 }), // Upward at 45 degree elevation along 8 cardinal directions
|
|
Vec3.normalize({ x: -1, y: 1, z: 0 }),
|
|
Vec3.normalize({ x: 1, y: 1, z: 1 }),
|
|
Vec3.normalize({ x: -1, y: 1, z: -1 }),
|
|
Vec3.normalize({ x: -1, y: 1, z: 1 }),
|
|
Vec3.normalize({ x: 1, y: 1, z: -1 }),
|
|
Vec3.normalize({ x: 0, y: 1, z: 1 }),
|
|
Vec3.normalize({ x: 0, y: 1, z: -1 })
|
|
];
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
// Various helper functions...
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
function printDebug(message) {
|
|
if (wantDebug) {
|
|
print(message);
|
|
}
|
|
}
|
|
|
|
// Helper function for returning either a value, or the default value if the value is undefined. This is
|
|
// is handing in parsing JSON where you don't know if the values have been set or not.
|
|
function valueOrDefault(value, defaultValue) {
|
|
if (value !== undefined) {
|
|
return value;
|
|
}
|
|
return defaultValue;
|
|
}
|
|
|
|
// return a random float between high and low
|
|
function randFloat(low, high) {
|
|
return low + Math.random() * (high - low);
|
|
}
|
|
|
|
// the "constructor" for our class. pretty simple, it just sets our _this, so we can access it later.
|
|
function AutoReverb() {
|
|
_this = this;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
// The class prototype
|
|
//
|
|
// This is the class definition/prototype for our class. Funtions declared here will be accessible
|
|
// via the instance of the entity
|
|
//
|
|
AutoReverb.prototype = {
|
|
|
|
// preload()
|
|
// This is called by every viewer/interface instance that "sees" the entity you've attached this script to.
|
|
// If this is a zone entity, then it will surely be called whenever someone enters the zone.
|
|
preload: function (entityID) {
|
|
|
|
// we always make a point of remember our entityID, so that we can access our entity later
|
|
_this.entityID = entityID;
|
|
|
|
// enable reverb
|
|
AudioDevice.setReverb(true);
|
|
_this.updateInterval = Script.setInterval(_this.onUpdate, UPDATE_INTERVAL_MSECS);
|
|
},
|
|
|
|
// unload()
|
|
// This is called by every viewer/interface instance that "sees" the entity when you "stop knowing about" the
|
|
// entity. Usually this means the user has left the domain, or maybe the entity has been deleted. We need to
|
|
// clean up anything transient that we created here. In this case it means disconnecting from the update signal
|
|
// and stopping the rain sound if we started it.
|
|
unload: function ( /*entityID*/ ) {
|
|
Script.clearInterval(_this.updateInterval);
|
|
AudioDevice.setReverb(false); // Cleanup on leaving the domain or if entity is deleted
|
|
},
|
|
|
|
// update() this will be called regularly, based on the timing of our setInterval. We will use
|
|
// it to determine if we need to adjust the reverb settings
|
|
onUpdate: function () {
|
|
var intersection
|
|
var pickRay = { origin: MyAvatar.position,
|
|
direction: { x: 0, y: 0, z: 0 }
|
|
};
|
|
var surfaces = 0;
|
|
var averageDistance = 0;
|
|
|
|
for (var i = 0; i < pickRays.length; i++) {
|
|
pickRay.direction = pickRays[i];
|
|
intersection = Entities.findRayIntersection(pickRay, true);
|
|
if (intersection.intersects) {
|
|
var distance = Vec3.distance(pickRay.origin, intersection.intersection);
|
|
if (distance <= MAX_PICK_DISTANCE) {
|
|
surfaces++;
|
|
averageDistance += distance;
|
|
}
|
|
}
|
|
}
|
|
if (surfaces > 0) {
|
|
averageDistance /= surfaces;
|
|
averageDistance = averageDistance.toFixed(2);
|
|
}
|
|
|
|
var gain = MIN_GAIN + surfaces * GAIN_MULTIPLIER;
|
|
var mix = Math.min(MIN_MIX + surfaces * MIX_MULTIPLIER, MAX_MIX);
|
|
var reverbTime = Math.min(MIN_REVERB_TIME + averageDistance * REVERB_DISTANCE_MULTIPLIER, MAX_REVERB_TIME).toFixed(2);
|
|
|
|
if (gain != lastGain || mix != lastMix || reverbTime != lastReverbTime) {
|
|
printDebug("surfaces: " + surfaces + ", distance: " + averageDistance)
|
|
printDebug("gain: " + gain + ", mix: " + mix + ", time: " + reverbTime);
|
|
|
|
audioOptions.reverbTime = reverbTime;
|
|
audioOptions.earlyGain = gain;
|
|
audioOptions.lateGain = gain;
|
|
audioOptions.wetDryMix = mix;
|
|
|
|
AudioDevice.setReverbOptions(audioOptions);
|
|
AudioDevice.setReverb(true);
|
|
}
|
|
|
|
lastGain = gain;
|
|
lastMix = mix;
|
|
lastReverbTime = reverbTime;
|
|
}
|
|
|
|
};
|
|
|
|
return new AutoReverb();
|
|
}); |