ExportPlugin.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  ExportPlugin.h
 
  Dominic Mazzoni
 
**********************************************************************/
#pragma once
 
#include <memory>
 
#include <rapidjson/fwd.h>
 
#include <wx/string.h>
 
#include "ExportOptionsEditor.h"
#include "wxArrayStringEx.h"
#include "Identifier.h"
#include "TranslatableString.h"
#include "wxFileNameWrapper.h"
 
class wxFileName;
class wxString;
 
class AudacityProject;
class Tags;
 
namespace MixerOptions{ class Downmix; }
 
 
struct IMPORT_EXPORT_API FormatInfo final
{
   wxString format;
   TranslatableString description;
   FileExtensions extensions;
   unsigned maxChannels;
   bool canMetaData;
};
 
 
class IMPORT_EXPORT_API ExportException
{
   const wxString mMessage;
public:
   
   ExportException(const wxString& msg);
 
   const wxString& What() const noexcept;
};
 
class IMPORT_EXPORT_API ExportErrorException
{
   TranslatableString mMessage;
   wxString mHelpPageId;
public:
   ExportErrorException(const wxString& errorCode);
   //
   ExportErrorException(TranslatableString message, const wxString& helpPage);
 
   const TranslatableString& GetMessage() const noexcept;
   const wxString& GetHelpPageId() const noexcept;
 
};
 
class IMPORT_EXPORT_API ExportDiskFullError
{
   wxFileNameWrapper mFileName;
public:
   ExportDiskFullError(const wxFileNameWrapper& fileName);
 
   const wxFileNameWrapper& GetFileName() const noexcept;
};
 
class IMPORT_EXPORT_API ExportProcessorDelegate
{
public:
   virtual ~ExportProcessorDelegate();
 
   virtual bool IsCancelled() const = 0;
   virtual bool IsStopped() const = 0;
   virtual void SetStatusString(const TranslatableString& str) = 0;
   virtual void OnProgress(double progress) = 0;
};
 
class IMPORT_EXPORT_API ExportProcessor
{
public:
   using Parameters = std::vector<std::tuple<ExportOptionID, ExportValue>>;
 
   ExportProcessor(const ExportProcessor&) = delete;
   ExportProcessor& operator=(const ExportProcessor&) = delete;
 
   ExportProcessor() = default;
   virtual ~ExportProcessor();
 
   virtual bool Initialize(AudacityProject& project,
      const Parameters& parameters,
      const wxFileNameWrapper& filename,
      double t0, double t1, bool selectedOnly,
      double rate, unsigned channels,
      MixerOptions::Downmix* mixerSpec = nullptr,
      const Tags* tags = nullptr) = 0;
   
   virtual ExportResult Process(ExportProcessorDelegate& delegate) = 0;
};
 
//----------------------------------------------------------------------------
// ExportPlugin
//----------------------------------------------------------------------------
class IMPORT_EXPORT_API ExportPlugin /* not final */
{
public:
   
   ExportPlugin();
   virtual ~ExportPlugin();
 
   virtual int GetFormatCount() const = 0;
   virtual FormatInfo GetFormatInfo(int index) const = 0;
   
   virtual std::unique_ptr<ExportOptionsEditor>
   CreateOptionsEditor(int formatIndex, ExportOptionsEditor::Listener* listener) const = 0;
 
   virtual std::vector<std::string> GetMimeTypes(int formatIndex) const;
 
   virtual bool ParseConfig(int formatIndex, const rapidjson::Value& config, ExportProcessor::Parameters& parameters) const;
 
   virtual bool CheckFileName(wxFileName &filename, int format = 0) const;
 
   virtual std::unique_ptr<ExportProcessor> CreateProcessor(int format) const = 0;
};