package X3dForAdvancedModeling.AudioSpatialSound;
/*
Copyright (c) 1995-2022 held by the author(s). All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of the Web3D Consortium (https://www.web3d.org)
nor the names of its contributors may be used to endorse or
promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
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.*;
import org.web3d.x3d.jsail.Text.*;
import org.web3d.x3d.jsail.Texturing.*;
// Javadoc annotations follow, see below for Java source code.
/**
*
This X3D scene includes a simple sound source which can be moved right and left. Depending on the position of the sound source, the user can hear the produced sound from the corresponding output speaker. Accordingly, there is a source that can be passed through a SpatialSound for the spatialization of the input audio. The approach is based on the relative position of the source and the listener, in comparison to the panner.
Related links: SplitChannels.java source, SplitChannels catalog page, X3D Resources, X3D Scene Authoring Hints, and X3D Tooltips.
Scene Meta Information
meta tags |
Document Metadata |
title |
SplitChannels.x3d |
description |
This X3D scene includes a simple sound source which can be moved right and left. Depending on the position of the sound source, the user can hear the produced sound from the corresponding output speaker. Accordingly, there is a source that can be passed through a SpatialSound for the spatialization of the input audio. The approach is based on the relative position of the source and the listener, in comparison to the panner. |
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 |
http://www.medialab.hmu.gr/minipages/x3domAudio |
identifier |
https://x3dgraphics.com/examples/X3dForAdvancedModeling/AudioSpatialSound/SplitChannels.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 to create Java source code from an .x3d
model.
* @author Efi Lakka, Athanasios Malamos, Dick Puk, Don Brutzman
*/
public class SplitChannels
{
/** Default constructor to create this object. */
public SplitChannels ()
{
initialize();
}
/** Create and initialize the X3D model for this object. */
public final void initialize()
{
x3dModel = new X3D().setProfile(X3D.PROFILE_FULL).setVersion(X3D.VERSION_4_0)
.setHead(new head()
.addMeta(new meta().setName(meta.NAME_TITLE ).setContent("SplitChannels.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("This X3D scene includes a simple sound source which can be moved right and left. Depending on the position of the sound source, the user can hear the produced sound from the corresponding output speaker. Accordingly, there is a source that can be passed through a SpatialSound for the spatialization of the input audio. The approach is based on the relative position of the source and the listener, in comparison to the panner."))
.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("http://www.medialab.hmu.gr/minipages/x3domAudio"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://x3dgraphics.com/examples/X3dForAdvancedModeling/AudioSpatialSound/SplitChannels.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("SplitChannels.x3d"))
.addChild(new NavigationInfo().setHtmlID("NAV").setType("NONE"))
.addChild(new Background().setSkyColor(new MFColor(new double[] {0.200,0.200,0.210})))
.addChild(new Viewpoint().setOrientation(1.0,0.0,0.0,-0.5).setPosition(0.0,500.0,600.0).setRetainUserOffsets(true))
.addChild(new Transform("PowerR").setTranslation(100.0,400.0,400.0)
.addChild(new Transform().setHtmlID("pR").setRotation(1.0,0.0,0.0,-0.5).setTranslation(0.0,40.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance("audio_emit")
.setMaterial(new Material().setDiffuseColor(0.0,1.0,0.0).setEmissiveColor(0.8,0.8,0.8).setSpecularColor(0.01,0.01,0.01)))
.setGeometry(new Box().setSize(10.0,80.0,0.01))))
.addChild(new Transform().setRotation(1.0,0.0,0.0,-0.5).setTranslation(-2.7,37.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance("audio_emit2")
.setMaterial(new Material().setDiffuseColor(0.0,1.0,0.0).setEmissiveColor(0.8,0.8,0.8).setSpecularColor(0.01,0.01,0.01))
.setTexture(new ImageTexture().setUrl(new String[] {"images/line.png","https://x3dgraphics.com/examples/X3dForAdvancedModeling/AudioSpatialSound/images/line.png"})))
.setGeometry(new Box().setSize(25.0,83.0,0.01))))
.addChild(new Transform("volumeRight").setRotation(1.0,0.0,0.0,-0.5).setScale(10.0,10.0,10.0).setTranslation(0.0,-10.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material().setAmbientIntensity(0.0933).setDiffuseColor(0.345,0.345,0.882).setShininess(0.51).setSpecularColor(0.46,0.46,0.46)))
.setGeometry(new Text().setString(new String[] {"Right Channel Volume"})
.setFontStyle(new FontStyle("VolumeFontStyle").setFamily(new String[] {"Times","SERIF"}).setCssStyle("BOLD"))))))
.addChild(new Transform("PowerL").setTranslation(-100.0,400.0,400.0)
.addChild(new Transform().setHtmlID("pL").setRotation(1.0,0.0,0.0,-0.5).setTranslation(0.0,40.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance("audio_emit3")
.setMaterial(new Material().setDiffuseColor(0.0,1.0,0.0).setEmissiveColor(0.8,0.8,0.8).setSpecularColor(0.01,0.01,0.01)))
.setGeometry(new Box().setSize(10.0,80.0,0.01))))
.addChild(new Transform().setRotation(1.0,0.0,0.0,-0.5).setTranslation(13.2,37.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance("audio_emit4")
.setMaterial(new Material().setDiffuseColor(0.0,1.0,0.0).setEmissiveColor(0.8,0.8,0.8).setSpecularColor(0.01,0.01,0.01))
.setTexture(new ImageTexture().setUrl(new String[] {"images/line.png","https://x3dgraphics.com/examples/X3dForAdvancedModeling/AudioSpatialSound/images/line.png"})))
.setGeometry(new Box().setSize(25.0,83.0,0.01))))
.addChild(new Transform("volumeLeft").setRotation(1.0,0.0,0.0,-0.5).setScale(10.0,10.0,10.0).setTranslation(0.0,-10.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material().setAmbientIntensity(0.0933).setDiffuseColor(0.345,0.345,0.882).setShininess(0.51).setSpecularColor(0.46,0.46,0.46)))
.setGeometry(new Text().setString(new String[] {"Left Channel Volume"})
.setFontStyle(new FontStyle().setUSE("VolumeFontStyle"))))))
.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 Box().setSize(1500.0,10.0,500.0))))
.addChild(new ListenerPointSource().setHtmlID("ListenerPointSource").setTrackCurrentView(true))
.addChild(new StreamAudioDestination().setChannelCountMode("MAX").setChannelInterpretation("SPEAKERS").setHtmlID("AudioDestination")
.addChild(new Gain().setChannelCountMode("MAX").setChannelInterpretation("SPEAKERS").setHtmlID("Gain3")
.addChild(new ChannelMerger().setChannelCountMode("MAX").setChannelInterpretation("SPEAKERS").setHtmlID("ChannelMerger")
.addChild(new ChannelSelector().setChannelCountMode("MAX").setChannelInterpretation("SPEAKERS").setHtmlID("ChannelSelector0")
.addChild(new Gain().setUSE("ChannelSplitter").setChannelCountMode("MAX").setChannelInterpretation("SPEAKERS")))
.addChild(new ChannelSelector().setChannelCountMode("MAX").setChannelInterpretation("SPEAKERS").setChannelSelection(1).setHtmlID("ChannelSelector1")
.addChild(new Gain().setUSE("ChannelSplitter").setChannelCountMode("MAX").setChannelInterpretation("SPEAKERS"))))))
.addChild(new ChannelSplitter("ChannelSplitter").setChannelCountMode("EXPLICIT").setChannelInterpretation("SPEAKERS")
.addChild(new AudioClip().setDescription("Violin").setUrl(new String[] {"sound/violin.mp3","https://x3dgraphics.com/examples/X3dForAdvancedModeling/AudioSpatialSound/sound/violin.mp3"})))
.addChild(new Transform("Audio3").setRotation(1.0,0.0,0.0,-0.5).setTranslation(0.0,100.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance("audio_emit5")
.setMaterial(new Material().setDiffuseColor(0.3,1.0,0.3).setEmissiveColor(0.8,0.8,0.8).setSpecularColor(0.01,0.01,0.01))
.setTexture(new ImageTexture().setUrl(new String[] {"images/loudspeaker.png","https://x3dgraphics.com/examples/X3dForAdvancedModeling/AudioSpatialSound/images/loudspeaker.png"})))
.setGeometry(new Box().setSize(100.0,100.0,0.001)))));
}
// 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 SplitChannels 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[])
{
X3D thisExampleX3dModel = new SplitChannels().getX3dModel();
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.SplitChannels\" 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.print("Java program \"X3dForAdvancedModeling.AudioSpatialSound.SplitChannels\" self-validation test results: ");
String validationResults = thisExampleX3dModel.validationReport();
if (validationResults.startsWith("\n"))
System.out.println();
System.out.println(validationResults.trim());
}
}
}