Doc tweaks.
[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 mxf_path Pathname of MXF file to create.
37          *  @param progress Signal to inform of progress.
38          *  @param fps Frames per second.
39          *  @param length Length in frames.
40          *  @param width Width of images in pixels.
41          *  @param height Height of images in pixels.
42          */
43         PictureAsset (
44                 std::vector<std::string> const & files,
45                 std::string mxf_path,
46                 sigc::signal1<void, float>* progress,
47                 int fps,
48                 int length,
49                 int width,
50                 int height
51                 );
52
53         /** Construct a PictureAsset, generating the MXF from the JPEG2000 files.
54          *  This may take some time; progress is indicated by emission of the Progress signal.
55          *  @param get_path Functor which returns a JPEG2000 file path for a given frame (frames counted from 0).
56          *  @param mxf_path Pathname of MXF file to create.
57          *  @param progress Signal to inform of progress.
58          *  @param fps Frames per second.
59          *  @param length Length in frames.
60          *  @param width Width of images in pixels.
61          *  @param height Height of images in pixels.
62          */
63         PictureAsset (
64                 sigc::slot<std::string, int> get_path,
65                 std::string mxf_path,
66                 sigc::signal1<void, float>* progress,
67                 int fps,
68                 int length,
69                 int width,
70                 int height
71                 );
72         
73         /** Write details of this asset to a CPL stream.
74          *  @param s Stream.
75          */
76         void write_to_cpl (std::ostream& s) const;
77
78 private:
79         std::string path_from_list (int f, std::vector<std::string> const & files) const;
80         void construct (sigc::slot<std::string, int>);
81         
82         /** picture width in pixels */
83         int _width;
84         /** picture height in pixels */
85         int _height;
86 };
87
88 }