ImportRawDialog Class Reference

ImportRawDialog prompts you with options such as endianness and sample size to help you importing data of an unknown format. More...

Inheritance diagram for ImportRawDialog:

Collaboration diagram for ImportRawDialog:

Public Member Functions
	ImportRawDialog (wxWindow *parent, const wxString &fileName)
	~ImportRawDialog ()
void	OnOK (wxCommandEvent &event)
void	OnCancel (wxCommandEvent &event)
void	OnPlay (wxCommandEvent &event)
void	OnDetect (wxCommandEvent &event)
void	OnChoice (wxCommandEvent &event)
Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()
	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
void	SetTitle (const TranslatableString &title)
void	SetLabel (const TranslatableString &title)
void	SetName (const TranslatableString &title)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Static Public Attributes
static int	mEncoding = SF_FORMAT_RAW | SF_ENDIAN_CPU | SF_FORMAT_PCM_16
static unsigned	mChannels = 1
static int	mOffset = 0
static double	mRate = 0
static double	mPercent = 100.

Private Attributes
wxButton *	mOK
wxChoice *	mEncodingChoice
wxChoice *	mEndianChoice
wxChoice *	mChannelChoice
wxTextCtrl *	mOffsetText
wxTextCtrl *	mPercentText
wxComboBox *	mRateText
std::vector< int >	mEncodingSubtype
wxString	mFileName

Detailed Description

ImportRawDialog prompts you with options such as endianness and sample size to help you importing data of an unknown format.

Definition at line 58 of file ImportRaw.cpp.

Constructor & Destructor Documentation

ImportRawDialog()

ImportRawDialog::ImportRawDialog	(	wxWindow *	parent,
		const wxString &	fileName
	)

Definition at line 296 of file ImportRaw.cpp.

:  wxDialogWrapper(parent, wxID_ANY, XO("Import Raw Data"),
            wxDefaultPosition, wxDefaultSize,
            wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER),
   mFileName(fileName)
{
   wxASSERT(0 < mChannels && mChannels <= 16);
 
   SetName();
 
   // Append filename at window title
   wxFileName wfn{ fileName };
   wxString windowTitle = XO("%s: %s").Format(GetTitle(), wfn.GetFullName()).Translation();
   wxDialog::SetTitle(windowTitle);
 
   ShuttleGui S(this, eIsCreating);
   TranslatableStrings encodings;
 
   int num = sf_num_encodings();
 
   int selection = 0;
   for (int i = 0; i < num; i++) {
      SF_INFO info = { 0 };
 
      int subtype = sf_encoding_index_to_subtype(i);
      info.format = SF_FORMAT_RAW + SF_ENDIAN_LITTLE + subtype;
      info.channels = 1;
      info.samplerate = 44100;
 
      if (sf_format_check(&info)) {
         mEncodingSubtype.push_back(subtype);
         encodings.push_back( Verbatim( sf_encoding_index_name(i) ) );
 
         if ((mEncoding & SF_FORMAT_SUBMASK) == subtype)
            selection = mEncodingSubtype.size() - 1;
      }
   }
 
   TranslatableStrings endians{
      /* i18n-hint: Refers to byte-order.  Don't translate "endianness" if you don't
          know the correct technical word. */
      XO("No endianness") ,
      /* i18n-hint: Refers to byte-order.  Don't translate this if you don't
       know the correct technical word. */
      XO("Little-endian") ,
      /* i18n-hint: Refers to byte-order.  Don't translate this if you don't
         know the correct technical word. */
      XO("Big-endian") ,
      /* i18n-hint: Refers to byte-order.  Don't translate "endianness" if you don't
         know the correct technical word. */
      XO("Default endianness") ,
   };
 
   int endian = getEndianChoice(mEncoding);
 
   TranslatableStrings chans{
      XO("1 Channel (Mono)") ,
      XO("2 Channels (Stereo)") ,
   };
   for (int i = 2; i < 16; i++) {
      chans.push_back( XO("%d Channels").Format( i + 1 ) );
   }
 
   S.StartVerticalLay(false);
   {
      S.SetBorder(5);
      S.StartTwoColumn();
      {
         mEncodingChoice = S.Id(ChoiceID).AddChoice(XXO("Encoding:"),
                                                    encodings,
                                                    selection);
         mEndianChoice = S.Id(ChoiceID).AddChoice(XXO("Byte order:"),
                                                  endians,
                                                  endian);
         mChannelChoice = S.Id(ChoiceID).AddChoice(XXO("Channels:"),
                                                   chans,
                                                   mChannels - 1);
      }
      S.EndTwoColumn();
 
      S.SetBorder(5);
      S.StartMultiColumn(3);
      {
         // Offset text
         /* i18n-hint: (noun)*/
         mOffsetText = S.AddTextBox(XXO("Start offset:"),
                                    wxString::Format(wxT("%d"), mOffset),
                                    12);
         S.AddUnits(XO("bytes"));
 
         // Percent text
         mPercentText = S.AddTextBox(XXO("Amount to import:"),
                                     wxT("100"),
                                     12);
         S.AddUnits(XO("%"));
 
         // Rate text
         wxArrayStringEx rates;
         for (int i = 0; i < AudioIOBase::NumStandardRates; i++) {
            rates.Add(
               wxString::Format(wxT("%d"), AudioIOBase::StandardRates[i]));
         }
 
         /* i18n-hint: (noun)*/
         mRateText = S.AddCombo(XXO("Sample rate:"),
                                wxString::Format(wxT("%d"), (int)mRate),
                                rates);
         /* i18n-hint: This is the abbreviation for "Hertz", or
            cycles per second. */
         S.AddUnits(XO("Hz"));
      }
      S.EndMultiColumn();
 
      S.SetBorder(5);
      S.StartTwoColumn();
      {
         /* i18n-hint: Guess format of raw file */
         S.Id(DetectID).AddButton(XXO("Detect"));
 
         //
         // Preview Pane goes here
         //
 
         S.AddStandardButtons();
      }
      S.EndTwoColumn();
 
      // Find the OK button, and change its text to 'Import'.
      // We MUST set mOK because it is used later.
      mOK = (wxButton *)wxWindow::FindWindowById(wxID_OK, this);
      mOK->SetLabel(_("&Import"));
   }
   S.EndVerticalLay();
 
   Fit();
   SetSizeHints(GetSize());
 
   Centre(wxBOTH);
}

References _, ChoiceID, DetectID, eIsCreating, getEndianChoice(), AudioIOBase::NumStandardRates, S, sf_encoding_index_name(), sf_encoding_index_to_subtype(), sf_num_encodings(), AudioIOBase::StandardRates, Verbatim(), wxT(), XO(), and XXO().

Here is the call graph for this function:

~ImportRawDialog()

ImportRawDialog::~ImportRawDialog

(

)

Definition at line 436 of file ImportRaw.cpp.

{
}

Member Function Documentation

OnCancel()

void ImportRawDialog::OnCancel

(

wxCommandEvent &

event

)

Definition at line 469 of file ImportRaw.cpp.

{
   EndModal(false);
}

OnChoice()

void ImportRawDialog::OnChoice

(

wxCommandEvent &

event

)

Definition at line 504 of file ImportRaw.cpp.

{
   SF_INFO info;
 
   memset(&info, 0, sizeof(SF_INFO));
 
   mEncoding = mEncodingSubtype[mEncodingChoice->GetSelection()];
   mEncoding += (mEndianChoice->GetSelection() * 0x10000000);
 
   info.format = mEncoding | SF_FORMAT_RAW;
   info.channels = mChannelChoice->GetSelection() + 1;
   info.samplerate = 44100;
 
   //mOK = (wxButton *)wxWindow::FindWindowById(wxID_OK, this);
   if (sf_format_check(&info)) {
      mOK->Enable(true);
      return;
   }
 
   // Try it with 1-channel
   info.channels = 1;
   if (sf_format_check(&info)) {
      mChannelChoice->SetSelection(0);
      mOK->Enable(true);
      return;
   }
 
   // Otherwise, this is an unsupported format
   mOK->Enable(false);
}

References mChannelChoice, mEncoding, mEncodingChoice, mEncodingSubtype, mEndianChoice, and mOK.

Referenced by OnDetect().

Here is the caller graph for this function:

OnDetect()

void ImportRawDialog::OnDetect

(

wxCommandEvent &

event

)

Definition at line 478 of file ImportRaw.cpp.

{
   try {
      // Yes, FormatClassifier currently handles filenames in UTF8 format only, that's a TODO ...
      FormatClassifier theClassifier(mFileName.utf8_str());
      mEncoding = theClassifier.GetResultFormatLibSndfile();
      mChannels = theClassifier.GetResultChannels();
   } catch (...) {
      // Something went wrong in FormatClassifier, abort.
      return;
   }
 
   int selection = 0;
   auto iter = std::find(mEncodingSubtype.begin(), mEncodingSubtype.end(), mEncoding & SF_FORMAT_SUBMASK);
   if (iter != mEncodingSubtype.end())   // subtype found
       selection = std::distance(mEncodingSubtype.begin(), iter);
 
   int endian = getEndianChoice(mEncoding);
 
   mEncodingChoice->SetSelection(selection);
   mEndianChoice->SetSelection(endian);
   mChannelChoice->SetSelection(mChannels - 1);
 
   OnChoice(event);
}

References getEndianChoice(), FormatClassifier::GetResultChannels(), FormatClassifier::GetResultFormatLibSndfile(), mChannelChoice, mChannels, mEncoding, mEncodingChoice, mEncodingSubtype, mEndianChoice, mFileName, and OnChoice().

Here is the call graph for this function:

OnOK()

void ImportRawDialog::OnOK

(

wxCommandEvent &

event

)

Definition at line 440 of file ImportRaw.cpp.

{
   long l;
 
   mEncoding = mEncodingSubtype[mEncodingChoice->GetSelection()];
   mEncoding += (mEndianChoice->GetSelection() * 0x10000000);
   mChannels = mChannelChoice->GetSelection() + 1;
   mOffsetText->GetValue().ToLong(&l);
   mOffset = l;
   mPercentText->GetValue().ToDouble(&mPercent);
   mRateText->GetValue().ToDouble(&mRate);
 
   if (mChannels < 1 || mChannels > 16)
      mChannels = 1;
   if (mOffset < 0)
      mOffset = 0;
   if (mPercent < 0.0)
      mPercent = 0.0;
   if (mPercent > 100.0)
      mPercent = 100.0;
   if (mRate < 100.0)
      mRate = 100.0;
   // Highest preset sample rate supported in Audacity 2.3.0 is 384 kHz
   if (mRate > 384000.0)
      mRate = 384000.0;
 
   EndModal(true);
}

References mChannelChoice, mChannels, mEncoding, mEncodingChoice, mEncodingSubtype, mEndianChoice, mOffset, mOffsetText, mPercent, mPercentText, mRate, and mRateText.

OnPlay()

void ImportRawDialog::OnPlay

(

wxCommandEvent &

event

)

Definition at line 474 of file ImportRaw.cpp.

{
}

Member Data Documentation

mChannelChoice

wxChoice* ImportRawDialog::mChannelChoice

private

Definition at line 83 of file ImportRaw.cpp.

Referenced by OnChoice(), OnDetect(), and OnOK().

mChannels

unsigned ImportRawDialog::mChannels = 1

static

Definition at line 73 of file ImportRaw.cpp.

Referenced by ImportRaw(), OnDetect(), and OnOK().

mEncoding

int ImportRawDialog::mEncoding = SF_FORMAT_RAW | SF_ENDIAN_CPU | SF_FORMAT_PCM_16

static

Definition at line 72 of file ImportRaw.cpp.

Referenced by ImportRaw(), OnChoice(), OnDetect(), and OnOK().

mEncodingChoice

wxChoice* ImportRawDialog::mEncodingChoice

private

Definition at line 81 of file ImportRaw.cpp.

Referenced by OnChoice(), OnDetect(), and OnOK().

mEncodingSubtype

std::vector<int> ImportRawDialog::mEncodingSubtype

private

Definition at line 88 of file ImportRaw.cpp.

Referenced by OnChoice(), OnDetect(), and OnOK().

mEndianChoice

wxChoice* ImportRawDialog::mEndianChoice

private

Definition at line 82 of file ImportRaw.cpp.

Referenced by OnChoice(), OnDetect(), and OnOK().

mFileName

wxString ImportRawDialog::mFileName

private

Definition at line 90 of file ImportRaw.cpp.

Referenced by OnDetect().

mOffset

int ImportRawDialog::mOffset = 0

static

Definition at line 74 of file ImportRaw.cpp.

Referenced by ImportRaw(), and OnOK().

mOffsetText

wxTextCtrl* ImportRawDialog::mOffsetText

private

Definition at line 84 of file ImportRaw.cpp.

Referenced by OnOK().

mOK

wxButton* ImportRawDialog::mOK

private

Definition at line 80 of file ImportRaw.cpp.

Referenced by OnChoice().

mPercent

double ImportRawDialog::mPercent = 100.

static

Definition at line 76 of file ImportRaw.cpp.

Referenced by ImportRaw(), and OnOK().

mPercentText

wxTextCtrl* ImportRawDialog::mPercentText

private

Definition at line 85 of file ImportRaw.cpp.

Referenced by OnOK().

mRate

double ImportRawDialog::mRate = 0

static

Definition at line 75 of file ImportRaw.cpp.

Referenced by ImportRaw(), and OnOK().

mRateText

wxComboBox* ImportRawDialog::mRateText

private

Definition at line 86 of file ImportRaw.cpp.

Referenced by OnOK().

---

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

• ImportRaw.cpp