ImportFileHandle Class Reference

An ImportFileHandle for data. More...

#include <ImportPlugin.h>

Inheritance diagram for ImportFileHandle:

Collaboration diagram for ImportFileHandle:

Public Types
using	ProgressResult = BasicUI::ProgressResult
using	ByteCount = unsigned long long

Public Member Functions
	ImportFileHandle (const FilePath &filename)
virtual	~ImportFileHandle ()
void	CreateProgress ()
virtual TranslatableString	GetFileDescription ()=0
virtual ByteCount	GetFileUncompressedBytes ()=0
virtual ProgressResult	Import (WaveTrackFactory *trackFactory, TrackHolders &outTracks, Tags *tags)=0
virtual wxInt32	GetStreamCount ()=0
virtual const TranslatableStrings &	GetStreamInfo ()=0
virtual void	SetStreamUsage (wxInt32 StreamID, bool Use)=0
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...

Static Public Member Functions
static sampleFormat	ChooseFormat (sampleFormat effectiveFormat)
	Choose appropriate format, which will not be narrower than the specified one. More...

Protected Attributes
FilePath	mFilename
std::unique_ptr< ProgressDialog >	mProgress

Detailed Description

An ImportFileHandle for data.

Base class for FlacImportFileHandle, LOFImportFileHandle, MP3ImportFileHandle, OggImportFileHandle and PCMImportFileHandle. Gives API for sound file import.

The Ogg format supports multiple logical bitstreams that can be chained within the physical bitstream. The sampling rate and number of channels can vary between these logical bitstreams. For the moment, we'll ignore all but the first logical bitstream.

Ogg also allows for an arbitrary number of channels. Luckily, so does Audacity. We'll call the first channel LeftChannel, the second RightChannel, and all others after it MonoChannel.

Definition at line 106 of file ImportPlugin.h.

Member Typedef Documentation

ByteCount

using ImportFileHandle::ByteCount = unsigned long long

Definition at line 127 of file ImportPlugin.h.

ProgressResult

using ImportFileHandle::ProgressResult = BasicUI::ProgressResult

Definition at line 109 of file ImportPlugin.h.

Constructor & Destructor Documentation

ImportFileHandle()

ImportFileHandle::ImportFileHandle

(

const FilePath &

filename

)

Definition at line 36 of file ImportPlugin.cpp.

:  mFilename(filename)
{
}

~ImportFileHandle()

ImportFileHandle::~ImportFileHandle ( )

virtual

Definition at line 41 of file ImportPlugin.cpp.

{
}

Member Function Documentation

ChooseFormat()

sampleFormat ImportFileHandle::ChooseFormat ( sampleFormat  effectiveFormat )

static

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

Definition at line 54 of file ImportPlugin.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, format, int16Sample, and QualitySettings::SampleFormatChoice().

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

Here is the call graph for this function:

Here is the caller graph for this function:

CreateProgress()

void ImportFileHandle::CreateProgress

(

)

Definition at line 45 of file ImportPlugin.cpp.

{
   wxFileName ff( mFilename );
 
   auto title = XO("Importing %s").Format( GetFileDescription() );
   mProgress = std::make_unique< ProgressDialog >(
      title, Verbatim( ff.GetFullName() ) );
}

References GetFileDescription(), mFilename, mProgress, title, Verbatim(), and XO.

Referenced by GStreamerImportFileHandle::Import(), AUPImportFileHandle::Import(), FFmpegImportFileHandle::Import(), FLACImportFileHandle::Import(), MP3ImportFileHandle::Import(), OggImportFileHandle::Import(), and PCMImportFileHandle::Import().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFileDescription()

virtual TranslatableString ImportFileHandle::GetFileDescription ( )

pure virtual

Implemented in PCMImportFileHandle, OggImportFileHandle, MP3ImportFileHandle, LOFImportFileHandle, GStreamerImportFileHandle, FLACImportFileHandle, FFmpegImportFileHandle, and AUPImportFileHandle.

Referenced by CreateProgress().

Here is the caller graph for this function:

GetFileUncompressedBytes()

virtual ByteCount ImportFileHandle::GetFileUncompressedBytes ( )

pure virtual

Implemented in PCMImportFileHandle, OggImportFileHandle, MP3ImportFileHandle, LOFImportFileHandle, GStreamerImportFileHandle, FLACImportFileHandle, FFmpegImportFileHandle, and AUPImportFileHandle.

GetStreamCount()

virtual wxInt32 ImportFileHandle::GetStreamCount ( )

pure virtual

Implemented in PCMImportFileHandle, OggImportFileHandle, MP3ImportFileHandle, LOFImportFileHandle, GStreamerImportFileHandle, FLACImportFileHandle, FFmpegImportFileHandle, and AUPImportFileHandle.

GetStreamInfo()

virtual const TranslatableStrings& ImportFileHandle::GetStreamInfo ( )

pure virtual

Implemented in PCMImportFileHandle, OggImportFileHandle, MP3ImportFileHandle, LOFImportFileHandle, GStreamerImportFileHandle, FLACImportFileHandle, FFmpegImportFileHandle, and AUPImportFileHandle.

Import()

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

pure virtual

Implemented in PCMImportFileHandle, OggImportFileHandle, MP3ImportFileHandle, LOFImportFileHandle, FLACImportFileHandle, FFmpegImportFileHandle, and AUPImportFileHandle.

NewWaveTrack()

std::shared_ptr< WaveTrack > ImportFileHandle::NewWaveTrack	(	WaveTrackFactory &	trackFactory,
		sampleFormat	effectiveFormat,
		double	rate
	)

Build a wave track with appropriate format, which will not be narrower than the specified one.

Definition at line 69 of file ImportPlugin.cpp.

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

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

Referenced by FFmpegImportFileHandle::Import(), FLACImportFileHandle::Import(), OggImportFileHandle::Import(), and PCMImportFileHandle::Import().

Here is the call graph for this function:

Here is the caller graph for this function:

SetStreamUsage()

virtual void ImportFileHandle::SetStreamUsage ( wxInt32  StreamID, bool  Use  )

pure virtual

Implemented in OggImportFileHandle, MP3ImportFileHandle, FFmpegImportFileHandle, and GStreamerImportFileHandle.

Member Data Documentation

mFilename

FilePath ImportFileHandle::mFilename

protected

Definition at line 158 of file ImportPlugin.h.

Referenced by CreateProgress(), AUPImportFileHandle::HandleImport(), AUPImportFileHandle::HandleProject(), AUPImportFileHandle::Import(), OggImportFileHandle::Import(), PCMImportFileHandle::Import(), FLACImportFileHandle::Init(), GStreamerImportFileHandle::Init(), AUPImportFileHandle::Open(), and MP3ImportFileHandle::Open().

mProgress

std::unique_ptr<ProgressDialog> ImportFileHandle::mProgress

protected

Definition at line 159 of file ImportPlugin.h.

Referenced by CreateProgress(), GStreamerImportFileHandle::Import(), AUPImportFileHandle::Import(), OggImportFileHandle::Import(), PCMImportFileHandle::Import(), MP3ImportFileHandle::InputCB(), and FFmpegImportFileHandle::WriteData().

---

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

• ImportPlugin.h
• ImportPlugin.cpp