#include <TimeAndPitchAudioReader.h>

Inheritance diagram for staffpad::audio::TimeAndPitchAudioReader:

Collaboration diagram for staffpad::audio::TimeAndPitchAudioReader:

Public Member Functions
	TimeAndPitchAudioReader (std::unique_ptr< BaseAudioReader > reader)

virtual	~TimeAndPitchAudioReader ()

AudioFormat	getFormat () const override

bool	canSeek () const override

bool	setPosition (int64_t newSamplePosition) override
	set the position based on input samples More...

int64_t	getPosition () const override

int64_t	getNumOfSourceSamples () const override

int32_t	read (Signal32 &outputSignal) override

int32_t	readTimeAndPitch (Signal32 &outputSignal, double timeStretch=1.0, double pitchFactor=1.0)

void	setQuality (const TimeAndPitch::QualitySettings &settings)

void	setLooping (bool flag)

Private Member Functions
int32_t	_read_from_base_reader_append_silence (Signal32 &sig)

Private Attributes
std::unique_ptr< BaseAudioReader >	_base_reader

Signal32	_sig

std::unique_ptr< TimeAndPitch >	_time_and_pitch

int	_initial_samples_to_discard = 0

int	_silent_samples_to_append = 0

bool	_looping = false

Static Private Attributes
static constexpr int	_block_size = 512

Detailed Description

Definition at line 10 of file TimeAndPitchAudioReader.h.

Constructor & Destructor Documentation

◆ TimeAndPitchAudioReader()

staffpad::audio::TimeAndPitchAudioReader::TimeAndPitchAudioReader ( std::unique_ptr< BaseAudioReader > reader )

inline

Definition at line 13 of file TimeAndPitchAudioReader.h.

       : _base_reader(std::move(reader))
       , _sig(2, _block_size)
   {
      _time_and_pitch = std::make_unique<TimeAndPitch>(2); // 2 channels
      _time_and_pitch->setup(4096, _block_size);
      _initial_samples_to_discard = _time_and_pitch->getLatencySamples();
      _silent_samples_to_append =
         _looping ? 0 : _time_and_pitch->getLatencySamples();
   }

References _block_size, _initial_samples_to_discard, _looping, _silent_samples_to_append, and _time_and_pitch.

◆ ~TimeAndPitchAudioReader()

virtual staffpad::audio::TimeAndPitchAudioReader::~TimeAndPitchAudioReader ( )

inlinevirtual

Definition at line 24 of file TimeAndPitchAudioReader.h.

25 {

26 }

Member Function Documentation

◆ _read_from_base_reader_append_silence()

int32_t staffpad::audio::TimeAndPitchAudioReader::_read_from_base_reader_append_silence ( Signal32 & sig )

inlineprivate

read from the base reader, but append some silence at the end. We need this to get the final samples out

Definition at line 154 of file TimeAndPitchAudioReader.h.

   {
      int n = _base_reader->read(_sig);
      if (n < sig.getNumOfDataPoints())
      {
         int silent_n =
            std::min(sig.getNumOfDataPoints() - n, _silent_samples_to_append);
         sig.setToValue(0.f, n, n + silent_n, -1);
         _silent_samples_to_append -= silent_n;
         return n + silent_n;
      }
      return n;
   }

References _base_reader, _sig, _silent_samples_to_append, and min().

Referenced by readTimeAndPitch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ canSeek()

bool staffpad::audio::TimeAndPitchAudioReader::canSeek ( ) const

inlineoverride

Definition at line 33 of file TimeAndPitchAudioReader.h.

   {
      return _base_reader->canSeek();
   }

References _base_reader.

Referenced by setPosition().

Here is the caller graph for this function:

◆ getFormat()

AudioFormat staffpad::audio::TimeAndPitchAudioReader::getFormat ( ) const

inlineoverride

Definition at line 28 of file TimeAndPitchAudioReader.h.

   {
      return _base_reader->getFormat();
   }

References _base_reader.

◆ getNumOfSourceSamples()

int64_t staffpad::audio::TimeAndPitchAudioReader::getNumOfSourceSamples ( ) const

inlineoverride

Definition at line 59 of file TimeAndPitchAudioReader.h.

   {
      return _base_reader->getNumOfSourceSamples();
   }

References _base_reader.

◆ getPosition()

int64_t staffpad::audio::TimeAndPitchAudioReader::getPosition ( ) const

inlineoverride

Definition at line 54 of file TimeAndPitchAudioReader.h.

   {
      return _base_reader->getPosition();
   }

References _base_reader.

◆ read()

int32_t staffpad::audio::TimeAndPitchAudioReader::read ( Signal32 & outputSignal )

inlineoverride

Definition at line 64 of file TimeAndPitchAudioReader.h.

   {
      return _base_reader->read(outputSignal);
   }

References _base_reader.

◆ readTimeAndPitch()

int32_t staffpad::audio::TimeAndPitchAudioReader::readTimeAndPitch	(	Signal32 &	outputSignal,
		double	timeStretch = `1.0`,
		double	pitchFactor = `1.0`
	)

inline

Read with time stretch and pitch shift. Do not mix this call with normal read() calls.

Definition at line 71 of file TimeAndPitchAudioReader.h.

   {
      PPK_ASSERT(outputSignal.getNumOfChannels() == 2);
 
      int num_samples = outputSignal.getNumOfDataPoints();
      int p = 0;
      bool end_of_file = false;
      _time_and_pitch->setTimeStretchAndPitchFactor(timeStretch, pitchFactor);
      while (num_samples > 0)
      {
         int num_samples_to_retrieve = std::min(num_samples, _block_size);
         while (_time_and_pitch->getNumAvailableOutputSamples() <
                num_samples_to_retrieve)
         {
            int feed_now =
               std::min(_time_and_pitch->getSamplesToNextHop(), _block_size);
            _sig.ensureDimensions(2, feed_now);
            int samples_read = _read_from_base_reader_append_silence(_sig);
            _time_and_pitch->feedAudio(_sig.getReadPointer(), samples_read);
            if (samples_read < feed_now)
            {
               if (_looping)
               {
                  _base_reader->setPosition(0);
               }
               else
               {
                  end_of_file = true;
                  break;
               }
            }
         }
 
         if (int n = int(_initial_samples_to_discard * timeStretch + 0.5f);
             n > 0)
         {
            n = std::min({ n, _time_and_pitch->getNumAvailableOutputSamples(),
                           outputSignal.getNumOfDataPoints(), _block_size });
            // dump to the beginning of the block to be overwritten be real data
            // later
            float* dmp[2] = { outputSignal.getWriteChannelPtr(0),
                              outputSignal.getWriteChannelPtr(1) };
            _time_and_pitch->retrieveAudio(dmp, n);
            _initial_samples_to_discard -= int(n / timeStretch + 0.5f);
         }
         else
         {
            _initial_samples_to_discard =
               0; // can still be 1 or 2 for extreme factors due to rounding
            float* smp[2] = { outputSignal.getWriteChannelPtr(0) + p,
                              outputSignal.getWriteChannelPtr(1) + p };
 
            int num_samples_retrieved = std::min(
               num_samples_to_retrieve,
               _time_and_pitch->getNumAvailableOutputSamples());
            _time_and_pitch->retrieveAudio(smp, num_samples_retrieved);
 
            p += num_samples_retrieved;
            num_samples -= num_samples_retrieved;
         }
         if (end_of_file)
            break;
      }
      return p;
   }

References _base_reader, _block_size, _initial_samples_to_discard, _looping, _read_from_base_reader_append_silence(), _sig, _time_and_pitch, and min().

Here is the call graph for this function:

◆ setLooping()

void staffpad::audio::TimeAndPitchAudioReader::setLooping ( bool flag )

inline

Definition at line 144 of file TimeAndPitchAudioReader.h.

   {
      _looping = flag;
      _silent_samples_to_append =
         _looping ? 0 : _time_and_pitch->getLatencySamples();
   }

References _looping, _silent_samples_to_append, _time_and_pitch, and flag.

◆ setPosition()

bool staffpad::audio::TimeAndPitchAudioReader::setPosition ( int64_t newSamplePosition )

inlineoverride

set the position based on input samples

Definition at line 39 of file TimeAndPitchAudioReader.h.

   {
      if (newSamplePosition != _base_reader->getPosition())
      {
         _base_reader->setPosition(
            newSamplePosition); // todo: needs to move further into the past to
                                // make up latency
         _initial_samples_to_discard = _time_and_pitch->getLatencySamples();
         _silent_samples_to_append =
            _looping ? 0 : _time_and_pitch->getLatencySamples();
         _time_and_pitch->reset();
      }
      return canSeek();
   }

References _base_reader, _initial_samples_to_discard, _looping, _silent_samples_to_append, _time_and_pitch, and canSeek().

Here is the call graph for this function:

◆ setQuality()

void staffpad::audio::TimeAndPitchAudioReader::setQuality ( const TimeAndPitch::QualitySettings & settings )

inline

Definition at line 139 of file TimeAndPitchAudioReader.h.

   {
      _time_and_pitch->setQuality(settings);
   }

References _time_and_pitch, and settings().

Here is the call graph for this function:

Member Data Documentation

◆ _base_reader

std::unique_ptr<BaseAudioReader> staffpad::audio::TimeAndPitchAudioReader::_base_reader

private

Definition at line 169 of file TimeAndPitchAudioReader.h.

Referenced by _read_from_base_reader_append_silence(), canSeek(), getFormat(), getNumOfSourceSamples(), getPosition(), read(), readTimeAndPitch(), and setPosition().

◆ _block_size

constexpr int staffpad::audio::TimeAndPitchAudioReader::_block_size = 512

staticconstexprprivate

Definition at line 168 of file TimeAndPitchAudioReader.h.

Referenced by readTimeAndPitch(), and TimeAndPitchAudioReader().

◆ _initial_samples_to_discard

int staffpad::audio::TimeAndPitchAudioReader::_initial_samples_to_discard = 0

private

Definition at line 172 of file TimeAndPitchAudioReader.h.

Referenced by readTimeAndPitch(), setPosition(), and TimeAndPitchAudioReader().

◆ _looping

bool staffpad::audio::TimeAndPitchAudioReader::_looping = false

private

Definition at line 174 of file TimeAndPitchAudioReader.h.

Referenced by readTimeAndPitch(), setLooping(), setPosition(), and TimeAndPitchAudioReader().

◆ _sig

Signal32 staffpad::audio::TimeAndPitchAudioReader::_sig

private

Definition at line 170 of file TimeAndPitchAudioReader.h.

Referenced by _read_from_base_reader_append_silence(), and readTimeAndPitch().

◆ _silent_samples_to_append

int staffpad::audio::TimeAndPitchAudioReader::_silent_samples_to_append = 0

private

Definition at line 173 of file TimeAndPitchAudioReader.h.

Referenced by _read_from_base_reader_append_silence(), setLooping(), setPosition(), and TimeAndPitchAudioReader().

◆ _time_and_pitch

std::unique_ptr<TimeAndPitch> staffpad::audio::TimeAndPitchAudioReader::_time_and_pitch

private

Definition at line 171 of file TimeAndPitchAudioReader.h.

Referenced by readTimeAndPitch(), setLooping(), setPosition(), setQuality(), and TimeAndPitchAudioReader().

The documentation for this class was generated from the following file:

TimeAndPitchAudioReader.h

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TimeAndPitchAudioReader()

◆ ~TimeAndPitchAudioReader()

Member Function Documentation

◆ _read_from_base_reader_append_silence()

◆ canSeek()

◆ getFormat()

◆ getNumOfSourceSamples()

◆ getPosition()

◆ read()

◆ readTimeAndPitch()

◆ setLooping()

◆ setPosition()

◆ setQuality()

Member Data Documentation

◆ _base_reader

◆ _block_size

◆ _initial_samples_to_discard

◆ _looping

◆ _sig

◆ _silent_samples_to_append

◆ _time_and_pitch