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 Barta 3359b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapackage com.jme3.audio; 3459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3559b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.asset.AssetKey; 3659b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.InputCapsule; 3759b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.JmeExporter; 3859b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.JmeImporter; 3959b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.OutputCapsule; 4059b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.io.IOException; 4159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/** 4359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * <code>AudioKey</code> is extending AssetKey by holding stream flag. 4459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 4559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @author Kirill Vainer 4659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 4759b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapublic class AudioKey extends AssetKey<AudioData> { 4859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private boolean stream; 5059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private boolean streamCache; 5159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 5359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Create a new AudioKey. 5459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 5559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param name Name of the asset 5659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param stream If true, the audio will be streamed from harddrive, 5759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * otherwise it will be buffered entirely and then played. 5859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param streamCache If stream is true, then this specifies if 5959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * the stream cache is used. When enabled, the audio stream will 6059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * be read entirely but not decoded, allowing features such as 6159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * seeking, determining duration and looping. 6259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 6359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public AudioKey(String name, boolean stream, boolean streamCache){ 6459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this(name, stream); 6559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.streamCache = streamCache; 6659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 6759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 6959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Create a new AudioKey 7059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 7159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param name Name of the asset 7259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param stream If true, the audio will be streamed from harddrive, 7359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * otherwise it will be buffered entirely and then played. 7459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 7559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public AudioKey(String name, boolean stream){ 7659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super(name); 7759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.stream = stream; 7859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 7959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public AudioKey(String name){ 8159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super(name); 8259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.stream = false; 8359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public AudioKey(){ 8659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 8959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public String toString(){ 9059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return name + (stream ? 9159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta (streamCache ? 9259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta " (Stream/Cache)" : 9359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta " (Stream)") : 9459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta " (Buffer)"); 9559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 9659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 9759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 9859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @return True if the loaded audio should be a {@link AudioStream} or 9959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * false if it should be a {@link AudioBuffer}. 10059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 10159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public boolean isStream() { 10259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return stream; 10359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 10659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Specifies if the stream cache is used. 10759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 10859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * When enabled, the audio stream will 10959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * be read entirely but not decoded, allowing features such as 11059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * seeking, looping and determining duration. 11159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 11259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public boolean useStreamCache(){ 11359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return streamCache; 11459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 11559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 11659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 11759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public boolean shouldCache(){ 11859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return !stream && !streamCache; 11959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 12259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void write(JmeExporter ex) throws IOException{ 12359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super.write(ex); 12459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta OutputCapsule oc = ex.getCapsule(this); 12559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta oc.write(stream, "do_stream", false); 12659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta oc.write(streamCache, "use_stream_cache", false); 12759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 13059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void read(JmeImporter im) throws IOException{ 13159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super.read(im); 13259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta InputCapsule ic = im.getCapsule(this); 13359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta stream = ic.readBoolean("do_stream", false); 13459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta streamCache = ic.readBoolean("use_stream_cache", false); 13559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 13659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 13759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta} 138