LyricsPanel Class Reference

LyricsPanel is a panel that paints the bouncing ball and the lyrics text. More...

#include <Lyrics.h>

Inheritance diagram for LyricsPanel:

Collaboration diagram for LyricsPanel:

Public Member Functions
	LyricsPanel (wxWindow *parent, wxWindowID id, AudacityProject *project, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize)
virtual	~LyricsPanel ()
int	FindSyllable (long startChar)
int	GetCurrentSyllableIndex ()
Syllable *	GetSyllable (int nSyl)
void	SetCurrentSyllableIndex (int nSyl)
LyricsStyle	GetLyricsStyle ()
void	SetLyricsStyle (const LyricsStyle newLyricsStyle)
void	Update (double t)
void	UpdateLyrics (struct UndoRedoMessage)
void	DoUpdateLyrics ()
void	OnShow (wxShowEvent &e)
void	OnStartStop (AudioIOEvent)
void	OnKeyEvent (wxKeyEvent &event)
void	DoPaint (wxDC &dc)
void	OnPaint (wxPaintEvent &evt)
void	OnSize (wxSizeEvent &evt)
void	HandlePaint (wxDC &dc)
void	HandlePaint_BouncingBall (wxDC &dc)
void	HandleLayout ()
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 Member Functions inherited from NonKeystrokeInterceptingWindow
virtual	~NonKeystrokeInterceptingWindow ()

Private Types
enum	LyricsStyle { kBouncingBallLyrics , kHighlightLyrics }

Private Member Functions
void	Clear ()
void	AddLabels (const LabelTrack *pLT)
void	Finish (double finalT)
void	Add (double t, const wxString &syllable, wxString &highlightText)
unsigned int	GetDefaultFontSize () const
void	SetDrawnFont (wxDC *dc)
void	SetHighlightFont ()
void	Measure (wxDC *dc)
int	FindSyllable (double t)
void	GetKaraokePosition (double t, int *outX, double *outY)

Private Attributes
Observer::Subscription	mAudioIOSubscription
Observer::Subscription	mUndoSubscription
int	mWidth
int	mHeight
int	mKaraokeHeight
unsigned int	mKaraokeFontSize
LyricsStyle	mLyricsStyle
HighlightTextCtrl *	mHighlightTextCtrl
double	mT
int	mCurrentSyllable
std::vector< Syllable >	mSyllables
wxString	mText
int	mTextHeight
bool	mMeasurementsDone
wxWeakRef< AudacityProject >	mProject
bool	mDelayedUpdate { false }

Detailed Description

LyricsPanel is a panel that paints the bouncing ball and the lyrics text.

Definition at line 76 of file Lyrics.h.

Member Enumeration Documentation

LyricsStyle

enum LyricsPanel::LyricsStyle

private

Enumerator
kBouncingBallLyrics
kHighlightLyrics

Definition at line 82 of file Lyrics.h.

                    {
      kBouncingBallLyrics, // Lyrics move from right to left with bouncing ball.
      // kGuitarTab,       //v <<future>> Guitar Tablature moves from right to left.
      kHighlightLyrics,    // Lyrics show in scrolling page and syllables highlight successively.
   };

Constructor & Destructor Documentation

LyricsPanel()

LyricsPanel::LyricsPanel	(	wxWindow *	parent,
		wxWindowID	id,
		AudacityProject *	project,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize
	)

Definition at line 89 of file Lyrics.cpp.

                                     :
   wxPanelWrapper(parent, id, pos, size, wxWANTS_CHARS),
   mWidth(size.x), mHeight(size.y)
   , mProject(project)
{
   mKaraokeHeight = mHeight;
   mLyricsStyle = kBouncingBallLyrics; // default
   mKaraokeFontSize = this->GetDefaultFontSize(); // Call only after mLyricsPanelStyle is set.
 
   this->SetBackgroundColour(*wxWHITE);
 
   mHighlightTextCtrl =
      safenew HighlightTextCtrl(this, -1, // wxWindow* parent, wxWindowID id,
                              wxT(""), // const wxString& value = {},
                              wxPoint(0, 0), // const wxPoint& pos = wxDefaultPosition,
                              size); // const wxSize& size = wxDefaultSize
   this->SetHighlightFont();
   mHighlightTextCtrl->Show(mLyricsStyle == kHighlightLyrics); // test, in case we conditionalize the default, above
 
 
   mT = 0.0;
 
   Clear();
   Finish(0.0);
 
   #ifdef __WXMAC__
      wxSizeEvent dummyEvent;
      OnSize(dummyEvent);
   #endif
 
   parent->Bind(wxEVT_SHOW, &LyricsPanel::OnShow, this);
 
   if (project)
      mUndoSubscription = UndoManager::Get(*project)
         .Subscribe(*this, &LyricsPanel::UpdateLyrics);
 
   mAudioIOSubscription =
      AudioIO::Get()->Subscribe(*this, &LyricsPanel::OnStartStop);
}

References AudioIO::Get(), UndoManager::Get(), OnShow(), OnSize(), OnStartStop(), safenew, size, Observer::Publisher< Message, NotifyAll >::Subscribe(), UpdateLyrics(), and wxT().

Here is the call graph for this function:

~LyricsPanel()

LyricsPanel::~LyricsPanel ( )

virtual

Definition at line 132 of file Lyrics.cpp.

{
}

Member Function Documentation

Add()

void LyricsPanel::Add ( double  t, const wxString &  syllable, wxString &  highlightText  )

private

Definition at line 163 of file Lyrics.cpp.

{
   int i = mSyllables.size();
 
   {
      Syllable &prevSyllable = mSyllables[i - 1];
 
      if (prevSyllable.t == t) {
         // We can't have two syllables with the same time, so append
         // this to the end of the previous one if they're at the
         // same time.
         prevSyllable.text += syllable;
         prevSyllable.textWithSpace += syllable;
         prevSyllable.char1 += syllable.length();
         return;
      }
   }
 
   mSyllables.push_back(Syllable());
   Syllable &thisSyllable = mSyllables[i];
   thisSyllable.t = t;
   thisSyllable.text = syllable;
 
   thisSyllable.char0 = mText.length();
 
   // Put a space between syllables unless the previous one
   // ended in a hyphen
   if (i > 0 &&
         // mSyllables[i-1].text.length() > 0 &&
         mSyllables[i - 1].text.Right(1) != wxT("-"))
      thisSyllable.textWithSpace = wxT(" ") + syllable;
   else
      thisSyllable.textWithSpace = syllable;
 
   mText += thisSyllable.textWithSpace;
   thisSyllable.char1 = mText.length();
 
   int nTextLen = thisSyllable.textWithSpace.length();
   if ((nTextLen > 0) && (thisSyllable.textWithSpace.Right(1) == wxT("_")))
      highlightText += (thisSyllable.textWithSpace.Left(nTextLen - 1) + wxT("\n"));
   else
      highlightText += thisSyllable.textWithSpace;
}

References Syllable::char0, Syllable::char1, mSyllables, mText, Syllable::t, Syllable::text, Syllable::textWithSpace, and wxT().

Referenced by AddLabels().

Here is the call graph for this function:

Here is the caller graph for this function:

AddLabels()

void LyricsPanel::AddLabels ( const LabelTrack *  pLT )

private

Definition at line 152 of file Lyrics.cpp.

{
   const size_t numLabels = pLT->GetNumLabels();
   wxString highlightText;
   for (size_t ii = 0; ii < numLabels; ++ii) {
      const LabelStruct *const pLabel = pLT->GetLabel(ii);
      Add(pLabel->getT0(), pLabel->title, highlightText);
   }
   mHighlightTextCtrl->AppendText(highlightText);
}

References Add(), LabelTrack::GetLabel(), LabelTrack::GetNumLabels(), LabelStruct::getT0(), mHighlightTextCtrl, and LabelStruct::title.

Referenced by DoUpdateLyrics().

Here is the call graph for this function:

Here is the caller graph for this function:

Clear()

void LyricsPanel::Clear ( )

private

Definition at line 138 of file Lyrics.cpp.

{
   mSyllables.clear();
   mText = wxT("");
 
   // Add two dummy syllables at the beginning
   mSyllables.push_back(Syllable());
   mSyllables[0].t = -2.0;
   mSyllables.push_back(Syllable());
   mSyllables[1].t = -1.0;
 
   mHighlightTextCtrl->Clear();
}

References mHighlightTextCtrl, mSyllables, mText, and wxT().

Referenced by DoUpdateLyrics().

Here is the call graph for this function:

Here is the caller graph for this function:

DoPaint()

void LyricsPanel::DoPaint

(

wxDC &

dc

)

Definition at line 557 of file Lyrics.cpp.

{
   if (!this->GetParent()->IsShown())
      return;
 
   if (mLyricsStyle == kBouncingBallLyrics)
   {
      if (!mMeasurementsDone)
         Measure(&dc);
 
      #ifdef __WXMAC__
         // Mac OS X automatically double-buffers the screen for you,
         // so our bitmap is unnecessary
         HandlePaint(dc);
      #else
         wxBitmap bitmap(mWidth, mKaraokeHeight);
         wxMemoryDC memDC;
         memDC.SelectObject(bitmap);
         HandlePaint(memDC);
         dc.Blit(0, 0, mWidth, mKaraokeHeight, &memDC, 0, 0, wxCOPY, FALSE);
      #endif
   }
   else // (mLyricsStyle == kHighlightLyrics)
   {
      //v causes flicker in ported version
      //    this->SetHighlightFont();
   }
}

References HandlePaint(), kBouncingBallLyrics, Measure(), mKaraokeHeight, mLyricsStyle, mMeasurementsDone, and mWidth.

Referenced by OnPaint(), and OnSize().

Here is the call graph for this function:

Here is the caller graph for this function:

DoUpdateLyrics()

void LyricsPanel::DoUpdateLyrics

(

)

Definition at line 492 of file Lyrics.cpp.

{
   // It's crucial to not do that repopulating during playback.
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO->IsStreamActive()) {
      mDelayedUpdate = true;
      return;
   }
 
   Clear();
 
   if (!mProject)
      return;
 
   // Lyrics come from only the first label track.
   auto pLabelTrack =
      *TrackList::Get( *mProject ).Any< const LabelTrack >().begin();
   if (!pLabelTrack)
      return;
 
   // The code that updates the lyrics is rather expensive when there
   // are a lot of labels.
   // So - bail out early if the lyrics window is not visible.
   // We will later force an update when the lyrics window is made visible.
   auto parent = dynamic_cast<wxFrame*>(GetParent());
   if( !(parent && parent->IsVisible()) )
      return;
 
   AddLabels(pLabelTrack);
   Finish(pLabelTrack->GetEndTime());
   const auto &selectedRegion = ViewInfo::Get( *mProject ).selectedRegion;
   Update(selectedRegion.t0());
}

References AddLabels(), TrackList::Any(), Clear(), Finish(), AudioIOBase::Get(), ViewInfo::Get(), TrackList::Get(), mDelayedUpdate, mProject, ViewInfo::selectedRegion, and Update().

Referenced by OnShow(), OnStartStop(), and UpdateLyrics().

Here is the call graph for this function:

Here is the caller graph for this function:

FindSyllable() [1/2]

int LyricsPanel::FindSyllable ( double  t )

private

Definition at line 333 of file Lyrics.cpp.

{
   int i1, i2;
 
   i1 = 0;
   i2 = mSyllables.size();
   while (i2 > i1+1) {
      int pmid = (i1+i2)/2;
      if (mSyllables[pmid].t > t)
         i2 = pmid;
      else
         i1 = pmid;
   }
 
   if (i1 < 2)
      i1 = 2;
   if (i1 > (int)(mSyllables.size()) - 3)
      i1 = mSyllables.size() - 3;
 
   return i1;
}

References mSyllables.

FindSyllable() [2/2]

int LyricsPanel::FindSyllable

(

long

startChar

)

Definition at line 225 of file Lyrics.cpp.

{
   int i1, i2;
 
   i1 = 0;
   i2 = mSyllables.size();
   while (i2 > i1+1) {
      int pmid = (i1+i2)/2;
      if (mSyllables[pmid].char0 > startChar)
         i2 = pmid;
      else
         i1 = pmid;
   }
 
   if (i1 < 2)
      i1 = 2;
   if (i1 > (int)(mSyllables.size()) - 3)
      i1 = mSyllables.size() - 3;
 
   return i1;
}

References mSyllables.

Referenced by GetKaraokePosition(), HighlightTextCtrl::OnMouseEvent(), and Update().

Here is the caller graph for this function:

Finish()

void LyricsPanel::Finish ( double  finalT )

private

Definition at line 207 of file Lyrics.cpp.

{
   // Add 3 dummy syllables at the end
   int i = mSyllables.size();
   mSyllables.push_back(Syllable());
   mSyllables[i].t = finalT + 1.0;
   mSyllables.push_back(Syllable());
   mSyllables[i+1].t = finalT + 2.0;
   mSyllables.push_back(Syllable());
   mSyllables[i+2].t = finalT + 3.0;
 
   // Mark measurements as invalid
   mMeasurementsDone = false; // only for drawn text
   mCurrentSyllable = 0;
   mHighlightTextCtrl->ShowPosition(0);
}

References mCurrentSyllable, mHighlightTextCtrl, mMeasurementsDone, and mSyllables.

Referenced by DoUpdateLyrics().

Here is the caller graph for this function:

GetCurrentSyllableIndex()

int LyricsPanel::GetCurrentSyllableIndex ( )

inline

Definition at line 96 of file Lyrics.h.

{ return mCurrentSyllable; };

References mCurrentSyllable.

Referenced by HighlightTextCtrl::OnMouseEvent().

Here is the caller graph for this function:

GetDefaultFontSize()

unsigned int LyricsPanel::GetDefaultFontSize ( ) const

private

Definition at line 260 of file Lyrics.cpp.

{
   return (mLyricsStyle == kBouncingBallLyrics) ? 48 : 10;
}

References kBouncingBallLyrics, and mLyricsStyle.

Referenced by OnSize().

Here is the caller graph for this function:

GetKaraokePosition()

void LyricsPanel::GetKaraokePosition ( double  t, int *  outX, double *  outY  )

private

Definition at line 362 of file Lyrics.cpp.

{
   *outX = 0;
   *outY = 0;
 
   if (t < mSyllables[I_FIRST_REAL_SYLLABLE].t || t > mSyllables[mSyllables.size() - 3].t)
      return;
 
   int i0, i1, i2, i3;
   int x0, x1, x2, x3;
   double t0, t1, t2, t3;
   i1 = FindSyllable(t);
   i2 = i1 + 1;
 
   // Because we've padded the syllables with two dummies at the beginning
   // and end, we know that i0...i3 will always exist.  Also, we've made
   // sure that we don't ever have two of the same time, so t2>t1 strictly.
   //
   //                          t
   //                          \/
   // time:  t0           t1                 t2              t3
   // pos:   x0           x1                 x2              x3
   // index: i0           i1                 i2              i3
   // vel:               vel1               vel2
 
   i0 = i1 - 1;
   i3 = i2 + 1;
 
   x0 = mSyllables[i0].x;
   x1 = mSyllables[i1].x;
   x2 = mSyllables[i2].x;
   x3 = mSyllables[i3].x;
 
   t0 = mSyllables[i0].t;
   t1 = mSyllables[i1].t;
   t2 = mSyllables[i2].t;
   t3 = mSyllables[i3].t;
 
   double linear_vel0 = (x1 - x0) / (t1 - t0);
   double linear_vel1 = (x2 - x1) / (t2 - t1);
   double linear_vel2 = (x3 - x2) / (t3 - t2);
 
   // average velocities
   double v1 = (linear_vel0 + linear_vel1) / 2;
   double v2 = (linear_vel1 + linear_vel2) / 2;
 
   // Solve a cubic equation f(t) = at^3 + bt^2 + ct + d
   // which gives the position x as a function of
   // (t - t1), by constraining f(0), f'(0), f(t2-t1), f'(t2-t1)
   double delta_t = t2 - t1;
   double delta_x = x2 - x1;
   v1 *= delta_t;
   v2 *= delta_t;
   double a = v1 + v2 - 2*delta_x;
   double b = 3*delta_x - 2*v1 - v2;
   double c = v1;
   double d = x1;
 
   t = (t - t1) / (t2 - t1);
   double xx = a*t*t*t + b*t*t + c*t + d;
 
   // Unfortunately sometimes our cubic goes backwards.  This is a quick
   // hack to stop that from happening.
   if (xx < x1)
      xx = x1;
 
   *outX = (int)xx;
 
   // The y position is a simple cosine curve; the max height is a
   // function of the time.
   double height = t2 - t1 > 4.0? 1.0: sqrt((t2-t1)/4.0);
   *outY = height * sin(M_PI * t);
}

References FindSyllable(), I_FIRST_REAL_SYLLABLE, M_PI, and mSyllables.

Referenced by HandlePaint_BouncingBall().

Here is the call graph for this function:

Here is the caller graph for this function:

GetLyricsStyle()

LyricsStyle LyricsPanel::GetLyricsStyle ( )

inline

Definition at line 100 of file Lyrics.h.

{ return mLyricsStyle; };

References mLyricsStyle.

GetSyllable()

Syllable * LyricsPanel::GetSyllable ( int  nSyl )

inline

Definition at line 97 of file Lyrics.h.

{ return &(mSyllables[nSyl]); };

References mSyllables.

Referenced by HighlightTextCtrl::OnMouseEvent().

Here is the caller graph for this function:

HandleLayout()

void LyricsPanel::HandleLayout

(

)

HandlePaint()

void LyricsPanel::HandlePaint

(

wxDC &

dc

)

Definition at line 622 of file Lyrics.cpp.

{
   wxASSERT(mLyricsStyle == kBouncingBallLyrics);
   dc.SetBrush(*wxWHITE_BRUSH);
   dc.DrawRectangle(0, 0, mWidth, mKaraokeHeight);
 
   this->HandlePaint_BouncingBall(dc);
}

References HandlePaint_BouncingBall(), kBouncingBallLyrics, mKaraokeHeight, mLyricsStyle, and mWidth.

Referenced by DoPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

HandlePaint_BouncingBall()

void LyricsPanel::HandlePaint_BouncingBall

(

wxDC &

dc

)

Definition at line 631 of file Lyrics.cpp.

{
   int ctr = mWidth / 2;
   int x;
   double y;
   GetKaraokePosition(mT, &x, &y);
 
   dc.SetTextForeground(wxColour(238, 0, 102));
   bool changedColor = false;
 
   SetDrawnFont(&dc);
   unsigned int i;
   wxCoord yTextTop = mKaraokeHeight - mTextHeight - 4;
   for(i = 0; i < mSyllables.size(); i++) {
      if (mSyllables[i].x + mSyllables[i].width < (x - ctr))
         continue;
      if (mSyllables[i].x > x + ctr)
         continue;
 
      if (!changedColor && mSyllables[i].x >= x) {
         dc.SetTextForeground(*wxBLACK);
         changedColor = true;
      }
 
      wxString text = mSyllables[i].text;
      if (text.length() > 0 && text.Right(1) == wxT("_")) {
         text = text.Left(text.length() - 1);
      }
 
      dc.DrawText(text,
                  mSyllables[i].leftX + ctr - x,
                  yTextTop);
   }
 
   int ballRadius = (int)(mTextHeight / 8.0);
   int bounceTop = ballRadius * 2;
   int bounceHeight = yTextTop - bounceTop;
   int yi = (int)(yTextTop - 4 - (y * bounceHeight));
 
   if (mT >= 0.0) {
      wxRect ball(ctr - ballRadius, yi - ballRadius, 2 * ballRadius, 2 * ballRadius);
      dc.SetBrush(wxBrush(wxColour(238, 0, 102), wxBRUSHSTYLE_SOLID));
      dc.DrawEllipse(ball);
   }
}

References GetKaraokePosition(), mKaraokeHeight, mSyllables, mT, mTextHeight, mWidth, SetDrawnFont(), and wxT().

Referenced by HandlePaint().

Here is the call graph for this function:

Here is the caller graph for this function:

Measure()

void LyricsPanel::Measure ( wxDC *  dc )

private

Definition at line 278 of file Lyrics.cpp.

{
   this->SetDrawnFont(dc);
   int width = 0, height = 0;
 
   const int kIndent = 4;
   int x = 2*kIndent;
 
   unsigned int i;
   for(i = 0; i < mSyllables.size(); i++) {
      if ((i < I_FIRST_REAL_SYLLABLE) || // Clear() starts the list with I_FIRST_REAL_SYLLABLE dummies.
            (i >= mSyllables.size() - 3)) // Finish() ends with 3 dummies.
      {
         dc->GetTextExtent(wxT("DUMMY"), &width, &height); // Get the correct height even if we're at i=0.
         width = 0;
      }
      else {
         dc->GetTextExtent(mSyllables[i].textWithSpace, &width, &height);
      }
 
      // Add some space between words; the space is normally small but
      // when there's a long pause relative to the previous word, insert
      // extra space.
      int extraWidth;
      if (i >= I_FIRST_REAL_SYLLABLE && i < mSyllables.size() - 2)
      {
         double deltaThis = mSyllables[i+1].t - mSyllables[i].t;
         double deltaPrev = mSyllables[i].t - mSyllables[i-1].t;
 
         double ratio;
         if (deltaPrev > 0.0)
            ratio = deltaThis / deltaPrev;
         else
            ratio = deltaThis;
 
         if (ratio > 2.0)
            extraWidth = 15 + (int)(15.0 * ratio);
         else
            extraWidth = 15;
      }
      else
         extraWidth = 20;
 
      mSyllables[i].width = width + extraWidth;
      mSyllables[i].leftX = x;
      mSyllables[i].x = x + width/2;
      x += mSyllables[i].width;
   }
 
   mTextHeight = height;
 
   mMeasurementsDone = true;
}

References I_FIRST_REAL_SYLLABLE, mMeasurementsDone, mSyllables, mTextHeight, SetDrawnFont(), and wxT().

Referenced by DoPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

OnKeyEvent()

void LyricsPanel::OnKeyEvent

(

wxKeyEvent &

event

)

Definition at line 543 of file Lyrics.cpp.

{
   auto project = FindProjectFromWindow( this );
   auto &commandManager = CommandManager::Get( *project );
   commandManager.FilterKeyEvent(project, event, true);
   event.Skip();
}

References FindProjectFromWindow(), and CommandManager::Get().

Here is the call graph for this function:

OnPaint()

void LyricsPanel::OnPaint

(

wxPaintEvent &

evt

)

Definition at line 551 of file Lyrics.cpp.

{
   wxPaintDC dc(this);
   DoPaint(dc);
}

References DoPaint().

Here is the call graph for this function:

OnShow()

void LyricsPanel::OnShow

(

wxShowEvent &

e

)

Definition at line 536 of file Lyrics.cpp.

{
   e.Skip();
   if (e.IsShown())
      DoUpdateLyrics();
}

References DoUpdateLyrics().

Referenced by LyricsPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

OnSize()

void LyricsPanel::OnSize

(

wxSizeEvent &

evt

)

Definition at line 586 of file Lyrics.cpp.

{
   GetClientSize(&mWidth, &mHeight);
 
   mKaraokeHeight = mHeight;
 
   mKaraokeFontSize =
      (int)((float)(this->GetDefaultFontSize() * mHeight) / (float)LYRICS_DEFAULT_HEIGHT);
   // Usually don't get the size window we want, usually less than
   // LYRICS_DEFAULT_HEIGHT, so bump it a little.
   mKaraokeFontSize += 2;
 
   if (mLyricsStyle == kBouncingBallLyrics)
   {
      mMeasurementsDone = false;
      wxClientDC dc(this);
      this->DoPaint(dc);
   }
   else // (mLyricsStyle == kHighlightLyrics)
   {
      mHighlightTextCtrl->SetSize(mWidth, mKaraokeHeight);
      this->SetHighlightFont();
   }
 
   this->Refresh(false);
}

References DoPaint(), GetDefaultFontSize(), kBouncingBallLyrics, LYRICS_DEFAULT_HEIGHT, mHeight, mHighlightTextCtrl, mKaraokeFontSize, mKaraokeHeight, mLyricsStyle, mMeasurementsDone, mWidth, and SetHighlightFont().

Referenced by SetLyricsStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

OnStartStop()

void LyricsPanel::OnStartStop

(

AudioIOEvent

e

)

Definition at line 526 of file Lyrics.cpp.

{
   if (e.type == AudioIOEvent::MONITOR)
      return;
   if ( !e.on && mDelayedUpdate ) {
      mDelayedUpdate = false;
      DoUpdateLyrics();
   }
}

References DoUpdateLyrics(), mDelayedUpdate, AudioIOEvent::MONITOR, AudioIOEvent::on, and AudioIOEvent::type.

Referenced by LyricsPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

SetCurrentSyllableIndex()

void LyricsPanel::SetCurrentSyllableIndex ( int  nSyl )

inline

Definition at line 98 of file Lyrics.h.

{ mCurrentSyllable = nSyl; };

References mCurrentSyllable.

SetDrawnFont()

void LyricsPanel::SetDrawnFont ( wxDC *  dc )

private

Definition at line 265 of file Lyrics.cpp.

{
   dc->SetFont(wxFont(mKaraokeFontSize, wxFONTFAMILY_SWISS, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL));
}

References mKaraokeFontSize.

Referenced by HandlePaint_BouncingBall(), and Measure().

Here is the caller graph for this function:

SetHighlightFont()

void LyricsPanel::SetHighlightFont ( )

private

Definition at line 270 of file Lyrics.cpp.

{
   wxFont newFont(mKaraokeFontSize, wxFONTFAMILY_SWISS, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL);
   mHighlightTextCtrl->SetDefaultStyle(wxTextAttr(wxNullColour, wxNullColour, newFont));
   mHighlightTextCtrl->SetStyle(0, mHighlightTextCtrl->GetLastPosition(),
                                 wxTextAttr(wxNullColour, wxNullColour, newFont));
}

References mHighlightTextCtrl, and mKaraokeFontSize.

Referenced by OnSize().

Here is the caller graph for this function:

SetLyricsStyle()

void LyricsPanel::SetLyricsStyle

(

const LyricsStyle

newLyricsStyle

)

Definition at line 247 of file Lyrics.cpp.

{
   if (mLyricsStyle == newLyricsStyle)
      return;
 
   mLyricsStyle = newLyricsStyle;
   mHighlightTextCtrl->Show(mLyricsStyle == kHighlightLyrics);
 
   wxSizeEvent ignore;
   this->OnSize(ignore);
}

References kHighlightLyrics, mHighlightTextCtrl, mLyricsStyle, and OnSize().

Referenced by LyricsWindow::OnStyle_BouncingBall(), and LyricsWindow::OnStyle_Highlight().

Here is the call graph for this function:

Here is the caller graph for this function:

Update()

void LyricsPanel::Update

(

double

t

)

Definition at line 437 of file Lyrics.cpp.

{
   if (t < 0.0)
   {
      // TrackPanel::OnTimer passes gAudioIO->GetStreamTime(), which is -DBL_MAX if !IsStreamActive().
      // In that case, use the selection start time.
      auto pProj = FindProjectFromWindow( this );
      const auto &selectedRegion = ViewInfo::Get( *pProj ).selectedRegion;
      mT = selectedRegion.t0();
   }
   else
      mT = t;
 
   if (mLyricsStyle == kBouncingBallLyrics)
   {
      wxRect karaokeRect(0, 0, mWidth, mKaraokeHeight);
      this->Refresh(false, &karaokeRect);
   }
 
   int i = FindSyllable(mT);
   if (i == mCurrentSyllable)
      return;
 
   mCurrentSyllable = i;
 
   if (mLyricsStyle == kHighlightLyrics)
   {
      mHighlightTextCtrl->SetSelection(mSyllables[i].char0, mSyllables[i].char1);
 
      //v No trail for now.
      //if (i == I_FIRST_REAL_SYLLABLE)
      //   // Reset the trail to zero.
      //   mHighlightTextCtrl->SetStyle(0, mHighlightTextCtrl->GetLastPosition(), wxTextAttr(wxNullColour, *wxWHITE));
      //mHighlightTextCtrl->SetStyle(mSyllables[i].char0, mSyllables[i].char1, wxTextAttr(wxNullColour, *wxLIGHT_GREY));
 
      //v Too much flicker:   mHighlightTextCtrl->ShowPosition(mSyllables[i].char0);
   }
}

References FindProjectFromWindow(), FindSyllable(), ViewInfo::Get(), kBouncingBallLyrics, kHighlightLyrics, mCurrentSyllable, mHighlightTextCtrl, mKaraokeHeight, mLyricsStyle, mSyllables, mT, mWidth, and ViewInfo::selectedRegion.

Referenced by DoUpdateLyrics(), and LyricsWindow::OnTimer().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateLyrics()

void LyricsPanel::UpdateLyrics

(

struct UndoRedoMessage

message

)

Definition at line 478 of file Lyrics.cpp.

{
   switch (message.type) {
   case UndoRedoMessage::Pushed:
   case UndoRedoMessage::Modified:
   case UndoRedoMessage::UndoOrRedo:
   case UndoRedoMessage::Reset:
      break;
   default:
      return;
   }
   DoUpdateLyrics();
}

References DoUpdateLyrics(), UndoRedoMessage::Modified, UndoRedoMessage::Pushed, UndoRedoMessage::Reset, UndoRedoMessage::type, and UndoRedoMessage::UndoOrRedo.

Referenced by LyricsPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mAudioIOSubscription

Observer::Subscription LyricsPanel::mAudioIOSubscription

private

Definition at line 143 of file Lyrics.h.

mCurrentSyllable

int LyricsPanel::mCurrentSyllable

private

Definition at line 158 of file Lyrics.h.

Referenced by Finish(), GetCurrentSyllableIndex(), SetCurrentSyllableIndex(), and Update().

mDelayedUpdate

bool LyricsPanel::mDelayedUpdate { false }

private

Definition at line 166 of file Lyrics.h.

Referenced by DoUpdateLyrics(), and OnStartStop().

mHeight

int LyricsPanel::mHeight

private

Definition at line 148 of file Lyrics.h.

Referenced by OnSize().

mHighlightTextCtrl

HighlightTextCtrl* LyricsPanel::mHighlightTextCtrl

private

Definition at line 154 of file Lyrics.h.

Referenced by AddLabels(), Clear(), Finish(), OnSize(), SetHighlightFont(), SetLyricsStyle(), and Update().

mKaraokeFontSize

unsigned int LyricsPanel::mKaraokeFontSize

private

Definition at line 151 of file Lyrics.h.

Referenced by OnSize(), SetDrawnFont(), and SetHighlightFont().

mKaraokeHeight

int LyricsPanel::mKaraokeHeight

private

Definition at line 150 of file Lyrics.h.

Referenced by DoPaint(), HandlePaint(), HandlePaint_BouncingBall(), OnSize(), and Update().

mLyricsStyle

LyricsStyle LyricsPanel::mLyricsStyle

private

Definition at line 153 of file Lyrics.h.

Referenced by DoPaint(), GetDefaultFontSize(), GetLyricsStyle(), HandlePaint(), OnSize(), SetLyricsStyle(), and Update().

mMeasurementsDone

bool LyricsPanel::mMeasurementsDone

private

Definition at line 163 of file Lyrics.h.

Referenced by DoPaint(), Finish(), Measure(), and OnSize().

mProject

wxWeakRef<AudacityProject> LyricsPanel::mProject

private

Definition at line 165 of file Lyrics.h.

Referenced by DoUpdateLyrics().

mSyllables

std::vector<Syllable> LyricsPanel::mSyllables

private

Definition at line 159 of file Lyrics.h.

Referenced by Add(), Clear(), FindSyllable(), Finish(), GetKaraokePosition(), GetSyllable(), HandlePaint_BouncingBall(), Measure(), and Update().

mT

double LyricsPanel::mT

private

Definition at line 156 of file Lyrics.h.

Referenced by HandlePaint_BouncingBall(), and Update().

mText

wxString LyricsPanel::mText

private

Definition at line 160 of file Lyrics.h.

Referenced by Add(), and Clear().

mTextHeight

int LyricsPanel::mTextHeight

private

Definition at line 162 of file Lyrics.h.

Referenced by HandlePaint_BouncingBall(), and Measure().

mUndoSubscription

Observer::Subscription LyricsPanel::mUndoSubscription

private

Definition at line 144 of file Lyrics.h.

mWidth

int LyricsPanel::mWidth

private

Definition at line 147 of file Lyrics.h.

Referenced by DoPaint(), HandlePaint(), HandlePaint_BouncingBall(), OnSize(), and Update().

---

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

• Lyrics.h
• Lyrics.cpp