SndWrap.h

/*
* Copyright (C) TES Electronic Solutions GmbH,
* All Rights Reserved.
* Contact: info@guiliani.de
*
* This file is part of the Guiliani HMI framework
* for the development of graphical user interfaces on embedded systems.
*/
 
#ifndef SNDWRAP__H_
#define SNDWRAP__H_
 
#include "eC_String.h"
#include "eC_Types.h"
#include "GUISoundResource.h"
 
#include "GUIComponentManager.h"
 
#define GETSND CGUIComponentManager::GetInstance().GetSndWrap()
 
// define flags
#define PLAY_SYNC           1
#define PLAY_ASYNC          2
#define PLAY_WAIT           4
#define PLAY_DISCARD        8
#define PLAY_IMMEDIATELY    16
 
 
 
class CSndWrap
{
    /*  the resourcemanager is the only class which may access the loadsnd and
        unloadsnd-methods of the sndwrapped directly. therefore it is granted
        friend-access.
    */
    friend class CGUIResourceManager; 
    friend class CGUIComponentManager; 
 
public:
    static void DeleteInstance();
 
    virtual eC_UByte GetVolume() = 0;
 
    virtual eC_Bool PauseSnd(const SoundResource_t &eID) = 0;
 
    virtual eC_Bool PlaySnd(const SoundResource_t &eID, eC_UInt uiFlags = PLAY_ASYNC) = 0;
 
    virtual eC_Bool ResumeSnd(const SoundResource_t &eID) = 0;
 
    virtual eC_Bool SetVolume(eC_UByte ubVolume) = 0;
 
    virtual eC_Bool StopSnd(const SoundResource_t &eID) = 0;
 
    inline virtual eC_UInt GetNOFSounds() {return m_uiNOFSounds;}
 
protected:
    CSndWrap(const CSndWrap& kSource);
 
    CSndWrap& operator=(const CSndWrap& kSource);
 
    CSndWrap();
 
    virtual ~CSndWrap();
 
    virtual eC_Bool SetNOFSounds(eC_UInt uiNOFSounds);
 
    virtual void LoadSnd(const eC_String& kPath, const SoundResource_t &eID, eC_UInt uiDeviceID = 0) = 0;
 
    virtual void UnloadSnd(const SoundResource_t &eID) = 0;
 
protected:
    eC_UInt m_uiNOFSounds;
};
#endif