FLACImportFileHandle Class Reference

An ImportFileHandle for FLAC data. More...

Inheritance diagram for FLACImportFileHandle:

Collaboration diagram for FLACImportFileHandle:

Public Member Functions
	FLACImportFileHandle (const FilePath &name)
	~FLACImportFileHandle ()
bool	Init ()
TranslatableString	GetFileDescription () override
ByteCount	GetFileUncompressedBytes () override
ProgressResult	Import (WaveTrackFactory *trackFactory, TrackHolders &outTracks, Tags *tags) override
wxInt32	GetStreamCount () override
const TranslatableStrings &	GetStreamInfo () override
void	SetStreamUsage (wxInt32 WXUNUSED(StreamID), bool WXUNUSED(Use)) override
Public Member Functions inherited from ImportFileHandle
	ImportFileHandle (const FilePath &filename)
virtual	~ImportFileHandle ()
void	CreateProgress ()
virtual TranslatableString	GetFileDescription ()=0
virtual ByteCount	GetFileUncompressedBytes ()=0
virtual wxInt32	GetStreamCount ()=0
virtual const TranslatableStrings &	GetStreamInfo ()=0
virtual void	SetStreamUsage (wxInt32 StreamID, bool Use)=0
virtual ProgressResult	Import (WaveTrackFactory *trackFactory, TrackHolders &outTracks, Tags *tags)=0

Private Attributes
sampleFormat	mFormat
std::unique_ptr< MyFLACFile >	mFile
wxFFile	mHandle
unsigned long	mSampleRate
unsigned long	mNumChannels
unsigned long	mBitsPerSample
FLAC__uint64	mNumSamples
FLAC__uint64	mSamplesDone
bool	mStreamInfoDone
ProgressResult	mUpdateResult
NewChannelGroup	mChannels

Friends
class	MyFLACFile

Additional Inherited Members
Public Types inherited from ImportFileHandle
using	ProgressResult = BasicUI::ProgressResult
using	ByteCount = unsigned long long
Static Public Member Functions inherited from ImportFileHandle
static sampleFormat	ChooseFormat (sampleFormat effectiveFormat)
	Choose appropriate format, which will not be narrower than the specified one. More...
Protected Member Functions inherited from ImportFileHandle
std::shared_ptr< WaveTrack >	NewWaveTrack (WaveTrackFactory &trackFactory, sampleFormat effectiveFormat, double rate)
	Build a wave track with appropriate format, which will not be narrower than the specified one. More...
Protected Attributes inherited from ImportFileHandle
FilePath	mFilename
std::unique_ptr< ProgressDialog >	mProgress

Detailed Description

An ImportFileHandle for FLAC data.

Definition at line 133 of file ImportFLAC.cpp.

Constructor & Destructor Documentation

FLACImportFileHandle()

FLACImportFileHandle::FLACImportFileHandle

(

const FilePath &

name

)

Definition at line 333 of file ImportFLAC.cpp.

:  ImportFileHandle(name),
   mSamplesDone(0),
   mStreamInfoDone(false),
   mUpdateResult(ProgressResult::Success)
{
   // Initialize mFormat as narrowest
   mFormat = narrowestSampleFormat;
   mFile = std::make_unique<MyFLACFile>(this);
}

References mFile, mFormat, and narrowestSampleFormat.

~FLACImportFileHandle()

FLACImportFileHandle::~FLACImportFileHandle

(

)

Definition at line 485 of file ImportFLAC.cpp.

{
   mFile->finish();
}

References mFile.

Member Function Documentation

GetFileDescription()

TranslatableString FLACImportFileHandle::GetFileDescription ( )

overridevirtual

Implements ImportFileHandle.

Definition at line 396 of file ImportFLAC.cpp.

{
   return DESC;
}

References DESC.

GetFileUncompressedBytes()

auto FLACImportFileHandle::GetFileUncompressedBytes ( )

overridevirtual

Implements ImportFileHandle.

Definition at line 402 of file ImportFLAC.cpp.

{
   // TODO: Get Uncompressed byte count.
   return 0;
}

GetStreamCount()

wxInt32 FLACImportFileHandle::GetStreamCount ( )

inlineoverridevirtual

Implements ImportFileHandle.

Definition at line 147 of file ImportFLAC.cpp.

{ return 1; }

GetStreamInfo()

const TranslatableStrings & FLACImportFileHandle::GetStreamInfo ( )

inlineoverridevirtual

Implements ImportFileHandle.

Definition at line 149 of file ImportFLAC.cpp.

   {
      static TranslatableStrings empty;
      return empty;
   }

Import()

ProgressResult FLACImportFileHandle::Import ( WaveTrackFactory *  trackFactory, TrackHolders &  outTracks, Tags *  tags  )

overridevirtual

Implements ImportFileHandle.

Definition at line 409 of file ImportFLAC.cpp.

{
   outTracks.clear();
 
   wxASSERT(mStreamInfoDone);
 
   CreateProgress();
 
   mChannels.resize(mNumChannels);
 
   {
      auto iter = mChannels.begin();
      for (size_t c = 0; c < mNumChannels; ++iter, ++c)
         *iter = NewWaveTrack(*trackFactory, mFormat, mSampleRate);
   }
 
   // TODO: Vigilant Sentry: Variable res unused after assignment (error code DA1)
   //    Should check the result.
   #ifdef LEGACY_FLAC
      bool res = (mFile->process_until_end_of_file() != 0);
   #else
      bool res = (mFile->process_until_end_of_stream() != 0);
   #endif
      wxUnusedVar(res);
 
   if (mUpdateResult == ProgressResult::Failed || mUpdateResult == ProgressResult::Cancelled) {
      return mUpdateResult;
   }
 
   for (const auto &channel : mChannels)
      channel->Flush();
 
   if (!mChannels.empty())
      outTracks.push_back(std::move(mChannels));
 
   wxString comment;
   wxString description;
 
   size_t cnt = mFile->mComments.size();
   if (cnt > 0) {
      tags->Clear();
      for (size_t c = 0; c < cnt; c++) {
         wxString name = mFile->mComments[c].BeforeFirst(wxT('='));
         wxString value = mFile->mComments[c].AfterFirst(wxT('='));
         wxString upper = name.Upper();
         if (upper == wxT("DATE") && !tags->HasTag(TAG_YEAR)) {
            long val;
            if (value.length() == 4 && value.ToLong(&val)) {
               name = TAG_YEAR;
            }
         }
         else if (upper == wxT("COMMENT") || upper == wxT("COMMENTS")) {
            comment = value;
            continue;
         }
         else if (upper == wxT("DESCRIPTION")) {
            description = value;
            continue;
         }
         tags->SetTag(name, value);
      }
 
      if (comment.empty()) {
         comment = description;
      }
      if (!comment.empty()) {
         tags->SetTag(TAG_COMMENTS, comment);
      }
   }
 
   return mUpdateResult;
}

References RefreshCode::Cancelled, Tags::Clear(), ImportFileHandle::CreateProgress(), Tags::HasTag(), mChannels, mFile, mFormat, mNumChannels, mSampleRate, mStreamInfoDone, mUpdateResult, name, ImportFileHandle::NewWaveTrack(), Tags::SetTag(), TAG_COMMENTS, TAG_YEAR, and wxT().

Here is the call graph for this function:

Init()

bool FLACImportFileHandle::Init

(

)

Definition at line 344 of file ImportFLAC.cpp.

{
#ifdef LEGACY_FLAC
   bool success = mFile->set_filename(OSINPUT(mFilename));
   if (!success) {
      return false;
   }
   mFile->set_metadata_respond(FLAC__METADATA_TYPE_STREAMINFO);
   mFile->set_metadata_respond(FLAC__METADATA_TYPE_VORBIS_COMMENT);
   FLAC::Decoder::File::State state = mFile->init();
   if (state != FLAC__FILE_DECODER_OK) {
      return false;
   }
#else
   if (!mHandle.Open(mFilename, 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;
   }
#endif
   mFile->process_until_end_of_metadata();
 
#ifdef LEGACY_FLAC
   state = mFile->get_state();
   if (state != FLAC__FILE_DECODER_OK) {
      return false;
   }
#else
   // 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;
   }
#endif
 
   if (!mFile->is_valid() || mFile->get_was_error()) {
      // This probably is not a FLAC file at all
      return false;
   }
   return true;
}

References mFile, ImportFileHandle::mFilename, mHandle, OSINPUT, and wxT().

Here is the call graph for this function:

SetStreamUsage()

void FLACImportFileHandle::SetStreamUsage ( wxInt32   WXUNUSEDStreamID, bool   WXUNUSEDUse  )

inlineoverride

Definition at line 155 of file ImportFLAC.cpp.

   {}

Friends And Related Function Documentation

MyFLACFile

friend class MyFLACFile

friend

Definition at line 135 of file ImportFLAC.cpp.

Member Data Documentation

mBitsPerSample

unsigned long FLACImportFileHandle::mBitsPerSample

private

Definition at line 164 of file ImportFLAC.cpp.

Referenced by MyFLACFile::metadata_callback().

mChannels

NewChannelGroup FLACImportFileHandle::mChannels

private

Definition at line 169 of file ImportFLAC.cpp.

Referenced by Import(), and MyFLACFile::write_callback().

mFile

std::unique_ptr<MyFLACFile> FLACImportFileHandle::mFile

private

Definition at line 160 of file ImportFLAC.cpp.

Referenced by FLACImportFileHandle(), Import(), Init(), and ~FLACImportFileHandle().

mFormat

sampleFormat FLACImportFileHandle::mFormat

private

Definition at line 159 of file ImportFLAC.cpp.

Referenced by FLACImportFileHandle(), Import(), and MyFLACFile::metadata_callback().

mHandle

wxFFile FLACImportFileHandle::mHandle

private

Definition at line 161 of file ImportFLAC.cpp.

Referenced by Init().

mNumChannels

unsigned long FLACImportFileHandle::mNumChannels

private

Definition at line 163 of file ImportFLAC.cpp.

Referenced by Import(), MyFLACFile::metadata_callback(), and MyFLACFile::write_callback().

mNumSamples

FLAC__uint64 FLACImportFileHandle::mNumSamples

private

Definition at line 165 of file ImportFLAC.cpp.

Referenced by MyFLACFile::metadata_callback().

mSampleRate

unsigned long FLACImportFileHandle::mSampleRate

private

Definition at line 162 of file ImportFLAC.cpp.

Referenced by Import(), and MyFLACFile::metadata_callback().

mSamplesDone

FLAC__uint64 FLACImportFileHandle::mSamplesDone

private

Definition at line 166 of file ImportFLAC.cpp.

mStreamInfoDone

bool FLACImportFileHandle::mStreamInfoDone

private

Definition at line 167 of file ImportFLAC.cpp.

Referenced by Import(), and MyFLACFile::metadata_callback().

mUpdateResult

ProgressResult FLACImportFileHandle::mUpdateResult

private

Definition at line 168 of file ImportFLAC.cpp.

Referenced by Import().

---

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

• ImportFLAC.cpp