src/dcp.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_DCP_H
  21 #define LIBDCP_DCP_H
  22
  23 #include <string>
  24 #include <list>
  25 #include <boost/shared_ptr.hpp>
  26 #include <sigc++/sigc++.h>
  27
  28 namespace libdcp
  29 {
  30
  31 class Asset;
  32
  33 /** A class to create a DCP */
  34 class DCP
  35 {
  36 public:
  37         enum ContentType
  38         {
  39                 FEATURE,
  40                 SHORT,
  41                 TRAILER,
  42                 TEST,
  43                 TRANSITIONAL,
  44                 RATING,
  45                 TEASER,
  46                 POLICY,
  47                 PUBLIC_SERVICE_ANNOUNCEMENT,
  48                 ADVERTISEMENT
  49         };
  50
  51         DCP (std::string, std::string, ContentType, int, int);
  52
  53         void add_sound_asset (std::list<std::string> const &);
  54         void add_picture_asset (std::list<std::string> const &, int, int);
  55
  56         void write_xml () const;
  57
  58         /** Emitted with a parameter between 0 and 1 to indicate progress
  59          *  for long jobs.
  60          */
  61         sigc::signal1<void, float> Progress;
  62
  63 private:
  64
  65         std::string write_cpl (std::string) const;
  66         std::string write_pkl (std::string, std::string, std::string, int) const;
  67         void write_volindex () const;
  68         void write_assetmap (std::string, int, std::string, int) const;
  69
  70         static std::string content_type_string (ContentType);
  71
  72         /** the directory that we are writing to */
  73         std::string _directory;
  74         /** the name of the DCP */
  75         std::string _name;
  76         /** the content type of the DCP */
  77         ContentType _content_type;
  78         /** frames per second */
  79         int _fps;
  80         /** length in frames */
  81         int _length;
  82         /** assets */
  83         std::list<boost::shared_ptr<Asset> > _assets;
  84 };
  85
  86 }
  87
  88 #endif