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_caption.h"
  26 #include <boost/weak_ptr.hpp>
  27 #include <boost/signals2.hpp>
  28
  29 class Film;
  30 class Encoder;
  31 class Player;
  32 class Job;
  33 class PlayerVideo;
  34 class AudioBuffers;
  35
  36 /** @class Encoder */
  37 class Encoder : public boost::noncopyable
  38 {
  39 public:
  40         Encoder (boost::shared_ptr<const Film> film, boost::weak_ptr<Job> job);
  41         virtual ~Encoder () {}
  42
  43         virtual void go () = 0;
  44
  45         /** @return the current frame rate over the last short while */
  46         virtual float current_rate () const = 0;
  47         /** @return the number of frames that are done */
  48         virtual Frame frames_done () const = 0;
  49         virtual bool finishing () const = 0;
  50
  51 protected:
  52         boost::shared_ptr<const Film> _film;
  53         boost::weak_ptr<Job> _job;
  54         boost::shared_ptr<Player> _player;
  55 };
  56
  57 #endif