2 Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
3 Taken from code Copyright (C) 2010-2011 Terrence Meiczinger
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #include <libdcp/picture_asset.h>
23 #include <libdcp/picture_asset_writer.h>
26 /** @file src/dcp_video_frame.h
27 * @brief A single frame of video destined for a DCP.
31 class ServerDescription;
36 class PlayerVideoFrame;
38 /** @class EncodedData
39 * @brief Container for J2K-encoded data.
41 class EncodedData : public boost::noncopyable
44 /** @param s Size of data, in bytes */
47 EncodedData (boost::filesystem::path);
49 virtual ~EncodedData ();
51 void send (boost::shared_ptr<Socket> socket);
52 void write (boost::shared_ptr<const Film>, int, Eyes) const;
53 void write_info (boost::shared_ptr<const Film>, int, Eyes, libdcp::FrameInfo) const;
56 uint8_t* data () const {
60 /** @return data size, in bytes */
66 uint8_t* _data; ///< data
67 int _size; ///< data size in bytes
70 /** @class LocallyEncodedData
71 * @brief EncodedData that was encoded locally; this class
72 * just keeps a pointer to the data, but does no memory
75 class LocallyEncodedData : public EncodedData
78 /** @param d Data (which will be copied by this class)
79 * @param s Size of data, in bytes.
81 LocallyEncodedData (uint8_t* d, int s);
84 /** @class RemotelyEncodedData
85 * @brief EncodedData that is being read from a remote server;
86 * this class allocates and manages memory for the data.
88 class RemotelyEncodedData : public EncodedData
91 RemotelyEncodedData (int s);
94 /** @class DCPVideoFrame
95 * @brief A single frame of video destined for a DCP.
97 * Given an Image and some settings, this class knows how to encode
98 * the image to J2K either on the local host or on a remote server.
100 * Objects of this class are used for the queue that we keep
101 * of images that require encoding.
103 class DCPVideoFrame : public boost::noncopyable
106 DCPVideoFrame (boost::shared_ptr<const PlayerVideoFrame>, int, int, int, Resolution, boost::shared_ptr<Log>);
107 DCPVideoFrame (boost::shared_ptr<const PlayerVideoFrame>, boost::shared_ptr<const cxml::Node>, boost::shared_ptr<Log>);
109 boost::shared_ptr<EncodedData> encode_locally ();
110 boost::shared_ptr<EncodedData> encode_remotely (ServerDescription);
120 void add_metadata (xmlpp::Element *) const;
122 boost::shared_ptr<const PlayerVideoFrame> _frame;
123 int _index; ///< frame index within the DCP's intrinsic duration
124 int _frames_per_second; ///< Frames per second that we will use for the DCP
125 int _j2k_bandwidth; ///< J2K bandwidth to use
126 Resolution _resolution; ///< Resolution (2K or 4K)
128 boost::shared_ptr<Log> _log; ///< log