Rename SafeStringStream -> locked_stringstream. Bump deps for removal of stringstream.

[dcpomatic.git] / src / lib / dcp_video.h

diff --git a/src/lib/dcp_video.h b/src/lib/dcp_video.h
index 75823f31d97118439ef9db5f59c21912ecdccf93..32cd1a1699ac56382ee547c04830af88b0808777 100644 (file)
--- a/src/lib/dcp_video.h
+++ b/src/lib/dcp_video.h
@@ -1,65 +1,72 @@
 /*
-    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
-extern "C" {
-#include <libavutil/avutil.h>
-}
-#include <boost/shared_ptr.hpp>
 #include "types.h"
-#include "colour_conversion.h"
-#include "position.h"
-#include "position_image.h"
+#include "encode_server_description.h"
+#include <libcxml/cxml.h>
+#include <dcp/data.h>
+
+/** @file  src/dcp_video_frame.h
+ *  @brief A single frame of video destined for a DCP.
+ */
 
-class Image;
-class Scaler;
+class Log;
+class PlayerVideo;
 
 /** @class DCPVideo
+ *  @brief A single frame of video destined for a DCP.
  *
- *  A ContentVideo image with:
- *     - content parameters (crop, scaling, colour conversion)
- *     - merged content (subtitles)
- *  and with its time converted from a ContentTime to a DCPTime.
+ *  Given an Image and some settings, this class knows how to encode
+ *  the image to J2K either on the local host or on a remote server.
+ *
+ *  Objects of this class are used for the queue that we keep
+ *  of images that require encoding.
  */
-class DCPVideo
+class DCPVideo : public boost::noncopyable
 {
 public:
-       DCPVideo (boost::shared_ptr<const Image>, Eyes eyes, Crop, dcp::Size, dcp::Size, Scaler const *, ColourConversion conversion, DCPTime time);
+       DCPVideo (boost::shared_ptr<const PlayerVideo>, int, int, int, Resolution, boost::shared_ptr<Log>);
+       DCPVideo (boost::shared_ptr<const PlayerVideo>, cxml::ConstNodePtr, boost::shared_ptr<Log>);
 
-       void set_subtitle (PositionImage);
-       boost::shared_ptr<Image> image (AVPixelFormat, bool) const;
+       dcp::Data encode_locally (dcp::NoteHandler note);
+       dcp::Data encode_remotely (EncodeServerDescription, int timeout = 30);
 
-       Eyes eyes () const {
-               return _eyes;
+       int index () const {
+               return _index;
        }
 
-       ColourConversion conversion () const {
-               return _conversion;
-       }
+       Eyes eyes () const;
+
+       bool same (boost::shared_ptr<const DCPVideo> other) const;
+
+       static boost::shared_ptr<dcp::OpenJPEGImage> convert_to_xyz (boost::shared_ptr<const PlayerVideo> frame, dcp::NoteHandler note);
 
 private:
-       boost::shared_ptr<const Image> _in;
-       Eyes _eyes;
-       Crop _crop;
-       dcp::Size _inter_size;
-       dcp::Size _out_size;
-       Scaler const * _scaler;
-       ColourConversion _conversion;
-       DCPTime _time;
-       PositionImage _subtitle;
+
+       void add_metadata (xmlpp::Element *) const;
+
+       boost::shared_ptr<const PlayerVideo> _frame;
+       int _index;                      ///< frame index within the DCP's intrinsic duration
+       int _frames_per_second;          ///< Frames per second that we will use for the DCP
+       int _j2k_bandwidth;              ///< J2K bandwidth to use
+       Resolution _resolution;          ///< Resolution (2K or 4K)
+
+       boost::shared_ptr<Log> _log; ///< log
 };