Add comment.
[libdcp.git] / src / reel.cc
index f7f267e409f954ecd6a4849f395ce8231ce2ba9b..a159ce74b7b7e6e57889bf87b248f38b10184c8d 100644 (file)
@@ -1,20 +1,34 @@
 /*
-    Copyright (C) 2014-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2017 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of libdcp.
+
+    libdcp 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,
+    libdcp 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 libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
 #include "reel.h"
 #include "decrypted_kdm_key.h"
 #include "decrypted_kdm.h"
 #include "interop_subtitle_asset.h"
+#include "smpte_subtitle_asset.h"
 #include "reel_atmos_asset.h"
+#include "reel_closed_caption_asset.h"
 #include <libxml++/nodes/element.h>
+#include <boost/foreach.hpp>
 
 using std::string;
 using std::list;
@@ -67,7 +84,16 @@ Reel::Reel (boost::shared_ptr<const cxml::Node> node)
                _main_subtitle.reset (new ReelSubtitleAsset (main_subtitle));
        }
 
-       shared_ptr<cxml::Node> atmos = asset_list->optional_node_child ("axd:AuxData");
+       /* XXX: it's not ideal that we silently tolerate Interop or SMPTE nodes here */
+       shared_ptr<cxml::Node> closed_caption = asset_list->optional_node_child ("MainClosedCaption");
+       if (!closed_caption) {
+               closed_caption = asset_list->optional_node_child ("ClosedCaption");
+       }
+       if (closed_caption) {
+               _closed_caption.reset (new ReelClosedCaptionAsset (closed_caption));
+       }
+
+       shared_ptr<cxml::Node> atmos = asset_list->optional_node_child ("AuxData");
        if (atmos) {
                _atmos.reset (new ReelAtmosAsset (atmos));
        }
@@ -96,6 +122,10 @@ Reel::write_to_cpl (xmlpp::Element* node, Standard standard) const
                _main_subtitle->write_to_cpl (asset_list, standard);
        }
 
+       if (_closed_caption) {
+               _closed_caption->write_to_cpl (asset_list, standard);
+       }
+
        if (_main_picture && dynamic_pointer_cast<ReelStereoPictureAsset> (_main_picture)) {
                /* ... but stereo pictures must come after */
                _main_picture->write_to_cpl (asset_list, standard);
@@ -136,6 +166,10 @@ Reel::equals (boost::shared_ptr<const Reel> other, EqualityOptions opt, NoteHand
                return false;
        }
 
+       if (_closed_caption && !_closed_caption->equals (other->_closed_caption, opt, note)) {
+               return false;
+       }
+
        if ((_atmos && !other->_atmos) || (!_atmos && other->_atmos)) {
                note (DCP_ERROR, "Reel: assets differ");
                return false;
@@ -154,6 +188,8 @@ Reel::encrypted () const
        return (
                (_main_picture && _main_picture->encrypted ()) ||
                (_main_sound && _main_sound->encrypted ()) ||
+               (_main_subtitle && _main_subtitle->encrypted ()) ||
+               (_closed_caption && _closed_caption->encrypted ()) ||
                (_atmos && _atmos->encrypted ())
                );
 }
@@ -164,13 +200,25 @@ Reel::add (DecryptedKDM const & kdm)
        list<DecryptedKDMKey> keys = kdm.keys ();
 
        for (list<DecryptedKDMKey>::iterator i = keys.begin(); i != keys.end(); ++i) {
-               if (i->id() == _main_picture->key_id()) {
+               if (_main_picture && i->id() == _main_picture->key_id()) {
                        _main_picture->asset()->set_key (i->key ());
                }
-               if (i->id() == _main_sound->key_id()) {
+               if (_main_sound && i->id() == _main_sound->key_id()) {
                        _main_sound->asset()->set_key (i->key ());
                }
-               if (i->id() == _atmos->key_id()) {
+               if (_main_subtitle && i->id() == _main_subtitle->key_id()) {
+                       shared_ptr<SMPTESubtitleAsset> s = dynamic_pointer_cast<SMPTESubtitleAsset> (_main_subtitle->asset());
+                       if (s) {
+                               s->set_key (i->key ());
+                       }
+               }
+               if (_closed_caption && i->id() == _closed_caption->key_id()) {
+                       shared_ptr<SMPTESubtitleAsset> s = dynamic_pointer_cast<SMPTESubtitleAsset> (_closed_caption->asset());
+                       if (s) {
+                               s->set_key (i->key ());
+                       }
+               }
+               if (_atmos && i->id() == _atmos->key_id()) {
                        _atmos->asset()->set_key (i->key ());
                }
        }
@@ -182,6 +230,7 @@ Reel::add (shared_ptr<ReelAsset> asset)
        shared_ptr<ReelPictureAsset> p = dynamic_pointer_cast<ReelPictureAsset> (asset);
        shared_ptr<ReelSoundAsset> so = dynamic_pointer_cast<ReelSoundAsset> (asset);
        shared_ptr<ReelSubtitleAsset> su = dynamic_pointer_cast<ReelSubtitleAsset> (asset);
+       shared_ptr<ReelClosedCaptionAsset> c = dynamic_pointer_cast<ReelClosedCaptionAsset> (asset);
        shared_ptr<ReelAtmosAsset> a = dynamic_pointer_cast<ReelAtmosAsset> (asset);
        if (p) {
                _main_picture = p;
@@ -189,6 +238,8 @@ Reel::add (shared_ptr<ReelAsset> asset)
                _main_sound = so;
        } else if (su) {
                _main_subtitle = su;
+       } else if (c) {
+               _closed_caption = c;
        } else if (a) {
                _atmos = a;
        }
@@ -209,9 +260,23 @@ Reel::resolve_refs (list<shared_ptr<Asset> > assets)
                _main_subtitle->asset_ref().resolve (assets);
 
                /* Interop subtitle handling is all special cases */
-               shared_ptr<InteropSubtitleAsset> iop = dynamic_pointer_cast<InteropSubtitleAsset> (_main_subtitle->asset_ref().asset ());
-               if (iop) {
-                       iop->resolve_fonts (assets);
+               if (_main_subtitle->asset_ref().resolved()) {
+                       shared_ptr<InteropSubtitleAsset> iop = dynamic_pointer_cast<InteropSubtitleAsset> (_main_subtitle->asset_ref().asset());
+                       if (iop) {
+                               iop->resolve_fonts (assets);
+                       }
+               }
+       }
+
+       if (_closed_caption) {
+               _closed_caption->asset_ref().resolve(assets);
+
+               /* Interop subtitle handling is all special cases */
+               if (_closed_caption->asset_ref().resolved()) {
+                       shared_ptr<InteropSubtitleAsset> iop = dynamic_pointer_cast<InteropSubtitleAsset> (_closed_caption->asset_ref().asset());
+                       if (iop) {
+                               iop->resolve_fonts (assets);
+                       }
                }
        }
 
@@ -234,6 +299,9 @@ Reel::duration () const
        if (_main_subtitle) {
                d = max (d, _main_subtitle->duration ());
        }
+       if (_closed_caption) {
+               d = max (d, _closed_caption->duration ());
+       }
        if (_atmos) {
                d = max (d, _atmos->duration ());
        }