Various Doxygen fixes.
[dcpomatic.git] / src / lib / transcode_job.cc
1 /*
2     Copyright (C) 2012-2015 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 "transcode_job.h"
26 #include "upload_job.h"
27 #include "job_manager.h"
28 #include "film.h"
29 #include "transcoder.h"
30 #include "log.h"
31 #include "compose.hpp"
32 #include <iostream>
33 #include <iomanip>
34
35 #include "i18n.h"
36
37 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
38 #define LOG_GENERAL_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
39 #define LOG_ERROR_NC(...)   _film->log()->log (__VA_ARGS__, LogEntry::TYPE_ERROR);
40
41 using std::string;
42 using std::fixed;
43 using std::setprecision;
44 using std::cout;
45 using boost::shared_ptr;
46
47 /** @param film Film to use */
48 TranscodeJob::TranscodeJob (shared_ptr<const Film> film)
49         : Job (film)
50 {
51
52 }
53
54 string
55 TranscodeJob::name () const
56 {
57         return String::compose (_("Transcode %1"), _film->name());
58 }
59
60 string
61 TranscodeJob::json_name () const
62 {
63         return N_("transcode");
64 }
65
66 void
67 TranscodeJob::run ()
68 {
69         try {
70                 struct timeval start;
71                 gettimeofday (&start, 0);
72                 LOG_GENERAL_NC (N_("Transcode job starting"));
73
74                 _transcoder.reset (new Transcoder (_film, shared_from_this ()));
75                 _transcoder->go ();
76                 set_progress (1);
77                 set_state (FINISHED_OK);
78
79                 struct timeval finish;
80                 gettimeofday (&finish, 0);
81
82                 float fps = 0;
83                 if (finish.tv_sec != start.tv_sec) {
84                         fps = _transcoder->video_frames_enqueued() / (finish.tv_sec - start.tv_sec);
85                 }
86
87                 LOG_GENERAL (N_("Transcode job completed successfully: %1 fps"), fps);
88                 _transcoder.reset ();
89
90                 if (_film->upload_after_make_dcp ()) {
91                         shared_ptr<Job> job (new UploadJob (_film));
92                         JobManager::instance()->add (job);
93                 }
94
95         } catch (...) {
96                 _transcoder.reset ();
97                 throw;
98         }
99 }
100
101 string
102 TranscodeJob::status () const
103 {
104         if (!_transcoder) {
105                 return Job::status ();
106         }
107
108
109         char buffer[256];
110         if (finished() || _transcoder->finishing()) {
111                 strncpy (buffer, Job::status().c_str(), 256);
112         } else {
113                 snprintf (
114                         buffer, sizeof(buffer), "%s; %d/%" PRId64 " frames",
115                         Job::status().c_str(),
116                         _transcoder->video_frames_enqueued(),
117                         _film->length().frames_round (_film->video_frame_rate ())
118                         );
119
120                 float const fps = _transcoder->current_encoding_rate ();
121                 if (fps) {
122                         char fps_buffer[64];
123                         /// TRANSLATORS: fps here is an abbreviation for frames per second
124                         snprintf (fps_buffer, sizeof(fps_buffer), _("; %.1f fps"), fps);
125                         strncat (buffer, fps_buffer, strlen(buffer) - 1);
126                 }
127         }
128
129         return buffer;
130 }
131
132 /** @return Approximate remaining time in seconds */
133 int
134 TranscodeJob::remaining_time () const
135 {
136         /* _transcoder might be destroyed by the job-runner thread */
137         shared_ptr<Transcoder> t = _transcoder;
138
139         if (!t || t->finishing()) {
140                 /* We aren't doing any actual encoding so just use the job's guess */
141                 return Job::remaining_time ();
142         }
143
144         /* We're encoding so guess based on the current encoding rate */
145
146         float fps = t->current_encoding_rate ();
147
148         if (fps == 0) {
149                 return 0;
150         }
151
152         /* Compute approximate proposed length here, as it's only here that we need it */
153         return (_film->length().frames_round (_film->video_frame_rate ()) - t->video_frames_enqueued()) / fps;
154 }