WaveTrackMenuTable Struct Reference

Inheritance diagram for WaveTrackMenuTable:

Collaboration diagram for WaveTrackMenuTable:

Public Member Functions
	WaveTrackMenuTable ()
void	InitUserData (void *pUserData) override
	Called before the menu items are appended. More...
	DECLARE_POPUP_MENU (WaveTrackMenuTable)
void	OnMultiView (wxCommandEvent &event)
void	OnSetDisplay (wxCommandEvent &event)
	Set the Display mode based on the menu choice in the Track Menu. More...
void	OnMergeStereo (wxCommandEvent &event)
	Merge two tracks into one stereo track ?? More...
void	SplitStereo (bool stereo)
	Splits stereo track into two mono tracks, preserving panning if stereo is set. More...
void	OnSwapChannels (wxCommandEvent &event)
	Swap the left and right channels of a stero track... More...
void	OnSplitStereo (wxCommandEvent &event)
	Split a stereo track into two tracks... More...
void	OnSplitStereoMono (wxCommandEvent &event)
	Split a stereo track into two mono tracks... More...
Public Member Functions inherited from WaveTrackPopupMenuTable
WaveTrack &	FindWaveTrack () const
int	ReserveId ()
	PopupMenuTable (const Identifier &id, const TranslatableString &caption={})
Public Member Functions inherited from PopupMenuTable
	PopupMenuTable (const Identifier &id, const TranslatableString &caption={})
const Identifier &	Id () const
const TranslatableString &	Caption () const
const auto *	GetRegistry () const
const auto &	Get (void *pUserData)
void	Clear ()
Public Member Functions inherited from PopupMenuHandler
	PopupMenuHandler ()=default
	PopupMenuHandler (const PopupMenuHandler &)=delete
PopupMenuHandler &	operator= (const PopupMenuHandler &)=delete
virtual void	InitUserData (void *pUserData)=0
	Called before the menu items are appended. More...

Static Public Member Functions
static WaveTrackMenuTable &	Instance ()
Static Public Member Functions inherited from PopupMenuTable
static std::unique_ptr< PopupMenu >	BuildMenu (PopupMenuTable *pTable, void *pUserData=NULL)
static void	ExtendMenu (PopupMenu &menu, PopupMenuTable &otherTable)
template<typename Table , typename Factory >
static auto	Adapt (const Factory &factory)

Additional Inherited Members
Public Types inherited from PopupMenuTable
using	Entry = PopupMenuTableEntry
Public Attributes inherited from WaveTrackPopupMenuTable
PlayableTrackControls::InitMenuData *	mpData {}
Protected Member Functions inherited from PopupMenuTable
virtual void	Populate ()=0
template<typename Ptr >
void	Append (Ptr pItem)
void	Append (const Identifier &stringId, PopupMenuTableEntry::Type type, int id, const TranslatableString &string, wxCommandEventFunction memFn, const PopupMenuTableEntry::InitFunction &init)
void	AppendItem (const Identifier &stringId, int id, const TranslatableString &string, wxCommandEventFunction memFn, const PopupMenuTableEntry::InitFunction &init={})
void	AppendRadioItem (const Identifier &stringId, int id, const TranslatableString &string, wxCommandEventFunction memFn, const PopupMenuTableEntry::InitFunction &init={})
void	AppendCheckItem (const Identifier &stringId, int id, const TranslatableString &string, wxCommandEventFunction memFn, const PopupMenuTableEntry::InitFunction &init={})
void	BeginSection (const Identifier &name)
void	EndSection ()
Static Protected Member Functions inherited from PopupMenuTable
static TranslatableString	MakeLabel (const TranslatableString &label, bool useExtra, const TranslatableString &extra)
Protected Attributes inherited from WaveTrackPopupMenuTable
int	mNextId = 0
Protected Attributes inherited from PopupMenuTable
std::shared_ptr< PopupSubMenu >	mTop
std::vector< PopupMenuGroupItem * >	mStack
Identifier	mId
TranslatableString	mCaption
std::unique_ptr< PopupMenuGroupItem >	mRegistry

Detailed Description

Definition at line 502 of file WaveTrackControls.cpp.

Constructor & Destructor Documentation

WaveTrackMenuTable()

WaveTrackMenuTable::WaveTrackMenuTable ( )

inline

Definition at line 506 of file WaveTrackControls.cpp.

      : WaveTrackPopupMenuTable{ MenuPathStart }
   {
      mNextId = FirstAttachedItemId;
   }

References FirstAttachedItemId, and WaveTrackPopupMenuTable::mNextId.

Member Function Documentation

DECLARE_POPUP_MENU()

WaveTrackMenuTable::DECLARE_POPUP_MENU

(

WaveTrackMenuTable

)

InitUserData()

void WaveTrackMenuTable::InitUserData ( void *  pUserData )

overridevirtual

Called before the menu items are appended.

Store context data, if needed. May be called more than once before the menu opens. Pointer remains valid for the duration of any callback, if PopupMenuTable::BuildMenu() is called and the result's Popup() is called before any other menus are built.

Implements PopupMenuHandler.

Definition at line 538 of file WaveTrackControls.cpp.

{
   mpData = static_cast<PlayableTrackControls::InitMenuData*>(pUserData);
}

References WaveTrackPopupMenuTable::mpData.

Instance()

WaveTrackMenuTable & WaveTrackMenuTable::Instance ( )

static

Definition at line 532 of file WaveTrackControls.cpp.

{
   static WaveTrackMenuTable instance;
   return instance;
}

Referenced by WaveTrackControls::GetMenuExtension(), and GetWaveTrackMenuTable().

Here is the caller graph for this function:

OnMergeStereo()

void WaveTrackMenuTable::OnMergeStereo

(

wxCommandEvent &

event

)

Merge two tracks into one stereo track ??

Definition at line 752 of file WaveTrackControls.cpp.

{
   AudacityProject *const project = &mpData->project;
   auto &tracks = TrackList::Get( *project );
 
   const auto first = tracks.Any<WaveTrack>().find(mpData->pTrack);
   const auto left = *first;
   const auto right = *std::next(first);
 
   const auto checkAligned = [](const WaveTrack& left, const WaveTrack& right)
   {
      auto eqTrims = [](double a, double b)
      {
         return std::abs(a - b) <=
            std::numeric_limits<double>::epsilon() * std::max(a, b);
      };
      const auto eps = 0.5 / left.GetRate();
      const auto rightIntervals = right.Intervals();
      for(const auto& a : left.Intervals())
      {
         auto it = std::find_if(
            rightIntervals.begin(),
            rightIntervals.end(),
            [&](const auto& b)
            {
               //Start() and End() are always snapped to a sample grid
               return std::abs(a->Start() - b->Start()) < eps &&
                  std::abs(a->End() - b->End()) < eps &&
                  eqTrims(a->GetTrimLeft(), b->GetTrimLeft()) &&
                  eqTrims(a->GetTrimRight(), b->GetTrimRight()) &&
                  a->StretchRatioEquals(b->GetStretchRatio());
            });
         if(it == rightIntervals.end())
            return false;
      }
      return true;
   };
 
   if(RealtimeEffectList::Get(*left).GetStatesCount() != 0 ||
      RealtimeEffectList::Get(*right).GetStatesCount() != 0 ||
      !checkAligned(*left, *right))
   {
      const auto answer = BasicUI::ShowMessageBox(
         XO(
"The tracks you are attempting to merge to stereo contain clips at\n"
"different positions, or otherwise mismatching clips. Merging them\n"
"will render the tracks.\n\n"
"This causes any realtime effects to be applied to the waveform and\n"
"hidden data to be removed. Additionally, the entire track will\n"
"become one large clip.\n\n"
"Do you wish to continue?"
         ),
         BasicUI::MessageBoxOptions{}
            .ButtonStyle(BasicUI::Button::YesNo)
            .Caption(XO("Combine mono to stereo")));
      if(answer != BasicUI::MessageBoxResult::Yes)
         return;
   }
 
   const auto viewMinimized =
      ChannelView::Get(*left->GetChannel(0)).GetMinimized() &&
      ChannelView::Get(*right->GetChannel(0)).GetMinimized();
   const auto averageViewHeight =
      (WaveChannelView::Get(*left).GetHeight() +
      WaveChannelView::Get(*right).GetHeight()) / 2;
 
   left->SetPan(-1.0f);
   right->SetPan(1.0f);
   auto mix = MixAndRender(
      TrackIterRange {
         tracks.Any<const WaveTrack>().find(left),
         ++tracks.Any<const WaveTrack>().find(right)
      },
      Mixer::WarpOptions{ tracks.GetOwner() },
      (*first)->GetName(),
      &WaveTrackFactory::Get(*project),
      //use highest sample rate
      std::max(left->GetRate(), right->GetRate()),
      //use widest sample format
      std::max(left->GetSampleFormat(), right->GetSampleFormat()),
      0.0, 0.0);
 
   const auto newTrack = *mix->begin();
 
   tracks.Insert(*first, std::move(*mix));
   tracks.Remove(*left);
   tracks.Remove(*right);
   
   for(const auto& channel : newTrack->Channels())
   {
      // Set NEW track heights and minimized state
      auto& view = ChannelView::Get(*channel);
      view.SetMinimized(viewMinimized);
      view.SetExpandedHeight(averageViewHeight);
   }
   ProjectHistory::Get( *project ).PushState(
      /* i18n-hint: The string names a track */
      XO("Made '%s' a stereo track").Format( newTrack->GetName() ),
      XO("Make Stereo"));
 
   using namespace RefreshCode;
   mpData->result = RefreshAll | FixScrollbars;
}

References BasicUI::MessageBoxOptions::ButtonStyle(), PopupMenuTable::Caption(), RefreshCode::FixScrollbars, ProjectHistory::Get(), RealtimeEffectList::Get(), TrackList::Get(), WaveTrackFactory::Get(), ChannelView::Get(), WaveChannelView::Get(), ChannelView::GetHeight(), ChannelView::GetMinimized(), RealtimeEffectList::GetStatesCount(), MixAndRender(), WaveTrackPopupMenuTable::mpData, project, CommonTrackControls::InitMenuData::project, CommonTrackControls::InitMenuData::pTrack, ProjectHistory::PushState(), RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, BasicUI::ShowMessageBox(), tracks, XO(), BasicUI::Yes, and BasicUI::YesNo.

Here is the call graph for this function:

OnMultiView()

void WaveTrackMenuTable::OnMultiView

(

wxCommandEvent &

event

)

Definition at line 698 of file WaveTrackControls.cpp.

{
   const auto pTrack = static_cast<WaveTrack*>(mpData->pTrack);
   auto &view = WaveChannelView::Get(*pTrack);
   bool multi = !view.GetMultiView();
   const auto &displays = view.GetDisplays();
   const auto display = displays.empty()
      ? WaveChannelViewConstants::Waveform : displays.begin()->id;
   view.SetMultiView(multi);
 
   // Whichever sub-view was on top stays on top
   // If going into Multi-view, it will be 1/nth the height.
   // If exiting multi-view, it will be full height.
   view.SetDisplay(display, !multi);
}

References WaveChannelView::Get(), and WaveChannelViewConstants::Waveform.

Here is the call graph for this function:

OnSetDisplay()

void WaveTrackMenuTable::OnSetDisplay

(

wxCommandEvent &

event

)

Set the Display mode based on the menu choice in the Track Menu.

Definition at line 715 of file WaveTrackControls.cpp.

{
   int idInt = event.GetId();
   wxASSERT(idInt >= OnSetDisplayId &&
            idInt <= lastDisplayId);
   const auto pTrack = static_cast<WaveTrack*>(mpData->pTrack);
 
   auto id = AllTypes()[ idInt - OnSetDisplayId ].id;
 
   auto &view = WaveChannelView::Get(*pTrack);
   if (view.GetMultiView()) {
      if (!WaveChannelView::Get(*pTrack)
            .ToggleSubView(WaveChannelView::Display{ id } )) {
         // Trying to toggle off the last sub-view.  It was refused.
         // Decide what to do here.  Turn off multi-view instead?
         // PRL:  I don't agree that it makes sense
      }
      else
         ProjectHistory::Get(mpData->project).ModifyState(true);
   }
   else {
      const auto displays = view.GetDisplays();
      const bool wrongType =
         !(displays.size() == 1 && displays[0].id == id);
      if (wrongType) {
         WaveChannelView::Get(*pTrack).SetDisplay(WaveChannelView::Display{ id });
 
         AudacityProject *const project = &mpData->project;
         ProjectHistory::Get( *project ).ModifyState(true);
 
         using namespace RefreshCode;
         mpData->result = RefreshAll | UpdateVRuler;
      }
   }
}

References AllTypes(), ProjectHistory::Get(), WaveChannelView::Get(), id, lastDisplayId, ProjectHistory::ModifyState(), WaveTrackPopupMenuTable::mpData, OnSetDisplayId, project, CommonTrackControls::InitMenuData::project, CommonTrackControls::InitMenuData::pTrack, RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, WaveChannelView::SetDisplay(), and RefreshCode::UpdateVRuler.

Here is the call graph for this function:

OnSplitStereo()

void WaveTrackMenuTable::OnSplitStereo

(

wxCommandEvent &

event

)

Split a stereo track into two tracks...

Definition at line 921 of file WaveTrackControls.cpp.

{
   SplitStereo(true);
   WaveTrack *const pTrack = static_cast<WaveTrack*>(mpData->pTrack);
   AudacityProject *const project = &mpData->project;
   ProjectHistory::Get( *project ).PushState(
   /* i18n-hint: The string names a track  */
      XO("Split stereo track '%s'").Format( pTrack->GetName() ),
      XO("Split"));
 
   using namespace RefreshCode;
   mpData->result = RefreshAll | FixScrollbars;
}

References RefreshCode::FixScrollbars, ProjectHistory::Get(), Track::GetName(), WaveTrackPopupMenuTable::mpData, project, CommonTrackControls::InitMenuData::project, CommonTrackControls::InitMenuData::pTrack, ProjectHistory::PushState(), RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, SplitStereo(), and XO().

Here is the call graph for this function:

OnSplitStereoMono()

void WaveTrackMenuTable::OnSplitStereoMono

(

wxCommandEvent &

event

)

Split a stereo track into two mono tracks...

Definition at line 936 of file WaveTrackControls.cpp.

{
   SplitStereo(false);
   WaveTrack *const pTrack = static_cast<WaveTrack*>(mpData->pTrack);
   AudacityProject *const project = &mpData->project;
   ProjectHistory::Get( *project ).PushState(
   /* i18n-hint: The string names a track  */
      XO("Split Stereo to Mono '%s'").Format( pTrack->GetName() ),
      XO("Split to Mono"));
 
   using namespace RefreshCode;
   mpData->result = RefreshAll | FixScrollbars;
}

References RefreshCode::FixScrollbars, ProjectHistory::Get(), Track::GetName(), WaveTrackPopupMenuTable::mpData, project, CommonTrackControls::InitMenuData::project, CommonTrackControls::InitMenuData::pTrack, ProjectHistory::PushState(), RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, SplitStereo(), and XO().

Here is the call graph for this function:

OnSwapChannels()

void WaveTrackMenuTable::OnSwapChannels

(

wxCommandEvent &

event

)

Swap the left and right channels of a stero track...

Definition at line 892 of file WaveTrackControls.cpp.

{
   // Fix assertion violation in `TrackPanel::OnEnsureVisible` by
   // dispatching any queued event
   // TODO wide wave tracks -- remove this when there is no "leader" distinction
   // any more
   wxTheApp->Yield();
 
   AudacityProject *const project = &mpData->project;
 
   auto &trackFocus = TrackFocus::Get( *project );
   const auto pTrack = mpData->pTrack;
   const bool hasFocus = trackFocus.Get() == pTrack;
   static_cast<WaveTrack*>(pTrack)->CopyClipEnvelopes();
   if (auto track = TrackList::SwapChannels(*pTrack))
   {
      if (hasFocus)
         trackFocus.Set(track);
 
      ProjectHistory::Get( *project ).PushState(
         /* i18n-hint: The string names a track  */
         XO("Swapped Channels in '%s'").Format( track->GetName() ),
         XO("Swap Channels"));
   }
 
   mpData->result = RefreshCode::RefreshAll;
}

References TrackFocus::Get(), ProjectHistory::Get(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Get(), Track::GetName(), WaveTrackPopupMenuTable::mpData, project, CommonTrackControls::InitMenuData::project, CommonTrackControls::InitMenuData::pTrack, ProjectHistory::PushState(), RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, WaveChannel::Set(), TrackList::SwapChannels(), and XO().

Here is the call graph for this function:

SplitStereo()

void WaveTrackMenuTable::SplitStereo

(

bool

stereo

)

Splits stereo track into two mono tracks, preserving panning if stereo is set.

Split a stereo track (or more-than-stereo?) into two (or more) tracks...

Definition at line 857 of file WaveTrackControls.cpp.

{
   AudacityProject *const project = &mpData->project;
 
   int totalHeight = 0;
   int nChannels = 0;
 
   const auto pTrack = mpData->pTrack;
   static_cast<WaveTrack*>(pTrack)->CopyClipEnvelopes();
   auto unlinkedTracks = TrackList::Get(*project).UnlinkChannels(*pTrack);
   assert(unlinkedTracks.size() == 2);
   if(stereo)
   {
      static_cast<WaveTrack*>(unlinkedTracks[0])->SetPan(-1.0f);
      static_cast<WaveTrack*>(unlinkedTracks[1])->SetPan(1.0f);
   }
 
   for (const auto track : unlinkedTracks) {
      auto &view = ChannelView::Get(*track->GetChannel(0));
      
      //make sure no channel is smaller than its minimum height
      if (view.GetHeight() < view.GetMinimizedHeight())
         view.SetExpandedHeight(view.GetMinimizedHeight());
      totalHeight += view.GetHeight();
      ++nChannels;
   }
 
   int averageHeight = totalHeight / nChannels;
 
   for (const auto track : unlinkedTracks)
      // Make tracks the same height
      ChannelView::Get(*track->GetChannel(0)).SetExpandedHeight(averageHeight);
}

References TrackList::Get(), ChannelView::Get(), WaveTrack::GetChannel(), WaveTrackPopupMenuTable::mpData, project, CommonTrackControls::InitMenuData::project, CommonTrackControls::InitMenuData::pTrack, ChannelView::SetExpandedHeight(), and TrackList::UnlinkChannels().

Referenced by OnSplitStereo(), and OnSplitStereoMono().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• WaveTrackControls.cpp