ISoundView.java

/*
  ISoundView.java

  (c) 2012-2016 Edward Swartz

  All rights reserved. This program and the accompanying materials
  are made available under the terms of the Eclipse Public License v1.0
  which accompanies this distribution, and is available at
  http://www.eclipse.org/legal/epl-v10.html
 */
package ejs.base.sound;


/**
 * @author ejs
 *
 */
public interface ISoundView extends IArrayAccess {

	ISoundView[] EMPTY_ARRAY = new ISoundView[0];

	SoundFormat getFormat();

	/**
	 * Get the value of the frame (averaging channels)
	 * @param frameOffs
	 * @return sample, or 0 if out of range
	 */
	float atFrame(int frameOffs);

	/**
	 * Get the sample (interleaving channels)
	 * @param sampleOffs
	 * @return sample, or 0 if out of range
	 */
	float at(int sampleOffs, int channel);

	boolean isSilent();

	/**
	 * Get the channel count.
	 */
	int getChannelCount();
	/**
	 * Get the number of raw entries (one per channel)
	 * @return
	 */
	int getSampleCount();
	/** 
	 * Get offset in parent (if any) 
	 * @return
	 */
	int getSampleOffset();

	/**
	 * Get the number of frames (samples divided by channels)
	 * @return
	 */
	int getFrameCount();

	
	/** 
	 * Get start frame number (e.g. time) 
	 * @return
	 */
	int getFrameStart();
	
	void setFrameStart(int start);
	
	/**
	 * Get the time in seconds for the view
	 * @return
	 */
	float getElapsedTime();

	/**
	 * @return
	 */
	float getStartTime();

	/**
	 * @return
	 */
	float getEndTime();

	ISoundView getSoundView(int fromSample, int count);
	ISoundView getSoundViewFrames(int fromFrame, int count);
	ISoundView getSoundViewTime(float fromTime, float length);

	/**
	 * Make a deep copy of the view
	 * @return
	 */
	IEditableSoundView copy();



}