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_channels " << _audio_channels << "\n";
117 f << "audio_sample_rate " << _audio_sample_rate << "\n";
118 f << "audio_sample_format " << audio_sample_format_to_string (_audio_sample_format) << "\n";
119 f << "content_digest " << _content_digest << "\n";
120 f << "has_subtitles " << _has_subtitles << "\n";
122 for (vector<Stream>::const_iterator i = _audio_streams.begin(); i != _audio_streams.end(); ++i) {
123 f << "audio_stream " << i->to_string () << "\n";
126 for (vector<Stream>::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
127 f << "subtitle_stream " << i->to_string () << "\n";
130 f << "frames_per_second " << _frames_per_second << "\n";
135 /** Read state from our metadata file */
137 FilmState::read_metadata ()
139 ifstream f (file("metadata").c_str());
140 multimap<string, string> kv = read_key_value (f);
141 for (multimap<string, string>::const_iterator i = kv.begin(); i != kv.end(); ++i) {
142 string const k = i->first;
143 string const v = i->second;
145 /* User-specified stuff */
148 } else if (k == "use_dci_name") {
149 _use_dci_name = (v == "1");
150 } else if (k == "content") {
152 } else if (k == "dcp_content_type") {
153 _dcp_content_type = DCPContentType::from_pretty_name (v);
154 } else if (k == "format") {
155 _format = Format::from_metadata (v);
156 } else if (k == "left_crop") {
157 _crop.left = atoi (v.c_str ());
158 } else if (k == "right_crop") {
159 _crop.right = atoi (v.c_str ());
160 } else if (k == "top_crop") {
161 _crop.top = atoi (v.c_str ());
162 } else if (k == "bottom_crop") {
163 _crop.bottom = atoi (v.c_str ());
164 } else if (k == "filter") {
165 _filters.push_back (Filter::from_id (v));
166 } else if (k == "scaler") {
167 _scaler = Scaler::from_id (v);
168 } else if (k == "dcp_frames") {
169 _dcp_frames = atoi (v.c_str ());
170 } else if (k == "dcp_trim_action") {
172 _dcp_trim_action = CUT;
173 } else if (v == "black_out") {
174 _dcp_trim_action = BLACK_OUT;
176 } else if (k == "dcp_ab") {
177 _dcp_ab = (v == "1");
178 } else if (k == "selected_audio_stream") {
179 _audio_stream = atoi (v.c_str ());
180 } else if (k == "audio_gain") {
181 _audio_gain = atof (v.c_str ());
182 } else if (k == "audio_delay") {
183 _audio_delay = atoi (v.c_str ());
184 } else if (k == "still_duration") {
185 _still_duration = atoi (v.c_str ());
186 } else if (k == "selected_subtitle_stream") {
187 _subtitle_stream = atoi (v.c_str ());
188 } else if (k == "with_subtitles") {
189 _with_subtitles = (v == "1");
190 } else if (k == "subtitle_offset") {
191 _subtitle_offset = atoi (v.c_str ());
192 } else if (k == "subtitle_scale") {
193 _subtitle_scale = atof (v.c_str ());
194 } else if (k == "audio_language") {
196 } else if (k == "subtitle_language") {
197 _subtitle_language = v;
198 } else if (k == "territory") {
200 } else if (k == "rating") {
202 } else if (k == "studio") {
204 } else if (k == "facility") {
206 } else if (k == "package_type") {
212 int const n = atoi (v.c_str ());
213 /* Only add it to the list if it still exists */
214 if (filesystem::exists (thumb_file_for_frame (n))) {
215 _thumbs.push_back (n);
217 } else if (k == "width") {
218 _size.width = atoi (v.c_str ());
219 } else if (k == "height") {
220 _size.height = atoi (v.c_str ());
221 } else if (k == "length") {
222 _length = atof (v.c_str ());
223 } else if (k == "audio_channels") {
224 _audio_channels = atoi (v.c_str ());
225 } else if (k == "audio_sample_rate") {
226 _audio_sample_rate = atoi (v.c_str ());
227 } else if (k == "audio_sample_format") {
228 _audio_sample_format = audio_sample_format_from_string (v);
229 } else if (k == "content_digest") {
231 } else if (k == "has_subtitles") {
232 _has_subtitles = (v == "1");
233 } else if (k == "audio_stream") {
234 _audio_streams.push_back (Stream (v));
235 } else if (k == "subtitle_stream") {
236 _subtitle_streams.push_back (Stream (v));
237 } else if (k == "frames_per_second") {
238 _frames_per_second = atof (v.c_str ());
245 /** @param n A thumb index.
246 * @return The path to the thumb's image file.
249 FilmState::thumb_file (int n) const
251 return thumb_file_for_frame (thumb_frame (n));
254 /** @param n A frame index within the Film.
255 * @return The path to the thumb's image file for this frame;
256 * we assume that it exists.
259 FilmState::thumb_file_for_frame (int n) const
261 return thumb_base_for_frame(n) + ".png";
265 FilmState::thumb_base (int n) const
267 return thumb_base_for_frame (thumb_frame (n));
271 FilmState::thumb_base_for_frame (int n) const
275 s << setfill('0') << n;
285 /** @param n A thumb index.
286 * @return The frame within the Film that it is for.
289 FilmState::thumb_frame (int n) const
291 assert (n < int (_thumbs.size ()));
296 FilmState::cropped_size (Size s) const
298 s.width -= _crop.left + _crop.right;
299 s.height -= _crop.top + _crop.bottom;
303 /** Given a directory name, return its full path within the Film's directory.
304 * The directory (and its parents) will be created if they do not exist.
307 FilmState::dir (string d) const
312 filesystem::create_directories (p);
316 /** Given a file or directory name, return its full path within the Film's directory */
318 FilmState::file (string f) const
326 /** @return full path of the content (actual video) file
330 FilmState::content_path () const
332 if (filesystem::path(_content).has_root_directory ()) {
336 return file (_content);
340 FilmState::content_type () const
342 #if BOOST_FILESYSTEM_VERSION == 3
343 string ext = filesystem::path(_content).extension().string();
345 string ext = filesystem::path(_content).extension();
348 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
350 if (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png") {
357 /** @return Number of bytes per sample of a single channel */
359 FilmState::bytes_per_sample () const
361 switch (_audio_sample_format) {
362 case AV_SAMPLE_FMT_S16:
372 FilmState::target_sample_rate () const
374 /* Resample to a DCI-approved sample rate */
375 double t = dcp_audio_sample_rate (_audio_sample_rate);
377 /* Compensate for the fact that video will be rounded to the
378 nearest integer number of frames per second.
380 if (rint (_frames_per_second) != _frames_per_second) {
381 t *= _frames_per_second / rint (_frames_per_second);
388 FilmState::dcp_length () const
397 /** @return a DCI-compliant name for a DCP of this film */
399 FilmState::dci_name () const
403 string fixed_name = to_upper_copy (_name);
404 for (size_t i = 0; i < fixed_name.length(); ++i) {
405 if (fixed_name[i] == ' ') {
410 /* Spec is that the name part should be maximum 14 characters, as I understand it */
411 if (fixed_name.length() > 14) {
412 fixed_name = fixed_name.substr (0, 14);
415 d << fixed_name << "_";
417 if (_dcp_content_type) {
418 d << _dcp_content_type->dci_name() << "_";
422 d << _format->dci_name() << "_";
425 if (!_audio_language.empty ()) {
426 d << _audio_language;
427 if (!_subtitle_language.empty() && _with_subtitles) {
428 d << "-" << _subtitle_language;
436 if (!_territory.empty ()) {
438 if (!_rating.empty ()) {
444 switch (_audio_channels) {
458 if (!_studio.empty ()) {
462 gregorian::date today = gregorian::day_clock::local_day ();
463 d << gregorian::to_iso_string (today) << "_";
465 if (!_facility.empty ()) {
466 d << _facility << "_";
469 if (!_package_type.empty ()) {
476 /** @return name to give the DCP */
478 FilmState::dcp_name () const
489 FilmState::set_directory (string d)
496 FilmState::set_name (string n)
499 signal_changed (NAME);
503 FilmState::set_use_dci_name (bool u)
506 signal_changed (USE_DCI_NAME);
510 FilmState::set_content (string c)
512 string check = _directory;
514 #if BOOST_FILESYSTEM_VERSION == 3
515 filesystem::path slash ("/");
516 string platform_slash = slash.make_preferred().string ();
518 #ifdef DVDOMATIC_WINDOWS
519 string platform_slash = "\\";
521 string platform_slash = "/";
525 if (!ends_with (check, platform_slash)) {
526 check += platform_slash;
529 if (filesystem::path(c).has_root_directory () && starts_with (c, check)) {
530 c = c.substr (_directory.length() + 1);
537 /* Create a temporary decoder so that we can get information
541 shared_ptr<FilmState> s = state_copy ();
543 shared_ptr<Options> o (new Options ("", "", ""));
544 o->out_size = Size (1024, 1024);
546 shared_ptr<Decoder> d = decoder_factory (s, o, 0, 0);
548 set_size (d->native_size ());
549 set_length (d->length_in_frames ());
550 set_frames_per_second (d->frames_per_second ());
551 set_audio_channels (d->audio_channels ());
552 set_audio_sample_rate (d->audio_sample_rate ());
553 set_audio_sample_format (d->audio_sample_format ());
554 set_has_subtitles (d->has_subtitles ());
555 set_audio_streams (d->audio_streams ());
556 set_subtitle_streams (d->subtitle_streams ());
557 set_audio_stream (audio_streams().empty() ? -1 : audio_streams().front().id);
558 set_subtitle_stream (subtitle_streams().empty() ? -1 : subtitle_streams().front().id);
559 set_content_digest (md5_digest (content_path ()));
562 signal_changed (CONTENT);
566 FilmState::set_dcp_content_type (DCPContentType const * t)
568 _dcp_content_type = t;
569 signal_changed (DCP_CONTENT_TYPE);
573 FilmState::set_format (Format const * f)
576 signal_changed (FORMAT);
580 FilmState::set_crop (Crop c)
583 signal_changed (CROP);
587 FilmState::set_left_crop (int c)
589 if (_crop.left == c) {
594 signal_changed (CROP);
598 FilmState::set_right_crop (int c)
600 if (_crop.right == c) {
605 signal_changed (CROP);
609 FilmState::set_top_crop (int c)
611 if (_crop.top == c) {
616 signal_changed (CROP);
620 FilmState::set_bottom_crop (int c)
622 if (_crop.bottom == c) {
627 signal_changed (CROP);
631 FilmState::set_filters (vector<Filter const *> f)
634 signal_changed (FILTERS);
638 FilmState::set_scaler (Scaler const * s)
641 signal_changed (SCALER);
645 FilmState::set_dcp_frames (int f)
648 signal_changed (DCP_FRAMES);
652 FilmState::set_dcp_trim_action (TrimAction a)
654 _dcp_trim_action = a;
655 signal_changed (DCP_TRIM_ACTION);
659 FilmState::set_dcp_ab (bool a)
662 signal_changed (DCP_AB);
666 FilmState::set_audio_stream (int s)
669 signal_changed (AUDIO_STREAM);
673 FilmState::set_audio_gain (float g)
676 signal_changed (AUDIO_GAIN);
680 FilmState::set_audio_delay (int d)
683 signal_changed (AUDIO_DELAY);
687 FilmState::set_still_duration (int d)
690 signal_changed (STILL_DURATION);
694 FilmState::set_subtitle_stream (int s)
696 _subtitle_stream = s;
697 signal_changed (SUBTITLE_STREAM);
701 FilmState::set_with_subtitles (bool w)
704 signal_changed (WITH_SUBTITLES);
708 FilmState::set_subtitle_offset (int o)
710 _subtitle_offset = o;
711 signal_changed (SUBTITLE_OFFSET);
715 FilmState::set_subtitle_scale (float s)
718 signal_changed (SUBTITLE_SCALE);
722 FilmState::set_audio_language (string l)
725 signal_changed (DCI_METADATA);
729 FilmState::set_subtitle_language (string l)
731 _subtitle_language = l;
732 signal_changed (DCI_METADATA);
736 FilmState::set_territory (string t)
739 signal_changed (DCI_METADATA);
743 FilmState::set_rating (string r)
746 signal_changed (DCI_METADATA);
750 FilmState::set_studio (string s)
753 signal_changed (DCI_METADATA);
757 FilmState::set_facility (string f)
760 signal_changed (DCI_METADATA);
764 FilmState::set_package_type (string p)
767 signal_changed (DCI_METADATA);
771 FilmState::set_thumbs (vector<int> t)
774 signal_changed (THUMBS);
778 FilmState::set_size (Size s)
781 signal_changed (SIZE);
785 FilmState::set_length (int l)
788 signal_changed (LENGTH);
792 FilmState::set_audio_channels (int c)
795 signal_changed (AUDIO_CHANNELS);
799 FilmState::set_audio_sample_rate (int r)
801 _audio_sample_rate = r;
802 signal_changed (AUDIO_SAMPLE_RATE);
806 FilmState::set_audio_sample_format (AVSampleFormat f)
808 _audio_sample_format = f;
813 FilmState::set_content_digest (string d)
820 FilmState::set_has_subtitles (bool s)
823 signal_changed (HAS_SUBTITLES);
827 FilmState::set_audio_streams (vector<Stream> s)
834 FilmState::set_subtitle_streams (vector<Stream> s)
836 _subtitle_streams = s;
841 FilmState::set_frames_per_second (float f)
843 _frames_per_second = f;
844 signal_changed (FRAMES_PER_SECOND);
848 FilmState::signal_changed (Property p)
854 shared_ptr<FilmState>
855 FilmState::state_copy () const
857 return shared_ptr<FilmState> (new FilmState (*this));