ODFlacDecoder Class Reference

class to decode a particular file (one per file). Saves info such as filename and length (after the header is read.) More...

#include <ODDecodeFlacTask.h>

Inheritance diagram for ODFlacDecoder:

Collaboration diagram for ODFlacDecoder:

Public Member Functions
	ODFlacDecoder (const wxString &fileName)
	This should handle unicode converted to UTF-8 on mac/linux, but OD TODO:check on windows. More...
virtual	~ODFlacDecoder ()
int	Decode (SampleBuffer &data, sampleFormat &format, sampleCount start, size_t len, unsigned int channel) override
bool	ReadHeader () override
ODFLACFile *	GetFlacFile ()
	FLAC specific file (inherited from FLAC::Decoder::File) More...
Public Member Functions inherited from ODFileDecoder
	ODFileDecoder (const wxString &fName)
	This should handle unicode converted to UTF-8 on mac/linux, but OD TODO:check on windows. More...
virtual	~ODFileDecoder ()
virtual bool	Init ()
virtual bool	SeekingAllowed ()
const wxString &	GetFileName ()
bool	IsInitialized ()

Private Attributes
sampleFormat	mFormat
std::unique_ptr< ODFLACFile >	mFile
ODLock	mFlacFileLock
wxFFile	mHandle
unsigned long	mSampleRate
unsigned long	mNumChannels
unsigned long	mBitsPerSample
FLAC__uint64	mNumSamples
FLAC__uint64	mSamplesDone
sampleCount	mLastDecodeStartSample
bool	mStreamInfoDone
int	mUpdateResult
WaveTrack **	mChannels
unsigned int	mTargetChannel
unsigned int	mDecodeBufferWritePosition
unsigned int	mDecodeBufferLen
samplePtr	mDecodeBuffer

Friends
class	ODFLACFile
class	FLACImportFileHandle

Additional Inherited Members
Protected Member Functions inherited from ODFileDecoder
void	MarkInitialized ()
	Derived classes should call this after they have parsed the header. More...
Protected Attributes inherited from ODFileDecoder
bool	mInited
ODLock	mInitedLock
const wxString	mFName
unsigned int	mSampleRate
unsigned int	mNumSamples
unsigned int	mNumChannels

Detailed Description

class to decode a particular file (one per file). Saves info such as filename and length (after the header is read.)

Definition at line 96 of file ODDecodeFlacTask.h.

Constructor & Destructor Documentation

ODFlacDecoder()

ODFlacDecoder::ODFlacDecoder ( const wxString &  fileName )

inline

This should handle unicode converted to UTF-8 on mac/linux, but OD TODO:check on windows.

Definition at line 101 of file ODDecodeFlacTask.h.

:ODFileDecoder(fileName),mSamplesDone(0){mFile=NULL;}

References mFile.

~ODFlacDecoder()

ODFlacDecoder::~ODFlacDecoder ( )

virtual

Definition at line 270 of file ODDecodeFlacTask.cpp.

                             {
   if(mFile)
      mFile->finish();
}

References mFile.

Member Function Documentation

Decode()

int ODFlacDecoder::Decode ( SampleBuffer &  data, sampleFormat &  format, sampleCount  start, size_t  len, unsigned int  channel  )

overridevirtual

Decodes the samples for this blockfile from the real file into a float buffer. This is file specific, so subclasses must implement this only. the buffer was defined like samplePtr sampleData = NewSamples(mLen, floatSample); this->ReadData(sampleData, floatSample, 0, mLen); This class should call ReadHeader() first, so it knows the length, and can prepare the file object if it needs to.

Implements ODFileDecoder.

Definition at line 172 of file ODDecodeFlacTask.cpp.

{
 
   //we need to lock this so the target stays fixed over the seek/write callback.
   mFlacFileLock.Lock();
 
   bool usingCache=mLastDecodeStartSample==start;
   if(usingCache)
   {
      //we've just decoded this, so lets use a cache.  (often so for
   }
 
 
   mDecodeBufferWritePosition=0;
   mDecodeBufferLen = len;
 
   data.Allocate(len, mFormat);
   mDecodeBuffer = data.ptr();
   format = mFormat;
 
   mTargetChannel=channel;
 
   // Third party library has its own type alias, check it
   static_assert(sizeof(sampleCount::type) <=
                 sizeof(FLAC__int64),
                 "Type FLAC__int64 is too narrow to hold a sampleCount");
   if(!mFile->seek_absolute(static_cast<FLAC__int64>( start.as_long_long() )))
   {
      mFlacFileLock.Unlock();
      return -1;
   }
 
   while(mDecodeBufferWritePosition<mDecodeBufferLen)
      mFile->process_single();
 
   mFlacFileLock.Unlock();
   if(!usingCache)
   {
      mLastDecodeStartSample=start;
   }
   //insert into blockfile and
   //calculate summary happen in ODDecodeBlockFile::WriteODDecodeBlockFile, where this method is also called.
   return 1;
}

References SampleBuffer::Allocate(), sampleCount::as_long_long(), format, mDecodeBuffer, mDecodeBufferLen, mDecodeBufferWritePosition, mFile, mFlacFileLock, mFormat, mLastDecodeStartSample, mTargetChannel, and SampleBuffer::ptr().

Here is the call graph for this function:

GetFlacFile()

ODFLACFile * ODFlacDecoder::GetFlacFile

(

)

FLAC specific file (inherited from FLAC::Decoder::File)

Definition at line 265 of file ODDecodeFlacTask.cpp.

{
   return mFile.get();
}

References mFile.

ReadHeader()

bool ODFlacDecoder::ReadHeader ( )

overridevirtual

Read header. Subclasses must override. Probably should save the info somewhere. Ideally called once per decoding of a file. This complicates the task because

Read header. Subclasses must override. Probably should save the info somewhere. Ideally called once per decoding of a file. This complicates the task because returns true if the file exists and the header was read alright.

Implements ODFileDecoder.

Definition at line 223 of file ODDecodeFlacTask.cpp.

{
   mFormat = int16Sample;//start with the smallest and move up in the metadata_callback.
                         //we want to use the native flac type for quick conversion.
      /* QualityPrefs::SampleFormatChoice(); */
   mFile = std::make_unique<ODFLACFile>(this);
 
 
   if (!mHandle.Open(mFName, wxT("rb"))) {
      return false;
   }
 
   // Even though there is an init() method that takes a filename, use the one that
   // takes a file handle because wxWidgets can open a file with a Unicode name and
   // libflac can't (under Windows).
   //
   // Responsibility for closing the file is passed to libflac.
   // (it happens when mFile->finish() is called)
   bool result = mFile->init(mHandle.fp())?true:false;
   mHandle.Detach();
 
   if (result != FLAC__STREAM_DECODER_INIT_STATUS_OK) {
      return false;
   }
 
   //this will call the metadata_callback when it is done
   mFile->process_until_end_of_metadata();
   // not necessary to check state, error callback will catch errors, but here's how:
   if (mFile->get_state() > FLAC__STREAM_DECODER_READ_FRAME) {
      return false;
   }
 
   if (!mFile->is_valid() || mFile->get_was_error()) {
      // This probably is not a FLAC file at all
      return false;
   }
 
   MarkInitialized();
   return true;
 
}

References int16Sample, ODFileDecoder::MarkInitialized(), mFile, ODFileDecoder::mFName, mFormat, and mHandle.

Here is the call graph for this function:

Friends And Related Function Documentation

FLACImportFileHandle

friend class FLACImportFileHandle

friend

Definition at line 122 of file ODDecodeFlacTask.h.

ODFLACFile

friend class ODFLACFile

friend

Definition at line 98 of file ODDecodeFlacTask.h.

Member Data Documentation

mBitsPerSample

unsigned long ODFlacDecoder::mBitsPerSample

private

Definition at line 129 of file ODDecodeFlacTask.h.

Referenced by ODFLACFile::metadata_callback().

mChannels

WaveTrack** ODFlacDecoder::mChannels

private

Definition at line 135 of file ODDecodeFlacTask.h.

mDecodeBuffer

samplePtr ODFlacDecoder::mDecodeBuffer

private

Definition at line 139 of file ODDecodeFlacTask.h.

Referenced by Decode(), and ODFLACFile::write_callback().

mDecodeBufferLen

unsigned int ODFlacDecoder::mDecodeBufferLen

private

Definition at line 138 of file ODDecodeFlacTask.h.

Referenced by Decode(), and ODFLACFile::write_callback().

mDecodeBufferWritePosition

unsigned int ODFlacDecoder::mDecodeBufferWritePosition

private

Definition at line 137 of file ODDecodeFlacTask.h.

Referenced by Decode(), and ODFLACFile::write_callback().

mFile

std::unique_ptr<ODFLACFile> ODFlacDecoder::mFile

private

Definition at line 124 of file ODDecodeFlacTask.h.

Referenced by Decode(), GetFlacFile(), ODFlacDecoder(), ReadHeader(), and ~ODFlacDecoder().

mFlacFileLock

ODLock ODFlacDecoder::mFlacFileLock

private

Definition at line 125 of file ODDecodeFlacTask.h.

Referenced by Decode().

mFormat

sampleFormat ODFlacDecoder::mFormat

private

Definition at line 123 of file ODDecodeFlacTask.h.

Referenced by Decode(), ODFLACFile::metadata_callback(), ReadHeader(), and ODFLACFile::write_callback().

mHandle

wxFFile ODFlacDecoder::mHandle

private

Definition at line 126 of file ODDecodeFlacTask.h.

Referenced by ReadHeader().

mLastDecodeStartSample

sampleCount ODFlacDecoder::mLastDecodeStartSample

private

Definition at line 132 of file ODDecodeFlacTask.h.

Referenced by Decode().

mNumChannels

unsigned long ODFlacDecoder::mNumChannels

private

Definition at line 128 of file ODDecodeFlacTask.h.

Referenced by ODFLACFile::metadata_callback().

mNumSamples

FLAC__uint64 ODFlacDecoder::mNumSamples

private

Definition at line 130 of file ODDecodeFlacTask.h.

Referenced by ODFLACFile::metadata_callback().

mSampleRate

unsigned long ODFlacDecoder::mSampleRate

private

Definition at line 127 of file ODDecodeFlacTask.h.

Referenced by ODFLACFile::metadata_callback().

mSamplesDone

FLAC__uint64 ODFlacDecoder::mSamplesDone

private

Definition at line 131 of file ODDecodeFlacTask.h.

Referenced by ODFLACFile::write_callback().

mStreamInfoDone

bool ODFlacDecoder::mStreamInfoDone

private

Definition at line 133 of file ODDecodeFlacTask.h.

Referenced by ODFLACFile::metadata_callback().

mTargetChannel

unsigned int ODFlacDecoder::mTargetChannel

private

Definition at line 136 of file ODDecodeFlacTask.h.

Referenced by Decode(), and ODFLACFile::write_callback().

mUpdateResult

int ODFlacDecoder::mUpdateResult

private

Definition at line 134 of file ODDecodeFlacTask.h.

---

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

• ODDecodeFlacTask.h
• ODDecodeFlacTask.cpp