FloatVectorClip Class Reference

#include <FloatVectorClip.h>

Inheritance diagram for FloatVectorClip:

Collaboration diagram for FloatVectorClip:

Public Member Functions
	FloatVectorClip (int sampleRate, const std::vector< std::vector< float > > &audio)
	FloatVectorClip (int sampleRate, const std::vector< float > &audio, size_t numChannels)
AudioSegmentSampleView	GetSampleView (size_t iChannel, sampleCount start, size_t len, bool mayThrow) const override
sampleCount	GetVisibleSampleCount () const override
size_t	NChannels () const override
int	GetRate () const override
double	GetPlayStartTime () const override
double	GetPlayEndTime () const override
sampleCount	TimeToSamples (double time) const override
double	GetStretchRatio () const override
int	GetCentShift () const override
Observer::Subscription	SubscribeToCentShiftChange (std::function< void(int)> cb) const override
PitchAndSpeedPreset	GetPitchAndSpeedPreset () const override
Observer::Subscription	SubscribeToPitchAndSpeedPresetChange (std::function< void(PitchAndSpeedPreset)> cb) const override
Public Member Functions inherited from ClipInterface
	~ClipInterface () override
virtual AudioSegmentSampleView	GetSampleView (size_t iChannel, sampleCount start, size_t length, bool mayThrow=true) const =0
virtual size_t	NChannels () const =0
virtual int	GetCentShift () const =0
virtual Observer::Subscription	SubscribeToCentShiftChange (std::function< void(int)> cb) const =0
virtual PitchAndSpeedPreset	GetPitchAndSpeedPreset () const =0
virtual Observer::Subscription	SubscribeToPitchAndSpeedPresetChange (std::function< void(PitchAndSpeedPreset)> cb) const =0
Public Member Functions inherited from ClipTimes
virtual	~ClipTimes ()
virtual sampleCount	GetVisibleSampleCount () const =0
virtual int	GetRate () const =0
virtual double	GetPlayStartTime () const =0
virtual double	GetPlayEndTime () const =0
virtual sampleCount	TimeToSamples (double time) const =0
virtual double	GetStretchRatio () const =0

Public Attributes
double	stretchRatio = 1.
double	playStartTime = 0.

Private Member Functions
double	GetPlayDuration () const

Private Attributes
const int	mSampleRate
const std::vector< std::vector< float > >	mAudio

Detailed Description

---

Audacity: A Digital Audio Editor

FloatVectorClip.h

Matthieu Hodgkinson

Definition at line 15 of file FloatVectorClip.h.

Constructor & Destructor Documentation

FloatVectorClip() [1/2]

FloatVectorClip::FloatVectorClip	(	int	sampleRate,
		const std::vector< std::vector< float > > &	audio
	)

---

Audacity: A Digital Audio Editor

FloatVectorClip.cpp

Matthieu Hodgkinson

Definition at line 15 of file FloatVectorClip.cpp.

    : mSampleRate { sampleRate }
    , mAudio { audio }
{
}

FloatVectorClip() [2/2]

FloatVectorClip::FloatVectorClip	(	int	sampleRate,
		const std::vector< float > &	audio,
		size_t	numChannels
	)

Definition at line 34 of file FloatVectorClip.cpp.

    : FloatVectorClip(sampleRate, Duplicate(audio, numChannels))
{
}

Member Function Documentation

GetCentShift()

int FloatVectorClip::GetCentShift ( ) const

inlineoverridevirtual

Implements ClipInterface.

Definition at line 52 of file FloatVectorClip.h.

   {
      return 0;
   }

GetPitchAndSpeedPreset()

PitchAndSpeedPreset FloatVectorClip::GetPitchAndSpeedPreset ( ) const

inlineoverridevirtual

Implements ClipInterface.

Definition at line 63 of file FloatVectorClip.h.

   {
      return PitchAndSpeedPreset::Default;
   }

References Default.

GetPlayDuration()

double FloatVectorClip::GetPlayDuration ( ) const

private

Definition at line 71 of file FloatVectorClip.cpp.

{
   return stretchRatio * mAudio[0].size() / mSampleRate;
}

References mAudio, mSampleRate, and stretchRatio.

Referenced by GetPlayEndTime().

Here is the caller graph for this function:

GetPlayEndTime()

double FloatVectorClip::GetPlayEndTime ( ) const

inlineoverridevirtual

Implements ClipTimes.

Definition at line 40 of file FloatVectorClip.h.

   {
      return playStartTime + GetPlayDuration();
   }

References GetPlayDuration(), and playStartTime.

Here is the call graph for this function:

GetPlayStartTime()

double FloatVectorClip::GetPlayStartTime ( ) const

inlineoverridevirtual

Implements ClipTimes.

Definition at line 35 of file FloatVectorClip.h.

   {
      return playStartTime;
   }

References playStartTime.

GetRate()

int FloatVectorClip::GetRate ( ) const

overridevirtual

Implements ClipTimes.

Definition at line 61 of file FloatVectorClip.cpp.

{
   return mSampleRate;
}

References mSampleRate.

Referenced by TimeToSamples().

Here is the caller graph for this function:

GetSampleView()

AudioSegmentSampleView FloatVectorClip::GetSampleView ( size_t  iChannel, sampleCount  start, size_t  len, bool  mayThrow  ) const

overridevirtual

Implements ClipInterface.

Definition at line 40 of file FloatVectorClip.cpp.

{
   std::vector<BlockSampleView> blockViews {
      std::make_shared<std::vector<float>>(mAudio[iChannel])
   };
   // todo(mhodgkinson) review argument types.
   return AudioSegmentSampleView(
      std::move(blockViews), start.as_size_t(), len);
}

References sampleCount::as_size_t(), anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, and mAudio.

Here is the call graph for this function:

GetStretchRatio()

double FloatVectorClip::GetStretchRatio ( ) const

inlineoverridevirtual

Implements ClipTimes.

Definition at line 47 of file FloatVectorClip.h.

   {
      return stretchRatio;
   }

References stretchRatio.

GetVisibleSampleCount()

sampleCount FloatVectorClip::GetVisibleSampleCount ( ) const

overridevirtual

The number of raw audio samples not hidden by trimming.

Implements ClipTimes.

Definition at line 51 of file FloatVectorClip.cpp.

{
   return mAudio[0].size();
}

References mAudio.

NChannels()

size_t FloatVectorClip::NChannels ( ) const

overridevirtual

Implements ClipInterface.

Definition at line 56 of file FloatVectorClip.cpp.

{
   return mAudio.size();
}

References mAudio.

SubscribeToCentShiftChange()

Observer::Subscription FloatVectorClip::SubscribeToCentShiftChange ( std::function< void(int)>  cb ) const

inlineoverridevirtual

Implements ClipInterface.

Definition at line 58 of file FloatVectorClip.h.

   {
      return {};
   }

SubscribeToPitchAndSpeedPresetChange()

Observer::Subscription FloatVectorClip::SubscribeToPitchAndSpeedPresetChange ( std::function< void(PitchAndSpeedPreset)>  cb ) const

inlineoverridevirtual

Implements ClipInterface.

Definition at line 68 of file FloatVectorClip.h.

   {
      return {};
   }

TimeToSamples()

sampleCount FloatVectorClip::TimeToSamples ( double  time ) const

overridevirtual

Implements ClipTimes.

Definition at line 66 of file FloatVectorClip.cpp.

{
   return sampleCount(floor(time * GetRate() + 0.5));
}

References GetRate().

Here is the call graph for this function:

Member Data Documentation

mAudio

const std::vector<std::vector<float> > FloatVectorClip::mAudio

private

Definition at line 82 of file FloatVectorClip.h.

Referenced by GetPlayDuration(), GetSampleView(), GetVisibleSampleCount(), and NChannels().

mSampleRate

const int FloatVectorClip::mSampleRate

private

Definition at line 81 of file FloatVectorClip.h.

Referenced by GetPlayDuration(), and GetRate().

playStartTime

double FloatVectorClip::playStartTime = 0.

Definition at line 76 of file FloatVectorClip.h.

Referenced by GetPlayEndTime(), and GetPlayStartTime().

stretchRatio

double FloatVectorClip::stretchRatio = 1.

Definition at line 75 of file FloatVectorClip.h.

Referenced by GetPlayDuration(), and GetStretchRatio().

---

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

• FloatVectorClip.h
• FloatVectorClip.cpp