src/lib/content.h

   1 /*
   2     Copyright (C) 2013-2015 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/lib/content.h
  21  *  @brief Content class.
  22  */
  23
  24 #ifndef DCPOMATIC_CONTENT_H
  25 #define DCPOMATIC_CONTENT_H
  26
  27 #include "types.h"
  28 #include "signaller.h"
  29 #include "dcpomatic_time.h"
  30 #include <libcxml/cxml.h>
  31 #include <boost/filesystem.hpp>
  32 #include <boost/signals2.hpp>
  33 #include <boost/thread/mutex.hpp>
  34 #include <boost/enable_shared_from_this.hpp>
  35
  36 namespace xmlpp {
  37         class Node;
  38 }
  39
  40 namespace cxml {
  41         class Node;
  42 }
  43
  44 class Job;
  45 class Film;
  46
  47 class ContentProperty
  48 {
  49 public:
  50         static int const PATH;
  51         static int const POSITION;
  52         static int const LENGTH;
  53         static int const TRIM_START;
  54         static int const TRIM_END;
  55 };
  56
  57 /** @class Content
  58  *  @brief A piece of content represented by one or more files on disk.
  59  */
  60 class Content : public boost::enable_shared_from_this<Content>, public Signaller, public boost::noncopyable
  61 {
  62 public:
  63         Content (boost::shared_ptr<const Film>);
  64         Content (boost::shared_ptr<const Film>, DCPTime);
  65         Content (boost::shared_ptr<const Film>, boost::filesystem::path);
  66         Content (boost::shared_ptr<const Film>, cxml::ConstNodePtr);
  67         Content (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
  68         virtual ~Content () {}
  69
  70         /** Examine the content to establish digest, frame rates and any other
  71          *  useful metadata.
  72          *  @param job Job to use to report progress, or 0.
  73          */
  74         virtual void examine (boost::shared_ptr<Job> job);
  75
  76         /** @return Quick one-line summary of the content, as will be presented in the
  77          *  film editor.
  78          */
  79         virtual std::string summary () const = 0;
  80
  81         /** @return Technical details of this content; these are written to logs to
  82          *  help with debugging.
  83          */
  84         virtual std::string technical_summary () const;
  85
  86         virtual void as_xml (xmlpp::Node *) const;
  87         virtual DCPTime full_length () const = 0;
  88         virtual std::string identifier () const;
  89         /** @return points at which to split this content when
  90          *  REELTYPE_BY_VIDEO_CONTENT is in use.
  91          */
  92         virtual std::list<DCPTime> reel_split_points () const;
  93
  94         std::list<std::pair<std::string, std::string> > properties () const;
  95
  96         boost::shared_ptr<Content> clone () const;
  97
  98         void set_path (boost::filesystem::path);
  99
 100         std::string path_summary () const;
 101
 102         std::vector<boost::filesystem::path> paths () const {
 103                 boost::mutex::scoped_lock lm (_mutex);
 104                 return _paths;
 105         }
 106
 107         size_t number_of_paths () const {
 108                 boost::mutex::scoped_lock lm (_mutex);
 109                 return _paths.size ();
 110         }
 111
 112         boost::filesystem::path path (size_t i) const {
 113                 boost::mutex::scoped_lock lm (_mutex);
 114                 return _paths[i];
 115         }
 116
 117         bool paths_valid () const;
 118
 119         /** @return Digest of the content's file(s).  Note: this is
 120          *  not a complete MD5-or-whatever hash, but a sort of poor
 121          *  man's version (see comments in ::examine).
 122          */
 123         std::string digest () const {
 124                 boost::mutex::scoped_lock lm (_mutex);
 125                 return _digest;
 126         }
 127
 128         void set_position (DCPTime);
 129
 130         /** DCPTime that this content starts; i.e. the time that the first
 131          *  bit of the content (trimmed or not) will happen.
 132          */
 133         DCPTime position () const {
 134                 boost::mutex::scoped_lock lm (_mutex);
 135                 return _position;
 136         }
 137
 138         void set_trim_start (ContentTime);
 139
 140         ContentTime trim_start () const {
 141                 boost::mutex::scoped_lock lm (_mutex);
 142                 return _trim_start;
 143         }
 144
 145         void set_trim_end (ContentTime);
 146
 147         ContentTime trim_end () const {
 148                 boost::mutex::scoped_lock lm (_mutex);
 149                 return _trim_end;
 150         }
 151
 152         /** @return Time immediately after the last thing in this content */
 153         DCPTime end () const {
 154                 return position() + length_after_trim();
 155         }
 156
 157         DCPTime length_after_trim () const;
 158
 159         void set_change_signals_frequent (bool f) {
 160                 _change_signals_frequent = f;
 161         }
 162
 163         boost::shared_ptr<const Film> film () const;
 164
 165         boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
 166
 167 protected:
 168         void signal_changed (int);
 169         virtual void add_properties (std::list<std::pair<std::string, std::string> > &) const {}
 170
 171         boost::weak_ptr<const Film> _film;
 172
 173         /** _mutex which should be used to protect accesses, as examine
 174          *  jobs can update content state in threads other than the main one.
 175          */
 176         mutable boost::mutex _mutex;
 177
 178         /** Paths of our data files */
 179         std::vector<boost::filesystem::path> _paths;
 180
 181 private:
 182         std::string _digest;
 183         DCPTime _position;
 184         ContentTime _trim_start;
 185         ContentTime _trim_end;
 186         bool _change_signals_frequent;
 187 };
 188
 189 #endif