src/content.h

   1 /*
   2     Copyright (C) 2012-2014 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/content.h
  21  *  @brief Content class.
  22  */
  23
  24 #ifndef LIBDCP_CONTENT_H
  25 #define LIBDCP_CONTENT_H
  26
  27 #include "types.h"
  28 #include "asset.h"
  29 #include <libxml++/libxml++.h>
  30 #include <boost/filesystem.hpp>
  31 #include <boost/function.hpp>
  32 #include <string>
  33 #include <list>
  34
  35 namespace ASDCP {
  36         class WriterInfo;
  37 }
  38
  39 namespace xmlpp {
  40         class Element;
  41 }
  42
  43 namespace dcp
  44 {
  45
  46 /** @class Content
  47  *  @brief An asset that represents a piece of content, i.e. picture, sound or subtitle.
  48  *
  49  *  Such a piece of content will be contained in a file (either MXF or XML) within a DCP.
  50  */
  51 class Content : public Asset
  52 {
  53 public:
  54         /** Construct a Content object by reading a file.
  55          *  @param file File to read.
  56          */
  57         Content (boost::filesystem::path file);
  58
  59         /** Construct a new piece of content with a specified edit rate.
  60          *  @param edit_rate Edit rate for the content.
  61          */
  62         Content (Fraction edit_rate);
  63
  64         virtual ~Content () {}
  65
  66         bool equals (
  67                 boost::shared_ptr<const Content> other,
  68                 EqualityOptions opt,
  69                 boost::function<void (NoteType, std::string)>
  70                 ) const;
  71
  72         Fraction edit_rate () const {
  73                 return _edit_rate;
  74         }
  75
  76         /** @return The total length of this content in video frames.
  77          *  The amount of content presented may be less than this.
  78          */
  79         int64_t intrinsic_duration () const {
  80                 return _intrinsic_duration;
  81         }
  82
  83 protected:
  84         friend class MXFWriter;
  85
  86         virtual std::string asdcp_kind () const = 0;
  87
  88         Fraction _edit_rate;
  89         /** The total length of this content in video frames.  The amount of
  90          *  content presented may be less than this.
  91          */
  92         int64_t _intrinsic_duration;
  93 };
  94
  95 }
  96
  97 #endif