AudioEditing.h

Go to the documentation of this file.

/*

             *
            ***
           *****
   *********************       Mercenaries Engineering SARL
     *****************              Copyright (C) 2018
       *************
         *********        http://www.mercenaries-engineering.com
        ***********
       ****     ****
      **           **

*/
#pragma once

#include "Waveform.h"

#include <Maquina/UserData.h>
#include <gsl/span>

namespace maquina
{

// An Audio editing
class AudioEditing : public UserData
{
public:
  class Clip
  {
  public:
    Clip(float offset, float in, float out, float volume, float speed_factor, std::shared_ptr<const maquina::Waveform> waveform) :
      _offset(offset), _in(in), _out(out), _volume(volume), _speed_factor(speed_factor), _waveform(std::move(waveform)) {}

    // Starting offset of the audio clip in the final edit in seconds
    float offset() const { return _offset; }

    // Starting offset of the audio clip in the waveform in seconds
    float in() const { return _in; }

    // Ending offset of the audio clip in the waveform in seconds
    float out() const { return _out; }

    // Clip volume
    float volume() const { return _volume; }

    // Clip speed factor
    float speed_factor() const { return _speed_factor; }

    const std::shared_ptr<const maquina::Waveform>& waveform() const { return _waveform; }
  private:
    float _offset, _in, _out, _volume, _speed_factor;
    std::shared_ptr<const maquina::Waveform> _waveform;
  };

  // From UserData
  StringView type_name() const;

  AudioEditing() = default;
  AudioEditing(std::vector<Clip>&& clips) : _clips(std::move(clips)) {}

  const std::vector<Clip>& clips() const { return _clips; }

private:
  std::vector<Clip> _clips;
};

inline StringView AudioEditing::type_name() const
{
  return "AudioEditing";
}

}