Merge branch '1.0' of ssh://main.carlh.net/home/carl/git/libdcp into 1.0
[libdcp.git] / src / transfer_function.h
1 /*
2     Copyright (C) 2012-2014 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/transfer_function.h
21  *  @brief TransferFunction class.
22  */
23
24 #ifndef LIBDCP_TRANSFER_FUNCTION_H
25 #define LIBDCP_TRANSFER_FUNCTION_H
26
27 #include <boost/noncopyable.hpp>
28 #include <boost/shared_ptr.hpp>
29 #include <boost/thread/mutex.hpp>
30 #include <map>
31
32 namespace dcp {
33
34 /** @class TransferFunction
35  *  @brief A transfer function represented by a lookup table.
36  */
37 class TransferFunction : public boost::noncopyable
38 {
39 public:
40         virtual ~TransferFunction ();
41
42         /** @return A look-up table (of size 2^bit_depth) whose values range from 0 to 1 */
43         double const * lut (int bit_depth, bool inverse) const;
44
45         virtual bool about_equal (boost::shared_ptr<const TransferFunction> other, double epsilon) const = 0;
46
47 protected:
48         /** Make a LUT and return an array allocated by new */
49         virtual double * make_lut (int bit_depth, bool inverse) const = 0;
50
51 private:
52         mutable std::map<std::pair<int, bool>, double*> _luts;
53         /** mutex to protect _luts */
54         mutable boost::mutex _mutex;
55 };
56
57 }
58
59 #endif