src/lib/video_encoder.h

   1 /*
   2     Copyright (C) 2024 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_VIDEO_ENCODER_H
  23 #define DCPOMATIC_VIDEO_ENCODER_H
  24
  25
  26 #include "dcpomatic_time.h"
  27 #include "event_history.h"
  28 #include "film.h"
  29 #include "player_video.h"
  30
  31
  32 class Writer;
  33
  34
  35 class VideoEncoder
  36 {
  37 public:
  38         VideoEncoder(std::shared_ptr<const Film> film, Writer& writer);
  39         virtual ~VideoEncoder() {}
  40
  41         VideoEncoder(VideoEncoder const&) = delete;
  42         VideoEncoder& operator=(VideoEncoder const&) = delete;
  43
  44         /** Called to indicate that a processing run is about to begin */
  45         virtual void begin() {}
  46
  47         /** Called to pass a bit of video to be encoded as the next DCP frame */
  48         virtual void encode(std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
  49
  50         virtual void pause() = 0;
  51         virtual void resume() = 0;
  52
  53         /** Called when a processing run has finished */
  54         virtual void end() = 0;
  55
  56         int video_frames_enqueued() const;
  57         boost::optional<float> current_encoding_rate() const;
  58
  59 protected:
  60         /** Film that we are encoding */
  61         std::shared_ptr<const Film> _film;
  62         Writer& _writer;
  63         EventHistory _history;
  64         boost::optional<dcpomatic::DCPTime> _last_player_video_time;
  65 };
  66
  67
  68 #endif
  69