Audacity 3.2.0
Public Member Functions | Public Attributes | List of all members
anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle Struct Referencefinal
Inheritance diagram for anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle:
[legend]
Collaboration diagram for anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle:
[legend]

Public Member Functions

 MIDIImportFileHandle (const FilePath &fileName)
 
 ~MIDIImportFileHandle () override
 
FilePath GetFilename () const override
 
TranslatableString GetFileDescription () override
 
ByteCount GetFileUncompressedBytes () override
 
wxInt32 GetStreamCount () override
 
const TranslatableStringsGetStreamInfo () override
 
void Import (ImportProgressListener &progressListener, WaveTrackFactory *trackFactory, TrackHolders &outTracks, Tags *tags, std::optional< LibFileFormats::AcidizerTags > &outAcidTags) override
 
void Cancel () override
 
void Stop () override
 
void SetStreamUsage (wxInt32, bool) 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 TranslatableStringsGetStreamInfo ()=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
 

Public Attributes

FilePath mFileName
 

Additional Inherited Members

- Public Types inherited from ImportFileHandle
using ByteCount = unsigned long long
 

Detailed Description

Definition at line 181 of file ImportMIDI.cpp.

Constructor & Destructor Documentation

◆ MIDIImportFileHandle()

anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle::MIDIImportFileHandle ( const FilePath fileName)
inlineexplicit

Definition at line 184 of file ImportMIDI.cpp.

◆ ~MIDIImportFileHandle()

anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle::~MIDIImportFileHandle ( )
inlineoverride

Definition at line 188 of file ImportMIDI.cpp.

188{}

Member Function Documentation

◆ Cancel()

void anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle::Cancel ( )
inlineoverridevirtual

Implements ImportFileHandle.

Definition at line 213 of file ImportMIDI.cpp.

213{}

◆ GetFileDescription()

TranslatableString anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle::GetFileDescription ( )
inlineoverridevirtual

Implements ImportFileHandle.

Definition at line 192 of file ImportMIDI.cpp.

192{ return DESC; }

References anonymous_namespace{ImportMIDI.cpp}::DESC.

◆ GetFilename()

FilePath anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle::GetFilename ( ) const
inlineoverridevirtual

Implements ImportFileHandle.

Definition at line 190 of file ImportMIDI.cpp.

190{ return mFileName; }

◆ GetFileUncompressedBytes()

ByteCount anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle::GetFileUncompressedBytes ( )
inlineoverridevirtual

Implements ImportFileHandle.

Definition at line 194 of file ImportMIDI.cpp.

195 {
196 // TODO: Get Uncompressed byte count.
197 return 0;
198 }

◆ GetStreamCount()

wxInt32 anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle::GetStreamCount ( )
inlineoverridevirtual

Implements ImportFileHandle.

Definition at line 200 of file ImportMIDI.cpp.

200{ return 1; }

◆ GetStreamInfo()

const TranslatableStrings & anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle::GetStreamInfo ( )
inlineoverridevirtual

Implements ImportFileHandle.

Definition at line 202 of file ImportMIDI.cpp.

203 {
204 static TranslatableStrings empty;
205 return empty;
206 }
std::vector< TranslatableString > TranslatableStrings

◆ Import()

void anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle::Import ( ImportProgressListener progressListener,
WaveTrackFactory trackFactory,
TrackHolders outTracks,
Tags tags,
std::optional< LibFileFormats::AcidizerTags > &  outAcidTags 
)
overridevirtual

Implements ImportFileHandle.

Definition at line 221 of file ImportMIDI.cpp.

224{
225 auto newTrack = std::make_shared<NoteTrack>();
226 if (::ImportMIDI(mFileName, newTrack.get())) {
227 outTracks.push_back(newTrack);
228 progressListener.OnImportResult(
230 }
231 else
232 progressListener.OnImportResult(
234}
virtual void OnImportResult(ImportResult result)=0
Used to report on import result for file handle passed as argument to OnImportFileOpened.
bool ImportMIDI(const FilePath &fName, NoteTrack *dest)
Definition: ImportMIDI.cpp:85

References ImportProgressListener::Error, anonymous_namespace{ImportMIDI.cpp}::ImportMIDI(), ImportProgressListener::OnImportResult(), and ImportProgressListener::Success.

Here is the call graph for this function:

◆ SetStreamUsage()

void anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle::SetStreamUsage ( wxInt32  ,
bool   
)
inlineoverridevirtual

Implements ImportFileHandle.

Definition at line 216 of file ImportMIDI.cpp.

216{}

◆ Stop()

void anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle::Stop ( )
inlineoverridevirtual

Implements ImportFileHandle.

Definition at line 214 of file ImportMIDI.cpp.

214{}

Member Data Documentation

◆ mFileName

FilePath anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle::mFileName

Definition at line 218 of file ImportMIDI.cpp.


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