vldXvMC.h revision 0f57e2e1 
1/*****************************************************************************
2 * VLD XvMC Nonstandard extension API.
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
33/*
34 * New "Motion compensation type".
35 */
36
37#define XVMC_VLD 0x0020000
38
39/*
40 * Below Flags to be passed in the XvMCMpegControl structure 'flag' field.
41 */
42
43#define XVMC_PROGRESSIVE_SEQUENCE 0x00000010
44
45/*
46 * Zig-Zag Scan / Alternative Scan.
47 */
48
49#define XVMC_ZIG_ZAG_SCAN         0x00000000
50#define XVMC_ALTERNATE_SCAN       0x00000100
51
52/*
53 * Frame DCT and frame prediction are used. /
54 * Field prediction
55 */
56
57#define XVMC_PRED_DCT_FRAME       0x00000040
58#define XVMC_PRED_DCT_FIELD       0x00000000
59
60/*
61 * Top / Bottom field first
62 */
63
64#define XVMC_TOP_FIELD_FIRST      0x00000080
65#define XVMC_BOTTOM_FIELD_FIRST   0x00000000
66
67/*
68 * Motion vectors coded in intra macroblocks
69 */
70
71#define XVMC_CONCEALMENT_MOTION_VECTORS 0x00000200
72
73/*
74 * Which of two mappings between quantiser_scale_code
75 * and quantiser_scale shall apply.
76 */
77
78#define XVMC_Q_SCALE_TYPE         0x00000400
79
80/*
81 * Intra VLC Format: Bit = 0,  Bit = 1
82 * Intra blocks      B-14      B-15
83 * Non-intra blocks  B-14      B-14
84 */
85#define XVMC_INTRA_VLC_FORMAT     0x00000800
86
87/*
88 * Also XVMC_SECOND_FIELD should be set in flags if active.
89 */
90
91#define XVMC_I_PICTURE 1
92#define XVMC_P_PICTURE 2
93#define XVMC_B_PICTURE 3
94
95typedef struct _XvMCMpegControl {
96    unsigned
97     BVMV_range,                /* Backward vertical motion vector range */
98     BHMV_range,                /* Backward horizontal motion vector range */
99     FVMV_range,                /* Forward vertical motion vector range */
100     FHMV_range,                /* Forward horizontal motion vector range */
101     picture_structure,         /* XVMC_TOP_FIELD, XVMC_BOTTOM_FIELD,
102                                 *  XVMC_FRAME_PICTURE
103                                 */
104     intra_dc_precision,        /* 0x00 - 0x03 corresponds to 8 to 11 bits prec. */
105     picture_coding_type,       /* XVMC_X_PICTURE */
106     mpeg_coding,               /* XVMC_MPEG_2 */
107     flags;                     /* See above */
108} XvMCMpegControl;
109
110/*
111 * The following function is called BEFORE starting sending slices to the
112 * lib. It grabs the decoder hardware and prepares it for coming slices.
113 * The function XvMCSyncSurface will release the hardware for other contexts
114 * in addition to it's current functionality.
115 */
116
117extern Status XvMCBeginSurface(Display *display,
118                               XvMCContext *context,
119                               XvMCSurface *target_surface,
120                               XvMCSurface *past_surface,
121                               XvMCSurface *future_surface,
122                               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.
131 */
132
133typedef struct _XvMCQMatrix {
134    int load_intra_quantiser_matrix;
135    int load_non_intra_quantiser_matrix;
136    int load_chroma_intra_quantiser_matrix;
137    int load_chroma_non_intra_quantiser_matrix;
138    unsigned char intra_quantiser_matrix[64];
139    unsigned char non_intra_quantiser_matrix[64];
140    unsigned char chroma_intra_quantiser_matrix[64];
141    unsigned char chroma_non_intra_quantiser_matrix[64];
142} XvMCQMatrix;
143
144/*
145 * Upload a XvMCQMatrix structure to the clientlib.
146 * The hardware will start using it the next XvMCBeginSurface.
147 */
148
149extern Status XvMCLoadQMatrix(Display *display, XvMCContext *context,
150                              const XvMCQMatrix *qmx);
151
152/*
153 * Put a slice to the decoder. The hardware will start processing it
154 * immediately.
155 */
156
157extern Status XvMCPutSlice(Display *display, XvMCContext *context,
158                           char *slice, int nBytes);
159/*
160 * Put a slice without the slice start code to the decoder.
161 * The hardware will start processing it
162 * immediately. This function is for client optimization.
163 * XvMCPutSlice(display,context,slice,nBytes) is equivalent to
164 * XvMCPutSlice2(display,context,slice+4,nBytes-4,slice[3]);
165 */
166
167extern Status XvMCPutSlice2(Display *display, XvMCContext *context,
168                            char *slice, int nBytes, int sliceCode);
169
170#endif
171