WideClip Class Reference

#include <WideClip.h>

Inheritance diagram for WideClip:

Collaboration diagram for WideClip:

Public Member Functions
	WideClip (std::shared_ptr< ClipInterface > left, std::shared_ptr< ClipInterface > right)
Observer::Subscription	SubscribeToCentShiftChange (std::function< void(int)> cb) override
Observer::Subscription	SubscribeToPitchAndSpeedPresetChange (std::function< void(PitchAndSpeedPreset)> cb) override
AudioSegmentSampleView	GetSampleView (size_t ii, sampleCount start, size_t len, bool mayThrow) const override
sampleCount	GetVisibleSampleCount () const override
size_t	GetWidth () 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
PitchAndSpeedPreset	GetPitchAndSpeedPreset () 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	GetWidth () const =0
virtual int	GetCentShift () const =0
virtual Observer::Subscription	SubscribeToCentShiftChange (std::function< void(int)> cb)=0
virtual PitchAndSpeedPreset	GetPitchAndSpeedPreset () const =0
virtual Observer::Subscription	SubscribeToPitchAndSpeedPresetChange (std::function< void(PitchAndSpeedPreset)> cb)=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

Private Attributes
const std::array< std::shared_ptr< ClipInterface >, 2 >	mChannels

Detailed Description

---

Audacity: A Digital Audio Editor

WideClip.h

Matthieu Hodgkinson

Definition at line 21 of file WideClip.h.

Constructor & Destructor Documentation

WideClip()

WideClip::WideClip	(	std::shared_ptr< ClipInterface >	left,
		std::shared_ptr< ClipInterface >	right
	)

---

Audacity: A Digital Audio Editor

WideClip.cpp

Matthieu Hodgkinson

Definition at line 13 of file WideClip.cpp.

    : mChannels { std::move(left), std::move(right) }
{
}

Member Function Documentation

GetCentShift()

int WideClip::GetCentShift ( ) const

overridevirtual

Implements ClipInterface.

Definition at line 60 of file WideClip.cpp.

{
   return mChannels[0u]->GetCentShift();
}

References mChannels.

GetPitchAndSpeedPreset()

PitchAndSpeedPreset WideClip::GetPitchAndSpeedPreset ( ) const

overridevirtual

Implements ClipInterface.

Definition at line 65 of file WideClip.cpp.

{
   return mChannels[0u]->GetPitchAndSpeedPreset();
}

References mChannels.

GetPlayEndTime()

double WideClip::GetPlayEndTime ( ) const

overridevirtual

Implements ClipTimes.

Definition at line 45 of file WideClip.cpp.

{
   return mChannels[0u]->GetPlayEndTime();
}

References mChannels.

GetPlayStartTime()

double WideClip::GetPlayStartTime ( ) const

overridevirtual

Implements ClipTimes.

Definition at line 40 of file WideClip.cpp.

{
   return mChannels[0u]->GetPlayStartTime();
}

References mChannels.

GetRate()

int WideClip::GetRate ( ) const

overridevirtual

Implements ClipTimes.

Definition at line 35 of file WideClip.cpp.

{
   return mChannels[0u]->GetRate();
}

References mChannels.

GetSampleView()

AudioSegmentSampleView WideClip::GetSampleView ( size_t  ii, sampleCount  start, size_t  len, bool  mayThrow  ) const

overridevirtual

Implements ClipInterface.

Definition at line 19 of file WideClip.cpp.

{
   return mChannels[ii]->GetSampleView(0u, start, len, mayThrow);
}

References mChannels.

GetStretchRatio()

double WideClip::GetStretchRatio ( ) const

overridevirtual

Implements ClipTimes.

Definition at line 55 of file WideClip.cpp.

{
   return mChannels[0u]->GetStretchRatio();
}

References mChannels.

GetVisibleSampleCount()

sampleCount WideClip::GetVisibleSampleCount ( ) const

overridevirtual

The number of raw audio samples not hidden by trimming.

Implements ClipTimes.

Definition at line 25 of file WideClip.cpp.

{
   return mChannels[0u]->GetVisibleSampleCount();
}

References mChannels.

GetWidth()

size_t WideClip::GetWidth ( ) const

overridevirtual

Implements ClipInterface.

Definition at line 30 of file WideClip.cpp.

{
   return mChannels[1u] == nullptr ? 1u : 2u;
}

References mChannels.

SubscribeToCentShiftChange()

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

overridevirtual

Implements ClipInterface.

Definition at line 71 of file WideClip.cpp.

{
   // On purpose set the publisher on the left channel only. This is not a clip
   // property that is saved to disk, and else we'll get two callbacks for the
   // same event.
   return mChannels[0u]->SubscribeToCentShiftChange(std::move(cb));
}

References mChannels.

SubscribeToPitchAndSpeedPresetChange()

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

overridevirtual

Implements ClipInterface.

Definition at line 80 of file WideClip.cpp.

{
   // On purpose set the publisher on the left channel only. This is not a clip
   // property that is saved to disk, and else we'll get two callbacks for the
   // same event.
   return mChannels[0u]->SubscribeToPitchAndSpeedPresetChange(std::move(cb));
}

References mChannels.

TimeToSamples()

sampleCount WideClip::TimeToSamples ( double  time ) const

overridevirtual

Implements ClipTimes.

Definition at line 50 of file WideClip.cpp.

{
   return mChannels[0u]->TimeToSamples(time);
}

References mChannels.

Member Data Documentation

mChannels

const std::array<std::shared_ptr<ClipInterface>, 2> WideClip::mChannels

private

Definition at line 60 of file WideClip.h.

Referenced by GetCentShift(), GetPitchAndSpeedPreset(), GetPlayEndTime(), GetPlayStartTime(), GetRate(), GetSampleView(), GetStretchRatio(), GetVisibleSampleCount(), GetWidth(), SubscribeToCentShiftChange(), SubscribeToPitchAndSpeedPresetChange(), and TimeToSamples().

---

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

• WideClip.h
• WideClip.cpp