Simpole DCP recovery utility (dcprecover) added.
authorCarl Hetherington <cth@carlh.net>
Wed, 14 Nov 2018 01:23:25 +0000 (01:23 +0000)
committerCarl Hetherington <cth@carlh.net>
Wed, 14 Nov 2018 01:23:25 +0000 (01:23 +0000)
run/tools/dcprecover [new file with mode: 0755]
src/asset_factory.cc [new file with mode: 0644]
src/asset_factory.h [new file with mode: 0644]
src/cpl.cc
src/cpl.h
src/dcp.cc
src/wscript
tools/dcprecover.cc [new file with mode: 0644]
tools/wscript

diff --git a/run/tools/dcprecover b/run/tools/dcprecover
new file mode 100755 (executable)
index 0000000..6277ccd
--- /dev/null
@@ -0,0 +1,12 @@
+#!/bin/bash
+
+export LD_LIBRARY_PATH=build/src:build/asdcplib/src:/home/c.hetherington/lib:$LD_LIBRARY_PATH
+if [ "$1" == "--debug" ]; then
+    shift
+    gdb --args build/tools/dcprecover "$@"
+elif [ "$1" == "--valgrind" ]; then
+    shift
+    valgrind --tool="memcheck" --leak-check=full --show-reachable=yes build/tools/dcprecover "$@"
+else
+    build/tools/dcprecover "$@"
+fi
diff --git a/src/asset_factory.cc b/src/asset_factory.cc
new file mode 100644 (file)
index 0000000..22c2518
--- /dev/null
@@ -0,0 +1,87 @@
+/*
+    Copyright (C) 2018 Carl Hetherington <cth@carlh.net>
+
+    This file is part of libdcp.
+
+    libdcp is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    libdcp is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
+*/
+
+#include "mono_picture_asset.h"
+#include "stereo_picture_asset.h"
+#include "sound_asset.h"
+#include "stereo_picture_asset.h"
+#include "smpte_subtitle_asset.h"
+#include "atmos_asset.h"
+#include "compose.hpp"
+#include "asset_factory.h"
+#include <boost/shared_ptr.hpp>
+
+using boost::shared_ptr;
+using namespace dcp;
+
+shared_ptr<Asset>
+dcp::asset_factory (boost::filesystem::path path, bool ignore_incorrect_picture_mxf_type)
+{
+       /* XXX: asdcplib does not appear to support discovery of read MXFs standard
+          (Interop / SMPTE)
+       */
+
+       ASDCP::EssenceType_t type;
+       if (ASDCP::EssenceType (path.string().c_str(), type) != ASDCP::RESULT_OK) {
+               throw DCPReadError ("Could not find essence type");
+       }
+       switch (type) {
+       case ASDCP::ESS_UNKNOWN:
+       case ASDCP::ESS_MPEG2_VES:
+               throw DCPReadError ("MPEG2 video essences are not supported");
+       case ASDCP::ESS_JPEG_2000:
+               try {
+                       return shared_ptr<MonoPictureAsset> (new MonoPictureAsset (path));
+               } catch (dcp::MXFFileError& e) {
+                       if (ignore_incorrect_picture_mxf_type && e.number() == ASDCP::RESULT_SFORMAT) {
+                               /* Tried to load it as mono but the error says it's stereo; try that instead */
+                               return shared_ptr<StereoPictureAsset> (new StereoPictureAsset (path));
+                       } else {
+                               throw;
+                       }
+               }
+       case ASDCP::ESS_PCM_24b_48k:
+       case ASDCP::ESS_PCM_24b_96k:
+               return shared_ptr<SoundAsset> (new SoundAsset (path));
+       case ASDCP::ESS_JPEG_2000_S:
+               return shared_ptr<StereoPictureAsset> (new StereoPictureAsset (path));
+       case ASDCP::ESS_TIMED_TEXT:
+               return shared_ptr<SMPTESubtitleAsset> (new SMPTESubtitleAsset (path));
+       case ASDCP::ESS_DCDATA_DOLBY_ATMOS:
+               return shared_ptr<AtmosAsset> (new AtmosAsset (path));
+       default:
+               throw DCPReadError (String::compose ("Unknown MXF essence type %1 in %2", int(type), path.string()));
+       }
+
+       return shared_ptr<Asset>();
+}
diff --git a/src/asset_factory.h b/src/asset_factory.h
new file mode 100644 (file)
index 0000000..6567154
--- /dev/null
@@ -0,0 +1,38 @@
+/*
+    Copyright (C) 2018 Carl Hetherington <cth@carlh.net>
+
+    This file is part of libdcp.
+
+    libdcp is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    libdcp is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
+*/
+
+namespace dcp {
+
+boost::shared_ptr<Asset> asset_factory (boost::filesystem::path path, bool ignore_incorrect_picture_mxf_type);
+
+}
index 5108161c916293498952ea722f5912169711a217..cc7237ea59498a3c2f0926778f7d9641616bb5ee 100644 (file)
@@ -170,6 +170,32 @@ CPL::write_xml (boost::filesystem::path file, Standard standard, shared_ptr<cons
        set_file (file);
 }
 
+list<shared_ptr<ReelAsset> >
+CPL::reel_assets ()
+{
+       list<shared_ptr<ReelAsset> > c;
+
+       BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+               if (i->main_picture ()) {
+                       c.push_back (i->main_picture());
+               }
+               if (i->main_sound ()) {
+                       c.push_back (i->main_sound());
+               }
+               if (i->main_subtitle ()) {
+                       c.push_back (i->main_subtitle());
+               }
+               BOOST_FOREACH (shared_ptr<ReelClosedCaptionAsset> j, i->closed_captions()) {
+                       c.push_back (j);
+               }
+               if (i->atmos ()) {
+                       c.push_back (i->atmos());
+               }
+       }
+
+       return c;
+}
+
 list<shared_ptr<const ReelAsset> >
 CPL::reel_assets () const
 {
index bcc1f06bd9ebb81bc4acc420ca7b2bac9c6c345f..259281dc3e958b5df692ca9836b952e18464a988 100644 (file)
--- a/src/cpl.h
+++ b/src/cpl.h
@@ -119,6 +119,7 @@ public:
        /** @return the ReelAssets in this CPL in all reels.
         */
        std::list<boost::shared_ptr<const ReelAsset> > reel_assets () const;
+       std::list<boost::shared_ptr<ReelAsset> > reel_assets ();
 
        bool encrypted () const;
 
index 08febadcbad8a7a6b68fe7c2233a75961c8453d5..8bf2f02fe97811d255361c28ffa5cc67008babf4 100644 (file)
@@ -57,6 +57,7 @@
 #include "reel_asset.h"
 #include "font_asset.h"
 #include "pkl.h"
+#include "asset_factory.h"
 #include <asdcp/AS_DCP.h>
 #include <xmlsec/xmldsig.h>
 #include <xmlsec/app.h>
@@ -228,46 +229,7 @@ DCP::read (bool keep_going, ReadErrors* errors, bool ignore_incorrect_picture_mx
                        *pkl_type == SMPTESubtitleAsset::static_pkl_type(*_standard)
                        ) {
 
-                       /* XXX: asdcplib does not appear to support discovery of read MXFs standard
-                          (Interop / SMPTE)
-                       */
-
-                       ASDCP::EssenceType_t type;
-                       if (ASDCP::EssenceType (path.string().c_str(), type) != ASDCP::RESULT_OK) {
-                               throw DCPReadError ("Could not find essence type");
-                       }
-                       switch (type) {
-                               case ASDCP::ESS_UNKNOWN:
-                               case ASDCP::ESS_MPEG2_VES:
-                                       throw DCPReadError ("MPEG2 video essences are not supported");
-                               case ASDCP::ESS_JPEG_2000:
-                                       try {
-                                               other_assets.push_back (shared_ptr<MonoPictureAsset> (new MonoPictureAsset (path)));
-                                       } catch (dcp::MXFFileError& e) {
-                                               if (ignore_incorrect_picture_mxf_type && e.number() == ASDCP::RESULT_SFORMAT) {
-                                                       /* Tried to load it as mono but the error says it's stereo; try that instead */
-                                                       other_assets.push_back (shared_ptr<StereoPictureAsset> (new StereoPictureAsset (path)));
-                                               } else {
-                                                       throw;
-                                               }
-                                       }
-                                       break;
-                               case ASDCP::ESS_PCM_24b_48k:
-                               case ASDCP::ESS_PCM_24b_96k:
-                                       other_assets.push_back (shared_ptr<SoundAsset> (new SoundAsset (path)));
-                                       break;
-                               case ASDCP::ESS_JPEG_2000_S:
-                                       other_assets.push_back (shared_ptr<StereoPictureAsset> (new StereoPictureAsset (path)));
-                                       break;
-                               case ASDCP::ESS_TIMED_TEXT:
-                                       other_assets.push_back (shared_ptr<SMPTESubtitleAsset> (new SMPTESubtitleAsset (path)));
-                                       break;
-                               case ASDCP::ESS_DCDATA_DOLBY_ATMOS:
-                                       other_assets.push_back (shared_ptr<AtmosAsset> (new AtmosAsset (path)));
-                                       break;
-                               default:
-                                       throw DCPReadError (String::compose ("Unknown MXF essence type %1 in %2", int(type), path.string()));
-                       }
+                       other_assets.push_back (asset_factory(path, ignore_incorrect_picture_mxf_type));
                } else if (*pkl_type == FontAsset::static_pkl_type(*_standard)) {
                        other_assets.push_back (shared_ptr<FontAsset> (new FontAsset (i->first, path)));
                } else if (*pkl_type == "image/png") {
index 3ab16157d45f9b080bf29a0c125bde785f690a81..5fe7fc802eb79e4e8b54dbd90485de10736d61e3 100644 (file)
@@ -35,6 +35,7 @@ from waflib import TaskGen
 def build(bld):
     source = """
              asset.cc
+             asset_factory.cc
              asset_writer.cc
              atmos_asset.cc
              atmos_asset_writer.cc
diff --git a/tools/dcprecover.cc b/tools/dcprecover.cc
new file mode 100644 (file)
index 0000000..b747a5d
--- /dev/null
@@ -0,0 +1,162 @@
+/*
+    Copyright (C) 2018 Carl Hetherington <cth@carlh.net>
+
+    This file is part of libdcp.
+
+    libdcp is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    libdcp is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
+*/
+
+#include "dcp.h"
+#include "cpl.h"
+#include "exceptions.h"
+#include "asset_factory.h"
+#include "reel_asset.h"
+#include <getopt.h>
+#include <libxml++/libxml++.h>
+#include <boost/filesystem.hpp>
+#include <boost/foreach.hpp>
+#include <iostream>
+
+using std::cerr;
+using std::cout;
+using std::string;
+using std::list;
+using boost::shared_ptr;
+using boost::optional;
+
+static void
+help (string n)
+{
+       cerr << "Syntax: " << n << " [OPTION] <DCP>]\n"
+            << "  -h, --help         show this help\n"
+            << "  -o, --output       output DCP directory\n";
+}
+
+void progress (float f)
+{
+       cout << (f * 100) << "%               \r";
+}
+
+int
+main (int argc, char* argv[])
+{
+       int option_index = 0;
+       optional<boost::filesystem::path> output;
+       while (true) {
+               struct option long_options[] = {
+                       { "help", no_argument, 0, 'h' },
+                       { "output", required_argument, 0, 'o' },
+                       { 0, 0, 0, 0 }
+               };
+
+               int c = getopt_long (argc, argv, "ho:", long_options, &option_index);
+
+               if (c == -1) {
+                       break;
+               }
+
+               switch (c) {
+               case 'h':
+                       help (argv[0]);
+                       exit (EXIT_SUCCESS);
+               case 'o':
+                       output = optarg;
+                       break;
+               }
+       }
+
+       if (optind >= argc) {
+               help (argv[0]);
+               exit (EXIT_FAILURE);
+       }
+
+       boost::filesystem::path dcp_dir = argv[optind];
+
+       /* Try to read it and report errors */
+
+       dcp::DCP dcp (dcp_dir);
+       dcp::DCP::ReadErrors errors;
+       try {
+               dcp.read (true, &errors, true);
+       } catch (dcp::DCPReadError& e) {
+               cout << "Error:" <<  e.what() << "\n";
+       }
+
+       BOOST_FOREACH (shared_ptr<dcp::DCPReadError> i, errors) {
+               cout << "Error: " << i->what() << "\n";
+       }
+
+       /* Look for a CPL */
+
+       shared_ptr<dcp::CPL> cpl;
+       for (boost::filesystem::directory_iterator i(dcp_dir); i != boost::filesystem::directory_iterator(); ++i) {
+               if (i->path().extension() == ".xml") {
+                       try {
+                               cpl.reset(new dcp::CPL(i->path()));
+                       } catch (dcp::DCPReadError& e) {
+                               cout << "Error: " << e.what() << "\n";
+                       } catch (xmlpp::parse_error& e) {
+                               cout << "Error: " << e.what() << "\n";
+                       }
+               }
+       }
+
+       if (cpl) {
+               cout << "Got a CPL!\n";
+
+               if (!output) {
+                       cerr << "No output directory specified.\n";
+                       exit(1);
+               }
+
+               /* Read all MXF assets */
+               list<shared_ptr<dcp::Asset> > assets;
+               for (boost::filesystem::directory_iterator i(dcp_dir); i != boost::filesystem::directory_iterator(); ++i) {
+                       if (i->path().extension() == ".mxf") {
+                               try {
+                                       shared_ptr<dcp::Asset> asset = dcp::asset_factory(i->path(), true);
+                                       asset->set_file (*output / i->path().filename());
+                                       cout << "Hashing " << i->path().filename() << "\n";
+                                       asset->hash (&progress);
+                                       cout << "100%                     \n";
+                                       assets.push_back (asset);
+                               } catch (dcp::DCPReadError& e) {
+                                       cout << "Error: " << e.what() << "\n";
+                               }
+                       }
+               }
+
+               dcp::DCP fixed (*output);
+               fixed.add (cpl);
+               fixed.resolve_refs (assets);
+               fixed.write_xml (dcp::INTEROP);
+               cout << "Fixed XML files written to " << output->string() << "\n";
+       }
+
+       return 0;
+}
index 96c31fdcc004c6f7dd6b4b58c82d8e11f256d695..99f5207e94db1fb6d92bf19a05fec33fdd29e1d3 100644 (file)
@@ -1,5 +1,5 @@
 #
-#    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
+#    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
 #
 #    This file is part of libdcp.
 #
@@ -44,7 +44,7 @@ def build(bld):
     obj.source = 'dcpinfo.cc common.cc'
     obj.target = 'dcpinfo'
 
-    for f in ['dumpsub', 'decryptmxf', 'kdm', 'thumb']:
+    for f in ['dumpsub', 'decryptmxf', 'kdm', 'thumb', 'recover']:
         obj = bld(features='cxx cxxprogram')
         obj.use = ['libdcp%s' % bld.env.API_VERSION]
         obj.uselib = 'OPENJPEG CXML OPENMP ASDCPLIB_CTH BOOST_FILESYSTEM LIBXML++ XMLSEC1 OPENSSL'