Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
pcm_format.h File Reference

PCM format. More...

#include "roc_core/stddefs.h"
Include dependency graph for pcm_format.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  roc::audio::PcmTraits
 PCM format meta-information. More...
 

Namespaces

 roc
 Root namespace.
 
 roc::audio
 Audio frames and audio processing.
 

Typedefs

typedef void(* roc::audio::PcmMapFn) (const uint8_t *in_data, size_t &in_bit_off, uint8_t *out_data, size_t &out_bit_off, size_t n_samples)
 PCM mapping function. More...
 

Enumerations

enum  roc::audio::PcmFormat {
  roc::audio::PcmFormat_Invalid , roc::audio::PcmFormat_SInt8 , roc::audio::PcmFormat_SInt8_Be , roc::audio::PcmFormat_SInt8_Le ,
  roc::audio::PcmFormat_UInt8 , roc::audio::PcmFormat_UInt8_Be , roc::audio::PcmFormat_UInt8_Le , roc::audio::PcmFormat_SInt16 ,
  roc::audio::PcmFormat_SInt16_Be , roc::audio::PcmFormat_SInt16_Le , roc::audio::PcmFormat_UInt16 , roc::audio::PcmFormat_UInt16_Be ,
  roc::audio::PcmFormat_UInt16_Le , roc::audio::PcmFormat_SInt18 , roc::audio::PcmFormat_SInt18_Be , roc::audio::PcmFormat_SInt18_Le ,
  roc::audio::PcmFormat_UInt18 , roc::audio::PcmFormat_UInt18_Be , roc::audio::PcmFormat_UInt18_Le , roc::audio::PcmFormat_SInt18_3 ,
  roc::audio::PcmFormat_SInt18_3_Be , roc::audio::PcmFormat_SInt18_3_Le , roc::audio::PcmFormat_UInt18_3 , roc::audio::PcmFormat_UInt18_3_Be ,
  roc::audio::PcmFormat_UInt18_3_Le , roc::audio::PcmFormat_SInt18_4 , roc::audio::PcmFormat_SInt18_4_Be , roc::audio::PcmFormat_SInt18_4_Le ,
  roc::audio::PcmFormat_UInt18_4 , roc::audio::PcmFormat_UInt18_4_Be , roc::audio::PcmFormat_UInt18_4_Le , roc::audio::PcmFormat_SInt20 ,
  roc::audio::PcmFormat_SInt20_Be , roc::audio::PcmFormat_SInt20_Le , roc::audio::PcmFormat_UInt20 , roc::audio::PcmFormat_UInt20_Be ,
  roc::audio::PcmFormat_UInt20_Le , roc::audio::PcmFormat_SInt20_3 , roc::audio::PcmFormat_SInt20_3_Be , roc::audio::PcmFormat_SInt20_3_Le ,
  roc::audio::PcmFormat_UInt20_3 , roc::audio::PcmFormat_UInt20_3_Be , roc::audio::PcmFormat_UInt20_3_Le , roc::audio::PcmFormat_SInt20_4 ,
  roc::audio::PcmFormat_SInt20_4_Be , roc::audio::PcmFormat_SInt20_4_Le , roc::audio::PcmFormat_UInt20_4 , roc::audio::PcmFormat_UInt20_4_Be ,
  roc::audio::PcmFormat_UInt20_4_Le , roc::audio::PcmFormat_SInt24 , roc::audio::PcmFormat_SInt24_Be , roc::audio::PcmFormat_SInt24_Le ,
  roc::audio::PcmFormat_UInt24 , roc::audio::PcmFormat_UInt24_Be , roc::audio::PcmFormat_UInt24_Le , roc::audio::PcmFormat_SInt24_4 ,
  roc::audio::PcmFormat_SInt24_4_Be , roc::audio::PcmFormat_SInt24_4_Le , roc::audio::PcmFormat_UInt24_4 , roc::audio::PcmFormat_UInt24_4_Be ,
  roc::audio::PcmFormat_UInt24_4_Le , roc::audio::PcmFormat_SInt32 , roc::audio::PcmFormat_SInt32_Be , roc::audio::PcmFormat_SInt32_Le ,
  roc::audio::PcmFormat_UInt32 , roc::audio::PcmFormat_UInt32_Be , roc::audio::PcmFormat_UInt32_Le , roc::audio::PcmFormat_SInt64 ,
  roc::audio::PcmFormat_SInt64_Be , roc::audio::PcmFormat_SInt64_Le , roc::audio::PcmFormat_UInt64 , roc::audio::PcmFormat_UInt64_Be ,
  roc::audio::PcmFormat_UInt64_Le , roc::audio::PcmFormat_Float32 , roc::audio::PcmFormat_Float32_Be , roc::audio::PcmFormat_Float32_Le ,
  roc::audio::PcmFormat_Float64 , roc::audio::PcmFormat_Float64_Be , roc::audio::PcmFormat_Float64_Le , roc::audio::PcmFormat_Max
}
 PCM format. Defines PCM sample coding and endian. More...
 

Functions

PcmMapFn roc::audio::pcm_format_mapfn (PcmFormat in_format, PcmFormat out_format)
 Get mapping function for given PCM format pair. More...
 
PcmTraits roc::audio::pcm_format_traits (PcmFormat format)
 Get format traits for given PCM format. More...
 
const char * roc::audio::pcm_format_to_str (PcmFormat format)
 Get string name of PCM format. More...
 
PcmFormat roc::audio::pcm_format_from_str (const char *str)
 Get PCM format from string name. More...
 

Detailed Description

PCM format.

Definition in file pcm_format.h.