159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/* 259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Copyright (c) 2009-2010 jMonkeyEngine 359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * All rights reserved. 459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Redistribution and use in source and binary forms, with or without 659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * modification, are permitted provided that the following conditions are 759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * met: 859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions of source code must retain the above copyright 1059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer. 1159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions in binary form must reproduce the above copyright 1359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer in the 1459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * documentation and/or other materials provided with the distribution. 1559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Neither the name of 'jMonkeyEngine' nor the names of its contributors 1759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * may be used to endorse or promote products derived from this software 1859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * without specific prior written permission. 1959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 2059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 2259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 2459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 2559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 2659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 2759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 2859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 2959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 3059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 3259b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapackage com.jme3.cinematic.events; 3359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3459b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.animation.LoopMode; 3559b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.app.Application; 3659b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.audio.AudioNode; 3759b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.cinematic.Cinematic; 3859b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.InputCapsule; 3959b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.JmeExporter; 4059b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.JmeImporter; 4159b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.OutputCapsule; 4259b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.io.IOException; 4359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/** 4559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * A sound track to be played in a cinematic. 4659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @author Nehon 4759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 4859b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapublic class SoundTrack extends AbstractCinematicEvent { 4959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected String path; 5159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected AudioNode audioNode; 5259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected boolean stream = false; 5359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 5559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * creates a sound track from the given resource path 5659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param path the path to an audi file (ie : "Sounds/mySound.wav") 5759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 5859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public SoundTrack(String path) { 5959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.path = path; 6059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 6159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 6359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * creates a sound track from the given resource path 6459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param path the path to an audi file (ie : "Sounds/mySound.wav") 6559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param stream true to make the audio data streamed 6659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 6759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public SoundTrack(String path, boolean stream) { 6859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this(path); 6959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.stream = stream; 7059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 7159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public SoundTrack(String path, boolean stream, float initialDuration) { 7359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super(initialDuration); 7459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.path = path; 7559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.stream = stream; 7659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 7759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public SoundTrack(String path, boolean stream, LoopMode loopMode) { 7959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super(loopMode); 8059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.path = path; 8159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.stream = stream; 8259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public SoundTrack(String path, boolean stream, float initialDuration, LoopMode loopMode) { 8559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super(initialDuration, loopMode); 8659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.path = path; 8759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.stream = stream; 8859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 9059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public SoundTrack(String path, float initialDuration) { 9159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super(initialDuration); 9259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.path = path; 9359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 9459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 9559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public SoundTrack(String path, LoopMode loopMode) { 9659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super(loopMode); 9759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.path = path; 9859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 9959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public SoundTrack(String path, float initialDuration, LoopMode loopMode) { 10159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super(initialDuration, loopMode); 10259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.path = path; 10359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public SoundTrack() { 10659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 10959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void initEvent(Application app, Cinematic cinematic) { 11059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super.initEvent(app, cinematic); 11159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta audioNode = new AudioNode(app.getAssetManager(), path, stream); 11259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta setLoopMode(loopMode); 11359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 11459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 11559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 11659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setTime(float time) { 11759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super.setTime(time); 11859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta //can occur on rewind 11959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (time < 0) { 12059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta stop(); 12159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta audioNode.setTimeOffset(time); 12359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 12659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void onPlay() { 12759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta audioNode.play(); 12859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 13059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 13159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void onStop() { 13259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta audioNode.stop(); 13359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 13459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 13559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 13659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 13759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void onPause() { 13859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta audioNode.pause(); 13959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 14159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 14259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void onUpdate(float tpf) { 14359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (audioNode.getStatus() == AudioNode.Status.Stopped) { 14459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta stop(); 14559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 14859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 14959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Returns the underlying audion node of this sound track 15059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @return 15159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 15259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public AudioNode getAudioNode() { 15359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return audioNode; 15459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 15659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 15759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setLoopMode(LoopMode loopMode) { 15859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super.setLoopMode(loopMode); 15959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 16059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (loopMode != LoopMode.DontLoop) { 16159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta audioNode.setLooping(true); 16259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } else { 16359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta audioNode.setLooping(false); 16459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 16759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 16859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void write(JmeExporter ex) throws IOException { 16959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super.write(ex); 17059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta OutputCapsule oc = ex.getCapsule(this); 17159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta oc.write(path, "path", ""); 17259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta oc.write(stream, "stream", false); 17359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 17559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 17659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void read(JmeImporter im) throws IOException { 17759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super.read(im); 17859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta InputCapsule ic = im.getCapsule(this); 17959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta path = ic.readString("path", ""); 18059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta stream = ic.readBoolean("stream", false); 18159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 18259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta} 184