Effect.h File Reference

#include "../Audacity.h"
#include "../MemoryX.h"
#include <set>
#include <wx/bmpbuttn.h>
#include <wx/defs.h>
#include <wx/intl.h>
#include <wx/string.h>
#include <wx/tglbtn.h>
#include <wx/event.h>
#include "audacity/ConfigInterface.h"
#include "audacity/EffectInterface.h"
#include "../Experimental.h"
#include "../SampleFormat.h"
#include "../SelectedRegion.h"
#include "../Shuttle.h"
#include "../Internat.h"
#include "../widgets/ProgressDialog.h"
#include "../Track.h"

Go to the source code of this file.

Classes
class	Effect
	Base class for many of the effects in Audacity. More...
class	Effect::AddedAnalysisTrack
class	Effect::ModifiedAnalysisTrack
class	EffectDialog
	New (Jun-2006) base class for effects dialogs. Likely to get greater use in future. More...
class	EffectUIHost
class	EffectPresetsDialog

Macros
#define	BUILTIN_EFFECT_PREFIX   wxT("Built-in Effect: ")
#define	ID_EFFECT_PREVIEW   ePreviewID
#define	Param(name, type, key, def, min, max, scale)
#define	PBasic(name, type, key, def)
#define	PRange(name, type, key, def, min, max)
#define	PScale(name, type, key, def, min, max, scale)
#define	ReadParam(type, name)
#define	ReadBasic(type, name)
#define	ReadAndVerifyEnum(name, list, listSize)
#define	ReadAndVerifyEnumWithObsoletes(name, list, listSize, obsoleteList, nObsolete)
#define	ReadAndVerifyInt(name)   ReadParam(int, name)
#define	ReadAndVerifyDouble(name)   ReadParam(double, name)
#define	ReadAndVerifyFloat(name)   ReadParam(float, name)
#define	ReadAndVerifyBool(name)   ReadBasic(bool, name)
#define	ReadAndVerifyString(name)   ReadBasic(wxString, name)

Functions
float	TrapFloat (float x, float min, float max)
double	TrapDouble (double x, double min, double max)
long	TrapLong (long x, long min, long max)

Macro Definition Documentation

#define BUILTIN_EFFECT_PREFIX   wxT("Built-in Effect: ")

Definition at line 47 of file Effect.h.

Referenced by BuiltinEffectsModule::AutoRegisterPlugins(), Effect::GetPath(), BuiltinEffectsModule::Initialize(), and BuiltinEffectsModule::Instantiate().

#define ID_EFFECT_PREVIEW   ePreviewID

Definition at line 557 of file Effect.h.

#define Param	(		name,
			type,
			key,
			def,
			min,
			max,
			scale
	)

Value:

static const wxChar * KEY_ ## name = (key); \
   static const type DEF_ ## name = (def); \
   static const type MIN_ ## name = (min); \
   static const type MAX_ ## name = (max); \
   static const type SCL_ ## name = (scale);

Definition at line 753 of file Effect.h.

#define PBasic	(		name,
			type,
			key,
			def
	)

Value:

static const wxChar * KEY_ ## name = (key); \
   static const type DEF_ ## name = (def);

Definition at line 760 of file Effect.h.

#define PRange	(		name,
			type,
			key,
			def,
			min,
			max
	)

Value:

PBasic(name, type, key, def); \
   static const type MIN_ ## name = (min); \
   static const type MAX_ ## name = (max);

Definition at line 764 of file Effect.h.

#define PScale	(		name,
			type,
			key,
			def,
			min,
			max,
			scale
	)

Value:

PRange(name, type, key, def, min, max); \
   static const type SCL_ ## name = (scale);

Definition at line 769 of file Effect.h.

#define ReadAndVerifyBool

(

name

)

ReadBasic(bool, name)

Definition at line 800 of file Effect.h.

Referenced by EffectNormalize::SetAutomationParameters(), EffectAmplify::SetAutomationParameters(), EffectCompressor::SetAutomationParameters(), EffectTruncSilence::SetAutomationParameters(), EffectReverb::SetAutomationParameters(), EffectBassTreble::SetAutomationParameters(), EffectDistortion::SetAutomationParameters(), and EffectEqualization::SetAutomationParameters().

#define ReadAndVerifyDouble

(

name

)

ReadParam(double, name)

Definition at line 798 of file Effect.h.

Referenced by EffectNormalize::SetAutomationParameters(), EffectNoise::SetAutomationParameters(), EffectChangeSpeed::SetAutomationParameters(), EffectToneGen::SetAutomationParameters(), EffectAutoDuck::SetAutomationParameters(), EffectCompressor::SetAutomationParameters(), EffectDtmf::SetAutomationParameters(), EffectTruncSilence::SetAutomationParameters(), EffectReverb::SetAutomationParameters(), EffectBassTreble::SetAutomationParameters(), EffectWahwah::SetAutomationParameters(), EffectPhaser::SetAutomationParameters(), and EffectDistortion::SetAutomationParameters().

#define ReadAndVerifyEnum	(		name,
			list,
			listSize
	)

Value:

int name; \
   if (!parms.ReadAndVerify(KEY_ ## name, &name, DEF_ ## name, list, listSize)) \
      return false;

Definition at line 786 of file Effect.h.

Referenced by EffectNoise::SetAutomationParameters(), EffectToneGen::SetAutomationParameters(), EffectTruncSilence::SetAutomationParameters(), EffectScienFilter::SetAutomationParameters(), EffectDistortion::SetAutomationParameters(), and EffectEqualization::SetAutomationParameters().

#define ReadAndVerifyEnumWithObsoletes	(		name,
			list,
			listSize,
			obsoleteList,
			nObsolete
	)

Value:

int name; \
   if (!parms.ReadAndVerify(KEY_ ## name, &name, DEF_ ## name, \
                            list, listSize, obsoleteList, nObsolete)) \
      return false;

Definition at line 791 of file Effect.h.

Referenced by EffectTruncSilence::SetAutomationParameters().

#define ReadAndVerifyFloat

(

name

)

ReadParam(float, name)

Definition at line 799 of file Effect.h.

Referenced by EffectPaulstretch::SetAutomationParameters(), EffectEcho::SetAutomationParameters(), EffectAmplify::SetAutomationParameters(), and EffectScienFilter::SetAutomationParameters().

#define ReadAndVerifyInt

(

name

)

ReadParam(int, name)

Definition at line 797 of file Effect.h.

Referenced by EffectFindClipping::SetAutomationParameters(), EffectRepeat::SetAutomationParameters(), EffectClickRemoval::SetAutomationParameters(), EffectScienFilter::SetAutomationParameters(), EffectWahwah::SetAutomationParameters(), EffectPhaser::SetAutomationParameters(), EffectDistortion::SetAutomationParameters(), and EffectEqualization::SetAutomationParameters().

#define ReadAndVerifyString

(

name

)

ReadBasic(wxString, name)

Definition at line 801 of file Effect.h.

Referenced by EffectDtmf::SetAutomationParameters(), and EffectEqualization::SetAutomationParameters().

#define ReadBasic	(		type,
			name
	)

Value:

type name; \
   wxUnusedVar(MIN_ ##name); \
   wxUnusedVar(MAX_ ##name); \
   wxUnusedVar(SCL_ ##name); \
   if (!parms.ReadAndVerify(KEY_ ## name, &name, DEF_ ## name)) \
      return false;

Definition at line 778 of file Effect.h.

#define ReadParam	(		type,
			name
	)

Value:

type name = DEF_ ## name; \
   if (!parms.ReadAndVerify(KEY_ ## name, &name, DEF_ ## name, MIN_ ## name, MAX_ ## name)) \
      return false;

Definition at line 773 of file Effect.h.

Function Documentation

double TrapDouble ( double  x, double  min, double  max  )

inline

Definition at line 729 of file Effect.h.

References min().

Referenced by EffectAmplify::OnAmpSlider(), EffectAmplify::OnAmpText(), EffectAutoDuckPanel::OnMotion(), EffectAmplify::OnPeakText(), EffectNormalize::Process(), EffectToneGen::SetAutomationParameters(), EffectAmplify::TransferDataFromWindow(), EffectAmplify::TransferDataToWindow(), and EffectChangeSpeed::Update_TimeCtrl_ToLength().

{
   if (x <= min)
      return min;

   if (x >= max)
      return max;

   return x;
}

float TrapFloat ( float  x, float  min, float  max  )

inline

Definition at line 718 of file Effect.h.

References min().

{
   if (x <= min)
      return min;

   if (x >= max)
      return max;

   return x;
}

long TrapLong ( long  x, long  min, long  max  )

inline

Definition at line 740 of file Effect.h.

References min().

{
   if (x <= min)
      return min;

   if (x >= max)
      return max;

   return x;
}