anonymous_namespace{TimerRecordDialog.cpp} Namespace Reference

Functions
void	OnTimerRecord (const CommandContext &context)

Variables
StringSetting	DefaultExportAudioFormat { L"/TimerRecordDialog/ExportFormat", L"WAV" }
StringSetting	DefaultExportAudioPath { L"/TimerRecordDialog/ExportPath", L"" }
const auto	CanStopFlags = AudioIONotBusyFlag() | CanStopAudioStreamFlag()
AttachedItem	sAttachment

Function Documentation

OnTimerRecord()

void anonymous_namespace{TimerRecordDialog.cpp}::OnTimerRecord

(

const CommandContext &

context

)

Definition at line 1183 of file TimerRecordDialog.cpp.

{
   auto &project = context.project;
   const auto &settings = ProjectSettings::Get( project );
   auto &undoManager = UndoManager::Get( project );
   auto &window = GetProjectFrame(project);
 
   // MY: Due to improvements in how Timer Recording saves and/or exports
   // it is now safer to disable Timer Recording when there is more than
   // one open project.
   if (AllProjects{}.size() > 1) {
      AudacityMessageBox(
         XO(
"Timer Recording cannot be used with more than one open project.\n\nPlease close any additional projects and try again."),
         XO("Timer Recording"),
         wxICON_INFORMATION | wxOK);
      return;
   }
 
   // MY: If the project has unsaved changes then we no longer allow access
   // to Timer Recording.  This decision has been taken as the safest approach
   // preventing issues surrounding "dirty" projects when Automatic Save/Export
   // is used in Timer Recording.
   if ((undoManager.UnsavedChanges()) && (!TrackList::Get(project).empty() )) {
      AudacityMessageBox(
         XO(
"Timer Recording cannot be used while you have unsaved changes.\n\nPlease save or close this project and try again."),
         XO("Timer Recording"),
         wxICON_INFORMATION | wxOK);
      return;
   }
 
   // We check the selected tracks to see if there is enough of them to accommodate
   // all input channels and all of them have the same sampling rate.
   // Those checks will be later performed by recording function anyway,
   // but we want to warn the user about potential problems from the very start.
   const auto selectedTracks{ GetPropertiesOfSelected(project) };
   const int rateOfSelected{ selectedTracks.rateOfSelected };
   const bool anySelected{ selectedTracks.anySelected };
   const bool allSameRate{ selectedTracks.allSameRate };
 
   if (!allSameRate) {
      AudacityMessageBox(XO("The tracks selected "
         "for recording must all have the same sampling rate"),
         XO("Mismatched Sampling Rates"),
         wxICON_ERROR | wxCENTRE);
 
      return;
   }
 
   // Only need the size
   const auto existingTracks =
      ProjectAudioManager::ChooseExistingRecordingTracks(project, true,
      rateOfSelected);
   if (existingTracks.empty()) {
      if (anySelected && rateOfSelected !=
          ProjectRate::Get(project).GetRate()) {
         AudacityMessageBox(XO(
            "Too few tracks are selected for recording at this sample rate.\n"
            "(Audacity requires two channels at the same sample rate for\n"
            "each stereo track)"),
            XO("Too Few Compatible Tracks Selected"),
            wxICON_ERROR | wxCENTRE);
 
         return;
      }
   }
 
   // We use this variable to display "Current Project" in the Timer Recording
   // save project field
   bool bProjectSaved = !ProjectFileIO::Get( project ).IsModified();
 
   //we break the prompting and waiting dialogs into two sections
   //because they both give the user a chance to click cancel
   //and therefore remove the newly inserted track.
 
   TimerRecordDialog dialog(
      &window, project, bProjectSaved); /* parent, project, project saved? */
   int modalResult = dialog.ShowModal();
   if (modalResult == wxID_CANCEL)
   {
      // Cancelled before recording - don't need to do anything.
   }
   else
   {
      // Bug #2382
      // Allow recording to start at current cursor position.
      #if 0
      // Timer Record should not record into a selection.
      bool bPreferNewTrack;
      gPrefs->Read("/GUI/PreferNewTrackRecord",&bPreferNewTrack, false);
      if (bPreferNewTrack) {
         window.Rewind(false);
      } else {
         window.SkipEnd(false);
      }
      #endif
 
      int iTimerRecordingOutcome = dialog.RunWaitDialog();
      switch (iTimerRecordingOutcome) {
      case POST_TIMER_RECORD_CANCEL_WAIT:
         // Canceled on the wait dialog
         ProjectHistory::Get( project ).RollbackState();
         break;
      case POST_TIMER_RECORD_CANCEL:
         // RunWaitDialog() shows the "wait for start" as well as "recording"
         // dialog if it returned POST_TIMER_RECORD_CANCEL it means the user
         // cancelled while the recording, so throw out the fresh track.
         // However, we can't undo it here because the PushState() is called in TrackPanel::OnTimer(),
         // which is blocked by this function.
         // so instead we mark a flag to undo it there.
         ProjectAudioManager::Get( project ).SetTimerRecordCancelled();
         break;
      case POST_TIMER_RECORD_NOTHING:
         // No action required
         break;
      case POST_TIMER_RECORD_CLOSE:
         wxTheApp->CallAfter( []{
            // Simulate the application Exit menu item
            wxCommandEvent evt{ wxEVT_MENU, wxID_EXIT };
            wxTheApp->AddPendingEvent( evt );
         } );
         ProjectManager::Get(project).SetSkipSavePrompt(true);
         break;
 
#ifdef __WINDOWS__
      case POST_TIMER_RECORD_RESTART:
         // Restart System
         ProjectManager::Get(project).SetSkipSavePrompt(true);
         system("shutdown /r /f /t 30");
         break;
      case POST_TIMER_RECORD_SHUTDOWN:
         // Shutdown System
         ProjectManager::Get(project).SetSkipSavePrompt(true);
         system("shutdown /s /f /t 30");
         break;
#endif
      }
   }
}

References AudacityMessageBox(), ProjectAudioManager::ChooseExistingRecordingTracks(), TrackList::empty(), ProjectFileIO::Get(), ProjectHistory::Get(), UndoManager::Get(), ProjectRate::Get(), TrackList::Get(), ProjectAudioManager::Get(), ProjectManager::Get(), ProjectSettings::Get(), GetProjectFrame(), GetPropertiesOfSelected(), anonymous_namespace{TimeTrack.cpp}::GetRate(), gPrefs, ProjectFileIO::IsModified(), POST_TIMER_RECORD_CANCEL, POST_TIMER_RECORD_CANCEL_WAIT, POST_TIMER_RECORD_CLOSE, POST_TIMER_RECORD_NOTHING, CommandContext::project, project, PropertiesOfSelected::rateOfSelected, audacity::BasicSettings::Read(), ProjectHistory::RollbackState(), TimerRecordDialog::RunWaitDialog(), ProjectManager::SetSkipSavePrompt(), ProjectAudioManager::SetTimerRecordCancelled(), settings(), AllProjects::size(), and XO().

Here is the call graph for this function:

Variable Documentation

CanStopFlags

const auto anonymous_namespace{TimerRecordDialog.cpp}::CanStopFlags = AudioIONotBusyFlag() | CanStopAudioStreamFlag()

Definition at line 1324 of file TimerRecordDialog.cpp.

Referenced by anonymous_namespace{SelectMenus.cpp}::CursorMenu(), and anonymous_namespace{TransportMenus.cpp}::TransportMenu().

DefaultExportAudioFormat

StringSetting anonymous_namespace{TimerRecordDialog.cpp}::DefaultExportAudioFormat { L"/TimerRecordDialog/ExportFormat", L"WAV" }

Definition at line 106 of file TimerRecordDialog.cpp.

Referenced by TimerRecordDialog::ExecutePostRecordActions().

DefaultExportAudioPath

StringSetting anonymous_namespace{TimerRecordDialog.cpp}::DefaultExportAudioPath { L"/TimerRecordDialog/ExportPath", L"" }

Definition at line 107 of file TimerRecordDialog.cpp.

Referenced by TimerRecordDialog::ExecutePostRecordActions().

sAttachment

AttachedItem anonymous_namespace{TimerRecordDialog.cpp}::sAttachment

Initial value:

{
   Command( wxT("TimerRecord"), XXO("&Timer Record..."),
      OnTimerRecord, CanStopFlags, wxT("Shift+T") ),
   { wxT("Transport/Basic/Record"),
      { OrderingHint::After, wxT("Record2ndChoice") } }
}

Definition at line 1327 of file TimerRecordDialog.cpp.