WaAudioDev.h

Go to the documentation of this file.

/*
 * This file is part of the Wave Arts VQE library.
 * Copyright (C) 2011 Wave Arts, Inc. (http://wavearts.com)
 *
 * VQE 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 of the License, or
 * (at your option) any later version.
 *
 * VQE 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.
 *
 * A copy of the GNU General Public License is included with VQE,
 * and can be found online at <http://www.gnu.org/licenses/>.
 *
 * If you'd like to distribute a closed-source product which uses VQE,
 * you must obtain a commercial VQE license from Wave Arts.
 */
#ifndef _WA_AUDIO_DEV_H
#define _WA_AUDIO_DEV_H

#include <stdlib.h>
#include "WaPlatform.h"

typedef enum {
        WadUnknownFmt = 0,      
        WadInt16,       
        WadFloat32      
} WadSampFmt;

typedef enum {
        WadPriorityNorm,        
        WadPriorityHigh,        
        WadPriorityMax          
} WadPriority;

typedef struct {
        WadSampFmt sampFmt;     
        int numChan;            
        int sampRate;           
        int framesPerBuf;       
} WadStreamFormat;

#define WadSampSize(sampFmt) ((sampFmt == WadInt16) ? sizeof(short) : sizeof(float))

typedef struct {
        int inDev;                              
        WadStreamFormat inFmt;  
        int outDev;                             
        WadStreamFormat outFmt; 
        WadPriority priority;   
        int inBufTimeMsec;              
        int outBufTimeMsec;             
} WadParam;

#define WAD_NAME_LEN    64

typedef struct {
        int numInChan;  
        int numOutChan; 
        char name[WAD_NAME_LEN];        
} WadDevInfo;

typedef int WadCallbackFn(void *buf, WadStreamFormat *fmt, void *arg);

#define WAD_MAX_ERROR_TEXT      128

enum WadStatus {
        WAD_OK = 0,                                     
        WAD_ERR_INTERNAL,                       
        WAD_ERR_UNSUPPORTED,            
        WAD_ERR_INVALID_ARG,            
        WAD_ERR_NOT_INITIALIZED,        
        WAD_ERR_NOT_OPEN,                       
        WAD_ERR_INVALID_DEVICE,         
        // Use GetClosestFormat() to return suggestions for unsupported formats
        WAD_ERR_IN_FORMAT,                      
        WAD_ERR_OUT_FORMAT,                     
        // more detail...
        WAD_ERR_IN_SAMPRATE,            
        WAD_ERR_OUT_SAMPRATE,           
        WAD_ERR_IN_NUMCHAN,                     
        WAD_ERR_OUT_NUMCHAN,            
        WAD_ERR_IN_SAMPFORMAT,          
        WAD_ERR_OUT_SAMPFORMAT,         
        WAD_ERR_IN_FRAMESPERBUF,        
        WAD_ERR_OUT_FRAMESPERBUF,       
};

// Up to here definitions are C compatible. They used to be in a separate
// file in case C code wanted to interact with the API. That's why
// the callback returns int rather than bool.


typedef enum {
        WadAPI_None,            
        WadAPI_File,            
        WadAPI_WinMME,          
        WadAPI_WinWASAPI,       
        WadAPI_MacHAL           
} WadAPI;

class WaAudioDev;

class WaAudioDevPort {
public:
        WaAudioDevPort() {}
        virtual ~WaAudioDevPort() {}

        virtual int Open(WadParam *param, WadCallbackFn *inFn, WadCallbackFn *outFn, void *arg) = 0;

        virtual int Start() = 0;

        virtual int Stop() = 0;

        virtual void Wait() = 0;

        virtual void Close() = 0;

        virtual bool IsOpen() = 0;

        virtual WaAudioDev *GetDevice() = 0;
};

// options for WadMake
#define WAD_MAKE_MME    0x01    //!< make MME interface, even on Vista and Win7
#define WAD_MAKE_FILE   0x02    //!< make file interface, usually for testing

class WaAudioDev : public WaAudioDevPort {
public:
        WaAudioDev();
        virtual ~WaAudioDev();

        virtual WadAPI GetAPI() = 0;

        virtual int Init() = 0;

        virtual int GetNumDevices(int *pNumDev) = 0;

        virtual int GetDevInfo(int devId, WadDevInfo *pInfo) = 0;

        virtual int GetDefaultInDevId(int *pId) = 0;

        virtual int GetDefaultOutDevId(int *pId) = 0;

        void SetMeteringEnable(bool enable);

        bool GetInPeak(float *pPeakVal);

        bool GetOutPeak(float *pPeakVal);

        float GetLastInPeak();

        float GetLastOutPeak();

        void ResetMetering();

        // helper functions
        static float PeakToDb(float peak, float minDb, float maxDb);

        static int CalcPeakInt16(short *buf, unsigned int numSamps);

        static float CalcPeakFloat32(float *buf, unsigned int numSamps);

        //
        // Instead of a generalized property interface, we provide methods to
        // get and set individual properties. By default they are unsupported.
        //

        virtual int SetVol(int devId, bool isOutput, float vol);

        virtual int GetVol(int devId, bool isOutput, float *pVol);

        virtual int GetBufTime(bool isOutput, int *pBufTimeMsec);

        virtual int GetClosestFormat(bool isOutput, WadStreamFormat *pFormat);

        WaAudioDev *GetDevice();

        virtual char *GetErrorText();

        bool IsInitialized();
        bool IsOpen();
        bool IsInOpen();
        bool IsOutOpen();

        virtual bool IsRunning() = 0;

        void SetErrorText(char *text);

        static WaAudioDev *WadMake(int options);

#if WA_WINDOWS

        static bool IsVistaOrAbove();
#endif

protected:
        // metering
        // implementations can call these to do the peak detection
        void ProcInPeakInt16(short *buf, unsigned int numSamps);
        void ProcInPeakFloat32(float *buf, unsigned int numSamps);
        void ProcOutPeakInt16(short *buf, unsigned int numSamps);
        void ProcOutPeakFloat32(float *buf, unsigned int numSamps);
        void SetIsInitialized(bool isInitialized);

        // peak metering
        float inPeak;
        float lastInPeak;
        float outPeak;
        float lastOutPeak;
        bool inPeakIsValid;
        bool outPeakIsValid;

        WadParam param;
        bool isInitialized;
        bool isMeteringEnabled;
        bool isOpen;
        char errorText[WAD_MAX_ERROR_TEXT];
};


class WaAudioDevPortObj : public WaAudioDevPort {
protected:
        WaAudioDevPort *devPort;        
public:
        WaAudioDevPortObj(WaAudioDevPort *devPort);
        virtual ~WaAudioDevPortObj();
        // partial implementation of WaAudioDevPort
        int Start();
        int Stop();
        void Wait();
        WaAudioDev *GetDevice();
        bool IsOpen();
        //
        //
        virtual void Reset();
};

#endif