Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
Loading...
Searching...
No Matches
roc::pipeline Namespace Reference

Sender and receiver processing pipelines. More...

Classes

struct  ConverterConfig
 Converter parameters. More...
 
class  ConverterSink
 Converter sink pipeline. More...
 
class  ConverterSource
 Converter source pipeline. More...
 
class  IPipelineTaskCompleter
 Pipeline task completion handler. More...
 
class  IPipelineTaskScheduler
 Pipeline task scheduler interface. PipelineLoop uses this interface to schedule asynchronous work. Method calls may come from different threads, but are serialized. More...
 
class  PipelineLoop
 Base class for task-based pipelines. More...
 
class  PipelineTask
 Base class for pipeline tasks. More...
 
struct  ReceiverCommonConfig
 Receiver common parameters. More...
 
struct  ReceiverConfig
 Receiver parameters. More...
 
class  ReceiverEndpoint
 Receiver endpoint sub-pipeline. More...
 
class  ReceiverLoop
 Receiver pipeline loop. More...
 
class  ReceiverSession
 Receiver session sub-pipeline. More...
 
struct  ReceiverSessionConfig
 Receiver session parameters. More...
 
class  ReceiverSessionGroup
 Receiver session group. More...
 
class  ReceiverSlot
 Receiver slot. More...
 
class  ReceiverSource
 Receiver source pipeline. More...
 
class  ReceiverState
 Receiver pipeline state. Thread-safe. More...
 
struct  SenderConfig
 Sender parameters. More...
 
class  SenderEndpoint
 Sender endpoint sub-pipeline. More...
 
class  SenderLoop
 Sender pipeline loop. More...
 
class  SenderSession
 Sender session sub-pipeline. More...
 
class  SenderSink
 Sender sink pipeline. More...
 
class  SenderSlot
 Sender slot. More...
 
struct  TaskConfig
 Task processing parameters. More...
 

Functions

bool validate_endpoint (address::Interface iface, address::Protocol proto)
 Validate endpoint type and protocol.
 
bool validate_endpoint_and_pipeline_consistency (packet::FecScheme pipeline_fec_scheme, address::Interface iface, address::Protocol proto)
 Validate consistency of the endpoint and the pipeline FEC scheme.
 
bool validate_endpoint_pair_consistency (address::Protocol source_proto, address::Protocol repair_proto)
 Validate consistency of the two endpoints.
 

Variables

const size_t DefaultSampleRate = 44100
 Default sample rate, number of samples per second.
 
const packet::channel_mask_t DefaultChannelMask = 0x3
 Default channel mask.
 
const core::nanoseconds_t DefaultPacketLength = 7 * core::Millisecond
 Default packet length.
 
const core::nanoseconds_t DefaultLatency = 200 * core::Millisecond
 Default latency.
 
const core::nanoseconds_t DefaultInternalFrameLength = 7 * core::Millisecond
 Default internal frame length.
 
const int DefaultMinLatencyFactor = -1
 Default minum latency relative to target latency.
 
const int DefaultMaxLatencyFactor = 2
 Default maximum latency relative to target latency.
 

Detailed Description

Sender and receiver processing pipelines.

Function Documentation

◆ validate_endpoint()

bool roc::pipeline::validate_endpoint ( address::Interface  iface,
address::Protocol  proto 
)

Validate endpoint type and protocol.

◆ validate_endpoint_and_pipeline_consistency()

bool roc::pipeline::validate_endpoint_and_pipeline_consistency ( packet::FecScheme  pipeline_fec_scheme,
address::Interface  iface,
address::Protocol  proto 
)

Validate consistency of the endpoint and the pipeline FEC scheme.

◆ validate_endpoint_pair_consistency()

bool roc::pipeline::validate_endpoint_pair_consistency ( address::Protocol  source_proto,
address::Protocol  repair_proto 
)

Validate consistency of the two endpoints.

Variable Documentation

◆ DefaultChannelMask

const packet::channel_mask_t roc::pipeline::DefaultChannelMask = 0x3

Default channel mask.

Definition at line 39 of file config.h.

◆ DefaultInternalFrameLength

const core::nanoseconds_t roc::pipeline::DefaultInternalFrameLength = 7 * core::Millisecond

Default internal frame length.

Definition at line 48 of file config.h.

◆ DefaultLatency

const core::nanoseconds_t roc::pipeline::DefaultLatency = 200 * core::Millisecond

Default latency.

Definition at line 45 of file config.h.

◆ DefaultMaxLatencyFactor

const int roc::pipeline::DefaultMaxLatencyFactor = 2

Default maximum latency relative to target latency.

Definition at line 54 of file config.h.

◆ DefaultMinLatencyFactor

const int roc::pipeline::DefaultMinLatencyFactor = -1

Default minum latency relative to target latency.

Definition at line 51 of file config.h.

◆ DefaultPacketLength

const core::nanoseconds_t roc::pipeline::DefaultPacketLength = 7 * core::Millisecond

Default packet length.

Definition at line 42 of file config.h.

◆ DefaultSampleRate

const size_t roc::pipeline::DefaultSampleRate = 44100

Default sample rate, number of samples per second.

Definition at line 36 of file config.h.