lmms
Cross-platform music production software
Loading...
Searching...
No Matches
lmms::SampleThumbnailCache::Thumbnail Class Reference

Encapsulates a fixed-width vector of audio peak min/max values. More...

#include <SampleThumbnailCache.h>

Classes

struct  Peak
 Stores a audio peak value pairing (i.e., minimum and maximum sample over some amount of time). More...

Public Member Functions

 Thumbnail (f_cnt_t width)
 Constructs an empty thumbnail of a certain width.
auto compress (f_cnt_t outputWidth) const -> Thumbnail
 Downsamples this thumbnail to fit a smaller screen width.
auto operator[] (f_cnt_t index) -> Peak &
auto operator[] (f_cnt_t index) const -> const Peak &
auto begin ()
auto begin () const
auto end ()
auto end () const
auto rbegin ()
auto rbegin () const
auto rend ()
auto rend () const
auto width () const -> f_cnt_t

Private Attributes

std::vector< Peak > m_peaks

Detailed Description

Encapsulates a fixed-width vector of audio peak min/max values.

A Thumbnail represents the entire sample downsampled to a specific width. It provides a compression method to further downsample or stretch itself into a smaller target.

Constructor & Destructor Documentation

◆ Thumbnail()

lmms::SampleThumbnailCache::Thumbnail::Thumbnail ( f_cnt_t width)
inlineexplicit

Constructs an empty thumbnail of a certain width.

Parameters
widthThe number of Peak elements this thumbnail will contain.

Member Function Documentation

◆ begin() [1/2]

auto lmms::SampleThumbnailCache::Thumbnail::begin ( )
inline
Returns
An iterator to the first peak.

◆ begin() [2/2]

auto lmms::SampleThumbnailCache::Thumbnail::begin ( ) const
inline
Returns
An iterator to the first peak.

◆ compress()

auto lmms::SampleThumbnailCache::Thumbnail::compress ( f_cnt_t outputWidth) const -> Thumbnail

Downsamples this thumbnail to fit a smaller screen width.

◆ end() [1/2]

auto lmms::SampleThumbnailCache::Thumbnail::end ( )
inline
Returns
An iterator to the last peak.

◆ end() [2/2]

auto lmms::SampleThumbnailCache::Thumbnail::end ( ) const
inline
Returns
An iterator to the last peak.

◆ operator[]() [1/2]

auto lmms::SampleThumbnailCache::Thumbnail::operator[] ( f_cnt_t index) -> Peak &
inline
Returns
The peak at the given index.

◆ operator[]() [2/2]

auto lmms::SampleThumbnailCache::Thumbnail::operator[] ( f_cnt_t index) const -> const Peak &
inline
Returns
The peak at the given index.

◆ rbegin() [1/2]

auto lmms::SampleThumbnailCache::Thumbnail::rbegin ( )
inline
Returns
A reversed iterator to the first peak.

◆ rbegin() [2/2]

auto lmms::SampleThumbnailCache::Thumbnail::rbegin ( ) const
inline
Returns
A reversed iterator to the first peak.

◆ rend() [1/2]

auto lmms::SampleThumbnailCache::Thumbnail::rend ( )
inline
Returns
A reversed iterator to the last peak.

◆ rend() [2/2]

auto lmms::SampleThumbnailCache::Thumbnail::rend ( ) const
inline
Returns
A reversed iterator to the last peak.

◆ width()

auto lmms::SampleThumbnailCache::Thumbnail::width ( ) const -> f_cnt_t
inline
Returns
The number of peaks stored inside this thumbnail.

Member Data Documentation

◆ m_peaks

std::vector<Peak> lmms::SampleThumbnailCache::Thumbnail::m_peaks
private

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