src/lib/content.h

   1 /*
   2     Copyright (C) 2013 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 DCPOMATIC_CONTENT_H
  21 #define DCPOMATIC_CONTENT_H
  22
  23 #include <set>
  24 #include <boost/filesystem.hpp>
  25 #include <boost/signals2.hpp>
  26 #include <boost/thread/mutex.hpp>
  27 #include <boost/enable_shared_from_this.hpp>
  28 #include <libxml++/libxml++.h>
  29 #include "types.h"
  30
  31 namespace cxml {
  32         class Node;
  33 }
  34
  35 class Job;
  36 class Film;
  37
  38 class ContentProperty
  39 {
  40 public:
  41         static int const START;
  42         static int const LENGTH;
  43 };
  44
  45 class Content : public boost::enable_shared_from_this<Content>
  46 {
  47 public:
  48         Content (boost::shared_ptr<const Film>, Time);
  49         Content (boost::shared_ptr<const Film>, boost::filesystem::path);
  50         Content (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
  51         Content (Content const &);
  52         virtual ~Content () {}
  53
  54         virtual void examine (boost::shared_ptr<Job>);
  55         virtual std::string summary () const = 0;
  56         virtual std::string information () const = 0;
  57         virtual void as_xml (xmlpp::Node *) const;
  58         virtual boost::shared_ptr<Content> clone () const = 0;
  59         virtual Time length () const = 0;
  60
  61         boost::filesystem::path file () const {
  62                 boost::mutex::scoped_lock lm (_mutex);
  63                 return _file;
  64         }
  65
  66         /** @return MD5 digest of the content's file */
  67         std::string digest () const {
  68                 boost::mutex::scoped_lock lm (_mutex);
  69                 return _digest;
  70         }
  71
  72         void set_start (Time);
  73
  74         Time start () const {
  75                 boost::mutex::scoped_lock lm (_mutex);
  76                 return _start;
  77         }
  78
  79         Time end () const {
  80                 return start() + length();
  81         }
  82
  83         void set_change_signals_frequent (bool f) {
  84                 _change_signals_frequent = f;
  85         }
  86
  87         boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
  88
  89 protected:
  90         void signal_changed (int);
  91
  92         boost::weak_ptr<const Film> _film;
  93         mutable boost::mutex _mutex;
  94
  95 private:
  96         boost::filesystem::path _file;
  97         std::string _digest;
  98         Time _start;
  99         bool _change_signals_frequent;
 100 };
 101
 102 #endif