A kind of ToolBar used to help with analysing voice recordings. More...

#include <TranscriptionToolBar.h>

Inheritance diagram for TranscriptionToolBar:

Collaboration diagram for TranscriptionToolBar:

Public Member Functions
	TranscriptionToolBar (AudacityProject &project)

virtual	~TranscriptionToolBar ()

bool	ShownByDefault () const override
	Whether the toolbar should be shown by default. Default implementation returns true. More...

DockID	DefaultDockID () const override
	Which dock the toolbar defaults into. Default implementation chooses the top dock. More...

void	Create (wxWindow *parent) override

void	OnKeyEvent (wxKeyEvent &event)

void	OnPlaySpeed (wxCommandEvent &event)

void	OnSpeedSlider (wxCommandEvent &event)

void	Populate () override

void	Repaint (wxDC *WXUNUSED(dc)) override

void	EnableDisableButtons () override

void	UpdatePrefs () override

int	GetInitialWidth () override
	Resizable toolbars should implement these. More...

int	GetMinToolbarWidth () override

void	OnFocus (wxFocusEvent &event)

void	OnCaptureKey (wxCommandEvent &event)

void	PlayAtSpeed (bool looped, bool cutPreview)

void	ShowPlaySpeedDialog ()

void	AdjustPlaySpeed (float adj)

void	SetEnabled (bool enabled)

void	SetPlaying (bool down, bool looped, bool cutPreview)

double	GetPlaySpeed () const

Public Member Functions inherited from ToolBar
	ToolBar (AudacityProject &project, const TranslatableString &label, const Identifier &section, bool resizable=false)

virtual	~ToolBar ()

virtual bool	ShownByDefault () const
	Whether the toolbar should be shown by default. Default implementation returns true. More...

virtual bool	HideAfterReset () const
	Default implementation returns false. More...

virtual DockID	DefaultDockID () const
	Which dock the toolbar defaults into. Default implementation chooses the top dock. More...

bool	AcceptsFocus () const override

bool	AcceptsFocusFromKeyboard () const override

virtual void	SetToDefaultSize ()

virtual void	Create (wxWindow *parent)

virtual void	EnableDisableButtons ()=0

virtual void	ReCreateButtons ()

void	UpdatePrefs () override

virtual void	RegenerateTooltips ()=0

int	GetIndex () const
	Get a value used for computing cascading positions of undocked bars. More...

void	SetIndex (int index)
	Set a value used for computing cascading positions of undocked bars. More...

TranslatableString	GetTitle ()

TranslatableString	GetLabel ()

Identifier	GetSection ()

ToolDock *	GetDock ()

void	SetPreferredNeighbors (Identifier left, Identifier top={})

void	SetLabel (const TranslatableString &label)

virtual void	SetDocked (ToolDock *dock, bool pushed)

std::pair< Identifier, Identifier >	PreferredNeighbors () const noexcept
	Defaults to (NoBarID, NoBarId) More...

virtual bool	Expose (bool show=true)

bool	IsResizable () const

bool	IsVisible () const

bool	IsDocked () const

bool	IsPositioned ()

void	SetVisible (bool bVisible)

void	SetPositioned ()

virtual int	GetInitialWidth ()
	Resizable toolbars should implement these. More...

virtual int	GetMinToolbarWidth ()

virtual wxSize	GetDockedSize ()

wxSize	GetSmartDockedSize ()

virtual void	ResizingDone ()

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

Static Public Member Functions
static Identifier	ID ()

static TranscriptionToolBar &	Get (AudacityProject &project)

static const TranscriptionToolBar &	Get (const AudacityProject &project)

Static Public Member Functions inherited from ToolBar
static AButton *	MakeButton (wxWindow *parent, teBmps eUp, teBmps eDown, teBmps eHilite, teBmps eDownHi, teBmps eStandardUp, teBmps eStandardDown, teBmps eDisabled, wxWindowID id, wxPoint placement, bool processdownevents, wxSize size)

static AButton *	MakeButton (ToolBar *parent, teBmps eEnabledUp, teBmps eEnabledDown, teBmps eDisabled, int id, bool processdownevents, const TranslatableString &label)

static void	MakeAlternateImages (AButton &button, int idx, teBmps eUp, teBmps eDown, teBmps eHilite, teBmps eDownHi, teBmps eStandardUp, teBmps eStandardDown, teBmps eDisabled, wxSize size)

static void	SetButtonToolTip (AudacityProject &project, AButton &button, const ComponentInterfaceSymbol commands[], size_t nCommands)

static void	MakeButtonBackgroundsSmall ()

static void	MakeButtonBackgroundsLarge ()

Private Member Functions
void	SetPlaySpeed (double value)

void	MakeAlternateImages (teBmps eFore, teBmps eDisabled, int id, unsigned altIdx)

void	GetSamples (const WaveTrack t, sampleCount s0, sampleCount *slen)

void	SetButton (bool newstate, AButton *button)

void	RegenerateTooltips () override

Static Private Member Functions
static AButton *	AddButton (TranscriptionToolBar *pBar, teBmps eFore, teBmps eDisabled, int id, const TranslatableString &label)

Private Attributes
AButton *	mButtons [TTBNumButtons]

wxImage *	upImage

wxImage *	downImage

wxImage *	hiliteImage

ASlider *	mPlaySpeedSlider

double	mPlaySpeed

ASlider *	mSensitivitySlider

int	mBackgroundWidth

int	mBackgroundHeight

std::shared_ptr< BoundedEnvelope >	mEnvelope

Additional Inherited Members
Public Types inherited from ToolBar
enum	DockID { TopDockID = 1 , BotDockID = 2 }
	Identifies one of the docking areas for toolbars. More...

using	Holder = wxWindowPtr< ToolBar >

Protected Member Functions inherited from ToolBar
void	SetButton (bool down, AButton *button)

wxBoxSizer *	GetSizer ()

void	Add (wxWindow window, int proportion=0, int flag=wxALIGN_TOP, int border=0, wxObject userData=NULL)

void	Add (wxSizer sizer, int proportion=0, int flag=0, int border=0, wxObject userData=NULL)

void	Add (int width, int height, int proportion=0, int flag=0, int border=0, wxObject *userData=NULL)

void	AddSpacer (int size=14)

void	AddStretchSpacer (int prop=1)

void	Detach (wxWindow *window)

void	Detach (wxSizer *sizer)

void	Updated ()

int	GetResizeGrabberWidth ()
	Returns the width in pixels of the resizer element. More...

virtual void	Populate ()=0

virtual void	Repaint (wxDC *dc)=0

void	OnErase (wxEraseEvent &event)

void	OnPaint (wxPaintEvent &event)

void	OnMouseEvents (wxMouseEvent &event)

Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)

	PrefsListener ()

virtual	~PrefsListener ()

virtual void	UpdatePrefs ()=0

Static Protected Member Functions inherited from ToolBar
static void	MakeMacRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)

static void	MakeMacRecoloredImageSize (teBmps eBmpOut, teBmps eBmpIn, const wxSize &size)

static void	MakeRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)

static void	MakeRecoloredImageSize (teBmps eBmpOut, teBmps eBmpIn, const wxSize &size)

Static Protected Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Protected Attributes inherited from ToolBar
AudacityProject &	mProject

TranslatableString	mLabel

Identifier	mSection

int	mIndex {0}

Detailed Description

A kind of ToolBar used to help with analysing voice recordings.

Definition at line 61 of file TranscriptionToolBar.h.

Constructor & Destructor Documentation

◆ TranscriptionToolBar()

TranscriptionToolBar::TranscriptionToolBar ( AudacityProject & project )

Definition at line 100 of file TranscriptionToolBar.cpp.

: ToolBar( project, XO("Play-at-Speed"), ID(), true )
{
   SetPlaySpeed( 1.0 * 100.0 );
#ifdef EXPERIMENTAL_VOICE_DETECTION
   mVk = std::make_unique<VoiceKey>();
#endif
}

References SetPlaySpeed().

Here is the call graph for this function:

◆ ~TranscriptionToolBar()

TranscriptionToolBar::~TranscriptionToolBar ( )

virtual

Definition at line 109 of file TranscriptionToolBar.cpp.

110{

111}

Member Function Documentation

◆ AddButton()

AButton * TranscriptionToolBar::AddButton	(	TranscriptionToolBar *	pBar,
		teBmps	eFore,
		teBmps	eDisabled,
		int	id,
		const TranslatableString &	label
	)

staticprivate

This is a convenience function that allows for button creation in MakeButtons() with fewer arguments Very similar to code in ControlToolBar...

Definition at line 184 of file TranscriptionToolBar.cpp.

{
   AButton *&r = pBar->mButtons[id];
 
   r = ToolBar::MakeButton(pBar,
      bmpRecoloredUpSmall, bmpRecoloredDownSmall, bmpRecoloredUpHiliteSmall,bmpRecoloredHiliteSmall,
      eFore, eFore, eDisabled,
      wxWindowID(id),
      wxDefaultPosition,
      false,
      theTheme.ImageSize( bmpRecoloredUpSmall ));
 
   r->SetLabel(label);
// JKC: Unlike ControlToolBar, does not have a focus rect.  Shouldn't it?
// r->SetFocusRect( r->GetRect().Deflate( 4, 4 ) );
 
   pBar->Add( r, 0, wxALIGN_CENTER );
 
   return r;
}

References ToolBar::Add(), id, ThemeBase::ImageSize(), label, ToolBar::MakeButton(), mButtons, AButton::SetLabel(), and theTheme.

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AdjustPlaySpeed()

void TranscriptionToolBar::AdjustPlaySpeed ( float adj )

Definition at line 1058 of file TranscriptionToolBar.cpp.

{
   if (adj < 0) {
      mPlaySpeedSlider->Decrease(-adj);
   }
   else {
      mPlaySpeedSlider->Increase(adj);
   }
   wxCommandEvent e;
   OnSpeedSlider(e);
}

References ASlider::Decrease(), ASlider::Increase(), mPlaySpeedSlider, and OnSpeedSlider().

Here is the call graph for this function:

◆ Create()

void TranscriptionToolBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 140 of file TranscriptionToolBar.cpp.

{
   ToolBar::Create(parent);
 
   mBackgroundHeight = 0;
   mBackgroundWidth = 0;
 
#ifdef EXPERIMENTAL_VOICE_DETECTION
   mButtons[TTB_StartOn]->Disable();
   mButtons[TTB_StartOff]->Disable();
   mButtons[TTB_EndOn]->Disable();
   mButtons[TTB_EndOff]->Disable();
   mButtons[TTB_SelectSound]->Disable();
   mButtons[TTB_SelectSilence]->Disable();
   mButtons[TTB_Calibrate]->Enable();
   mButtons[TTB_AutomateSelection]->Disable();
   mButtons[TTB_MakeLabel]->Enable();
#endif
 
   //Old code...
   //Process a dummy event to set up mPlaySpeed
   //wxCommandEvent dummy;
   //OnSpeedSlider(dummy);
 
   //JKC: Set speed this way is better, as we don't
   //then stop Audio if it is playing, so we can be playing
   //audio and open a second project.
   SetPlaySpeed( (mPlaySpeedSlider->Get()) * 100 );
 
   // Simulate a size event to set initial placement/size
   wxSizeEvent event(GetSize(), GetId());
   event.SetEventObject(this);
   GetEventHandler()->ProcessEvent(event);
}

References ToolBar::Create(), AButton::Disable(), AButton::Enable(), ASlider::Get(), mBackgroundHeight, mBackgroundWidth, mButtons, mPlaySpeedSlider, and SetPlaySpeed().

Here is the call graph for this function:

◆ DefaultDockID()

ToolBar::DockID TranscriptionToolBar::DefaultDockID ( ) const

overridevirtual

Which dock the toolbar defaults into. Default implementation chooses the top dock.

Reimplemented from ToolBar.

Definition at line 124 of file TranscriptionToolBar.cpp.

{
   return BotDockID;
}

References ToolBar::BotDockID.

◆ EnableDisableButtons()

void TranscriptionToolBar::EnableDisableButtons ( )

overridevirtual

Implements ToolBar.

Definition at line 315 of file TranscriptionToolBar.cpp.

{
   AudacityProject *p = &mProject;
 
   auto gAudioIO = AudioIO::Get();
   bool canStopAudioStream = (!gAudioIO->IsStreamActive() ||
           gAudioIO->IsMonitoring() ||
           gAudioIO->GetOwningProject().get() == p );
   bool recording = gAudioIO->GetNumCaptureChannels() > 0;
 
   // Only interested in audio type tracks
   bool tracks = p && TrackList::Get(*p).Any<AudioTrack>(); // PRL:  PlayableTrack ?
   SetEnabled(canStopAudioStream && tracks && !recording);
 
#ifdef EXPERIMENTAL_VOICE_DETECTION
   if (!p)
      return;
   // Is anything selected?
   const auto &selectedRegion = ViewInfo::Get( *p ).selectedRegion;
   auto selection = !selectedRegion.isPoint() &&
      !TrackList::Get( *p ).Selected().empty();
 
   mButtons[TTB_Calibrate]->SetEnabled(selection);
#endif
}

References TrackList::Any(), AudioIO::Get(), ViewInfo::Get(), TrackList::Get(), NotifyingSelectedRegion::isPoint(), mButtons, ToolBar::mProject, TrackList::Selected(), ViewInfo::selectedRegion, SetEnabled(), AButton::SetEnabled(), and tracks.

Here is the call graph for this function:

◆ Get() [1/2]

TranscriptionToolBar & TranscriptionToolBar::Get ( AudacityProject & project )

static

Definition at line 129 of file TranscriptionToolBar.cpp.

{
   auto &toolManager = ToolManager::Get( project );
   return *static_cast<TranscriptionToolBar*>(toolManager.GetToolBar(ID()));
}

References ToolManager::Get(), ID(), and project.

Referenced by Get(), anonymous_namespace{TranscriptionToolBar.cpp}::OnPlayAtSpeed(), anonymous_namespace{TranscriptionToolBar.cpp}::OnPlayAtSpeedCutPreview(), anonymous_namespace{TranscriptionToolBar.cpp}::OnPlayAtSpeedLooped(), anonymous_namespace{TranscriptionToolBar.cpp}::OnPlaySpeedDec(), anonymous_namespace{TranscriptionToolBar.cpp}::OnPlaySpeedInc(), and anonymous_namespace{TranscriptionToolBar.cpp}::OnSetPlaySpeed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [2/2]

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

static

Definition at line 135 of file TranscriptionToolBar.cpp.

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

References Get(), and project.

Here is the call graph for this function:

◆ GetInitialWidth()

int TranscriptionToolBar::GetInitialWidth ( )

inlineoverridevirtual

Resizable toolbars should implement these.

Reimplemented from ToolBar.

Definition at line 87 of file TranscriptionToolBar.h.

87{ return 191; }

◆ GetMinToolbarWidth()

int TranscriptionToolBar::GetMinToolbarWidth ( )

inlineoverridevirtual

Reimplemented from ToolBar.

Definition at line 88 of file TranscriptionToolBar.h.

88{ return 125; }

◆ GetPlaySpeed()

double TranscriptionToolBar::GetPlaySpeed ( ) const

inline

Definition at line 123 of file TranscriptionToolBar.h.

123{ return mPlaySpeed / 100.0; }

TranscriptionToolBar::mPlaySpeed

double mPlaySpeed

Definition: TranscriptionToolBar.h:146

References mPlaySpeed.

Referenced by SetPlaySpeed().

Here is the caller graph for this function:

◆ GetSamples()

void TranscriptionToolBar::GetSamples	(	const WaveTrack *	t,
		sampleCount *	s0,
		sampleCount *	slen
	)

private

Definition at line 449 of file TranscriptionToolBar.cpp.

{
   // GetSamples attempts to translate the start and end selection markers into sample indices
   // These selection numbers are doubles.
 
   AudacityProject *p = &mProject;
   if (!p) {
      return;
   }
 
   //First, get the current selection. It is part of the mViewInfo, which is
   //part of the project
 
   const auto &selectedRegion = ViewInfo::Get( *p ).selectedRegion;
   double start = selectedRegion.t0();
   double end = selectedRegion.t1();
 
   auto ss0 = sampleCount( (start - t->GetStartTime()) * t->GetRate() );
   auto ss1 = sampleCount( (end - t->GetStartTime()) * t->GetRate() );
 
   if (start < t->GetStartTime()) {
      ss0 = 0;
   }
 
#if 0
   //This adjusts the right samplecount to the maximum sample.
   if (ss1 >= t->GetNumSamples()) {
      ss1 = t->GetNumSamples();
   }
#endif
 
   if (ss1 < ss0) {
      ss1 = ss0;
   }
 
   *s0 = ss0;
   *slen = ss1 - ss0;
}

References PackedArray::end(), ViewInfo::Get(), WaveTrack::GetRate(), WaveTrack::GetStartTime(), ToolBar::mProject, ViewInfo::selectedRegion, and NotifyingSelectedRegion::t0().

Here is the call graph for this function:

◆ ID()

Identifier TranscriptionToolBar::ID ( )

static

Definition at line 94 of file TranscriptionToolBar.cpp.

{
   return wxT("Transcription");
}

References wxT().

Referenced by Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeAlternateImages()

void TranscriptionToolBar::MakeAlternateImages	(	teBmps	eFore,
		teBmps	eDisabled,
		int	id,
		unsigned	altIdx
	)

private

Definition at line 209 of file TranscriptionToolBar.cpp.

{
   ToolBar::MakeAlternateImages(*mButtons[id], altIdx,
      bmpRecoloredUpSmall, bmpRecoloredDownSmall, bmpRecoloredUpHiliteSmall,bmpRecoloredHiliteSmall,
      eFore, eFore, eDisabled,
      theTheme.ImageSize( bmpRecoloredUpSmall ));
}

References ThemeBase::ImageSize(), ToolBar::MakeAlternateImages(), mButtons, and theTheme.

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnCaptureKey()

void TranscriptionToolBar::OnCaptureKey ( wxCommandEvent & event )

Definition at line 400 of file TranscriptionToolBar.cpp.

{
   wxKeyEvent *kevent = (wxKeyEvent *)event.GetEventObject();
   int keyCode = kevent->GetKeyCode();
 
   // Pass LEFT/RIGHT/UP/DOWN/PAGEUP/PAGEDOWN through for input/output sliders
   if (FindFocus() == mPlaySpeedSlider && (keyCode == WXK_LEFT || keyCode == WXK_RIGHT
                                    || keyCode == WXK_UP || keyCode == WXK_DOWN
                                    || keyCode == WXK_PAGEUP || keyCode == WXK_PAGEDOWN)) {
      return;
   }
 
   event.Skip();
 
   return;
}

References BasicUI::FindFocus(), and mPlaySpeedSlider.

Here is the call graph for this function:

◆ OnFocus()

void TranscriptionToolBar::OnFocus ( wxFocusEvent & event )

Definition at line 395 of file TranscriptionToolBar.cpp.

{
   KeyboardCapture::OnFocus( *this, event );
}

References KeyboardCapture::OnFocus().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnKeyEvent()

void TranscriptionToolBar::OnKeyEvent ( wxKeyEvent & event )

Definition at line 418 of file TranscriptionToolBar.cpp.

{
   if (event.ControlDown()) {
      event.Skip();
      return;
   }
 
   if (event.GetKeyCode() == WXK_SPACE) {
      auto gAudioIO = AudioIOBase::Get();
      if (gAudioIO->IsBusy()) {
         /*Do Stuff Here*/
      }
      else {
         /*Do other stuff Here*/
      }
   }
}

References AudioIOBase::Get().

Here is the call graph for this function:

◆ OnPlaySpeed()

void TranscriptionToolBar::OnPlaySpeed ( wxCommandEvent & event )

Definition at line 566 of file TranscriptionToolBar.cpp.

{
   auto button = mButtons[TTB_PlaySpeed];
 
   // Let control have precedence over shift
   const bool cutPreview = mButtons[TTB_PlaySpeed]->WasControlDown();
   const bool looped = !cutPreview &&
      !button->WasShiftDown();
   OnSpeedSlider(event);
   PlayAtSpeed(looped, cutPreview);
}

References mButtons, OnSpeedSlider(), PlayAtSpeed(), TTB_PlaySpeed, and AButton::WasControlDown().

Here is the call graph for this function:

◆ OnSpeedSlider()

void TranscriptionToolBar::OnSpeedSlider ( wxCommandEvent & event )

Definition at line 578 of file TranscriptionToolBar.cpp.

{
   SetPlaySpeed( (mPlaySpeedSlider->Get()) * 100 );
   RegenerateTooltips();
 
   // If IO is busy, abort immediately
   // AWD: This is disabled to work around a hang on Linux when PulseAudio is
   // used.  If we figure that one out we can re-enable this code.
   // auto gAudioIO = AudioIOBase::Get();
   //if (gAudioIO->IsBusy()) {
   //   OnPlaySpeed(event);
   //}
}

References ASlider::Get(), mPlaySpeedSlider, RegenerateTooltips(), and SetPlaySpeed().

Referenced by AdjustPlaySpeed(), OnPlaySpeed(), and ShowPlaySpeedDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PlayAtSpeed()

void TranscriptionToolBar::PlayAtSpeed	(	bool	looped,
		bool	cutPreview
	)

Definition at line 495 of file TranscriptionToolBar.cpp.

{
   // Can't do anything without an active project
   AudacityProject *p = &mProject;
   if (!p) {
      return;
   }
 
   auto &projectAudioManager = ProjectAudioManager::Get( mProject );
 
   // Fixed speed play is the old method, that uses a time track.
   // VariSpeed play reuses Scrubbing.
   bool bFixedSpeedPlay = !gPrefs->ReadBool(wxT("/AudioIO/VariSpeedPlay"), true);
   // Scrubbing doesn't support note tracks, but the fixed-speed method using time tracks does.
   if (TrackList::Get(*p).Any<NoteTrack>())
      bFixedSpeedPlay = true;
 
   // If cutPreview, we have to fall back to fixed speed.
   if (newDefault)
      cutPreview = false;
   bFixedSpeedPlay = bFixedSpeedPlay || cutPreview;
   if (bFixedSpeedPlay)
   {
      // Create a BoundedEnvelope if we haven't done so already
      if (!mEnvelope) {
         mEnvelope =
            std::make_unique<BoundedEnvelope>(
               true, TIMETRACK_MIN, TIMETRACK_MAX, 1.0);
         // values as in the constructor for TimeTrack
         mEnvelope->SetRangeLower( 0.9 );
         mEnvelope->SetRangeUpper( 1.1 );
      }
      // Set the speed range
      //mTimeTrack->SetRangeUpper((double)mPlaySpeed / 100.0);
      //mTimeTrack->SetRangeLower((double)mPlaySpeed / 100.0);
      mEnvelope->Flatten((double)mPlaySpeed / 100.0);
   }
 
   // Pop up the button
   SetButton(false, mButtons[TTB_PlaySpeed]);
 
   // If IO is busy, abort immediately
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO->IsBusy())
      projectAudioManager.Stop();
 
   // Get the current play region
   const auto &viewInfo = ViewInfo::Get( *p );
   const auto &playRegion = viewInfo.playRegion;
 
   // Start playing
   if (playRegion.GetStart() < 0)
      return;
 
   {
      auto options = ProjectAudioIO::GetDefaultOptions(*p, newDefault);
      // No need to set cutPreview options.
      options.envelope = bFixedSpeedPlay ? mEnvelope.get() : nullptr;
      options.variableSpeed = !bFixedSpeedPlay;
      auto mode =
         cutPreview ? PlayMode::cutPreviewPlay
         : newDefault ? PlayMode::loopedPlay
         : PlayMode::normalPlay;
      projectAudioManager.PlayPlayRegion(
         SelectedRegion(playRegion.GetStart(), playRegion.GetEnd()),
            options,
            mode);
   }
}

References TrackList::Any(), cutPreviewPlay, AudioIOBase::Get(), ViewInfo::Get(), TrackList::Get(), ProjectAudioManager::Get(), ProjectAudioIO::GetDefaultOptions(), gPrefs, loopedPlay, mButtons, mEnvelope, mPlaySpeed, ToolBar::mProject, normalPlay, audacity::BasicSettings::ReadBool(), SetButton(), TIMETRACK_MAX, TIMETRACK_MIN, TTB_PlaySpeed, and wxT().

Referenced by OnPlaySpeed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Populate()

void TranscriptionToolBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 219 of file TranscriptionToolBar.cpp.

{
   SetBackgroundColour( theTheme.Colour( clrMedium  ) );
// Very similar to code in ControlToolBar...
// Very similar to code in EditToolBar
   MakeButtonBackgroundsSmall();
 
   AddButton(this, bmpPlay,     bmpPlayDisabled,   TTB_PlaySpeed,
      XO("Play at selected speed"));
   // 3.1.0 abandoned distinct images for Shift
   MakeAlternateImages(bmpPlay, bmpPlayDisabled, TTB_PlaySpeed, 1);
   MakeAlternateImages(bmpCutPreview, bmpCutPreviewDisabled, TTB_PlaySpeed, 2);
   mButtons[TTB_PlaySpeed]->FollowModifierKeys();
 
   //Add a slider that controls the speed of playback.
   const int SliderWidth=100;
   mPlaySpeedSlider = safenew ASlider(this,
      TTB_PlaySpeedSlider,
      XO("Playback Speed"),
      wxDefaultPosition,
      wxSize(SliderWidth,25),
      ASlider::Options{}
         .Style( SPEED_SLIDER )
         //  6 steps using page up/down, and 60 using arrow keys
         .Line( 0.16667f )
         .Page( 1.6667f )
   );
   mPlaySpeedSlider->SetSizeHints(wxSize(100, 25), wxSize(2000, 25));
   mPlaySpeedSlider->Set(mPlaySpeed / 100.0);
   mPlaySpeedSlider->SetLabel(_("Playback Speed"));
   Add( mPlaySpeedSlider, 1, wxALIGN_CENTER );
   mPlaySpeedSlider->Bind(wxEVT_SET_FOCUS,
                 &TranscriptionToolBar::OnFocus,
                 this);
   mPlaySpeedSlider->Bind(wxEVT_KILL_FOCUS,
                 &TranscriptionToolBar::OnFocus,
                 this);
 
#ifdef EXPERIMENTAL_VOICE_DETECTION
// If we need these strings translated, then search and replace
// YO by XO and remove this #define.
#define YO( x ) Verbatim( x )
   AddButton(this, bmpTnStartOn,     bmpTnStartOnDisabled,  TTB_StartOn,
      YO("Adjust left selection to next onset"));
   AddButton(this, bmpTnEndOn,       bmpTnEndOnDisabled,   TTB_EndOn,
      YO("Adjust right selection to previous offset"));
   AddButton(this, bmpTnStartOff,    bmpTnStartOffDisabled,  TTB_StartOff,
      YO("Adjust left selection to next offset"));
   AddButton(this, bmpTnEndOff,      bmpTnEndOffDisabled,    TTB_EndOff,
      YO("Adjust right selection to previous onset"));
   AddButton(this, bmpTnSelectSound, bmpTnSelectSoundDisabled, TTB_SelectSound,
      YO("Select region of sound around cursor"));
   AddButton(this, bmpTnSelectSilence, bmpTnSelectSilenceDisabled, TTB_SelectSilence,
      YO("Select region of silence around cursor"));
   AddButton(this, bmpTnAutomateSelection,   bmpTnAutomateSelectionDisabled,  TTB_AutomateSelection,
      YO("Automatically make labels from words"));
   AddButton(this, bmpTnMakeTag, bmpTnMakeTagDisabled,  TTB_MakeLabel,
      YO("Add label at selection"));
   AddButton(this, bmpTnCalibrate, bmpTnCalibrateDisabled, TTB_Calibrate,
      YO("Calibrate voicekey"));
 
   mSensitivitySlider = safenew ASlider(this,
                                    TTB_SensitivitySlider,
                                    YO("Adjust Sensitivity"),
                                    wxDefaultPosition,
                                    wxSize(SliderWidth,25),
                                    ASlider::Options{}
                                       .Style( SPEED_SLIDER ));
   mSensitivitySlider->Set(.5);
   mSensitivitySlider->SetLabel(YO("Sensitivity").Translation());
   Add( mSensitivitySlider, 0, wxALIGN_CENTER );
 
   TranslatableStrings choices {
      YO("Energy"),
      YO("Sign Changes (Low Threshold)"),
      YO("Sign Changes (High Threshold)"),
      YO("Direction Changes (Low Threshold)"),
      YO("Direction Changes (High Threshold)")
   };
 
   mKeyTypeChoice = safenew wxChoice(this, TTB_KeyType,
      wxDefaultPosition,
      wxDefaultSize,
      transform_container<wxArrayStringEx>( choices,
         std::mem_fn( &TranslatableString::Translation ) ) );
   mKeyTypeChoice->SetName(YO("Key type").Translation());
   mKeyTypeChoice->SetSelection(0);
   Add( mKeyTypeChoice, 0, wxALIGN_CENTER );
#endif
 
   // Add a little space
   Add(2, -1);
 
   UpdatePrefs();
}

References _, ToolBar::Add(), AddButton(), ThemeBase::Colour(), AButton::FollowModifierKeys(), MakeAlternateImages(), ToolBar::MakeButtonBackgroundsSmall(), mButtons, mPlaySpeed, mPlaySpeedSlider, mSensitivitySlider, OnFocus(), safenew, ASlider::Set(), SPEED_SLIDER, ASlider::Options::Style(), theTheme, TranslatableString::Translation(), TTB_PlaySpeed, TTB_PlaySpeedSlider, UpdatePrefs(), and XO().

Here is the call graph for this function:

◆ RegenerateTooltips()

void TranscriptionToolBar::RegenerateTooltips ( )

overrideprivatevirtual

Implements ToolBar.

Definition at line 352 of file TranscriptionToolBar.cpp.

{
   // We could also mention the shift- and ctrl-modified versions in the
   // tool tip... but it would get long
 
   static const struct Entry {
      int tool;
      CommandID commandName;
      TranslatableString untranslatedLabel;
      CommandID commandName2;
      TranslatableString untranslatedLabel2;
   } table[] = {
      { TTB_PlaySpeed,
         wxT("PlayAtSpeedLooped"),    XO("Play-at-Speed"),
         wxT("PlayAtSpeed"),    XO("Play-at-Speed Once"),
      },
   };
 
   for (const auto &entry : table) {
      ComponentInterfaceSymbol commands[] = {
         { entry.commandName,  entry.untranslatedLabel  },
         { entry.commandName2, entry.untranslatedLabel2 },
      };
      ToolBar::SetButtonToolTip( mProject,
         *mButtons[entry.tool], commands, 2u );
   }
 
#ifdef EXPERIMENTAL_VOICE_DETECTION
   mButtons[TTB_StartOn]->SetToolTip(YO("Left-to-On"));
   mButtons[TTB_EndOn]->SetToolTip(   YO("Right-to-Off"));
   mButtons[TTB_StartOff]->SetToolTip(   YO("Left-to-Off"));
   mButtons[TTB_EndOff]->SetToolTip(   YO("Right-to-On"));
   mButtons[TTB_SelectSound]->SetToolTip(   YO("Select-Sound"));
   mButtons[TTB_SelectSilence]->SetToolTip(   YO("Select-Silence"));
   mButtons[TTB_AutomateSelection]->SetToolTip(   YO("Make Labels"));
   mButtons[TTB_MakeLabel]->SetToolTip(   YO("Add Label"));
   mButtons[TTB_Calibrate]->SetToolTip(   YO("Calibrate"));
 
   mSensitivitySlider->SetToolTip(YO("Sensitivity").Translation());
   mKeyTypeChoice->SetToolTip(YO("Key type").Translation());
#endif
}

References entry, mButtons, ToolBar::mProject, mSensitivitySlider, ToolBar::SetButtonToolTip(), AButton::SetToolTip(), TTB_PlaySpeed, wxT(), and XO().

Referenced by OnSpeedSlider(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Repaint()

void TranscriptionToolBar::Repaint ( wxDC * WXUNUSEDdc )

inlineoverride

Definition at line 84 of file TranscriptionToolBar.h.

84{};

◆ SetButton()

void TranscriptionToolBar::SetButton	(	bool	newstate,
		AButton *	button
	)

private

Definition at line 439 of file TranscriptionToolBar.cpp.

{
   if (down) {
      button->PushDown();
   }
   else {
      button->PopUp();
   }
}

References AButton::PopUp(), and AButton::PushDown().

Referenced by PlayAtSpeed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetEnabled()

void TranscriptionToolBar::SetEnabled ( bool enabled )

Definition at line 1040 of file TranscriptionToolBar.cpp.

{
   mButtons[TTB_PlaySpeed]->SetEnabled(enabled);
}

References mButtons, AButton::SetEnabled(), and TTB_PlaySpeed.

Referenced by EnableDisableButtons().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetPlaying()

void TranscriptionToolBar::SetPlaying	(	bool	down,
		bool	looped,
		bool	cutPreview
	)

Definition at line 1045 of file TranscriptionToolBar.cpp.

{
   AButton *const button = mButtons[TTB_PlaySpeed];
   if (down) {
      button->SetAlternateIdx(cutPreview ? 2 : looped ? 1 : 0);
      button->PushDown();
   }
   else {
      button->SetAlternateIdx(0);
      button->PopUp();
   }
}

References mButtons, AButton::PopUp(), AButton::PushDown(), AButton::SetAlternateIdx(), and TTB_PlaySpeed.

Here is the call graph for this function:

◆ SetPlaySpeed()

void TranscriptionToolBar::SetPlaySpeed ( double value )

private

Definition at line 175 of file TranscriptionToolBar.cpp.

{
   mPlaySpeed = value;
   ProjectAudioIO::Get( mProject ).SetPlaySpeed( GetPlaySpeed() );
}

References ProjectAudioIO::Get(), GetPlaySpeed(), mPlaySpeed, ToolBar::mProject, and ProjectAudioIO::SetPlaySpeed().

Referenced by Create(), OnSpeedSlider(), and TranscriptionToolBar().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ShownByDefault()

bool TranscriptionToolBar::ShownByDefault ( ) const

overridevirtual

Whether the toolbar should be shown by default. Default implementation returns true.

Reimplemented from ToolBar.

Definition at line 113 of file TranscriptionToolBar.cpp.

{
   return
#ifdef EXPERIMENTAL_DA
      false
#else
      true
#endif
   ;
}

◆ ShowPlaySpeedDialog()

void TranscriptionToolBar::ShowPlaySpeedDialog ( )

Definition at line 1032 of file TranscriptionToolBar.cpp.

{
   mPlaySpeedSlider->ShowDialog();
   mPlaySpeedSlider->Refresh();
   wxCommandEvent e;
   OnSpeedSlider(e);
}

References mPlaySpeedSlider, OnSpeedSlider(), and ASlider::ShowDialog().

Here is the call graph for this function:

◆ UpdatePrefs()

void TranscriptionToolBar::UpdatePrefs ( )

overridevirtual

Reimplemented from ToolBar.

Definition at line 341 of file TranscriptionToolBar.cpp.

{
   RegenerateTooltips();
 
   // Set label to pull in language change
   SetLabel(XO("Play-at-Speed"));
 
   // Give base class a chance
   ToolBar::UpdatePrefs();
}

References RegenerateTooltips(), ToolBar::SetLabel(), ToolBar::UpdatePrefs(), and XO().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ downImage

wxImage* TranscriptionToolBar::downImage

private

Definition at line 142 of file TranscriptionToolBar.h.

◆ hiliteImage

wxImage* TranscriptionToolBar::hiliteImage

private

Definition at line 143 of file TranscriptionToolBar.h.

◆ mBackgroundHeight

int TranscriptionToolBar::mBackgroundHeight

private

Definition at line 156 of file TranscriptionToolBar.h.

Referenced by Create().

◆ mBackgroundWidth

int TranscriptionToolBar::mBackgroundWidth

private

Definition at line 155 of file TranscriptionToolBar.h.

Referenced by Create().

◆ mButtons

AButton* TranscriptionToolBar::mButtons[TTBNumButtons]

private

Definition at line 140 of file TranscriptionToolBar.h.

Referenced by AddButton(), Create(), EnableDisableButtons(), MakeAlternateImages(), OnPlaySpeed(), PlayAtSpeed(), Populate(), RegenerateTooltips(), SetEnabled(), and SetPlaying().

◆ mEnvelope

std::shared_ptr<BoundedEnvelope> TranscriptionToolBar::mEnvelope

private

Definition at line 158 of file TranscriptionToolBar.h.

Referenced by PlayAtSpeed().

◆ mPlaySpeed

double TranscriptionToolBar::mPlaySpeed

private

Definition at line 146 of file TranscriptionToolBar.h.

Referenced by GetPlaySpeed(), PlayAtSpeed(), Populate(), and SetPlaySpeed().

◆ mPlaySpeedSlider

ASlider* TranscriptionToolBar::mPlaySpeedSlider

private

Definition at line 145 of file TranscriptionToolBar.h.

Referenced by AdjustPlaySpeed(), Create(), OnCaptureKey(), OnSpeedSlider(), Populate(), and ShowPlaySpeedDialog().

◆ mSensitivitySlider

ASlider* TranscriptionToolBar::mSensitivitySlider

private

Definition at line 147 of file TranscriptionToolBar.h.

Referenced by Populate(), and RegenerateTooltips().

◆ upImage

wxImage* TranscriptionToolBar::upImage

private

Definition at line 141 of file TranscriptionToolBar.h.

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TranscriptionToolBar()

◆ ~TranscriptionToolBar()

Member Function Documentation

◆ AddButton()

◆ AdjustPlaySpeed()

◆ Create()

◆ DefaultDockID()

◆ EnableDisableButtons()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetInitialWidth()

◆ GetMinToolbarWidth()

◆ GetPlaySpeed()

◆ GetSamples()

◆ ID()

◆ MakeAlternateImages()

◆ OnCaptureKey()

◆ OnFocus()

◆ OnKeyEvent()

◆ OnPlaySpeed()

◆ OnSpeedSlider()

◆ PlayAtSpeed()

◆ Populate()

◆ RegenerateTooltips()

◆ Repaint()

◆ SetButton()

◆ SetEnabled()

◆ SetPlaying()

◆ SetPlaySpeed()

◆ ShownByDefault()

◆ ShowPlaySpeedDialog()

◆ UpdatePrefs()

Member Data Documentation

◆ downImage

◆ hiliteImage

◆ mBackgroundHeight

◆ mBackgroundWidth

◆ mButtons

◆ mEnvelope

◆ mPlaySpeed

◆ mPlaySpeedSlider

◆ mSensitivitySlider

◆ upImage