avcodec/avcodec: Document signed/unsignedness of sample formats in relation to bits_per_raw_sample

Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
This commit is contained in:
Michael Niedermayer 2016-04-15 00:42:22 +02:00
parent bcf936eaea
commit f07923253a

View File

@ -3850,8 +3850,8 @@ typedef struct AVCodecParameters {
* sample format has more bits, the least significant bits are additional
* padding bits, which are always 0. Use right shifts to reduce the sample
* to its actual size. For example, audio formats with 24 bit samples will
* have bits_per_raw_sample set to 24, and format set to AV_SAMPLEFMT_S32.
* To get the original sample use "(uint32_t)sample >> 8"."
* have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
* To get the original sample use "(int32_t)sample >> 8"."
*
* For ADPCM this might be 12 or 16 or similar
* Can be 0