spelling/grammar/wording fixes for Doxygen comments
[libav.git] / libavcodec / mpegvideo_xvmc.c
CommitLineData
302898fc
IK
1/*
2 * XVideo Motion Compensation
3 * Copyright (c) 2003 Ivan Kalvachev
4 *
b78e7197
DB
5 * This file is part of FFmpeg.
6 *
7 * FFmpeg is free software; you can redistribute it and/or
302898fc
IK
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
b78e7197 10 * version 2.1 of the License, or (at your option) any later version.
302898fc 11 *
b78e7197 12 * FFmpeg is distributed in the hope that it will be useful,
302898fc
IK
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
b78e7197 18 * License along with FFmpeg; if not, write to the Free Software
5509bffa 19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
302898fc
IK
20 */
21
2e7b4c84
IK
22#include <limits.h>
23
2e7b4c84
IK
24#include "avcodec.h"
25#include "dsputil.h"
26#include "mpegvideo.h"
27
28#undef NDEBUG
29#include <assert.h>
30
fd949a63 31#include "xvmc.h"
4440bd0d 32#include "xvmc_internal.h"
302898fc 33
8f38ff00
DB
34/**
35 * Initializes the block field of the MpegEncContext pointer passed as
36 * parameter after making sure that the data is not corrupted.
d758a5cb
DB
37 * In order to implement something like direct rendering instead of decoding
38 * coefficients in s->blocks and then copying them, copy them directly
3d43e42f 39 * into the data_blocks array provided by xvmc.
8f38ff00 40 */
78f9a878 41void ff_xvmc_init_block(MpegEncContext *s)
148302e7 42{
f602b044 43 struct xvmc_pix_fmt *render = (struct xvmc_pix_fmt*)s->current_picture.data[2];
1fcef408 44 assert(render && render->xvmc_id == AV_XVMC_RENDER_MAGIC);
d2d600b7 45
9f00a41c 46 s->block = (DCTELEM *)(render->data_blocks + render->next_free_data_block_num * 64);
a579db0c
IK
47}
48
3d43e42f
IK
49/**
50 * Fill individual block pointers, so there are no gaps in the data_block array
51 * in case not all blocks in MB are coded.
52 */
78f9a878 53void ff_xvmc_pack_pblocks(MpegEncContext *s, int cbp)
148302e7 54{
b71bd0ed 55 int i, j = 0;
148302e7 56 const int mb_block_count = 4 + (1 << s->chroma_format);
a579db0c 57
148302e7
DB
58 cbp <<= 12-mb_block_count;
59 for (i = 0; i < mb_block_count; i++) {
4ec58e13 60 if (cbp & (1 << 11))
4742762f 61 s->pblocks[i] = (short *)(&s->block[j++]);
4ec58e13 62 else
39dba5e8 63 s->pblocks[i] = NULL;
bb270c08 64 cbp+=cbp;
a579db0c 65 }
2e7b4c84
IK
66}
67
9107f7cd 68/**
3d43e42f 69 * Find and store the surfaces that are used as reference frames.
9107f7cd
DB
70 * This function should be called for every new field and/or frame.
71 * It should be safe to call the function a few times for the same field.
72 */
78f9a878 73int ff_xvmc_field_start(MpegEncContext*s, AVCodecContext *avctx)
148302e7 74{
f602b044 75 struct xvmc_pix_fmt *last, *next, *render = (struct xvmc_pix_fmt*)s->current_picture.data[2];
d2d600b7 76 const int mb_block_count = 4 + (1 << s->chroma_format);
2e7b4c84 77
3ae01928 78 assert(avctx);
1fcef408 79 if (!render || render->xvmc_id != AV_XVMC_RENDER_MAGIC ||
9043202e 80 !render->data_blocks || !render->mv_blocks) {
d2d600b7
IK
81 av_log(avctx, AV_LOG_ERROR,
82 "Render token doesn't look as expected.\n");
a1db3b93 83 return -1; // make sure that this is a render packet
d2d600b7 84 }
2e7b4c84 85
cb18fb62 86 if (render->filled_mv_blocks_num) {
9939841f 87 av_log(avctx, AV_LOG_ERROR,
d2d600b7 88 "Rendering surface contains %i unprocessed blocks.\n",
cb18fb62 89 render->filled_mv_blocks_num);
013cebfb 90 return -1;
9939841f 91 }
d2d600b7
IK
92 if (render->total_number_of_mv_blocks < 1 ||
93 render->total_number_of_data_blocks < mb_block_count) {
94 av_log(avctx, AV_LOG_ERROR,
95 "Rendering surface doesn't provide enough block structures to work with.\n");
96 return -1;
97 }
2e7b4c84 98
d76c5ed5
IK
99 render->picture_structure = s->picture_structure;
100 render->flags = s->first_field ? 0 : XVMC_SECOND_FIELD;
9e0a8a36
IK
101 render->p_future_surface = NULL;
102 render->p_past_surface = NULL;
2e7b4c84 103
7e2e870e 104 switch(s->pict_type) {
9701840b 105 case FF_I_TYPE:
1f7c1d14 106 return 0; // no prediction from other frames
9701840b 107 case FF_B_TYPE:
f602b044 108 next = (struct xvmc_pix_fmt*)s->next_picture.data[2];
3ae01928 109 if (!next)
148302e7 110 return -1;
1fcef408 111 if (next->xvmc_id != AV_XVMC_RENDER_MAGIC)
148302e7 112 return -1;
2e7b4c84 113 render->p_future_surface = next->p_surface;
1f7c1d14 114 // no return here, going to set forward prediction
9701840b 115 case FF_P_TYPE:
f602b044 116 last = (struct xvmc_pix_fmt*)s->last_picture.data[2];
63a21bc0 117 if (!last)
1f7c1d14 118 last = render; // predict second field from the first
1fcef408 119 if (last->xvmc_id != AV_XVMC_RENDER_MAGIC)
148302e7 120 return -1;
2e7b4c84
IK
121 render->p_past_surface = last->p_surface;
122 return 0;
5e5c247a 123 }
2e7b4c84
IK
124
125return -1;
126}
127
0b2eb2e8 128/**
3d43e42f 129 * Complete frame/field rendering by passing any remaining blocks.
d758a5cb
DB
130 * Normally ff_draw_horiz_band() is called for each slice, however,
131 * some leftover blocks, for example from error_resilience(), may remain.
0b2eb2e8
DB
132 * It should be safe to call the function a few times for the same field.
133 */
78f9a878 134void ff_xvmc_field_end(MpegEncContext *s)
148302e7 135{
f602b044 136 struct xvmc_pix_fmt *render = (struct xvmc_pix_fmt*)s->current_picture.data[2];
3ae01928 137 assert(render);
2e7b4c84 138
148302e7 139 if (render->filled_mv_blocks_num > 0)
99df0aa5 140 ff_draw_horiz_band(s, 0, 0);
2e7b4c84
IK
141}
142
3d43e42f
IK
143/**
144 * Synthesize the data needed by XvMC to render one macroblock of data.
d758a5cb 145 * Fill all relevant fields, if necessery do IDCT.
3d43e42f 146 */
78f9a878 147void ff_xvmc_decode_mb(MpegEncContext *s)
148302e7 148{
7e2e870e 149 XvMCMacroBlock *mv_block;
f602b044 150 struct xvmc_pix_fmt *render;
7e2e870e 151 int i, cbp, blocks_per_mb;
2e7b4c84 152
39dba5e8 153 const int mb_xy = s->mb_y * s->mb_stride + s->mb_x;
2e7b4c84
IK
154
155
148302e7 156 if (s->encoding) {
8ac5c1b2 157 av_log(s->avctx, AV_LOG_ERROR, "XVMC doesn't support encoding!!!\n");
61b76987 158 return;
2e7b4c84
IK
159 }
160
1f7c1d14 161 // from MPV_decode_mb(), update DC predictors for P macroblocks
2e7b4c84
IK
162 if (!s->mb_intra) {
163 s->last_dc[0] =
164 s->last_dc[1] =
165 s->last_dc[2] = 128 << s->intra_dc_precision;
166 }
167
1f7c1d14 168 // MC doesn't skip blocks
160d679c 169 s->mb_skipped = 0;
2e7b4c84
IK
170
171
d15876d3
DB
172 // Do I need to export quant when I could not perform postprocessing?
173 // Anyway, it doesn't hurt.
2e7b4c84
IK
174 s->current_picture.qscale_table[mb_xy] = s->qscale;
175
a1db3b93 176 // start of XVMC-specific code
f602b044 177 render = (struct xvmc_pix_fmt*)s->current_picture.data[2];
3ae01928 178 assert(render);
1fcef408 179 assert(render->xvmc_id == AV_XVMC_RENDER_MAGIC);
2e7b4c84 180 assert(render->mv_blocks);
302898fc 181
1f7c1d14 182 // take the next free macroblock
115329f1 183 mv_block = &render->mv_blocks[render->start_mv_blocks_num +
fe4be5db 184 render->filled_mv_blocks_num];
2e7b4c84 185
4ef690f5
DB
186 mv_block->x = s->mb_x;
187 mv_block->y = s->mb_y;
1f7c1d14 188 mv_block->dct_type = s->interlaced_dct; // XVMC_DCT_TYPE_FRAME/FIELD;
4ec58e13 189 if (s->mb_intra) {
1f7c1d14 190 mv_block->macroblock_type = XVMC_MB_TYPE_INTRA; // no MC, all done
4ec58e13 191 } else {
2e7b4c84
IK
192 mv_block->macroblock_type = XVMC_MB_TYPE_PATTERN;
193
148302e7 194 if (s->mv_dir & MV_DIR_FORWARD) {
2d7d8cc7 195 mv_block->macroblock_type |= XVMC_MB_TYPE_MOTION_FORWARD;
0439c09d 196 // PMV[n][dir][xy] = mv[dir][n][xy]
2e7b4c84
IK
197 mv_block->PMV[0][0][0] = s->mv[0][0][0];
198 mv_block->PMV[0][0][1] = s->mv[0][0][1];
199 mv_block->PMV[1][0][0] = s->mv[0][1][0];
200 mv_block->PMV[1][0][1] = s->mv[0][1][1];
201 }
148302e7 202 if (s->mv_dir & MV_DIR_BACKWARD) {
2d7d8cc7 203 mv_block->macroblock_type |= XVMC_MB_TYPE_MOTION_BACKWARD;
2e7b4c84
IK
204 mv_block->PMV[0][1][0] = s->mv[1][0][0];
205 mv_block->PMV[0][1][1] = s->mv[1][0][1];
206 mv_block->PMV[1][1][0] = s->mv[1][1][0];
207 mv_block->PMV[1][1][1] = s->mv[1][1][1];
208 }
209
99df0aa5 210 switch(s->mv_type) {
2e7b4c84
IK
211 case MV_TYPE_16X16:
212 mv_block->motion_type = XVMC_PREDICTION_FRAME;
213 break;
214 case MV_TYPE_16X8:
215 mv_block->motion_type = XVMC_PREDICTION_16x8;
216 break;
217 case MV_TYPE_FIELD:
218 mv_block->motion_type = XVMC_PREDICTION_FIELD;
148302e7
DB
219 if (s->picture_structure == PICT_FRAME) {
220 mv_block->PMV[0][0][1] <<= 1;
221 mv_block->PMV[1][0][1] <<= 1;
222 mv_block->PMV[0][1][1] <<= 1;
223 mv_block->PMV[1][1][1] <<= 1;
2e7b4c84
IK
224 }
225 break;
226 case MV_TYPE_DMV:
227 mv_block->motion_type = XVMC_PREDICTION_DUAL_PRIME;
148302e7 228 if (s->picture_structure == PICT_FRAME) {
2e7b4c84 229
ba585726 230 mv_block->PMV[0][0][0] = s->mv[0][0][0]; // top from top
81189e4f 231 mv_block->PMV[0][0][1] = s->mv[0][0][1] << 1;
2e7b4c84 232
ba585726 233 mv_block->PMV[0][1][0] = s->mv[0][0][0]; // bottom from bottom
81189e4f 234 mv_block->PMV[0][1][1] = s->mv[0][0][1] << 1;
2e7b4c84 235
ba585726 236 mv_block->PMV[1][0][0] = s->mv[0][2][0]; // dmv00, top from bottom
81189e4f 237 mv_block->PMV[1][0][1] = s->mv[0][2][1] << 1; // dmv01
2e7b4c84 238
ba585726 239 mv_block->PMV[1][1][0] = s->mv[0][3][0]; // dmv10, bottom from top
81189e4f 240 mv_block->PMV[1][1][1] = s->mv[0][3][1] << 1; // dmv11
2e7b4c84 241
4ec58e13 242 } else {
ba585726
DB
243 mv_block->PMV[0][1][0] = s->mv[0][2][0]; // dmv00
244 mv_block->PMV[0][1][1] = s->mv[0][2][1]; // dmv01
2e7b4c84
IK
245 }
246 break;
247 default:
248 assert(0);
249 }
250
251 mv_block->motion_vertical_field_select = 0;
252
1f7c1d14 253 // set correct field references
148302e7 254 if (s->mv_type == MV_TYPE_FIELD || s->mv_type == MV_TYPE_16X8) {
90509ec7 255 mv_block->motion_vertical_field_select |= s->field_select[0][0];
7e2e870e
DB
256 mv_block->motion_vertical_field_select |= s->field_select[1][0] << 1;
257 mv_block->motion_vertical_field_select |= s->field_select[0][1] << 2;
258 mv_block->motion_vertical_field_select |= s->field_select[1][1] << 3;
2e7b4c84 259 }
1f7c1d14 260 } // !intra
a1db3b93 261 // time to handle data blocks
2e7b4c84 262 mv_block->index = render->next_free_data_block_num;
5e5c247a 263
2e7b4c84 264 blocks_per_mb = 6;
148302e7 265 if (s->chroma_format >= 2) {
4742762f 266 blocks_per_mb = 4 + (1 << s->chroma_format);
2e7b4c84 267 }
5e5c247a 268
1f7c1d14 269 // calculate cbp
715731a3 270 cbp = 0;
148302e7 271 for (i = 0; i < blocks_per_mb; i++) {
2d7d8cc7 272 cbp += cbp;
148302e7 273 if (s->block_last_index[i] >= 0)
715731a3
IK
274 cbp++;
275 }
115329f1 276
148302e7 277 if (s->flags & CODEC_FLAG_GRAY) {
ba585726 278 if (s->mb_intra) { // intra frames are always full chroma blocks
148302e7 279 for (i = 4; i < blocks_per_mb; i++) {
6e4b41f8 280 memset(s->pblocks[i], 0, sizeof(short)*64); // so we need to clear them
148302e7
DB
281 if (!render->unsigned_intra)
282 s->pblocks[i][0] = 1 << 10;
a579db0c 283 }
4ec58e13 284 } else {
148302e7 285 cbp &= 0xf << (blocks_per_mb - 4);
ba585726 286 blocks_per_mb = 4; // luminance blocks only
715731a3 287 }
a579db0c 288 }
2e7b4c84 289 mv_block->coded_block_pattern = cbp;
148302e7 290 if (cbp == 0)
2e7b4c84
IK
291 mv_block->macroblock_type &= ~XVMC_MB_TYPE_PATTERN;
292
148302e7
DB
293 for (i = 0; i < blocks_per_mb; i++) {
294 if (s->block_last_index[i] >= 0) {
7a74e067 295 // I do not have unsigned_intra MOCO to test, hope it is OK.
eba9cecc 296 if (s->mb_intra && (render->idct || (!render->idct && !render->unsigned_intra)))
148302e7
DB
297 s->pblocks[i][0] -= 1 << 10;
298 if (!render->idct) {
a579db0c 299 s->dsp.idct(s->pblocks[i]);
a1db3b93
DB
300 /* It is unclear if MC hardware requires pixel diff values to be
301 * in the range [-255;255]. TODO: Clipping if such hardware is
302 * ever found. As of now it would only be an unnecessary
303 * slowdown. */
2e7b4c84 304 }
1f7c1d14 305 // copy blocks only if the codec doesn't support pblocks reordering
148302e7 306 if (s->avctx->xvmc_acceleration == 1) {
4742762f 307 memcpy(&render->data_blocks[render->next_free_data_block_num*64],
6e280340 308 s->pblocks[i], sizeof(short)*64);
a579db0c
IK
309 }
310 render->next_free_data_block_num++;
2e7b4c84
IK
311 }
312 }
313 render->filled_mv_blocks_num++;
314
1a90cf3c 315 assert(render->filled_mv_blocks_num <= render->total_number_of_mv_blocks);
2e7b4c84 316 assert(render->next_free_data_block_num <= render->total_number_of_data_blocks);
1a90cf3c 317 /* The above conditions should not be able to fail as long as this function
930efaf4
DB
318 * is used and the following 'if ()' automatically calls a callback to free
319 * blocks. */
2e7b4c84
IK
320
321
afb9342a 322 if (render->filled_mv_blocks_num == render->total_number_of_mv_blocks)
7e2e870e 323 ff_draw_horiz_band(s, 0, 0);
2e7b4c84 324}