data.h

Go to the documentation of this file.

/*
 * data.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 _SOUND_DATA_CACHE_H_
#define _SOUND_DATA_CACHE_H_


//====================================================================================
// Crystal Space Includes
//====================================================================================
#include <cssysdef.h>
#include <iutil/objreg.h>
#include <csutil/csstring.h>
#include <csutil/hash.h>
#include <iutil/vfs.h>
#include <isndsys/ss_data.h>
#include <isndsys/ss_loader.h>

#define DEFAULT_SOUNDFILE_CACHETIME 300000


struct SoundFile
{
public:
    csString            name;           
    csString            fileName;       
    csRef<iSndSysData>  sndData;        
    csTicks             lastTouch;      

    SoundFile(const char* newName, const char* newFileName);

    SoundFile(SoundFile* const &copySoundFile);

    ~SoundFile();
};


//--------------------------------------------------


class SoundDataCache
{
public:

    SoundDataCache();

    ~SoundDataCache();

    bool Initialize(iObjectRegistry* objectReg);

    bool LoadSoundLib(const char* fileName, iObjectRegistry* objectReg);

    void UnloadSoundLib();

    bool GetSoundData(const char* name, csRef<iSndSysData> &sndData);

    void UnloadSoundFile(const char* name);

    void Update();

private:
    uint                         cacheTime;         
    csRef<iVFS>                  vfs;               
    csRef<iSndSysLoader>         sndLoader;         
    csHash<SoundFile*, csString> libSoundFiles;     
    csHash<SoundFile*, csString> loadedSoundFiles;  
    
    SoundFile* LoadSoundFile(const char* name);
};

#endif // _SOUND_DATA_CACHE_H_