audio_function.h

// SPDX-FileCopyrightText: © 2020-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include "structure/arrangement/arranger_object.h"
#include "utils/format.h"
#include "utils/logger.h"
 
namespace zrythm::structure::arrangement
{
 
enum class AudioFunctionType
{
  Invert,
  NormalizePeak,
  NormalizeRMS,
  NormalizeLUFS,
  LinearFadeIn,
  LinearFadeOut,
  NudgeLeft,
  NudgeRight,
  Reverse,
  PitchShift,
  CopyLtoR,

  ExternalProgram,

  Script,

  CustomPlugin,
 
  /* reserved */
  Invalid,
};
 
class AudioFunctionOpts
{
public:
  double amount_ = 0;
};
 
utils::Utf8String
audio_function_get_action_target_for_type (AudioFunctionType type);

utils::Utf8String
audio_function_get_detailed_action_for_type (
  AudioFunctionType        type,
  const utils::Utf8String &base_action);
 
#define audio_function_get_detailed_action_for_type_default(type) \
  audio_function_get_detailed_action_for_type (type, "app.editor-function")
 
utils::Utf8String
audio_function_get_icon_name_for_type (AudioFunctionType type);

void
audio_function_apply (
  ArrangerObject::Uuid                                    region_id,
  std::pair<units::precise_tick_t, units::precise_tick_t> selected_range,
  AudioFunctionType                                       type,
  AudioFunctionOpts                                       opts,
  std::optional<utils::Utf8String>                        uri);
}
 
DEFINE_ENUM_FORMATTER (
  zrythm::structure::arrangement::AudioFunctionType,
  AudioFunctionType,
  QT_TR_NOOP_UTF8 ("Invert"),
  QT_TR_NOOP_UTF8 ("Normalize peak"),
  QT_TR_NOOP_UTF8 ("Normalize RMS"),
  QT_TR_NOOP_UTF8 ("Normalize LUFS"),
  QT_TR_NOOP_UTF8 ("Linear fade in"),
  QT_TR_NOOP_UTF8 ("Linear fade out"),
  QT_TR_NOOP_UTF8 ("Nudge left"),
  QT_TR_NOOP_UTF8 ("Nudge right"),
  QT_TR_NOOP_UTF8 ("Reverse"),
  QT_TR_NOOP_UTF8 ("Pitch shift"),
  QT_TR_NOOP_UTF8 ("Copy L to R"),
  QT_TR_NOOP_UTF8 ("External program"),
  QT_TR_NOOP_UTF8 ("Guile script"),
  QT_TR_NOOP_UTF8 ("Custom plugin"),
  QT_TR_NOOP_UTF8 ("Invalid"));