PCMAudioPlayer.h

Go to the documentation of this file.

// PCMAudioPlayer.h - interface of class PCMAudioPlayer
//
// Copyright (c) 2003, Roku, LLC.
//

#ifndef _ROKU_INCLUDE_DESCHUTES_LIBRARIES_HDMACHINEX225_PCMAUDIOPLAYER_H
#define _ROKU_INCLUDE_DESCHUTES_LIBRARIES_HDMACHINEX225_PCMAUDIOPLAYER_H

#include <cascade/av/CascadeAudioPlaybackDevice.h>

// class PCMAudioPlayer
class PCMAudioPlayer : public CascadeAudioPlaybackDevice
{
public: 
    PCMAudioPlayer();
    virtual ~PCMAudioPlayer();

public:
    bool IsOpen();
        // returns true if the PCMAudioPlayer is open

public:
    virtual bool GetBufferRequirements(u32 & nMinNumBuffersToSet, u32 & nMaxNumBuffersToSet, u32 & nMinBufferSizeToSet, u32 & nMaxBufferSizeToSet, u32 & nBufferSizeMultipleToSet);
        virtual bool GetDefaultBufferRequirements(u32 & nNumBuffersToSet, u32 & nBufferSizeInBytesToSet);
    virtual bool Open(u32 nNumBuffers, u32 nBufferSizeInBytes, void ** ppBufferLocationsToSet);
        virtual bool Close();
        virtual bool QueueBuffer(s16 * pData, u32 nSamples);
        virtual u32  WaitForBuffer();
    virtual bool GetNumBuffersAvailable(u32 & nNumBuffersAvailableToSet);
        virtual bool Pause();
        virtual bool Play();
        virtual bool Flush();
        virtual bool SetVolume(u16 nVolume);
        virtual bool SetSampleRate(u32 nSampleRate);
    virtual u32  GetSampleRate();
    virtual bool IsSupportedSampleRate(u32 nSampleRate);
    virtual bool SetOutputFlags(bool bAnalog, bool bSPDIF);
    virtual void GetOutputFlags(bool & bAnalogToSet, bool & bSPDIFToSet);

private:
    void * m_pPlayerInternal;
};

#endif // #ifndef _ROKU_INCLUDE_DESCHUTES_LIBRARIES_HDMACHINEX225_PCMAUDIOPLAYER_H

//  LOG
//  08-Aug-03   dwoodward   created
//  09-Dec-03   dwoodward   added GetNumBuffersAvailable()
//  02-Aug-04   dwoodward   added IsSupportedSampleRate()
//  29-Sep-04   dwoodward   added SetOutputFlags() and GetOutputFlags()
//  25-Feb-05   dwoodward   updated for new GetBufferRequirements interface, added GetDefaultBufferRequirements
//  03-Mar-05   dwoodward   added GetSampleRate()

---