/*

 * Copyright 2007 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package com.sun.media.sound;

import java.io.InputStream;

import javax.sound.midi.Soundbank;

import javax.sound.midi.SoundbankResource;

import javax.sound.sampled.AudioFormat;

import javax.sound.sampled.AudioInputStream;

/**

 * This class is used to store the sample data itself.

 * A sample is encoded as PCM audio stream

 * and in DLS Level 1 files it is always a mono 8/16 bit stream.

 * They are stored just like RIFF WAVE files are stored.

 * It is stored inside a "wave" List Chunk inside DLS files.

 *

 * @author Karl Helgason

 */

public class DLSSample extends SoundbankResource {

    protected byte[] guid = null;

    protected DLSInfo info = new DLSInfo();

    protected DLSSampleOptions sampleoptions;

    protected ModelByteBuffer data;

    protected AudioFormat format;

    public DLSSample(Soundbank soundBank) {

        super(soundBank, null, AudioInputStream.class);

    }

    public DLSSample() {

        super(null, null, AudioInputStream.class);

    }

    public DLSInfo getInfo() {

        return info;

    }

    public Object getData() {

        AudioFormat format = getFormat();

        InputStream is = data.getInputStream();

        if (is == null)

            return null;

        return new AudioInputStream(is, format, data.capacity());

    }

    public ModelByteBuffer getDataBuffer() {

        return data;

    }

    public AudioFormat getFormat() {

        return format;

    }

    public void setFormat(AudioFormat format) {

        this.format = format;

    }

    public void setData(ModelByteBuffer data) {

        this.data = data;

    }

    public void setData(byte[] data) {

        this.data = new ModelByteBuffer(data);

    }

    public void setData(byte[] data, int offset, int length) {

        this.data = new ModelByteBuffer(data, offset, length);

    }

    public String getName() {

        return info.name;

    }

    public void setName(String name) {

        info.name = name;

    }

    public DLSSampleOptions getSampleoptions() {

        return sampleoptions;

    }

    public void setSampleoptions(DLSSampleOptions sampleOptions) {

        this.sampleoptions = sampleOptions;

    }

    public String toString() {

        return "Sample: " + info.name;

    }

    public byte[] getGuid() {

        return guid;

    }

    public void setGuid(byte[] guid) {

        this.guid = guid;

    }

}