CascadeAudioCodec.h

Go to the documentation of this file.

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

#ifndef _ROKU_INCLUDE_CASCADE_AV_CASCADEAUDIOCODEC_H
#define _ROKU_INCLUDE_CASCADE_AV_CASCADEAUDIOCODEC_H

#include <cascade/av/CascadeCodec.h>

class CascadeAudioCodec : public CascadeCodec, public CascadeStream
{
public:
        CascadeAudioCodec();
        virtual ~CascadeAudioCodec();

public: // overrides from CascadeCodec
    virtual CascadeStream * GetOutputStream() { return this; };

public: // overrides from CascadeStream
    virtual u64 GetSize()                           { return 0; }
    virtual u64 GetPosition()                       { return 0; }
    virtual bool SeekToPosition(u64 nPosition)      { return false; }
        // even though an audio codec is a stream, generally speaking
        // the size is not known a-priori and streams are not seekable
        
public:
    enum SamplePolarity     { kSigned = 0, kUnsigned = 1 };
    enum SampleEndianness   { kLittleEndian = 0, kBigEndian = 1 };
    enum SampleOrder        { kLeftRight = 0, kRightLeft = 1 };
    
    virtual u32 GetSampleRate() = 0;
        // returns 0 if unknown
    virtual u32 GetNumChannels() = 0;
        // returns 0 if unknown
    virtual u32 GetBitsPerSample() = 0;
        // returns 0 if unknown
    virtual u32 GetDurationInMilliseconds() = 0;
        // returns 0 if unknown
    virtual SamplePolarity GetSamplePolarity() = 0;
        // returns the sample polarity, signed or unsigned
    virtual SampleEndianness GetSampleEndianness() = 0;
        // returns the sample endianness (not relevant with 8 bits per sample)
    virtual SampleOrder GetSampleOrder() = 0;
        // returns the sample order (only valid for stereo samples)
};

#endif // #ifndef _ROKU_INCLUDE_CASCADE_AV_CASCADEAUDIOCODEC_H

//  LOG
//  03-Mar-04   dwoodward       created
//  03-May-04   dwoodward   added polarity, endianness, and order

---