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 <libxml++/libxml++.h>
  31 #include <libcxml/cxml.h>
  32 #include <boost/filesystem.hpp>
  33 #include <boost/signals2.hpp>
  34 #include <boost/thread/mutex.hpp>
  35 #include <boost/enable_shared_from_this.hpp>
  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 Signaller, 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          */
  71         virtual void examine (boost::shared_ptr<Job> job);
  72
  73         /** @return Quick one-line summary of the content, as will be presented in the
  74          *  film editor.
  75          */
  76         virtual std::string summary () const = 0;
  77
  78         /** @return Technical details of this content; these are written to logs to
  79          *  help with debugging.
  80          */
  81         virtual std::string technical_summary () const;
  82
  83         virtual void as_xml (xmlpp::Node *) const;
  84         virtual DCPTime full_length () const = 0;
  85         virtual std::string identifier () const;
  86
  87         boost::shared_ptr<Content> clone () const;
  88
  89         void set_path (boost::filesystem::path);
  90
  91         std::string path_summary () const;
  92
  93         std::vector<boost::filesystem::path> paths () const {
  94                 boost::mutex::scoped_lock lm (_mutex);
  95                 return _paths;
  96         }
  97
  98         size_t number_of_paths () const {
  99                 boost::mutex::scoped_lock lm (_mutex);
 100                 return _paths.size ();
 101         }
 102
 103         boost::filesystem::path path (size_t i) const {
 104                 boost::mutex::scoped_lock lm (_mutex);
 105                 return _paths[i];
 106         }
 107
 108         bool paths_valid () const;
 109
 110        /** @return Digest of the content's file(s).  Note: this is
 111         *  not a complete MD5-or-whatever hash, but a sort of poor
 112         *  man's version (see comments in ::examine).
 113         */
 114         std::string digest () const {
 115                 boost::mutex::scoped_lock lm (_mutex);
 116                 return _digest;
 117         }
 118
 119         void set_position (DCPTime);
 120
 121         /** DCPTime that this content starts; i.e. the time that the first
 122          *  bit of the content (trimmed or not) will happen.
 123          */
 124         DCPTime position () const {
 125                 boost::mutex::scoped_lock lm (_mutex);
 126                 return _position;
 127         }
 128
 129         void set_trim_start (DCPTime);
 130
 131         DCPTime trim_start () const {
 132                 boost::mutex::scoped_lock lm (_mutex);
 133                 return _trim_start;
 134         }
 135
 136         void set_trim_end (DCPTime);
 137
 138         DCPTime trim_end () const {
 139                 boost::mutex::scoped_lock lm (_mutex);
 140                 return _trim_end;
 141         }
 142
 143         /** @return Time immediately after the last thing in this content */
 144         DCPTime end () const {
 145                 return position() + length_after_trim();
 146         }
 147
 148         DCPTime length_after_trim () const;
 149
 150         void set_change_signals_frequent (bool f) {
 151                 _change_signals_frequent = f;
 152         }
 153
 154         boost::shared_ptr<const Film> film () const {
 155                 return _film.lock ();
 156         }
 157
 158         boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
 159
 160 protected:
 161         void signal_changed (int);
 162
 163         boost::weak_ptr<const Film> _film;
 164
 165         /** _mutex which should be used to protect accesses, as examine
 166          *  jobs can update content state in threads other than the main one.
 167          */
 168         mutable boost::mutex _mutex;
 169
 170         /** Paths of our data files */
 171         std::vector<boost::filesystem::path> _paths;
 172
 173 private:
 174         std::string _digest;
 175         DCPTime _position;
 176         DCPTime _trim_start;
 177         DCPTime _trim_end;
 178         bool _change_signals_frequent;
 179 };
 180
 181 #endif