1/*
2 * Copyright (c) 2009-2010 jMonkeyEngine
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 *   notice, this list of conditions and the following disclaimer.
11 *
12 * * Redistributions in binary form must reproduce the above copyright
13 *   notice, this list of conditions and the following disclaimer in the
14 *   documentation and/or other materials provided with the distribution.
15 *
16 * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
17 *   may be used to endorse or promote products derived from this software
18 *   without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33package com.jme3.audio;
34
35import com.jme3.audio.AudioData.DataType;
36import com.jme3.util.NativeObject;
37import java.nio.ByteBuffer;
38
39/**
40 * An <code>AudioBuffer</code> is an implementation of AudioData
41 * where the audio is buffered (stored in memory). All parts of it
42 * are accessible at any time. <br/>
43 * AudioBuffers are useful for short sounds, like effects, etc.
44 *
45 * @author Kirill Vainer
46 */
47public class AudioBuffer extends AudioData {
48
49    /**
50     * The audio data buffer. Should be direct and native ordered.
51     */
52    protected ByteBuffer audioData;
53
54    public AudioBuffer(){
55        super();
56    }
57
58    protected AudioBuffer(int id){
59        super(id);
60    }
61
62    public DataType getDataType() {
63        return DataType.Buffer;
64    }
65
66    /**
67     * @return The duration of the audio in seconds. It is expected
68     * that audio is uncompressed.
69     */
70    public float getDuration(){
71        int bytesPerSec = (bitsPerSample / 8) * channels * sampleRate;
72        if (audioData != null)
73            return (float) audioData.capacity() / bytesPerSec;
74        else
75            return Float.NaN; // unknown
76    }
77
78    @Override
79    public String toString(){
80        return getClass().getSimpleName() +
81               "[id="+id+", ch="+channels+", bits="+bitsPerSample +
82               ", rate="+sampleRate+", duration="+getDuration()+"]";
83    }
84
85    /**
86     * Update the data in the buffer with new data.
87     * @param data
88     */
89    public void updateData(ByteBuffer data){
90        this.audioData = data;
91        updateNeeded = true;
92    }
93
94    /**
95     * @return The buffered audio data.
96     */
97    public ByteBuffer getData(){
98        return audioData;
99    }
100
101    public void resetObject() {
102        id = -1;
103        setUpdateNeeded();
104    }
105
106    public void deleteObject(AudioRenderer ar) {
107
108    }
109
110    @Override
111    public void deleteObject(Object rendererObject) {
112        ((AudioRenderer)rendererObject).deleteAudioData(this);
113    }
114
115    @Override
116    public NativeObject createDestructableClone() {
117        return new AudioBuffer(id);
118    }
119
120}
121