Tidying.

[libdcp.git] / src / transfer_function.h

diff --git a/src/transfer_function.h b/src/transfer_function.h
index 31a794e20f5af59877b5b9eb7855311fc2f37833..a52011ec003c844db49d1f74b466d3f2a417cdb5 100644 (file)
--- a/src/transfer_function.h
+++ b/src/transfer_function.h
@@ -1,47 +1,84 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of libdcp.
+
+    libdcp 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,
+    libdcp 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 libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
 
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
+
+/** @file  src/transfer_function.h
+ *  @brief TransferFunction class
+ */
+
+
 #ifndef LIBDCP_TRANSFER_FUNCTION_H
 #define LIBDCP_TRANSFER_FUNCTION_H
 
-#include <boost/noncopyable.hpp>
-#include <boost/shared_ptr.hpp>
+
+#include <boost/thread/mutex.hpp>
 #include <map>
+#include <memory>
+
 
 namespace dcp {
 
-class TransferFunction : public boost::noncopyable
+
+/** @class TransferFunction
+ *  @brief A transfer function represented by a lookup table.
+ */
+class TransferFunction
 {
 public:
+       TransferFunction () {}
+
+       TransferFunction (TransferFunction const&) = delete;
+       TransferFunction& operator= (TransferFunction const&) = delete;
+
        virtual ~TransferFunction ();
 
-       float const * lut (int bit_depth) const;
+       /** @return A look-up table (of size 2^bit_depth) whose values range from 0 to 1 */
+       double const * lut (int bit_depth, bool inverse) const;
 
-       virtual bool about_equal (boost::shared_ptr<const TransferFunction> other, float epsilon) const = 0;
+       virtual bool about_equal (std::shared_ptr<const TransferFunction> other, double epsilon) const = 0;
 
 protected:
-       virtual float * make_lut (int bit_depth) const = 0;
+       /** Make a LUT and return an array allocated by new */
+       virtual double * make_lut (int bit_depth, bool inverse) const = 0;
 
-private:       
-       mutable std::map<int, float*> _luts;
+private:
+       mutable std::map<std::pair<int, bool>, double*> _luts;
+       /** mutex to protect _luts */
+       mutable boost::mutex _mutex;
 };
 
+
 }
 
+
 #endif