src/lib/encoder.h

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