flux_scalar.h

Go to the documentation of this file.

#pragma once
 
// Brightness x power as one linear amplitude stage (P6 C4, #4040).
//
// The pipeline has exactly one place where amplitude changes. Brightness and
// the power limiter both land here and compose multiplicatively; nothing
// downstream rescales channels.
 
#include "fl/stl/int.h"
#include "fl/stl/noexcept.h"
#include "fl/stl/span.h"
 
namespace fl {

class FluxScalar {
  public:
    static FluxScalar unity() FL_NO_EXCEPT;

    static FluxScalar fromBrightness(u8 brightness) FL_NO_EXCEPT;

    static FluxScalar fromRawQ16(i32 raw) FL_NO_EXCEPT;

    FluxScalar composedWith(FluxScalar other) const FL_NO_EXCEPT;
 
    i32 rawQ16() const FL_NO_EXCEPT;
 
  private:
    explicit FluxScalar(i32 raw) FL_NO_EXCEPT;
    i32 mRawQ16;
};

void applyFluxScalar(FluxScalar scalar, span<i32> drives) FL_NO_EXCEPT;
 
}  // namespace fl