Autres/audacity
1
0
Fork 0
mirror of https://github.com/cookiengineer/audacity synced 2025-07-02 17:23:18 +02:00
Code Issues Releases Wiki Activity

Just wanted to add a little doc to explain the parameters...

Browse Source
This commit is contained in:
lllucius 2013-09-18 13:26:20 +00:00
parent 4b23eb342d
commit 3e8e94767c
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/Dither.cpp
View File

@ -227,6 +227,28 @@ void Dither::Reset()
// This only decides if we must dither at all, the dithers
// are all implemented using macros.
//
// "source" can contain interleaved or non-interleaved samples. This is
// controlled via the "stride" argument.
//
// "dest" is always non-interleaved and should be large enough to hold "len"
// samples in the "destFormat".
//
// The "len" argument specifies the number of "sourceFormat" samples to
// process.
//
// In the case of a non-interleaved "source", this will usually equal the
// number of samples in "source".
//
// With an interleaved "source", "source" should contain "stride" times "len"
// samples.
//
// If the "stride" value is 1 then "source" contains non-interleaved samples.
//
// If the "stride" value is greater than 1 then "source" contains interleaved
// samples and they will be processed by skipping every "stride" number of
// samples.
void Dither::Apply(enum DitherType ditherType,
const samplePtr source, sampleFormat sourceFormat,
samplePtr dest, sampleFormat destFormat,