ImportFileHandle Class Reference

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

#include <ImportPlugin.h>

Inheritance diagram for ImportFileHandle:

Public Types
using	ByteCount = unsigned long long

Public Member Functions
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)=0
virtual void	Cancel ()=0
virtual void	Stop ()=0

Detailed Description

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

An ImportFileHandle for data.

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 110 of file ImportPlugin.h.

Member Typedef Documentation

ByteCount

using ImportFileHandle::ByteCount = unsigned long long

Definition at line 114 of file ImportPlugin.h.

Constructor & Destructor Documentation

~ImportFileHandle()

ImportFileHandle::~ImportFileHandle ( )

virtualdefault

Member Function Documentation

Cancel()

virtual void ImportFileHandle::Cancel ( )

pure virtual

Implemented in ImportFileHandleEx, FFmpegImportFileHandle, LOFImportFileHandle, and anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle.

GetErrorMessage()

TranslatableString ImportFileHandle::GetErrorMessage ( ) const

virtual

Reimplemented in AUPImportFileHandle.

Definition at line 79 of file ImportPlugin.cpp.

{
   return {};
}

GetFileDescription()

virtual TranslatableString ImportFileHandle::GetFileDescription ( )

pure virtual

Implemented in AUPImportFileHandle, FFmpegImportFileHandle, FLACImportFileHandle, LOFImportFileHandle, anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle, anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle, OggImportFileHandle, OpusImportFileHandle, PCMImportFileHandle, and WavPackImportFileHandle.

GetFilename()

virtual FilePath ImportFileHandle::GetFilename ( ) const

pure virtual

Implemented in ImportFileHandleEx, FFmpegImportFileHandle, LOFImportFileHandle, and anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle.

GetFileUncompressedBytes()

virtual ByteCount ImportFileHandle::GetFileUncompressedBytes ( )

pure virtual

Implemented in AUPImportFileHandle, FFmpegImportFileHandle, FLACImportFileHandle, LOFImportFileHandle, anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle, anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle, OggImportFileHandle, OpusImportFileHandle, PCMImportFileHandle, and WavPackImportFileHandle.

GetStreamCount()

virtual wxInt32 ImportFileHandle::GetStreamCount ( )

pure virtual

Implemented in AUPImportFileHandle, FFmpegImportFileHandle, FLACImportFileHandle, LOFImportFileHandle, anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle, anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle, OggImportFileHandle, OpusImportFileHandle, PCMImportFileHandle, and WavPackImportFileHandle.

Referenced by anonymous_namespace{ProjectFileManager.cpp}::ImportProgress::OnImportFileOpened().

Here is the caller graph for this function:

GetStreamInfo()

virtual const TranslatableStrings & ImportFileHandle::GetStreamInfo ( )

pure virtual

Implemented in AUPImportFileHandle, FFmpegImportFileHandle, FLACImportFileHandle, LOFImportFileHandle, anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle, anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle, OggImportFileHandle, OpusImportFileHandle, PCMImportFileHandle, and WavPackImportFileHandle.

Import()

virtual void ImportFileHandle::Import ( ImportProgressListener &  progressListener, WaveTrackFactory *  trackFactory, TrackHolders &  outTracks, Tags *  tags  )

pure virtual

Implemented in AUPImportFileHandle, FFmpegImportFileHandle, FLACImportFileHandle, LOFImportFileHandle, anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle, anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle, OggImportFileHandle, OpusImportFileHandle, PCMImportFileHandle, and WavPackImportFileHandle.

SetStreamUsage()

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

pure virtual

Implemented in FFmpegImportFileHandle, anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle, OggImportFileHandle, OpusImportFileHandle, WavPackImportFileHandle, and anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle.

Referenced by anonymous_namespace{ProjectFileManager.cpp}::ImportProgress::OnImportFileOpened(), and ImportStreamDialog::OnOk().

Here is the caller graph for this function:

Stop()

virtual void ImportFileHandle::Stop ( )

pure virtual

Implemented in ImportFileHandleEx, FFmpegImportFileHandle, LOFImportFileHandle, and anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle.

---

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

• ImportPlugin.h
• ImportPlugin.cpp