MixerOptions.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  @file MixerOptions.h
  @brief supporting classes for Mixer
 
  Dominic Mazzoni
  Markus Meyer
 
  Paul Licameli split from Mix.h
 
***********************************************************************/
 
#ifndef __AUDACITY_MIXER_OPTIONS__
#define __AUDACITY_MIXER_OPTIONS__
 
#include "EffectInterface.h" // for EffectSettings
#include "GlobalVariable.h"
#include "MemoryX.h"
#include <functional>
#include <vector>
 
class AudacityProject;
class BoundedEnvelope;
class EffectInstanceEx;
class WideSampleSequence;
 
namespace MixerOptions {
 
class MIXER_API Downmix final {
   unsigned mNumTracks, mNumChannels, mMaxNumChannels;
 
   void Alloc();
 
public:
   ArraysOf<bool> mMap;
 
   Downmix(unsigned numTracks, unsigned maxNumChannels);
   Downmix(const Downmix &mixerSpec);
   Downmix(const Downmix &mixerSpec, const std::vector<bool>& tracksMask);
   ~Downmix();
 
   bool SetNumChannels(unsigned numChannels);
   unsigned GetNumChannels() const { return mNumChannels; }
 
   unsigned GetMaxNumChannels() const { return mMaxNumChannels; }
   unsigned GetNumTracks() const { return mNumTracks; }
 
   Downmix& operator=(const Downmix &mixerSpec);
};
 
struct MIXER_API Warp final {
   struct MIXER_API DefaultWarp : GlobalHook<DefaultWarp,
      const BoundedEnvelope*(const AudacityProject*)
   >{};
 
   explicit Warp(const AudacityProject *pProject);
 
   explicit Warp(const BoundedEnvelope *e);
 
 
   Warp(double min, double max, double initial = 1.0);
 
   const BoundedEnvelope *const envelope = nullptr;
   const double minSpeed, maxSpeed;
   const double initialSpeed{ 1.0 };
};
 
// Information derived from Warp and other data
struct ResampleParameters final {
   ResampleParameters(bool highQuality,
      double inRate, double outRate, const Warp &options);
   bool             mHighQuality{};
   bool             mVariableRates{ false };
   double           mMinFactor, mMaxFactor;
};
 
struct TimesAndSpeed final {
   // Bounds for fetch position in the sample source
   double           mT0; // Start time
   double           mT1; // Stop time (none if mT0==mT1)
   // Varying scrub speed is one cause for resampling
   double           mSpeed;
 
   // For output purposes only (like progress indicator update)
   double           mTime;  // Current time (renamed from mT to mTime for
   // consistency with AudioIO - mT represented warped time there)
};
 
struct StageSpecification final {
   using Factory = std::function<std::shared_ptr<EffectInstance>()>;
 
   const Factory factory;
   EffectSettings settings;
 
   mutable std::shared_ptr<EffectInstance> mpFirstInstance;
};
 
}
#endif