/*
    
  This file is a part of EMIPLIB, the EDM Media over IP Library.
  
  Copyright (C) 2006-2010  Hasselt University - Expertise Centre for
                      Digital Media (EDM) (http://www.edm.uhasselt.be)

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  
  USA

*/

/**
 * \file mipaudiodistancefade.h
 */

#ifndef MIPAUDIODISTANCEFADE_H

#define MIPAUDIODISTANCEFADE_H

#include "mipconfig.h"
#include "mipaudio3dbase.h"
#include <list>

class MIPRawFloatAudioMessage;

/** A simple 3D audio component which only takes the distance between participants into account.
 *  A simple 3D audio component which only takes the distance between participants into account.
 *  The compontent accepts and produces floating point raw audio messages.
 */
class MIPAudioDistanceFade : public MIPAudio3DBase
{
public:
	MIPAudioDistanceFade();
	~MIPAudioDistanceFade();

	/** Initialize the component.
	 *  This function initializes the component.
	 *  \param cutOffDistance Specifies the distance (in meters) beyond which audio information
	 *                        is ignored.
	 */
	bool init(real_t cutOffDistance = 50.0);

	/** Clean up the component. */
	bool destroy();
	
	bool push(const MIPComponentChain &chain, int64_t iteration, MIPMessage *pMsg);
	bool pull(const MIPComponentChain &chain, int64_t iteration, MIPMessage **pMsg);
private:
	bool m_init;
	real_t m_cutOffDistance;
	std::list<MIPRawFloatAudioMessage *> m_messages;
	std::list<MIPRawFloatAudioMessage *>::const_iterator m_msgIt;
	int64_t m_curIteration;
};

#endif // MIPAUDIODISTANCEFADE_H

