Docs.

[dcpomatic.git] / src / lib / audio_mapping.h

diff --git a/src/lib/audio_mapping.h b/src/lib/audio_mapping.h
index 26087bfffa8f9e04924170444eea908640b6bced..a76d83a370f703dceded47e1d5aff6e90cd472e3 100644 (file)
--- a/src/lib/audio_mapping.h
+++ b/src/lib/audio_mapping.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -17,12 +17,17 @@
 
 */
 
+/** @file  src/lib/audio_mapping.h
+ *  @brief AudioMapping class.
+ */
+
 #ifndef DCPOMATIC_AUDIO_MAPPING_H
 #define DCPOMATIC_AUDIO_MAPPING_H
 
 #include <vector>
-#include <libdcp/types.h>
 #include <boost/shared_ptr.hpp>
+#include <dcp/types.h>
+#include <libcxml/cxml.h>
 
 namespace xmlpp {
        class Node;
@@ -32,7 +37,9 @@ namespace cxml {
        class Node;
 }
 
-/** A many-to-many mapping from some content channels to DCP channels.
+/** @class AudioMapping.
+ *  @brief A many-to-many mapping from some content channels to DCP channels.
+ *
  *  The number of content channels is set on construction and fixed,
  *  and then each of those content channels are mapped to each DCP channel
  *  by a linear gain.
@@ -41,8 +48,8 @@ class AudioMapping
 {
 public:
        AudioMapping ();
-       AudioMapping (int);
-       AudioMapping (boost::shared_ptr<const cxml::Node>, int);
+       AudioMapping (int channels);
+       AudioMapping (cxml::ConstNodePtr, int);
 
        /* Default copy constructor is fine */
        
@@ -50,12 +57,14 @@ public:
 
        void make_default ();
 
-       void set (int, libdcp::Channel, float);
-       float get (int, libdcp::Channel) const;
+       void set (int, dcp::Channel, float);
+       float get (int, dcp::Channel) const;
 
        int content_channels () const {
                return _content_channels;
        }
+
+       std::string digest () const;
        
 private:
        void setup (int);