1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */
2 /**********************************************************
3 * Copyright 2007-2015 VMware, Inc.
5 * Permission is hereby granted, free of charge, to any person
6 * obtaining a copy of this software and associated documentation
7 * files (the "Software"), to deal in the Software without
8 * restriction, including without limitation the rights to use, copy,
9 * modify, merge, publish, distribute, sublicense, and/or sell copies
10 * of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
20 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 **********************************************************/
30 * Definitions for video-overlay support.
33 #ifndef _SVGA_OVERLAY_H_
34 #define _SVGA_OVERLAY_H_
39 * Video formats we support
42 #define VMWARE_FOURCC_YV12 0x32315659 /* 'Y' 'V' '1' '2' */
43 #define VMWARE_FOURCC_YUY2 0x32595559 /* 'Y' 'U' 'Y' '2' */
44 #define VMWARE_FOURCC_UYVY 0x59565955 /* 'U' 'Y' 'V' 'Y' */
47 SVGA_OVERLAY_FORMAT_INVALID = 0,
48 SVGA_OVERLAY_FORMAT_YV12 = VMWARE_FOURCC_YV12,
49 SVGA_OVERLAY_FORMAT_YUY2 = VMWARE_FOURCC_YUY2,
50 SVGA_OVERLAY_FORMAT_UYVY = VMWARE_FOURCC_UYVY,
53 #define SVGA_VIDEO_COLORKEY_MASK 0x00ffffff
55 #define SVGA_ESCAPE_VMWARE_VIDEO 0x00020000
57 #define SVGA_ESCAPE_VMWARE_VIDEO_SET_REGS 0x00020001
58 /* FIFO escape layout:
59 * Type, Stream Id, (Register Id, Value) pairs */
61 #define SVGA_ESCAPE_VMWARE_VIDEO_FLUSH 0x00020002
62 /* FIFO escape layout:
66 struct SVGAEscapeVideoSetRegs {
72 /* May include zero or more items. */
77 } SVGAEscapeVideoSetRegs;
80 struct SVGAEscapeVideoFlush {
83 } SVGAEscapeVideoFlush;
87 * Struct definitions for the video overlay commands built on
94 } SVGAFifoEscapeCmdVideoBase;
98 SVGAFifoEscapeCmdVideoBase videoCmd;
99 } SVGAFifoEscapeCmdVideoFlush;
103 SVGAFifoEscapeCmdVideoBase videoCmd;
108 } SVGAFifoEscapeCmdVideoSetRegs;
112 SVGAFifoEscapeCmdVideoBase videoCmd;
116 } items[SVGA_VIDEO_NUM_REGS];
117 } SVGAFifoEscapeCmdVideoSetAllRegs;
121 *----------------------------------------------------------------------
123 * VMwareVideoGetAttributes --
125 * Computes the size, pitches and offsets for YUV frames.
128 * TRUE on success; otherwise FALSE on failure.
131 * Pitches and offsets for the given YUV frame are put in 'pitches'
132 * and 'offsets' respectively. They are both optional though.
134 *----------------------------------------------------------------------
138 VMwareVideoGetAttributes(const SVGAOverlayFormat format, /* IN */
139 uint32 *width, /* IN / OUT */
140 uint32 *height, /* IN / OUT */
141 uint32 *size, /* OUT */
142 uint32 *pitches, /* OUT (optional) */
143 uint32 *offsets) /* OUT (optional) */
147 *width = (*width + 1) & ~1;
154 case VMWARE_FOURCC_YV12:
155 *height = (*height + 1) & ~1;
156 *size = (*width) * (*height);
169 pitches[1] = pitches[2] = tmp;
172 tmp *= (*height >> 1);
182 case VMWARE_FOURCC_YUY2:
183 case VMWARE_FOURCC_UYVY:
200 #endif /* _SVGA_OVERLAY_H_ */