oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

pcm/Traits: add API documentation

Browse Source
This commit is contained in:
Max Kellermann 2013-12-01 19:30:52 +01:00
parent e1436063ff
commit 7661ad6653
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/pcm/Traits.hxx
View File

@ -25,16 +25,40 @@
#include <stdint.h> #include <stdint.h>
/**
* This template describes the specified #SampleFormat. This is an
* empty prototype; the specializations contain the real definitions.
* See SampleTraits<uint8_t> for more documentation.
*/
template<SampleFormat F> template<SampleFormat F>
struct SampleTraits {}; struct SampleTraits {};
template<> template<>
struct SampleTraits<SampleFormat::S8> { struct SampleTraits<SampleFormat::S8> {
/**
* The type used for one sample value.
*/
typedef int8_t value_type; typedef int8_t value_type;
/**
* A writable pointer.
*/
typedef value_type *pointer_type; typedef value_type *pointer_type;
/**
* A read-only pointer.
*/
typedef const value_type *const_pointer_type; typedef const value_type *const_pointer_type;
/**
* The size of one sample in bytes.
*/
static constexpr size_t SAMPLE_SIZE = sizeof(value_type); static constexpr size_t SAMPLE_SIZE = sizeof(value_type);
/**
* The integer bit depth of one sample. This attribute may
* not exist if this is not an integer sample format.
*/
static constexpr unsigned BITS = sizeof(value_type) * 8; static constexpr unsigned BITS = sizeof(value_type) * 8;
}; };