diff options
| author | Josh Coalson <jcoalson@users.sourceforce.net> | 2006-10-06 05:51:59 +0000 |
|---|---|---|
| committer | Josh Coalson <jcoalson@users.sourceforce.net> | 2006-10-06 05:51:59 +0000 |
| commit | 1dfcea1340dd26639c9094523c46aee530d39c90 (patch) | |
| tree | 94daf091fbd8a309652b0a88e7e200539610b796 /include/FLAC | |
| parent | b51392b654e35ef6417e0497b8efb162c8f54c6d (diff) | |
| download | flac-1dfcea1340dd26639c9094523c46aee530d39c90.tar.gz | |
multichannel assignments in format and documentation
Diffstat (limited to 'include/FLAC')
| -rw-r--r-- | include/FLAC/stream_decoder.h | 6 | ||||
| -rw-r--r-- | include/FLAC/stream_encoder.h | 8 |
2 files changed, 11 insertions, 3 deletions
diff --git a/include/FLAC/stream_decoder.h b/include/FLAC/stream_decoder.h index 6762a69c..ce2b927d 100644 --- a/include/FLAC/stream_decoder.h +++ b/include/FLAC/stream_decoder.h @@ -574,9 +574,9 @@ typedef FLAC__bool (*FLAC__StreamDecoderEofCallback)(const FLAC__StreamDecoder * * \param buffer An array of pointers to decoded channels of data. * Each pointer will point to an array of signed * samples of length \a frame->header.blocksize. - * Currently, the channel order has no meaning - * except for stereo streams; in this case channel - * 0 is left and 1 is right. + * Channels will be ordered according to the FLAC + * specification; see the documentation for the + * <A HREF="../format.html#frame_header">frame header</A>. * \param client_data The callee's client data set through * FLAC__stream_decoder_init_*(). * \retval FLAC__StreamDecoderWriteStatus diff --git a/include/FLAC/stream_encoder.h b/include/FLAC/stream_encoder.h index e57a6839..407b6ac8 100644 --- a/include/FLAC/stream_encoder.h +++ b/include/FLAC/stream_encoder.h @@ -1318,6 +1318,10 @@ FLAC_API void FLAC__stream_encoder_finish(FLAC__StreamEncoder *encoder); * representing one channel. The samples need not be block-aligned, * but each channel should have the same number of samples. * + * For applications where channel order is important, channels must + * follow the order as described in the + * <A HREF="../format.html#frame_header">frame header</A>. + * * \param encoder An initialized encoder instance in the OK state. * \param buffer An array of pointers to each channel's signal. * \param samples The number of samples in one channel. @@ -1339,6 +1343,10 @@ FLAC_API FLAC__bool FLAC__stream_encoder_process(FLAC__StreamEncoder *encoder, c * sample-aligned, i.e. the first value should be channel0_sample0 * and the last value channelN_sampleM. * + * For applications where channel order is important, channels must + * follow the order as described in the + * <A HREF="../format.html#frame_header">frame header</A>. + * * \param encoder An initialized encoder instance in the OK state. * \param buffer An array of channel-interleaved data (see above). * \param samples The number of samples in one channel, the same as for |