AudioProperties: added doc to getBitRate method

Clement Champetier · Clement Champetier · commit 7980a3065144 · 2016-06-20T16:31:53.000+02:00
diff --git a/src/AvTranscoder/properties/AudioProperties.cpp b/src/AvTranscoder/properties/AudioProperties.cpp
@@ -128,7 +128,7 @@ size_t AudioProperties::getBitRate() const
         return _codecContext->bit_rate;
 
     // else get computed bit rate from our computation (warning: way to compute bit rate of PCM audio data)
-    int bitsPerSample = av_get_bits_per_sample(_codecContext->codec_id); // 0 if unknown for the given codec
+    const int bitsPerSample = av_get_bits_per_sample(_codecContext->codec_id); // 0 if unknown for the given codec
     return _codecContext->sample_rate * _codecContext->channels * bitsPerSample;
 }
 
diff --git a/src/AvTranscoder/properties/AudioProperties.hpp b/src/AvTranscoder/properties/AudioProperties.hpp
@@ -21,7 +21,7 @@ class AvExport AudioProperties : public StreamProperties
 
     size_t getSampleRate() const;
     size_t getNbChannels() const;
-    size_t getBitRate() const; ///< 0 if unknown
+    size_t getBitRate() const; ///< in bits/s, 0 if unknown
     size_t getNbSamples() const;
 
     size_t getTicksPerFrame() const;

Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ size_t AudioProperties::getBitRate() const`
`128`	`128`	`return _codecContext->bit_rate;`
`129`	`129`
`130`	`130`	`// else get computed bit rate from our computation (warning: way to compute bit rate of PCM audio data)`
`131`		`- int bitsPerSample = av_get_bits_per_sample(_codecContext->codec_id); // 0 if unknown for the given codec`
	`131`	`+ const int bitsPerSample = av_get_bits_per_sample(_codecContext->codec_id); // 0 if unknown for the given codec`
`132`	`132`	`return _codecContext->sample_rate * _codecContext->channels * bitsPerSample;`
`133`	`133`	`}`
`134`	`134`