psmusic.h

Go to the documentation of this file.

/*
 * psmusic.h
 *
 * Copyright (C) 2001-2010 Atomic Blue (info@planeshift.it, http://www.planeshift.it)
 *
 * Credits : Saul Leite <leite@engineer.com>
 *           Mathias 'AgY' Voeroes <agy@operswithoutlife.net>
 *           and all past and present planeshift coders
 *
 * This program 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 (version 2 of the License.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */
 
#ifndef _PSMUSIC_H_
#define _PSMUSIC_H_

//------------------------------------------------------------------------------------
// Forward Declarations
//------------------------------------------------------------------------------------
class SoundHandle;


class psMusic
{
public:
    csString       resource;            
    int            type;                
    float          minvol;              
    float          maxvol;              
    int            fadedelay;           
    int            timeofday;           
    int            timeofdayrange;      
    size_t         loopstart;           
    size_t         loopend;             
    bool           active;              
    SoundHandle*   handle;              
    
    psMusic();
    ~psMusic();
    bool CheckTimeOfDay(int time);
    bool CheckType(const int _type);
    void FadeDownAndStop();
    void FadeDown();
    void FadeUp();
    bool Play(bool loopToggle, SoundControl* &ctrl);
    void Stop();
    void SetUnManaged();
    void SetManaged();
    void Loop();
    void DontLoop();
    void UpdateHandleCallback();
    static void StopCallback(void* object);
};

#endif /*_PSMUSIC_H_*/