/*
  * 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.
  */ 

/**
 * This class is used to store region parts for instrument.
 * A region has a velocity and key range which it response to.
 * And it has a list of modulators/articulators which 
 * is used how to synthesize a single voice.
 * It is stored inside a "rgn " List Chunk inside DLS files.
 *
 * @version %I%, %E%
 * @author Karl Helgason
 */ 
package com.sun.media.sound;

import java.util.ArrayList;
import java.util.List;

/**
 * This class is used for storing DLS regions.
 * It is stored inside a "rgn " List Chunk inside DLS files.
 *
 * @version %I%, %E%
 * @author Karl Helgason
 */ 
public class DLSRegion {
	
	public final static int OPTION_SELFNONEXCLUSIVE = 0x0001;

	protected List<DLSModulator> modulators = new ArrayList<DLSModulator>();
	
	protected int keyfrom;
	protected int keyto;
	protected int velfrom;
	protected int velto;
	protected int options;
	protected int exclusiveClass;
	
	protected int fusoptions;
	protected int phasegroup;
	protected long channel;
	protected DLSSample sample = null;	
	protected DLSSampleOptions sampleoptions;
	
	public List<DLSModulator> getModulators() {
		return modulators;
	}

	public long getChannel() {
		return channel;
	}

	public void setChannel(long channel) {
		this.channel = channel;
	}

	public int getExclusiveClass() {
		return exclusiveClass;
	}

	public void setExclusiveClass(int exclusiveClass) {
		this.exclusiveClass = exclusiveClass;
	}

	public int getFusoptions() {
		return fusoptions;
	}

	public void setFusoptions(int fusoptions) {
		this.fusoptions = fusoptions;
	}

	public int getKeyfrom() {
		return keyfrom;
	}

	public void setKeyfrom(int keyfrom) {
		this.keyfrom = keyfrom;
	}

	public int getKeyto() {
		return keyto;
	}

	public void setKeyto(int keyto) {
		this.keyto = keyto;
	}

	public int getOptions() {
		return options;
	}

	public void setOptions(int options) {
		this.options = options;
	}

	public int getPhasegroup() {
		return phasegroup;
	}

	public void setPhasegroup(int phasegroup) {
		this.phasegroup = phasegroup;
	}

	public DLSSample getSample() {
		return sample;
	}

	public void setSample(DLSSample sample) {
		this.sample = sample;
	}

	public int getVelfrom() {
		return velfrom;
	}

	public void setVelfrom(int velfrom) {
		this.velfrom = velfrom;
	}

	public int getVelto() {
		return velto;
	}

	public void setVelto(int velto) {
		this.velto = velto;
	}

	public void setModulators(List<DLSModulator> modulators) {
		this.modulators = modulators;
	}

	public DLSSampleOptions getSampleoptions() {
		return sampleoptions;
	}

	public void setSampleoptions(DLSSampleOptions sampleOptions) {
		this.sampleoptions = sampleOptions;
	}	
}