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 <boost/signals2.hpp>
  29
  30
  31 class Film;
  32 class Encoder;
  33 class Player;
  34 class Job;
  35 class PlayerVideo;
  36 class AudioBuffers;
  37
  38
  39 /** @class Encoder
  40  *  @brief Parent class for something that can encode a film into some format
  41  */
  42 class Encoder
  43 {
  44 public:
  45         Encoder (std::shared_ptr<const Film> film, std::weak_ptr<Job> job);
  46         virtual ~Encoder () {}
  47
  48         Encoder (Encoder const&) = delete;
  49         Encoder& operator= (Encoder const&) = delete;
  50
  51         virtual void go () = 0;
  52
  53         /** @return the current frame rate over the last short while */
  54         virtual boost::optional<float> current_rate () const {
  55                 return {};
  56         }
  57
  58         /** @return the number of frames that are done */
  59         virtual Frame frames_done () const = 0;
  60         virtual bool finishing () const = 0;
  61
  62 protected:
  63         std::shared_ptr<const Film> _film;
  64         std::weak_ptr<Job> _job;
  65         Player _player;
  66 };
  67
  68
  69 #endif