background_source.h

Go to the documentation of this file.

/* Copyright, 2001 Nevrax Ltd.
 *
 * This file is part of NEVRAX NEL.
 * NEVRAX NEL is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.

 * NEVRAX NEL 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 for more details.

 * You should have received a copy of the GNU General Public License
 * along with NEVRAX NEL; see the file COPYING. If not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */

#ifndef NL_BACKGROUND_SOURCE_H
#define NL_BACKGROUND_SOURCE_H

#include "nel/misc/types_nl.h"
//#include "nel/sound/u_source.h"
#include "source_common.h"
#include "background_sound.h"


namespace NLSOUND {

class CBackgroundSound;

class CBackgroundSource : public CSourceCommon , public CAudioMixerUser::IMixerUpdate
{
public:
    CBackgroundSource   (CBackgroundSound *backgroundSound=NULL, bool spawn=false, TSpawnEndCallback cb=0, void *cbUserParam = 0, NL3D::CCluster *cluster = 0);
    ~CBackgroundSource  ();

    virtual TSoundId                getSound();

    virtual void                    play();
    virtual void                    stop();

    TSOURCE_TYPE                    getType() const                             {return SOURCE_BACKGROUND;}

    void                            setGain( float gain );
    void                            setRelativeGain( float gain );

    void                            setPos( const NLMISC::CVector& pos );
    void                            setVelocity( const NLMISC::CVector& vel );
    void                            setDirection( const NLMISC::CVector& dir );

    void                            updateFilterValues(const float *filterValues);


private:

    void onUpdate();

    enum TSubSourceStatus
    {
        SUB_STATUS_PLAY,
        SUB_STATUS_STOP,
        SUB_STATUS_PLAY_FAIL
    };

    struct TSubSource
    {
        USource             *Source;
        TSubSourceStatus    Status;
        UAudioMixer::TBackgroundFlags   Filter;
    };

    CBackgroundSound            *_BackgroundSound;

    std::vector<TSubSource>     _Sources;
};



} // NLSOOUND

#endif // NL_BACKGROUND_SOURCE_H