package X3dForAdvancedModeling.AudioSpatialSound;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Geometry3D.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Sound.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* This X3D scene involves three sound sources. Each of them is visualized by a 3D object (in our case is a sphere) that depicts the sound effects. Specifically, we have added filters through of them we are able to manage the different sound effects in an impressive way. Filters can be composed of a number of attributes, frequency, detune, gain and the quality factor which also known as Q. Furthermore, the filters are classified in some specific types, depending on the sound effects that produce. In detail, there is the Low-pass filter which can create more muffled sound. Another one is the High-pass filter, which is used to generate tinny sound. Equally important is the Band-pass filter, which cuts off low and high frequencies and passes through only these within a certain range. On the contrary, the Notch filter has exactly the opposite operation of the Band-pass filter. Then is the Low-shelf filter, its role is to change the amount of bass in a sound, as a result the frequencies that are lower than the current frequency get a boost, while them that are over it remain unchanged. Next, the High-shelf filter is responsible for the quantity of treble in a sound. Moreover, Peaking filter is used in order to handle the amount of midrange in a sound. Lastly, there is the All-pass filter, whose role is to introduce phaser effects.
Related links: Catalog page Filters, source Filters.java, X3D Resources, X3D Scene Authoring Hints, and X3D Tooltips.
Scene Meta Information
| meta tags |
Document Metadata |
| title |
Filters.x3d |
| description |
This X3D scene involves three sound sources. Each of them is visualized by a 3D object (in our case is a sphere) that depicts the sound effects. Specifically, we have added filters through of them we are able to manage the different sound effects in an impressive way. Filters can be composed of a number of attributes, frequency, detune, gain and the quality factor which also known as Q. Furthermore, the filters are classified in some specific types, depending on the sound effects that produce. In detail, there is the Low-pass filter which can create more muffled sound. Another one is the High-pass filter, which is used to generate tinny sound. Equally important is the Band-pass filter, which cuts off low and high frequencies and passes through only these within a certain range. On the contrary, the Notch filter has exactly the opposite operation of the Band-pass filter. Then is the Low-shelf filter, its role is to change the amount of bass in a sound, as a result the frequencies that are lower than the current frequency get a boost, while them that are over it remain unchanged. Next, the High-shelf filter is responsible for the quantity of treble in a sound. Moreover, Peaking filter is used in order to handle the amount of midrange in a sound. Lastly, there is the All-pass filter, whose role is to introduce phaser effects. |
| info |
This work presents an innovative solution of the spatial sound in X3DOM framework, that based on a combinational methodology. Specifically, we suggested the enrichment of X3DOM with spatial sound features, using both the X3D sound nodes and the structure of Web Audio API. |
| creator |
Efi Lakka, Athanasios Malamos, Dick Puk, Don Brutzman |
| created |
28 October 2020 |
| modified |
23 April 2023 |
| reference |
CHANGELOG.txt |
| TODO |
credit for audio files |
| reference |
https://www.medialab.hmu.gr/minipages/x3domAudio |
| identifier |
https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/AudioSpatialSound/Filters.x3d |
| generator |
X3D-Edit 4.0, https://savage.nps.edu/X3D-Edit |
| license |
../license.html |
| |
This program uses the
X3D Java Scene Access Interface Library (X3DJSAIL).
It has been produced using the
X3dToJava.xslt
stylesheet
(version control)
which is used to create Java source code from an original .x3d model.
* @author Efi Lakka, Athanasios Malamos, Dick Puk, Don Brutzman
*/
public class Filters
{
/** Default constructor to create this object. */
public Filters ()
{
initialize();
}
/** Create and initialize the X3D model for this object. */
public final void initialize()
{
try { // catch-all
x3dModel = new X3D().setProfile(X3D.PROFILE_FULL).setVersion(X3D.VERSION_4_0)
.setHead(new head()
.addMeta(new meta().setName(meta.NAME_TITLE ).setContent("Filters.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("This X3D scene involves three sound sources. Each of them is visualized by a 3D object (in our case is a sphere) that depicts the sound effects. Specifically, we have added filters through of them we are able to manage the different sound effects in an impressive way. Filters can be composed of a number of attributes, frequency, detune, gain and the quality factor which also known as Q. Furthermore, the filters are classified in some specific types, depending on the sound effects that produce. In detail, there is the Low-pass filter which can create more muffled sound. Another one is the High-pass filter, which is used to generate tinny sound. Equally important is the Band-pass filter, which cuts off low and high frequencies and passes through only these within a certain range. On the contrary, the Notch filter has exactly the opposite operation of the Band-pass filter. Then is the Low-shelf filter, its role is to change the amount of bass in a sound, as a result the frequencies that are lower than the current frequency get a boost, while them that are over it remain unchanged. Next, the High-shelf filter is responsible for the quantity of treble in a sound. Moreover, Peaking filter is used in order to handle the amount of midrange in a sound. Lastly, there is the All-pass filter, whose role is to introduce phaser effects."))
.addMeta(new meta().setName(meta.NAME_INFO ).setContent("This work presents an innovative solution of the spatial sound in X3DOM framework, that based on a combinational methodology. Specifically, we suggested the enrichment of X3DOM with spatial sound features, using both the X3D sound nodes and the structure of Web Audio API."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Efi Lakka, Athanasios Malamos, Dick Puk, Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("28 October 2020"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("23 April 2023"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("CHANGELOG.txt"))
.addMeta(new meta().setName(meta.NAME_TODO ).setContent("credit for audio files"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.medialab.hmu.gr/minipages/x3domAudio"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/AudioSpatialSound/Filters.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 4.0, https://savage.nps.edu/X3D-Edit"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../license.html")))
.setScene(new Scene()
.addChild(new WorldInfo().setTitle("Filters.x3d"))
.addChild(new NavigationInfo().setHtmlID("NAV"))
.addChild(new Background().setSkyColor(new MFColor(new double[] {0.200,0.200,0.200})))
.addChild(new Viewpoint().setDescription("View entire audio model").setOrientation(1.0,0.0,0.0,-0.5).setPosition(0.0,500.0,600.0).setRetainUserOffsets(true))
.addChild(new Transform("TransformAudio1").setTranslation(-200.0,50.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance("audio_emit")
.setMaterial(new Material().setDiffuseColor(0.1,0.1,0.1).setEmissiveColor(0.8,0.8,0.8).setSpecularColor(0.01,0.01,0.01)))
.setGeometry(new Sphere().setRadius(30))))
.addChild(new Transform("TransformAudio2").setTranslation(0.0,50.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance("audio_emit2")
.setMaterial(new Material().setDiffuseColor(0.1,0.1,0.1).setEmissiveColor(0.8,0.8,0.8).setSpecularColor(0.01,0.01,0.01)))
.setGeometry(new Sphere().setRadius(30))))
.addChild(new Transform("TransformAudio3").setTranslation(200.0,50.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance("audio_emit3")
.setMaterial(new Material().setDiffuseColor(0.1,0.1,0.1).setEmissiveColor(0.8,0.8,0.8).setSpecularColor(0.01,0.01,0.01)))
.setGeometry(new Sphere().setRadius(30))))
.addChild(new Transform("AnimData").setHtmlID("AnimDataPoint").setTranslation(0.0,50.0,0.0))
.addChild(new Transform("AnimDataBoxH").setTranslation(0.0,100.0,0.0))
.addChild(new Transform("AnimDataBoxM").setTranslation(15.0,100.0,0.0))
.addChild(new Transform("AnimDataBoxL").setTranslation(30.0,100.0,0.0))
.addChild(new Transform("AnimDataBoxMM").setHtmlID("AnimDataBoxMMirror").setTranslation(-15.0,100.0,0.0))
.addChild(new Transform("AnimDataBoxLM").setHtmlID("AnimDataBoxLMirror").setTranslation(-30.0,100.0,0.0))
.addChild(new Transform()
.addChild(new Shape()
.setAppearance(new Appearance("floor")
.setMaterial(new Material().setDiffuseColor(0.1,0.1,0.1).setShininess(0.8).setSpecularColor(0.5,0.6,0.7)))
.setGeometry(new Cylinder().setRadius(500))))
.addChild(new ListenerPointSource().setHtmlID("ListenerPointSource").setTrackCurrentView(true))
.addChild(new StreamAudioDestination().setHtmlID("AudioDestination")
.addChild(new DynamicsCompressor().setHtmlID("DynamicsCompressor")
.addChild(new Gain().setHtmlID("Gain4")
.addChild(new SpatialSound("Audio1")
.addChild(new Gain().setHtmlID("Gain1")
.addChild(new Analyser().setHtmlID("Analyser1")
.addChild(new BiquadFilter().setDetune(50.0).setFrequency(600).setHtmlID("BiquadFilter1").setQualityFactor(30.0).setType("ALLPASS")
.addChild(new AudioClip().setDescription("Techno beat").setHtmlID("AudioClip1").setLoop(true).setUrl(new String[] {"sound/techno_beat.mp3","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/AudioSpatialSound/sound/techno_beat.mp3"}))))))
.addChild(new SpatialSound("Audio2")
.addChild(new Gain().setHtmlID("Gain2")
.addChild(new Analyser().setHtmlID("Analyser2")
.addChild(new BiquadFilter().setDetune(15.0).setFrequency(600).setHtmlID("BiquadFilter2").setQualityFactor(15.0).setType("ALLPASS")
.addChild(new AudioClip().setDescription("Simple beat").setHtmlID("AudioClip2").setLoop(true).setUrl(new String[] {"sound/beat.mp3","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/AudioSpatialSound/sound/beat.mp3"}))))))
.addChild(new SpatialSound("Audio3")
.addChild(new Gain().setHtmlID("Gain3")
.addChild(new Analyser().setHtmlID("Analyser3")
.addChild(new BiquadFilter().setFrequency(1000).setHtmlID("BiquadFilter3").setQualityFactor(0).setType("ALLPASS")
.addChild(new AudioClip().setDescription("Wobble loop").setHtmlID("AudioClip3").setLoop(true).setUrl(new String[] {"sound/wobble_loop.mp3","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/AudioSpatialSound/sound/wobble_loop.mp3"}))))))))));
}
catch (Exception ex)
{
System.err.println ("*** Further hints on X3DJSAIL errors and exceptions at");
System.err.println ("*** https://www.web3d.org/specifications/java/X3DJSAIL.html");
throw (ex);
}
}
// end of initialize() method
/** The initialized model object, created within initialize() method. */
private X3D x3dModel;
/**
* Provide a
* shallow copy
* of the X3D model.
* @see X3D
* @return Filters model
*/
public X3D getX3dModel()
{
return x3dModel;
}
/**
* Default main() method provided for test purposes, uses CommandLine to set global ConfigurationProperties for this object.
* @param args array of input parameters, provided as arguments
* @see X3D.handleArguments(args)
* @see X3D.validationReport()
* @see CommandLine
* @see CommandLine.USAGE
* @see ConfigurationProperties
*/
public static void main(String args[])
{
System.out.println("Build this X3D model, showing validation diagnostics...");
X3D thisExampleX3dModel = new Filters().getX3dModel();
// System.out.println("X3D model construction complete.");
// next handle command line arguments
boolean hasArguments = (args != null) && (args.length > 0);
boolean validate = true; // default
boolean argumentsLoadNewModel = false;
String fileName = new String();
if (args != null)
{
for (String arg : args)
{
if (arg.toLowerCase().startsWith("-v") || arg.toLowerCase().contains("validate"))
{
validate = true; // making sure
}
if (arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_X3D) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_CLASSICVRML) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_X3DB) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_VRML97) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_EXI) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_GZIP) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_ZIP) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_HTML) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_XHTML))
{
argumentsLoadNewModel = true;
fileName = arg;
}
}
}
if (argumentsLoadNewModel)
System.out.println("WARNING: \"X3dForAdvancedModeling.AudioSpatialSound.Filters\" model invocation is attempting to load file \"" + fileName + "\" instead of simply validating itself... file loading ignored.");
else if (hasArguments) // if no arguments provided, this method produces usage warning
thisExampleX3dModel.handleArguments(args);
if (validate)
{
// System.out.println("--- TODO fix duplicated outputs ---"); // omit when duplicated outputs problem is solved/refactored
String validationResults = thisExampleX3dModel.validationReport();
// System.out.println("-----------------------------------"); // omit when duplicated outputs problem is solved/refactored
System.out.print("X3dForAdvancedModeling.AudioSpatialSound.Filters self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// AudioSpatialSound/Filters_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "AudioSpatialSound/Filters_JavaExport.x3d";
String filenameX3DV = "AudioSpatialSound/Filters_JavaExport.x3dv";
String filenameJSON = "AudioSpatialSound/Filters_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}