CascadeVizData.h

Go to the documentation of this file.

//
// CascadeVizData.h - header file for class CascadeVizData
//
// Copyright (c) 2004, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_AV_CASCADEVIZDATA_H
#define _ROKU_INCLUDE_CASCADE_AV_CASCADEVIZDATA_H

#include <cascade/CascadeObject.h>

class CascadeVizData : public CascadeObject
{
public:
        CascadeVizData();
        virtual ~CascadeVizData();
public:
    // functions for clients that will be performing visualizations
    virtual bool IsPlaying();
    virtual bool IsPaused();
    virtual bool IsStopped();
    virtual u32  GetPlaybackMilliseconds();
    virtual bool GetVULevels(u16 & nLeftChannelToSet, u16 & nRightChannelToSet, u16 nScale = 0);
        // GetVULevels() will set nLeftChannelToSet and nRightChannelToSet with the VU
        // level from [0..nScale).  e.g. if nScale is 256, then valid values are from
        // [0..255].  If nScale is 0, then the full range of [0..65535] will be used.
    virtual bool GetScopeDataMono(s16 * pScopeDataToSet, u16 nNumDataPoints, u16 nYScale = 0);
    virtual bool GetScopeDataStereo(s16 * pScopeDataLeftToSet, s16 * pScopeDataRightToSet, u16 nNumDataPoints, u16 nYScale = 0);
    virtual bool GetScopeDataLeft(s16 * pScopeDataToSet, u16 nNumDataPoints, u16 nYScale = 0);
    virtual bool GetScopeDataRight(s16 * pScopeDataToSet, u16 nNumDataPoints, u16 nYScale = 0);
        // GetScopeData...() fills *pScopeDataToSet with nNumDataPoints data points
        // of signed 16 bit values in the range of [-nYScale .. nYScale), centered on 0.
        // e.g. if nYScale is 128, pScopeDataToSet will be set with values from
        // [-128..127].  if nYScale is 0, or nYScale >= 32767, then the full scale
        // of [-32768..32767] will be used.
    //virtual bool GetFrequencyData(u8 * pFrequencyDataToSet, u32 nNumDataPoints);
private:
    class Data;
    Data * m_pData;
};

#endif // #ifndef _ROKU_INCLUDE_CASCADE_AV_CASCADECODEC_H

// LOG
// 23-Mar-05    dwoodward       created

---