TrackUtilities Namespace Reference

Enumerations
enum	MoveChoice { OnMoveUpID , OnMoveDownID , OnMoveTopID , OnMoveBottomID }

Functions
void	DoRemoveTracks (AudacityProject &project)
void	DoTrackMute (AudacityProject &project, Track *t, bool exclusive)
void	DoTrackSolo (AudacityProject &project, Track *t, bool exclusive)
void	DoRemoveTrack (AudacityProject &project, Track *toRemove)
void	DoMoveTrack (AudacityProject &project, Track *target, MoveChoice choice)
	Move a track up, down, to top or to bottom. More...

Enumeration Type Documentation

MoveChoice

enum TrackUtilities::MoveChoice

Enumerator
OnMoveUpID
OnMoveDownID
OnMoveTopID
OnMoveBottomID

Definition at line 19 of file TrackUtilities.h.

                   {
      OnMoveUpID, OnMoveDownID, OnMoveTopID, OnMoveBottomID
   };

Function Documentation

DoMoveTrack()

AUDACITY_DLL_API void TrackUtilities::DoMoveTrack	(	AudacityProject &	project,
		Track *	target,
		MoveChoice	choice
	)

Move a track up, down, to top or to bottom.

Definition at line 186 of file TrackUtilities.cpp.

{
   auto &tracks = TrackList::Get( project );
 
   TranslatableString longDesc, shortDesc;
 
   switch (choice)
   {
   case OnMoveTopID:
      /* i18n-hint: Past tense of 'to move', as in 'moved audio track up'.*/
      longDesc = XO("Moved '%s' to Top");
      shortDesc = XO("Move Track to Top");
 
      // TODO: write TrackList::Rotate to do this in one step and avoid emitting
      // an event for each swap
      while (tracks.CanMoveUp(target))
         tracks.Move(target, true);
 
      break;
   case OnMoveBottomID:
      /* i18n-hint: Past tense of 'to move', as in 'moved audio track up'.*/
      longDesc = XO("Moved '%s' to Bottom");
      shortDesc = XO("Move Track to Bottom");
 
      // TODO: write TrackList::Rotate to do this in one step and avoid emitting
      // an event for each swap
      while (tracks.CanMoveDown(target))
         tracks.Move(target, false);
 
      break;
   default:
      bool bUp = (OnMoveUpID == choice);
 
      tracks.Move(target, bUp);
      longDesc =
         /* i18n-hint: Past tense of 'to move', as in 'moved audio track up'.*/
         bUp? XO("Moved '%s' Up")
         : XO("Moved '%s' Down");
      shortDesc =
         /* i18n-hint: Past tense of 'to move', as in 'moved audio track up'.*/
         bUp? XO("Move Track Up")
         : XO("Move Track Down");
 
   }
 
   longDesc.Format(target->GetName());
 
   ProjectHistory::Get( project ).PushState(longDesc, shortDesc);
}

References TranslatableString::Format(), ProjectHistory::Get(), TrackList::Get(), Track::GetName(), OnMoveBottomID, OnMoveTopID, OnMoveUpID, ProjectHistory::PushState(), and XO().

Referenced by TrackMenuTable::OnMoveTrack(), anonymous_namespace{TrackMenus.cpp}::OnTrackMoveBottom(), anonymous_namespace{TrackMenus.cpp}::OnTrackMoveDown(), anonymous_namespace{TrackMenus.cpp}::OnTrackMoveTop(), and anonymous_namespace{TrackMenus.cpp}::OnTrackMoveUp().

Here is the call graph for this function:

Here is the caller graph for this function:

DoRemoveTrack()

AUDACITY_DLL_API void TrackUtilities::DoRemoveTrack	(	AudacityProject &	project,
		Track *	toRemove
	)

Definition at line 151 of file TrackUtilities.cpp.

{
   auto &tracks = TrackList::Get( project );
   auto &trackFocus = TrackFocus::Get( project );
   auto &window = ProjectWindow::Get( project );
 
   // If it was focused, then NEW focus is the next or, if
   // unavailable, the previous track. (The NEW focus is set
   // after the track has been removed.)
   bool toRemoveWasFocused = trackFocus.Get() == toRemove;
   Track* newFocus{};
   if (toRemoveWasFocused) {
      auto iterNext = tracks.FindLeader(toRemove), iterPrev = iterNext;
      newFocus = *++iterNext;
      if (!newFocus) {
         newFocus = *--iterPrev;
      }
   }
 
   wxString name = toRemove->GetName();
 
   auto channels = TrackList::Channels(toRemove);
   // Be careful to post-increment over positions that get erased!
   auto &iter = channels.first;
   while (iter != channels.end())
      tracks.Remove( * iter++ );
 
   if (toRemoveWasFocused)
      trackFocus.Set( newFocus );
 
   ProjectHistory::Get( project ).PushState(
      XO("Removed track '%s.'").Format( name ),
      XO("Track Remove"));
}

References TrackList::Channels(), TrackFocus::Get(), ProjectHistory::Get(), TrackList::Get(), ProjectWindow::Get(), Track::GetName(), name, ProjectHistory::PushState(), and XO().

Referenced by CloseButtonHandle::CommitChanges(), and anonymous_namespace{TrackMenus.cpp}::OnTrackClose().

Here is the call graph for this function:

Here is the caller graph for this function:

DoRemoveTracks()

AUDACITY_DLL_API void TrackUtilities::DoRemoveTracks

(

AudacityProject &

project

)

Definition at line 21 of file TrackUtilities.cpp.

{
   auto &tracks = TrackList::Get( project );
   auto &trackPanel = TrackPanel::Get( project );
 
   std::vector<Track*> toRemove;
   for (auto track : tracks.Selected())
      toRemove.push_back(track);
 
   // Capture the track preceding the first removed track
   Track *f{};
   if (!toRemove.empty()) {
      auto found = tracks.Find(toRemove[0]);
      f = *--found;
   }
 
   for (auto track : toRemove)
      tracks.Remove(track);
 
   if (!f)
      // try to use the last track
      f = *tracks.Any().rbegin();
   if (f) {
      // Try to use the first track after the removal
      auto found = tracks.FindLeader(f);
      auto t = *++found;
      if (t)
         f = t;
   }
 
   // If we actually have something left, then set focus and make sure it's seen
   if (f) {
      TrackFocus::Get(project).Set(f);
      f->EnsureVisible();
   }
 
   ProjectHistory::Get( project )
      .PushState(XO("Removed audio track(s)"), XO("Remove Track"));
 
   trackPanel.UpdateViewIfNoTracks();
}

References Track::EnsureVisible(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Find(), TrackFocus::Get(), ProjectHistory::Get(), TrackList::Get(), TrackPanel::Get(), ProjectHistory::PushState(), and XO().

Referenced by anonymous_namespace{TrackMenus.cpp}::OnRemoveTracks(), and ProjectManager::ResetProjectToEmpty().

Here is the call graph for this function:

Here is the caller graph for this function:

DoTrackMute()

AUDACITY_DLL_API void TrackUtilities::DoTrackMute	(	AudacityProject &	project,
		Track *	t,
		bool	exclusive
	)

Definition at line 63 of file TrackUtilities.cpp.

{
   auto &tracks = TrackList::Get( project );
 
   // Whatever t is, replace with lead channel
   t = *tracks.FindLeader(t);
 
   // "exclusive" mute means mute the chosen track and unmute all others.
   if (exclusive) {
      for (auto leader : tracks.Leaders<PlayableTrack>()) {
         bool chosen = (t == leader);
         leader->SetMute(chosen);
         leader->SetSolo(false);
      }
   }
   else {
      // Normal click toggles this track.
      auto pt = dynamic_cast<PlayableTrack *>( t );
      if (!pt)
         return;
 
      bool wasMute = pt->GetMute();
      pt->SetMute(!wasMute);
 
      if (auto value = TracksBehaviorsSolo.ReadEnum();
         value == SoloBehaviorSimple || value == SoloBehaviorNone)
      {
         // We also set a solo indicator if we have just one track / stereo pair playing.
         // in a group of more than one playable tracks.
         // otherwise clear solo on everything.
 
         auto range = tracks.Leaders<PlayableTrack>();
         auto nPlayableTracks = range.size();
         auto nPlaying = (range - &PlayableTrack::GetMute).size();
         for (auto track : range)
            track->SetSolo((nPlaying == 1) &&
               (nPlayableTracks > 1) && !track->GetMute());
      }
   }
   ProjectHistory::Get( project ).ModifyState(true);
 
   TrackFocus::Get( project ).UpdateAccessibility();
}

References TrackFocus::Get(), ProjectHistory::Get(), TrackList::Get(), PlayableTrack::GetMute(), ProjectHistory::ModifyState(), size, ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::size(), SoloBehaviorNone, SoloBehaviorSimple, and TracksBehaviorsSolo.

Referenced by MuteButtonHandle::CommitChanges(), MixerTrackCluster::OnButton_Mute(), and anonymous_namespace{TrackMenus.cpp}::OnTrackMute().

Here is the call graph for this function:

Here is the caller graph for this function:

DoTrackSolo()

AUDACITY_DLL_API void TrackUtilities::DoTrackSolo	(	AudacityProject &	project,
		Track *	t,
		bool	exclusive
	)

Definition at line 107 of file TrackUtilities.cpp.

{
   auto &tracks = TrackList::Get( project );
   
   // Whatever t is, replace with lead channel
   t = *tracks.FindLeader(t);
 
   const auto pt = dynamic_cast<PlayableTrack *>( t );
   if (!pt)
      return;
   bool bWasSolo = pt->GetSolo();
 
   bool simple = (TracksBehaviorsSolo.ReadEnum() == SoloBehaviorSimple);
   bool bSoloMultiple = !simple ^ exclusive;
 
   // Standard and Simple solo have opposite defaults:
   //   Standard - Behaves as individual buttons, shift=radio buttons
   //   Simple   - Behaves as radio buttons, shift=individual
   // In addition, Simple solo will mute/unmute tracks
   // when in standard radio button mode.
   if (bSoloMultiple)
      pt->SetSolo(!bWasSolo);
   else {
      // Normal click solo this track only, mute everything else.
      // OR unmute and unsolo everything.
      for (auto leader : tracks.Leaders<PlayableTrack>()) {
         bool chosen = (t == leader);
         if (chosen) {
            leader->SetSolo(!bWasSolo);
            if (simple)
               leader->SetMute(false);
         }
         else {
            leader->SetSolo(false);
            if (simple)
               leader->SetMute(!bWasSolo);
         }
      }
   }
   ProjectHistory::Get( project ).ModifyState(true);
 
   TrackFocus::Get( project ).UpdateAccessibility();
}

References TrackFocus::Get(), ProjectHistory::Get(), TrackList::Get(), PlayableTrack::GetSolo(), ProjectHistory::ModifyState(), SoloBehaviorSimple, and TracksBehaviorsSolo.

Referenced by SoloButtonHandle::CommitChanges(), MixerTrackCluster::OnButton_Solo(), and anonymous_namespace{TrackMenus.cpp}::OnTrackSolo().

Here is the call graph for this function:

Here is the caller graph for this function: