oak-editor/app/widget/slider/floatslider.cpp

/***

  Olive - Non-Linear Video Editor
  Copyright (C) 2020 Olive Team

  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

***/

#include "floatslider.h"

#include <cmath>
#include <QAudio>
#include <QDebug>

namespace olive {

#define super DecimalSliderBase

FloatSlider::FloatSlider(QWidget *parent) :
  super(parent),
  display_type_(kNormal)
{
  SetValue(0.0);
}

double FloatSlider::GetValue() const
{
  return GetValueInternal().toDouble();
}

void FloatSlider::SetValue(const double &d)
{
  SetValueInternal(d);
}

void FloatSlider::SetDefaultValue(const double &d)
{
  super::SetDefaultValue(d);
}

void FloatSlider::SetMinimum(const double &d)
{
  SetMinimumInternal(d);
}

void FloatSlider::SetMaximum(const double &d)
{
  SetMaximumInternal(d);
}

void FloatSlider::SetDisplayType(const FloatSlider::DisplayType &type)
{
  display_type_ = type;

  switch (display_type_) {
  case kNormal:
    ClearFormat();
    break;
  case kDecibel:
    SetFormat(tr("%1 dB"));
    break;
  case kPercentage:
    SetFormat(tr("%1%"));
    break;
  }
}

QString FloatSlider::ValueToString(double val, FloatSlider::DisplayType display, int decimal_places, bool autotrim_decimal_places)
{
  switch (display) {
  case kNormal:
    // Do nothing, skip to the return string at the end
    break;
  case kDecibel:
    // Convert to decibels and return dB formatted string

    // Return negative infinity for zero volume
    if (qIsNull(val)) {
      return tr("\xE2\x88\x9E");
    }

    val = LinearToDecibel(val);
    break;
  case kPercentage:
    // Multiply value by 100 for user-friendly percentage
    val *= 100.0;
    break;
  }

  return FloatToString(val, decimal_places, autotrim_decimal_places);
}

QString FloatSlider::ValueToString(const QVariant &v) const
{
  return ValueToString(v.toDouble() + GetOffset().toDouble(), display_type_, GetDecimalPlaces(), GetAutoTrimDecimalPlaces());
}

QVariant FloatSlider::StringToValue(const QString &s, bool *ok) const
{
  switch (display_type_) {
  case kNormal:
    // Do nothing, skip to the return string at the end
    break;
  case kDecibel:
  {
    bool valid;

    // See if we can get a decimal number out of this
    qreal decibels = s.toDouble(&valid);

    if (ok) *ok = valid;

    if (valid) {
      // Convert from decibel scale to linear decimal
      return DecibelToLinear(decibels);
    }

    break;
  }
  case kPercentage:
  {
    bool valid;

    // Try to get double value
    double val = s.toDouble(&valid);

    if (ok) *ok = valid;

    // If we could get it, convert back to a 0.0 - 1.0 value and return
    if (valid) {
      return val * 0.01;
    }

    break;
  }
  }

  // Just try to convert the string to a double
  return s.toDouble(ok) - GetOffset().toDouble();
}

QVariant FloatSlider::AdjustDragDistanceInternal(const QVariant &start, const double &drag) const
{
  switch (display_type_) {
  case kNormal:
    // No change here
    break;
  case kDecibel:
  {
    double current_db = LinearToDecibel(start.toDouble());
    current_db += drag;
    double adjusted_linear = DecibelToLinear(current_db);

    return adjusted_linear;
  }
  case kPercentage:
    return super::AdjustDragDistanceInternal(start, drag * 0.01);
  }

  return super::AdjustDragDistanceInternal(start, drag);
}

void FloatSlider::ValueSignalEvent(const QVariant &value)
{
  emit ValueChanged(value.toDouble());
}

double FloatSlider::LinearToDecibel(double linear)
{
  return double(20.0) * std::log10(linear);
}

double FloatSlider::DecibelToLinear(double decibel)
{
  double to_linear = std::pow(double(10.0), decibel / double(20.0));

  // Minimum threshold that we figure is close enough to 0 that we may as well just return 0
  if (to_linear < 0.000001) {
    return 0;
  } else {
    return to_linear;
  }
}

}