1/*****************************************************************************
2 * VLD Nonstandard XvMC extension.
3 *
4 * Copyright (c) 2004 The Unichrome Project. All rights reserved.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHOR(S) OR COPYRIGHT HOLDER(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *
24 * Author: Thomas Hellstr�m, 2004.
25 */
26
27#ifndef _VLDXVMC_H
28#define _VLDXVMC_H
29
30#include <X11/Xlib.h>
31#include <X11/extensions/XvMC.h>
32#include <X11/extensions/XvMClib.h>
33
34/*
35 * New "Motion compensation type".
36 */
37
38#define XVMC_VLD 0x0020000
39
40/*
41 * Below Flags to be passed in the XvMCMpegControl structure 'flag' field.
42 */
43
44#define XVMC_PROGRESSIVE_SEQUENCE 0x00000010
45
46/*
47 * Zig-Zag Scan / Alternative Scan.
48 */
49
50#define XVMC_ZIG_ZAG_SCAN         0x00000000
51#define XVMC_ALTERNATE_SCAN       0x00000100
52
53/*
54 * Frame DCT and frame prediction are used. /
55 * Field prediction
56 */
57
58#define XVMC_PRED_DCT_FRAME       0x00000040
59#define XVMC_PRED_DCT_FIELD       0x00000000
60
61/*
62 * Top / Bottom field first
63 */
64
65#define XVMC_TOP_FIELD_FIRST      0x00000080
66#define XVMC_BOTTOM_FIELD_FIRST   0x00000000
67
68/*
69 * Motion vectors coded in intra macroblocks
70 */
71
72#define XVMC_CONCEALMENT_MOTION_VECTORS 0x00000200
73
74/*
75 * Which of two mappings between quantiser_scale_code
76 * and quantiser_scale shall apply.
77 */
78
79#define XVMC_Q_SCALE_TYPE         0x00000400
80
81/*
82 * Intra VLC Format: Bit = 0,  Bit = 1
83 * Intra blocks      B-14      B-15
84 * Non-intra blocks  B-14      B-14
85 */
86#define XVMC_INTRA_VLC_FORMAT     0x00000800
87
88/*
89 * Also XVMC_SECOND_FIELD should be set in flags if active.
90 */
91
92#define XVMC_I_PICTURE 1
93#define XVMC_P_PICTURE 2
94#define XVMC_B_PICTURE 3
95
96typedef struct _XvMCMpegControl
97{
98    unsigned BVMV_range,	       /* Backward vertical motion vector range */
99        BHMV_range,		       /* Backward horizontal motion vector range */
100        FVMV_range,		       /* Forward vertical motion vector range */
101        FHMV_range,		       /* Forward horizontal motion vector range */
102        picture_structure,	       /* XVMC_TOP_FIELD, XVMC_BOTTOM_FIELD,
103				        *  XVMC_FRAME_PICTURE
104				        */
105        intra_dc_precision,	       /* 0x00 - 0x03 corresponds to 8 to 11 bits prec. */
106        picture_coding_type,	       /* XVMC_X_PICTURE */
107        mpeg_coding,		       /* XVMC_MPEG_2 */
108        flags;			       /* See above */
109} XvMCMpegControl;
110
111/*
112 * The following function is called BEFORE starting sending slices to the
113 * lib. It grabs the decoder hardware and prepares it for coming slices.
114 * The function XvMCSyncSurface will release the hardware for other contexts
115 * in addition to it's current functionality.
116 */
117
118extern Status XvMCBeginSurface(Display * display,
119    XvMCContext * context,
120    XvMCSurface * target_surface,
121    XvMCSurface * past_surface,
122    XvMCSurface * future_surface, const XvMCMpegControl * control);
123
124/*
125 * The quantizer matrix structure. This should be filled in by the user and
126 * uploaded whenever a change is needed. The lib initializes with
127 * default matrices and will automatically load the hardware with new matrices
128 * on decoder context switches. To load data, set the corresponding load flag
129 * to true and fill in the values. The VIA MPEG2 engine only uses the
130 * intra_quantiser_matrix and the non_intra_quantiser_matrix. RFC: Are
131 * the other fields needed for future compatibility?
132 */
133
134typedef struct _XvMCQMatrix
135{
136    int load_intra_quantiser_matrix;
137    int load_non_intra_quantiser_matrix;
138    int load_chroma_intra_quantiser_matrix;
139    int load_chroma_non_intra_quantiser_matrix;
140    unsigned char intra_quantiser_matrix[64];
141    unsigned char non_intra_quantiser_matrix[64];
142    unsigned char chroma_intra_quantiser_matrix[64];
143    unsigned char chroma_non_intra_quantiser_matrix[64];
144} XvMCQMatrix;
145
146/*
147 * Upload a XvMCQMatrix structure to the clientlib.
148 * The hardware will start using it the next XvMCBeginSurface.
149 */
150
151extern Status XvMCLoadQMatrix(Display * display, XvMCContext * context,
152    const XvMCQMatrix * qmx);
153
154/*
155 * Put a slice to the decoder. The hardware will start processing it
156 * immediately.
157 */
158
159extern Status XvMCPutSlice(Display * display, XvMCContext * context,
160    char *slice, int nBytes);
161/*
162 * Put a slice without the slice start code to the decoder.
163 * The hardware will start processing it
164 * immediately. This function is for client optimization.
165 * XvMCPutSlice(display,context,slice,nBytes) is equivalent to
166 * XvMCPutSlice2(display,context,slice+4,nBytes-4,slice[3]);
167 */
168
169extern Status XvMCPutSlice2(Display * display, XvMCContext * context,
170    char *slice, int nBytes, int sliceCode);
171
172/*
173 * Debug the XvMCControl structure. For convenience only.
174 */
175
176extern void debugControl(const XvMCMpegControl * control);
177
178#endif
179