AudacityMirProject Class Reference

#include <AudacityMirProject.h>

Inheritance diagram for AudacityMirProject:

Collaboration diagram for AudacityMirProject:

Public Member Functions
	AudacityMirProject (AudacityProject &project)
	~AudacityMirProject () override
bool	ViewIsBeatsAndMeasures () const override
void	ReconfigureMusicGrid (double newTempo, std::optional< MIR::TimeSignature > timeSignature) override
double	GetTempo () const override
bool	ShouldBeReconfigured (double newTempo, bool isSingleFileImport) override
void	OnClipsSynchronized () override
Public Member Functions inherited from MIR::ProjectInterface
virtual	~ProjectInterface ()=default
virtual bool	ViewIsBeatsAndMeasures () const =0
virtual void	ReconfigureMusicGrid (double newTempo, std::optional< MIR::TimeSignature > timeSignature)=0
virtual double	GetTempo () const =0
virtual bool	ShouldBeReconfigured (double newTempo, bool isSingleFileImport)=0
virtual void	OnClipsSynchronized ()=0

Private Types
enum class	ModificationType { Automatic , Manual }

Private Attributes
AudacityProject &	mProject
const double	mProjectTempo
const bool	mImportedOnEmptyProject
std::optional< ModificationType >	mMostSignificantModification
bool	mProjectWasModified = false

Detailed Description

Definition at line 17 of file AudacityMirProject.h.

Member Enumeration Documentation

ModificationType

enum class AudacityMirProject::ModificationType

strongprivate

Enumerator
Automatic
Manual

Definition at line 36 of file AudacityMirProject.h.

   {
      Automatic,
      Manual,
   };

Constructor & Destructor Documentation

AudacityMirProject()

AudacityMirProject::AudacityMirProject ( AudacityProject &  project )

explicit

Definition at line 33 of file AudacityMirProject.cpp.

    : mProject { project }
    , mImportedOnEmptyProject { TrackList::Get(mProject)
                                   .Any<WaveTrack>()
                                   .empty() }
    , mProjectTempo { ProjectTimeSignature::Get(mProject).GetTempo() }
{
}

~AudacityMirProject()

AudacityMirProject::~AudacityMirProject ( )

override

Definition at line 42 of file AudacityMirProject.cpp.

{
   if (!mProjectWasModified)
      return;
   assert(mMostSignificantModification.has_value());
   auto& ph = ProjectHistory::Get(mProject);
   if (mMostSignificantModification == ModificationType::Automatic)
      ph.ModifyState(true);
   else if (mMostSignificantModification == ModificationType::Manual)
      ph.PushState(
         XO("Configure Project from Music File"),
         XO("Automatic Music Configuration"));
}

References Automatic, ProjectHistory::Get(), Manual, mMostSignificantModification, mProject, mProjectWasModified, and XO().

Here is the call graph for this function:

Member Function Documentation

GetTempo()

double AudacityMirProject::GetTempo ( ) const

overridevirtual

Implements MIR::ProjectInterface.

Definition at line 79 of file AudacityMirProject.cpp.

{
   return mProjectTempo;
}

References mProjectTempo.

OnClipsSynchronized()

void AudacityMirProject::OnClipsSynchronized ( )

overridevirtual

Implements MIR::ProjectInterface.

Definition at line 113 of file AudacityMirProject.cpp.

{
   mProjectWasModified = true;
   if (mMostSignificantModification != ModificationType::Manual)
      mMostSignificantModification = ModificationType::Automatic;
}

References Automatic, Manual, mMostSignificantModification, and mProjectWasModified.

ReconfigureMusicGrid()

void AudacityMirProject::ReconfigureMusicGrid ( double  newTempo, std::optional< MIR::TimeSignature >  timeSignature  )

override

Definition at line 62 of file AudacityMirProject.cpp.

{
   AdornedRulerPanel::Get(mProject).SetTimeDisplayMode(
      TimeDisplayMode::BeatsAndMeasures);
   auto& projTimeSignature = ProjectTimeSignature::Get(mProject);
   projTimeSignature.SetTempo(newTempo);
   if (timeSignature.has_value())
   {
      projTimeSignature.SetUpperTimeSignature(
         MIR::GetNumerator(*timeSignature));
      projTimeSignature.SetLowerTimeSignature(
         MIR::GetDenominator(*timeSignature));
   }
   mProjectWasModified = true;
}

References BeatsAndMeasures, ProjectTimeSignature::Get(), AdornedRulerPanel::Get(), MIR::GetDenominator(), MIR::GetNumerator(), mProject, mProjectWasModified, and AdornedRulerPanel::SetTimeDisplayMode().

Here is the call graph for this function:

ShouldBeReconfigured()

bool AudacityMirProject::ShouldBeReconfigured ( double  newTempo, bool  isSingleFileImport  )

overridevirtual

Implements MIR::ProjectInterface.

Definition at line 84 of file AudacityMirProject.cpp.

{
   const auto policy = ImportExportPrefs::MusicFileImportSetting.Read();
   if (policy == wxString("Ask"))
   {
      const auto displayedTempo = FormatTempo(newTempo);
      const auto message =
         isSingleFileImport ?
            XO("Audacity detected this file to be %s bpm.\nWould you like to enable music view and set the project tempo to %s?")
               .Format(displayedTempo, displayedTempo) :
            XO("Audacity detected one or more files to be %s bpm.\nWould you like to enable music view and set the project tempo to %s?")
               .Format(displayedTempo, displayedTempo);
      AudacityDontAskAgainMessageDialog m(
         &GetProjectPanel(mProject), XO("Music Import"), message);
      const auto yes = m.ShowDialog();
      if (m.IsChecked())
         ImportExportPrefs::MusicFileImportSetting.Write(
            yes ? wxString("Yes") : wxString("No"));
      if (yes)
         mMostSignificantModification = ModificationType::Manual;
      return yes;
   }
   const auto yes = policy == wxString("Yes");
   if (yes)
      mMostSignificantModification = ModificationType::Automatic;
   return yes;
}

References Automatic, anonymous_namespace{AudacityMirProject.cpp}::FormatTempo(), GetProjectPanel(), AudacityDontAskAgainMessageDialog::IsChecked(), Manual, mMostSignificantModification, mProject, ImportExportPrefs::MusicFileImportSetting, ChoiceSetting::Read(), AudacityDontAskAgainMessageDialog::ShowDialog(), ChoiceSetting::Write(), and XO().

Here is the call graph for this function:

ViewIsBeatsAndMeasures()

bool AudacityMirProject::ViewIsBeatsAndMeasures ( ) const

overridevirtual

Implements MIR::ProjectInterface.

Definition at line 56 of file AudacityMirProject.cpp.

{
   return AdornedRulerPanel::Get(mProject).GetTimeDisplayMode() ==
          TimeDisplayMode::BeatsAndMeasures;
}

References BeatsAndMeasures, AdornedRulerPanel::Get(), AdornedRulerPanel::GetTimeDisplayMode(), and mProject.

Here is the call graph for this function:

Member Data Documentation

mImportedOnEmptyProject

const bool AudacityMirProject::mImportedOnEmptyProject

private

Definition at line 44 of file AudacityMirProject.h.

mMostSignificantModification

std::optional<ModificationType> AudacityMirProject::mMostSignificantModification

private

Definition at line 45 of file AudacityMirProject.h.

Referenced by OnClipsSynchronized(), ShouldBeReconfigured(), and ~AudacityMirProject().

mProject

AudacityProject& AudacityMirProject::mProject

private

Definition at line 42 of file AudacityMirProject.h.

Referenced by ReconfigureMusicGrid(), ShouldBeReconfigured(), ViewIsBeatsAndMeasures(), and ~AudacityMirProject().

mProjectTempo

const double AudacityMirProject::mProjectTempo

private

Definition at line 43 of file AudacityMirProject.h.

Referenced by GetTempo().

mProjectWasModified

bool AudacityMirProject::mProjectWasModified = false

private

Definition at line 46 of file AudacityMirProject.h.

Referenced by OnClipsSynchronized(), ReconfigureMusicGrid(), and ~AudacityMirProject().

---

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

• AudacityMirProject.h
• AudacityMirProject.cpp