src/lib/transcode_job.cc

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