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

pcm/Dither: add API documentation

Browse Source
This commit is contained in:
Max Kellermann 2013-12-24 23:45:38 +01:00
parent 9ac18c39a1
commit 431c80f4f0
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/pcm/PcmDither.hxx
View File

@ -39,9 +39,27 @@ public:
const int32_t *src_end); const int32_t *src_end);
private: private:
/**
* Shift the given sample by #scale_bits to the right, and
* apply dithering.
*
* @param T the input sample type
* @param MIN the minimum input sample value
* @param MAX the maximum input sample value
* @param scale_bits the number of bits to be discarded
* @param sample the input sample value
*/
template<typename T, T MIN, T MAX, unsigned scale_bits> template<typename T, T MIN, T MAX, unsigned scale_bits>
T Dither(T sample); T Dither(T sample);
/**
* Convert the given sample from one sample format to another,
* discarding bits.
*
* @param ST the input #SampleTraits class
* @param ST the output #SampleTraits class
* @param sample the input sample value
*/
template<typename ST, typename DT> template<typename ST, typename DT>
typename DT::value_type DitherConvert(typename ST::value_type sample); typename DT::value_type DitherConvert(typename ST::value_type sample);