Tidy up diffing of frames a bit.
[libdcp.git] / src / picture_asset.h
1 /*
2     Copyright (C) 2012 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/picture_asset.h
21  *  @brief An asset made up of JPEG2000 files
22  */
23
24 #include <openjpeg.h>
25 #include "mxf_asset.h"
26
27 namespace libdcp
28 {
29
30 class MonoPictureFrame; 
31 class StereoPictureFrame;       
32
33 /** @brief An asset made up of JPEG2000 files */
34 class PictureAsset : public MXFAsset
35 {
36 public:
37         PictureAsset (std::string directory, std::string mxf_name, sigc::signal1<void, float>* progress, int fps, int entry_point, int length);
38         
39         /** Write details of this asset to a CPL stream.
40          *  @param s Stream.
41          */
42         void write_to_cpl (std::ostream& s) const;
43
44         std::list<std::string> equals (boost::shared_ptr<const Asset> other, EqualityOptions opt) const;
45
46         int width () const {
47                 return _width;
48         }
49
50         int height () const {
51                 return _height;
52         }
53
54 protected:      
55
56         std::list<std::string> frame_buffer_equals (
57                 int frame, EqualityOptions opt, uint8_t const * data_A, unsigned int size_A, uint8_t const * data_B, unsigned int size_B
58                 ) const;
59         
60         /** picture width in pixels */
61         int _width;
62         /** picture height in pixels */
63         int _height;
64 };
65
66 /** A 2D (monoscopic) picture asset */
67 class MonoPictureAsset : public PictureAsset
68 {
69 public:
70         /** Construct a PictureAsset, generating the MXF from the JPEG2000 files.
71          *  This may take some time; progress is indicated by emission of the Progress signal.
72          *  @param files Pathnames of JPEG2000 files, in frame order.
73          *  @param directory Directory in which to create MXF file.
74          *  @param mxf_name Name of MXF file to create.
75          *  @param progress Signal to inform of progress.
76          *  @param fps Frames per second.
77          *  @param length Length in frames.
78          *  @param width Width of images in pixels.
79          *  @param height Height of images in pixels.
80          */
81         MonoPictureAsset (
82                 std::vector<std::string> const & files,
83                 std::string directory,
84                 std::string mxf_name,
85                 sigc::signal1<void, float>* progress,
86                 int fps,
87                 int length,
88                 int width,
89                 int height
90                 );
91
92         /** Construct a PictureAsset, generating the MXF from the JPEG2000 files.
93          *  This may take some time; progress is indicated by emission of the Progress signal.
94          *  @param get_path Functor which returns a JPEG2000 file path for a given frame (frames counted from 0).
95          *  @param directory Directory in which to create MXF file.
96          *  @param mxf_name Name of MXF file to create.
97          *  @param progress Signal to inform of progress.
98          *  @param fps Frames per second.
99          *  @param length Length in frames.
100          *  @param width Width of images in pixels.
101          *  @param height Height of images in pixels.
102          */
103         MonoPictureAsset (
104                 sigc::slot<std::string, int> get_path,
105                 std::string directory,
106                 std::string mxf_name,
107                 sigc::signal1<void, float>* progress,
108                 int fps,
109                 int length,
110                 int width,
111                 int height
112                 );
113
114         MonoPictureAsset (std::string directory, std::string mxf_name, int fps, int entry_point, int length);
115         
116         boost::shared_ptr<const MonoPictureFrame> get_frame (int n) const;
117         std::list<std::string> equals (boost::shared_ptr<const Asset> other, EqualityOptions opt) const;
118
119 private:
120         std::string path_from_list (int f, std::vector<std::string> const & files) const;
121         void construct (sigc::slot<std::string, int>);
122 };
123
124 /** A 3D (stereoscopic) picture asset */        
125 class StereoPictureAsset : public PictureAsset
126 {
127 public:
128         StereoPictureAsset (std::string directory, std::string mxf_name, int fps, int entry_point, int length);
129         
130         boost::shared_ptr<const StereoPictureFrame> get_frame (int n) const;
131         std::list<std::string> equals (boost::shared_ptr<const Asset> other, EqualityOptions opt) const;
132 };
133         
134
135 }