src/mxf_asset.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef LIBDCP_MXF_ASSET_H
  21 #define LIBDCP_MXF_ASSET_H
  22
  23 #include <boost/signals2.hpp>
  24 #include "asset.h"
  25
  26 namespace ASDCP {
  27         class AESEncContext;
  28 }
  29
  30 namespace libdcp
  31 {
  32
  33 class MXFMetadata;
  34
  35 /** @brief Parent class for assets which have MXF files */
  36 class MXFAsset : public Asset
  37 {
  38 public:
  39         /** Construct an MXFAsset.
  40          *  This class will not write anything to disk in this constructor, but subclasses may.
  41          *
  42          *  @param directory Directory where MXF file is.
  43          *  @param file_name Name of MXF file.
  44          */
  45         MXFAsset (std::string directory, std::string file_name);
  46
  47         /** Construct an MXFAsset.
  48          *  This class will not write anything to disk in this constructor, but subclasses may.
  49          *
  50          *  @param directory Directory where MXF file is.
  51          *  @param file_name Name of MXF file.
  52          *  @param progress Signal to use to inform of progress, or 0.
  53          *  @param edit_rate Edit rate in frames per second (usually equal to the video frame rate).
  54          *  @param intrinsic_duration Duration of the whole asset in frames.
  55          */
  56         MXFAsset (std::string directory, std::string file_name, boost::signals2::signal<void (float)>* progress, int edit_rate, int intrinsic_duration, bool encrypted);
  57
  58         ~MXFAsset ();
  59
  60         virtual bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
  61
  62         virtual void write_to_cpl (xmlpp::Node *) const;
  63
  64         /** Fill in a ADSCP::WriteInfo struct.
  65          *  @param w struct to fill in.
  66          *  @param uuid uuid to use.
  67          */
  68         void fill_writer_info (ASDCP::WriterInfo* w, std::string uuid, MXFMetadata const & metadata);
  69
  70         void add_typed_key_id (xmlpp::Element *) const;
  71
  72         void set_key_id (std::string k) {
  73                 _key_id = k;
  74         }
  75
  76         bool encrypted () const {
  77                 return !_key_id.empty ();
  78         }
  79
  80 protected:
  81         virtual std::string key_type () const = 0;
  82         virtual std::string cpl_node_name () const = 0;
  83
  84         /** Signal to emit to report progress, or 0 */
  85         boost::signals2::signal<void (float)>* _progress;
  86         bool _encrypted;
  87         ASDCP::AESEncContext* _encryption_context;
  88         std::string _key_value;
  89         std::string _key_id;
  90 };
  91
  92 }
  93
  94 #endif