src/lib/transcode_job.cc

   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 /** @file src/transcode_job.cc
  23  *  @brief A job which transcodes from one format to another.
  24  */
  25
  26
  27 #include "analytics.h"
  28 #include "compose.hpp"
  29 #include "config.h"
  30 #include "dcp_encoder.h"
  31 #include "dcpomatic_log.h"
  32 #include "encoder.h"
  33 #include "film.h"
  34 #include "job_manager.h"
  35 #include "log.h"
  36 #include "transcode_job.h"
  37 #include "upload_job.h"
  38 #include <iomanip>
  39 #include <iostream>
  40
  41 #include "i18n.h"
  42
  43
  44 using std::cout;
  45 using std::fixed;
  46 using std::make_shared;
  47 using std::setprecision;
  48 using std::shared_ptr;
  49 using std::string;
  50 using boost::optional;
  51 using std::dynamic_pointer_cast;
  52
  53
  54 /** @param film Film to use */
  55 TranscodeJob::TranscodeJob (shared_ptr<const Film> film)
  56         : Job (film)
  57 {
  58
  59 }
  60
  61
  62 TranscodeJob::~TranscodeJob ()
  63 {
  64         stop_thread ();
  65 }
  66
  67
  68 string
  69 TranscodeJob::name () const
  70 {
  71         return String::compose (_("Transcoding %1"), _film->name());
  72 }
  73
  74
  75 string
  76 TranscodeJob::json_name () const
  77 {
  78         return N_("transcode");
  79 }
  80
  81
  82 void
  83 TranscodeJob::set_encoder (shared_ptr<Encoder> e)
  84 {
  85         _encoder = e;
  86 }
  87
  88
  89 void
  90 TranscodeJob::run ()
  91 {
  92         try {
  93                 struct timeval start;
  94                 gettimeofday (&start, 0);
  95                 LOG_GENERAL_NC (N_("Transcode job starting"));
  96
  97                 DCPOMATIC_ASSERT (_encoder);
  98                 _encoder->go ();
  99
 100                 struct timeval finish;
 101                 gettimeofday (&finish, 0);
 102
 103                 float fps = 0;
 104                 if (finish.tv_sec != start.tv_sec) {
 105                         fps = _encoder->frames_done() / (finish.tv_sec - start.tv_sec);
 106                 }
 107
 108                 LOG_GENERAL (N_("Transcode job completed successfully: %1 fps"), fps);
 109
 110                 if (dynamic_pointer_cast<DCPEncoder>(_encoder)) {
 111                         Analytics::instance()->successful_dcp_encode();
 112                 }
 113
 114                 /* XXX: this shouldn't be here */
 115                 if (Config::instance()->upload_after_make_dcp() && dynamic_pointer_cast<DCPEncoder>(_encoder)) {
 116                         JobManager::instance()->add(make_shared<UploadJob>(_film));
 117                 }
 118
 119                 _encoder.reset ();
 120
 121                 set_progress (1);
 122                 set_state (FINISHED_OK);
 123
 124         } catch (...) {
 125                 _encoder.reset ();
 126                 throw;
 127         }
 128 }
 129
 130
 131 string
 132 TranscodeJob::status () const
 133 {
 134         if (!_encoder) {
 135                 return Job::status ();
 136         }
 137
 138
 139         char buffer[256];
 140         if (finished() || _encoder->finishing()) {
 141                 strncpy (buffer, Job::status().c_str(), 255);
 142                 buffer[255] = '\0';
 143         } else {
 144                 snprintf (
 145                         buffer, sizeof(buffer), "%s; %" PRId64 "/%" PRId64 " frames",
 146                         Job::status().c_str(),
 147                         _encoder->frames_done(),
 148                         _film->length().frames_round (_film->video_frame_rate ())
 149                         );
 150
 151                 optional<float> const fps = _encoder->current_rate ();
 152                 if (fps) {
 153                         char fps_buffer[64];
 154                         /// TRANSLATORS: fps here is an abbreviation for frames per second
 155                         snprintf (fps_buffer, sizeof(fps_buffer), _("; %.1f fps"), *fps);
 156                         strncat (buffer, fps_buffer, strlen(buffer) - 1);
 157                 }
 158         }
 159
 160         return buffer;
 161 }
 162
 163
 164 /** @return Approximate remaining time in seconds */
 165 int
 166 TranscodeJob::remaining_time () const
 167 {
 168         /* _encoder might be destroyed by the job-runner thread */
 169         auto e = _encoder;
 170
 171         if (!e || e->finishing()) {
 172                 /* We aren't doing any actual encoding so just use the job's guess */
 173                 return Job::remaining_time ();
 174         }
 175
 176         /* We're encoding so guess based on the current encoding rate */
 177
 178         auto fps = e->current_rate ();
 179
 180         if (!fps) {
 181                 return 0;
 182         }
 183
 184         /* Compute approximate proposed length here, as it's only here that we need it */
 185         return (_film->length().frames_round(_film->video_frame_rate()) - e->frames_done()) / *fps;
 186 }