src/lib/content.h

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