src/lib/transcode_job.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_TRANSCODE_JOB_H
  23 #define DCPOMATIC_TRANSCODE_JOB_H
  24
  25
  26 /** @file src/transcode_job.h
  27  *  @brief A job which transcodes from one format to another.
  28  */
  29
  30
  31 #include "job.h"
  32
  33
  34 /* Defined by Windows */
  35 #undef IGNORE
  36
  37
  38 class Encoder;
  39
  40 struct frames_not_lost_when_threads_disappear;
  41
  42
  43 /** @class TranscodeJob
  44  *  @brief A job which transcodes a Film to another format.
  45  */
  46 class TranscodeJob : public Job
  47 {
  48 public:
  49         enum class ChangedBehaviour {
  50                 EXAMINE_THEN_STOP,
  51                 STOP,
  52                 IGNORE
  53         };
  54
  55         explicit TranscodeJob (std::shared_ptr<const Film> film, ChangedBehaviour changed);
  56         ~TranscodeJob ();
  57
  58         std::string name () const override;
  59         std::string json_name () const override;
  60         void run () override;
  61         void pause() override;
  62         void resume() override;
  63         std::string status () const override;
  64         bool enable_notify () const override {
  65                 return true;
  66         }
  67
  68         void set_encoder (std::shared_ptr<Encoder> t);
  69
  70 private:
  71         friend struct ::frames_not_lost_when_threads_disappear;
  72
  73         virtual void post_transcode () {}
  74         float frames_per_second() const;
  75
  76         int remaining_time () const override;
  77
  78         std::shared_ptr<Encoder> _encoder;
  79         ChangedBehaviour _changed;
  80 };
  81
  82
  83 #endif
  84