diff options
author | Uwe Klotz <uklotz@mixxx.org> | 2020-03-30 21:55:29 +0200 |
---|---|---|
committer | Uwe Klotz <uklotz@mixxx.org> | 2020-03-30 21:55:50 +0200 |
commit | a166aa2ffc5bd9f336c47bf2653da2ad4a4e04d6 (patch) | |
tree | 90823838b0881465dd2d04fe80fd2cc0d4b4d0a8 /src/audio | |
parent | 32ef6c87cf460577f331eff7a8fea9c61fa10225 (diff) |
Improve documentation of basic audio types
Diffstat (limited to 'src/audio')
-rw-r--r-- | src/audio/types.h | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/src/audio/types.h b/src/audio/types.h index 1da4c5a5b7..64b55f260e 100644 --- a/src/audio/types.h +++ b/src/audio/types.h @@ -34,6 +34,7 @@ QDebug operator<<(QDebug dbg, ChannelLayout arg); class ChannelCount { private: + // The default value is invalid and indicates a missing or unknown value. static constexpr SINT kValueDefault = 0; public: @@ -100,6 +101,7 @@ QDebug operator<<(QDebug dbg, SampleLayout arg); class SampleRate { private: + // The default value is invalid and indicates a missing or unknown value. static constexpr SINT kValueDefault = 0; public: @@ -138,10 +140,14 @@ QDebug operator<<(QDebug dbg, SampleRate arg); // The bitrate is measured in kbit/s (kbps) and provides information // about the level of compression for lossily encoded audio streams. -// It depends on the metadata and decoder if a value for the bitrate -// is available, i.e. it might be invalid if it cannot be determined. +// +// The value can only be interpreted in the context of the corresponding +// codec. It is supposed to reflect the average bitrate in case of a +// variable bitrate encoding and serves as a rough estimate of the +// expected quality. class Bitrate { private: + // The default value is invalid and indicates a missing or unknown value. static constexpr SINT kValueDefault = 0; public: |