ImportUtils Class Reference

#include <ImportUtils.h>

Static Public Member Functions
static sampleFormat	ChooseFormat (sampleFormat effectiveFormat)
	Choose appropriate format, which will not be narrower than the specified one. More...
static std::shared_ptr< WaveTrack >	NewWaveTrack (WaveTrackFactory &trackFactory, unsigned nChannels, sampleFormat effectiveFormat, double rate)
static void	ShowMessageBox (const TranslatableString &message, const TranslatableString &caption=XO("Import Project"))
static void	ForEachChannel (TrackList &trackList, const std::function< void(WaveChannel &)> &op)
	Iterates over channels in each wave track from the list. More...
static void	ForEachChannel (WaveTrack &track, const std::function< void(WaveChannel &)> &op)
	Iterates over channels in one wave track. More...
static void	FinalizeImport (TrackHolders &outTracks, const std::vector< std::shared_ptr< WaveTrack > > &importedStreams)
	Flushes the given channels and moves them to outTracks. More...
static void	FinalizeImport (TrackHolders &outTracks, TrackList &&trackList)
static void	FinalizeImport (TrackHolders &outTracks, WaveTrack &track)
	Flushes the given channels and moves them to outTracks. More...

Detailed Description

Definition at line 30 of file ImportUtils.h.

Member Function Documentation

ChooseFormat()

sampleFormat ImportUtils::ChooseFormat ( sampleFormat  effectiveFormat )

static

Choose appropriate format, which will not be narrower than the specified one.

Definition at line 19 of file ImportUtils.cpp.

{
   // Consult user preference
   auto defaultFormat = QualitySettings::SampleFormatChoice();
 
   // Don't choose format narrower than effective or default
   auto format = std::max(effectiveFormat, defaultFormat);
 
   // But also always promote 24 bits to float
   if (format > int16Sample)
      format = floatSample;
 
   return format;
}

References floatSample, anonymous_namespace{ExportPCM.cpp}::format, int16Sample, and QualitySettings::SampleFormatChoice().

Referenced by FFmpegImportFileHandle::Import(), PCMImportFileHandle::Import(), ImportRaw(), NewWaveTrack(), and PCMImportFileHandle::PCMImportFileHandle().

Here is the call graph for this function:

Here is the caller graph for this function:

FinalizeImport() [1/3]

void ImportUtils::FinalizeImport ( TrackHolders &  outTracks, const std::vector< std::shared_ptr< WaveTrack > > &  importedStreams  )

static

Flushes the given channels and moves them to outTracks.

Definition at line 49 of file ImportUtils.cpp.

{
   for(auto& stream : importedStreams)
      FinalizeImport(outTracks, *stream);
}

References FinalizeImport().

Referenced by FinalizeImport(), FFmpegImportFileHandle::Import(), FLACImportFileHandle::Import(), anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle::Import(), OggImportFileHandle::Import(), OpusImportFileHandle::Import(), PCMImportFileHandle::Import(), and WavPackImportFileHandle::Import().

Here is the call graph for this function:

Here is the caller graph for this function:

FinalizeImport() [2/3]

void ImportUtils::FinalizeImport ( TrackHolders &  outTracks, TrackList &&  trackList  )

static

Flushes the given channels and moves them to outTracks trackList is emptied

Definition at line 55 of file ImportUtils.cpp.

{
   if(trackList.empty())
      return;
 
   for(const auto track : trackList.Any<WaveTrack>())
      track->Flush();
   
   while (!trackList.empty())
      outTracks.push_back(trackList.DetachFirst());
}

FinalizeImport() [3/3]

void ImportUtils::FinalizeImport ( TrackHolders &  outTracks, WaveTrack &  track  )

static

Flushes the given channels and moves them to outTracks.

Definition at line 67 of file ImportUtils.cpp.

{
   track.Flush();
   outTracks.push_back(track.shared_from_this());
}

References WaveTrack::Flush().

Here is the call graph for this function:

ForEachChannel() [1/2]

void ImportUtils::ForEachChannel ( TrackList &  trackList, const std::function< void(WaveChannel &)> &  op  )

static

Iterates over channels in each wave track from the list.

Definition at line 73 of file ImportUtils.cpp.

{
   for(auto track : trackList.Any<WaveTrack>())
   {
      for(auto channel : track->Channels())
      {
         op(*channel);
      }
   }
}

References TrackList::Any().

Referenced by anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle::Import(), OggImportFileHandle::Import(), OpusImportFileHandle::Import(), PCMImportFileHandle::Import(), WavPackImportFileHandle::Import(), ImportRaw(), MyFLACFile::write_callback(), and FFmpegImportFileHandle::WriteData().

Here is the call graph for this function:

Here is the caller graph for this function:

ForEachChannel() [2/2]

void ImportUtils::ForEachChannel ( WaveTrack &  track, const std::function< void(WaveChannel &)> &  op  )

static

Iterates over channels in one wave track.

Definition at line 84 of file ImportUtils.cpp.

{
   for(auto channel : track.Channels())
   {
      op(*channel);
   }
}

References WaveTrack::Channels().

Here is the call graph for this function:

NewWaveTrack()

WaveTrack::Holder ImportUtils::NewWaveTrack ( WaveTrackFactory &  trackFactory, unsigned  nChannels, sampleFormat  effectiveFormat, double  rate  )

static

Builds a wave track The format will not be narrower than the specified one.

Definition at line 35 of file ImportUtils.cpp.

{
   return trackFactory.Create(nChannels, ChooseFormat(effectiveFormat), rate);
}

References ChooseFormat(), and WaveTrackFactory::Create().

Referenced by FLACImportFileHandle::Import(), OpusImportFileHandle::Import(), and anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle::SetupOutputFormat().

Here is the call graph for this function:

Here is the caller graph for this function:

ShowMessageBox()

void ImportUtils::ShowMessageBox ( const TranslatableString &  message, const TranslatableString &  caption = XO("Import Project")  )

static

Definition at line 43 of file ImportUtils.cpp.

{
   BasicUI::ShowMessageBox(message,
                           BasicUI::MessageBoxOptions().Caption(caption));
}

References BasicUI::ShowMessageBox().

Referenced by AUPImportFileHandle::HandleNoteTrack(), AUPImportFileHandle::HandleProject(), AUPImportFileHandle::HandleTimeTrack(), AUPImportFileHandle::Import(), WavPackImportFileHandle::Import(), LOFImportFileHandle::lofOpenFiles(), OpusImportFileHandle::NotifyImportFailed(), and AUPImportFileHandle::Open().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• ImportUtils.h
• ImportUtils.cpp