Mix.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  Mix.h
 
  Dominic Mazzoni
  Markus Meyer
 
********************************************************************//********************************************************************/
 
#ifndef __AUDACITY_MIX__
#define __AUDACITY_MIX__
 
#include "audacity/Types.h"
#include "SampleFormat.h"
#include <vector>
 
class sampleCount;
class Resample;
class BoundedEnvelope;
class WaveTrackFactory;
class TrackList;
class WaveTrack;
using WaveTrackConstArray = std::vector < std::shared_ptr < const WaveTrack > >;
class WaveTrackCache;
 
void AUDACITY_DLL_API MixAndRender(TrackList * tracks, WaveTrackFactory *factory,
                  double rate, sampleFormat format,
                  double startTime, double endTime,
                  std::shared_ptr<WaveTrack> &uLeft,
                  std::shared_ptr<WaveTrack> &uRight);
 
class AUDACITY_DLL_API MixerSpec
{
   unsigned mNumTracks, mNumChannels, mMaxNumChannels;
 
   void Alloc();
 
public:
   ArraysOf<bool> mMap;
 
   MixerSpec( unsigned numTracks, unsigned maxNumChannels );
   MixerSpec( const MixerSpec &mixerSpec );
   virtual ~MixerSpec();
 
   bool SetNumChannels( unsigned numChannels );
   unsigned GetNumChannels() { return mNumChannels; }
 
   unsigned GetMaxNumChannels() { return mMaxNumChannels; }
   unsigned GetNumTracks() { return mNumTracks; }
 
   MixerSpec& operator=( const MixerSpec &mixerSpec );
};
 
class AUDACITY_DLL_API Mixer {
 public:
 
    // An argument to Mixer's constructor
    class AUDACITY_DLL_API WarpOptions
    {
    public:
       explicit WarpOptions(const TrackList &list);
 
       explicit WarpOptions(const BoundedEnvelope *e);
 
       WarpOptions(double min, double max);
 
    private:
       friend class Mixer;
       const BoundedEnvelope *envelope = nullptr;
       double minSpeed, maxSpeed;
    };
 
    //
   // Constructor / Destructor
   //
 
   Mixer(const WaveTrackConstArray &inputTracks, bool mayThrow,
         const WarpOptions &warpOptions,
         double startTime, double stopTime,
         unsigned numOutChannels, size_t outBufferSize, bool outInterleaved,
         double outRate, sampleFormat outFormat,
         bool highQuality = true, MixerSpec *mixerSpec = nullptr,
         bool applytTrackGains = true);
 
   virtual ~ Mixer();
 
   //
   // Processing
   //
 
   size_t Process(size_t maxSamples);
 
   void Restart();
 
   void Reposition(double t, bool bSkipping = false);
 
   // Used in scrubbing.
   void SetTimesAndSpeed(double t0, double t1, double speed);
   void SetSpeedForPlayAtSpeed(double speed);
   void SetSpeedForKeyboardScrubbing(double speed, double startTime);
 
   double MixGetCurrentTime();
 
   constSamplePtr GetBuffer();
 
   constSamplePtr GetBuffer(int channel);
 
 private:
 
   void Clear();
   size_t MixSameRate(int *channelFlags, WaveTrackCache &cache,
                           sampleCount *pos);
 
   size_t MixVariableRates(int *channelFlags, WaveTrackCache &cache,
                                sampleCount *pos, float *queue,
                                int *queueStart, int *queueLen,
                                Resample * pResample);
 
   void MakeResamplers();
 
 private:
 
    // Input
   const size_t     mNumInputTracks;
   ArrayOf<WaveTrackCache> mInputTrack;
   bool             mbVariableRates;
   const BoundedEnvelope *mEnvelope;
   ArrayOf<sampleCount> mSamplePos;
   const bool       mApplyTrackGains;
   Doubles          mEnvValues;
   double           mT0; // Start time
   double           mT1; // Stop time (none if mT0==mT1)
   double           mTime;  // Current time (renamed from mT to mTime for consistency with AudioIO - mT represented warped time there)
   ArrayOf<std::unique_ptr<Resample>> mResample;
   const size_t     mQueueMaxLen;
   FloatBuffers     mSampleQueue;
   ArrayOf<int>     mQueueStart;
   ArrayOf<int>     mQueueLen;
   size_t           mProcessLen;
   MixerSpec        *mMixerSpec;
 
   // Output
   size_t              mMaxOut;
   const unsigned   mNumChannels;
   Floats           mGains;
   unsigned         mNumBuffers;
   size_t              mBufferSize;
   size_t              mInterleavedBufferSize;
   const sampleFormat mFormat;
   bool             mInterleaved;
   ArrayOf<SampleBuffer> mBuffer;
   ArrayOf<Floats>  mTemp;
   Floats           mFloatBuffer;
   const double     mRate;
   double           mSpeed;
   bool             mHighQuality;
   std::vector<double> mMinFactor, mMaxFactor;
 
   const bool       mMayThrow;
};
 
#endif