Doc tweaks.
[libdcp.git] / src / metadata.h
1 /*
2     Copyright (C) 2012 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/metadata.h
21  *  @brief Metadata for writing to the DCP.
22  */
23
24 #include <string>
25
26 namespace libdcp
27 {
28
29 /** @brief A class to hold various metadata that will be written
30  *  to the DCP.
31  *
32  *  The values are initialised, and can be modified if desired.
33  */
34 class Metadata
35 {
36 public:
37         static Metadata* instance ();
38
39         std::string company_name;
40         std::string product_name;
41         std::string product_version;
42         std::string issuer;
43         std::string creator;
44         std::string issue_date;
45
46 private:
47         Metadata ();
48
49         /** Singleton instance of Metadata */
50         static Metadata* _instance;
51 };
52
53 }