Cleanup: extract HAlign to its own files.
[libdcp.git] / src / v_align.h
1 /*
2     Copyright (C) 2023 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 #ifndef LIBDCP_V_ALIGN_H
36 #define LIBDCP_V_ALIGN_H
37
38
39 #include <string>
40
41
42 namespace dcp {
43
44
45 enum class VAlign
46 {
47         /** vertical position is distance:
48          *    from top of screen to top of subtitle (for SMPTE 428-7:{2007,2010} or
49          *    from top of screen to subtitle baseline (for Interop or SMPTE 428-7:2014)
50          */
51         TOP,
52         /** vertical position is distance:
53          *    from centre of screen to centre of subtitle (for SMPTE 428-7:{2007,2010}) or
54          *    from centre of screen to subtitle baseline (for Interop or SMPTE 428-7:2014)
55          */
56         CENTER,
57         /** vertical position is distance:
58          *    from bottom of screen to bottom of subtitle (for SMPTE 428-7:{2007,2010}) or
59          *    from bottom of screen to subtitle baseline (for Interop or SMPTE 428-7:2014)
60          */
61         BOTTOM
62 };
63
64
65 extern std::string valign_to_string(VAlign a);
66 extern VAlign string_to_valign(std::string s);
67
68
69 }
70
71
72 #endif
73