pcce::OggFile Class Reference

#include <OggFile.h>

List of all members.

Public Member Functions
	OggFile (const std::string &fileName)
	~OggFile ()
void	SetFileName (const std::string &fileName)
bool	IsOpen ()
void	Open ()
void	Close ()
void	Rewind ()
size_t	Read (size_t size, tCharVector &result)
size_t	Read (tCharVector &result)
unsigned short	GetChannelCount ()
unsigned long	GetFrequency ()
Private Member Functions
void	GetInfo ()
void	ResetInfo ()
Private Attributes
std::string	mFileName
OggVorbis_File *	mVorbisFile
unsigned short	mChannels
unsigned long	mFreq

---

Detailed Description

Definition at line 45 of file OggFile.h.

---

Constructor & Destructor Documentation

OggFile::OggFile

(

const std::string &

fileName

)

Definition at line 57 of file OggFile.cpp.

                                         : mFileName(fileName), mVorbisFile(NULL), mChannels(0), mFreq(0) {
}

OggFile::~OggFile

(

)

Definition at line 60 of file OggFile.cpp.

References Close().

                  {
  Close();
}

---

Member Function Documentation

void OggFile::SetFileName

(

const std::string &

fileName

)

Definition at line 64 of file OggFile.cpp.

References IsOpen(), mFileName, and PCCE_CHECK.

                                                   {
  PCCE_CHECK(!IsOpen(), "OggFile::SetFileName: Cannot set filename of open OggFile");
  mFileName = fileName;
}

bool OggFile::IsOpen

(

)

Definition at line 69 of file OggFile.cpp.

References mVorbisFile.

Referenced by Close(), GetChannelCount(), GetFrequency(), GetInfo(), Open(), Rewind(), and SetFileName().

                     {
  return NULL != mVorbisFile;
}

void OggFile::Open

(

)

Definition at line 73 of file OggFile.cpp.

References IsOpen(), mFileName, mVorbisFile, OggCallbacks, PCCE_CHECK, and PCCE_THROW.

Referenced by pcce::LoadOgg(), and pcce::OggStream::OggStream().

                   {
  PCCE_CHECK(!IsOpen(), "OggFile::Open: OggFile already open");

  FILE* f = fopen(mFileName.c_str(), "rb");
  if (!f) {
    PCCE_THROW("LoadOgg: Could not load ogg from " + mFileName);
  }

  mVorbisFile = new OggVorbis_File();
  if (ov_open_callbacks(f, mVorbisFile, NULL, 0, OggCallbacks) != 0) {
    delete mVorbisFile;
    mVorbisFile = NULL;
    fclose(f);
    PCCE_THROW("LoadOgg: ov_open failed on " + mFileName);
  }
}

void OggFile::Close

(

)

Definition at line 90 of file OggFile.cpp.

References IsOpen(), mVorbisFile, and ResetInfo().

Referenced by pcce::LoadOgg(), and ~OggFile().

                    {
  if (IsOpen()) {
    ov_clear(mVorbisFile);
    delete mVorbisFile;
    mVorbisFile = NULL;
  }
  ResetInfo();
}

void OggFile::Rewind

(

)

Definition at line 99 of file OggFile.cpp.

References IsOpen(), mVorbisFile, and PCCE_CHECK.

Referenced by pcce::OggStream::Stop().

                     {
  PCCE_CHECK(IsOpen(), "OggFile::Rewind: OggFile must be open to rewind");
  
  PCCE_CHECK(ov_raw_seek(mVorbisFile, 0) == 0, "OggFile::Rewind: Could not rewind");
}

size_t OggFile::Read	(	size_t	size,
		tCharVector &	result
	)

Definition at line 105 of file OggFile.cpp.

References BUFFER_SIZE, mVorbisFile, and PCCE_CHECK.

Referenced by pcce::OggStream::FillBuffer(), pcce::LoadOgg(), and Read().

                                                     {
  // 0 for Little-Endian, 1 for Big-Endian
  #if PCCE_BIG_ENDIAN
  int endian = 1;
  #else
  int endian = 0;
  #endif
  char array[BUFFER_SIZE];
  long bytes;
  int bitStream;
  size_t totalRead = 0;
  
  PCCE_CHECK(size > 0, "OggFile::Read: size must be > 0");
  
  do {
    PCCE_CHECK(totalRead < size, "OggFile::Read: Internal error");
    
    // Read up to a buffer's worth of decoded sound data
    bytes = ov_read(mVorbisFile, array, std::min(size - totalRead, BUFFER_SIZE), endian, 2, 1, &bitStream);
    // Append to end of buffer
    result.insert(result.end(), array, array + bytes);
    
    totalRead += bytes;
  } while ((bytes > 0) && (totalRead < size));
  
  return totalRead;
}

size_t OggFile::Read

(

tCharVector &

result

)

Definition at line 133 of file OggFile.cpp.

References BUFFER_SIZE, and Read().

                                        {
  size_t totalCount = 0;
  size_t readCount;
  
  do {
    readCount = Read(BUFFER_SIZE, result);
    totalCount += readCount;
  } while (readCount == BUFFER_SIZE);
  
  return totalCount;
}

unsigned short OggFile::GetChannelCount

(

)

Definition at line 145 of file OggFile.cpp.

References GetInfo(), IsOpen(), mChannels, and PCCE_CHECK.

Referenced by pcce::LoadOgg(), and pcce::OggStream::OggStream().

                                        {
  PCCE_CHECK(IsOpen(), "OggFile::GetFormat: You must open a file first");
  if (mChannels == 0) {
    GetInfo();
  }
  return mChannels;
}

unsigned long OggFile::GetFrequency

(

)

Definition at line 153 of file OggFile.cpp.

References GetInfo(), IsOpen(), mFreq, and PCCE_CHECK.

Referenced by pcce::LoadOgg(), and pcce::OggStream::OggStream().

                                    {
  PCCE_CHECK(IsOpen(), "OggFile::GetFrequency: You must open a file first");
  if (mFreq == 0) {
    GetInfo();
  }
  return mFreq;
}

void OggFile::GetInfo

(

)

[private]

Definition at line 161 of file OggFile.cpp.

References IsOpen(), mChannels, mFileName, mFreq, mVorbisFile, and PCCE_CHECK.

Referenced by GetChannelCount(), and GetFrequency().

                      {
  PCCE_CHECK(IsOpen(), "OggFile::LoadInfo: You must open a file first");
  
  vorbis_info* info = ov_info(mVorbisFile, -1);
  PCCE_CHECK(info != NULL, "OggFile::LoadInfo: ov_info failed on " + mFileName);

  mChannels = info->channels;
  mFreq = info->rate;
}

void OggFile::ResetInfo

(

)

[private]

Definition at line 171 of file OggFile.cpp.

References mChannels, and mFreq.

Referenced by Close().

                        {
  mChannels = 0;
  mFreq = 0;
}

---

Member Data Documentation

std::string pcce::OggFile::mFileName [private]

Definition at line 66 of file OggFile.h.

Referenced by GetInfo(), Open(), and SetFileName().

OggVorbis_File* pcce::OggFile::mVorbisFile [private]

Definition at line 67 of file OggFile.h.

Referenced by Close(), GetInfo(), IsOpen(), Open(), Read(), and Rewind().

unsigned short pcce::OggFile::mChannels [private]

Definition at line 68 of file OggFile.h.

Referenced by GetChannelCount(), GetInfo(), and ResetInfo().

unsigned long pcce::OggFile::mFreq [private]

Definition at line 69 of file OggFile.h.

Referenced by GetFrequency(), GetInfo(), and ResetInfo().

---

The documentation for this class was generated from the following files:

• include/OggFile.h
• src/OggFile.cpp