1 /* This file is part of the Pangolin Project.
2 * http://github.com/stevenlovegrove/Pangolin
3 *
4 * Copyright (c) 2011-2013 Steven Lovegrove
5 *
6 * Permission is hereby granted, free of charge, to any person
7 * obtaining a copy of this software and associated documentation
8 * files (the "Software"), to deal in the Software without
9 * restriction, including without limitation the rights to use,
10 * copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following
13 * conditions:
14 *
15 * The above copyright notice and this permission notice shall be
16 * included in all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25 * OTHER DEALINGS IN THE SOFTWARE.
26 */
27
28 #pragma once
29
30 #include <pangolin/platform.h>
31 #include <string>
32
33 namespace pangolin
34 {
35
36 struct PANGOLIN_EXPORT PixelFormat
37 {
38 // Previously, VideoInterface::PixFormat returned a string.
39 // For compatibility, make this string convertable
stringPixelFormat40 inline operator std::string() const { return format; }
41
42 std::string format;
43 unsigned int channels;
44 unsigned int channel_bits[4]; //Of the data type
45 unsigned int bpp; //Of the data type
46 unsigned int channel_bit_depth; //Of the data
47 bool planar;
48 };
49
50
51 //! Return Pixel Format properties given string specification in
52 //! FFMPEG notation.
53 PANGOLIN_EXPORT
54 PixelFormat PixelFormatFromString(const std::string& format);
55
56 ////////////////////////////////////////////////////////////////////
57 /// Deprecated aliases for above
58
59 PANGOLIN_DEPRECATED
60 typedef PixelFormat VideoPixelFormat;
61 PANGOLIN_DEPRECATED
VideoFormatFromString(const std::string & format)62 inline PixelFormat VideoFormatFromString(const std::string& format) {
63 return PixelFormatFromString(format);
64 }
65
66 }
67