]> git.sesse.net Git - casparcg/blob - core/video_format.h
2.1.0: Seal of appropriate classes.
[casparcg] / core / video_format.h
1 /*\r
2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>\r
3 *\r
4 * This file is part of CasparCG (www.casparcg.com).\r
5 *\r
6 * CasparCG is free software: you can redistribute it and/or modify\r
7 * it under the terms of the GNU General Public License as published by\r
8 * the Free Software Foundation, either version 3 of the License, or\r
9 * (at your option) any later version.\r
10 *\r
11 * CasparCG is distributed in the hope that it will be useful,\r
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
14 * GNU General Public License for more details.\r
15 *\r
16 * You should have received a copy of the GNU General Public License\r
17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.\r
18 *\r
19 * Author: Robert Nagy, ronag89@gmail.com\r
20 */\r
21 \r
22 #pragma once\r
23 \r
24 #include <vector>\r
25 #include <string>\r
26 \r
27 namespace caspar { namespace core {\r
28         \r
29 struct video_format \r
30\r
31         enum type\r
32         {\r
33                 pal = 0,\r
34                 ntsc,\r
35                 x576p2500,\r
36                 x720p2500,\r
37                 x720p5000,\r
38                 x720p5994,\r
39                 x720p6000,\r
40                 x1080p2397,\r
41                 x1080p2400,\r
42                 x1080i5000,\r
43                 x1080i5994,\r
44                 x1080i6000,\r
45                 x1080p2500,\r
46                 x1080p2997,\r
47                 x1080p3000,\r
48                 x1080p5000,\r
49                 invalid,\r
50                 count\r
51         };\r
52 };\r
53 \r
54 struct field_mode \r
55\r
56         enum type\r
57         {\r
58                 empty           = 0,\r
59                 lower           = 1,\r
60                 upper           = 2,\r
61                 progressive = 3 // NOTE: progressive == lower | upper;\r
62         };\r
63 \r
64         static std::wstring print(field_mode::type value)\r
65         {\r
66                 switch(value)\r
67                 {\r
68                         case progressive:\r
69                                 return L"progressive"; \r
70                         case lower:\r
71                                 return L"lower";\r
72                         case upper:\r
73                                 return L"upper";\r
74                         default:\r
75                                 return L"invalid";\r
76                 }\r
77         }\r
78 };\r
79 \r
80 struct video_format_desc sealed\r
81 {\r
82         video_format::type      format;         // video output format\r
83 \r
84         int                                     width;          // output frame width\r
85         int                                     height;         // output frame height\r
86         int                                     square_width;\r
87         int                                     square_height;\r
88         field_mode::type        field_mode;     // progressive, interlaced upper field first, interlaced lower field first\r
89         double                          fps;            // actual framerate, e.g. i50 = 25 fps, p50 = 50 fps\r
90         int                                     time_scale;\r
91         int                                     duration;\r
92         int                                     field_count;\r
93         int                                     size;           // output frame size in bytes \r
94         std::wstring            name;           // name of output format\r
95 \r
96         int                                     audio_sample_rate;\r
97         int                                     audio_channels;\r
98         std::vector<int>        audio_cadence;\r
99 \r
100         static const video_format_desc& get(video_format::type format);\r
101         static const video_format_desc& get(const std::wstring& name);\r
102         \r
103         bool operator==(const video_format_desc& lhs)\r
104         {\r
105                 return format == lhs.format;\r
106         }\r
107 \r
108         bool operator!=(const video_format_desc& lhs)\r
109         {\r
110                 return !(*this == lhs);\r
111         }\r
112 };\r
113 \r
114 inline std::wostream& operator<<(std::wostream& out, const video_format_desc& format_desc)\r
115 {\r
116         out << format_desc.name.c_str();\r
117         return out;\r
118 }\r
119 \r
120 }}