zep::audio::PcmBufferPoolInterface Class Reference

PCM buffer pool interface. More...

#include <PcmBufferPoolInterface.hpp>

Collaboration diagram for zep::audio::PcmBufferPoolInterface:

Public Member Functions
virtual std::size_t	GetSamplesPerBuffer () const noexcept=0
	Get the number of samples per buffer.
virtual std::size_t virtual GetSamplesPerBuffer() virtual std void	FinalizeWriter (PcmBufferWriter &writer, std::size_t written_samples,. TimestampInterface::Rep head_timestamp) noexcept=0
	Get the number of buffers.
virtual void	FinalizeReader (PcmBufferReader &reader) noexcept=0
	Finalize the Reader.
virtual std::size_t	GetSamplesPerBuffer () const noexcept=0
	バッファあたりのサンプル数を取得する。
virtual std::size_t	GetNumOfBuffers () const noexcept=0
	バッファの個数を取得する。
virtual void	FinalizeWriter (PcmBufferWriter &writer, std::size_t written_samples, TimestampInterface::Rep head_timestamp) noexcept=0
	Writerのファイナライズ処理を行う。
virtual void	FinalizeReader (PcmBufferReader &reader) noexcept=0
	Readerのファイナライズ処理を行う。
virtual PcmBufferWriter	GetWriter (bool wait) noexcept=0
	Extract one write buffer (free buffer).
virtual PcmBufferWriter	GetWriter (bool wait) noexcept=0
virtual PcmBufferWriter	GetWriter (bool wait) noexcept=0
	書き込みバッファ(空きのあるバッファ)を1つ取り出す。
virtual void	AbortGetWriter () noexcept=0
virtual void	AbortGetWriter () noexcept=0
	GetWriter(true)で待機中のスレッドに対し、待機を中断させる。
virtual PcmBufferReader	GetReader (bool wait) noexcept=0
	Extract one read buffer (buffer with valid data).
virtual PcmBufferReader	GetReader (bool wait) noexcept=0
	読み込みバッファ(有効データのあるバッファ)を1つ取り出す。
virtual void	AbortGetReader () noexcept=0
	GetReader(true) aborts the wait for a thread that is waiting on GetReader(true).
virtual void	AbortGetReader () noexcept=0
	GetReader(true)で待機中のスレッドに対し、待機を中断させる。

Detailed Description

PCM buffer pool interface.

PCMバッファプールのインターフェース

Member Function Documentation

AbortGetWriter()

virtual void zep::audio::PcmBufferPoolWriterInterface::AbortGetWriter ( )

pure virtualnoexceptinherited

virtual PcmBufferWriter GetWriter(bool wait) noexcept = 0; /** virtual PcmBufferWriter GetWriter(bool getWriter(true))

FinalizeReader() [1/2]

virtual void zep::audio::PcmBufferPoolInterface::FinalizeReader ( PcmBufferReader &  reader )

pure virtualnoexcept

Finalize the Reader.

Note

This function is called from inside PcmBufferReader::Finalize().

Parameters

reader

Target reader

FinalizeReader() [2/2]

virtual void zep::audio::PcmBufferPoolInterface::FinalizeReader ( PcmBufferReader &  reader )

pure virtualnoexcept

Readerのファイナライズ処理を行う。

Note

この関数はPcmBufferReader::Finalize()の内部から呼び出される。

Parameters

reader

対象のreader

FinalizeWriter() [1/2]

virtual void zep::audio::PcmBufferPoolInterface::FinalizeWriter ( PcmBufferWriter &  writer, std::size_t  written_samples, TimestampInterface::Rep  head_timestamp  )

pure virtualnoexcept

Writerのファイナライズ処理を行う。

Note

この関数はPcmBufferWriter::Finalize()の内部から呼び出される。

Parameters

writer	対象のwriter
written_samples	書き込まれた有効サンプル数
head_timestamp	先頭のタイムスタンプ

FinalizeWriter() [2/2]

virtual std::size_t virtual GetSamplesPerBuffer() virtual std void zep::audio::PcmBufferPoolInterface::FinalizeWriter ( PcmBufferWriter &  writer, std::size_t  written_samples, . TimestampInterface::Rep  head_timestamp  )

pure virtualnoexcept

Get the number of buffers.

Finalize the Writer.

Note

This function is called from inside PcmBufferWriter::Finalize().

Parameters

writer	Target writer
written_samples	Number of valid samples written
head_timestamp	Timestamp at the beginning

GetReader() [1/2]

virtual PcmBufferReader zep::audio::PcmBufferPoolReaderInterface::GetReader ( bool  wait )

pure virtualnoexceptinherited

Extract one read buffer (buffer with valid data).

Parameters

wait	True when waiting for no buffer.

Attention

This function is not thread-safe. It must be called from a single thread.

Note

Invalid if there is no read buffer, or if there is another

Returns an invalid Reader if there is no read buffer or if there is another Reader that has not been Finalized.

GetReader() [2/2]

virtual PcmBufferReader zep::audio::PcmBufferPoolReaderInterface::GetReader ( bool  wait )

pure virtualnoexceptinherited

読み込みバッファ(有効データのあるバッファ)を1つ取り出す。

Parameters

wait	バッファが無い場合に待機するときtrue

Attention

この関数はスレッドセーフでは無い。単一スレッドから呼び出すこと。

Note

読み込みバッファが無い場合、またはFinalizeしていない他の Readerが存在する場合、無効なReaderを返す。

GetWriter() [1/2]

virtual PcmBufferWriter zep::audio::PcmBufferPoolWriterInterface::GetWriter ( bool  wait )

pure virtualnoexceptinherited

Extract one write buffer (free buffer).

Parameters

wait	True when waiting for no buffer.

Attention

This function is not thread-safe. Call this function from a single thread.

Note

If there is no write buffer, or if another @write Returns an invalid Writer if there is no write buffer or if there is another Writer that has not been Finalized.

GetWriter() [2/2]

virtual PcmBufferWriter zep::audio::PcmBufferPoolWriterInterface::GetWriter ( bool  wait )

pure virtualnoexceptinherited

書き込みバッファ(空きのあるバッファ)を1つ取り出す。

Parameters

wait	バッファが無い場合に待機するときtrue

Attention

この関数はスレッドセーフでは無い。単一スレッドから呼び出すこと。

Note

書き込みバッファが無い場合、またはFinalizeしていない他の Writerが存在する場合、無効なWriterを返す。

---

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

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