path -> dir, name for MXFs.
[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 "asset.h"
25
26 namespace libdcp
27 {
28
29 /** @brief An asset made up of JPEG2000 files */
30 class PictureAsset : public Asset
31 {
32 public:
33         /** Construct a PictureAsset, generating the MXF from the JPEG2000 files.
34          *  This may take some time; progress is indicated by emission of the Progress signal.
35          *  @param files Pathnames of JPEG2000 files, in frame order.
36          *  @param directory Directory in which to create MXF file.
37          *  @param mxf_name Name of MXF file to create.
38          *  @param progress Signal to inform of progress.
39          *  @param fps Frames per second.
40          *  @param length Length in frames.
41          *  @param width Width of images in pixels.
42          *  @param height Height of images in pixels.
43          */
44         PictureAsset (
45                 std::vector<std::string> const & files,
46                 std::string directory,
47                 std::string mxf_name,
48                 sigc::signal1<void, float>* progress,
49                 int fps,
50                 int length,
51                 int width,
52                 int height
53                 );
54
55         /** Construct a PictureAsset, generating the MXF from the JPEG2000 files.
56          *  This may take some time; progress is indicated by emission of the Progress signal.
57          *  @param get_path Functor which returns a JPEG2000 file path for a given frame (frames counted from 0).
58          *  @param directory Directory in which to create MXF file.
59          *  @param mxf_name Name of MXF file to create.
60          *  @param progress Signal to inform of progress.
61          *  @param fps Frames per second.
62          *  @param length Length in frames.
63          *  @param width Width of images in pixels.
64          *  @param height Height of images in pixels.
65          */
66         PictureAsset (
67                 sigc::slot<std::string, int> get_path,
68                 std::string directory,
69                 std::string mxf_name,
70                 sigc::signal1<void, float>* progress,
71                 int fps,
72                 int length,
73                 int width,
74                 int height
75                 );
76
77         PictureAsset (std::string directory, std::string mxf_name, int fps, int length, int width, int height);
78         
79         /** Write details of this asset to a CPL stream.
80          *  @param s Stream.
81          */
82         void write_to_cpl (std::ostream& s) const;
83
84 private:
85         std::string path_from_list (int f, std::vector<std::string> const & files) const;
86         void construct (sigc::slot<std::string, int>);
87         
88         /** picture width in pixels */
89         int _width;
90         /** picture height in pixels */
91         int _height;
92 };
93
94 }