/* $Id$
 *
 * Copyright (c) 1999 Xenonsoft Limited. All Rights Reserved.
 *
 * This software is protected by copyright. You are hereby notified from
 * now by reading this message. This software is also the confidential 
 * and proprietary information of Xenonsoft Limited.  ("Confidential
 * Information"). 
 *
 * This software is distributed under the Xenonsoft Public end user 
 * License ("XPeL"), where the machine-readable source code is provided 
 * under the "Open Source" model.
 * For more information, please read the file "LICENSE-XPL.txt" 
 */

// SoundFilter.java

//
// Description:
//	An abstract class prototypes a sound filter
//	  
// Author:
//	Peter Pilgrim Wed Jun 23 00:01:03 BST 1999
//	  
// RCS HEADER
// 
// $Author$
// $Date$
// $Source$
// $Revision$    $State$    $Locker$
//
// ================================================================================
// History
//	  $Log$
// 
// 

package xenon.soundkit;

/**
 * A prototypical abstract class thats filter linear sound data
 * from the Sound engine.
 *
 * @author Peter Pilgrim Wed Jun 23 00:03:41 BST 1999
 * @version $Id$
 */
public abstract class SoundFilter {

    protected SoundFilter	parent;
    
    /**
     * @param parent the parent sound filter
     */
    public SoundFilter( SoundFilter parent )
    {
	setParentFilter( parent );
    }
    
    /**
     * sets the parent sound filter
     */
    public void setParentFilter( SoundFilter newParent )
    {
	parent = newParent;
    }
    
    /**
     * gets the parent sound filter
     */
    public SoundFilter getParentFilter()
    {
	return (parent);
    }
    
    /**
     * filters the sound linear data
     * @param se the sound engine
     * @param data_buffer the sound filter data buffer
     */
    public abstract void filterLinearData( 
	SoundEngine se, 
	SoundFilterDataBuffer data_buffer );
    
}
