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 <sigc++/sigc++.h>
  29
  30 namespace ASDCP {
  31         class WriterInfo;
  32 }
  33
  34 namespace libdcp
  35 {
  36
  37 /** @brief Parent class for assets of DCPs
  38  *
  39  *  These are collections of pictures or sound.
  40  */
  41 class Asset
  42 {
  43 public:
  44         /** Construct an Asset.
  45          *  @param directory Directory where MXF file is.
  46          *  @param mxf_name Name of MXF file.
  47          *  @param progress Signal to inform of progress.
  48          *  @param fps Frames per second.
  49          *  @param length Length in frames.
  50          */
  51         Asset (std::string directory, std::string mxf_path, sigc::signal1<void, float>* progress, int fps, int length);
  52
  53         /** Write details of the asset to a CPL stream.
  54          *  @param s Stream.
  55          */
  56         virtual void write_to_cpl (std::ostream& s) const = 0;
  57
  58         /** Write details of the asset to a PKL stream.
  59          *  @param s Stream.
  60          */
  61         void write_to_pkl (std::ostream& s) const;
  62
  63         /** Write details of the asset to a ASSETMAP stream.
  64          *  @param s Stream.
  65          */
  66         void write_to_assetmap (std::ostream& s) const;
  67
  68 protected:
  69         /** Fill in a ADSCP::WriteInfo struct.
  70          *  @param w struct to fill in.
  71          */
  72         void fill_writer_info (ASDCP::WriterInfo* w) const;
  73
  74         boost::filesystem::path mxf_path () const;
  75
  76         /** Directory that our MXF file is in */
  77         std::string _directory;
  78         /** Name of our MXF file */
  79         std::string _mxf_name;
  80         /** Signal to emit to report progress */
  81         sigc::signal1<void, float>* _progress;
  82         /** Frames per second */
  83         int _fps;
  84         /** Length in frames */
  85         int _length;
  86         /** Our UUID */
  87         std::string _uuid;
  88         /** Digest of our MXF */
  89         std::string _digest;
  90 };
  91
  92 }
  93
  94 #endif