src/lib/encoder.h

   1 /*
   2     Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21
  22 #ifndef DCPOMATIC_ENCODER_H
  23 #define DCPOMATIC_ENCODER_H
  24
  25
  26 #include "player.h"
  27 #include "player_text.h"
  28 #include "types.h"
  29 #include <boost/signals2.hpp>
  30
  31
  32 class Film;
  33 class Encoder;
  34 class Player;
  35 class Job;
  36 class PlayerVideo;
  37 class AudioBuffers;
  38
  39
  40 /** @class Encoder
  41  *  @brief Parent class for something that can encode a film into some format
  42  */
  43 class Encoder
  44 {
  45 public:
  46         Encoder (std::shared_ptr<const Film> film, std::weak_ptr<Job> job);
  47         virtual ~Encoder () {}
  48
  49         Encoder (Encoder const&) = delete;
  50         Encoder& operator= (Encoder const&) = delete;
  51
  52         virtual void go () = 0;
  53
  54         /** @return the current frame rate over the last short while */
  55         virtual boost::optional<float> current_rate () const {
  56                 return {};
  57         }
  58
  59         /** @return the number of frames that are done */
  60         virtual Frame frames_done () const = 0;
  61         virtual bool finishing () const = 0;
  62
  63 protected:
  64         std::shared_ptr<const Film> _film;
  65         std::weak_ptr<Job> _job;
  66         Player _player;
  67 };
  68
  69
  70 #endif