332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync/**********************************************************
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * Copyright 2007-2009 VMware, Inc. All rights reserved.
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * Permission is hereby granted, free of charge, to any person
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * obtaining a copy of this software and associated documentation
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * files (the "Software"), to deal in the Software without
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * restriction, including without limitation the rights to use, copy,
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * modify, merge, publish, distribute, sublicense, and/or sell copies
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * of the Software, and to permit persons to whom the Software is
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * furnished to do so, subject to the following conditions:
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * The above copyright notice and this permission notice shall be
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * included in all copies or substantial portions of the Software.
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * SOFTWARE.
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync **********************************************************/
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/*
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * svga_overlay.h --
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * Definitions for video-overlay support.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync#ifndef _SVGA_OVERLAY_H_
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync#define _SVGA_OVERLAY_H_
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync#include "svga_reg.h"
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync/*
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * Video formats we support
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync */
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync#define VMWARE_FOURCC_YV12 0x32315659 // 'Y' 'V' '1' '2'
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync#define VMWARE_FOURCC_YUY2 0x32595559 // 'Y' 'U' 'Y' '2'
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync#define VMWARE_FOURCC_UYVY 0x59565955 // 'U' 'Y' 'V' 'Y'
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsynctypedef enum {
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync SVGA_OVERLAY_FORMAT_INVALID = 0,
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync SVGA_OVERLAY_FORMAT_YV12 = VMWARE_FOURCC_YV12,
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync SVGA_OVERLAY_FORMAT_YUY2 = VMWARE_FOURCC_YUY2,
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync SVGA_OVERLAY_FORMAT_UYVY = VMWARE_FOURCC_UYVY
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync} SVGAOverlayFormat;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync#define SVGA_VIDEO_COLORKEY_MASK 0x00ffffff
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync#define SVGA_ESCAPE_VMWARE_VIDEO 0x00020000
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync#define SVGA_ESCAPE_VMWARE_VIDEO_SET_REGS 0x00020001
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync /* FIFO escape layout:
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * Type, Stream Id, (Register Id, Value) pairs */
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync#define SVGA_ESCAPE_VMWARE_VIDEO_FLUSH 0x00020002
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync /* FIFO escape layout:
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * Type, Stream Id */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsynctypedef
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsyncstruct SVGAEscapeVideoSetRegs {
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync struct {
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync uint32_t cmdType;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync uint32_t streamId;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync } header;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync // May include zero or more items.
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync struct {
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync uint32_t registerId;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync uint32_t value;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync } items[1];
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync} SVGAEscapeVideoSetRegs;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsynctypedef
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsyncstruct SVGAEscapeVideoFlush {
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync uint32_t cmdType;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync uint32_t streamId;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync} SVGAEscapeVideoFlush;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync/*
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * Struct definitions for the video overlay commands built on
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * SVGAFifoCmdEscape.
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync */
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsynctypedef
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsyncstruct {
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync uint32_t command;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync uint32_t overlay;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync} SVGAFifoEscapeCmdVideoBase;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsynctypedef
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsyncstruct {
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync SVGAFifoEscapeCmdVideoBase videoCmd;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync} SVGAFifoEscapeCmdVideoFlush;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsynctypedef
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsyncstruct {
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync SVGAFifoEscapeCmdVideoBase videoCmd;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync struct {
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync uint32_t regId;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync uint32_t value;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync } items[1];
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync} SVGAFifoEscapeCmdVideoSetRegs;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsynctypedef
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsyncstruct {
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync SVGAFifoEscapeCmdVideoBase videoCmd;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync struct {
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync uint32_t regId;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync uint32_t value;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync } items[SVGA_VIDEO_NUM_REGS];
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync} SVGAFifoEscapeCmdVideoSetAllRegs;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync/*
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *----------------------------------------------------------------------
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * VMwareVideoGetAttributes --
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * Computes the size, pitches and offsets for YUV frames.
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * Results:
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * TRUE on success; otherwise FALSE on failure.
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * Side effects:
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * Pitches and offsets for the given YUV frame are put in 'pitches'
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync * and 'offsets' respectively. They are both optional though.
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *----------------------------------------------------------------------
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync */
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync#if 0
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsyncstatic INLINE Bool
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsyncVMwareVideoGetAttributes(const SVGAOverlayFormat format, // IN
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync uint32_t *width, // IN / OUT
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync uint32_t *height, // IN / OUT
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync uint32_t *size, // OUT
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync uint32_t *pitches, // OUT (optional)
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync uint32_t *offsets) // OUT (optional)
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync{
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync int tmp;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *width = (*width + 1) & ~1;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync if (offsets) {
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync offsets[0] = 0;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync }
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync switch (format) {
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync case VMWARE_FOURCC_YV12:
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *height = (*height + 1) & ~1;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *size = (*width + 3) & ~3;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync if (pitches) {
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync pitches[0] = *size;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync }
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *size *= *height;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync if (offsets) {
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync offsets[1] = *size;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync }
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync tmp = ((*width >> 1) + 3) & ~3;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync if (pitches) {
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync pitches[1] = pitches[2] = tmp;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync }
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync tmp *= (*height >> 1);
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *size += tmp;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync if (offsets) {
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync offsets[2] = *size;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync }
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *size += tmp;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync break;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync case VMWARE_FOURCC_YUY2:
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync case VMWARE_FOURCC_UYVY:
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *size = *width * 2;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync if (pitches) {
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync pitches[0] = *size;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync }
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync *size *= *height;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync break;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync default:
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync return FALSE;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync }
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync return TRUE;
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync}
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync#endif
332aaa1da374e694e37fdfe0a00bbe040e670453vboxsync#endif // _SVGA_OVERLAY_H_