src/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 /** @file  src/asset.h
  21  *  @brief Parent class for assets of DCPs.
  22  */
  23
  24 #ifndef LIBDCP_ASSET_H
  25 #define LIBDCP_ASSET_H
  26
  27 #include <string>
  28 #include <boost/filesystem.hpp>
  29 #include "types.h"
  30
  31 namespace ASDCP {
  32         class WriterInfo;
  33 }
  34
  35 namespace libdcp
  36 {
  37
  38 /** @brief Parent class for assets of DCPs
  39  *
  40  *  These are collections of pictures or sound.
  41  */
  42 class Asset
  43 {
  44 public:
  45         /** Construct an Asset.
  46          *  @param directory Directory where our XML or MXF file is.
  47          *  @param file_name Name of our file within directory, or empty to make one up based on UUID.
  48          */
  49         Asset (std::string directory, std::string file_name = "");
  50
  51         /** Write details of the asset to a CPL stream.
  52          *  @param s Stream.
  53          */
  54         virtual void write_to_cpl (std::ostream& s) const = 0;
  55
  56         /** Write details of the asset to a PKL stream.
  57          *  @param s Stream.
  58          */
  59         void write_to_pkl (std::ostream& s) const;
  60
  61         /** Write details of the asset to a ASSETMAP stream.
  62          *  @param s Stream.
  63          */
  64         void write_to_assetmap (std::ostream& s) const;
  65
  66         std::string uuid () const {
  67                 return _uuid;
  68         }
  69
  70         virtual bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, std::list<std::string>& notes) const = 0;
  71
  72 protected:
  73         friend class PictureAsset;
  74         friend class SoundAsset;
  75
  76         std::string digest () const;
  77         boost::filesystem::path path () const;
  78
  79         /** Directory that our MXF or XML file is in */
  80         std::string _directory;
  81         /** Name of our MXF or XML file */
  82         std::string _file_name;
  83         /** Our UUID */
  84         std::string _uuid;
  85
  86 private:
  87         /** Digest of our MXF or XML file */
  88         mutable std::string _digest;
  89 };
  90
  91 }
  92
  93 #endif