PitchAndSpeedDialog Class Reference

#include <PitchAndSpeedDialog.h>

Inheritance diagram for PitchAndSpeedDialog:

Collaboration diagram for PitchAndSpeedDialog:

Classes
struct	PitchShift
struct	StrongTarget

Public Member Functions
	PitchAndSpeedDialog (AudacityProject &project)
PitchAndSpeedDialog &	Retarget (const std::shared_ptr< WaveTrack > &track, const WaveTrack::IntervalHolder &wideClip)
PitchAndSpeedDialog &	SetFocus (const std::optional< PitchAndSpeedDialogGroup > &group)
void	TryRetarget (const TrackPanelMouseEvent &event)
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
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static PitchAndSpeedDialog &	Get (AudacityProject &project)
static const PitchAndSpeedDialog &	Get (const AudacityProject &project)
static void	Destroy (AudacityProject &project)

Private Member Functions
bool	Show (bool show) override
void	SetFocus () override
void	PopulateOrExchange (ShuttleGui &s)
void	SetSemitoneShift ()
bool	SetClipSpeed ()
void	UpdateDialog ()
void	UpdateHistory (const TranslatableString &desc)
std::optional< StrongTarget >	LockTarget ()

Private Attributes
AudacityProject &	mProject
const wxString	mTitle
Observer::Subscription	mProjectCloseSubscription
Observer::Subscription	mAudioIOSubscription
Observer::Subscription	mClipDeletedSubscription
Observer::Subscription	mClipCentShiftChangeSubscription
Observer::Subscription	mClipSpeedChangeSubscription
double	mClipSpeed = 100
double	mOldClipSpeed = mClipSpeed
PitchShift	mShift
PitchShift	mOldShift
std::weak_ptr< WaveClip >	mLeftClip
std::weak_ptr< WaveClip >	mRightClip
std::weak_ptr< WaveTrack >	mTrack
bool	mConsolidateHistory = true
bool	mFirst = true
bool	mFormantPreservation = false
bool	mOldFormantPreservation = mFormantPreservation

Detailed Description

Definition at line 30 of file PitchAndSpeedDialog.h.

Constructor & Destructor Documentation

PitchAndSpeedDialog()

PitchAndSpeedDialog::PitchAndSpeedDialog

(

AudacityProject &

project

)

Definition at line 166 of file PitchAndSpeedDialog.cpp.

    : wxDialogWrapper(
         FindProjectFrame(&project), wxID_ANY, XO("Pitch and Speed"), wxDefaultPosition,
         { 480, 250 }, wxDEFAULT_DIALOG_STYLE)
    , mProject { project }
    , mProjectCloseSubscription { ProjectWindow::Get(mProject).Subscribe(
         [this](ProjectWindowDestroyedMessage) { Destroy(mProject); }) }
    , mTitle { GetTitle() }
{
   Bind(wxEVT_CLOSE_WINDOW, [this](const auto&) { Show(false); });
 
   Bind(wxEVT_CHAR_HOOK, [this](wxKeyEvent& event) {
      if (event.GetKeyCode() == WXK_ESCAPE)
         Show(false);
      else
         event.Skip();
   });
 
   if (const auto audioIo = AudioIO::Get())
   {
      mAudioIOSubscription =
         audioIo->Subscribe([this](const AudioIOEvent& event) {
            if (event.pProject != &mProject)
               return;
            switch (event.type)
            {
            case AudioIOEvent::CAPTURE:
            case AudioIOEvent::PLAYBACK:
               if (const auto child = wxDialog::FindWindowById(speedCtrlId))
                  child->Enable(!event.on);
               break;
            case AudioIOEvent::MONITOR:
            case AudioIOEvent::PAUSE:
               break;
            default:
               // Unknown event type
               assert(false);
            }
         });
   }
}

Member Function Documentation

Destroy()

void PitchAndSpeedDialog::Destroy ( AudacityProject &  project )

static

Definition at line 155 of file PitchAndSpeedDialog.cpp.

{
   auto& attachedWindows = GetAttachedWindows(project);
   auto* pPanel = attachedWindows.Find(key);
   if (pPanel)
   {
      pPanel->wxWindow::Destroy();
      attachedWindows.Assign(key, nullptr);
   }
}

References GetAttachedWindows(), anonymous_namespace{PitchAndSpeedDialog.cpp}::key, and project.

Here is the call graph for this function:

Get() [1/2]

PitchAndSpeedDialog & PitchAndSpeedDialog::Get ( AudacityProject &  project )

static

Definition at line 144 of file PitchAndSpeedDialog.cpp.

{
   return GetAttachedWindows(project).Get<PitchAndSpeedDialog>(key);
}

References ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Get(), GetAttachedWindows(), anonymous_namespace{PitchAndSpeedDialog.cpp}::key, and project.

Referenced by Get(), WaveTrackAffordanceHandle::Release(), SelectHandle::Release(), WaveChannelView::SelectNextClip(), and WaveTrackAffordanceControls::StartEditSelectedClipSpeed().

Here is the call graph for this function:

Here is the caller graph for this function:

Get() [2/2]

const PitchAndSpeedDialog & PitchAndSpeedDialog::Get ( const AudacityProject &  project )

static

Definition at line 150 of file PitchAndSpeedDialog.cpp.

{
   return Get(const_cast<AudacityProject&>(project));
}

References Get(), and project.

Here is the call graph for this function:

LockTarget()

std::optional< PitchAndSpeedDialog::StrongTarget > PitchAndSpeedDialog::LockTarget ( )

private

Definition at line 429 of file PitchAndSpeedDialog.cpp.

{
   if (const auto track = mTrack.lock())
      if (const auto leftClip = mLeftClip.lock())
         return StrongTarget {
            track, leftClip
         };
   return {};
}

References mLeftClip, and mTrack.

Referenced by PopulateOrExchange(), SetClipSpeed(), and SetSemitoneShift().

Here is the caller graph for this function:

PopulateOrExchange()

void PitchAndSpeedDialog::PopulateOrExchange ( ShuttleGui &  s )

private

Definition at line 287 of file PitchAndSpeedDialog.cpp.

{
   {
      ScopedInvisiblePanel panel { s, 15 };
      s.SetBorder(0);
      {
         ScopedStatic scopedStatic { s, XO("Clip Pitch") };
         {
            ScopedHorizontalLay h { s, wxLeft };
            s.SetBorder(2);
            // Use `TieSpinCtrl` rather than `AddSpinCtrl`, too see updates
            // instantly when `UpdateDialog` is called.
            const auto semiSpin = s.Id(semitoneCtrlId)
                                     .TieSpinCtrl(
                                        XO("se&mitones:"), mShift.semis,
                                        TimeAndPitchInterface::MaxCents / 100,
                                        TimeAndPitchInterface::MinCents / 100);
            semiSpin->Bind(wxEVT_SPINCTRL, [this, semiSpin](const auto&) {
               // The widget's value isn't updated yet on macos, so we need
               // to asynchronously query it later.
               CallAfter([this, semiSpin] {
                  const auto prevSemis = mShift.semis;
                  mShift.semis = semiSpin->GetValue();
                  // If we have e.g. -3 semi, -1 cents, and the user
                  // changes the sign of the semitones, the logic in
                  // `SetSemitoneShift` would result in 2 semi, 99
                  // cents. If the user changes sign again, we would now
                  // get 1 semi, -1 cents. Mirrorring (e.g. -3 semi, -1
                  // cents -> 3 semi, 1 cents) is not a good idea because
                  // that would ruin the work of users painstakingly
                  // adjusting the cents of an instrument. So instead, we
                  // map -3 semi, -1 cents to 3 semi, 99 cents.
                  if (mShift.cents != 0)
                  {
                     if (prevSemis < 0 && mShift.semis > 0)
                        ++mShift.semis;
                     else if (prevSemis > 0 && mShift.semis < 0)
                        --mShift.semis;
                  }
                  SetSemitoneShift();
               });
            });
            const auto centSpin =
               s.TieSpinCtrl(XO("&cents:"), mShift.cents, 100, -100);
            centSpin->Bind(wxEVT_SPINCTRL, [this, centSpin](const auto&) {
               CallAfter([this, centSpin] {
                  mShift.cents = centSpin->GetValue();
                  SetSemitoneShift();
               });
            });
         }
      }
 
      s.AddSpace(0, 12);
      s.SetBorder(0);
 
      {
         ScopedStatic scopedStatic { s, XO("Clip Speed") };
         {
            ScopedHorizontalLay h { s, wxLeft };
            const auto txtCtrl =
               s.Id(speedCtrlId)
                  .Name(XO("Clip Speed"))
                  .TieSpinControl(
                     wxSize(60, -1), XO("&speed %: "), mClipSpeed, 1000.0, 1.0);
#if wxUSE_ACCESSIBILITY
            txtCtrl->SetAccessible(safenew WindowAccessible(txtCtrl));
#endif
            const auto playbackOngoing =
               ProjectAudioIO::Get(mProject).IsAudioActive();
            txtCtrl->Enable(!playbackOngoing);
            txtCtrl->Bind(
               wxEVT_SPINCTRL, [this, txtCtrl](wxCommandEvent& event) {
                  mClipSpeed = txtCtrl->GetValue();
                  if (!SetClipSpeed())
                     if (auto target = LockTarget())
                     {
                        WaveTrackUtilities::ExpandClipTillNextOne(
                           *target->track, *target->clip);
                        UpdateDialog();
                     }
               });
         }
      }
 
      s.AddSpace(0, 12);
      s.SetBorder(0);
 
      {
         ScopedStatic scopedStatic { s, XO("General") };
         {
            ScopedHorizontalLay h { s, wxLeft };
            s.SetBorder(2);
            s.TieCheckBox(XO("&Optimize for Voice"), mFormantPreservation)
               ->Bind(wxEVT_CHECKBOX, [this](auto&) {
                  mFormantPreservation = !mFormantPreservation;
                  if (auto target = LockTarget())
                     target->clip->SetPitchAndSpeedPreset(
                        mFormantPreservation ?
                           PitchAndSpeedPreset::OptimizeForVoice :
                           PitchAndSpeedPreset::Default);
               });
         }
      }
   }
}

References ShuttleGui::AddSpace(), BasicUI::CallAfter(), PitchAndSpeedDialog::PitchShift::cents, Default, WaveTrackUtilities::ExpandClipTillNextOne(), ProjectAudioIO::Get(), ShuttleGui::Id(), ProjectAudioIO::IsAudioActive(), LockTarget(), TimeAndPitchInterface::MaxCents, mClipSpeed, mFormantPreservation, TimeAndPitchInterface::MinCents, mProject, mShift, ShuttleGui::Name(), OptimizeForVoice, safenew, PitchAndSpeedDialog::PitchShift::semis, anonymous_namespace{PitchAndSpeedDialog.cpp}::semitoneCtrlId, ShuttleGuiBase::SetBorder(), SetClipSpeed(), SetSemitoneShift(), anonymous_namespace{PitchAndSpeedDialog.cpp}::speedCtrlId, ShuttleGuiBase::TieCheckBox(), ShuttleGuiBase::TieSpinControl(), ShuttleGuiBase::TieSpinCtrl(), UpdateDialog(), and XO().

Referenced by Retarget(), and UpdateDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

Retarget()

PitchAndSpeedDialog & PitchAndSpeedDialog::Retarget	(	const std::shared_ptr< WaveTrack > &	track,
		const WaveTrack::IntervalHolder &	wideClip
	)

Definition at line 216 of file PitchAndSpeedDialog.cpp.

{
   mConsolidateHistory = false;
   wxDialog::SetTitle(mTitle + " - " + clip->GetName());
   const auto leftClip = clip;
   mClipDeletedSubscription =
      leftClip->Observer::Publisher<WaveClipDtorCalled>::Subscribe(
         [this](WaveClipDtorCalled) { Show(false); });
   mClipCentShiftChangeSubscription =
      leftClip->Observer::Publisher<CentShiftChange>::Subscribe(
         [this](const CentShiftChange& cents) {
            mShift = ToSemitonesAndCents(
               mShift.semis * 100 + mShift.cents, cents.newValue);
            UpdateDialog();
         });
   mClipSpeedChangeSubscription =
      leftClip->Observer::Publisher<StretchRatioChange>::Subscribe(
         [this](const StretchRatioChange& stretchRatio) {
            mClipSpeed = 100.0 / stretchRatio.newValue;
            UpdateDialog();
         });
 
   mTrack = track;
   mLeftClip = leftClip;
   mClipSpeed = 100.0 / leftClip->GetStretchRatio();
   mOldClipSpeed = mClipSpeed;
   mShift = GetClipShift(*leftClip);
   mOldShift = mShift;
   mFormantPreservation = leftClip->GetPitchAndSpeedPreset() ==
                          PitchAndSpeedPreset::OptimizeForVoice;
   mOldFormantPreservation = mFormantPreservation;
 
   ShuttleGui s(this, mFirst ? eIsCreating : eIsSettingToDialog);
 
   {
      ScopedVerticalLay v { s };
      PopulateOrExchange(s);
   }
 
   if (mFirst)
   {
      Layout();
      Fit();
      Centre();
      mFirst = false;
   }
 
   return *this;
}

References PitchAndSpeedDialog::PitchShift::cents, eIsCreating, eIsSettingToDialog, anonymous_namespace{PitchAndSpeedDialog.cpp}::GetClipShift(), mClipCentShiftChangeSubscription, mClipDeletedSubscription, mClipSpeed, mClipSpeedChangeSubscription, mConsolidateHistory, mFirst, mFormantPreservation, mLeftClip, mOldClipSpeed, mOldFormantPreservation, mOldShift, mShift, mTitle, mTrack, CentShiftChange::newValue, StretchRatioChange::newValue, OptimizeForVoice, PopulateOrExchange(), PitchAndSpeedDialog::PitchShift::semis, Show(), anonymous_namespace{PitchAndSpeedDialog.cpp}::ToSemitonesAndCents(), and UpdateDialog().

Referenced by WaveChannelView::SelectNextClip(), WaveTrackAffordanceControls::StartEditSelectedClipSpeed(), and TryRetarget().

Here is the call graph for this function:

Here is the caller graph for this function:

SetClipSpeed()

bool PitchAndSpeedDialog::SetClipSpeed ( )

private

Definition at line 394 of file PitchAndSpeedDialog.cpp.

{
   auto target = LockTarget();
   if (!target)
      return false;
 
   const auto wasExactlySelected =
      IsExactlySelected(mProject, *mLeftClip.lock());
 
   if (!TimeStretching::SetClipStretchRatio(
          *target->track, *target->clip, 100 / mClipSpeed))
      return false;
 
   if (wasExactlySelected)
      WaveClipUIUtilities::SelectClip(mProject, *target->clip);
 
   UpdateHistory(XO("Changed Speed"));
 
   return true;
}

References anonymous_namespace{PitchAndSpeedDialog.cpp}::IsExactlySelected(), LockTarget(), mClipSpeed, mLeftClip, mProject, WaveClipUIUtilities::SelectClip(), TimeStretching::SetClipStretchRatio(), UpdateHistory(), and XO().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

SetFocus() [1/2]

void PitchAndSpeedDialog::SetFocus ( )

inlineoverrideprivate

Definition at line 67 of file PitchAndSpeedDialog.h.

   {
      wxDialogWrapper::SetFocus();
   }

References BasicUI::SetFocus().

Here is the call graph for this function:

SetFocus() [2/2]

PitchAndSpeedDialog & PitchAndSpeedDialog::SetFocus

(

const std::optional< PitchAndSpeedDialogGroup > &

group

)

Definition at line 268 of file PitchAndSpeedDialog.cpp.

{
 
   const auto item =
      group.has_value() ?
         wxWindow::FindWindowById(
            *group == PitchAndSpeedDialogGroup::Pitch ? semitoneCtrlId :
                                                        speedCtrlId,
            this) :
         nullptr;
   if (item)
      item->SetFocus();
   wxDialog::Show(true);
   wxDialog::Raise();
   wxDialog::SetFocus();
   return *this;
}

References Pitch, anonymous_namespace{PitchAndSpeedDialog.cpp}::semitoneCtrlId, BasicUI::SetFocus(), ExportProgressUI::Show(), and anonymous_namespace{PitchAndSpeedDialog.cpp}::speedCtrlId.

Referenced by WaveTrackAffordanceControls::StartEditSelectedClipSpeed().

Here is the call graph for this function:

Here is the caller graph for this function:

SetSemitoneShift()

void PitchAndSpeedDialog::SetSemitoneShift ( )

private

Definition at line 439 of file PitchAndSpeedDialog.cpp.

{
   auto target = LockTarget();
   if (!target)
      return;
   ClampPitchShift(mShift);
   const auto success =
      target->clip->SetCentShift(mShift.semis * 100 + mShift.cents);
   assert(success);
   TrackPanel::Get(mProject).RefreshTrack(target->track.get());
   UpdateHistory(XO("Changed Pitch"));
}

References PitchAndSpeedDialog::PitchShift::cents, anonymous_namespace{PitchAndSpeedDialog.cpp}::ClampPitchShift(), TrackPanel::Get(), LockTarget(), mProject, mShift, TrackPanel::RefreshTrack(), PitchAndSpeedDialog::PitchShift::semis, UpdateHistory(), and XO().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

Show()

bool PitchAndSpeedDialog::Show ( bool  show )

inlineoverrideprivate

Definition at line 63 of file PitchAndSpeedDialog.h.

   {
      return wxDialogWrapper::Show(show);
   }

References ExportProgressUI::Show().

Referenced by Retarget().

Here is the call graph for this function:

Here is the caller graph for this function:

TryRetarget()

void PitchAndSpeedDialog::TryRetarget

(

const TrackPanelMouseEvent &

event

)

Definition at line 208 of file PitchAndSpeedDialog.cpp.

{
   const auto target = GetHitClip(mProject, event);
   if (!target.has_value() || target->clip == mLeftClip.lock())
      return;
   Retarget(target->track, target->clip);
}

References anonymous_namespace{PitchAndSpeedDialog.cpp}::GetHitClip(), mLeftClip, mProject, and Retarget().

Referenced by WaveTrackAffordanceHandle::Release(), and SelectHandle::Release().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateDialog()

void PitchAndSpeedDialog::UpdateDialog ( )

private

Definition at line 415 of file PitchAndSpeedDialog.cpp.

{
   ShuttleGui S(this, eIsSettingToDialog);
   PopulateOrExchange(S);
}

References eIsSettingToDialog, PopulateOrExchange(), and S.

Referenced by PopulateOrExchange(), and Retarget().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateHistory()

void PitchAndSpeedDialog::UpdateHistory ( const TranslatableString &  desc )

private

Definition at line 421 of file PitchAndSpeedDialog.cpp.

{
   ProjectHistory::Get(mProject).PushState(
      desc, desc, mConsolidateHistory ? UndoPush::CONSOLIDATE : UndoPush::NONE);
   mConsolidateHistory = true;
}

References CONSOLIDATE, anonymous_namespace{ExportPCM.cpp}::desc, ProjectHistory::Get(), mConsolidateHistory, mProject, NONE, and ProjectHistory::PushState().

Referenced by SetClipSpeed(), and SetSemitoneShift().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mAudioIOSubscription

Observer::Subscription PitchAndSpeedDialog::mAudioIOSubscription

private

Definition at line 89 of file PitchAndSpeedDialog.h.

mClipCentShiftChangeSubscription

Observer::Subscription PitchAndSpeedDialog::mClipCentShiftChangeSubscription

private

Definition at line 91 of file PitchAndSpeedDialog.h.

Referenced by Retarget().

mClipDeletedSubscription

Observer::Subscription PitchAndSpeedDialog::mClipDeletedSubscription

private

Definition at line 90 of file PitchAndSpeedDialog.h.

Referenced by Retarget().

mClipSpeed

double PitchAndSpeedDialog::mClipSpeed = 100

private

Definition at line 93 of file PitchAndSpeedDialog.h.

Referenced by PopulateOrExchange(), Retarget(), and SetClipSpeed().

mClipSpeedChangeSubscription

Observer::Subscription PitchAndSpeedDialog::mClipSpeedChangeSubscription

private

Definition at line 92 of file PitchAndSpeedDialog.h.

Referenced by Retarget().

mConsolidateHistory

bool PitchAndSpeedDialog::mConsolidateHistory = true

private

Definition at line 100 of file PitchAndSpeedDialog.h.

Referenced by Retarget(), and UpdateHistory().

mFirst

bool PitchAndSpeedDialog::mFirst = true

private

Definition at line 101 of file PitchAndSpeedDialog.h.

Referenced by Retarget().

mFormantPreservation

bool PitchAndSpeedDialog::mFormantPreservation = false

private

Definition at line 102 of file PitchAndSpeedDialog.h.

Referenced by PopulateOrExchange(), and Retarget().

mLeftClip

std::weak_ptr<WaveClip> PitchAndSpeedDialog::mLeftClip

private

Definition at line 97 of file PitchAndSpeedDialog.h.

Referenced by LockTarget(), Retarget(), SetClipSpeed(), and TryRetarget().

mOldClipSpeed

double PitchAndSpeedDialog::mOldClipSpeed = mClipSpeed

private

Definition at line 94 of file PitchAndSpeedDialog.h.

Referenced by Retarget().

mOldFormantPreservation

bool PitchAndSpeedDialog::mOldFormantPreservation = mFormantPreservation

private

Definition at line 103 of file PitchAndSpeedDialog.h.

Referenced by Retarget().

mOldShift

PitchShift PitchAndSpeedDialog::mOldShift

private

Definition at line 96 of file PitchAndSpeedDialog.h.

Referenced by Retarget().

mProject

AudacityProject& PitchAndSpeedDialog::mProject

private

Definition at line 86 of file PitchAndSpeedDialog.h.

Referenced by PopulateOrExchange(), SetClipSpeed(), SetSemitoneShift(), TryRetarget(), and UpdateHistory().

mProjectCloseSubscription

Observer::Subscription PitchAndSpeedDialog::mProjectCloseSubscription

private

Definition at line 88 of file PitchAndSpeedDialog.h.

mRightClip

std::weak_ptr<WaveClip> PitchAndSpeedDialog::mRightClip

private

Definition at line 98 of file PitchAndSpeedDialog.h.

mShift

PitchShift PitchAndSpeedDialog::mShift

private

Definition at line 95 of file PitchAndSpeedDialog.h.

Referenced by PopulateOrExchange(), Retarget(), and SetSemitoneShift().

mTitle

const wxString PitchAndSpeedDialog::mTitle

private

Definition at line 87 of file PitchAndSpeedDialog.h.

Referenced by Retarget().

mTrack

std::weak_ptr<WaveTrack> PitchAndSpeedDialog::mTrack

private

Definition at line 99 of file PitchAndSpeedDialog.h.

Referenced by LockTarget(), and Retarget().

---

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

• PitchAndSpeedDialog.h
• PitchAndSpeedDialog.cpp