LogoSearch packages:      

Sourcecode: audacity version File versions

Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
AboutDialogThe AboutDialog shows the program version and developer credits
AboutDialogCreditItemAboutDialogCreditItem is a structure used by the AboutDialog to hold information about one contributor to Audacity
AButtonA wxButton with mouse-over behaviour
AColorAColor Manages color brushes and pens
AliasBlockFileA BlockFile that refers to data in an existing file
AmplifyDialogDilaog used with EffectAmplify
portaudio::AsioDeviceAdapterAdapts the given Device to an ASIO specific extension
ASliderASlider is a custom slider, allowing for a slicker look and feel
AttachableScrollBarAn AttachableScrollBar is a scroll bar that can be attached to multiple items and so control their scrolling. Uses floats internally, not ints, allowing for (external) control of zooming
AudacityAppAudacityApp is the 'main' class for Audacity
AudacityPrintoutDerived from wxPrintout, this class helps with printing
AudacityProjectAudacityProject provides the main window, with tools and tracks contained within it
AudacityProjectCommandFunctorAudacityProjectCommandFunctor, derived from CommandFunctor, simplifies construction of menu items
AudioIOAudioIO uses the PortAudio library to play and record sound
AudioIOPrefsA PrefsPanel used to select recording and playback devices and other settings
AudioThreadDefined different on Mac and other platforms (on Mac it does not use wxWidgets wxThread), this class sits in a thread loop reading and writing audio
AudioUnitDialogA Dialog used with AudioUnitEffect
AudioUnitEffectAn Effect class that handles a wide range of effects. ??Mac only??
AudioUnitGUIControlUsed with AudioUnitEffect
auHeaderThe auHeader is a structure used by SimpleBlockFile for .au file format. There probably is an 'official' header file we should include to get its definition, rather than rolling our own
AutoRollbackRenamerAutoRollbackRenamer handles the renaming of files which is needed when producing a new version of a file which may fail. On failure the old version is put back in place
portaudio::AutoSystemA RAII idiom class to ensure automatic clean-up when an exception is raised
AvcCompressorDialogAn unused class used by unused effect, EffectAvcCompressor
BassBoostDialogDialog for EffectBassBoost
BatchCommandDialogProvides a list of configurable commands for use with BatchCommands
BatchCommandsMaintains the chain of commands used in batch processing. See also BatchCommandDialog and BatchProcessDialog
BatchPrefsA PrefsPanel that builds up a chain of effects in BatchCommands
BatchProcessDialogShows progress in executing commands in BatchCommands
BenchmarkDialogBenchmarkDialog is used for measuring performance and accuracy of the BlockFile system
BlockFileA BlockFile is a chunk of immutable audio data
portaudio::BlockingStreamStream class for blocking read/write-style input and output
BPMDetectClass for calculating BPM rate for audio data
BuiltinFormatStringBuiltinFormatString is a structure used in the TimeTextCtrl and holds both a descriptive name for the string format and a printf inspired style format string, optimised for displaying time in different formats
portaudio::CallbackInterfaceInterface for an object that's callable as a PortAudioCpp callback object (ie that implements the paCallbackFun method)
portaudio::CallbackStreamBase class for all Streams which use a callback-based mechanism
portaudio::CFunCallbackStreamCallback stream using a free function with C linkage. It's important that the function the passed function pointer points to is declared ``extern "C"''
ChangeLengthDialogDialog used with EffectChangeLength
ChangeSpeedDialogDialog used with EffectChangeSpeed
ChangeTempoDialogDialog used with EffectChangeTempo
ClickRemovalDialogDialog used with EffectClickRemoval
CommandFunctorCommandFunctor is a very small class that works with CommandManager. It holds the callback for one command
CommandListList of CommandListEntry
CommandListEntryCommandListEntry is a structure used by CommandManager
CommandManagerCommandManager implements a system for organizing all user-callable commands
CompressorDialogDialog used with EffectCompressor
CompressorPanelPanel used within the CompressorDialog for EffectCompressor
ConstTrackListIteratorConstTrackListIterator provides an iterator to iterate through a TrackList
ControlToolBarA ToolBar that has the main control buttons
CrossFaderNot used by Audacity (yet) apparently work in progress that has been abandoned
portaudio::DeviceClass which represents a PortAudio device in the System
DeviceToolBarA toobar to allow easier changing of input and output devices
DigitInfoDigitInfo is a class used in the TimeTextCtrl
portaudio::DirectionSpecificStreamParametersAll parameters for one direction (either in or out) of a Stream. Together with parameters common to both directions, two DirectionSpecificStreamParameters can make up a StreamParameters object which contains all parameters for a Stream
DirectoriesPrefsA PrefsPanel used to selct directories
DirManagerCreates and manages BlockFile objects
DitherThis class implements various functions for dithering and is derived from the dither code in the Ardour project, written by Steve Harris
DropTargetDropTarget, derived from wxFileDropTarget gives drag and drop functionality for audio files
EchoDialogEchoDialog used with EffectEcho
EditToolBarA ToolBar that has the edit buttons on it
EffectBase class for many of the effects in Audacity
EffectAmplifyAn EffectSimpleMono
EffectAutoDuckImplements the Auto Ducking effect
EffectAvcCompressorAn unused Effect (we use EffectCompressor instead) derived from EffectSimplePairedTwoTrackBase
EffectBassBoostAn EffectSimpleMono
EffectChangeLengthAn Effect
EffectChangeSpeedAn Effect that affects both pitch & tempo
EffectChangeTempoAn EffectSoundTouch provides speeding up or slowing down tempo without changing pitch
EffectClickRemovalAn Effect
EffectCompressorAn Effect derived from EffectTwoPassSimpleMono
EffectDialogNew (Jun-2006) base class for effects dialogs. Likely to get greater use in future
EffectDtmfAn effect for the "Generator" menu to generate DTMF tones
EffectEchoAn Effect that causes an echo, variable delay and volume
EffectEqualizationAn Effect
EffectFadeInAn EffectSimpleMono
EffectFadeOutAn EffectSimpleMono
EffectInvertAn EffectSimpleMono that inverts the selected audio
EffectLevellerAn EffectSimpleMono
EffectNoiseAn Effect for the "Generator" menu to add white noise
EffectNoiseRemovalA two-pass effect to remove background noise
EffectNormalizeAn Effect
EffectNyquistAn Effect that calls up a Nyquist (XLISP) plug in, i.e. many possible effects from this one class
EffectPhaserAn EffectSimpleMono
EffectRepairUse 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
EffectRepeatAn Effect
EffectReverseAn Effect that reverses the selected audio
EffectSilenceAn Effect for the "Generator" menu to add silence
EffectSimpleMonoAn abstract Effect class that simplifies the implementation of a basic monaural effect. Inherit from it if your effect just modifies a single track in place and doesn't care how many samples it gets at a time
EffectSimplePairedTwoTrack< _DataType, _xxxSample >Obsolete. Don't use it
EffectSimplePairedTwoTrackBaseObsolete. Does nothing. Don't use it
EffectSpikeCleanerAn EffectSimpleMono for removing spikes
EffectStereoToMonoAn Effect
EffectToneGenAn Effect that can generate a sine, square or sawtooth wave. An extended mode of EffectToneGen supports 'chirps' where the frequency changes smoothly during the tone
EffectTruncSilenceAn Effect
EffectTwoPassSimpleMonoAn Effect base class that implements a two pass process by using EffectSimpleMono
EffectWahwahAn EffectSimpleMono
EnumsEnums is a helper class for Shuttle. It defines enumerations which are used in effects dialogs, in the effects themselves and in preferences
EnvelopeDraggable curve used in TrackPanel for varying amplification
EnvPointEnvPoint, derived from XMLTagHandler, provides Envelope with a draggable point type
EQCurveEQCurve is used with EffectEqualization
EQPointEQPoint is used with EQCurve and hence EffectEqualization
EqualizationDialogDialog used with EffectEqualization
EqualizationPanelEqualizationPanel is used with EqualizationDialog and controls a graph for EffectEqualization. We should look at amalgamating the various graphing code, such as provided by FreqWindow and FilterPanel
portaudio::ExceptionBase class for all exceptions PortAudioCpp can throw
ExpandingToolBarA smart ToolBar class that has a "MainPanel" which is always displayed, and an "ExtraPanel" that can be hidden to save space
ExpandingToolBarEvtHandlerA custom event handler for ExpandingToolBar
ExportMain class to control the export function
ExportMixerDialogDialog for advanced mixing
ExportMixerPanelPanel that displays mixing for advanced mixing option
ExportMultiplePresents a dialog box allowing the user to export multiple files either by exporting each track as a separate file, or by exporting each label as a separate file
ExportTypeContainer for information about supported export types
soundtouch::FIFOProcessor
soundtouch::FIFOSampleBuffer
soundtouch::FIFOSamplePipeAbstract base class for FIFO (first-in-first-out) sample processing classes
FileDialogDialog used to present platform specific "Save As" dialog with custom controls
FileFormatPrefsA PrefsPanel used to select file format preferences and to locate the MP3 encoding library
FileNamesProvides Static functions to yield filenames
FileObjectFileObject, derived from wxFileDataObject gives extended drag and drop functionality for audio files
FLACImportFileHandleAn ImportFileHandle for FLAC data
FLACImportPluginAn ImportPlugin for FLAC data
FlowPackerPacks rectangular boxes into a rectangle, using simple first fit
FormatAbstract base class used in importing a file
FreqPlotWorks with FreqWindow to dsplay a spectrum plot of the waveform. This class actually does the graph display
FreqWindowDisplays a spectrum plot of the waveform. Has options for selecting parameters of the plot
portaudio::FunCallbackStreamCallback stream using a C++ function (either a free function or a static function) callback
portaudio::FunCallbackStream::CppToCCallbackDataSimple structure containing a function pointer to the C++ callback function and a (void) pointer to the user supplied data
GrabberThe widget to the left of a ToolBar that allows it to be dragged around to new positions
GrabberEvent
GridSupplies an accessible grid based on wxGrid
GUIPrefsA PrefsPanel for general GUI prefernces
HistoryWindowWorks with UndoManager to allow user to see descriptions of and undo previous commands. Also allows you to selectively clear the undo memory so as to free up space
portaudio::HostApiHostApi represents a host API (usually type of driver) in the System
iAVCBufferListAn unused class used by EffectAvcCompressor
ImageRollAn ImageRoll is an image that can be expanded to an arbitrary size; it is made up of both fixed pieces and repeating pieces
ImageRollPanelA wxPanel which displays an ImageRoll
ImporterClass which actulaly imports the auido, using functions defined in ImportPCM.cpp, ImportMP3.cpp, ImportOGG.cpp, ImportRawData.cpp, and ImportLOF.cpp
ImportFileHandleAn ImportFileHandle for data
ImportPluginBase class for FlacImportPlugin, LOFImportPlugin, MP3ImportPlugin, OggImportPlugin and PCMImportPlugin. Gives API for sound file import
ImportPluginListAn ImportPlugin list
ImportRawDialogImportRawDialog prompts you with options such as endianness and sample size to help you importing data of an unknown format
portaudio::InterfaceCallbackStreamCallback stream using an instance of an object that's derived from the CallbackInterface interface
InternatInternationalisation support
InvisiblePanelAn InvisiblePanel is a panel which does not repaint its own background
KeyConfigPrefsA PrefsPanel for keybindings
LabelDialogDialog for editing labels
LabelStructA LabelStruct holds information for ONE label in a LabelTrack
LabelTrackA LabelTrack is a Track that holds labels (LabelStruct)
LadspaEffectAn Effect that calls up a LADSPA plug in, i.e. many possible effects from this one class
LadspaEffectDialogDialog used with Effect
LangChoiceDialogA dialog used (at start up) to present the user with a choice of languages for Audacity
LegacyAliasBlockFileAn AliasBlockFile that references uncompressed data in an existing file
LegacyBlockFileAudacity 1.1.0 block file format:
LevellerDialogDialog for EffectLeveller
LOFImportFileHandleAn ImportFileHandle for LOF data
LOFImportPluginAn ImportPlugin for LOF data
LWSliderLightweight version of ASlider. In other words it does not have a window permanaently associated with it
MatrixHolds a matrix of doubles and supports arithmetic, subsetting, and matrix inversion. Used by InterpolateAudio
portaudio::MemFunCallbackStream< T >Callback stream using a class's member function as a callback. Template argument T is the type of the class of which a member function is going to be used
portaudio::MemFunCallbackStream< T >::MemFunToCallbackInterfaceAdapterInner class which adapts a member function callback to a CallbackInterface compliant class (so it can be adapted using the paCallbackAdapter function)
MenuBarListList of MenuBarListEntry
MenuBarListEntryMenuBarListEntry is a structure used by CommandManager
MeterVU Meter, for displaying recording/playback level
MeterBarA struct used by Meter to hold the position of one bar
MeterToolBarA ToolBar that holds the VU Meter
MeterUpdateMsgMessage used to update the Meter
MeterUpdateQueueQueue of MeterUpdateMsg used to feed the Meter
MIDIParserUnused class that might someday be used again to read MIDI files into a NoteTrack
MixerFunctions for doing the mixdown of the tracks
MixerSpecClass used with Mixer
MixerToolBarA ToolBar that provides the record and playback volume settings
MousePrefsA PrefsPanel that presents an interface for user to view the default bindings of mouse buttons to commands
MP2ExporterClass used to export MP2 files
MP3ExporterClass used to export MP3 files
MP3ImportFileHandleAn ImportFileHandle for MP3 data
MP3ImportPluginAn ImportPlugin for MP3 data
MultiDialogA multi purpose dialog, mainly used to show lists of orphaned or damaged block files. It is a good alternative to having a dialog pop up for each problem encountered, since there can be many orphans
MyFontEnumeratorMyFontEnumerator, derived from wxFontEnumerator, creates a list of fonts
NoiseRemovalDialogDialog used with EffectNoiseRemoval
NormalizeDialogDialog used with EffectNormalize
NoteTrackA Track that is used for Midi notes. (Somewhat old code)
NyqControlA control on a NyquistDialog
NyquistDialogBase class for NyquistInputDialog and NyquistOutputDialog
NyquistInputDialogDialog used with EffectNyquist
NyquistOutputDialogDialog used with EffectNyquist
OGGImportPluginAn ImportPlugin for OGG data
PaAsiHpiDeviceInfo
PaAsiHpiHostApiRepresentation
PaAsiHpiStream
PaAsiHpiStreamComponent
PaAsiHpiStreamInfo
portaudio::PaCppExceptionExceptions specific to PortAudioCpp (ie. exceptions which do not have an equivalent PortAudio error code)
PaDeviceInfo
portaudio::PaExceptionWrapper for PortAudio error codes to C++ exceptions
PaHostApiInfo
PaHostErrorInfo
PaOssStream
PaOssStreamComponent
PaStreamCallbackTimeInfo
PaStreamInfo
PaStreamParameters
PaUtilBufferProcessorThe main buffer processor data structure
PaUtilChannelDescriptorAn auxilliary data structure used internally by the buffer processor to represent host input and output buffers
PaUtilConverterTable
PaUtilHostApiRepresentation
PaUtilHostApiSpecificStreamInfoHeader
PaUtilPrivatePaFrontHostApiInfo
PaUtilStreamInterface
PaUtilStreamRepresentation
PaUtilTriangularDitherGeneratorState needed to generate a dither signal
PaUtilZeroerTable
PCMAliasBlockFileAn AliasBlockFile that references uncompressed data in an existing file
PCMImportFileHandleAn ImportFileHandle for PCM data
PCMImportPluginAn ImportPlugin for PCM data
PeakFinder
PhaserDialogDialog for EffectPhaser
PlatformCompatibilityFilename Compatibility utilities
PrefsDialogDialog that shows the current PrefsPanel in a tabbed divider
PrefsPanelUsed within the PrefsDialog, classes derived from this class include AudioIOPrefs, BatchPrefs, DirectoriesPrefs, FileFormatPrefs, GUIPrefs, KeyConfigPrefs, MousePrefs, QualityPrefs, SpectrumPrefs and ThemePrefs
QualityPrefsA PrefsPanel used for setting audio quality
soundtouch::RateTransposer
RateTransposerFloat
RateTransposerInteger
REGIONStructure to hold region of a wavetrack and a comparison function for sortability
RepeatDialogDialog used with EffectRepeat
ResampleCombined interface to libresample and libsamplerate
RingBufferHolds streamed audio samples
RtAudioRealtime audio i/o C++ classes
RtAudioDeviceInfoThe public device information structure for returning queried values
RtErrorException handling class for RtAudio & RtMidi
RulerUsed to display a Ruler
Ruler::LabelAn array of these created by the Ruler is used to determine what and where text annotations to the numbers on the Ruler get drawn
RulerPanelRulerPanel class allows you to work with a Ruler like any other wxWindow
RunParametersParses command line parameters into program parameters
SelectionBar(not quite a Toolbar) at foot of screen for setting and viewing the selection range
SelectionBarListenerA parent class of SelectionBar, used to forward events to do with changes in the SelectionBar
SeqBlockPointer to a BlockFile along with a start time. Element of a BlockArray. WARNING defined differently in Track.cpp and Sequence.cpp. Not yet sure why
SequenceHas a sequence of samples. Compare with RingBuffer
ShuttleMoves data from one place to another, converting it as required
ShuttleCliDerived from Shuttle, this class exchanges string parameters with a binary representation
ShuttleGuiDerived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI
ShuttleGuiBaseBase class for shuttling data to and from a GUI
ShuttlePrefsA kind of Shuttle to exchange data with preferences e.g. the registry
SilentBlockFileA BlockFile containing nothing but silence. Saves disk space
SimpleBlockFileA BlockFile that reads and writes uncompressed data using libsndfile
SliderDialogPop up dialog used with an LWSlider
SmartRecordDialogDialog for Smart Record, i.e., timed or long recording, limited GUI
SourceOutputStreamHelper class based on wxOutputStream used to get a png file in text format
SpecCacheCache used with WaveClip to cache spectrum information (for drawing). Cache's the Spectrogram frequency samples
SpectrumPrefsA PrefsPanel for spectrum settings
SpikeCleanerDialogDialog for EffectSpikeCleaner
portaudio::StreamA Stream represents an active or inactive input and/or output data stream in the System
portaudio::StreamParametersThe entire set of parameters needed to configure and open a Stream
SubMenuListList of SubMenuListEntry
SubMenuListEntrySubMenuListEntry is a structure used by CommandManager
SummaryInfoWorks with BlockFile to hold info about max and min and RMS over multiple samples, which in turn allows rapid drawing when zoomed out
SysKeyTextCtrlBG: A quick and dirty override of wxTextCtrl to capture keys like Ctrl, Alt
portaudio::SystemSystem singleton which represents the PortAudio system
portaudio::System::DeviceIteratorIterator class for iterating through all Devices in a System
portaudio::System::HostApiIteratorIterator class for iterating through all HostApis in a System
TagsID3 Tags (for MP3)
TagsEditorDerived from ExpandingToolBar, this dialog allows editing of Tags
soundtouch::TDStretch
ThemeBased on ThemeBase, Theme manages image and icon resources
ThemeBaseTheme management - Image loading and saving
ThemePrefsA PrefsPanel that configures dynamic loading of Theme icons and colours
TimeDialogDialog used to request a time value
TimeFieldTimeField is a class used in the TimeTextCtrl
TimeTextCtrlTimeTextCtrl provides the advanced time formatting control used in the status bar of Audacity
TimeTextCtrlAxTimeTextCtrlAx gives the TimeTextCtrl Accessibility
TimeTrackA kind of Track used to 'warp time'
TipPanelA wxPanel or a wxPopupWindow used to give the numerical value of an LWSlider or ASlider
ToneGenDialogDialog used with EffectToneGen
ToolBarWorks with ToolManager and ToolDock to provide a dockable window in which buttons can be placed
ToolBarAreaAn alterantive to ToolBarFrame which can contain an ExpandingToolBar. ToolBarArea is used for a 'docked' ToolBar, ToolBarFrame for a floating one
ToolBarArrangementSmall class that holds some layout information for an ExpandingToolBar
ToolBarDialogA dialog based container for ExpandingToolBars providing modal based operations
ToolBarFrameA miniframe based container for ExpandingToolBars providing modeless presentation
ToolBarGrabberDraws the grabber for an ExpandingToolBar
ToolDockA dynamic panel where a ToolBar can be docked
ToolManagerManages the ToolDocks and handles the dragging, floating, and docking of ToolBars
ToolsToolBarA kind of ToolBar with Tools on it
TrackFundamental data object of Audacity, placed in the TrackPanel. Classes derived form it include the WaveTrack, NoteTrack, LabelTrack and TimeTrack
TrackArtistThis class handles the actual rendering of WaveTracks (both waveforms and spectra), NoteTracks, LabelTracks and TimeTracks
TrackClipOne clip (i.e short section) of a WaveTrack
TrackFactoryUsed to create a WaveTrack, or a LabelTrack.. Implementation of the functions of this class are dispersed through the different Track classes
TrackLabelThe TrackLabel is shown to the side of a track It has the menus, pan and gain controls displayed in it
TrackListA list of TrackListNode items
TrackListIteratorAn iterator for a TrackList
TrackListNodeUsed by TrackList, points to a Track
TrackPanelCoordinates updates and operations on the main part of the screen which contains multiple tracks
TrackPanel::AudacityTimerTimer class dedicated to infomring the TrackPanel that it is time to refresh some aspect of the screen
TrackPanelAxHelper to TrackPanel to give accessibility
TrackPanelListenerA now badly named class which is used to give access to a subset of the TrackPanel functions from all over the place
TranscriptionToolBarA kind of ToolBar used to help with analysing voice recordings
TruncSilenceDialogDialog used with EffectTruncSilence
UndoManagerWorks with HistoryWindow to provide the Undo functionality
UndoStackElemHolds one item with description and time range for the UndoManager
UnusableImportPluginUsed in place of a real plug in for plug ins that have not been compiled or are not available in this version of Audacity. Has enough information to identify the file extensions that would be used, but little else
UnusableImportPluginListAn UnusableImportPlugin list
UploadDialogA contributed class for uploading audio via FTP
VectorHolds a matrix of doubles and supports arithmetic operations, including Vector-Matrix operations. Used by InterpolateAudio
ViewInfoViewInfo is used mainly to hold the zooming, selection and scroll information. It also has some status flags
VoiceKeyThis implements a voice key, detecting either the next "ON" or "OFF" point
WahwahDialogDialog for EffectWahwah
WarningDialogGives a warning message, that can be dismissed, with crucially the ability to not see similar warnings again for this session
WavDataWAV audio file 'data' section header
WaveCacheCache used with WaveClip to cache wave information (for drawing)
WaveClipThis allows multiple clips to be a part of one WaveTrack
WaveTrackA Track that contains audio waveform data
WaveTrack::LocationUsed only by WaveTrack, a special way to hold location that can accommodate merged regions
WavFormatWAV audio file 'format' section header
WavHeaderWAV audio file header
WavInFileClass for reading WAV audio files
WavOutFileClass for writing WAV audio files
WavRiffWAV audio file 'riff' section header
WrappedTypeUsed in type conversions, this wrapper for ints, strings, doubles and enums provides conversions between all the types. Functions that work on wrapped types can quickly be reused to work on any of these types. This cuts out a lot of repetitive code
XMLFileReaderReads a file and passes the results through an XMLTagHandler
XMLFileWriterWrapper to output XML data to files
XMLStringWriterWrapper to output XML data to strings
XMLTagHandlerThis class is an interface which should be implemented by classes which wish to be able to load and save themselves using XML files
XMLValueCheckerXMLValueChecker implements static bool methods for checking input values from XML files
XMLWriterBase class for XMLFileWriter and XMLStringWriter that provides the general functionality for creating XML in UTF8 encoding

Generated by  Doxygen 1.5.1   Back to index