2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/film_state.cc
21 * @brief The state of a Film. This is separate from Film so that
22 * state can easily be copied and kept around for reference
23 * by long-running jobs. This avoids the jobs getting confused
24 * by the user changing Film settings during their run.
31 #include <boost/filesystem.hpp>
32 #include <boost/date_time.hpp>
33 #include <boost/algorithm/string.hpp>
34 #include "film_state.h"
38 #include "dcp_content_type.h"
40 #include "exceptions.h"
43 #include "decoder_factory.h"
46 using namespace boost;
48 /** Write state to our `metadata' file */
50 FilmState::write_metadata () const
52 filesystem::create_directories (directory());
54 string const m = file ("metadata");
55 ofstream f (m.c_str ());
57 throw CreateFileError (m);
61 f << "name " << _name << "\n";
62 f << "use_dci_name " << _use_dci_name << "\n";
63 f << "content " << _content << "\n";
64 if (_dcp_content_type) {
65 f << "dcp_content_type " << _dcp_content_type->pretty_name () << "\n";
68 f << "format " << _format->as_metadata () << "\n";
70 f << "left_crop " << _crop.left << "\n";
71 f << "right_crop " << _crop.right << "\n";
72 f << "top_crop " << _crop.top << "\n";
73 f << "bottom_crop " << _crop.bottom << "\n";
74 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
75 f << "filter " << (*i)->id () << "\n";
77 f << "scaler " << _scaler->id () << "\n";
78 f << "dcp_frames " << _dcp_frames << "\n";
80 f << "dcp_trim_action ";
81 switch (_dcp_trim_action) {
90 f << "dcp_ab " << (_dcp_ab ? "1" : "0") << "\n";
91 f << "selected_audio_stream " << _audio_stream << "\n";
92 f << "audio_gain " << _audio_gain << "\n";
93 f << "audio_delay " << _audio_delay << "\n";
94 f << "still_duration " << _still_duration << "\n";
95 f << "selected_subtitle_stream " << _subtitle_stream << "\n";
96 f << "with_subtitles " << _with_subtitles << "\n";
97 f << "subtitle_offset " << _subtitle_offset << "\n";
98 f << "subtitle_scale " << _subtitle_scale << "\n";
99 f << "audio_language " << _audio_language << "\n";
100 f << "subtitle_language " << _subtitle_language << "\n";
101 f << "territory " << _territory << "\n";
102 f << "rating " << _rating << "\n";
103 f << "studio " << _studio << "\n";
104 f << "facility " << _facility << "\n";
105 f << "package_type " << _package_type << "\n";
107 /* Cached stuff; this is information about our content; we could
108 look it up each time, but that's slow.
110 for (vector<int>::const_iterator i = _thumbs.begin(); i != _thumbs.end(); ++i) {
111 f << "thumb " << *i << "\n";
113 f << "width " << _size.width << "\n";
114 f << "height " << _size.height << "\n";
115 f << "length " << _length << "\n";
116 f << "audio_sample_rate " << _audio_sample_rate << "\n";
117 f << "content_digest " << _content_digest << "\n";
118 f << "has_subtitles " << _has_subtitles << "\n";
120 for (vector<AudioStream>::const_iterator i = _audio_streams.begin(); i != _audio_streams.end(); ++i) {
121 f << "audio_stream " << i->to_string () << "\n";
124 for (vector<SubtitleStream>::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
125 f << "subtitle_stream " << i->to_string () << "\n";
128 f << "frames_per_second " << _frames_per_second << "\n";
129 f << "audio_to_discard " << _audio_to_discard << "\n";
134 /** Read state from our metadata file */
136 FilmState::read_metadata ()
138 ifstream f (file("metadata").c_str());
139 multimap<string, string> kv = read_key_value (f);
140 for (multimap<string, string>::const_iterator i = kv.begin(); i != kv.end(); ++i) {
141 string const k = i->first;
142 string const v = i->second;
144 /* User-specified stuff */
147 } else if (k == "use_dci_name") {
148 _use_dci_name = (v == "1");
149 } else if (k == "content") {
151 } else if (k == "dcp_content_type") {
152 _dcp_content_type = DCPContentType::from_pretty_name (v);
153 } else if (k == "format") {
154 _format = Format::from_metadata (v);
155 } else if (k == "left_crop") {
156 _crop.left = atoi (v.c_str ());
157 } else if (k == "right_crop") {
158 _crop.right = atoi (v.c_str ());
159 } else if (k == "top_crop") {
160 _crop.top = atoi (v.c_str ());
161 } else if (k == "bottom_crop") {
162 _crop.bottom = atoi (v.c_str ());
163 } else if (k == "filter") {
164 _filters.push_back (Filter::from_id (v));
165 } else if (k == "scaler") {
166 _scaler = Scaler::from_id (v);
167 } else if (k == "dcp_frames") {
168 _dcp_frames = atoi (v.c_str ());
169 } else if (k == "dcp_trim_action") {
171 _dcp_trim_action = CUT;
172 } else if (v == "black_out") {
173 _dcp_trim_action = BLACK_OUT;
175 } else if (k == "dcp_ab") {
176 _dcp_ab = (v == "1");
177 } else if (k == "selected_audio_stream") {
178 _audio_stream = atoi (v.c_str ());
179 } else if (k == "audio_gain") {
180 _audio_gain = atof (v.c_str ());
181 } else if (k == "audio_delay") {
182 _audio_delay = atoi (v.c_str ());
183 } else if (k == "still_duration") {
184 _still_duration = atoi (v.c_str ());
185 } else if (k == "selected_subtitle_stream") {
186 _subtitle_stream = atoi (v.c_str ());
187 } else if (k == "with_subtitles") {
188 _with_subtitles = (v == "1");
189 } else if (k == "subtitle_offset") {
190 _subtitle_offset = atoi (v.c_str ());
191 } else if (k == "subtitle_scale") {
192 _subtitle_scale = atof (v.c_str ());
193 } else if (k == "audio_language") {
195 } else if (k == "subtitle_language") {
196 _subtitle_language = v;
197 } else if (k == "territory") {
199 } else if (k == "rating") {
201 } else if (k == "studio") {
203 } else if (k == "facility") {
205 } else if (k == "package_type") {
211 int const n = atoi (v.c_str ());
212 /* Only add it to the list if it still exists */
213 if (filesystem::exists (thumb_file_for_frame (n))) {
214 _thumbs.push_back (n);
216 } else if (k == "width") {
217 _size.width = atoi (v.c_str ());
218 } else if (k == "height") {
219 _size.height = atoi (v.c_str ());
220 } else if (k == "length") {
221 _length = atof (v.c_str ());
222 } else if (k == "audio_sample_rate") {
223 _audio_sample_rate = atoi (v.c_str ());
224 } else if (k == "content_digest") {
226 } else if (k == "has_subtitles") {
227 _has_subtitles = (v == "1");
228 } else if (k == "audio_stream") {
229 _audio_streams.push_back (AudioStream (v));
230 } else if (k == "subtitle_stream") {
231 _subtitle_streams.push_back (SubtitleStream (v));
232 } else if (k == "frames_per_second") {
233 _frames_per_second = atof (v.c_str ());
234 } else if (k == "audio_to_discard") {
235 _audio_to_discard = atoi (v.c_str ());
242 /** @param n A thumb index.
243 * @return The path to the thumb's image file.
246 FilmState::thumb_file (int n) const
248 return thumb_file_for_frame (thumb_frame (n));
251 /** @param n A frame index within the Film.
252 * @return The path to the thumb's image file for this frame;
253 * we assume that it exists.
256 FilmState::thumb_file_for_frame (int n) const
258 return thumb_base_for_frame(n) + ".png";
262 FilmState::thumb_base (int n) const
264 return thumb_base_for_frame (thumb_frame (n));
268 FilmState::thumb_base_for_frame (int n) const
272 s << setfill('0') << n;
282 /** @param n A thumb index.
283 * @return The frame within the Film that it is for.
286 FilmState::thumb_frame (int n) const
288 assert (n < int (_thumbs.size ()));
293 FilmState::cropped_size (Size s) const
295 s.width -= _crop.left + _crop.right;
296 s.height -= _crop.top + _crop.bottom;
300 /** Given a directory name, return its full path within the Film's directory.
301 * The directory (and its parents) will be created if they do not exist.
304 FilmState::dir (string d) const
309 filesystem::create_directories (p);
313 /** Given a file or directory name, return its full path within the Film's directory */
315 FilmState::file (string f) const
323 /** @return full path of the content (actual video) file
327 FilmState::content_path () const
329 if (filesystem::path(_content).has_root_directory ()) {
333 return file (_content);
337 FilmState::content_type () const
339 #if BOOST_FILESYSTEM_VERSION == 3
340 string ext = filesystem::path(_content).extension().string();
342 string ext = filesystem::path(_content).extension();
345 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
347 if (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png") {
355 FilmState::target_sample_rate () const
357 /* Resample to a DCI-approved sample rate */
358 double t = dcp_audio_sample_rate (_audio_sample_rate);
360 /* Compensate for the fact that video will be rounded to the
361 nearest integer number of frames per second.
363 if (rint (_frames_per_second) != _frames_per_second) {
364 t *= _frames_per_second / rint (_frames_per_second);
371 FilmState::dcp_length () const
380 /** @return a DCI-compliant name for a DCP of this film */
382 FilmState::dci_name () const
386 string fixed_name = to_upper_copy (_name);
387 for (size_t i = 0; i < fixed_name.length(); ++i) {
388 if (fixed_name[i] == ' ') {
393 /* Spec is that the name part should be maximum 14 characters, as I understand it */
394 if (fixed_name.length() > 14) {
395 fixed_name = fixed_name.substr (0, 14);
398 d << fixed_name << "_";
400 if (_dcp_content_type) {
401 d << _dcp_content_type->dci_name() << "_";
405 d << _format->dci_name() << "_";
408 if (!_audio_language.empty ()) {
409 d << _audio_language;
410 if (!_subtitle_language.empty() && _with_subtitles) {
411 d << "-" << _subtitle_language;
419 if (!_territory.empty ()) {
421 if (!_rating.empty ()) {
427 switch (_audio_streams[_audio_stream].channels()) {
444 if (!_studio.empty ()) {
448 gregorian::date today = gregorian::day_clock::local_day ();
449 d << gregorian::to_iso_string (today) << "_";
451 if (!_facility.empty ()) {
452 d << _facility << "_";
455 if (!_package_type.empty ()) {
462 /** @return name to give the DCP */
464 FilmState::dcp_name () const
475 FilmState::set_directory (string d)
482 FilmState::set_name (string n)
485 signal_changed (NAME);
489 FilmState::set_use_dci_name (bool u)
492 signal_changed (USE_DCI_NAME);
496 FilmState::set_content (string c)
498 string check = _directory;
500 #if BOOST_FILESYSTEM_VERSION == 3
501 filesystem::path slash ("/");
502 string platform_slash = slash.make_preferred().string ();
504 #ifdef DVDOMATIC_WINDOWS
505 string platform_slash = "\\";
507 string platform_slash = "/";
511 if (!ends_with (check, platform_slash)) {
512 check += platform_slash;
515 if (filesystem::path(c).has_root_directory () && starts_with (c, check)) {
516 c = c.substr (_directory.length() + 1);
523 /* Create a temporary decoder so that we can get information
527 shared_ptr<FilmState> s = state_copy ();
529 shared_ptr<Options> o (new Options ("", "", ""));
530 o->out_size = Size (1024, 1024);
532 shared_ptr<Decoder> d = decoder_factory (s, o, 0, 0);
534 set_size (d->native_size ());
535 set_frames_per_second (d->frames_per_second ());
536 set_audio_sample_rate (d->audio_sample_rate ());
537 set_has_subtitles (d->has_subtitles ());
538 set_audio_streams (d->audio_streams ());
539 set_subtitle_streams (d->subtitle_streams ());
540 set_audio_stream (audio_streams().empty() ? -1 : 0);
541 set_subtitle_stream (subtitle_streams().empty() ? -1 : 0);
542 set_content_digest (md5_digest (c));
545 signal_changed (CONTENT);
549 FilmState::set_dcp_content_type (DCPContentType const * t)
551 _dcp_content_type = t;
552 signal_changed (DCP_CONTENT_TYPE);
556 FilmState::set_format (Format const * f)
559 signal_changed (FORMAT);
563 FilmState::set_crop (Crop c)
566 signal_changed (CROP);
570 FilmState::set_left_crop (int c)
572 if (_crop.left == c) {
577 signal_changed (CROP);
581 FilmState::set_right_crop (int c)
583 if (_crop.right == c) {
588 signal_changed (CROP);
592 FilmState::set_top_crop (int c)
594 if (_crop.top == c) {
599 signal_changed (CROP);
603 FilmState::set_bottom_crop (int c)
605 if (_crop.bottom == c) {
610 signal_changed (CROP);
614 FilmState::set_filters (vector<Filter const *> f)
617 signal_changed (FILTERS);
621 FilmState::set_scaler (Scaler const * s)
624 signal_changed (SCALER);
628 FilmState::set_dcp_frames (int f)
631 signal_changed (DCP_FRAMES);
635 FilmState::set_dcp_trim_action (TrimAction a)
637 _dcp_trim_action = a;
638 signal_changed (DCP_TRIM_ACTION);
642 FilmState::set_dcp_ab (bool a)
645 signal_changed (DCP_AB);
649 FilmState::set_audio_stream (int s)
652 signal_changed (AUDIO_STREAM);
656 FilmState::set_audio_gain (float g)
659 signal_changed (AUDIO_GAIN);
663 FilmState::set_audio_delay (int d)
666 signal_changed (AUDIO_DELAY);
670 FilmState::set_still_duration (int d)
673 signal_changed (STILL_DURATION);
677 FilmState::set_subtitle_stream (int s)
679 _subtitle_stream = s;
680 signal_changed (SUBTITLE_STREAM);
684 FilmState::set_with_subtitles (bool w)
687 signal_changed (WITH_SUBTITLES);
691 FilmState::set_subtitle_offset (int o)
693 _subtitle_offset = o;
694 signal_changed (SUBTITLE_OFFSET);
698 FilmState::set_subtitle_scale (float s)
701 signal_changed (SUBTITLE_SCALE);
705 FilmState::set_audio_language (string l)
708 signal_changed (DCI_METADATA);
712 FilmState::set_subtitle_language (string l)
714 _subtitle_language = l;
715 signal_changed (DCI_METADATA);
719 FilmState::set_territory (string t)
722 signal_changed (DCI_METADATA);
726 FilmState::set_rating (string r)
729 signal_changed (DCI_METADATA);
733 FilmState::set_studio (string s)
736 signal_changed (DCI_METADATA);
740 FilmState::set_facility (string f)
743 signal_changed (DCI_METADATA);
747 FilmState::set_package_type (string p)
750 signal_changed (DCI_METADATA);
754 FilmState::set_thumbs (vector<int> t)
757 signal_changed (THUMBS);
761 FilmState::set_size (Size s)
764 signal_changed (SIZE);
768 FilmState::set_length (int l)
771 signal_changed (LENGTH);
775 FilmState::set_audio_sample_rate (int r)
777 _audio_sample_rate = r;
778 signal_changed (AUDIO_SAMPLE_RATE);
782 FilmState::set_content_digest (string d)
789 FilmState::set_has_subtitles (bool s)
792 signal_changed (HAS_SUBTITLES);
796 FilmState::set_audio_streams (vector<AudioStream> s)
803 FilmState::set_subtitle_streams (vector<SubtitleStream> s)
805 _subtitle_streams = s;
810 FilmState::set_frames_per_second (float f)
812 _frames_per_second = f;
813 signal_changed (FRAMES_PER_SECOND);
817 FilmState::set_audio_to_discard (int a)
819 _audio_to_discard = a;
820 signal_changed (AUDIO_TO_DISCARD);
824 FilmState::signal_changed (Property p)
830 shared_ptr<FilmState>
831 FilmState::state_copy () const
833 return shared_ptr<FilmState> (new FilmState (*this));
837 FilmState::audio_channels () const
839 if (_audio_stream == -1) {
843 return _audio_streams[_audio_stream].channels ();
847 FilmState::total_audio_delay () const
849 return _audio_delay - _audio_to_discard;