TranscriptionToolBar.cpp

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  TranscriptionToolBar.cpp
 
  Shane T. Mueller
  Leland Lucius
 
*******************************************************************//*******************************************************************/
 
 
#include "TranscriptionToolBar.h"
#include "ToolManager.h"
 
// For compilers that support precompilation, includes "wx/wx.h".
#include <wx/wxprec.h>
 
#ifndef WX_PRECOMP
#include <wx/choice.h>
#include <wx/defs.h>
#include <wx/brush.h>
#endif // WX_PRECOMP
 
#include "Envelope.h"
 
#include "AllThemeResources.h"
#include "AudioIO.h"
#include "ImageManipulation.h"
#include "../KeyboardCapture.h"
#include "NoteTrack.h"
#include "Project.h"
#include "ProjectAudioIO.h"
#include "../ProjectAudioManager.h"
#include "Envelope.h"
#include "ViewInfo.h"
#include "WaveTrack.h"
#include "../widgets/AButton.h"
#include "../widgets/ASlider.h"
#include "../tracks/ui/Scrubbing.h"
#include "Prefs.h"
 
#ifdef EXPERIMENTAL_VOICE_DETECTION
#include "../VoiceKey.h"
#include "../ProjectWindow.h"
#endif
 
IMPLEMENT_CLASS(TranscriptionToolBar, ToolBar);
 
 
 
BEGIN_EVENT_TABLE(TranscriptionToolBar, ToolBar)
   EVT_CHAR(TranscriptionToolBar::OnKeyEvent)
   EVT_COMMAND(wxID_ANY, EVT_CAPTURE_KEY, TranscriptionToolBar::OnCaptureKey)
 
   EVT_COMMAND_RANGE(TTB_PlaySpeed, TTB_PlaySpeed,
                     wxEVT_COMMAND_BUTTON_CLICKED, TranscriptionToolBar::OnPlaySpeed)
   EVT_SLIDER(TTB_PlaySpeedSlider, TranscriptionToolBar::OnSpeedSlider)
 
#ifdef EXPERIMENTAL_VOICE_DETECTION
   EVT_COMMAND_RANGE(TTB_StartOn, TTB_StartOn,
                     wxEVT_COMMAND_BUTTON_CLICKED, TranscriptionToolBar::OnStartOn)
   EVT_COMMAND_RANGE(TTB_StartOff, TTB_StartOff,
                     wxEVT_COMMAND_BUTTON_CLICKED, TranscriptionToolBar::OnStartOff)
   EVT_COMMAND_RANGE(TTB_EndOn, TTB_EndOn,
                     wxEVT_COMMAND_BUTTON_CLICKED, TranscriptionToolBar::OnEndOn)
   EVT_COMMAND_RANGE(TTB_EndOff, TTB_EndOff,
                     wxEVT_COMMAND_BUTTON_CLICKED, TranscriptionToolBar::OnEndOff)
   EVT_COMMAND_RANGE(TTB_SelectSound, TTB_SelectSound,
                     wxEVT_COMMAND_BUTTON_CLICKED, TranscriptionToolBar::OnSelectSound)
   EVT_COMMAND_RANGE(TTB_SelectSilence, TTB_SelectSilence,
                     wxEVT_COMMAND_BUTTON_CLICKED, TranscriptionToolBar::OnSelectSilence)
   EVT_COMMAND_RANGE(TTB_AutomateSelection, TTB_AutomateSelection,
                     wxEVT_COMMAND_BUTTON_CLICKED, TranscriptionToolBar::OnAutomateSelection)
   EVT_COMMAND_RANGE(TTB_MakeLabel, TTB_MakeLabel,
                     wxEVT_COMMAND_BUTTON_CLICKED, TranscriptionToolBar::OnMakeLabel)
   EVT_COMMAND_RANGE(TTB_Calibrate, TTB_Calibrate,
                     wxEVT_COMMAND_BUTTON_CLICKED, TranscriptionToolBar::OnCalibrate)
   EVT_SLIDER(TTB_SensitivitySlider, TranscriptionToolBar::OnSensitivitySlider)
 
   EVT_CHOICE(TTB_KeyType, TranscriptionToolBar::SetKeyType)
#endif
END_EVENT_TABLE()
   ;   //semicolon enforces  proper automatic indenting in emacs.
 
Identifier TranscriptionToolBar::ID()
{
   return wxT("Transcription");
}
 
TranscriptionToolBar::TranscriptionToolBar( AudacityProject &project )
: ToolBar( project, XO("Play-at-Speed"), ID(), true )
{
   SetPlaySpeed( 1.0 * 100.0 );
#ifdef EXPERIMENTAL_VOICE_DETECTION
   mVk = std::make_unique<VoiceKey>();
#endif
}
 
TranscriptionToolBar::~TranscriptionToolBar()
{
}
 
bool TranscriptionToolBar::ShownByDefault() const
{
   return
#ifdef EXPERIMENTAL_DA
      false
#else
      true
#endif
   ;
}
 
ToolBar::DockID TranscriptionToolBar::DefaultDockID() const
{
   return BotDockID;
}
 
TranscriptionToolBar &TranscriptionToolBar::Get( AudacityProject &project )
{
   auto &toolManager = ToolManager::Get( project );
   return *static_cast<TranscriptionToolBar*>(toolManager.GetToolBar(ID()));
}
 
const TranscriptionToolBar &TranscriptionToolBar::Get( const AudacityProject &project )
{
   return Get( const_cast<AudacityProject&>( project )) ;
}
 
void TranscriptionToolBar::Create(wxWindow * parent)
{
   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);
}
 
void TranscriptionToolBar::SetPlaySpeed( double value )
{
   mPlaySpeed = value;
   ProjectAudioIO::Get( mProject ).SetPlaySpeed( GetPlaySpeed() );
}
 
AButton *TranscriptionToolBar::AddButton(
   TranscriptionToolBar *pBar,
   teBmps eFore, teBmps eDisabled,
   int id,
   const TranslatableString &label)
{
   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;
}
 
void TranscriptionToolBar::MakeAlternateImages(
   teBmps eFore, teBmps eDisabled,
   int id, unsigned altIdx)
{
   ToolBar::MakeAlternateImages(*mButtons[id], altIdx,
      bmpRecoloredUpSmall, bmpRecoloredDownSmall, bmpRecoloredUpHiliteSmall,bmpRecoloredHiliteSmall,
      eFore, eFore, eDisabled,
      theTheme.ImageSize( bmpRecoloredUpSmall ));
}
 
void TranscriptionToolBar::Populate()
{
   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();
}
 
void TranscriptionToolBar::EnableDisableButtons()
{
   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
}
 
void TranscriptionToolBar::UpdatePrefs()
{
   RegenerateTooltips();
 
   // Set label to pull in language change
   SetLabel(XO("Play-at-Speed"));
 
   // Give base class a chance
   ToolBar::UpdatePrefs();
}
 
void TranscriptionToolBar::RegenerateTooltips()
{
   // 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
}
 
void TranscriptionToolBar::OnFocus(wxFocusEvent &event)
{
   KeyboardCapture::OnFocus( *this, event );
}
 
void TranscriptionToolBar::OnCaptureKey(wxCommandEvent &event)
{
   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;
}
 
//This handles key-stroke events????
void TranscriptionToolBar::OnKeyEvent(wxKeyEvent & event)
{
   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*/
      }
   }
}
 
 
 
//This changes the state of the various buttons
void TranscriptionToolBar::SetButton(bool down, AButton* button)
{
   if (down) {
      button->PushDown();
   }
   else {
      button->PopUp();
   }
}
 
void TranscriptionToolBar::GetSamples(
   const WaveTrack *t, sampleCount *s0, sampleCount *slen)
{
   // 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->GetOffset()) * t->GetRate() );
   auto ss1 = sampleCount( (end - t->GetOffset()) * t->GetRate() );
 
   if (start < t->GetOffset()) {
      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;
}
 
// PRL: duplicating constants from TimeTrack.cpp
//TODO-MB: are these sensible values?
#define TIMETRACK_MIN 0.01
#define TIMETRACK_MAX 10.0
 
// Come here from button clicks, or commands
void TranscriptionToolBar::PlayAtSpeed(bool newDefault, bool cutPreview)
{
   // 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);
   }
}
 
// Come here from button clicks only
void TranscriptionToolBar::OnPlaySpeed(wxCommandEvent & event)
{
   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);
}
 
void TranscriptionToolBar::OnSpeedSlider(wxCommandEvent& WXUNUSED(event))
{
   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);
   //}
}
 
#ifdef EXPERIMENTAL_VOICE_DETECTION
void TranscriptionToolBar::OnStartOn(wxCommandEvent & WXUNUSED(event))
{
   //If IO is busy, abort immediately
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO->IsBusy()){
      SetButton(false,mButtons[TTB_StartOn]);
      return;
   }
 
   mVk->AdjustThreshold(GetSensitivity());
 
   auto t = *TrackList::Get( mProject ).Any< const WaveTrack >().begin();
   if(t ) {
      auto wt = static_cast<const WaveTrack*>(t);
      sampleCount start, len;
      GetSamples(wt, &start, &len);
 
      //Adjust length to end if selection is null
      //if(len == 0)
      //len = wt->GetSequence()->GetNumSamples()-start;
 
      auto newstart = mVk->OnForward(*wt, start, len);
      double newpos = newstart.as_double() / wt->GetRate();
 
      auto &selectedRegion = ViewInfo::Get( mProject ).selectedRegion;
      selectedRegion.setT0( newpos );
      ProjectWindow::Get( mProject ).RedrawProject();
 
      SetButton(false, mButtons[TTB_StartOn]);
   }
}
 
void TranscriptionToolBar::OnStartOff(wxCommandEvent & WXUNUSED(event))
{
   //If IO is busy, abort immediately
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO->IsBusy()){
      SetButton(false,mButtons[TTB_StartOff]);
      return;
   }
   mVk->AdjustThreshold(GetSensitivity());
   AudacityProject *p = &mProject;
 
   SetButton(false, mButtons[TTB_StartOff]);
   auto t = *TrackList::Get( mProject ).Any< const WaveTrack >().begin();
   if(t) {
      auto wt = static_cast<const WaveTrack*>(t);
      sampleCount start, len;
      GetSamples(wt, &start, &len);
 
      //Adjust length to end if selection is null
      //if(len == 0)
      //len = wt->GetSequence()->GetNumSamples()-start;
 
      auto newstart = mVk->OffForward(*wt, start, len);
      double newpos = newstart.as_double() / wt->GetRate();
 
      auto &selectedRegion = ViewInfo::Get( mProject ).selectedRegion;
      selectedRegion.setT0( newpos );
      ProjectWindow::Get( mProject ).RedrawProject();
 
      SetButton(false, mButtons[TTB_StartOn]);
   }
}
 
void TranscriptionToolBar::OnEndOn(wxCommandEvent & WXUNUSED(event))
{
 
   //If IO is busy, abort immediately
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO->IsBusy()){
      SetButton(false,mButtons[TTB_EndOn]);
      return;
   }
 
   mVk->AdjustThreshold(GetSensitivity());
   AudacityProject *p = &mProject;
   auto t = *TrackList::Get( mProject ).Any< const WaveTrack >().begin();
   if(t) {
      auto wt = static_cast<const WaveTrack*>(t);
      sampleCount start, len;
      GetSamples(wt, &start, &len);
 
      //Adjust length to end if selection is null
      if(len == 0)
         {
            len = start;
            start = 0;
         }
      auto newEnd = mVk->OnBackward(*wt, start + len, len);
      double newpos = newEnd.as_double() / wt->GetRate();
 
      auto &selectedRegion = ViewInfo::Get( mProject ).selectedRegion;
      selectedRegion.setT1( newpos );
      ProjectWindow::Get( mProject ).RedrawProject();
 
      SetButton(false, mButtons[TTB_EndOn]);
   }
}
 
 
 
void TranscriptionToolBar::OnEndOff(wxCommandEvent & WXUNUSED(event))
{
 
   //If IO is busy, abort immediately
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO->IsBusy()){
      SetButton(false,mButtons[TTB_EndOff]);
      return;
   }
   mVk->AdjustThreshold(GetSensitivity());
   AudacityProject *p = &mProject;
 
   auto t = *TrackList::Get( mProject ).Any< const WaveTrack >().begin();
   if(t) {
      auto wt = static_cast<const WaveTrack*>(t);
      sampleCount start, len;
      GetSamples(wt, &start, &len);
 
      //Adjust length to end if selection is null
      if(len == 0) {
         len = start;
         start = 0;
      }
      auto newEnd = mVk->OffBackward(*wt, start + len, len);
      double newpos = newEnd.as_double() / wt->GetRate();
 
      auto &selectedRegion = ViewInfo::Get( mProject ).selectedRegion;
      selectedRegion.setT1( newpos );
      ProjectWindow::Get( mProject ).RedrawProject();
 
      SetButton(false, mButtons[TTB_EndOff]);
   }
}
 
 
 
void TranscriptionToolBar::OnSelectSound(wxCommandEvent & WXUNUSED(event))
{
 
   //If IO is busy, abort immediately
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO->IsBusy()){
      SetButton(false,mButtons[TTB_SelectSound]);
      return;
   }
 
 
   mVk->AdjustThreshold(GetSensitivity());
 
 
   TrackList *tl = &TrackList::Get( mProject );
   if(auto wt = *tl->Any<const WaveTrack>().begin()) {
      sampleCount start, len;
      GetSamples(wt, &start, &len);
 
      //Adjust length to end if selection is null
      //if(len == 0)
      //len = wt->GetSequence()->GetNumSamples()-start;
 
      double rate =  wt->GetRate();
      auto newstart = mVk->OffBackward(*wt, start, start);
      auto newend   =
      mVk->OffForward(*wt, start + len, (int)(tl->GetEndTime() * rate));
 
      //reset the selection bounds.
      auto &selectedRegion = ViewInfo::Get( mProject ).selectedRegion;
      selectedRegion.setTimes(
         newstart.as_double() / rate, newend.as_double() /  rate );
      ProjectWindow::Get( mProject ).RedrawProject();
 
   }
 
   SetButton(false,mButtons[TTB_SelectSound]);
}
 
void TranscriptionToolBar::OnSelectSilence(wxCommandEvent & WXUNUSED(event))
{
 
   //If IO is busy, abort immediately
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO->IsBusy()){
      SetButton(false,mButtons[TTB_SelectSilence]);
      return;
   }
 
   mVk->AdjustThreshold(GetSensitivity());
 
 
   TrackList *tl = &TrackList::Get( mProject );
   if(auto wt = *tl->Any<const WaveTrack>().begin()) {
      sampleCount start, len;
      GetSamples(wt, &start, &len);
 
      //Adjust length to end if selection is null
      //if(len == 0)
      //len = wt->GetSequence()->GetNumSamples()-start;
      double rate =  wt->GetRate();
      auto newstart = mVk->OnBackward(*wt, start, start);
      auto newend   =
      mVk->OnForward(*wt, start + len, (int)(tl->GetEndTime() * rate));
 
      //reset the selection bounds.
      auto &selectedRegion = ViewInfo::Get( mProject ).selectedRegion;
      selectedRegion.setTimes(
         newstart.as_double() / rate, newend.as_double() / rate);
      ProjectWindow::Get( mProject ).RedrawProject();
 
   }
 
   SetButton(false,mButtons[TTB_SelectSilence]);
 
}
 
 
 
void TranscriptionToolBar::OnCalibrate(wxCommandEvent & WXUNUSED(event))
{
   //If IO is busy, abort immediately
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO->IsBusy()){
      SetButton(false,mButtons[TTB_Calibrate]);
      return;
   }
 
 
   TrackList *tl = &TrackList::Get( mProject );
   if(auto wt = *tl->Any<const WaveTrack>().begin()) {
      sampleCount start, len;
      GetSamples(wt, &start, &len);
 
      mVk->CalibrateNoise(*wt, start, len);
      mVk->AdjustThreshold(3);
 
      mButtons[TTB_StartOn]->Enable();
      mButtons[TTB_StartOff]->Enable();
      mButtons[TTB_EndOn]->Enable();
      mButtons[TTB_EndOff]->Enable();
      //mThresholdSensitivity->Set(3);
 
      SetButton(false,mButtons[TTB_Calibrate]);
   }
 
   mButtons[TTB_StartOn]->Enable();
   mButtons[TTB_StartOff]->Enable();
   mButtons[TTB_EndOn]->Enable();
   mButtons[TTB_EndOff]->Enable();
   mButtons[TTB_SelectSound]->Enable();
   mButtons[TTB_SelectSilence]->Enable();
   mButtons[TTB_AutomateSelection]->Enable();
 
   //Make the sensitivity slider set the sensitivity by processing an event.
   wxCommandEvent dummy;
   OnSensitivitySlider(dummy);
 
}
 
#include "../LabelTrack.h"
#include "ProjectHistory.h"
#include "../TrackPanel.h"
#include "../TrackPanelAx.h"
#include "../tracks/labeltrack/ui/LabelTrackView.h"
namespace {
int DoAddLabel(
   AudacityProject &project, const SelectedRegion &region )
{
   auto &tracks = TrackList::Get( project );
   auto &trackFocus = TrackFocus::Get( project );
   auto &trackPanel = TrackPanel::Get( project );
   auto &window = ProjectWindow::Get( project );
 
   wxString title;      // of label
 
   // If the focused track is a label track, use that
   const auto pFocusedTrack = trackFocus.Get();
 
   // Look for a label track at or after the focused track
   auto iter = pFocusedTrack
      ? tracks.Find(pFocusedTrack)
      : tracks.Any().begin();
   auto lt = * iter.Filter< LabelTrack >();
 
   // If none found, start a NEW label track and use it
   if (!lt)
      lt = tracks.Add( std::make_shared<LabelTrack>() );
 
// LLL: Commented as it seemed a little forceful to remove users
//      selection when adding the label.  This does not happen if
//      you select several tracks and the last one of those is a
//      label track...typing a label will not clear the selections.
//
//   SelectNone();
   lt->SetSelected(true);
 
   int index;
   int focusTrackNumber = -1;
   index =
      LabelTrackView::Get( *lt ).AddLabel(region, title, focusTrackNumber);
 
   ProjectHistory::Get( project )
      .PushState(XO("Added label"), XO("Label"));
 
   TrackFocus::Get(project).Set(lt);
   lt->EnsureVisible();
 
   trackPanel.SetFocus();
 
   return index;
}
}
 
//This automates selection through a selected region,
//selecting its best guess for words and creating labels at those points.
 
void TranscriptionToolBar::OnAutomateSelection(wxCommandEvent & WXUNUSED(event))
{
 
 
   //If IO is busy, abort immediately
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO->IsBusy())
   {
      SetButton(false,mButtons[TTB_EndOff]);
      return;
   }
 
   wxBusyCursor busy;
 
   mVk->AdjustThreshold(GetSensitivity());
   TrackList *tl = &TrackList::Get( mProject );
   if(auto wt = *tl->Any<const WaveTrack>().begin()) {
      sampleCount start, len;
      GetSamples(wt, &start, &len);
 
      //Adjust length to end if selection is null
      if(len == 0)
      {
         len = start;
         start = 0;
      }
      sampleCount lastlen = 0;
      double newStartPos, newEndPos;
 
      //This is the minimum word size in samples (.05 is 50 ms)
      int minWordSize = (int)(wt->GetRate() * .05);
 
      //Continue until we have processed the entire
      //region, or we are making no progress.
      while(len > 0 && lastlen != len)
      {
 
         lastlen = len;
 
         auto newStart = mVk->OnForward(*wt, start, len);
 
         //JKC: If no start found then don't add any labels.
         if( newStart==start)
            break;
 
         //Adjust len by the NEW start position
         len -= (newStart - start);
 
         //Adjust len by the minimum word size
         len -= minWordSize;
 
 
 
         //OK, now we have found a NEW starting point.  A 'word' should be at least
         //50 ms long, so jump ahead minWordSize
 
         auto newEnd   =
         mVk->OffForward(*wt, newStart + minWordSize, len);
 
         //If newEnd didn't move, we should give up, because
         // there isn't another end before the end of the selection.
         if(newEnd == (newStart + minWordSize))
            break;
 
 
         //Adjust len by the NEW word end
         len -= (newEnd - newStart);
 
         //Calculate the start and end of the words, in seconds
         newStartPos = newStart.as_double() / wt->GetRate();
         newEndPos = newEnd.as_double() / wt->GetRate();
 
 
         //Increment
         start = newEnd;
 
         DoAddLabel(mProject, SelectedRegion(newStartPos, newEndPos));
      ProjectWindow::Get( mProject ).RedrawProject();
      }
      SetButton(false, mButtons[TTB_AutomateSelection]);
   }
}
 
void TranscriptionToolBar::OnMakeLabel(wxCommandEvent & WXUNUSED(event))
{
   SetButton(false, mButtons[TTB_MakeLabel]);
   DoAddLabel( mProject, ViewInfo::Get( mProject ).selectedRegion );
}
 
//This returns a double z-score between 0 and 10.
double TranscriptionToolBar::GetSensitivity()
{
   return (double)mSensitivity;
}
 
void TranscriptionToolBar::OnSensitivitySlider(wxCommandEvent & WXUNUSED(event))
{
   mSensitivity = (mSensitivitySlider->Get());
}
 
void TranscriptionToolBar::SetKeyType(wxCommandEvent & WXUNUSED(event))
{
   int value = mKeyTypeChoice->GetSelection();
 
   //Only use one key type at a time.
   switch(value)
      {
      case 0:
         mVk->SetKeyType(true,0,0,0,0);
         break;
      case 1:
         mVk->SetKeyType(0,true,0,0,0);
         break;
      case 2:
         mVk->SetKeyType(0,0,true,0,0);
         break;
      case 3:
         mVk->SetKeyType(0,0,0,true,0);
         break;
      case 4:
         mVk->SetKeyType(0,0,0,0,true);
         break;
      }
 
}
#endif
 
void TranscriptionToolBar::ShowPlaySpeedDialog()
{
   mPlaySpeedSlider->ShowDialog();
   mPlaySpeedSlider->Refresh();
   wxCommandEvent e;
   OnSpeedSlider(e);
}
 
void TranscriptionToolBar::SetEnabled(bool enabled)
{
   mButtons[TTB_PlaySpeed]->SetEnabled(enabled);
}
 
void TranscriptionToolBar::SetPlaying(bool down, bool looped, bool cutPreview)
{
   AButton *const button = mButtons[TTB_PlaySpeed];
   if (down) {
      button->SetAlternateIdx(cutPreview ? 2 : looped ? 1 : 0);
      button->PushDown();
   }
   else {
      button->SetAlternateIdx(0);
      button->PopUp();
   }
}
 
void TranscriptionToolBar::AdjustPlaySpeed(float adj)
{
   if (adj < 0) {
      mPlaySpeedSlider->Decrease(-adj);
   }
   else {
      mPlaySpeedSlider->Increase(adj);
   }
   wxCommandEvent e;
   OnSpeedSlider(e);
}
 
static RegisteredToolbarFactory factory{
   []( AudacityProject &project ){
      return ToolBar::Holder{ safenew TranscriptionToolBar{ project } }; }
};
 
namespace {
AttachedToolBarMenuItem sAttachment{
   /* i18n-hint: Clicking this menu item shows the toolbar
      for transcription (currently just vary play speed) */
   TranscriptionToolBar::ID(),
   wxT("ShowTranscriptionTB"), XXO("Pla&y-at-Speed Toolbar")
};
}
 
// Menu handler functions
 
#include "../CommonCommandFlags.h"
 
namespace {
void OnPlayAtSpeed(const CommandContext &context)
{
   auto &project = context.project;
   auto tb = &TranscriptionToolBar::Get( project );
 
   if (tb) {
      tb->PlayAtSpeed(false, false);
   }
}
 
void OnPlayAtSpeedLooped(const CommandContext &context)
{
   auto &project = context.project;
   auto tb = &TranscriptionToolBar::Get( project );
 
   if (tb) {
      tb->PlayAtSpeed(true, false);
   }
}
 
void OnPlayAtSpeedCutPreview(const CommandContext &context)
{
   auto &project = context.project;
   auto tb = &TranscriptionToolBar::Get( project );
 
   if (tb) {
      tb->PlayAtSpeed(false, true);
   }
}
 
void OnSetPlaySpeed(const CommandContext &context)
{
   auto &project = context.project;
   auto tb = &TranscriptionToolBar::Get( project );
 
   if (tb) {
      tb->ShowPlaySpeedDialog();
   }
}
 
void OnPlaySpeedInc(const CommandContext &context)
{
   auto &project = context.project;
   auto tb = &TranscriptionToolBar::Get( project );
 
   if (tb) {
      tb->AdjustPlaySpeed(0.1f);
   }
}
 
void OnPlaySpeedDec(const CommandContext &context)
{
   auto &project = context.project;
   auto tb = &TranscriptionToolBar::Get( project );
 
   if (tb) {
      tb->AdjustPlaySpeed(-0.1f);
   }
}
 
using namespace MenuTable;
 
BaseItemSharedPtr ExtraPlayAtSpeedMenu()
{
   static BaseItemSharedPtr menu{
      Menu( wxT("PlayAtSpeed"), XXO("&Play-at-Speed") ) };
   return menu;
}
 
AttachedItem sAttachment2{
   wxT("Optional/Extra/Part1"),
   Shared( ExtraPlayAtSpeedMenu() )
};
 
BaseItemSharedPtr ExtraPlayAtSpeedItems()
{
   static BaseItemSharedPtr items{
   Items( "",
      /* i18n-hint: 'Normal Play-at-Speed' doesn't loop or cut preview. */
      Command( wxT("PlayAtSpeedLooped"), XXO("&Play-at-Speed"),
         OnPlayAtSpeedLooped, CaptureNotBusyFlag() ),
      Command( wxT("PlayAtSpeed"), XXO("Play-at-Speed &Once"),
         OnPlayAtSpeed, CaptureNotBusyFlag() ),
      Command( wxT("PlayAtSpeedCutPreview"), XXO("Play C&ut Preview-at-Speed"),
         OnPlayAtSpeedCutPreview, CaptureNotBusyFlag() ),
      Command( wxT("SetPlaySpeed"), XXO("Ad&just Playback Speed..."),
         OnSetPlaySpeed, CaptureNotBusyFlag() ),
      Command( wxT("PlaySpeedInc"), XXO("&Increase Playback Speed"),
         OnPlaySpeedInc, CaptureNotBusyFlag() ),
      Command( wxT("PlaySpeedDec"), XXO("&Decrease Playback Speed"),
         OnPlaySpeedDec, CaptureNotBusyFlag() )
   ) };
   return items;
}
 
AttachedItem sAttachment3{
   Placement{ wxT("Optional/Extra/Part1/PlayAtSpeed"),
     OrderingHint::Begin },
   Shared( ExtraPlayAtSpeedItems() )
};
 
}