Use the interpolation code to fill in damaged audio. Damage can include pops, clicks, or clipping. As long as the damaged section is short and surrounded by lots of good audio, it is usually quite successful. More...

#include <Repair.h>

Inheritance diagram for EffectRepair:

Public Member Functions
	EffectRepair ()

virtual	~EffectRepair ()

IdentInterfaceSymbol	GetSymbol () override

wxString	GetDescription () override

EffectType	GetType () override

bool	IsInteractive () override

bool	Process () override

Public Member Functions inherited from Effect
	Effect ()

virtual	~Effect ()

wxString	GetPath () override

IdentInterfaceSymbol	GetVendor () override

wxString	GetVersion () override

IdentInterfaceSymbol	GetFamilyId () override

bool	IsDefault () override

bool	IsLegacy () override

bool	SupportsRealtime () override

bool	SupportsAutomation () override

bool	SetHost (EffectHostInterface *host) override

unsigned	GetAudioInCount () override

unsigned	GetAudioOutCount () override

int	GetMidiInCount () override

int	GetMidiOutCount () override

sampleCount	GetLatency () override

size_t	GetTailSize () override

void	SetSampleRate (double rate) override

size_t	SetBlockSize (size_t maxBlockSize) override

bool	IsReady () override

bool	ProcessInitialize (sampleCount totalLen, ChannelNames chanMap=NULL) override

bool	ProcessFinalize () override

size_t	ProcessBlock (float inBlock, float outBlock, size_t blockLen) override

bool	RealtimeInitialize () override

bool	RealtimeAddProcessor (unsigned numChannels, float sampleRate) override

bool	RealtimeFinalize () override

bool	RealtimeSuspend () override

bool	RealtimeResume () override

bool	RealtimeProcessStart () override

size_t	RealtimeProcess (int group, float inbuf, float outbuf, size_t numSamples) override

bool	RealtimeProcessEnd () override

bool	ShowInterface (wxWindow *parent, bool forceModal=false) override

bool	GetAutomationParameters (CommandParameters &parms) override

bool	SetAutomationParameters (CommandParameters &parms) override

bool	LoadUserPreset (const wxString &name) override

bool	SaveUserPreset (const wxString &name) override

wxArrayString	GetFactoryPresets () override

bool	LoadFactoryPreset (int id) override

bool	LoadFactoryDefaults () override

void	SetHostUI (EffectUIHostInterface *host) override

bool	PopulateUI (wxWindow *parent) override

bool	IsGraphicalUI () override

bool	ValidateUI () override

bool	HideUI () override

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets () override

void	ImportPresets () override

bool	HasOptions () override

void	ShowOptions () override

double	GetDefaultDuration () override

double	GetDuration () override

NumericFormatId	GetDurationFormat () override

virtual NumericFormatId	GetSelectionFormat ()

void	SetDuration (double duration) override

bool	Apply () override

void	Preview () override

wxDialog *	CreateUI (wxWindow parent, EffectUIClientInterface client) override

wxString	GetUserPresetsGroup (const wxString &name) override

wxString	GetCurrentSettingsGroup () override

wxString	GetFactoryDefaultsGroup () override

virtual wxString	GetSavedStateGroup ()

bool	HasSharedConfigGroup (const wxString &group) override

bool	GetSharedConfigSubgroups (const wxString &group, wxArrayString &subgroups) override

bool	GetSharedConfig (const wxString &group, const wxString &key, wxString &value, const wxString &defval=wxEmptyString) override

bool	GetSharedConfig (const wxString &group, const wxString &key, int &value, int defval=0) override

bool	GetSharedConfig (const wxString &group, const wxString &key, bool &value, bool defval=false) override

bool	GetSharedConfig (const wxString &group, const wxString &key, float &value, float defval=0.0) override

bool	GetSharedConfig (const wxString &group, const wxString &key, double &value, double defval=0.0) override

bool	SetSharedConfig (const wxString &group, const wxString &key, const wxString &value) override

bool	SetSharedConfig (const wxString &group, const wxString &key, const int &value) override

bool	SetSharedConfig (const wxString &group, const wxString &key, const bool &value) override

bool	SetSharedConfig (const wxString &group, const wxString &key, const float &value) override

bool	SetSharedConfig (const wxString &group, const wxString &key, const double &value) override

bool	RemoveSharedConfigSubgroup (const wxString &group) override

bool	RemoveSharedConfig (const wxString &group, const wxString &key) override

bool	HasPrivateConfigGroup (const wxString &group) override

bool	GetPrivateConfigSubgroups (const wxString &group, wxArrayString &subgroups) override

bool	GetPrivateConfig (const wxString &group, const wxString &key, wxString &value, const wxString &defval=wxEmptyString) override

bool	GetPrivateConfig (const wxString &group, const wxString &key, int &value, int defval=0) override

bool	GetPrivateConfig (const wxString &group, const wxString &key, bool &value, bool defval=false) override

bool	GetPrivateConfig (const wxString &group, const wxString &key, float &value, float defval=0.0) override

bool	GetPrivateConfig (const wxString &group, const wxString &key, double &value, double defval=0.0) override

bool	SetPrivateConfig (const wxString &group, const wxString &key, const wxString &value) override

bool	SetPrivateConfig (const wxString &group, const wxString &key, const int &value) override

bool	SetPrivateConfig (const wxString &group, const wxString &key, const bool &value) override

bool	SetPrivateConfig (const wxString &group, const wxString &key, const float &value) override

bool	SetPrivateConfig (const wxString &group, const wxString &key, const double &value) override

bool	RemovePrivateConfigSubgroup (const wxString &group) override

bool	RemovePrivateConfig (const wxString &group, const wxString &key) override

virtual PluginID	GetID ()

virtual bool	Startup (EffectClientInterface *client)

virtual bool	Startup ()

virtual bool	GetAutomationParameters (wxString &parms)

virtual bool	SetAutomationParameters (const wxString &parms)

virtual wxArrayString	GetUserPresets ()

virtual bool	HasCurrentSettings ()

virtual bool	HasFactoryDefaults ()

virtual wxString	GetPreset (wxWindow *parent, const wxString &parms)

virtual wxString	ManualPage ()

virtual wxString	HelpPage ()

virtual bool	IsBatchProcessing ()

virtual void	SetBatchProcessing (bool start)

void	SetPresetParameters (const wxArrayString Names, const wxArrayString Values)

bool	DoEffect (wxWindow parent, double projectRate, TrackList list, TrackFactory factory, SelectedRegion selectedRegion, bool shouldPrompt=true)

bool	Delegate (Effect &delegate, wxWindow *parent, bool shouldPrompt)

bool	RealtimeAddProcessor (int group, unsigned chans, float rate)

size_t	RealtimeProcess (int group, unsigned chans, float inbuf, float outbuf, size_t numSamples)

bool	IsRealtimeActive ()

virtual bool	IsHidden ()

int	MessageBox (const wxString &message, long style=DefaultMessageBoxStyle, const wxString &titleStr=wxString{})

Public Member Functions inherited from EffectClientInterface
virtual	~EffectClientInterface ()

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

virtual EffectType	GetClassification ()

Public Member Functions inherited from IdentInterface
virtual	~IdentInterface ()

const wxString &	GetTranslatedName ()

Public Member Functions inherited from ParamsInterface
virtual	~ParamsInterface ()

virtual bool	DefineParams (ShuttleParams &WXUNUSED(S))

Public Member Functions inherited from EffectUIClientInterface
virtual	~EffectUIClientInterface ()

Public Member Functions inherited from EffectHostInterface
virtual	~EffectHostInterface ()

Public Member Functions inherited from ConfigClientInterface
virtual	~ConfigClientInterface ()

Private Member Functions
bool	ProcessOne (int count, WaveTrack *track, sampleCount start, size_t len, size_t repairStart, size_t repairLen)

Additional Inherited Members
Public Types inherited from Effect
enum	: long { DefaultMessageBoxStyle = wxOK \| wxCENTRE }

Static Public Member Functions inherited from Effect
static void	IncEffectCounter ()

Protected Member Functions inherited from Effect
virtual bool	Init ()

virtual bool	PromptUser (wxWindow *parent)

virtual bool	CheckWhetherSkipEffect ()

virtual bool	ProcessPass ()

virtual bool	InitPass1 ()

virtual bool	InitPass2 ()

virtual int	GetPass ()

virtual void	End ()

virtual double	CalcPreviewInputLength (double previewLength)

virtual void	Preview (bool dryOnly)

virtual void	PopulateOrExchange (ShuttleGui &S)

virtual bool	TransferDataToWindow ()

virtual bool	TransferDataFromWindow ()

virtual bool	EnableApply (bool enable=true)

virtual bool	EnablePreview (bool enable=true)

virtual void	EnableDebug (bool enable=true)

bool	TotalProgress (double frac, const wxString &=wxEmptyString)

bool	TrackProgress (int whichTrack, double frac, const wxString &=wxEmptyString)

bool	TrackGroupProgress (int whichGroup, double frac, const wxString &=wxEmptyString)

int	GetNumWaveTracks ()

int	GetNumWaveGroups ()

void	GetSamples (const WaveTrack track, sampleCount start, sampleCount *len)

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing ()

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	CopyInputTracks ()

void	CopyInputTracks (int trackType)

std::shared_ptr < AddedAnalysisTrack >	AddAnalysisTrack (const wxString &name=wxString())

ModifiedAnalysisTrack	ModifyAnalysisTrack (const LabelTrack *pOrigTrack, const wxString &name=wxString())

void	ReplaceProcessedTracks (const bool bGoodResult)

Track *	AddToOutputTracks (std::unique_ptr< Track > &&t)

TrackList *	inputTracks () const

Protected Attributes inherited from Effect
ProgressDialog *	mProgress

double	mProjectRate

double	mSampleRate

SelectedRegion *	mpSelectedRegion {}

TrackFactory *	mFactory

std::shared_ptr< TrackList >	mOutputTracks

double	mT0

double	mT1

double	mF0

double	mF1

wxArrayString	mPresetNames

wxArrayString	mPresetValues

int	mPass

wxDialog *	mUIDialog

wxWindow *	mUIParent

int	mUIResultID

sampleCount	mSampleCnt

int	mOutputTracksType

Static Protected Attributes inherited from Effect
static int	nEffectsDone =0

Detailed Description

Use the interpolation code to fill in damaged audio. Damage can include pops, clicks, or clipping. As long as the damaged section is short and surrounded by lots of good audio, it is usually quite successful.

This was formerly the PopClickRemoval effect, but it was renamed and focused on the smaller subproblem of repairing the audio, rather than actually finding the clicks.

Definition at line 22 of file Repair.h.

Constructor & Destructor Documentation

EffectRepair::EffectRepair ( )

Definition at line 36 of file Repair.cpp.

37 {

38 }

EffectRepair::~EffectRepair ( )

virtual

Definition at line 40 of file Repair.cpp.

41 {

42 }

Member Function Documentation

wxString EffectRepair::GetDescription ( )

overridevirtual

Reimplemented from Effect.

Definition at line 51 of file Repair.cpp.

References _().

 {
    return _("Sets the peak amplitude of a one or more tracks");
 }

IdentInterfaceSymbol EffectRepair::GetSymbol ( )

overridevirtual

Reimplemented from Effect.

Definition at line 46 of file Repair.cpp.

References REPAIR_PLUGIN_SYMBOL.

 {
    return REPAIR_PLUGIN_SYMBOL;
 }

EffectType EffectRepair::GetType ( )

overridevirtual

Reimplemented from Effect.

Definition at line 58 of file Repair.cpp.

References EffectTypeProcess.

 {
    return EffectTypeProcess;
 }

bool EffectRepair::IsInteractive ( )

overridevirtual

Reimplemented from Effect.

Definition at line 63 of file Repair.cpp.

 {
    return false;
 }

bool EffectRepair::Process ( )

overridevirtual

The Repair effect needs some data to go on.
select an area to repair with some audio on at least one side (the more the better)."));

Reimplemented from Effect.

Definition at line 70 of file Repair.cpp.

References _(), Effect::CopyInputTracks(), WaveTrack::GetStartTime(), Effect::MessageBox(), min(), Effect::mOutputTracks, Effect::mT0, Effect::mT1, ProcessOne(), Effect::ReplaceProcessedTracks(), and Track::Wave.

 {
    //v This may be too much copying for EffectRepair. To support Cancel, may be able to copy much less.
    //  But for now, Cancel isn't supported without this.
    this->CopyInputTracks(); // Set up mOutputTracks. //v This may be too much copying for EffectRepair.
    bool bGoodResult = true;
 
    SelectedTrackListOfKindIterator iter(Track::Wave, mOutputTracks.get());
    WaveTrack *track = (WaveTrack *) iter.First();
    int count = 0;
    while (track) {
       const
       double trackStart = track->GetStartTime();
       const double repair_t0 = std::max(mT0, trackStart);
       const
       double trackEnd = track->GetEndTime();
       const double repair_t1 = std::min(mT1, trackEnd);
       const
       double repair_deltat = repair_t1 - repair_t0;
       if (repair_deltat > 0) {  // selection is within track audio
          const auto repair0 = track->TimeToLongSamples(repair_t0);
          const auto repair1 = track->TimeToLongSamples(repair_t1);
          const auto repairLen = repair1 - repair0;
          if (repairLen > 128) {
             ::Effect::MessageBox(_("The Repair effect is intended to be used on very short sections of damaged audio (up to 128 samples).\n\nZoom in and select a tiny fraction of a second to repair."));
             bGoodResult = false;
             break;
          }
 
          const double rate = track->GetRate();
          const double spacing = std::max(repair_deltat * 2, 128. / rate);
          const double t0 = std::max(repair_t0 - spacing, trackStart);
          const double t1 = std::min(repair_t1 + spacing, trackEnd);
 
          const auto s0 = track->TimeToLongSamples(t0);
          const auto s1 = track->TimeToLongSamples(t1);
          // The difference is at most 2 * 128:
          const auto repairStart = (repair0 - s0).as_size_t();
          const auto len = s1 - s0;
 
          if (s0 == repair0 && s1 == repair1) {
             ::Effect::MessageBox(_("Repair works by using audio data outside the selection region.\n\nPlease select a region that has audio touching at least one side of it.\n\nThe more surrounding audio, the better it performs."));
             bGoodResult = false;
             break;
          }
 
          if (!ProcessOne(count, track, s0,
                          // len is at most 5 * 128.
                          len.as_size_t(),
                          repairStart,
                          // repairLen is at most 128.
                          repairLen.as_size_t() )) {
             bGoodResult = false;
             break;
          }
       }
 
       track = (WaveTrack *) iter.Next();
       count++;
    }
 
    this->ReplaceProcessedTracks(bGoodResult);
    return bGoodResult;
 }

bool EffectRepair::ProcessOne	(	int	count,
		WaveTrack *	track,
		sampleCount	start,
		size_t	len,
		size_t	repairStart,
		size_t	repairLen
	)

private

Definition at line 136 of file Repair.cpp.

References floatSample, WaveTrack::Get(), InterpolateAudio(), WaveTrack::Set(), and Effect::TrackProgress().

Referenced by Process().

 {
    Floats buffer{ len };
    track->Get((samplePtr) buffer.get(), floatSample, start, len);
    InterpolateAudio(buffer.get(), len, repairStart, repairLen);
    track->Set((samplePtr)&buffer[repairStart], floatSample,
               start + repairStart, repairLen);
    return !TrackProgress(count, 1.0); // TrackProgress returns true on Cancel.
 }

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

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation