---

LibPenguinPlay Compound List

Here are the classes, structs, unions and interfaces with brief descriptions:

• AbstractFactory (The abstract interface for the factory)
• Codec::ALawDecoder (A-Law decoder functor)
• pp::Filters::AllPass (The equation used is: y[n] = (-g * x[n]) + x[n - D] + (g * y[n - D]))
• Audio (This is an abstract interface for accessing the sound hardware)
• AudioCD (Controls audio cd playing. Supports linux and windows)
• AudioChooserDialog (Device display dialog)
• AudioStreamFromSample (Support streaming data from a sample in memory)
• AudioToFile (Mixes each active channel and writes it to a file descriptor)
• AudioToFileFactory (Introduced to provide ppsAudioToFile classes with a way to set the rate and bit width and select stereo or mono output)
• pp::Generators::BartlettWindow (Bartlett(x,r) = { 1 - |x|/r } if |x| < r { 0 } else)
• pp::Generators::BlackmanWindow (Blackman(x,r) = { 0.42 + 0.5*cos(PI*x/r)+ 0.08*cos(2*PI*x/r) } |x| < r { 0 } else)
• pp::Filters::ButterworthFilter (Here's a bit from an article by Arun Chandra at: http://ems.music.uiuc.edu/news/fall94/news.html)
• CChildFrame (ChildFrame)
• CDInfo (Retrieve cd title and track information)
• CDPlayerIni (A class to read the ini file used by Microsoft's cd player)
• CDUserInterface (Interface for a simple CD player)
• Channel (A wrapper for Audio. Helps channels management)
• CMainFrame (MainFrame)
• Codec::Codex (Encoder or decoder functor)
• pp::Filters::CombFilter (Abstract Comb Filter class)
• pp::Filters::ConnectInParallel (Connect two filters together in parallel)
• pp::Filters::ConnectInSeries (Connect two filters together in series)
• pp::Filters::ConnectorFilter (The base class for the set of filters that connect SimpleFilters together)
• pp::Generators::ConnectorGenerator (The base class for the set of Generators that connect SimpleGenerators together)
• pp::Generators::ConstantGenerator (Returns a constant value)
• pp::Convert8to16 (Some nice adapter functors for 8 bit/16 bit conversions)
• pp::Filters::Convolution (A connector filter that multiplies the output of both its filters)
• pp::Generators::CountGenerator (A trivial counter)
• CPenguinEdApp (The Application)
• CPenguinEdDoc (Sample Document)
• CPenguinEdView (The View)
• SampleWav::WavReader::CuePoints (Before this there is a 32bit count of the number of cuepoints)
• pp::Filters::Delay (Delay the output by a specified number of samples)
• DelPtr (An utility class to handle exceptions The porpuse of DelPtr is to make the compiler, rather than you, do as much of the extra work that sometimes comes when mixing dynamic memory allocation with exceptions)
• DirectSoundCapture (Windows DirectSoundCapture)
• DlgConfig (The configuration dialog)
• Dsp (Open /dev/dsp and set it to the correct format)
• DspMmapped (Open /dev/dsp and mmap it)
• pp::Filters::DynamicDelay (Delay the output by a specified number of samples)
• DynMemAlloc (A fast allocator of variable-size memory chunks)
• DynObjAlloc (A fast allocator of objects)
• EAccessFailure (File opening / memory allocation / visual initialization / ... failed)
• EAssertionFailed (Assertion failed FIX: Not used yet. ppAssert () still yields a ppInternalError ())
• EConstructionFailed (Error occured while initializing an object FIX: I'm not sure if we should use this one)
• EError (Called from a shutdown)
• EHardwareUnavailable (The hardware (-feature) we tried to access is unavailable at the moment)
• EInvalidData (Thrown e.g. when decoding corrupt files etc)
• EInvalidParameter (One or more function/method parameter(s) had an invalid value)
• EMethodFailure (Use when nothing else matches)
• ENullPointer (Null pointer encountered)
• pp::Filters::EnvelopeFilter (Scale the amplitude (volume) of the wave)
• EnvelopeFilterDialog (For the Dynamic Range Filter)
• EObscureFailure (For paranoia tests. Should only be thrown when the code/compiler/OS is buggy)
• Esd (ESounD support)
• EUnavailable (Service not available in this particular case)
• EUnsupported (File format / feature / operation not supported by LibPenguinPlay)
• EUnsupportedEnvironment (Thrown when some aspect of the environment is not supported or a required "feature" is not present. Note: this is not for checks that can be done at compile time)
• Exception (Base exception class)
• Factory (A concrete subclass of the Factory interface)
• Codec::FibonacciDecoder (I haven't quite worked out how to output two values from one input value. This decoder will take a 4 bit value and output an 8 bit value This is a bit dodgy)
• FileAudio (Ouput samples to a file)
• FilterGraphWidget (A widget for displaying graphs of filters that have been connected together)
• pp::Filters::FindOp (A more generic form of FindMax)
• pp::Filters::FIRComb (An additive Finite Impulse Reponse Filter functor)
• FixedT (A fixed point integer representation)
• flModUI (FlMod user interface class)
• SampleWav::WavReader::FmtChunk ("fmt ")
• pp::Generators::GaussWindow (Gauss(x,r,d) = { 2-(x/d)^2 } |x| < r { 0 } else)
• pp::Generators::GenAdd (Useful for a Generator expression tree)
• pp::Filters::GeneralFilter (A general filter can be defined using the differential equation a0 * X + a1 * X' + ..)
• pp::Filters::GeneratorFilter (A bridge to the generator functors)
• GeneratorGraphWidget (A widget for displaying graphs of generators that have been connected together)
• pp::Filters::GenericFilter (A general filter can be defined using the differential equation a0*X + a1*X' + a2*X'' + ..)
• pp::Generators::GenFilter (Apply a filter to a generator)
• pp::Generators::GenMinus (Useful for a Generator expression tree)
• pp::Generators::GenMultiply (Kind of like convolution)
• gtkplayer (An interface to the player class for gtk)
• pp::Generators::HammingWindow (Hanning/Hamming)
• pp::Filters::HighPassFIR (High Pass Finite Impulse Response Filter functor for use with STL algorithms)
• pp::Filters::HighPassIIR (High Pass Infinite Response Filter functor for use with STL algorithms)
• pp::Filters::IIRComb (Infinite Impulse Response Comb filter functor)
• pp::Filters::IIRCombLoop (Useful for plucked string generators)
• pp::Filters::ImpulseResponseFilter (An abstract class for FIR and IIR filters)
• pcbModuleIt::IT_ENVELOPE (Data is stored in envelope as 1 byte for y-value, 1 word for tick value The bits for flags are: \verbatim)
• pcbModuleIt::IT_HEADER (I think IT consists of - IT_HEADER - Order - then come parapointers like s3m - instrument offsets - sample offsets - pattern offsets)
• pp::Generators::IteratedWaveForm (Might be useful in combination with a Sample)
• Iterator (Generic interface for Iterator classes)
• pp::Generators::LanczosWindow (Lanczos(x,r) = { sin(PI*x/r)/(PI*x/r) } |x| < r { 0 } else)
• LocalCDDB (A class to read the ini file used by Microsoft's cd player)
• pp::Filters::LowPassFIR (Low Pass Finite Impulse Response Filter functor for use with STL algorithms)
• pp::Filters::LowPassIIR (Low Pass Infinite Response Filter functor for use with STL algorithms)
• MapLikeContainer (A simple, quick replacement for std::map)
• pp::Generators::MathGenerator (A generator functor class for use with the sin, cos, tan, etc)
• pp::Generators::MathGenerator2 (A math generator that can take another generator as it's input)
• pcbModuleMdl::MDL_II_DATA ("II", dword blocklength, byte Number of saved instruments)
• pcbModuleMdl::MDL_II_IS_DATA (Followed by NumSamples * MDL_II_IS_DATA no id or block length for MDL_II_IS_DATA)
• pcbModuleMdl::MDL_IN (ID = "IN" - Song Info block)
• pcbModuleMdl::MDL_IS (ID = "PE" panning envelope ID = "FE" frequency envelope ID = "IS" sample info block ID, blocklength, samlar, samlar * MDL_IS)
• pcbModuleMdl::MDL_PA (ID = "PA" Pattern Data block preceded by "PA", dword - block length, byte - NumPatterns followed by NumPatterns * MDL_PA)
• pcbModuleMdl::MDL_VE_DATA (ID = "VE" volume envelope block preceded by "VE" , dword block length and byte number of envelopes)
• MemAlloc (A fast (de)allocator of fixed-size memory chunks)
• pcbModuleMod::ModSampleHeader (The structure of the mod format sample header)
• Codec::MuLawDecoder (Mu-Law decoder functor)
• pp::Filters::MultiLowPassFIR (A version of the Low Pass FIR that averages a customisable number of samples)
• Mutex (Mutual Exclusion. Supports pthreads and Windows Mutexes)
• MutexLock (Automatic lock/unlock for mutexes)
• ncplayer (An interface to pcbPlayer for ncurses)
• NetAudio (Ouput samples to a TCP socket stream connection)
• MemAlloc::Node (This class is used to do linked lists internally in MemAlloc)
• DynMemAlloc::Node (This class is used to do linked lists internally in DynMemAlloc)
• pp::Filters::NullFilter (Output = input It might be useful)
• ObjAlloc (A fast (de)allocator of objects)
• SoftwareMixer::OutputConvF (A functor version of OutputConv)
• pp::Generators::ParzenWindow (Parzen(x) = 0.25 * { (2 + x)^3 } if (-2 <= x < -1) { 4 - 6*x^2 - 3*x^3 } if (-1 <= x < 0 ) { 4 - 6*x^2 + 3*x^3 } if (0 <= x < 1) { (2 - x)^3 } if (1 <= x < 2) { 0 } else)
• PatternWidget (A module pattern widget)
• pcbChannel (The channel class)
• pcbInstrument (Sound files that contain more than one sample)
• pcbInstrumentPat (Gravis Ultrasound Patch Format)
• pcbInstrumentXi (Fasttracker II extended instrument format)
• pcbModule (Load and save a module, and store all the related data)
• pcbModuleIt (Load and save an impulse tracker module)
• pcbModuleMdl (Load and save n-Factor's DigiTrakker module)
• pcbModuleMed (Load and save an octamed module)
• pcbModuleMod (Load and save a protracker module)
• pcbModuleS3m (Load and save a screamtracker module)
• pcbModuleXm (Load and save a fast tracker II module)
• pcbNote (This is used solely for storing note data)
• pcbPlayer (A class for playing modules)
• pcbPlayerController (I have introduced this class so that it will be possible in the future to easily control different player types)
• SampleWav::WavReader::PlayList (Before this there is a 32 bit count of the number of play lists)
• pp::Filters::PluginFilter (The base class for the Linux Audio Developers Simple Plugin Api filters)
• pssed (Sample Editor)
• QtGraph (A class that plots sample data on a graph for Qt)
• QtMod (The main window of the QtMod application)
• QtPattern (A Widget for displaying the patterns in modules)
• QtPlayer (An interface to the pcbPlayer for QT)
• pp::Generators::RampDown (Return a value between max(T) (at position 0) and 0 (at positions greater than length) Might be useful in combination with other generators, such as GenMultiply)
• pp::Generators::RampUp (Might be useful in combination with other generators, such as GenMultiply)
• pp::Generators::RandGenerator (Generate a random value)
• pp::Generators::RectangularWindow (Rectangular Window Functor)
• RegistryFactory (The Factory Registry)
• pcbModuleS3m::S3MSAMPLE (Flags - - 1 - st2vibrato - 2 - st2 tempo - 4 - amiga slides - 8 - 0 vol omptimisations - 16 - amiga limits - 32 - enable filter - 64 - st3 volume slides - 128 - special data present)
• Sample (A class for manipulating samples)
• SampleAF (Load a sample using the audiofile library)
• SampleAu (Load and Save an AU file)
• SampleClipboard (A clipboard for cut and pasteing to and from a Sample)
• SampleDetailsDlg (Sample Details Dialog)
• SampleIff (Load and Save an 8SVX or 16SV IFF file)
• SampleIO (An abstract interface class used to read and write to sample files)
• SamplePropertiesDialog (Properties Dialog)
• SampleRaw (Load and save a sample from a raw sample file. A raw sample file contains pcm samples and no headers)
• SampleView (Trying to abstract the opengl parts)
• SampleVoc (Load and save a Voc file)
• SampleWav (Load and Save a WAVE file)
• SampleWidget (A sample widget for fltk)
• pp::Generators::SawWave (Generate a saw toothed wave)
• pp::Filters::Scale (Scale the input by a specified value)
• pp::Filters::Schroeder1 (1. 4 comb filters in parallel followed by two all pass filters in series)
• Sequencer (Play sounds through /dev/sequencer)
• SoftwareMixer::Shift (A horrible kludge so that there are no complaints about negative bitshifts)
• SoftwareMixer::SignType (Stores information about whether the type is signed or unsigned)
• pp::Filters::SimpleFilter (The base class for the filters)
• pp::Generators::SimpleGenerator (The base class for the Generators)
• pcbInstrumentXi::SMPHeader (SMP - Fasttracker samples)
• StatMemAlloc (A fast allocator of variable-size memory chunks)
• StatObjAlloc (A fast allocator of objects)
• StreamT (Supports retrieving a stream of data)
• Thread (A simple class to encapsulate threads so that they can be used independently of the platform)
• ThreadV (A less cumbersome version of Thread)
• Timeout (A timeout class for linux and win32)
• TimeoutImpl (The timer implementation class, for linux and win32)
• TrackListDialog (For entering and display cd track details)
• pp::Filters::TransformFilter (TransformFilter is an implemetnation of a filter that uses a map to transform input values to output values)
• TransformFilterDialog (For the Dynamic Range Filter)
• MapLikeContainer::value_type (Simple version of std::pair)
• pp::Generators::WaveTable (Generate the wavetable at initialisation using a generator)
• pp::Generators::WelchWindow (Welch(x,r) = { 1 - (x/r)^2 } |x| < r { 0 } else)
• WidgetTest (A generic class that is useful for testing widgets with)
• pcbModuleXm::XI_XMHeader (The size of the xi header struct is 29 bytes)
• pcbModuleXm::XM_NOTE (If bit 7 is set in the Note field then bit 0 : Note follows 1 : Instrument follows 2 : volume column follows 3 : effect follows 4 : effect param follows Note: this means you need to process the pattern a u_int8_t at time)

---