Reader implementation of PCM buffer. More...

#include <PcmBufferReader.hpp>

Public Member Functions
	PcmBufferReader () noexcept
	Build a PcmBufferReader object by default without any management object.

	PcmBufferReader (const std::weak_ptr< PcmBufferPoolInterface > &pool_weak,. std::int16_t *pointer, std::size_t readable_samples, std::size_t readable_samples, std::size_t readable_samples TimestampInterface::Rep head_timestamp) noexcept
	Construct a PcmBufferReader object.

	PcmBufferReader (PcmBufferReader &&other) noexcept
	Construct a PcmBufferReader object move.

PcmBufferReader &	operator= (PcmBufferReader &&other) noexcept
	Move assignment of PcmBufferReader object.

	PcmBufferReader () noexcept
	PcmBufferReaderオブジェクトを管理対象無しでデフォルト構築する。

	PcmBufferReader (const std::weak_ptr< PcmBufferPoolInterface > &pool_weak, std::int16_t *pointer, std::size_t readable_samples, TimestampInterface::Rep head_timestamp) noexcept
	PcmBufferReaderオブジェクトを構築する。

	PcmBufferReader (PcmBufferReader &&other) noexcept
	PcmBufferReaderオブジェクトをムーブ構築する。

PcmBufferReader &	operator= (PcmBufferReader &&other) noexcept
	PcmBufferReaderオブジェクトをムーブ代入する。

	PcmBufferReader (const PcmBufferReader &)=delete

PcmBufferReader &	operator= (const PcmBufferReader &)=delete

	~PcmBufferReader () noexcept
	PcmBufferReaderオブジェクトを破棄する。

bool	IsValid () const noexcept
	有効なバッファを保持しているか否かを取得する。

	operator bool () const noexcept
	有効なバッファを保持しているか否かを取得する。

const std::int16_t *	GetPointer () const noexcept
	管理対象バッファの先頭ポインタを取得する。

std::size_t	GetReadableSamples () const noexcept
	有効なサンプル数を取得する。

TimestampInterface::Rep	GetHeadTimestamp () const noexcept
	先頭のタイムスタンプを取得する。

void	Finalize () noexcept
	バッファからのデータ読み込み完了を通知する。

Detailed Description

Reader implementation of PCM buffer.

PCMバッファのReader実装

Note: There is no concept of the number of channels in this buffer. Therefore, the capacity and the number of effective elements are the number of samples for the total of all channels.; 本バッファにはチャネル数という概念が存在しない。よって容量や有効要素数は全チャンネル合計分のサンプル数になる。

Constructor & Destructor Documentation

◆ PcmBufferReader() [1/6]

zep::audio::PcmBufferReader::PcmBufferReader ( )

inlinenoexcept

Build a PcmBufferReader object by default without any management object.

class PcmBufferReader /**

Postcondition: IsValid() == false

◆ PcmBufferReader() [2/6]

zep::audio::PcmBufferReader::PcmBufferReader	(	const std::weak_ptr< PcmBufferPoolInterface > &	pool_weak,
		. std::int16_t *	pointer,
		std::size_t	readable_samples,
		std::size_t	readable_samples,
		std::size_t readable_samples TimestampInterface::Rep	head_timestamp
	)

inlinenoexcept

Construct a PcmBufferReader object.

Parameters

pool_weak	Pool owned by
pointer	managed buffer
readable_samples	Number of samples that can be read
head_timestamp	timestamp value at the beginning

◆ PcmBufferReader() [3/6]

zep::audio::PcmBufferReader::PcmBufferReader ( PcmBufferReader && other )

inlinenoexcept

Construct a PcmBufferReader object move.

Parameters

other Move source.

◆ PcmBufferReader() [4/6]

zep::audio::PcmBufferReader::PcmBufferReader ( )

inlinenoexcept

PcmBufferReaderオブジェクトを管理対象無しでデフォルト構築する。

Postcondition: IsValid() == false

◆ PcmBufferReader() [5/6]

zep::audio::PcmBufferReader::PcmBufferReader	(	const std::weak_ptr< PcmBufferPoolInterface > &	pool_weak,
		std::int16_t *	pointer,
		std::size_t	readable_samples,
		TimestampInterface::Rep	head_timestamp
	)

inlinenoexcept

PcmBufferReaderオブジェクトを構築する。

Parameters

pool_weak	所有しているプール
pointer	管理対象バッファ
readable_samples	読み込み可能なサンプル数
head_timestamp	先頭のタイムスタンプ値

◆ PcmBufferReader() [6/6]

zep::audio::PcmBufferReader::PcmBufferReader ( PcmBufferReader && other )

inlinenoexcept

PcmBufferReaderオブジェクトをムーブ構築する。

Parameters

other ムーブ元

Member Function Documentation

◆ Finalize()

void zep::audio::PcmBufferReader::Finalize ( )

inlinenoexcept

バッファからのデータ読み込み完了を通知する。

Note: この関数を呼んだ後は、GetPointer()の返すポインタへアクセスしてはならない。

Postcondition: IsValid() == false

◆ GetPointer()

const std::int16_t * zep::audio::PcmBufferReader::GetPointer ( ) const

inlinenoexcept

管理対象バッファの先頭ポインタを取得する。

Return values

nullptr	管理対象バッファが無い
非nullptr	管理対象バッファの先頭ポインタ

◆ GetReadableSamples()

std::size_t zep::audio::PcmBufferReader::GetReadableSamples ( ) const

inlinenoexcept

有効なサンプル数を取得する。

Note: チャネル毎ではなく、全チャネル合計のサンプル数となる。; 単位はサンプル数であり、バイト数ではない。

Return values

0	有効な要素がない(有効なバッファを保持していない場合も含む)

◆ IsValid()

bool zep::audio::PcmBufferReader::IsValid ( ) const

inlinenoexcept

有効なバッファを保持しているか否かを取得する。

Return values

true	有効なバッファを保持している
false	有効なバッファを保持していない

◆ operator bool()

zep::audio::PcmBufferReader::operator bool ( ) const

inlineexplicitnoexcept

有効なバッファを保持しているか否かを取得する。

See also: IsValid()

Return values

true	有効なバッファを保持している
false	有効なバッファを保持していない

◆ operator=() [1/2]

PcmBufferReader & zep::audio::PcmBufferReader::operator= ( PcmBufferReader && other )

inlinenoexcept

Move assignment of PcmBufferReader object.

Parameters

other Move source

◆ operator=() [2/2]

PcmBufferReader & zep::audio::PcmBufferReader::operator= ( PcmBufferReader && other )

inlinenoexcept

PcmBufferReaderオブジェクトをムーブ代入する。

Parameters

other ムーブ元

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

/Users/manabutogawa/Downloads/libzep_doxygen_src.20230515/include/zep-en/audio/PcmBufferReader.hpp
/Users/manabutogawa/Downloads/libzep_doxygen_src.20230515/include/zep/audio/PcmBufferReader.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PcmBufferReader() [1/6]

◆ PcmBufferReader() [2/6]

◆ PcmBufferReader() [3/6]

◆ PcmBufferReader() [4/6]

◆ PcmBufferReader() [5/6]

◆ PcmBufferReader() [6/6]

Member Function Documentation

◆ Finalize()

◆ GetPointer()

◆ GetReadableSamples()

◆ IsValid()

◆ operator bool()

◆ operator=() [1/2]

◆ operator=() [2/2]