Audacity 3.2.0
Public Member Functions | Static Public Attributes | Private Member Functions | List of all members
StereoToMono Class Reference

#include <StereoToMono.h>

Inheritance diagram for StereoToMono:
[legend]
Collaboration diagram for StereoToMono:
[legend]

Public Member Functions

ComponentInterfaceSymbol GetSymbol () const override
 
TranslatableString GetDescription () const override
 
EffectType GetType () const override
 Type determines how it behaves. More...
 
bool IsInteractive () const override
 Whether the effect needs a dialog for entry of settings. More...
 
unsigned GetAudioInCount () const override
 How many input buffers to allocate at once. More...
 
unsigned GetAudioOutCount () const override
 How many output buffers to allocate at once. More...
 
bool Process (EffectInstance &instance, EffectSettings &settings) override
 
bool IsHiddenFromMenus () const override
 Default is false. More...
 
- Public Member Functions inherited from StatefulEffect
 ~StatefulEffect () override
 
std::shared_ptr< EffectInstanceMakeInstance () const override
 Make an object maintaining short-term state of an Effect. More...
 
- Public Member Functions inherited from StatefulEffectBase
virtual bool Init ()
 
virtual bool Process (EffectInstance &instance, EffectSettings &settings)=0
 
virtual bool RealtimeInitialize (EffectSettings &settings, double sampleRate)
 
virtual bool RealtimeAddProcessor (EffectSettings &settings, EffectOutputs *pOutputs, unsigned numChannels, float sampleRate)
 
virtual bool RealtimeSuspend ()
 
virtual bool RealtimeResume ()
 
virtual bool RealtimeProcessStart (MessagePackage &package)
 settings are possibly changed, since last call, by an asynchronous dialog More...
 
virtual size_t RealtimeProcess (size_t group, EffectSettings &settings, const float *const *inBuf, float *const *outBuf, size_t numSamples)
 
virtual bool RealtimeProcessEnd (EffectSettings &settings) noexcept
 settings can be updated to let a dialog change appearance at idle More...
 
virtual bool RealtimeFinalize (EffectSettings &settings) noexcept
 
virtual size_t SetBlockSize (size_t maxBlockSize)
 
virtual size_t GetBlockSize () const
 
virtual unsigned GetAudioInCount () const
 How many input buffers to allocate at once. More...
 
virtual unsigned GetAudioOutCount () const
 How many output buffers to allocate at once. More...
 
virtual sampleCount GetLatency () const
 
virtual bool NeedsDither () const
 
virtual bool ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap=nullptr)
 
virtual bool ProcessFinalize () noexcept
 
- Public Member Functions inherited from Effect
 Effect ()
 
virtual ~Effect ()
 
PluginPath GetPath () const override
 
bool VisitSettings (SettingsVisitor &visitor, EffectSettings &settings) override
 
bool VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const override
 
ComponentInterfaceSymbol GetSymbol () const override
 
VendorSymbol GetVendor () const override
 
wxString GetVersion () const override
 
TranslatableString GetDescription () const override
 
EffectFamilySymbol GetFamily () const override
 Report identifier and user-visible name of the effect protocol. More...
 
bool IsInteractive () const override
 Whether the effect needs a dialog for entry of settings. More...
 
bool IsDefault () const override
 Whether the effect sorts "above the line" in the menus. More...
 
RealtimeSince RealtimeSupport () const override
 Since which version of Audacity has the effect supported realtime? More...
 
bool SupportsAutomation () const override
 Whether the effect has any automatable controls. More...
 
bool SaveSettings (const EffectSettings &settings, CommandParameters &parms) const override
 Store settings as keys and values. More...
 
bool LoadSettings (const CommandParameters &parms, EffectSettings &settings) const override
 Restore settings from keys and values. More...
 
OptionalMessage LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override
 
bool SaveUserPreset (const RegistryPath &name, const EffectSettings &settings) const override
 Save settings in the configuration file as a user-named preset. More...
 
RegistryPaths GetFactoryPresets () const override
 Report names of factory presets. More...
 
OptionalMessage LoadFactoryPreset (int id, EffectSettings &settings) const override
 
OptionalMessage LoadFactoryDefaults (EffectSettings &settings) const override
 
virtual const EffectParameterMethodsParameters () const
 
bool CanExportPresets () const override
 Whether the effect supports export of presets to files, and importing too. More...
 
bool HasOptions () const override
 
const EffectSettingsManagerGetDefinition () const override
 
virtual NumericFormatID GetSelectionFormat ()
 
bool SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const override
 
OptionalMessage LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const override
 
bool IsBatchProcessing () const override
 
void SetBatchProcessing () override
 
void UnsetBatchProcessing () override
 
unsigned TestUIFlags (unsigned mask)
 
bool Delegate (Effect &delegate, EffectSettings &settings, InstanceFinder finder={})
 Re-invoke DoEffect on another Effect object that implements the work. More...
 
- Public Member Functions inherited from EffectBase
 EffectBase ()
 
 ~EffectBase () override
 
bool IsLinearEffect () const
 
bool PreviewsFullSelection () const
 
void SetTracks (TrackList *pTracks)
 
double GetDefaultDuration ()
 
virtual std::any BeginPreview (const EffectSettings &settings)
 Called when Preview() starts, to allow temporary effect state changes. More...
 
bool DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess) override
 
virtual double CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0
 
void CountWaveTracks ()
 
- Public Member Functions inherited from EffectPlugin
EffectPluginoperator= (EffectPlugin &)=delete
 
virtual ~EffectPlugin ()
 
virtual bool HasOptions () const =0
 
virtual bool CanExportPresets () const =0
 Whether the effect supports export of presets to files, and importing too. More...
 
virtual const EffectSettingsManagerGetDefinition () const =0
 
virtual bool SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const =0
 
virtual OptionalMessage LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const =0
 
virtual bool IsBatchProcessing () const =0
 
virtual void SetBatchProcessing ()=0
 
virtual void UnsetBatchProcessing ()=0
 
virtual bool DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess=nullptr)=0
 
- Public Member Functions inherited from EffectInstanceFactory
virtual ~EffectInstanceFactory ()
 
virtual std::shared_ptr< EffectInstanceMakeInstance () const =0
 Make an object maintaining short-term state of an Effect. More...
 
- Public Member Functions inherited from EffectSettingsManager
virtual ~EffectSettingsManager ()
 
virtual bool VisitSettings (SettingsVisitor &visitor, EffectSettings &settings)
 
virtual bool VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const
 
virtual EffectSettings MakeSettings () const
 
virtual bool CopySettingsContents (const EffectSettings &src, EffectSettings &dst) const
 Update one settings object from another. More...
 
virtual std::unique_ptr< EffectOutputsMakeOutputs () const
 Produce an object to hold values to send to effect output meters. More...
 
- Public Member Functions inherited from EffectDefinitionInterface
virtual ~EffectDefinitionInterface ()
 
virtual EffectType GetType () const =0
 Type determines how it behaves. More...
 
virtual EffectType GetClassification () const
 Determines which menu it appears in; default same as GetType(). More...
 
virtual EffectFamilySymbol GetFamily () const =0
 Report identifier and user-visible name of the effect protocol. More...
 
virtual bool IsInteractive () const =0
 Whether the effect needs a dialog for entry of settings. More...
 
virtual bool IsDefault () const =0
 Whether the effect sorts "above the line" in the menus. More...
 
virtual RealtimeSince RealtimeSupport () const =0
 Since which version of Audacity has the effect supported realtime? More...
 
bool SupportsRealtime () const
 
virtual bool SupportsAutomation () const =0
 Whether the effect has any automatable controls. More...
 
virtual bool EnablesDebug () const
 Whether the effect dialog should have a Debug button; default, always false. More...
 
virtual ManualPageID ManualPage () const
 Name of a page in the Audacity alpha manual, default is empty. More...
 
virtual FilePath HelpPage () const
 Fully qualified local help file name, default is empty. More...
 
virtual bool IsHiddenFromMenus () const
 Default is false. More...
 
- Public Member Functions inherited from ComponentInterface
virtual ~ComponentInterface ()
 
virtual PluginPath GetPath () const =0
 
virtual ComponentInterfaceSymbol GetSymbol () const =0
 
virtual VendorSymbol GetVendor () const =0
 
virtual wxString GetVersion () const =0
 
virtual TranslatableString GetDescription () const =0
 
TranslatableString GetName () const
 

Static Public Attributes

static const ComponentInterfaceSymbol Symbol { XO("Stereo To Mono") }
 
- Static Public Attributes inherited from EffectPlugin
static const wxString kUserPresetIdent = wxT("User Preset:")
 
static const wxString kFactoryPresetIdent = wxT("Factory Preset:")
 
static const wxString kCurrentSettingsIdent = wxT("<Current Settings>")
 
static const wxString kFactoryDefaultsIdent = wxT("<Factory Defaults>")
 

Private Member Functions

bool ProcessOne (TrackList &outputs, sampleCount &curTime, sampleCount totalTime, WaveTrack &track)
 

Additional Inherited Members

- Public Types inherited from StatefulEffectBase
using MessagePackage = EffectInstance::MessagePackage
 
- Public Types inherited from EffectPlugin
using EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess >
 
using InstancePointer = std::shared_ptr< EffectInstanceEx >
 
using InstanceFinder = std::function< std::optional< InstancePointer >(EffectSettings &settings) >
 
- Public Types inherited from EffectDefinitionInterface
enum class  RealtimeSince : unsigned { Never , After_3_1 , Always }
 In which versions of Audacity was an effect realtime capable? More...
 
- Static Public Member Functions inherited from Effect
static EffectFetchParameters (Effect &e, EffectSettings &)
 
- Static Public Member Functions inherited from EffectBase
static std::optional< InstancePointerFindInstance (EffectPlugin &plugin)
 
static InstanceFinder DefaultInstanceFinder (EffectPlugin &plugin)
 
- Static Public Member Functions inherited from EffectDefinitionInterface
static Identifier GetSquashedName (const Identifier &ident)
 A utility that strips spaces and CamelCases a name. More...
 
- Public Attributes inherited from EffectBase
std::shared_ptr< TrackListmTracks {}
 
int mNumTracks {}
 
BasicUI::ProgressDialogmProgress {}
 
double mProjectRate {}
 
WaveTrackFactorymFactory {}
 
double mT0 {}
 
double mT1 {}
 
bool mIsPreview { false }
 
- Protected Member Functions inherited from Effect
bool CheckWhetherSkipEffect (const EffectSettings &settings) const override
 Default implementation returns false. More...
 
double CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const override
 Default implementation returns previewLength More...
 
bool TotalProgress (double frac, const TranslatableString &={}) const
 
bool TrackProgress (int whichTrack, double frac, const TranslatableString &={}) const
 
bool TrackGroupProgress (int whichGroup, double frac, const TranslatableString &={}) const
 
int GetNumWaveTracks () const
 
int GetNumWaveGroups () const
 
void GetBounds (const WaveTrack &track, sampleCount *start, sampleCount *len)
 
- Protected Member Functions inherited from EffectBase
virtual bool CheckWhetherSkipEffect (const EffectSettings &settings) const =0
 After Init(), tell whether Process() should be skipped. More...
 
void SetLinearEffectFlag (bool linearEffectFlag)
 
void SetPreviewFullSelectionFlag (bool previewDurationFlag)
 
bool IsPreviewing () const
 
const TrackListinputTracks () const
 
const AudacityProjectFindProject () const
 
- Protected Attributes inherited from EffectBase
double mF0 {}
 
double mF1 {}
 
wxArrayString mPresetNames
 
unsigned mUIFlags { 0 }
 

Detailed Description

Definition at line 14 of file StereoToMono.h.

Member Function Documentation

◆ GetAudioInCount()

unsigned StereoToMono::GetAudioInCount ( ) const
overridevirtual

How many input buffers to allocate at once.

If the instance processes channels independently, this can return 1 The result is not necessarily well defined before RealtimeInitialize Default implementation returns 0

Reimplemented from StatefulEffectBase.

Definition at line 45 of file StereoToMono.cpp.

46{
47 return 2;
48}

◆ GetAudioOutCount()

unsigned StereoToMono::GetAudioOutCount ( ) const
overridevirtual

How many output buffers to allocate at once.

The result is not necessarily well defined before RealtimeInitialize Default implementation returns 0

Reimplemented from StatefulEffectBase.

Definition at line 50 of file StereoToMono.cpp.

51{
52 return 1;
53}

◆ GetDescription()

TranslatableString StereoToMono::GetDescription ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 26 of file StereoToMono.cpp.

27{
28 return XO("Converts stereo tracks to mono");
29}
XO("Cut/Copy/Paste")

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol StereoToMono::GetSymbol ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 21 of file StereoToMono.cpp.

22{
23 return Symbol;
24}
static const ComponentInterfaceSymbol Symbol
Definition: StereoToMono.h:17

References Symbol.

◆ GetType()

EffectType StereoToMono::GetType ( ) const
overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 33 of file StereoToMono.cpp.

34{
35 // Really EffectTypeProcess, but this prevents it from showing in the Effect
36 // Menu
37 return EffectTypeHidden;
38}
@ EffectTypeHidden

References EffectTypeHidden.

Referenced by Process().

Here is the caller graph for this function:

◆ IsHiddenFromMenus()

bool StereoToMono::IsHiddenFromMenus ( ) const
overridevirtual

Default is false.

Reimplemented from EffectDefinitionInterface.

Definition at line 159 of file StereoToMono.cpp.

160{
161 return true;
162}

◆ IsInteractive()

bool StereoToMono::IsInteractive ( ) const
overridevirtual

Whether the effect needs a dialog for entry of settings.

Implements EffectDefinitionInterface.

Definition at line 40 of file StereoToMono.cpp.

41{
42 return false;
43}

◆ Process()

bool StereoToMono::Process ( EffectInstance instance,
EffectSettings settings 
)
overridevirtual

Implements StatefulEffectBase.

Definition at line 57 of file StereoToMono.cpp.

58{
59 // Do not use mWaveTracks here. We will possibly DELETE tracks,
60 // so we must use the "real" tracklist.
61 EffectOutputTracks outputs {
62 *mTracks,
63 GetType(),
64 // This effect ignores mT0 and mT1 but always mixes the entire tracks.
65 { { mTracks->GetStartTime(), mTracks->GetEndTime() } }
66 };
67 bool bGoodResult = true;
68
69 // Determine the total time (in samples) used by all of the target tracks
70 // only for progress dialog
71 sampleCount totalTime = 0;
72
73 auto trackRange = outputs.Get().Selected<WaveTrack>();
74 for (const auto left : trackRange)
75 {
76 if (left->Channels().size() > 1)
77 {
78 auto start = left->TimeToLongSamples(left->GetStartTime());
79 auto end = left->TimeToLongSamples(left->GetEndTime());
80 totalTime += (end - start);
81 }
82 }
83
84 // Process each stereo track
85 sampleCount curTime = 0;
86
87 mProgress->SetMessage(XO("Mixing down to mono"));
88
89 for (const auto track : trackRange)
90 {
91 if (track->Channels().size() > 1)
92 {
93 if (!ProcessOne(outputs.Get(), curTime, totalTime, *track))
94 break;
95 }
96 }
97
98 if (bGoodResult)
99 outputs.Commit();
100
101 return bGoodResult;
102}
virtual void SetMessage(const TranslatableString &message)=0
Change an existing dialog's message.
BasicUI::ProgressDialog * mProgress
Definition: EffectBase.h:118
std::shared_ptr< TrackList > mTracks
Definition: EffectBase.h:116
Use this object to copy the input tracks to tentative outputTracks.
EffectType GetType() const override
Type determines how it behaves.
bool ProcessOne(TrackList &outputs, sampleCount &curTime, sampleCount totalTime, WaveTrack &track)
A Track that contains audio waveform data.
Definition: WaveTrack.h:203
sampleCount TimeToLongSamples(double t0) const
Positions or offsets within audio files need a wide type.
Definition: SampleCount.h:19
const char * end(const char *str) noexcept
Definition: StringUtils.h:106

References details::end(), GetType(), EffectBase::mProgress, EffectBase::mTracks, ProcessOne(), BasicUI::ProgressDialog::SetMessage(), WideSampleSequence::TimeToLongSamples(), and XO().

Here is the call graph for this function:

◆ ProcessOne()

bool StereoToMono::ProcessOne ( TrackList outputs,
sampleCount curTime,
sampleCount  totalTime,
WaveTrack track 
)
private

Definition at line 104 of file StereoToMono.cpp.

107{
108 auto idealBlockLen = track.GetMaxBlockSize() * 2;
109 bool bResult = true;
110 sampleCount processed = 0;
111
112 const auto start = track.GetStartTime();
113 const auto end = track.GetEndTime();
114
116 tracks.emplace_back(
117 track.SharedPointer<const SampleTrack>(), GetEffectStages(track));
118
119 Mixer mixer(
120 move(tracks), std::nullopt,
121 true, // Throw to abort mix-and-render if read fails:
122 Mixer::WarpOptions { inputTracks()->GetOwner() }, start, end, 1,
123 idealBlockLen,
124 false, // Not interleaved
125 track.GetRate(), floatSample);
126
127 // Always make mono output; don't use EmptyCopy
128 auto outTrack = track.EmptyCopy(1);
129 auto tempList = TrackList::Temporary(nullptr, outTrack);
130 outTrack->ConvertToSampleFormat(floatSample);
131
132 double denominator = track.GetChannelVolume(0) + track.GetChannelVolume(1);
133 while (auto blockLen = mixer.Process())
134 {
135 auto buffer = mixer.GetBuffer();
136 for (auto i = 0; i < blockLen; i++)
137 ((float*)buffer)[i] /= denominator;
138
139 // If mixing channels that both had only 16 bit effective format
140 // (for example), and no gains or envelopes, still there should be
141 // dithering because of the averaging above, which may introduce samples
142 // lying between the quantization levels. So use widestSampleFormat.
143 outTrack->Append(0, buffer, floatSample, blockLen, 1, widestSampleFormat);
144
145 curTime += blockLen;
146 if (TotalProgress(curTime.as_double() / totalTime.as_double()))
147 return false;
148 }
149 outTrack->Flush();
150
151 track.Clear(start, end);
152 track.MakeMono();
153 track.Paste(start, *outTrack);
155
156 return bResult;
157}
std::vector< MixerOptions::StageSpecification > GetEffectStages(const WaveTrack &track)
const auto tracks
const TrackList * inputTracks() const
Definition: EffectBase.h:102
bool TotalProgress(double frac, const TranslatableString &={}) const
Definition: Effect.cpp:335
Functions for doing the mixdown of the tracks.
Definition: Mix.h:31
std::vector< Input > Inputs
Definition: Mix.h:49
static RealtimeEffectList & Get(AudacityProject &project)
void Clear()
Use only in the main thread. Sends Remove messages.
std::shared_ptr< Subclass > SharedPointer()
Definition: Track.h:146
AudacityProject * GetOwner()
Definition: Track.h:887
static TrackListHolder Temporary(AudacityProject *pProject, const Track::Holder &pTrack={})
Definition: Track.cpp:858
void MakeMono()
Simply discard any right channel.
Definition: WaveTrack.cpp:1039
double GetStartTime() const override
Implement WideSampleSequence.
Definition: WaveTrack.cpp:2603
float GetChannelVolume(int channel) const override
Takes volume and pan into account.
Definition: WaveTrack.cpp:888
void Clear(double t0, double t1) override
Definition: WaveTrack.cpp:1161
void Paste(double t0, const Track &src) override
Definition: WaveTrack.cpp:1986
double GetEndTime() const override
Implement WideSampleSequence.
Definition: WaveTrack.cpp:2613
double GetRate() const override
Definition: WaveTrack.cpp:821
size_t GetMaxBlockSize() const
Definition: WaveTrack.cpp:2279
Holder EmptyCopy(size_t nChannels, const SampleBlockFactoryPtr &pFactory={}) const
Definition: WaveTrack.cpp:1012
double as_double() const
Definition: SampleCount.h:46
Immutable structure is an argument to Mixer's constructor.
Definition: MixerOptions.h:56

References sampleCount::as_double(), RealtimeEffectList::Clear(), WaveTrack::Clear(), WaveTrack::EmptyCopy(), details::end(), floatSample, RealtimeEffectList::Get(), WaveTrack::GetChannelVolume(), GetEffectStages(), WaveTrack::GetEndTime(), WaveTrack::GetMaxBlockSize(), TrackList::GetOwner(), WaveTrack::GetRate(), WaveTrack::GetStartTime(), EffectBase::inputTracks(), WaveTrack::MakeMono(), WaveTrack::Paste(), Track::SharedPointer(), TrackList::Temporary(), Effect::TotalProgress(), tracks, and widestSampleFormat.

Referenced by Process().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ Symbol

const ComponentInterfaceSymbol StereoToMono::Symbol { XO("Stereo To Mono") }
static

Definition at line 17 of file StereoToMono.h.

Referenced by GetSymbol().


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