FormatMenuTable Struct Reference

Inheritance diagram for FormatMenuTable:

Collaboration diagram for FormatMenuTable:

Public Member Functions
	FormatMenuTable ()
	DECLARE_POPUP_MENU (FormatMenuTable)
void	InitUserData (void *pUserData) override
	Called before the menu items are appended. More...
void	OnFormatChange (wxCommandEvent &event)
Public Member Functions inherited from PopupMenuTable
	PopupMenuTable (const Identifier &id, const TranslatableString &caption={})
const Identifier &	Id () const
const TranslatableString &	Caption () const
const auto *	GetRegistry () const
const auto &	Get (void *pUserData)
void	Clear ()
Public Member Functions inherited from PopupMenuHandler
	PopupMenuHandler ()=default
	PopupMenuHandler (const PopupMenuHandler &)=delete
PopupMenuHandler &	operator= (const PopupMenuHandler &)=delete
virtual void	InitUserData (void *pUserData)=0
	Called before the menu items are appended. More...

Static Public Member Functions
static FormatMenuTable &	Instance ()
static int	IdOfFormat (sampleFormat format)
	Converts a format enumeration to a wxWidgets menu item Id. More...
Static Public Member Functions inherited from PopupMenuTable
static std::unique_ptr< PopupMenu >	BuildMenu (PopupMenuTable *pTable, void *pUserData=NULL)
static void	ExtendMenu (PopupMenu &menu, PopupMenuTable &otherTable)
template<typename Table , typename Factory >
static auto	Adapt (const Factory &factory)

Public Attributes
PlayableTrackControls::InitMenuData *	mpData {}

Additional Inherited Members
Public Types inherited from PopupMenuTable
using	Entry = PopupMenuTableEntry
Protected Member Functions inherited from PopupMenuTable
virtual void	Populate ()=0
template<typename Ptr >
void	Append (Ptr pItem)
void	Append (const Identifier &stringId, PopupMenuTableEntry::Type type, int id, const TranslatableString &string, wxCommandEventFunction memFn, const PopupMenuTableEntry::InitFunction &init)
void	AppendItem (const Identifier &stringId, int id, const TranslatableString &string, wxCommandEventFunction memFn, const PopupMenuTableEntry::InitFunction &init={})
void	AppendRadioItem (const Identifier &stringId, int id, const TranslatableString &string, wxCommandEventFunction memFn, const PopupMenuTableEntry::InitFunction &init={})
void	AppendCheckItem (const Identifier &stringId, int id, const TranslatableString &string, wxCommandEventFunction memFn, const PopupMenuTableEntry::InitFunction &init={})
void	BeginSection (const Identifier &name)
void	EndSection ()
Static Protected Member Functions inherited from PopupMenuTable
static TranslatableString	MakeLabel (const TranslatableString &label, bool useExtra, const TranslatableString &extra)
Protected Attributes inherited from PopupMenuTable
std::shared_ptr< PopupSubMenu >	mTop
std::vector< PopupMenuGroupItem * >	mStack
Identifier	mId
TranslatableString	mCaption
std::unique_ptr< PopupMenuGroupItem >	mRegistry

Detailed Description

Definition at line 166 of file WaveTrackControls.cpp.

Constructor & Destructor Documentation

FormatMenuTable()

FormatMenuTable::FormatMenuTable ( )

inline

Definition at line 168 of file WaveTrackControls.cpp.

      : PopupMenuTable{ "SampleFormat", XO("&Format") }
   {}

Member Function Documentation

DECLARE_POPUP_MENU()

FormatMenuTable::DECLARE_POPUP_MENU

(

FormatMenuTable

)

IdOfFormat()

int FormatMenuTable::IdOfFormat ( sampleFormat  format )

static

Converts a format enumeration to a wxWidgets menu item Id.

Definition at line 213 of file WaveTrackControls.cpp.

{
   switch (format) {
   case int16Sample:
      return On16BitID;
   case int24Sample:
      return On24BitID;
   case floatSample:
      return OnFloatID;
   default:
      // ERROR -- should not happen
      wxASSERT(false);
      break;
   }
   return OnFloatID;// Compiler food.
}

References floatSample, anonymous_namespace{ExportPCM.cpp}::format, int16Sample, int24Sample, On16BitID, On24BitID, and OnFloatID.

InitUserData()

void FormatMenuTable::InitUserData ( void *  pUserData )

overridevirtual

Called before the menu items are appended.

Store context data, if needed. May be called more than once before the menu opens. Pointer remains valid for the duration of any callback, if PopupMenuTable::BuildMenu() is called and the result's Popup() is called before any other menus are built.

Implements PopupMenuHandler.

Definition at line 190 of file WaveTrackControls.cpp.

{
   mpData = static_cast<PlayableTrackControls::InitMenuData*>(pUserData);
}

References mpData.

Instance()

FormatMenuTable & FormatMenuTable::Instance ( )

static

Definition at line 184 of file WaveTrackControls.cpp.

{
   static FormatMenuTable instance;
   return instance;
}

OnFormatChange()

void FormatMenuTable::OnFormatChange

(

wxCommandEvent &

event

)

Handles the selection from the Format submenu of the track menu.

Definition at line 232 of file WaveTrackControls.cpp.

{
   int id = event.GetId();
   wxASSERT(id >= On16BitID && id <= OnFloatID);
   auto &track = static_cast<WaveTrack&>(mpData->track);
 
   sampleFormat newFormat = int16Sample;
 
   switch (id) {
   case On16BitID:
      newFormat = int16Sample;
      break;
   case On24BitID:
      newFormat = int24Sample;
      break;
   case OnFloatID:
      newFormat = floatSample;
      break;
   default:
      // ERROR -- should not happen
      wxASSERT(false);
      break;
   }
   if (newFormat == track.GetSampleFormat())
      return; // Nothing to do.
 
   AudacityProject *const project = &mpData->project;
 
   ProgressDialog progress{ XO("Changing sample format"),
                            XO("Processing...   0%%"),
                            pdlgHideStopButton };
 
   // Simply finding a denominator for the progress dialog
   // Hidden samples are processed too, they should be counted as well
   // (Correctly counting all samples of all channels)
   const sampleCount totalSamples =
      WaveTrackUtilities::GetSequenceSamplesCount(track);
   sampleCount processedSamples{ 0 };
 
   // Below is the lambda function that is passed along the call chain to
   // the Sequence::ConvertToSampleFormat. This callback function is used
   // to report the conversion progress and update the progress dialog.
   auto progressUpdate = [&progress, &totalSamples, &processedSamples]
   (size_t newlyProcessedCount)->void
   {
      processedSamples += newlyProcessedCount;
      double d_processed = processedSamples.as_double();
      double d_total = totalSamples.as_double();
      int percentage{ static_cast<int>((d_processed / d_total) * 100) };
 
      auto progressStatus = progress.Update(d_processed, d_total,
         XO("Processing...   %i%%").Format(percentage));
 
      if (progressStatus != ProgressResult::Success)
         throw UserException{};
   };
 
   track.ConvertToSampleFormat(newFormat, progressUpdate);
 
   ProjectHistory::Get( *project )
   /* i18n-hint: The strings name a track and a format */
      .PushState(XO("Changed '%s' to %s")
         .Format(track.GetName(), GetSampleFormatStr(newFormat)),
      XO("Format Change"));
 
   using namespace RefreshCode;
   mpData->result = RefreshAll | FixScrollbars;
}

References sampleCount::as_double(), RefreshCode::FixScrollbars, floatSample, ProjectHistory::Get(), GetSampleFormatStr(), WaveTrackUtilities::GetSequenceSamplesCount(), int16Sample, int24Sample, mpData, On16BitID, On24BitID, OnFloatID, pdlgHideStopButton, project, CommonTrackControls::InitMenuData::project, ProjectHistory::PushState(), RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, BasicUI::Success, CommonTrackControls::InitMenuData::track, and XO().

Here is the call graph for this function:

Member Data Documentation

mpData

PlayableTrackControls::InitMenuData* FormatMenuTable::mpData {}

Definition at line 177 of file WaveTrackControls.cpp.

Referenced by InitUserData(), and OnFormatChange().

---

The documentation for this struct was generated from the following file:

• WaveTrackControls.cpp