Audacity  2.2.0
ImportFileHandle Class Referenceabstract

An ImportFileHandle for data. More...

#include <ImportPlugin.h>

Inheritance diagram for ImportFileHandle:
LOFImportFileHandle PCMImportFileHandle

Public Types

using ByteCount = unsigned long long
 

Public Member Functions

 ImportFileHandle (const wxString &filename)
 
virtual ~ImportFileHandle ()
 
void CreateProgress ()
 
virtual wxString GetFileDescription ()=0
 
virtual ByteCount GetFileUncompressedBytes ()=0
 
virtual ProgressResult Import (TrackFactory *trackFactory, TrackHolders &outTracks, Tags *tags)=0
 
virtual wxInt32 GetStreamCount ()=0
 
virtual const wxArrayString & GetStreamInfo ()=0
 
virtual void SetStreamUsage (wxInt32 StreamID, bool Use)=0
 

Protected Attributes

wxString mFilename
 
Maybe< ProgressDialogmProgress
 

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.

Member Typedef Documentation

using ImportFileHandle::ByteCount = unsigned long long

Constructor & Destructor Documentation

ImportFileHandle::ImportFileHandle ( const wxString &  filename)
inline
virtual ImportFileHandle::~ImportFileHandle ( )
inlinevirtual

Member Function Documentation

void ImportFileHandle::CreateProgress ( )
inline
virtual wxString ImportFileHandle::GetFileDescription ( )
pure virtual

Implemented in LOFImportFileHandle, and PCMImportFileHandle.

Referenced by CreateProgress().

virtual ByteCount ImportFileHandle::GetFileUncompressedBytes ( )
pure virtual
virtual wxInt32 ImportFileHandle::GetStreamCount ( )
pure virtual
virtual const wxArrayString& ImportFileHandle::GetStreamInfo ( )
pure virtual
virtual ProgressResult ImportFileHandle::Import ( TrackFactory trackFactory,
TrackHolders outTracks,
Tags tags 
)
pure virtual
virtual void ImportFileHandle::SetStreamUsage ( wxInt32  StreamID,
bool  Use 
)
pure virtual

Member Data Documentation

wxString ImportFileHandle::mFilename
protected
Maybe<ProgressDialog> ImportFileHandle::mProgress
protected

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