src/mono_picture_asset.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34
  35 /** @file  src/mono_picture_asset.cc
  36  *  @brief MonoPictureAsset class
  37  */
  38
  39
  40 #ifndef LIBDCP_MONO_PICTURE_ASSET_H
  41 #define LIBDCP_MONO_PICTURE_ASSET_H
  42
  43
  44 #include "picture_asset.h"
  45 #include "mono_picture_asset_reader.h"
  46
  47
  48 namespace dcp {
  49
  50
  51 class MonoPictureAssetWriter;
  52
  53
  54 /** @class MonoPictureAsset
  55  *  @brief A 2D (monoscopic) picture asset
  56  */
  57 class MonoPictureAsset : public PictureAsset
  58 {
  59 public:
  60         /** Create a MonoPictureAsset by reading a file.
  61          *  @param file Asset file to read.
  62          */
  63         explicit MonoPictureAsset (boost::filesystem::path file);
  64
  65         /** Create a MonoPictureAsset with a given edit rate.
  66          *  @param edit_rate Edit rate (i.e. frame rate) in frames per second.
  67          *  @param standard DCP standard (INTEROP or SMPTE).
  68          */
  69         explicit MonoPictureAsset (Fraction edit_rate, Standard standard);
  70
  71         /** Start a progressive write to a MonoPictureAsset */
  72         std::shared_ptr<PictureAssetWriter> start_write (boost::filesystem::path, bool);
  73         std::shared_ptr<MonoPictureAssetReader> start_read () const;
  74
  75         bool equals (
  76                 std::shared_ptr<const Asset> other,
  77                 EqualityOptions opt,
  78                 NoteHandler note
  79                 ) const;
  80
  81 private:
  82         std::string cpl_node_name () const;
  83 };
  84
  85 }
  86
  87 #endif