Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
Loading...
Searching...
No Matches
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
 NrocRoot namespace
 NaddressURIs and addresses
 Cendpoint_uri_to_strConvert EndpointUri to string
 CEndpointUriNetwork endpoint URI
 Cio_uri_to_strConvert IoUri to string
 CIoUriAudio file or device URI
 CProtocolAttrsProtocol attributes
 CProtocolMapProtocol attributes map
 Csocket_addr_to_strConvert network address to string
 CSocketAddrSocket address
 NaudioAudio frames and audio processing
 CBuiltinResamplerBuilt-in resampler
 Cchannel_set_to_strFormat ChannelSet to string
 CChannelMapperChannel mapper
 CChannelMapperMatrixChannel mapping matrix
 CChannelMapperReaderChannel mapper reader. Reads frames from nested reader and maps them to another channel mask
 CChannelMapperWriterChannel mapper writer. Reads frames from nested writer and maps them to another channel mask
 CChannelMapRuleDefines multiplication coefficient for a pair of channels
 CChannelMapTableDefines multiplication matrix for two channel masks
 CChannelMaskNameDefines string name for pre-defined channel mask
 CChannelOrderTableDefines ordered list of channels
 CChannelPositionNameDefines string name for channel position
 CChannelSetChannel set. Multi-word bitmask with bits corresponding to enabled channels. Meaning of each channel is defined by ChannelLayout. Order of serialized channels is defined by ChannelOrder
 CDecimationResamplerDecimating resampler
 CDepacketizerDepacketizer
 CFanoutFanout. Duplicates audio stream to multiple output writers
 CFeedbackConfigFeedback monitor configuration
 CFeedbackMonitorFeedback monitor
 CFrameAudio frame
 CFrameFactoryFrame factory
 CFreqEstimatorEvaluates sender's frequency to receivers's frequency ratio
 CFreqEstimatorConfigFreqEstimator tunable parameters
 CIFrameDecoderAudio frame decoder interface
 CIFrameEncoderAudio frame encoder interface
 CIFrameReaderFrame reader interface
 CIFrameWriterFrame writer interface
 CIResamplerAudio writer interface
 CLatencyConfigLatency settings
 CLatencyMetricsLatency-related metrics
 CLatencyMonitorLatency monitor
 CLatencyTunerLatency tuner
 CMixerMixer. Mixes multiple input streams into one output stream
 CNullWriterNull writer
 CPacketizerPacketizer
 CPacketizerMetricsMetrics of packetizer
 CPcmDecoderPCM decoder
 CPcmEncoderPCM encoder
 CPcmMapperPCM format mapper. Convert between PCM formats
 CPcmMapperReaderPcm mapper reader. Reads frames from nested reader and maps them to another pcm mask
 CPcmMapperWriterPcm mapper writer. Reads frames from nested writer and maps them to another pcm mask
 CPcmTraitsPCM format meta-information
 CProfilerProfiler The role of the profiler is to report the average processing speed (# of samples processed per time unit) during the last N seconds. We want to calculate the average processing speed efficiently (with O(1) complexity, without allocations, and as lightweight as possible). The problems with this are that we have variable-sized frames and SMA requires fixed-size chunks. To efficiently perform this calculation a ring buffer is employed. The idea behind the ring buffer is that each chunk of the buffer is the average speed of 10ms worth of samples. The ring buffer is initialized with fixed size (N * 1000)ms / (10ms) chunks. Within each chunk a weighted mean is used to calculate the average speed during those 10ms. Each frame will contribute a different number of samples to each chunk, the chunk speed is then weighted based on how many samples are contributed at what frame speed. As the chunks get populated the moving average is calculated. When the buffer is not entirely full the cumulative moving average algorithm is used and once the buffer is full the simple moving average algorithm is used
 CProfilerConfigProfiler Configuration Parameters. Controls profiling interval and duration of each circular buffer chunk
 CProfilingReaderProfiling reader
 CProfilingWriterProfiling writer
 CResamplerConfigResampler config
 CResamplerMapFactory class for IResampler objects, according to the ResamplerBackend input
 CResamplerReaderResampler element for reading pipeline
 CResamplerWriterResampler element for writing pipeline
 Csample_spec_to_strFormat SampleSpec to string
 CSampleSpecSample specification. Describes sample rate and channels
 CSpeexResamplerSpeex resampler
 CWatchdogWatchdog
 CWatchdogConfigWatchdog parameters
 NcoreGeneral-purpose building blocks and platform abstraction layer
 CAlignedStorageFixed-size maximum-aligned storage
 CAlignMaxMaximum aligned data unit
 CAlignOpsAlignment operations
 CArenaAllocationAllocation policy for objects allocated using IArena
 CArrayDynamic array
 CAtomicAtomic integer. Provides sequential consistency. For a fine-grained memory order control, see AtomicOps
 CAtomic< T * >Atomic pointer. Provides sequential consistency. For a fine-grained memory order control, see AtomicOps
 CAtomicOpsAtomic operations. This wrapper exists because on non-C11 compilers we use another implementation
 CBufferFixed-size dynamically-allocated byte buffer
 CCondCondition variable
 CCrashHandlerCrash handler
 CCsvConfigCSV write configuration
 CCsvDumperAsynchronous CSV dumper. Writes entries to CSV file from background thread. Recommended to be used from a single thread
 CCsvEntryCSV entry. Corresponds to one line in output file
 CCustomAllocationAllocation policy for objects with custom deallocation function
 CEndianOpsEndian operations
 Cerrno_to_strConvert errno to string
 CGlobalDestructorAllows to determine if global library destruction was initiated
 CHashmapIntrusive hash table
 CHashmapDataHashmap node internal data
 CHashmapImplIntrusive hash table internal implementation
 CBucketBucket container
 CHashmapNodeBase class for Hashmap element
 CHeapArenaHeap arena implementation
 CIArenaMemory arena interface
 CIPoolMemory pool interface
 CLimitedArenaDecorator around IArena to make it memory limited
 CLimitedPoolDecorator around IPool to make it memory limited
 CListIntrusive doubly-linked list
 CListDataList node internal data
 CListImplIntrusive doubly-linked list implementation class. Handles List infrastructure independent of templated type for List. Ownership handling is left to the main List class
 CListNodeBase class for List element
 CLogBackendLog backend
 CLoggerLogger
 CLogMessageLog message
 CManualAllocationAllocation policy for objects that does not have automatic deallocation
 CMemoryLimiterMemory limiter. This class can be used to keep track of memory being consumed. This is done through the acquire and release methods. The class is used within classes such as LimitedPool, LimitedArena
 CMemoryOpsMemory operations
 CMovStatsRolling window moving average and variance
 CMpscQueueThread-safe lock-free node-based intrusive multi-producer single-consumer queue
 CMpscQueueDataMpscQueue node internal data
 CMpscQueueImplMulti-producer single-consumer queue internal implementation class
 CMpscQueueNodeBase class for MpscQueue element
 CMutexMutex
 CNonCopyableBase class for non-copyable objects
 CNoopArenaImplArena implementation that just fails all allocations. Can be used with containers that have embedded capacity and arena, but we want them to use only embedded capacity
 CNoOwnershipNo ownership
 COptionalOptionally constructed object
 CPoolAllocationAllocation policy for objects allocated using IPool
 CPrinterPrinter
 CRateLimiterRate limiter
 CRefCountedBase class for object with reference counter
 CRefCountedImplImplementation class for reference counter
 CRefCountedOwnershipReference counted object ownership
 CRingQueueQueue on continuous memory buffer
 CScopedLockRAII mutex lock
 CScopedPtrUnique ownrship pointer
 CSemaphoreSemaphore
 CSeqlockSeqlock
 CSeqlockImplSeqlock implementation class
 CSharedPtrShared ownership intrusive pointer
 CSingletonSingleton
 CSlabPoolMemory pool
 CSlabPoolImplMemory pool implementation class
 CSlotHeaderSlot header
 CSliceSlice
 CSpscByteBufferThread-safe lock-free single-producer single-consumer circular buffer of byte chunks
 CSpscRingBufferThread-safe lock-free single-producer single-consumer circular buffer of copyable objects
 CStringBufferString buffer
 CStringBuilderString builder
 CStringListDynamic list of strings
 CTempFileTemporary file
 CThreadBase class for thread objects
 CTickerTicker
 CTimerThread-safe timer
 NctlControl tasks event loop
 CBasicControlEndpointBase class for control endpoints
 CControlInterfaceMapControl interface map
 CControlLoopControl loop thread
 CTasksSubclasses for specific tasks
 CCreateEndpointCreate endpoint on given interface
 CDeleteEndpointDelete endpoint, if it exists
 CBindEndpointBind endpoint on local URI
 CConnectEndpointConnect endpoint on remote URI
 CAttachSinkAttach sink to endpoint at given URI
 CDetachSinkDetach sink from endpoint
 CAttachSourceAttach source to endpoint at given URI
 CDetachSourceDetach source from endpoint
 CPipelineProcessingProcess pending pipeline tasks on control thread
 CControlTaskBase class for control tasks
 CControlTaskExecutorControl task executor
 CControlTaskQueueControl task queue
 CIControlTaskCompleterControl task completion handler
 CIControlTaskExecutorControl task executor interface
 NfecFEC support
 CCodecConfigFEC codec parameters
 CCodecMapFEC codec map
 CComposerFECFRAME packet composer
 CIBlockDecoderFEC block decoder interface
 CIBlockEncoderFEC block encoder interface
 CLDPC_Repair_PayloadIDLDPC-Staircase Repair FEC Payload ID
 CLDPC_Source_PayloadIDLDPC-Staircase Source FEC Payload ID
 COpenfecDecoderDecoder implementation using OpenFEC library
 COpenfecEncoderEncoder implementation using OpenFEC library
 CParserFECFRAME packet parser
 CReaderFEC reader
 CReaderConfigFEC reader parameters
 CRS8M_PayloadIDReed-Solomon Source or Repair Payload ID (for m=8)
 CWriterFEC writer
 CWriterConfigFEC writer parameters
 NnetioNetwork I/O
 CBasicPortBase class for ports
 CICloseHandlerClose handler interface
 CIConnConnection interface
 CIConnAcceptorConnection acceptor interface
 CIConnHandlerConnection event handler interface
 CINetworkTaskCompleterNetwork task completion handler
 CIResolverRequestHandlerResolver request result handler interface
 CITerminateHandlerTermination handler interface
 CNetworkLoopNetwork event loop thread
 CTasksSubclasses for specific tasks
 CAddUdpPortAdd UDP datagram sender/receiver port
 CStartUdpSendStart sending on UDP port
 CStartUdpRecvStart receiving on UDP port
 CAddTcpServerPortAdd TCP server port
 CAddTcpClientPortAdd TCP client port
 CRemovePortRemove port
 CResolveEndpointAddressResolve endpoint address
 CNetworkTaskBase class for network loop tasks
 CResolverHostname resolver
 CResolverRequestResolver request
 CSocketOptsSocket options
 CTcpClientConfigTCP connection parameters
 CTcpConnectionConfigTCP connection parameters
 CTcpConnectionPortTCP connection port
 CTcpServerConfigTCP server parameters
 CTcpServerPortTCP server
 CUdpConfigUDP port parameters
 CUdpPortUDP sender/receiver port
 NnodeHigh-level sender and receiver nodes
 CContextNode context
 CContextConfigNode context config
 CNodeBase class for nodes
 CReceiverReceiver node
 CReceiverDecoderReceiver decoder node
 CSenderSender node
 CSenderEncoderSender encoder node
 NpacketNetwork packets and packet processing
 CConcurrentQueueConcurrent blocking packet queue
 CDelayedReaderDelayed reader
 CFECFECFRAME packet
 CIComposerPacket composer interface
 CILinkMeterLink meter interface
 CInterleaverInterleaves packets to transmit them in pseudo random order
 CIParserPacket parser interface
 CIReaderPacket reader interface
 CISequencerPacket sequencer. Fills protocol-specific packet headers to form a continous sequence. For example, RTP sequencer fills packet seqnums and timestamps
 CIWriterPacket writer interface
 CLinkMetricsLink metrics
 CPacketPacket
 Cpacket_flags_to_strFormat packet flags to string
 CPacketFactoryPacket factory
 CQueuePacket queue
 CRouterRoute packets to packet writers
 CRTCPRTCP compound packet
 CRTPRTP packet
 CShipperPrepare a packet for being sent
 CSortedQueueSorted packet queue
 CUDPUDP packet
 NpipelineSender and receiver processing pipelines
 CIPipelineTaskCompleterPipeline task completion handler
 CIPipelineTaskSchedulerPipeline task scheduler interface. PipelineLoop uses this interface to schedule asynchronous work. Method calls may come from different threads, but are serialized
 CPipelineLoopBase class for task-based pipelines
 CStatsTask processing statistics
 CPipelineLoopConfigPipeline loop task processing parameters
 CPipelineTaskBase class for pipeline tasks
 CReceiverCommonConfigParameters common for all receiver sessions
 CReceiverEndpointReceiver endpoint sub-pipeline
 CReceiverLoopReceiver pipeline loop
 CTaskBase task class
 CTasksSubclasses for specific tasks
 CCreateSlotCreate new slot
 CDeleteSlotDelete existing slot
 CQuerySlotQuery slot metrics
 CAddEndpointCreate endpoint on given interface of the slot
 CReceiverParticipantMetricsReceiver-side metrics specific to one participant (remote sender)
 CReceiverSessionReceiver session sub-pipeline
 CReceiverSessionConfigParameters of receiver session
 CReceiverSessionGroupReceiver session group
 CReceiverSessionRouterReceiver session router
 CReceiverSlotReceiver slot
 CReceiverSlotConfigParameters of receiver slot
 CReceiverSlotMetricsReceiver-side metrics of the whole slot
 CReceiverSourceReceiver source pipeline
 CReceiverSourceConfigParameters of receiver session
 CSenderEndpointSender endpoint sub-pipeline
 CSenderLoopSender pipeline loop
 CTaskBase task class
 CTasksSubclasses for specific tasks
 CCreateSlotCreate new slot
 CDeleteSlotDelete existing slot
 CQuerySlotQuery slot metrics
 CAddEndpointCreate endpoint on given interface of the slot
 CSenderParticipantMetricsSender-side metrics specific to one participant (remote receiver)
 CSenderSessionSender session sub-pipeline
 CSenderSinkSender sink pipeline
 CSenderSinkConfigParameters of sender sink and sender session
 CSenderSlotSender slot
 CSenderSlotConfigParameters of sender slot
 CSenderSlotMetricsSender-side metrics of the whole slot
 CStateTrackerPipeline state tracker
 CTranscoderConfigConverter parameters
 CTranscoderSinkTranscoder sink pipeline
 CTranscoderSourceTranscoder source pipeline
 NrtcpRTCP protocol support
 Nheader
 CPacketHeaderRTCP packet header, common for all RTCP packet types
 CNtpTimestamp6464-bit NTP timestamp
 CNtpTimestamp3232-bit NTP absolute time (stored as middle 32 bits of 64-bit timestamp)
 CReceptionReportBlockReception report block
 CReceiverReportPacketReceiver Report RTCP packet (RR)
 CSenderReportPacketSender Report RTCP packet (SR)
 CSdesChunkHeaderSDES chunk header
 CSdesItemHeaderSDES item header
 CSdesPacketSource Description RTCP packet (SDES)
 CByeSourceHeaderBYE source header
 CByeReasonHeaderBYE reason header
 CByePacketGoodbye RTCP packet (BYE)
 CXrPacketRTCP Extended Report Packet
 CXrBlockHeaderXR Block Header
 CXrRrtrBlockXR Receiver Reference Time Report block
 CXrDlrrSubblockXR DLRR Report sub-block
 CXrDlrrBlockXR DLRR Report block
 CXrMeasurementInfoBlockXR Measurement Info Report Block
 CXrDelayMetricsBlockXR Delay Metrics Block
 CXrQueueMetricsBlockXR Queue Metrics Block
 CBuilderRTCP compound packet builder
 CByeTraverserBYE packet traverer
 CIteratorPacket iterator
 Ccname_to_strGet printable representation of CNAME
 CCommunicatorRTCP communicator
 CComposerRTCP packet composer
 CConfigRTCP config
 CIParticipantRTCP participant
 CLossEstimatorComputes fractions loss ration since last report
 CPacketCounterComputes number of packets in interval
 CParserRTCP packet parser
 CParticipantInfoParticipant info
 CRecvReportReceiver report, for inspection on sender
 CReporterRTCP report processor and generator
 CRttConfigRound-trip time metrics
 CRttEstimatorRound-trip time estimator. Created inside rtcp::Reporter for each RTP stream. Continously computes RTT and clock offset based on LSR/DLSR or LRR/DLRR timestamps
 CRttMetricsRound-trip time metrics
 CSdesChunkParsed SDES chunk
 CSdesItemParsed SDES item
 CSdesTraverserSDES packet traverer
 CIteratorPacket iterator
 CSendReportSender report, for inspection on receiver
 CTraverserRTCP compound packet traverser
 CIteratorPacket iterator
 CXrTraverserXR packet traverser
 CIteratorPacket iterator
 NrtpRTP protocol support
 CComposerRTP packet composer
 CEncodingRTP encoding
 CEncodingMapRTP encoding map. Thread-safe. Returned encodings are immutable and can be safely used from any thread
 CExtentionHeaderRTP extension header
 CFilterRTP filter
 CFilterConfigRTP filter parameters
 CHeaderRTP header
 CIdentityRTP participant identity
 CLinkMeterRTP link meter
 CParserRTP packet parser
 CSequencerRTP packet sequencer
 CTimestampExtractorRemembers a recent pair of capture timestamp and rtp ts
 CTimestampInjectorFills capture timestamps in rtp packets
 NsdpSDP protocol support
 CConnectionDataSDP connection data field
 CMediaDescriptionSDP media description
 CSessionDescriptionSDP session description
 NsndioSound I/O
 CBackendDispatcherBackend dispatcher
 CBackendMapBackend map
 CConfigSink and source config
 CDriverInfoDriver information
 CIBackendBackend interface
 CIDeviceBase interface for sinks and sources
 CISinkSink interface
 CISourceSource interface
 CPulseaudioBackendPulseaudio backend
 CPulseaudioDevicePulseAudio device. Can be either source or sink depending on constructor parameter
 CPumpAudio pump
 CSndfileBackendSndfile backend
 CSndfileSinkSndfile sink
 CSndfileSourceSndfile source
 CSoxBackendSoX backend
 CSoxSinkSoX sink
 CSoxSourceSoX source
 CWavBackendWAV backend
 CWavHeaderWAV header
 CWavHeaderDataWAV header data
 CWavSinkWAV sink
 CWavSourceWAV source
 CFileMapSndfile driver map