oak-editor/app/codec/encoder.h

/***

  Olive - Non-Linear Video Editor
  Copyright (C) 2021 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/>.

***/

#ifndef ENCODER_H
#define ENCODER_H

#include <memory>
#include <QRegularExpression>
#include <QString>
#include <QXmlStreamWriter>

#include "codec/exportcodec.h"
#include "codec/exportformat.h"
#include "codec/frame.h"
#include "codec/samplebuffer.h"
#include "common/timerange.h"
#include "node/block/subtitle/subtitle.h"
#include "render/audioparams.h"
#include "render/subtitleparams.h"
#include "render/videoparams.h"

namespace olive {

class Encoder;
using EncoderPtr = std::shared_ptr<Encoder>;

class EncodingParams {
public:
  EncodingParams();

  void SetFilename(const QString& filename);

  void EnableVideo(const VideoParams& video_params, const ExportCodec::Codec& vcodec);
  void EnableAudio(const AudioParams& audio_params, const ExportCodec::Codec &acodec);
  void EnableSubtitles(const SubtitleParams::Encoding &encoding, const ExportCodec::Codec &scodec);

  void set_video_option(const QString& key, const QString& value);
  void set_video_bit_rate(const int64_t& rate);
  void set_video_min_bit_rate(const int64_t& rate);
  void set_video_max_bit_rate(const int64_t& rate);
  void set_video_buffer_size(const int64_t& sz);
  void set_video_threads(const int& threads);
  void set_video_pix_fmt(const QString& s);
  void set_video_is_image_sequence(bool s)
  {
    video_is_image_sequence_ = s;
  }

  const QString& filename() const;

  bool video_enabled() const;
  const ExportCodec::Codec& video_codec() const;
  const VideoParams& video_params() const;
  const QHash<QString, QString>& video_opts() const;
  const int64_t& video_bit_rate() const;
  const int64_t& video_min_bit_rate() const;
  const int64_t& video_max_bit_rate() const;
  const int64_t& video_buffer_size() const;
  const int& video_threads() const;
  const QString& video_pix_fmt() const;
  bool video_is_image_sequence() const
  {
    return video_is_image_sequence_;
  }

  bool audio_enabled() const;
  const ExportCodec::Codec &audio_codec() const;
  const AudioParams& audio_params() const;

  const int64_t& audio_bit_rate() const
  {
    return audio_bit_rate_;
  }

  void set_audio_bit_rate(const int64_t& b)
  {
    audio_bit_rate_ = b;
  }

  bool subtitles_enabled() const;
  SubtitleParams::Encoding subtitles_encoding() const;
  ExportCodec::Codec subtitles_codec() const;

  const rational& GetExportLength() const;
  void SetExportLength(const rational& GetExportLength);

  virtual void Save(QXmlStreamWriter* writer) const;

private:
  QString filename_;

  bool video_enabled_;
  ExportCodec::Codec video_codec_;
  VideoParams video_params_;
  QHash<QString, QString> video_opts_;
  int64_t video_bit_rate_;
  int64_t video_min_bit_rate_;
  int64_t video_max_bit_rate_;
  int64_t video_buffer_size_;
  int video_threads_;
  QString video_pix_fmt_;
  bool video_is_image_sequence_;

  bool audio_enabled_;
  ExportCodec::Codec audio_codec_;
  AudioParams audio_params_;
  int64_t audio_bit_rate_;

  bool subtitles_enabled_;
  ExportCodec::Codec subtitles_codec_;
  SubtitleParams::Encoding subtitles_encoding_;

  rational export_length_;

};

class Encoder : public QObject
{
  Q_OBJECT
public:
  Encoder(const EncodingParams& params);

  enum Type {
    kEncoderTypeNone = -1,
    kEncoderTypeFFmpeg,
    kEncoderTypeOIIO
  };

  /**
   * @brief Create a Encoder instance using a Encoder ID
   *
   * @return
   *
   * A Encoder instance or nullptr if a Decoder with this ID does not exist
   */
  static Encoder *CreateFromID(Type id, const EncodingParams &params);

  static Type GetTypeFromFormat(ExportFormat::Format f);

  static Encoder *CreateFromFormat(ExportFormat::Format f, const EncodingParams &params);

  virtual QStringList GetPixelFormatsForCodec(ExportCodec::Codec c) const;

  const EncodingParams& params() const;

  virtual VideoParams::Format GetDesiredPixelFormat() const
  {
    return VideoParams::kFormatInvalid;
  }

  const QString& GetError() const
  {
    return error_;
  }

  QString GetFilenameForFrame(const rational& frame);

  static int GetImageSequencePlaceholderDigitCount(const QString& filename);

  static bool FilenameContainsDigitPlaceholder(const QString &filename);
  static QString FilenameRemoveDigitPlaceholder(QString filename);

  static const QRegularExpression kImageSequenceContainsDigits;
  static const QRegularExpression kImageSequenceRemoveDigits;

public slots:
  virtual bool Open() = 0;

  virtual bool WriteFrame(olive::FramePtr frame, olive::rational time) = 0;
  virtual bool WriteAudio(olive::SampleBufferPtr audio) = 0;
  virtual bool WriteSubtitle(const SubtitleBlock *sub_block) = 0;

  virtual void Close() = 0;

protected:
  void SetError(const QString& err)
  {
    error_ = err;
  }

private:
  EncodingParams params_;

  QString error_;

};

}

#endif // ENCODER_H