MixerTrackCluster Class Reference

#include <MixerBoard.h>

Inheritance diagram for MixerTrackCluster:

Collaboration diagram for MixerTrackCluster:

Public Member Functions
	MixerTrackCluster (wxWindow *parent, MixerBoard *grandParent, AudacityProject *project, const std::shared_ptr< PlayableTrack > &pTrack, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize)
virtual	~MixerTrackCluster ()
WaveTrack *	GetWave () const
WaveChannel *	GetRight () const
void	HandleResize ()
void	HandleSliderGain (const bool bWantPushState=false)
void	HandleSliderPan (const bool bWantPushState=false)
void	ResetMeter (const bool bResetClipping)
void	UpdateForStateChange ()
void	UpdateMeter (const double t0, const double t1)
Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()
	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
void	SetLabel (const TranslatableString &label)
void	SetName (const TranslatableString &name)
void	SetToolTip (const TranslatableString &toolTip)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Public Attributes
std::shared_ptr< PlayableTrack >	mTrack

Private Member Functions
wxColour	GetTrackColor ()
void	HandleSelect (bool bShiftDown, bool bControlDown)
void	OnKeyEvent (wxKeyEvent &event)
void	OnMouseEvent (wxMouseEvent &event)
void	OnPaint (wxPaintEvent &evt)
void	OnButton_MusicalInstrument (wxCommandEvent &event)
void	OnSlider_Gain (wxCommandEvent &event)
void	OnSlider_Pan (wxCommandEvent &event)
void	OnButton_Mute (wxCommandEvent &event)
void	OnButton_Solo (wxCommandEvent &event)

Private Attributes
MixerBoard *	mMixerBoard
AudacityProject *	mProject
auStaticText *	mStaticText_TrackName
wxBitmapButton *	mBitmapButton_MusicalInstrument
AButton *	mToggleButton_Mute
AButton *	mToggleButton_Solo
MixerTrackSlider *	mSlider_Pan
MixerTrackSlider *	mSlider_Gain
wxWeakRef< MeterPanel >	mMeter
ChannelGroupSampleView	mSampleView

Detailed Description

Definition at line 81 of file MixerBoard.h.

Constructor & Destructor Documentation

MixerTrackCluster()

MixerTrackCluster::MixerTrackCluster	(	wxWindow *	parent,
		MixerBoard *	grandParent,
		AudacityProject *	project,
		const std::shared_ptr< PlayableTrack > &	pTrack,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize
	)

Definition at line 176 of file MixerBoard.cpp.

: wxPanelWrapper(parent, -1, pos, size)
, mTrack{ pTrack }
{
   mMixerBoard = grandParent;
   mProject = project;
   wxASSERT( pTrack );
 
   SetName( Verbatim( mTrack->GetName() ) );
 
   //this->SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE));
   this->SetBackgroundColour( theTheme.Colour( clrMedium ) );
   // Not sure why, but sizers weren't getting offset vertically,
   // probably because not using wxDefaultPosition,
   // so positions are calculated explicitly below, and sizers code was removed.
   // (Still available in Audacity_UmixIt branch off 1.2.6.)
 
   // track name
   wxPoint ctrlPos(kDoubleInset, kDoubleInset);
   wxSize ctrlSize(size.GetWidth() - kQuadrupleInset, TRACK_NAME_HEIGHT);
   mStaticText_TrackName =
      safenew auStaticText(this, mTrack->GetName());
   //v Useful when different tracks are different colors, but not now.
   //    mStaticText_TrackName->SetBackgroundColour(this->GetTrackColor());
   mStaticText_TrackName->SetForegroundColour(theTheme.Colour(clrMedium));
   mStaticText_TrackName->SetForegroundColour(theTheme.Colour(clrTrackPanelText));
   mStaticText_TrackName->SetSize( ctrlSize );
   mStaticText_TrackName->SetPosition( ctrlPos );
 
 
   // gain and velocity sliders at left (both in same place)
   ctrlPos.x = kDoubleInset;
   ctrlPos.y += TRACK_NAME_HEIGHT + kDoubleInset;
   const int nGainSliderHeight =
      size.GetHeight() - ctrlPos.y - kQuadrupleInset;
   ctrlSize.Set(kLeftSideStackWidth - kQuadrupleInset, nGainSliderHeight);
 
   mSlider_Gain =
      safenew MixerTrackSlider(
            this, ID_SLIDER_GAIN,
            /* i18n-hint: title of the Gain slider, used to adjust the volume */
            XO("Gain"),
            ctrlPos, ctrlSize,
            ASlider::Options{}
               .Style( DB_SLIDER )
               .Orientation( wxVERTICAL ));
   mSlider_Gain->SetName(_("Gain"));
 
#ifdef EXPERIMENTAL_MIDI_OUT
   mSlider_Velocity =
      safenew MixerTrackSlider(
            this, ID_SLIDER_VELOCITY,
            /* i18n-hint: title of the MIDI Velocity slider */
            XO("Velocity"),
            ctrlPos, ctrlSize,
            ASlider::Options{}
               .Style( VEL_SLIDER )
               .Orientation( wxVERTICAL ));
   mSlider_Velocity->SetName(_("Velocity"));
#endif
 
   // other controls and meter at right
 
   // musical instrument image
   ctrlPos.x += kLeftSideStackWidth + kInset; // + kInset to center it in right side stack
   ctrlSize.Set(MUSICAL_INSTRUMENT_HEIGHT_AND_WIDTH, MUSICAL_INSTRUMENT_HEIGHT_AND_WIDTH);
   wxBitmap* bitmap = mMixerBoard->GetMusicalInstrumentBitmap(mTrack.get());
   wxASSERT(bitmap);
   mBitmapButton_MusicalInstrument =
      safenew wxBitmapButton(this, ID_BITMAPBUTTON_MUSICAL_INSTRUMENT, *bitmap,
                           ctrlPos, ctrlSize,
                           wxBU_AUTODRAW, wxDefaultValidator,
                           _("Musical Instrument"));
   mBitmapButton_MusicalInstrument->SetName(_("Musical Instrument"));
 
 
   // pan slider
   ctrlPos.x -= kInset; // Remove inset for instrument, so Pan is at leftmost of left side stack.
   ctrlPos.y += MUSICAL_INSTRUMENT_HEIGHT_AND_WIDTH + kDoubleInset;
   ctrlSize.Set(kRightSideStackWidth, PAN_HEIGHT);
 
   // The width of the pan slider must be odd (don't ask).
   if (!(ctrlSize.x & 1))
      ctrlSize.x--;
 
   mSlider_Pan =
      safenew MixerTrackSlider(
            this, ID_SLIDER_PAN,
            /* i18n-hint: Title of the Pan slider, used to move the sound left or right */
            XO("Pan"),
            ctrlPos, ctrlSize,
            ASlider::Options{}.Style( PAN_SLIDER ));
   mSlider_Pan->SetName(_("Pan"));
 
   // mute/solo buttons stacked below Pan slider
   ctrlPos.y += PAN_HEIGHT + kDoubleInset;
   ctrlSize.Set(mMixerBoard->mMuteSoloWidth, MUTE_SOLO_HEIGHT);
   mToggleButton_Mute =
      safenew AButton(this, ID_TOGGLEBUTTON_MUTE,
                  ctrlPos, ctrlSize,
                  *(mMixerBoard->mImageMuteUp), *(mMixerBoard->mImageMuteOver),
                  *(mMixerBoard->mImageMuteDown), *(mMixerBoard->mImageMuteDown),
                  *(mMixerBoard->mImageMuteDisabled),
                  true); // toggle button
   mToggleButton_Mute->SetName(_("Mute"));
   mToggleButton_Mute->SetAlternateImages(
      1,
      *(mMixerBoard->mImageMuteUp), *(mMixerBoard->mImageMuteOver),
      *(mMixerBoard->mImageMuteDown), *(mMixerBoard->mImageMuteDown),
      *(mMixerBoard->mImageMuteDisabled));
 
   ctrlPos.y += MUTE_SOLO_HEIGHT;
   mToggleButton_Solo =
      safenew AButton(this, ID_TOGGLEBUTTON_SOLO,
                  ctrlPos, ctrlSize,
                  *(mMixerBoard->mImageSoloUp), *(mMixerBoard->mImageSoloOver),
                  *(mMixerBoard->mImageSoloDown), *(mMixerBoard->mImageSoloDown),
                  *(mMixerBoard->mImageSoloDisabled),
                  true); // toggle button
   mToggleButton_Solo->SetName(_("Solo"));
   bool bSoloNone = (TracksBehaviorsSolo.ReadEnum() == SoloBehaviorNone);
   mToggleButton_Solo->Show(!bSoloNone);
 
 
   // meter
   ctrlPos.y += (bSoloNone ? 0 : MUTE_SOLO_HEIGHT) + kDoubleInset;
   const int nMeterHeight =
      nGainSliderHeight -
      (MUSICAL_INSTRUMENT_HEIGHT_AND_WIDTH + kDoubleInset) -
      (PAN_HEIGHT + kDoubleInset) -
      (MUTE_SOLO_HEIGHT + (bSoloNone ? 0 : MUTE_SOLO_HEIGHT) + kDoubleInset);
   ctrlSize.Set(kRightSideStackWidth, nMeterHeight);
 
   mMeter.Release();
   if (GetWave()) {
      mMeter =
         safenew MeterPanel(mProject, // AudacityProject* project,
                   this, -1, // wxWindow* parent, wxWindowID id,
                   false, // bool isInput
                   ctrlPos, ctrlSize, // const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
                   MeterPanel::MixerTrackCluster); // Style style = HorizontalStereo,
      mMeter->SetName(XO("Signal Level Meter"));
   }
 
   #if wxUSE_TOOLTIPS
      mStaticText_TrackName->SetToolTip(mTrack->GetName());
      mToggleButton_Mute->SetToolTip(XO("Mute"));
      mToggleButton_Solo->SetToolTip(XO("Solo"));
      if (GetWave())
         mMeter->SetToolTip(XO("Signal Level Meter"));
   #endif // wxUSE_TOOLTIPS
 
   UpdateForStateChange();
 
   #ifdef __WXMAC__
      wxSizeEvent event(GetSize(), GetId());
      event.SetEventObject(this);
      GetEventHandler()->ProcessEvent(event);
   #endif
}

~MixerTrackCluster()

virtual MixerTrackCluster::~MixerTrackCluster ( )

inlinevirtual

Definition at line 89 of file MixerBoard.h.

{}

Member Function Documentation

GetRight()

WaveChannel * MixerTrackCluster::GetRight

(

)

const

Definition at line 346 of file MixerBoard.cpp.

{
  // TODO: more-than-two-channels
   auto left = GetWave();
   if (left) {
      auto channels = left->Channels();
      if (channels.size() > 1)
         return (* ++ channels.first).get();
   }
   return nullptr;
}

References GetWave().

Here is the call graph for this function:

GetTrackColor()

wxColour MixerTrackCluster::GetTrackColor ( )

private

Definition at line 702 of file MixerBoard.cpp.

{
   return wxColour(102, 255, 102); // same as Meter playback color
}

GetWave()

WaveTrack * MixerTrackCluster::GetWave

(

)

const

Definition at line 341 of file MixerBoard.cpp.

{
   return dynamic_cast< WaveTrack * >( mTrack.get() );
}

References mTrack.

Referenced by GetRight(), HandleSliderGain(), HandleSliderPan(), ResetMeter(), UpdateForStateChange(), and UpdateMeter().

Here is the caller graph for this function:

HandleResize()

void MixerTrackCluster::HandleResize

(

)

Definition at line 377 of file MixerBoard.cpp.

{
   wxSize scrolledWindowClientSize = this->GetParent()->GetClientSize();
   const int newClusterHeight =
      scrolledWindowClientSize.GetHeight() - kDoubleInset - // nClusterHeight from MixerBoard::UpdateTrackClusters
      wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y) + // wxScrolledWindow::GetClientSize doesn't account for its scrollbar size.
      kDoubleInset;
 
   this->SetSize(-1, newClusterHeight);
 
   // Change only the heights of mSlider_Gain and mMeter.
   // But update shown status of mToggleButton_Solo, which affects top of mMeter.
   const int nGainSliderHeight =
      newClusterHeight -
      (kInset + // margin above mStaticText_TrackName
         TRACK_NAME_HEIGHT + kDoubleInset) - // mStaticText_TrackName + margin
      kQuadrupleInset; // margin below gain slider
   mSlider_Gain->SetSize(-1, nGainSliderHeight);
#ifdef EXPERIMENTAL_MIDI_OUT
   mSlider_Velocity->SetSize(-1, nGainSliderHeight);
#endif
 
   bool bSoloNone = TracksBehaviorsSolo.ReadEnum() == SoloBehaviorNone;
 
   mToggleButton_Solo->Show(!bSoloNone);
 
   const int nRequiredHeightAboveMeter =
      MUSICAL_INSTRUMENT_HEIGHT_AND_WIDTH + kDoubleInset +
      PAN_HEIGHT + kDoubleInset +
      MUTE_SOLO_HEIGHT + (bSoloNone ? 0 : MUTE_SOLO_HEIGHT) + kDoubleInset;
   const int nMeterY =
      kDoubleInset + // margin at top
      TRACK_NAME_HEIGHT + kDoubleInset +
      nRequiredHeightAboveMeter;
   const int nMeterHeight = nGainSliderHeight - nRequiredHeightAboveMeter;
   if (mMeter)
      mMeter->SetSize(-1, nMeterY, -1, nMeterHeight);
}

References kDoubleInset, kInset, kQuadrupleInset, mMeter, mSlider_Gain, mToggleButton_Solo, MUSICAL_INSTRUMENT_HEIGHT_AND_WIDTH, MUTE_SOLO_HEIGHT, PAN_HEIGHT, SoloBehaviorNone, TRACK_NAME_HEIGHT, and TracksBehaviorsSolo.

HandleSelect()

void MixerTrackCluster::HandleSelect ( bool  bShiftDown, bool  bControlDown  )

private

Definition at line 710 of file MixerBoard.cpp.

{
   SelectUtilities::DoListSelection(*mProject,
      *mTrack, bShiftDown, bControlDown, true);
}

References SelectUtilities::DoListSelection(), mProject, and mTrack.

Referenced by OnButton_MusicalInstrument(), and OnMouseEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

HandleSliderGain()

void MixerTrackCluster::HandleSliderGain

(

const bool

bWantPushState = false

)

Definition at line 416 of file MixerBoard.cpp.

{
   float fValue = mSlider_Gain->Get();
   if (GetWave())
      GetWave()->SetGain(fValue);
 
   // Update the TrackPanel correspondingly.
   TrackPanel::Get( *mProject ).RefreshTrack(mTrack.get());
   if (bWantPushState)
      ProjectHistory::Get( *mProject )
         .PushState(XO("Moved gain slider"), XO("Gain"), UndoPush::CONSOLIDATE );
}

References CONSOLIDATE, ProjectHistory::Get(), TrackPanel::Get(), ASlider::Get(), GetWave(), mProject, mSlider_Gain, mTrack, ProjectHistory::PushState(), TrackPanel::RefreshTrack(), WaveTrack::SetGain(), and XO().

Referenced by MixerTrackSlider::OnMouseEvent(), and OnSlider_Gain().

Here is the call graph for this function:

Here is the caller graph for this function:

HandleSliderPan()

void MixerTrackCluster::HandleSliderPan

(

const bool

bWantPushState = false

)

Definition at line 445 of file MixerBoard.cpp.

{
   float fValue = mSlider_Pan->Get();
   if (GetWave()) // test in case track is a NoteTrack
      GetWave()->SetPan(fValue);
 
   // Update the TrackPanel correspondingly.
   TrackPanel::Get( *mProject ).RefreshTrack(mTrack.get());
 
   if (bWantPushState)
      ProjectHistory::Get( *mProject )
         .PushState(XO("Moved pan slider"), XO("Pan"),
            UndoPush::CONSOLIDATE );
}

References CONSOLIDATE, ProjectHistory::Get(), TrackPanel::Get(), ASlider::Get(), GetWave(), mProject, mSlider_Pan, mTrack, ProjectHistory::PushState(), TrackPanel::RefreshTrack(), WaveTrack::SetPan(), and XO().

Referenced by MixerTrackSlider::OnMouseEvent(), and OnSlider_Pan().

Here is the call graph for this function:

Here is the caller graph for this function:

OnButton_MusicalInstrument()

void MixerTrackCluster::OnButton_MusicalInstrument ( wxCommandEvent &  event )

private

Definition at line 751 of file MixerBoard.cpp.

{
   const auto &state = ::wxGetMouseState();
   this->HandleSelect(state.ShiftDown(), state.ControlDown());
}

References HandleSelect().

Here is the call graph for this function:

OnButton_Mute()

void MixerTrackCluster::OnButton_Mute ( wxCommandEvent &  event )

private

Definition at line 789 of file MixerBoard.cpp.

{
   TrackUtilities::DoTrackMute(
      *mProject, mTrack.get(), mToggleButton_Mute->WasShiftDown());
   mToggleButton_Mute->SetAlternateIdx(mTrack->GetSolo() ? 1 : 0);
 
   // Update the TrackPanel correspondingly.
   if (TracksBehaviorsSolo.ReadEnum() == SoloBehaviorSimple)
      Viewport::Get(*mProject).Redraw();
   else
      // Update only the changed track.
      TrackPanel::Get( *mProject ).RefreshTrack(mTrack.get());
}

References TrackUtilities::DoTrackMute(), Viewport::Get(), TrackPanel::Get(), mProject, mToggleButton_Mute, mTrack, Viewport::Redraw(), TrackPanel::RefreshTrack(), AButton::SetAlternateIdx(), SoloBehaviorSimple, TracksBehaviorsSolo, and AButton::WasShiftDown().

Here is the call graph for this function:

OnButton_Solo()

void MixerTrackCluster::OnButton_Solo ( wxCommandEvent &  event )

private

Definition at line 803 of file MixerBoard.cpp.

{
   TrackUtilities::DoTrackSolo(
      *mProject, mTrack.get(), mToggleButton_Solo->WasShiftDown());
   bool bIsSolo = mTrack->GetSolo();
   mToggleButton_Mute->SetAlternateIdx(bIsSolo ? 1 : 0);
 
   // Update the TrackPanel correspondingly.
   // Bug 509: Must repaint all, as many tracks can change with one Solo change.
   Viewport::Get(*mProject).Redraw();
}

References TrackUtilities::DoTrackSolo(), Viewport::Get(), mProject, mToggleButton_Mute, mToggleButton_Solo, mTrack, Viewport::Redraw(), AButton::SetAlternateIdx(), and AButton::WasShiftDown().

Here is the call graph for this function:

OnKeyEvent()

void MixerTrackCluster::OnKeyEvent ( wxKeyEvent &  event )

private

OnMouseEvent()

void MixerTrackCluster::OnMouseEvent ( wxMouseEvent &  event )

private

Definition at line 716 of file MixerBoard.cpp.

{
   if (event.ButtonUp())
      this->HandleSelect(event.ShiftDown(), event.ControlDown());
   else
      event.Skip();
}

References HandleSelect().

Here is the call graph for this function:

OnPaint()

void MixerTrackCluster::OnPaint ( wxPaintEvent &  evt )

private

Definition at line 724 of file MixerBoard.cpp.

{
   UpdateForStateChange();
 
   auto selected = mTrack->GetSelected();
 
   wxColour col = theTheme.Colour(selected ? clrTrackInfoSelected : clrTrackInfo) ;
   SetBackgroundColour( col );
   if (mMeter)
      mMeter->SetBackgroundColour( col );
   mStaticText_TrackName->SetBackgroundColour( col );
   mSlider_Gain->SetBackgroundColour( col );
   mSlider_Pan->SetBackgroundColour( col );
 
   wxPaintDC dc(this);
 
   AColor::MediumTrackInfo(&dc, selected);
   dc.DrawRectangle(this->GetClientRect());
 
   wxSize clusterSize = this->GetSize();
   wxRect bev(0, 0, clusterSize.GetWidth() - 1, clusterSize.GetHeight() - 1);
 
   //bev.Inflate(-1, -1);
   AColor::Bevel(dc, true, bev);// same bevel whether selected or not.
}

References AColor::Bevel(), ThemeBase::Colour(), AColor::MediumTrackInfo(), mMeter, mSlider_Gain, mSlider_Pan, mStaticText_TrackName, mTrack, ASlider::SetBackgroundColour(), theTheme, and UpdateForStateChange().

Here is the call graph for this function:

OnSlider_Gain()

void MixerTrackCluster::OnSlider_Gain ( wxCommandEvent &  event )

private

Definition at line 757 of file MixerBoard.cpp.

{
   this->HandleSliderGain();
}

References HandleSliderGain().

Here is the call graph for this function:

OnSlider_Pan()

void MixerTrackCluster::OnSlider_Pan ( wxCommandEvent &  event )

private

Definition at line 784 of file MixerBoard.cpp.

{
   this->HandleSliderPan();
}

References HandleSliderPan().

Here is the call graph for this function:

ResetMeter()

void MixerTrackCluster::ResetMeter

(

const bool

bResetClipping

)

Definition at line 460 of file MixerBoard.cpp.

{
   if (mMeter)
      mMeter->Reset(GetWave()->GetRate(), bResetClipping);
   // Release view to allow cache eviction after/before playback.
   mSampleView.clear();
}

References anonymous_namespace{TimeTrack.cpp}::GetRate(), GetWave(), mMeter, and mSampleView.

Referenced by UpdateMeter().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateForStateChange()

void MixerTrackCluster::UpdateForStateChange

(

)

Definition at line 470 of file MixerBoard.cpp.

{
   const wxString newName = mTrack->GetName();
   if (newName != GetName()) {
      SetName( Verbatim( newName ) );
      mStaticText_TrackName->SetLabel(newName);
      mStaticText_TrackName->SetName(newName);
#if wxUSE_TOOLTIPS
         mStaticText_TrackName->SetToolTip(newName);
#endif
      mBitmapButton_MusicalInstrument->SetBitmapLabel(
         *(mMixerBoard->GetMusicalInstrumentBitmap(mTrack.get())));
   }
 
   mToggleButton_Mute->SetAlternateIdx(mTrack->GetSolo() ? 1 : 0);
   if (mTrack->GetMute())
      mToggleButton_Mute->PushDown();
   else
      mToggleButton_Mute->PopUp();
 
   bool bIsSolo = mTrack->GetSolo();
   if (bIsSolo)
      mToggleButton_Solo->PushDown();
   else
      mToggleButton_Solo->PopUp();
   mToggleButton_Mute->SetAlternateIdx(bIsSolo ? 1 : 0);
 
   if (!GetWave())
      mSlider_Pan->Hide();
   else
      mSlider_Pan->Set(GetWave()->GetPan());
 
   if (!GetWave())
      mSlider_Gain->Hide();
   else
      mSlider_Gain->Set(GetWave()->GetGain());
 
#ifdef EXPERIMENTAL_MIDI_OUT
   if (!GetNote())
      mSlider_Velocity->Hide();
   else
      mSlider_Velocity->Set(GetNote()->GetVelocity());
#endif
}

References MixerBoard::GetMusicalInstrumentBitmap(), GetWave(), mBitmapButton_MusicalInstrument, mMixerBoard, mSlider_Gain, mSlider_Pan, mStaticText_TrackName, mToggleButton_Mute, mToggleButton_Solo, mTrack, AButton::PopUp(), AButton::PushDown(), ASlider::Set(), AButton::SetAlternateIdx(), wxPanelWrapper::SetName(), and Verbatim().

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateMeter()

void MixerTrackCluster::UpdateMeter	(	const double	t0,
		const double	t1
	)

Definition at line 538 of file MixerBoard.cpp.

{
   // NoteTracks do not (currently) register on meters. It would probably be
   // a good idea to display 16 channel "active" lights rather than a meter
   if (!GetWave())
      return;
 
   if ((t0 < 0.0) || (t1 < 0.0) || (t0 >= t1) || // bad time value or nothing to show
         ((mMixerBoard->HasSolo() || mTrack->GetMute()) && !mTrack->GetSolo())
      )
   {
      //v Vaughan, 2011-02-25: Moved the update back to TrackPanel::OnTimer() as it helps with
      //    playback issues reported by Bill and noted on Bug 258, so no assert.
      // Vaughan, 2011-02-04: Now that we're updating all meters from audacityAudioCallback,
      //    this causes an assert if you click Mute while playing, because ResetMeter() resets
      //    the timer, and wxTimerbase says that can only be done from main thread --
      //    but it seems to work fine.
      this->ResetMeter(false);
      return;
   }
 
   // Vaughan, 2010-11-27:
   // This commented out code is flawed. Mistaken understanding of "frame" vs "window".
   // Caused me to override MeterPanel::UpdateDisplay().
   // But I think it's got a good idea, of calling WaveTracks' GetMinMax and GetRMS
   // instead of passing in all the data and asking the meter to derive peak and rms.
   // May be worth revisiting as I think it should perform better, because it uses the min/max/rms
   // stored in sample blocks, rather than calculating them, but for now, changing it to use the
   // original MeterPanel::UpdateDisplay(). New code is below the previous (now commented out).
   //
   //const size_t kFramesPerBuffer = 4;
   //float min; // dummy, since it's not shown in meters
   //Floats maxLeft{kFramesPerBuffer};
   //Floats rmsLeft{kFramesPerBuffer};
   //Floats maxRight{kFramesPerBuffer};
   //Floats rmsRight{kFramesPerBuffer};
   //
   //#ifdef EXPERIMENTAL_MIDI_OUT
   //   bool bSuccess = (GetWave() != nullptr);
   //#else
   //   bool bSuccess = true;
   //#endif
 
   //const double dFrameInterval = (t1 - t0) / (double)kFramesPerBuffer;
   //double dFrameT0 = t0;
   //double dFrameT1 = t0 + dFrameInterval;
   //int i = 0;
   //while (bSuccess && (i < kFramesPerBuffer))
   //{
   //   bSuccess &=
   //      mTrack->GetMinMax(&min, &(maxLeft[i]), dFrameT0, dFrameT1) &&
   //      mTrack->GetRMS(&(rmsLeft[i]), dFrameT0, dFrameT1);
   //   if (bSuccess && mRightTrack)
   //      bSuccess &=
   //         mRightTrack->GetMinMax(&min, &(maxRight[i]), dFrameT0, dFrameT1) &&
   //         mRightTrack->GetRMS(&(rmsRight[i]), dFrameT0, dFrameT1);
   //   else
   //   {
   //      // Mono: Start with raw values same as left.
   //      // To be modified by bWantPostFadeValues and channel pan/gain.
   //      maxRight[i] = maxLeft[i];
   //      rmsRight[i] = rmsLeft[i];
   //   }
   //   dFrameT0 += dFrameInterval;
   //   dFrameT1 += dFrameInterval;
   //   i++;
   //}
   //
   //const bool bWantPostFadeValues = true; //v Turn this into a checkbox on MixerBoard? For now, always true.
   //if (bSuccess && bWantPostFadeValues)
   //if (bSuccess)
   //{
   //   for (i = 0; i < kFramesPerBuffer; i++)
   //   {
   //      float gain = mTrack->GetChannelGain(0);
   //      maxLeft[i] *= gain;
   //      rmsLeft[i] *= gain;
   //      if (mRightTrack)
   //         gain = mRightTrack->GetChannelGain(1);
   //      maxRight[i] *= gain;
   //      rmsRight[i] *= gain;
   //   }
   //   if ( mMeter ) mMeter->UpdateDisplay(
   //      2, // If mono, show left track values in both meters, as in MeterToolBar, rather than nChannels.
   //      kFramesPerBuffer,
   //      maxLeft, rmsLeft,
   //      maxRight, rmsRight,
   //      mTrack->TimeToLongSamples(t1 - t0));
   //}
   //
 
   // PRL: TODO:  don't fetch from wave tracks at calculated times, for update
   // of the meter display, but instead consult PlaybackPolicy
 
   const auto pTrack = GetWave();
 
   // Don't throw on read error in this drawing update routine
   constexpr auto mayThrow = false;
 
   // Not sure how to prove satisfaction of the invariant of GetSampleView
   mSampleView = pTrack->GetSampleView(t0, t1, mayThrow);
 
   // Expect that the difference of t1 and t0 is the part of a track played
   // in about 1/20 second (ticks of TrackPanel timer), so this won't overflow,
   // unless stretch ratio is extremely low.
   const auto nFrames = GetNumSamplesInView(mSampleView[0]);
 
   Floats tempFloatsArray;
   try {
      tempFloatsArray.reinit(nFrames);
   }
   catch (const std::bad_alloc&) {
      // Just in case we did not satisfy GetSampleView and computed a bogus
      // size_t value
      return;
   }
   FillBufferWithSampleView(tempFloatsArray.get(), mSampleView[0]);
 
   decltype(tempFloatsArray) meterFloatsArray;
   // We always pass a stereo sample array to the meter, as it shows 2 channels.
   // Mono shows same in both meters.
   // Since we're not mixing, need to duplicate same signal for "right" channel in mono case.
   try {
      meterFloatsArray.reinit(2 * nFrames );
   }
   catch (const std::bad_alloc&) {
      // Just in case we did not satisfy GetSampleView and computed a bogus
      // size_t value
      return;
   }
 
   // Interleave for stereo. Left/mono first.
   for (unsigned int index = 0; index < nFrames; index++)
      meterFloatsArray[2 * index] = tempFloatsArray[index];
 
   if (mSampleView.size() > 1u)
      FillBufferWithSampleView(tempFloatsArray.get(), mSampleView[1]);
 
   // Interleave right channel, or duplicate same signal for "right" channel in mono case.
   for (unsigned int index = 0; index < nFrames; index++)
      meterFloatsArray[(2 * index) + 1] = tempFloatsArray[index];
 
   //const bool bWantPostFadeValues = true; //v Turn this into a checkbox on MixerBoard? For now, always true.
   //if (bSuccess && bWantPostFadeValues)
   //vvv Need to apply envelope, too? See Mixer::MixSameRate.
   float gain = pTrack->GetChannelGain(0);
   for (unsigned int index = 0; index < nFrames; index++)
      meterFloatsArray[2 * index] *= gain;
   gain = pTrack->GetChannelGain(1);
   for (unsigned int index = 0; index < nFrames; index++)
      meterFloatsArray[(2 * index) + 1] *= gain;
   // Clip to [-1.0, 1.0] range.
   for (unsigned int index = 0; index < 2 * nFrames; index++)
      if (meterFloatsArray[index] < -1.0)
         meterFloatsArray[index] = -1.0;
      else if (meterFloatsArray[index] > 1.0)
         meterFloatsArray[index] = 1.0;
 
   if (mMeter)
      mMeter->UpdateDisplay(2, nFrames, meterFloatsArray.get());
}

References anonymous_namespace{MixerBoard.cpp}::FillBufferWithSampleView(), anonymous_namespace{MixerBoard.cpp}::GetNumSamplesInView(), GetWave(), MixerBoard::HasSolo(), mMeter, mMixerBoard, mSampleView, mTrack, ArrayOf< X >::reinit(), and ResetMeter().

Here is the call graph for this function:

Member Data Documentation

mBitmapButton_MusicalInstrument

wxBitmapButton* MixerTrackCluster::mBitmapButton_MusicalInstrument

private

Definition at line 142 of file MixerBoard.h.

Referenced by UpdateForStateChange().

mMeter

wxWeakRef<MeterPanel> MixerTrackCluster::mMeter

private

Definition at line 150 of file MixerBoard.h.

Referenced by HandleResize(), OnPaint(), ResetMeter(), and UpdateMeter().

mMixerBoard

MixerBoard* MixerTrackCluster::mMixerBoard

private

Definition at line 137 of file MixerBoard.h.

Referenced by UpdateForStateChange(), and UpdateMeter().

mProject

AudacityProject* MixerTrackCluster::mProject

private

Definition at line 138 of file MixerBoard.h.

Referenced by HandleSelect(), HandleSliderGain(), HandleSliderPan(), OnButton_Mute(), and OnButton_Solo().

mSampleView

ChannelGroupSampleView MixerTrackCluster::mSampleView

private

Definition at line 151 of file MixerBoard.h.

Referenced by ResetMeter(), and UpdateMeter().

mSlider_Gain

MixerTrackSlider* MixerTrackCluster::mSlider_Gain

private

Definition at line 146 of file MixerBoard.h.

Referenced by HandleResize(), HandleSliderGain(), OnPaint(), and UpdateForStateChange().

mSlider_Pan

MixerTrackSlider* MixerTrackCluster::mSlider_Pan

private

Definition at line 145 of file MixerBoard.h.

Referenced by HandleSliderPan(), OnPaint(), and UpdateForStateChange().

mStaticText_TrackName

auStaticText* MixerTrackCluster::mStaticText_TrackName

private

Definition at line 141 of file MixerBoard.h.

Referenced by OnPaint(), and UpdateForStateChange().

mToggleButton_Mute

AButton* MixerTrackCluster::mToggleButton_Mute

private

Definition at line 143 of file MixerBoard.h.

Referenced by OnButton_Mute(), OnButton_Solo(), and UpdateForStateChange().

mToggleButton_Solo

AButton* MixerTrackCluster::mToggleButton_Solo

private

Definition at line 144 of file MixerBoard.h.

Referenced by HandleResize(), OnButton_Solo(), and UpdateForStateChange().

mTrack

std::shared_ptr<PlayableTrack> MixerTrackCluster::mTrack

Definition at line 134 of file MixerBoard.h.

Referenced by GetWave(), HandleSelect(), HandleSliderGain(), HandleSliderPan(), OnButton_Mute(), OnButton_Solo(), OnPaint(), UpdateForStateChange(), and UpdateMeter().

---

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

• MixerBoard.h
• MixerBoard.cpp