CWE-ou-minkata/Sources/Plasma/PubUtilLib/plAudio/plVoiceChat.h

/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

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, either version 3 of the License, or
(at your option) any later version.

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, see <http://www.gnu.org/licenses/>.

Additional permissions under GNU GPL version 3 section 7

If you modify this Program, or any covered work, by linking or
combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK,
NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent
JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK
(or a modified version of those libraries),
containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA,
PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG
JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the
licensors of this Program grant you additional
permission to convey the resulting work. Corresponding Source for a
non-source form of such a combination shall include the source code for
the parts of OpenSSL and IJG JPEG Library used as well as that of the covered
work.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/
#ifndef plVoiceChat_h
#define plVoiceChat_h

#include "hsTemplates.h"
#include "plWin32Sound.h"
#include "hsThread.h"

// voice flags
#define VOICE_ENCODED       ( 1 << 0 )
#define VOICE_NARROWBAND    ( 1 << 1 )
#define VOICE_ENH           ( 1 << 2 )
#define BUFFER_LEN_SECONDS      4
#define FREQUENCY               8000

struct hsVector3;
struct SpeexBits;
class  plWinAudible;
class  plPlate;
class  plStatusLog;
class  plSpeex;
typedef struct ALCdevice_struct ALCdevice;


// Sound used for playing back dynamic voice chat data. this allows us to hook voice chat into the audio system
class plVoiceSound : public plWin32Sound
{
public:
    plVoiceSound();
    ~plVoiceSound();
    bool LoadSound( bool is3D );
    void AddVoiceData(void *data, unsigned bytes);
    void Update();
    void Play();
    virtual void SetStartPos(unsigned bytes){}
    
private:
    virtual bool    ILoadDataBuffer( void ){ return true; }
    virtual void    IUnloadDataBuffer( void ){}

    virtual void    IDerivedActuallyPlay( void );
    virtual void    ISetActualTime( double t ){}
    virtual float   GetActualTimeSec() { return 0.0f; }
    virtual void    IRefreshParams( void );
    static unsigned fCount;
    double   fLastUpdate;
};

class plVoicePlayer
{
public:
    plVoicePlayer();
    ~plVoicePlayer();
    void PlaybackVoiceMessage(void* data, unsigned size, int numFramesInBuffer);
    void PlaybackUncompressedVoiceMessage(void* data, unsigned size);
    void SetVelocity(const hsVector3 vel);
    void SetPosition(const hsPoint3 pos);
    void SetOrientation(const hsPoint3 pos);
    
    void SetTalkIcon(int index, uint32_t str){}
    void ClearTalkIcon(){}
    plVoiceSound *GetSoundPtr() { return &fSound; }
    static void Enable(bool enable) { fEnabled = enable; }

private:
    plVoiceSound fSound;
    static bool fEnabled;
};

class plVoiceRecorder
{
public:
    plVoiceRecorder();
    ~plVoiceRecorder();

    void Update(double time);
    void SetMikeOpen(bool b);
    void DrawTalkIcon(bool b);
    void DrawDisabledIcon(bool b);
    
    void    SetTalkIcon(int index, uint32_t str);
    void    ClearTalkIcon();

    static bool     RecordingEnabled() { return fRecording; }
    static bool     NetVoiceEnabled() { return fNetVoice; }
    static bool     CompressionEnabled() { return fCompress; }
    static void     EnablePushToTalk(bool b) { fMicAlwaysOpen = !b; }
    static void     EnableIcons(bool b) { fShowIcons = b; }
    static void     EnableRecording(bool b) { fRecording = b; }
    static void     EnableNetVoice(bool b) { fNetVoice = b; }
    static void     EnableCompression(bool b) { fCompress = b; }
    static void     SetSampleRate(short s) { fSampleRate = s; }
    static void     SetSquelch(float f) { fRecordThreshhold = f; }

    static void IncreaseRecordingThreshhold();
    static void DecreaseRecordingThreshhold();

    static void SetQuality(int quality);    // sets the quality of encoding
    static void SetMode(int mode);  // sets nb or wb mode
    static void SetVBR(bool vbr);
    static void SetComplexity(int c);
    static void SetENH(bool b);
    static short GetSampleRate() { return fSampleRate; }
    
private:
    
    bool                    fMikeOpen;
    bool                    fMikeJustClosed;
    static bool             fMicAlwaysOpen;
    static bool             fShowIcons;
    static bool             fCompress;
    static bool             fNetVoice;
    static bool             fRecording;
    static short            fSampleRate;
    plPlate*                fDisabledIcon;
    plPlate*                fTalkIcon;
    static float         fRecordThreshhold;
};


// Speex voice encoder/decoder class
class plSpeex 
{
public:
    ~plSpeex();
    
    enum Mode
    {
        kNarrowband,
        kWideband,
        kUltraWideband
    };
    static plSpeex *GetInstance()   
    {
        static plSpeex instance;
        return &instance;
    }

    bool Init(Mode mode);
    bool Shutdown();
    bool Encode(short *data, int numFrames, int *packedLength, hsRAMStream *out);
    bool Decode(uint8_t *data, int size, int numFrames, int *numOutputBytes, short *out);
    int    GetFrameSize() { return fFrameSize; }
    void   VBR(bool b);                                   // turn variable bit rate on/off
    void   SetVBR(uint32_t vbr);                              // Set variable bit rate quality
    void   ABR(bool b);                                   // turn average bit rate on/off
    void   SetABR(uint32_t abr);                              // Set average bit rate quality
    void   SetQuality(uint32_t quality);                      // Set encoder quality
    bool IsUsingVBR()         { return fVBR; }
    int    GetQuality()         { return fQuality; }
    void   SetENH(bool b);
    void   SetComplexity(uint8_t c);

    bool Initialized() { return fInitialized; }
    
private:
    plSpeex();
    SpeexBits*                  fBits;                  // main speex structure
    bool                        fBitsInit;
    void*                       fEncoderState;
    void*                       fDecoderState;
    int                         fSampleRate;
    int                         fFrameSize;             // frame size from speex - 160 for nb
    int                         fQuality;               // 0-10 speex encode quality
    bool                        fVBR;                   // toggle variable bit rate
    int                         fAverageBitrate;        // n-bits per second
    uint8_t                       fComplexity;            // 1-10 sets cpu resources allowed for encoder
    bool                        fENH;                   // perceptual enhancement
    bool                        fInitialized;           
};

#endif //plVoiceChat_h