Various Doxygen fixes.

[dcpomatic.git] / src / lib / playlist.cc

diff --git a/src/lib/playlist.cc b/src/lib/playlist.cc
index 41ce862b53837fa945ce6cab5cb0f6eb31230246..aa365ead4f3939c5d51264c9cc057bfbdee83a36 100644 (file)
--- a/src/lib/playlist.cc
+++ b/src/lib/playlist.cc
@@ -1,19 +1,20 @@
 /*
     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
@@ -28,7 +29,7 @@
 #include "job.h"
 #include "config.h"
 #include "util.h"
-#include "md5_digester.h"
+#include "digester.h"
 #include <libcxml/cxml.h>
 #include <libxml++/libxml++.h>
 #include <boost/shared_ptr.hpp>
@@ -153,12 +154,16 @@ Playlist::video_identifier () const
                }
        }
 
-       MD5Digester digester;
+       Digester digester;
        digester.add (t.c_str(), t.length());
        return digester.get ();
 }
 
-/** @param node <Playlist> node */
+/** @param film Film that this Playlist is for.
+ *  @param node &lt;Playlist&gt; node.
+ *  @param version Metadata version number.
+ *  @param notes Output notes about that happened.
+ */
 void
 Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
 {
@@ -172,12 +177,14 @@ Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, in
        reconnect ();
 }
 
-/** @param node <Playlist> node */
+/** @param node &lt;Playlist&gt; node.
+ *  @param with_content_paths true to include &lt;Path&gt; nodes in &lt;Content&gt; nodes, false to omit them.
+ */
 void
-Playlist::as_xml (xmlpp::Node* node)
+Playlist::as_xml (xmlpp::Node* node, bool with_content_paths)
 {
        BOOST_FOREACH (shared_ptr<Content> i, _content) {
-               i->as_xml (node->add_child ("Content"));
+               i->as_xml (node->add_child ("Content"), with_content_paths);
        }
 }
 
@@ -510,3 +517,40 @@ Playlist::required_disk_space (int j2k_bandwidth, int audio_channels, int audio_
        /* Add on 64k for bits and pieces (metadata, subs etc) */
        return video + audio + 65536;
 }
+
+string
+Playlist::content_summary (DCPTimePeriod period) const
+{
+       string best_summary;
+       int best_score = -1;
+       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+               int score = 0;
+               optional<DCPTimePeriod> const o = DCPTimePeriod(i->position(), i->end()).overlap (period);
+               if (o) {
+                       score += 100 * o.get().duration().get() / period.duration().get();
+               }
+
+               if (i->video) {
+                       score += 100;
+               }
+
+               if (score > best_score) {
+                       best_summary = i->path(0).leaf().string();
+                       best_score = score;
+               }
+       }
+
+       return best_summary;
+}
+
+bool
+Playlist::video_content_at (DCPTime time) const
+{
+       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+               if (i->video && i->position() <= time && time < i->end()) {
+                       return true;
+               }
+       }
+
+       return false;
+}