• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  *  Copyright 2011 The LibYuv Project Authors. All rights reserved.
3  *
4  *  Use of this source code is governed by a BSD-style license
5  *  that can be found in the LICENSE file in the root of the source
6  *  tree. An additional intellectual property rights grant can be found
7  *  in the file PATENTS. All contributing project authors may
8  *  be found in the AUTHORS file in the root of the source tree.
9  */
10 
11 // Common definitions for video, including fourcc and VideoFormat.
12 
13 #ifndef INCLUDE_LIBYUV_VIDEO_COMMON_H_
14 #define INCLUDE_LIBYUV_VIDEO_COMMON_H_
15 
16 #include "libyuv/basic_types.h"
17 
18 #ifdef __cplusplus
19 namespace libyuv {
20 extern "C" {
21 #endif
22 
23 //////////////////////////////////////////////////////////////////////////////
24 // Definition of FourCC codes
25 //////////////////////////////////////////////////////////////////////////////
26 
27 // Convert four characters to a FourCC code.
28 // Needs to be a macro otherwise the OS X compiler complains when the kFormat*
29 // constants are used in a switch.
30 #ifdef __cplusplus
31 #define FOURCC(a, b, c, d)                                        \
32   ((static_cast<uint32_t>(a)) | (static_cast<uint32_t>(b) << 8) | \
33    (static_cast<uint32_t>(c) << 16) | /* NOLINT */                \
34    (static_cast<uint32_t>(d) << 24))  /* NOLINT */
35 #else
36 #define FOURCC(a, b, c, d)                                     \
37   (((uint32_t)(a)) | ((uint32_t)(b) << 8) |       /* NOLINT */ \
38    ((uint32_t)(c) << 16) | ((uint32_t)(d) << 24)) /* NOLINT */
39 #endif
40 
41 // Some pages discussing FourCC codes:
42 //   http://www.fourcc.org/yuv.php
43 //   http://v4l2spec.bytesex.org/spec/book1.htm
44 //   http://developer.apple.com/quicktime/icefloe/dispatch020.html
45 //   http://msdn.microsoft.com/library/windows/desktop/dd206750.aspx#nv12
46 //   http://people.xiph.org/~xiphmont/containers/nut/nut4cc.txt
47 
48 // FourCC codes grouped according to implementation efficiency.
49 // Primary formats should convert in 1 efficient step.
50 // Secondary formats are converted in 2 steps.
51 // Auxilliary formats call primary converters.
52 enum FourCC {
53   // 10 Primary YUV formats: 5 planar, 2 biplanar, 2 packed.
54   FOURCC_I420 = FOURCC('I', '4', '2', '0'),
55   FOURCC_I422 = FOURCC('I', '4', '2', '2'),
56   FOURCC_I444 = FOURCC('I', '4', '4', '4'),
57   FOURCC_I400 = FOURCC('I', '4', '0', '0'),
58   FOURCC_NV21 = FOURCC('N', 'V', '2', '1'),
59   FOURCC_NV12 = FOURCC('N', 'V', '1', '2'),
60   FOURCC_YUY2 = FOURCC('Y', 'U', 'Y', '2'),
61   FOURCC_UYVY = FOURCC('U', 'Y', 'V', 'Y'),
62   FOURCC_I010 = FOURCC('I', '0', '1', '0'),  // bt.601 10 bit 420
63   FOURCC_I210 = FOURCC('I', '2', '1', '0'),  // bt.601 10 bit 422
64 
65   // 1 Secondary YUV format: row biplanar.  deprecated.
66   FOURCC_M420 = FOURCC('M', '4', '2', '0'),
67 
68   // 13 Primary RGB formats: 4 32 bpp, 2 24 bpp, 3 16 bpp, 1 10 bpc 2 64 bpp
69   FOURCC_ARGB = FOURCC('A', 'R', 'G', 'B'),
70   FOURCC_BGRA = FOURCC('B', 'G', 'R', 'A'),
71   FOURCC_ABGR = FOURCC('A', 'B', 'G', 'R'),
72   FOURCC_AR30 = FOURCC('A', 'R', '3', '0'),  // 10 bit per channel. 2101010.
73   FOURCC_AB30 = FOURCC('A', 'B', '3', '0'),  // ABGR version of 10 bit
74   FOURCC_AR64 = FOURCC('A', 'R', '6', '4'),  // 16 bit per channel.
75   FOURCC_AB64 = FOURCC('A', 'B', '6', '4'),  // ABGR version of 16 bit
76   FOURCC_24BG = FOURCC('2', '4', 'B', 'G'),
77   FOURCC_RAW = FOURCC('r', 'a', 'w', ' '),
78   FOURCC_RGBA = FOURCC('R', 'G', 'B', 'A'),
79   FOURCC_RGBP = FOURCC('R', 'G', 'B', 'P'),  // rgb565 LE.
80   FOURCC_RGBO = FOURCC('R', 'G', 'B', 'O'),  // argb1555 LE.
81   FOURCC_R444 = FOURCC('R', '4', '4', '4'),  // argb4444 LE.
82 
83   // 1 Primary Compressed YUV format.
84   FOURCC_MJPG = FOURCC('M', 'J', 'P', 'G'),
85 
86   // 14 Auxiliary YUV variations: 3 with U and V planes are swapped, 1 Alias.
87   FOURCC_YV12 = FOURCC('Y', 'V', '1', '2'),
88   FOURCC_YV16 = FOURCC('Y', 'V', '1', '6'),
89   FOURCC_YV24 = FOURCC('Y', 'V', '2', '4'),
90   FOURCC_YU12 = FOURCC('Y', 'U', '1', '2'),  // Linux version of I420.
91   FOURCC_J420 =
92       FOURCC('J', '4', '2', '0'),  // jpeg (bt.601 full), unofficial fourcc
93   FOURCC_J422 =
94       FOURCC('J', '4', '2', '2'),  // jpeg (bt.601 full), unofficial fourcc
95   FOURCC_J444 =
96       FOURCC('J', '4', '4', '4'),  // jpeg (bt.601 full), unofficial fourcc
97   FOURCC_J400 =
98       FOURCC('J', '4', '0', '0'),  // jpeg (bt.601 full), unofficial fourcc
99   FOURCC_F420 = FOURCC('F', '4', '2', '0'),  // bt.709 full, unofficial fourcc
100   FOURCC_F422 = FOURCC('F', '4', '2', '2'),  // bt.709 full, unofficial fourcc
101   FOURCC_F444 = FOURCC('F', '4', '4', '4'),  // bt.709 full, unofficial fourcc
102   FOURCC_H420 = FOURCC('H', '4', '2', '0'),  // bt.709, unofficial fourcc
103   FOURCC_H422 = FOURCC('H', '4', '2', '2'),  // bt.709, unofficial fourcc
104   FOURCC_H444 = FOURCC('H', '4', '4', '4'),  // bt.709, unofficial fourcc
105   FOURCC_U420 = FOURCC('U', '4', '2', '0'),  // bt.2020, unofficial fourcc
106   FOURCC_U422 = FOURCC('U', '4', '2', '2'),  // bt.2020, unofficial fourcc
107   FOURCC_U444 = FOURCC('U', '4', '4', '4'),  // bt.2020, unofficial fourcc
108   FOURCC_F010 = FOURCC('F', '0', '1', '0'),  // bt.709 full range 10 bit 420
109   FOURCC_H010 = FOURCC('H', '0', '1', '0'),  // bt.709 10 bit 420
110   FOURCC_U010 = FOURCC('U', '0', '1', '0'),  // bt.2020 10 bit 420
111   FOURCC_F210 = FOURCC('F', '2', '1', '0'),  // bt.709 full range 10 bit 422
112   FOURCC_H210 = FOURCC('H', '2', '1', '0'),  // bt.709 10 bit 422
113   FOURCC_U210 = FOURCC('U', '2', '1', '0'),  // bt.2020 10 bit 422
114   FOURCC_P010 = FOURCC('P', '0', '1', '0'),
115   FOURCC_P210 = FOURCC('P', '2', '1', '0'),
116 
117   // 14 Auxiliary aliases.  CanonicalFourCC() maps these to canonical fourcc.
118   FOURCC_IYUV = FOURCC('I', 'Y', 'U', 'V'),  // Alias for I420.
119   FOURCC_YU16 = FOURCC('Y', 'U', '1', '6'),  // Alias for I422.
120   FOURCC_YU24 = FOURCC('Y', 'U', '2', '4'),  // Alias for I444.
121   FOURCC_YUYV = FOURCC('Y', 'U', 'Y', 'V'),  // Alias for YUY2.
122   FOURCC_YUVS = FOURCC('y', 'u', 'v', 's'),  // Alias for YUY2 on Mac.
123   FOURCC_HDYC = FOURCC('H', 'D', 'Y', 'C'),  // Alias for UYVY.
124   FOURCC_2VUY = FOURCC('2', 'v', 'u', 'y'),  // Alias for UYVY on Mac.
125   FOURCC_JPEG = FOURCC('J', 'P', 'E', 'G'),  // Alias for MJPG.
126   FOURCC_DMB1 = FOURCC('d', 'm', 'b', '1'),  // Alias for MJPG on Mac.
127   FOURCC_BA81 = FOURCC('B', 'A', '8', '1'),  // Alias for BGGR.
128   FOURCC_RGB3 = FOURCC('R', 'G', 'B', '3'),  // Alias for RAW.
129   FOURCC_BGR3 = FOURCC('B', 'G', 'R', '3'),  // Alias for 24BG.
130   FOURCC_CM32 = FOURCC(0, 0, 0, 32),  // Alias for BGRA kCMPixelFormat_32ARGB
131   FOURCC_CM24 = FOURCC(0, 0, 0, 24),  // Alias for RAW kCMPixelFormat_24RGB
132   FOURCC_L555 = FOURCC('L', '5', '5', '5'),  // Alias for RGBO.
133   FOURCC_L565 = FOURCC('L', '5', '6', '5'),  // Alias for RGBP.
134   FOURCC_5551 = FOURCC('5', '5', '5', '1'),  // Alias for RGBO.
135 
136   // deprecated formats.  Not supported, but defined for backward compatibility.
137   FOURCC_I411 = FOURCC('I', '4', '1', '1'),
138   FOURCC_Q420 = FOURCC('Q', '4', '2', '0'),
139   FOURCC_RGGB = FOURCC('R', 'G', 'G', 'B'),
140   FOURCC_BGGR = FOURCC('B', 'G', 'G', 'R'),
141   FOURCC_GRBG = FOURCC('G', 'R', 'B', 'G'),
142   FOURCC_GBRG = FOURCC('G', 'B', 'R', 'G'),
143   FOURCC_H264 = FOURCC('H', '2', '6', '4'),
144 
145   // Match any fourcc.
146   FOURCC_ANY = -1,
147 };
148 
149 enum FourCCBpp {
150   // Canonical fourcc codes used in our code.
151   FOURCC_BPP_I420 = 12,
152   FOURCC_BPP_I422 = 16,
153   FOURCC_BPP_I444 = 24,
154   FOURCC_BPP_I411 = 12,
155   FOURCC_BPP_I400 = 8,
156   FOURCC_BPP_NV21 = 12,
157   FOURCC_BPP_NV12 = 12,
158   FOURCC_BPP_YUY2 = 16,
159   FOURCC_BPP_UYVY = 16,
160   FOURCC_BPP_M420 = 12,  // deprecated
161   FOURCC_BPP_Q420 = 12,
162   FOURCC_BPP_ARGB = 32,
163   FOURCC_BPP_BGRA = 32,
164   FOURCC_BPP_ABGR = 32,
165   FOURCC_BPP_RGBA = 32,
166   FOURCC_BPP_AR30 = 32,
167   FOURCC_BPP_AB30 = 32,
168   FOURCC_BPP_AR64 = 64,
169   FOURCC_BPP_AB64 = 64,
170   FOURCC_BPP_24BG = 24,
171   FOURCC_BPP_RAW = 24,
172   FOURCC_BPP_RGBP = 16,
173   FOURCC_BPP_RGBO = 16,
174   FOURCC_BPP_R444 = 16,
175   FOURCC_BPP_RGGB = 8,
176   FOURCC_BPP_BGGR = 8,
177   FOURCC_BPP_GRBG = 8,
178   FOURCC_BPP_GBRG = 8,
179   FOURCC_BPP_YV12 = 12,
180   FOURCC_BPP_YV16 = 16,
181   FOURCC_BPP_YV24 = 24,
182   FOURCC_BPP_YU12 = 12,
183   FOURCC_BPP_J420 = 12,
184   FOURCC_BPP_J400 = 8,
185   FOURCC_BPP_H420 = 12,
186   FOURCC_BPP_H422 = 16,
187   FOURCC_BPP_I010 = 15,
188   FOURCC_BPP_I210 = 20,
189   FOURCC_BPP_H010 = 15,
190   FOURCC_BPP_H210 = 20,
191   FOURCC_BPP_P010 = 15,
192   FOURCC_BPP_P210 = 20,
193   FOURCC_BPP_MJPG = 0,  // 0 means unknown.
194   FOURCC_BPP_H264 = 0,
195   FOURCC_BPP_IYUV = 12,
196   FOURCC_BPP_YU16 = 16,
197   FOURCC_BPP_YU24 = 24,
198   FOURCC_BPP_YUYV = 16,
199   FOURCC_BPP_YUVS = 16,
200   FOURCC_BPP_HDYC = 16,
201   FOURCC_BPP_2VUY = 16,
202   FOURCC_BPP_JPEG = 1,
203   FOURCC_BPP_DMB1 = 1,
204   FOURCC_BPP_BA81 = 8,
205   FOURCC_BPP_RGB3 = 24,
206   FOURCC_BPP_BGR3 = 24,
207   FOURCC_BPP_CM32 = 32,
208   FOURCC_BPP_CM24 = 24,
209 
210   // Match any fourcc.
211   FOURCC_BPP_ANY = 0,  // 0 means unknown.
212 };
213 
214 // Converts fourcc aliases into canonical ones.
215 LIBYUV_API uint32_t CanonicalFourCC(uint32_t fourcc);
216 
217 #ifdef __cplusplus
218 }  // extern "C"
219 }  // namespace libyuv
220 #endif
221 
222 #endif  // INCLUDE_LIBYUV_VIDEO_COMMON_H_
223