Skip to content

Commit

Permalink
Update documentation of LoudnessCalculatorFactoryUserProvidedLoudness.
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 628476866
  • Loading branch information
jwcullen committed Apr 30, 2024
1 parent b127705 commit 13cab0d
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion iamf/cli/loudness_calculator_factory.h
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,20 @@ class LoudnessCalculatorFactoryBase {

// TODO(b/302273947): Use this class to measure loudness when finalizing mix
// presentations.
/*\!brief Factory which always provides a fallback loudness calculator. */
/*\!brief Factory which always provides a fallback loudness calculator.
*
* This factory produces underlying loudness calculators which entirely ignore
* all input samples. Those calculators are useful if the user does not wish to
* provide samples to the calculator, or knows the samples they provide are
* inaccurate or not valid for some reason.
*
* This factory is intended to be used when the user does not care about
* "accurate" loudness measurement. One such case is if the user does not
* support rendering to a layout that loudness should be measured on.
*
* This factory is also intended be used as a fallback when other loudness
* factories fail to be created.
*/
class LoudnessCalculatorFactoryUserProvidedLoudness
: public LoudnessCalculatorFactoryBase {
public:
Expand Down

0 comments on commit 13cab0d

Please sign in to comment.