]> git.sesse.net Git - casparcg/blob - core/video_format.h
Subtree merge of old SVN "docs" folder into the "master" git branch. You can see...
[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                 x720p2398,\r
39                 x720p2400,\r
40                 x720p2997,\r
41                 x720p5994,\r
42                 x720p3000,\r
43                 x720p6000,\r
44                 x1080p2398,\r
45                 x1080p2400,\r
46                 x1080i5000,\r
47                 x1080i5994,\r
48                 x1080i6000,\r
49                 x1080p2500,\r
50                 x1080p2997,\r
51                 x1080p3000,\r
52                 x1080p5000,\r
53                 x1080p5994,\r
54                 x1080p6000,\r
55                 invalid,\r
56                 count\r
57         };\r
58 };\r
59 \r
60 struct field_mode \r
61\r
62         enum type\r
63         {\r
64                 empty           = 0,\r
65                 lower           = 1,\r
66                 upper           = 2,\r
67                 progressive = 3 // NOTE: progressive == lower | upper;\r
68         };\r
69 \r
70         static std::wstring print(field_mode::type value)\r
71         {\r
72                 switch(value)\r
73                 {\r
74                         case progressive:\r
75                                 return L"progressive"; \r
76                         case lower:\r
77                                 return L"lower";\r
78                         case upper:\r
79                                 return L"upper";\r
80                         default:\r
81                                 return L"invalid";\r
82                 }\r
83         }\r
84 };\r
85 \r
86 struct video_format_desc\r
87 {\r
88         video_format::type              format;         // video output format\r
89 \r
90         size_t                                  width;          // output frame width\r
91         size_t                                  height;         // output frame height\r
92         size_t                                  square_width;\r
93         size_t                                  square_height;\r
94         field_mode::type                field_mode;     // progressive, interlaced upper field first, interlaced lower field first\r
95         double                                  fps;            // actual framerate, e.g. i50 = 25 fps, p50 = 50 fps\r
96         size_t                                  time_scale;\r
97         size_t                                  duration;\r
98         size_t                                  field_count;\r
99         size_t                                  size;           // output frame size in bytes \r
100         std::wstring                    name;           // name of output format\r
101 \r
102         size_t                                  audio_sample_rate;\r
103         size_t                                  audio_channels;\r
104         std::vector<size_t>             audio_cadence;\r
105 \r
106         static const video_format_desc& get(video_format::type format);\r
107         static const video_format_desc& get(const std::wstring& name);\r
108         \r
109         bool operator==(const video_format_desc& lhs)\r
110         {\r
111                 return format == lhs.format;\r
112         }\r
113 \r
114         bool operator!=(const video_format_desc& lhs)\r
115         {\r
116                 return !(*this == lhs);\r
117         }\r
118 };\r
119 \r
120 inline std::wostream& operator<<(std::wostream& out, const video_format_desc& format_desc)\r
121 {\r
122         out << format_desc.name.c_str();\r
123         return out;\r
124 }\r
125 \r
126 }}