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

void	Import (ImportProgressListener &progressListener, WaveTrackFactory trackFactory, TrackHolders &outTracks, Tags tags, std::optional< LibFileFormats::AcidizerTags > &outAcidTags) override

wxInt32	GetStreamCount () override

const TranslatableStrings &	GetStreamInfo () override

void	SetStreamUsage (wxInt32 WXUNUSED(StreamID), bool WXUNUSED(Use)) override

Public Member Functions inherited from ImportFileHandleEx
	ImportFileHandleEx (const FilePath &filename)

FilePath	GetFilename () const override

void	Cancel () override

void	Stop () override

Public Member Functions inherited from ImportFileHandle
virtual	~ImportFileHandle ()

virtual FilePath	GetFilename () const =0

virtual TranslatableString	GetErrorMessage () const

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 void	Import (ImportProgressListener &progressListener, WaveTrackFactory trackFactory, TrackHolders &outTracks, Tags tags, std::optional< LibFileFormats::AcidizerTags > &acidTags)=0

virtual void	Cancel ()=0

virtual void	Stop ()=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

WaveTrack::Holder	mTrack

Friends
class	MyFLACFile

Additional Inherited Members
Public Types inherited from ImportFileHandle
using	ByteCount = unsigned long long

Protected Member Functions inherited from ImportFileHandleEx
void	BeginImport ()

bool	IsCancelled () const noexcept

bool	IsStopped () const noexcept

Detailed Description

An ImportFileHandle for FLAC data.

Definition at line 115 of file ImportFLAC.cpp.

Constructor & Destructor Documentation

◆ FLACImportFileHandle()

FLACImportFileHandle::FLACImportFileHandle ( const FilePath & name )

Definition at line 321 of file ImportFLAC.cpp.

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

References mFile, mFormat, and narrowestSampleFormat.

◆ ~FLACImportFileHandle()

FLACImportFileHandle::~FLACImportFileHandle ( )

Definition at line 468 of file ImportFLAC.cpp.

{
   mFile->finish();
}

References mFile.

Member Function Documentation

◆ GetFileDescription()

TranslatableString FLACImportFileHandle::GetFileDescription ( )

overridevirtual

Implements ImportFileHandle.

Definition at line 383 of file ImportFLAC.cpp.

{
   return DESC;
}

References DESC.

◆ GetFileUncompressedBytes()

auto FLACImportFileHandle::GetFileUncompressedBytes ( )

overridevirtual

Implements ImportFileHandle.

Definition at line 389 of file ImportFLAC.cpp.

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

◆ GetStreamCount()

wxInt32 FLACImportFileHandle::GetStreamCount ( )

inlineoverridevirtual

Implements ImportFileHandle.

Definition at line 131 of file ImportFLAC.cpp.

131{ return 1; }

◆ GetStreamInfo()

const TranslatableStrings & FLACImportFileHandle::GetStreamInfo ( )

inlineoverridevirtual

Implements ImportFileHandle.

Definition at line 133 of file ImportFLAC.cpp.

   {
      static TranslatableStrings empty;
      return empty;
   }

◆ Import()

void FLACImportFileHandle::Import	(	ImportProgressListener &	progressListener,
		WaveTrackFactory *	trackFactory,
		TrackHolders &	outTracks,
		Tags *	tags,
		std::optional< LibFileFormats::AcidizerTags > &	outAcidTags
	)

overridevirtual

Implements ImportFileHandle.

Definition at line 395 of file ImportFLAC.cpp.

{
   BeginImport();
 
   outTracks.clear();
 
   auto cleanup = finally([&]{ mFile->mImportProgressListener = nullptr; });
 
   wxASSERT(mStreamInfoDone);
 
   mTrack = ImportUtils::NewWaveTrack(*trackFactory, mNumChannels, mFormat, mSampleRate);
 
   mFile->mImportProgressListener = &progressListener;
 
   // 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
 
   if(IsCancelled())
   {
      progressListener.OnImportResult(ImportProgressListener::ImportResult::Cancelled);
      return;
   }
 
   ImportUtils::FinalizeImport(outTracks, *mTrack);
 
   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);
      }
   }
 
   progressListener.OnImportResult(IsStopped()
                                   ? ImportProgressListener::ImportResult::Stopped
                                   : ImportProgressListener::ImportResult::Success);
}

References ImportFileHandleEx::BeginImport(), ImportProgressListener::Cancelled, Tags::Clear(), ImportUtils::FinalizeImport(), Tags::HasTag(), ImportFileHandleEx::IsCancelled(), ImportFileHandleEx::IsStopped(), mFile, mFormat, mNumChannels, mSampleRate, mStreamInfoDone, mTrack, name, ImportUtils::NewWaveTrack(), ImportProgressListener::OnImportResult(), Tags::SetTag(), ImportProgressListener::Stopped, ImportProgressListener::Success, TAG_COMMENTS, TAG_YEAR, and wxT().

Here is the call graph for this function:

◆ Init()

bool FLACImportFileHandle::Init ( )

Definition at line 331 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(GetFilename(), 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 ImportFileHandleEx::GetFilename(), mFile, ImportFileHandleEx::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 139 of file ImportFLAC.cpp.

140 {}

Friends And Related Function Documentation

◆ MyFLACFile

friend class MyFLACFile

friend

Definition at line 117 of file ImportFLAC.cpp.

Member Data Documentation

◆ mBitsPerSample

unsigned long FLACImportFileHandle::mBitsPerSample

private

Definition at line 148 of file ImportFLAC.cpp.

Referenced by MyFLACFile::metadata_callback().

◆ mFile

std::unique_ptr<MyFLACFile> FLACImportFileHandle::mFile

private

Definition at line 144 of file ImportFLAC.cpp.

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

◆ mFormat

sampleFormat FLACImportFileHandle::mFormat

private

Definition at line 143 of file ImportFLAC.cpp.

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

◆ mHandle

wxFFile FLACImportFileHandle::mHandle

private

Definition at line 145 of file ImportFLAC.cpp.

Referenced by Init().

◆ mNumChannels

unsigned long FLACImportFileHandle::mNumChannels

private

Definition at line 147 of file ImportFLAC.cpp.

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

◆ mNumSamples

FLAC__uint64 FLACImportFileHandle::mNumSamples

private

Definition at line 149 of file ImportFLAC.cpp.

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

◆ mSampleRate

unsigned long FLACImportFileHandle::mSampleRate

private

Definition at line 146 of file ImportFLAC.cpp.

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

◆ mSamplesDone

FLAC__uint64 FLACImportFileHandle::mSamplesDone

private

Definition at line 150 of file ImportFLAC.cpp.

Referenced by MyFLACFile::write_callback().

◆ mStreamInfoDone

bool FLACImportFileHandle::mStreamInfoDone

private

Definition at line 151 of file ImportFLAC.cpp.

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

◆ mTrack

WaveTrack::Holder FLACImportFileHandle::mTrack

private

Definition at line 152 of file ImportFLAC.cpp.

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

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

ImportFLAC.cpp

Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FLACImportFileHandle()

◆ ~FLACImportFileHandle()

Member Function Documentation

◆ GetFileDescription()

◆ GetFileUncompressedBytes()

◆ GetStreamCount()

◆ GetStreamInfo()

◆ Import()

◆ Init()

◆ SetStreamUsage()

Friends And Related Function Documentation

◆ MyFLACFile

Member Data Documentation

◆ mBitsPerSample

◆ mFile

◆ mFormat

◆ mHandle

◆ mNumChannels

◆ mNumSamples

◆ mSampleRate

◆ mSamplesDone

◆ mStreamInfoDone

◆ mTrack