Rename some variables.
[dcpomatic.git] / src / lib / j2k_image_proxy.h
1 /*
2     Copyright (C) 2015 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
6     DCP-o-matic is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     DCP-o-matic is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
18
19 */
20
21 #include "image_proxy.h"
22 #include <dcp/util.h>
23 #include <dcp/data.h>
24
25 namespace dcp {
26         class MonoPictureFrame;
27         class StereoPictureFrame;
28 }
29
30 class J2KImageProxy : public ImageProxy
31 {
32 public:
33         J2KImageProxy (boost::filesystem::path path, dcp::Size, AVPixelFormat pixel_format);
34         J2KImageProxy (boost::shared_ptr<const dcp::MonoPictureFrame> frame, dcp::Size, AVPixelFormat pixel_format);
35         J2KImageProxy (boost::shared_ptr<const dcp::StereoPictureFrame> frame, dcp::Size, dcp::Eye, AVPixelFormat pixel_format);
36         J2KImageProxy (boost::shared_ptr<cxml::Node> xml, boost::shared_ptr<Socket> socket);
37
38         boost::shared_ptr<Image> image (
39                 boost::optional<dcp::NoteHandler> note = boost::optional<dcp::NoteHandler> (),
40                 boost::optional<dcp::Size> size = boost::optional<dcp::Size> ()
41                 ) const;
42
43         void add_metadata (xmlpp::Node *) const;
44         void send_binary (boost::shared_ptr<Socket>) const;
45         /** @return true if our image is definitely the same as another, false if it is probably not */
46         bool same (boost::shared_ptr<const ImageProxy>) const;
47         AVPixelFormat pixel_format () const {
48                 return _pixel_format;
49         }
50
51         dcp::Data j2k () const {
52                 return _data;
53         }
54
55         dcp::Size size () const {
56                 return _size;
57         }
58
59 private:
60         friend struct client_server_test_j2k;
61
62         /* For tests */
63         J2KImageProxy (dcp::Data data, dcp::Size size, AVPixelFormat pixel_format);
64
65         dcp::Data _data;
66         dcp::Size _size;
67         boost::optional<dcp::Eye> _eye;
68         mutable boost::shared_ptr<dcp::OpenJPEGImage> _decompressed;
69         mutable boost::optional<dcp::Size> _target_size;
70         AVPixelFormat _pixel_format;
71 };