Tidy API; subtitle_asset() -> asset()>
[libdcp.git] / src / reel_subtitle_asset.h
1 /*
2     Copyright (C) 2012-2015 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/reel_subtitle_asset.h
21  *  @brief ReelSubtitleAsset class.
22  */
23
24 #ifndef LIBDCP_REEL_SUBTITLE_ASSET_H
25 #define LIBDCP_REEL_SUBTITLE_ASSET_H
26
27 #include "reel_asset.h"
28 #include "subtitle_asset.h"
29
30 namespace dcp {
31
32 class SubtitleAsset;
33
34 /** @class ReelSubtitleAsset
35  *  @brief Part of a Reel's description which refers to a subtitle XML file.
36  */
37 class ReelSubtitleAsset : public ReelAsset
38 {
39 public:
40         ReelSubtitleAsset (boost::shared_ptr<SubtitleAsset> asset, Fraction edit_rate, int64_t instrinsic_duration, int64_t entry_point);
41         ReelSubtitleAsset (boost::shared_ptr<const cxml::Node>);
42
43         boost::shared_ptr<SubtitleAsset> asset () const {
44                 return boost::dynamic_pointer_cast<SubtitleAsset> (_asset_ref.object ());
45         }
46
47 private:
48         std::string cpl_node_name () const;
49 };
50
51 }
52
53 #endif