WaveChannelUtilities.h

Go to the documentation of this file.

/*  SPDX-License-Identifier: GPL-2.0-or-later */
/*!********************************************************************
 
  Audacity: A Digital Audio Editor
 
  WaveChannelUtilities.h
 
  Paul Licameli
 
  @brief Various operations on WaveChannel, needing only its public interface
 
**********************************************************************/
#ifndef __AUDACITY_WAVE_CHANNEL_UTILITIES__
#define __AUDACITY_WAVE_CHANNEL_UTILITIES__
 
class Envelope;
enum class PlaybackDirection;
enum class sampleFormat : unsigned;
class WaveChannel;
class WaveClipChannel;
 
#include <algorithm>
#include <functional>
#include <memory>
#include <utility>
#include <vector>
 
namespace WaveChannelUtilities {
 
using Clip = WaveClipChannel;
using ClipPointer = std::shared_ptr<Clip>;
using ClipPointers = std::vector<ClipPointer>;
using ClipConstPointer = std::shared_ptr<const Clip>;
using ClipConstPointers = std::vector<ClipConstPointer>;
 
WAVE_TRACK_API
bool CompareClipsByPlayStartTime(const Clip &x, const Clip &y);
 
inline bool CompareClipPointersByPlayStartTime(
   const ClipConstPointer x, const ClipConstPointer y)
{
   return CompareClipsByPlayStartTime(*x, *y);
}
 
inline bool IsSortedByPlayStartTime(const ClipPointers &clips)
{
   return is_sorted(
      clips.begin(), clips.end(), CompareClipPointersByPlayStartTime);
}
 
inline bool IsSortedByPlayStartTime(const ClipConstPointers &clips)
{
   return is_sorted(
      clips.begin(), clips.end(), CompareClipPointersByPlayStartTime);
}
 
WAVE_TRACK_API ClipPointers SortedClipArray(WaveChannel &channel);
 
WAVE_TRACK_API ClipConstPointers SortedClipArray(const WaveChannel &channel);
 
WAVE_TRACK_API ClipPointer GetClipAtTime(WaveChannel &channel, double time);
 
WAVE_TRACK_API
ClipConstPointer GetClipAtTime(const WaveChannel &channel, double time);
 
WAVE_TRACK_API Envelope* GetEnvelopeAtTime(WaveChannel &channel, double time);
 
WAVE_TRACK_API std::pair<float, float> GetMinMax(const WaveChannel &channel,
   double t0, double t1, bool mayThrow = true);
 
WAVE_TRACK_API float GetRMS(const WaveChannel &channel,
   double t0, double t1, bool mayThrow = true);
 
WAVE_TRACK_API std::pair<size_t, size_t>
GetFloatsCenteredAroundTime(const WaveChannel &channel,
   double t, float* buffer, size_t numSideSamples,
   bool mayThrow);
 
WAVE_TRACK_API bool GetFloatAtTime(const WaveChannel &channel,
   double t, float& value, bool mayThrow);
 
WAVE_TRACK_API bool GetFloatAtTime(const Clip &clip,
   double t, float& value, bool mayThrow);
 
WAVE_TRACK_API void SetFloatsCenteredAroundTime(WaveChannel &channel,
   double t, const float* buffer, size_t numSideSamples,
   sampleFormat effectiveFormat);
 
WAVE_TRACK_API void SetFloatAtTime(WaveChannel &channel,
   double t, float value, sampleFormat effectiveFormat);
 
WAVE_TRACK_API void SetFloatsWithinTimeRange(WaveChannel &channel,
   double t0, double t1,
   const std::function<float(double sampleTime)>& producer,
   sampleFormat effectiveFormat);
 
WAVE_TRACK_API size_t GetFloatsFromTime(const WaveChannel &channel,
   double t, float* buffer, size_t numSamples,
   bool mayThrow, PlaybackDirection direction);
 
WAVE_TRACK_API void SetFloatsFromTime(WaveChannel &channel,
   double t, const float* buffer, size_t numSamples,
   sampleFormat effectiveFormat, PlaybackDirection direction);
 
WAVE_TRACK_API void SetFloatsFromTime(Clip &channel,
   double t, const float* buffer, size_t numSamples,
   sampleFormat effectiveFormat, PlaybackDirection direction);
 
WAVE_TRACK_API
ClipConstPointer GetAdjacentClip(const ClipConstPointers &clips,
   const Clip& clip, PlaybackDirection searchDirection);
 
WAVE_TRACK_API ClipPointer GetAdjacentClip(const ClipPointers &clips,
   const Clip& clip, PlaybackDirection searchDirection);
 
WAVE_TRACK_API ClipConstPointer GetNextClip(const ClipConstPointers &clips,
   const Clip& clip, PlaybackDirection searchDirection);
 
WAVE_TRACK_API ClipPointer GetNextClip(const ClipPointers &clips,
   const Clip& clip, PlaybackDirection searchDirection);
 
WAVE_TRACK_API ClipPointer GetIntervalAtTime(WaveChannel &channel, double t);
}
 
#endif