src/lib/kdm_with_metadata.h

   1 /*
   2     Copyright (C) 2013-2019 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 #ifndef DCPOMATIC_KDM_WITH_METADATA_H
  22 #define DCPOMATIC_KDM_WITH_METADATA_H
  23
  24 #ifdef DCPOMATIC_VARIANT_SWAROOP
  25 #include "encrypted_ecinema_kdm.h"
  26 #endif
  27 #include <dcp/encrypted_kdm.h>
  28 #include <dcp/name_format.h>
  29 #include <boost/shared_ptr.hpp>
  30
  31 class Cinema;
  32
  33 class KDMWithMetadata
  34 {
  35 public:
  36         KDMWithMetadata (dcp::NameFormat::Map const& name_values, boost::shared_ptr<const Cinema> cinema)
  37                 : _name_values (name_values)
  38                 , _cinema (cinema)
  39         {}
  40
  41         virtual ~KDMWithMetadata () {}
  42
  43         virtual std::string kdm_as_xml () const = 0;
  44         virtual void kdm_as_xml (boost::filesystem::path out) const = 0;
  45
  46         dcp::NameFormat::Map const& name_values () const {
  47                 return _name_values;
  48         }
  49
  50         boost::optional<std::string> get (char k) const;
  51
  52         boost::shared_ptr<const Cinema> cinema () const {
  53                 return _cinema;
  54         }
  55
  56 private:
  57         dcp::NameFormat::Map _name_values;
  58         boost::shared_ptr<const Cinema> _cinema;
  59 };
  60
  61
  62 typedef boost::shared_ptr<KDMWithMetadata> KDMWithMetadataPtr;
  63
  64
  65 int write_files (
  66         std::list<KDMWithMetadataPtr> screen_kdms, boost::filesystem::path directory,
  67         dcp::NameFormat name_format, boost::function<bool (boost::filesystem::path)> confirm_overwrite
  68         );
  69
  70
  71 void make_zip_file (std::list<KDMWithMetadataPtr> kdms, boost::filesystem::path zip_file, dcp::NameFormat name_format);
  72
  73
  74 std::list<std::list<KDMWithMetadataPtr> > collect (std::list<KDMWithMetadataPtr> kdms);
  75
  76
  77 int write_directories (
  78                 std::list<std::list<KDMWithMetadataPtr> > cinema_kdms,
  79                 boost::filesystem::path directory,
  80                 dcp::NameFormat container_name_format,
  81                 dcp::NameFormat filename_format,
  82                 boost::function<bool (boost::filesystem::path)> confirm_overwrite
  83                 );
  84
  85
  86 int write_zip_files (
  87                 std::list<std::list<KDMWithMetadataPtr> > cinema_kdms,
  88                 boost::filesystem::path directory,
  89                 dcp::NameFormat container_name_format,
  90                 dcp::NameFormat filename_format,
  91                 boost::function<bool (boost::filesystem::path)> confirm_overwrite
  92                 );
  93
  94
  95 void email (
  96                 std::list<std::list<KDMWithMetadataPtr> > cinema_kdms,
  97                 dcp::NameFormat container_name_format,
  98                 dcp::NameFormat filename_format,
  99                 std::string cpl_name
 100                 );
 101
 102
 103 template <class T>
 104 class SpecialKDMWithMetadata : public KDMWithMetadata
 105 {
 106 public:
 107         SpecialKDMWithMetadata (dcp::NameFormat::Map const& name_values, boost::shared_ptr<const Cinema> cinema, T k)
 108                 : KDMWithMetadata (name_values, cinema)
 109                 , kdm (k)
 110         {}
 111
 112         std::string kdm_as_xml () const {
 113                 return kdm.as_xml ();
 114         }
 115
 116         void kdm_as_xml (boost::filesystem::path out) const {
 117                 return kdm.as_xml (out);
 118         }
 119
 120         T kdm;
 121 };
 122
 123 typedef SpecialKDMWithMetadata<dcp::EncryptedKDM> DCPKDMWithMetadata;
 124 #ifdef DCPOMATIC_VARIANT_SWAROOP
 125 typedef SpecialKDMWithMetadata<EncryptedECinemaKDM> ECinemaKDMWithMetadata;
 126 #endif
 127
 128 #endif
 129