SoundClip.java

/*
 * Copyright (c) 2003-onwards Shaven Puppy Ltd
 * 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 'Shaven Puppy' 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.
 */
package com.shavenpuppy.jglib.openal;

import java.io.InputStream;

import org.w3c.dom.Element;

import com.shavenpuppy.jglib.Memory;
import com.shavenpuppy.jglib.Resource;
import com.shavenpuppy.jglib.Wave;
import com.shavenpuppy.jglib.resources.WaveWrapper;
import com.shavenpuppy.jglib.util.XMLUtil;

/**
 * $Id: SoundClip.java,v 1.9 2011/07/20 15:12:46 cix_foo Exp $
 * A clip of sound
 * @author $Author: cix_foo $
 * @version $Revision: 1.9 $
 */
public class SoundClip extends Resource implements WaveWrapper {

	private static final long serialVersionUID = 1L;

	/** Parent ALClipBank */
	private final SoundBank clipBank;

	/** Clip offset, in bytes */
	private int offset;

	/** Length, in bytes */
	private int length;

	/*
	 * Transient data
	 */

	/** The wave data. */
	private transient Wave wave;

	/**
	 * C'tor
	 * @param name
	 */
	public SoundClip(String name, SoundBank clipBank) {
		super(name);
		this.clipBank = clipBank;
	}

	@Override
	public void load(Element element, Loader loader) throws Exception {
		offset = XMLUtil.getInt(element, "offset");
		length = XMLUtil.getInt(element, "length");
	}

	@Override
	protected void doCreate() {
		try {
			if (!clipBank.isCreated()) {
				clipBank.create();
			}
			Wave clipBankWave = clipBank.getWave();
			wave = new Wave(
					length / Wave.getBytesPerSample(clipBankWave.getType()),
					clipBankWave.getType(), clipBankWave.getFrequency(),
					Memory.chop(clipBankWave.getData(), offset, length)
					);
		} catch (Exception e) {
			throw new RuntimeException(e);
		}
	}

	@Override
	protected void doDestroy() {
		wave = null;
	}

	@Override
	public Wave getWave() throws Exception {
		assert isCreated();
		if (wave.getData() == null) {
			// Reload the wave
			doCreate();
		}
		return wave;
	}

	@Override
	public int getFrequency() {
		return wave.getFrequency();
	}

	@Override
	public int getType() {
		return wave.getType();
	}

	@Override
	public InputStream getStream() throws Exception {
		return null;
	}
}