libdcp
combine.cc
Go to the documentation of this file.
1 /*
2  Copyright (C) 2020-2021 Carl Hetherington <cth@carlh.net>
3 
4  This file is part of libdcp.
5 
6  libdcp 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  libdcp 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 libdcp. If not, see <http://www.gnu.org/licenses/>.
18 
19  In addition, as a special exception, the copyright holders give
20  permission to link the code of portions of this program with the
21  OpenSSL library under certain conditions as described in each
22  individual source file, and distribute linked combinations
23  including the two.
24 
25  You must obey the GNU General Public License in all respects
26  for all of the code used other than OpenSSL. If you modify
27  file(s) with this exception, you may extend this exception to your
28  version of the file(s), but you are not obligated to do so. If you
29  do not wish to do so, delete this exception statement from your
30  version. If you delete this exception statement from all source
31  files in the program, then also delete it here.
32 */
33 
34 
40 #include "asset.h"
41 #include "combine.h"
42 #include "cpl.h"
43 #include "dcp.h"
44 #include "dcp_assert.h"
45 #include "exceptions.h"
46 #include "font_asset.h"
47 #include "interop_subtitle_asset.h"
48 #include "raw_convert.h"
49 #include <boost/filesystem.hpp>
50 #include <set>
51 #include <string>
52 #include <vector>
53 
54 
55 using std::map;
56 using std::set;
57 using std::string;
58 using std::vector;
59 using std::dynamic_pointer_cast;
60 using boost::optional;
61 using std::shared_ptr;
62 
63 
64 boost::filesystem::path
65 make_unique (boost::filesystem::path path)
66 {
67  if (!boost::filesystem::exists(path)) {
68  return path;
69  }
70 
71  for (int i = 0; i < 10000; ++i) {
72  boost::filesystem::path p = path.parent_path() / (path.stem().string() + dcp::raw_convert<string>(i) + path.extension().string());
73  if (!boost::filesystem::exists(p)) {
74  return p;
75  }
76  }
77 
78  DCP_ASSERT (false);
79  return path;
80 }
81 
82 
83 static
84 void
85 create_hard_link_or_copy (boost::filesystem::path from, boost::filesystem::path to)
86 {
87  try {
88  create_hard_link (from, to);
89  } catch (boost::filesystem::filesystem_error& e) {
90  if (e.code() == boost::system::errc::cross_device_link) {
91  copy_file (from, to);
92  } else {
93  throw;
94  }
95  }
96 }
97 
98 
99 void
100 dcp::combine (
101  vector<boost::filesystem::path> inputs,
102  boost::filesystem::path output,
103  string issuer,
104  string creator,
105  string issue_date,
106  string annotation_text,
107  shared_ptr<const CertificateChain> signer
108  )
109 {
110  using namespace boost::filesystem;
111 
112  DCP_ASSERT (!inputs.empty());
113 
114  DCP output_dcp (output);
115  optional<dcp::Standard> standard;
116 
117  for (auto i: inputs) {
118  DCP dcp (i);
119  dcp.read ();
120  if (!standard) {
121  standard = *dcp.standard();
122  } else if (standard != dcp.standard()) {
123  throw CombineError ("Cannot combine Interop and SMPTE DCPs.");
124  }
125  }
126 
127  vector<path> paths;
128  vector<shared_ptr<dcp::Asset>> assets;
129 
130  for (auto i: inputs) {
131  DCP dcp (i);
132  dcp.read ();
133 
134  for (auto j: dcp.cpls()) {
135  output_dcp.add (j);
136  }
137 
138  for (auto j: dcp.assets(true)) {
139  if (dynamic_pointer_cast<dcp::CPL>(j)) {
140  continue;
141  }
142 
143  auto sub = dynamic_pointer_cast<dcp::InteropSubtitleAsset>(j);
144  if (sub) {
145  /* Interop fonts are really fiddly. The font files are assets (in the ASSETMAP)
146  * and also linked from the font XML by filename. We have to fix both these things,
147  * and re-write the font XML file since the font URI might have changed if it's a duplicate
148  * with another DCP.
149  */
150  auto fonts = sub->font_filenames ();
151  for (auto const& k: fonts) {
152  sub->set_font_file (k.first, make_unique(output / k.second.filename()));
153  }
154  auto file = sub->file();
155  DCP_ASSERT (file);
156  path new_path = make_unique(output / file->filename());
157  sub->write (new_path);
158  }
159 
160  assets.push_back (j);
161  }
162  }
163 
164  output_dcp.resolve_refs (assets);
165 
166  for (auto i: output_dcp.assets()) {
167  if (!dynamic_pointer_cast<dcp::FontAsset>(i) && !dynamic_pointer_cast<dcp::CPL>(i)) {
168  auto file = i->file();
169  DCP_ASSERT (file);
170  path new_path = make_unique(output / file->filename());
171  create_hard_link_or_copy (*file, new_path);
172  i->set_file (new_path);
173  }
174  }
175 
176  output_dcp.write_xml (issuer, creator, issue_date, annotation_text, signer);
177 }
Asset class.
Method to combine DCPs.
CPL class.
DCP class.
DCP_ASSERT macro.
Exceptions thrown by libdcp.
FontAsset class.
InteropSubtitleAsset class.
Namespace for everything in libdcp.
Definition: array_data.h:50
Methods for conversion to/from string.