Audacity  2.2.0
Effect.h File Reference
#include "../Audacity.h"
#include "../MemoryX.h"
#include <set>
#include <wx/bmpbuttn.h>
#include <wx/defs.h>
#include <wx/dynarray.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)
 
#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: ")
#define ID_EFFECT_PREVIEW   ePreviewID
#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);
int min(int a, int b)
Definition: CompareAudioCommand.cpp:80
const wxChar * name
Definition: Distortion.cpp:93
#define PBasic (   name,
  type,
  key,
  def 
)
Value:
static const wxChar * KEY_ ## name = (key); \
static const type DEF_ ## name = (def);
const wxChar * name
Definition: Distortion.cpp:93
#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);
#define PBasic(name, type, key, def)
Definition: Effect.h:745
int min(int a, int b)
Definition: CompareAudioCommand.cpp:80
const wxChar * name
Definition: Distortion.cpp:93
#define PScale (   name,
  type,
  key,
  def,
  min,
  max,
  scale 
)
Value:
PRange(name, type, key, def, min, max); \
static const type SCL_ ## name = (scale);
#define PRange(name, type, key, def, min, max)
Definition: Effect.h:749
int min(int a, int b)
Definition: CompareAudioCommand.cpp:80
const wxChar * name
Definition: Distortion.cpp:93
#define ReadAndVerifyEnum (   name,
  list 
)
#define ReadAndVerifyString (   name)    ReadBasic(wxString, name)
#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;
const wxChar * name
Definition: Distortion.cpp:93
#define ReadParam (   type,
  name 
)
Value:
type name; \
if (!parms.ReadAndVerify(KEY_ ## name, &name, DEF_ ## name, MIN_ ## name, MAX_ ## name)) \
return false;
const wxChar * name
Definition: Distortion.cpp:93

Function Documentation

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

References min().

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

References min().