cloud::audiocom::ShareAudioDialog Class Reference

#include <ShareAudioDialog.h>

Inheritance diagram for cloud::audiocom::ShareAudioDialog:

Collaboration diagram for cloud::audiocom::ShareAudioDialog:

Classes
struct	ExportProgressHelper
struct	InitialStatePanel
struct	ProgressPanel
struct	Services

Public Member Functions
	ShareAudioDialog (AudacityProject &project, wxWindow *parent=nullptr)
	~ShareAudioDialog () override
Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()
	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
void	SetTitle (const TranslatableString &title)
void	SetLabel (const TranslatableString &title)
void	SetName (const TranslatableString &title)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Types
using	Clock = std::chrono::steady_clock

Private Member Functions
void	Populate (ShuttleGui &s)
void	OnCancel ()
void	OnContinue ()
void	OnClose ()
wxString	ExportProject ()
void	StartUploadProcess ()
void	HandleUploadSucceeded (std::string_view finishUploadURL, std::string_view audioSlug)
void	HandleUploadFailed (std::string_view errorMessage)
void	HandleExportFailure ()
void	ResetProgress ()
void	UpdateProgress (uint64_t current, uint64_t total)

Private Attributes
AudacityProject &	mProject
struct cloud::audiocom::ShareAudioDialog::InitialStatePanel	mInitialStatePanel
struct cloud::audiocom::ShareAudioDialog::ProgressPanel	mProgressPanel
wxButton *	mContinueButton { nullptr }
wxButton *	mCancelButton { nullptr }
wxButton *	mCloseButton { nullptr }
wxButton *	mGotoButton { nullptr }
std::unique_ptr< Services >	mServices
std::unique_ptr< BasicUI::ProgressDialog >	mExportProgressHelper
Clock::time_point	mStageStartTime
Clock::time_point	mLastUIUpdateTime
int	mLastProgressValue { 0 }
wxString	mFilePath
std::function< void()>	mContinueAction
bool	mInProgress { false }

Detailed Description

Definition at line 40 of file ShareAudioDialog.h.

Member Typedef Documentation

Clock

using cloud::audiocom::ShareAudioDialog::Clock = std::chrono::steady_clock

private

Definition at line 120 of file ShareAudioDialog.h.

Constructor & Destructor Documentation

ShareAudioDialog()

cloud::audiocom::ShareAudioDialog::ShareAudioDialog	(	AudacityProject &	project,
		wxWindow *	parent = nullptr
	)

Definition at line 173 of file ShareAudioDialog.cpp.

    : wxDialogWrapper(
         parent, wxID_ANY, XO("Share Audio"), wxDefaultPosition, { 480, 250 },
         wxDEFAULT_DIALOG_STYLE)
    , mProject(project)
    , mServices(std::make_unique<Services>())
{
   GetAuthorizationHandler().PushSuppressDialogs();
 
   ShuttleGui s(this, eIsCreating);
 
   s.StartVerticalLay();
   {
      Populate(s);
   }
   s.EndVerticalLay();
 
   Layout();
   Fit();
   Centre();
 
   const auto size = GetSize();
 
   SetMinSize({ size.x, std::min(250, size.y) });
   SetMaxSize({ size.x, -1 });
 
   mContinueAction = [this]()
   {
      if (mInitialStatePanel.root->IsShown())
         StartUploadProcess();
   };
 
   Bind(
      wxEVT_CHAR_HOOK,
      [this](auto& evt)
      {
         if (!IsEscapeKey(evt))
         {
            evt.Skip();
            return;
         }
 
         if (mCancelButton->IsShown())
            OnCancel();
         else
            OnClose();
      });
}

~ShareAudioDialog()

cloud::audiocom::ShareAudioDialog::~ShareAudioDialog ( )

override

Definition at line 222 of file ShareAudioDialog.cpp.

{
   GetAuthorizationHandler().PopSuppressDialogs();
   // Clean up the temp file when the dialog is closed
   if (!mFilePath.empty() && wxFileExists(mFilePath))
      wxRemoveFile(mFilePath);
}

References cloud::audiocom::GetAuthorizationHandler(), mFilePath, and cloud::audiocom::AuthorizationHandler::PopSuppressDialogs().

Here is the call graph for this function:

Member Function Documentation

ExportProject()

wxString cloud::audiocom::ShareAudioDialog::ExportProject ( )

private

Definition at line 310 of file ShareAudioDialog.cpp.

{
   mExportProgressHelper = std::make_unique<ExportProgressHelper>(*this);
 
   auto exporter = CreatePreferredExporter(GetServiceConfig().GetPreferredAudioFormats(), mProject);
 
   if (!exporter)
      return {};
 
   const auto path = GenerateTempPath(exporter->GetFileExtension());
 
   if (path.empty())
      return {};
   
 
   SettingScope scope;
   exporter->OnBeforeExport();
 
   auto cleanupExporter = finally([&]() { exporter->OnAfterExport(); });
 
   Exporter e { const_cast<AudacityProject&>(mProject) };
 
   auto& tracks = TrackList::Get(mProject);
 
   const double t0 = 0.0;
   const double t1 = tracks.GetEndTime();
 
   const int nChannels = (tracks.Any() - &Track::IsLeader).empty() ? 1 : 2;
 
   const bool success = e.Process(
      nChannels,                 // numChannels,
      exporter->GetExporterID(), // type,
      path,                      // full path,
      false,                     // selectedOnly,
      t0,                        // t0
      t1,                        // t1
      mExportProgressHelper      // progress dialog
   );
 
   if (!success && wxFileExists(path))
      // Try to remove the file if exporting has failed (or was canceled)
      wxRemoveFile(path);
 
   return success ? path : wxString {};
}

References cloud::CreatePreferredExporter(), cloud::audiocom::anonymous_namespace{ShareAudioDialog.cpp}::GenerateTempPath(), TrackList::Get(), cloud::audiocom::GetServiceConfig(), Track::IsLeader(), mExportProgressHelper, mProject, and scope.

Referenced by StartUploadProcess().

Here is the call graph for this function:

Here is the caller graph for this function:

HandleExportFailure()

void cloud::audiocom::ShareAudioDialog::HandleExportFailure ( )

private

Definition at line 478 of file ShareAudioDialog.cpp.

{
   EndModal(wxID_ABORT);
 
   BasicUI::ShowErrorDialog(
      {}, XO("Export error"),
      XO("We are unable to prepare this file for uploading."), {},
      BasicUI::ErrorDialogOptions { BasicUI::ErrorDialogType::ModalError });
}

References BasicUI::ModalError, BasicUI::ShowErrorDialog(), and XO().

Referenced by StartUploadProcess().

Here is the call graph for this function:

Here is the caller graph for this function:

HandleUploadFailed()

void cloud::audiocom::ShareAudioDialog::HandleUploadFailed ( std::string_view  errorMessage )

private

Definition at line 466 of file ShareAudioDialog.cpp.

{
   EndModal(wxID_ABORT);
 
   BasicUI::ShowErrorDialog(
      {}, XO("Upload error"),
      XO("We are unable to upload this file. Please try again and make sure to link to your audio.com account before uploading."),
      {},
      BasicUI::ErrorDialogOptions { BasicUI::ErrorDialogType::ModalError }.Log(
         audacity::ToWString(errorMessage)));
}

References BasicUI::ModalError, BasicUI::ShowErrorDialog(), audacity::ToWString(), and XO().

Here is the call graph for this function:

HandleUploadSucceeded()

void cloud::audiocom::ShareAudioDialog::HandleUploadSucceeded ( std::string_view  finishUploadURL, std::string_view  audioSlug  )

private

Definition at line 416 of file ShareAudioDialog.cpp.

{
   mProgressPanel.timePanel->Hide();
   mProgressPanel.title->SetLabel(XO("Upload complete!").Translation());
   mProgressPanel.info->Show();
   mProgressPanel.info->SetLabel(
      mInitialStatePanel.isPublic->GetValue() ? publicDescriptionText.Translation() :
         unlistedDescriptionText.Translation());
   
   if (!GetOAuthService().HasAccessToken())
   {
      mProgressPanel.info->SetLabel(
         "By pressing continue, you will be taken to audio.com and given a shareable link.");
      mProgressPanel.info->Wrap(mProgressPanel.root->GetSize().GetWidth());
 
      mContinueAction = [this, url = std::string(finishUploadURL)]()
      {
         EndModal(wxID_CLOSE);
         OpenInDefaultBrowser({ url });
      };
 
      mContinueButton->Show();
   }
   else
   {
      auto shareableLink = wxString::Format(
         "https://audio.com/%s/%s", GetUserService().GetUserSlug(),
         audacity::ToWXString(audioSlug));
 
      mGotoButton->Show();
      mCloseButton->Show();
      mCancelButton->Hide();
 
      mGotoButton->Bind(
         wxEVT_BUTTON,
         [this, url = shareableLink](auto)
         {
            EndModal(wxID_CLOSE);
            OpenInDefaultBrowser({ url });
         });
 
      mProgressPanel.link->SetValue(shareableLink);
      mProgressPanel.linkPanel->Show();
   }
 
   Layout();
   Fit();
}

References cloud::audiocom::GetOAuthService(), cloud::audiocom::GetUserService(), OpenInDefaultBrowser(), cloud::audiocom::anonymous_namespace{ShareAudioDialog.cpp}::publicDescriptionText, audacity::ToWXString(), cloud::audiocom::anonymous_namespace{ShareAudioDialog.cpp}::unlistedDescriptionText, and XO().

Here is the call graph for this function:

OnCancel()

void cloud::audiocom::ShareAudioDialog::OnCancel ( )

private

Definition at line 269 of file ShareAudioDialog.cpp.

{
   const auto hasExportStarted = mExportProgressHelper != nullptr;
   const auto hasUploadStarted = !!mServices->uploadPromise;
 
   if (mInProgress)
   {
      AudacityMessageDialog dlgMessage(
         this, XO("Are you sure you want to cancel?"), XO("Cancel upload to Audio.com"),
         wxYES_NO | wxICON_QUESTION | wxNO_DEFAULT | wxSTAY_ON_TOP);
      
      const auto result = dlgMessage.ShowModal();
 
      if (result != wxID_YES)
         return;
 
      // If export has started, notify it that it should be canceled
      if (mExportProgressHelper != nullptr)
         static_cast<ExportProgressHelper&>(*mExportProgressHelper).Cancel();
   }
 
   
   // If upload was started - ask it to discard the result.
   // The result should be discarded even after the upload has finished
   if (mServices->uploadPromise)
      mServices->uploadPromise->DiscardResult();
 
   EndModal(wxID_CANCEL);
}

References cloud::audiocom::ShareAudioDialog::ExportProgressHelper::Cancel(), mExportProgressHelper, mInProgress, mServices, and XO().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

OnClose()

void cloud::audiocom::ShareAudioDialog::OnClose ( )

private

Definition at line 304 of file ShareAudioDialog.cpp.

{
   EndModal(wxID_CLOSE);
}

Referenced by Populate().

Here is the caller graph for this function:

OnContinue()

void cloud::audiocom::ShareAudioDialog::OnContinue ( )

private

Definition at line 299 of file ShareAudioDialog.cpp.

{
   mContinueAction();
}

References mContinueAction.

Referenced by Populate().

Here is the caller graph for this function:

Populate()

void cloud::audiocom::ShareAudioDialog::Populate ( ShuttleGui &  s )

private

Definition at line 230 of file ShareAudioDialog.cpp.

{
   mInitialStatePanel.PopulateInitialStatePanel(s);
   mProgressPanel.PopulateProgressPanel(s);
 
   s.StartHorizontalLay(wxEXPAND, 0);
   {
      s.StartInvisiblePanel(14);
      {
         s.SetBorder(2);
         s.StartHorizontalLay(wxEXPAND, 0);
         {
            s.AddSpace(0, 0, 1);
 
            mCancelButton = s.AddButton(XXO("&Cancel"));
            mCancelButton->Bind(wxEVT_BUTTON, [this](auto) { OnCancel(); });
 
            mCloseButton = s.AddButton(XXO("&Close"));
            mCloseButton->Bind(wxEVT_BUTTON, [this](auto) { OnClose(); });
            
            s.AddSpace(4, 0, 0);
 
            mContinueButton = s.AddButton(XXO("C&ontinue"));
            mContinueButton->Bind(wxEVT_BUTTON, [this](auto) { OnContinue(); });
            
            mGotoButton = s.AddButton(XXO("&Go to my file"));
         }
         s.EndHorizontalLay();
      }
      s.EndInvisiblePanel();
   }
   s.EndHorizontalLay();
 
   // This two buttons are only used in the end of
   // authorised upload flow
   mGotoButton->Hide();
   mCloseButton->Hide();
}

References ShuttleGuiBase::AddButton(), ShuttleGui::AddSpace(), ShuttleGuiBase::EndHorizontalLay(), ShuttleGuiBase::EndInvisiblePanel(), mCancelButton, mCloseButton, mContinueButton, mGotoButton, mInitialStatePanel, mProgressPanel, OnCancel(), OnClose(), OnContinue(), cloud::audiocom::ShareAudioDialog::InitialStatePanel::PopulateInitialStatePanel(), cloud::audiocom::ShareAudioDialog::ProgressPanel::PopulateProgressPanel(), ShuttleGuiBase::SetBorder(), ShuttleGuiBase::StartHorizontalLay(), ShuttleGuiBase::StartInvisiblePanel(), and XXO().

Here is the call graph for this function:

ResetProgress()

void cloud::audiocom::ShareAudioDialog::ResetProgress ( )

private

Definition at line 488 of file ShareAudioDialog.cpp.

{
   mStageStartTime = Clock::now();
   mLastUIUpdateTime = mStageStartTime;
 
   mProgressPanel.elapsedTime->SetLabel(" 00:00:00");
   mProgressPanel.remainingTime->SetLabel(" 00:00:00");
   mProgressPanel.progress->SetValue(0);
 
   mLastProgressValue = 0;
 
   BasicUI::Yield();
}

References BasicUI::Yield().

Referenced by StartUploadProcess().

Here is the call graph for this function:

Here is the caller graph for this function:

StartUploadProcess()

void cloud::audiocom::ShareAudioDialog::StartUploadProcess ( )

private

Definition at line 356 of file ShareAudioDialog.cpp.

{
   mInProgress = true;
   
   mInitialStatePanel.root->Hide();
   mProgressPanel.root->Show();
 
   mProgressPanel.linkPanel->Hide();
   mProgressPanel.info->Hide();
 
   mContinueButton->Hide();
 
   Layout();
   Fit();
 
   ResetProgress();
 
   mFilePath = ExportProject();
 
   if (mFilePath.empty())
   {
      if (!static_cast<ExportProgressHelper&>(*mExportProgressHelper)
              .WasCancelled())
      {
         HandleExportFailure();
      }
 
      return;
   }
 
   mProgressPanel.title->SetLabel(XO("Uploading audio...").Translation());
   ResetProgress();
 
   mServices->uploadPromise = mServices->uploadService.Upload(
      mFilePath,
      mProject.GetProjectName(),
      mInitialStatePanel.isPublic->GetValue(),
      [this](const auto& result)
      {
         CallAfter(
            [this, result]()
            {
               mInProgress = false;
               
               if (result.result == UploadOperationCompleted::Result::Success)
                  HandleUploadSucceeded(result.finishUploadURL, result.audioSlug);
               else if (result.result != UploadOperationCompleted::Result::Aborted)
                  HandleUploadFailed(result.errorMessage);
            });
      },
      [this](auto current, auto total)
      {
         CallAfter(
            [this, current, total]()
            {
               UpdateProgress(current, total);
            });
      });
}

References ExportProject(), AudacityProject::GetProjectName(), HandleExportFailure(), cloud::audiocom::ShareAudioDialog::ProgressPanel::info, cloud::audiocom::ShareAudioDialog::InitialStatePanel::isPublic, cloud::audiocom::ShareAudioDialog::ProgressPanel::linkPanel, mContinueButton, mExportProgressHelper, mFilePath, mInitialStatePanel, mInProgress, mProgressPanel, mProject, mServices, ResetProgress(), cloud::audiocom::ShareAudioDialog::InitialStatePanel::root, cloud::audiocom::ShareAudioDialog::ProgressPanel::root, cloud::audiocom::ShareAudioDialog::ProgressPanel::title, and XO().

Here is the call graph for this function:

UpdateProgress()

void cloud::audiocom::ShareAudioDialog::UpdateProgress ( uint64_t  current, uint64_t  total  )

private

Definition at line 514 of file ShareAudioDialog.cpp.

{
   using namespace std::chrono;
 
   const auto now = Clock::now();
 
   if (current == 0)
      return;
 
   if (current > total)
      current = total;
 
   if (mLastProgressValue != current)
   {
      constexpr int scale = 10000;
 
      mLastProgressValue = static_cast<int>(current);
 
      mProgressPanel.progress->SetRange(scale);
      mProgressPanel.progress->SetValue((current * scale) / total);
 
      if (current == total && mServices->uploadPromise)
      {
         mProgressPanel.timePanel->Hide();
         mProgressPanel.title->SetLabel(XO("Finalizing upload...").Translation());
      }
   }
 
   const auto elapsedSinceUIUpdate = now - mLastUIUpdateTime;
 
   constexpr auto uiUpdateTimeout = 500ms;
 
   if (elapsedSinceUIUpdate < uiUpdateTimeout && current < total)
      return;
 
   mLastUIUpdateTime = now;
 
   const auto elapsed = duration_cast<milliseconds>(now - mStageStartTime);
 
   SetTimeLabel(mProgressPanel.elapsedTime, elapsed);
 
   const auto estimate = elapsed * total / current;
   const auto remains = estimate - elapsed;
 
   SetTimeLabel(
      mProgressPanel.remainingTime,
      std::chrono::duration_cast<std::chrono::milliseconds>(remains));
}

References cloud::audiocom::anonymous_namespace{ShareAudioDialog.cpp}::SetTimeLabel(), and XO().

Referenced by cloud::audiocom::ShareAudioDialog::ExportProgressHelper::Poll().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mCancelButton

wxButton* cloud::audiocom::ShareAudioDialog::mCancelButton { nullptr }

private

Definition at line 110 of file ShareAudioDialog.h.

Referenced by Populate().

mCloseButton

wxButton* cloud::audiocom::ShareAudioDialog::mCloseButton { nullptr }

private

Definition at line 111 of file ShareAudioDialog.h.

Referenced by Populate().

mContinueAction

std::function<void()> cloud::audiocom::ShareAudioDialog::mContinueAction

private

Definition at line 128 of file ShareAudioDialog.h.

Referenced by OnContinue().

mContinueButton

wxButton* cloud::audiocom::ShareAudioDialog::mContinueButton { nullptr }

private

Definition at line 109 of file ShareAudioDialog.h.

Referenced by Populate(), and StartUploadProcess().

mExportProgressHelper

std::unique_ptr<BasicUI::ProgressDialog> cloud::audiocom::ShareAudioDialog::mExportProgressHelper

private

Definition at line 118 of file ShareAudioDialog.h.

Referenced by ExportProject(), OnCancel(), and StartUploadProcess().

mFilePath

wxString cloud::audiocom::ShareAudioDialog::mFilePath

private

Definition at line 126 of file ShareAudioDialog.h.

Referenced by StartUploadProcess(), and ~ShareAudioDialog().

mGotoButton

wxButton* cloud::audiocom::ShareAudioDialog::mGotoButton { nullptr }

private

Definition at line 112 of file ShareAudioDialog.h.

Referenced by Populate().

mInitialStatePanel

struct cloud::audiocom::ShareAudioDialog::InitialStatePanel cloud::audiocom::ShareAudioDialog::mInitialStatePanel

private

Referenced by Populate(), and StartUploadProcess().

mInProgress

bool cloud::audiocom::ShareAudioDialog::mInProgress { false }

private

Definition at line 130 of file ShareAudioDialog.h.

Referenced by OnCancel(), and StartUploadProcess().

mLastProgressValue

int cloud::audiocom::ShareAudioDialog::mLastProgressValue { 0 }

private

Definition at line 124 of file ShareAudioDialog.h.

mLastUIUpdateTime

Clock::time_point cloud::audiocom::ShareAudioDialog::mLastUIUpdateTime

private

Definition at line 123 of file ShareAudioDialog.h.

mProgressPanel

struct cloud::audiocom::ShareAudioDialog::ProgressPanel cloud::audiocom::ShareAudioDialog::mProgressPanel

private

Referenced by Populate(), and StartUploadProcess().

mProject

AudacityProject& cloud::audiocom::ShareAudioDialog::mProject

private

Definition at line 64 of file ShareAudioDialog.h.

Referenced by ExportProject(), and StartUploadProcess().

mServices

std::unique_ptr<Services> cloud::audiocom::ShareAudioDialog::mServices

private

Definition at line 115 of file ShareAudioDialog.h.

Referenced by OnCancel(), and StartUploadProcess().

mStageStartTime

Clock::time_point cloud::audiocom::ShareAudioDialog::mStageStartTime

private

Definition at line 122 of file ShareAudioDialog.h.

---

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

• ShareAudioDialog.h
• ShareAudioDialog.cpp