Check all critical xvmc struct fields in ff_xvmc_field_start()
[ffmpeg.git] / libavcodec / mpegvideo_xvmc.c
1 /*
2  * XVideo Motion Compensation
3  * Copyright (c) 2003 Ivan Kalvachev
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
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
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include <limits.h>
23
24 #include "avcodec.h"
25 #include "dsputil.h"
26 #include "mpegvideo.h"
27
28 #undef NDEBUG
29 #include <assert.h>
30
31 #include "xvmc.h"
32 #include "xvmc_internal.h"
33
34 /**
35  * Initializes the block field of the MpegEncContext pointer passed as
36  * parameter after making sure that the data is not corrupted.
37  */
38 void ff_xvmc_init_block(MpegEncContext *s)
39 {
40     struct xvmc_pixfmt_render *render = (struct xvmc_pixfmt_render*)s->current_picture.data[2];
41     assert(render && render->magic_id == AV_XVMC_RENDER_MAGIC);
42
43     s->block = (DCTELEM *)(render->data_blocks + render->next_free_data_block_num * 64);
44 }
45
46 void ff_xvmc_pack_pblocks(MpegEncContext *s, int cbp)
47 {
48     int i, j = 0;
49     const int mb_block_count = 4 + (1 << s->chroma_format);
50
51     cbp <<= 12-mb_block_count;
52     for (i = 0; i < mb_block_count; i++) {
53         if (cbp & (1 << 11))
54             s->pblocks[i] = (short *)(&s->block[j++]);
55         else
56             s->pblocks[i] = NULL;
57         cbp+=cbp;
58     }
59 }
60
61 /**
62  * This function should be called for every new field and/or frame.
63  * It should be safe to call the function a few times for the same field.
64  */
65 int ff_xvmc_field_start(MpegEncContext*s, AVCodecContext *avctx)
66 {
67     struct xvmc_pixfmt_render *last, *next, *render = (struct xvmc_pixfmt_render*)s->current_picture.data[2];
68     const int mb_block_count = 4 + (1 << s->chroma_format);
69
70     assert(avctx);
71     if (!render || render->magic_id != AV_XVMC_RENDER_MAGIC ||
72         !render->data_blocks || !render->mv_blocks){
73         av_log(avctx, AV_LOG_ERROR,
74                "Render token doesn't look as expected.\n");
75         return -1; // make sure that this is a render packet
76     }
77
78     render->picture_structure = s->picture_structure;
79     render->flags             = s->first_field ? 0 : XVMC_SECOND_FIELD;
80
81     if (render->filled_mv_blocks_num) {
82         av_log(avctx, AV_LOG_ERROR,
83                "Rendering surface contains %i unprocessed blocks.\n",
84                render->filled_mv_blocks_num);
85         return -1;
86     }
87     if (render->total_number_of_mv_blocks   < 1 ||
88         render->total_number_of_data_blocks < mb_block_count) {
89         av_log(avctx, AV_LOG_ERROR,
90                "Rendering surface doesn't provide enough block structures to work with.\n");
91         return -1;
92     }
93     if (render->total_number_of_mv_blocks   < 1 ||
94         render->total_number_of_data_blocks < mb_block_count) {
95         av_log(avctx, AV_LOG_ERROR,
96                "Rendering surface doesn't provide enough block structures to work with.\n");
97         return -1;
98     }
99
100     render->p_future_surface = NULL;
101     render->p_past_surface   = NULL;
102
103     switch(s->pict_type) {
104         case  FF_I_TYPE:
105             return 0; // no prediction from other frames
106         case  FF_B_TYPE:
107             next = (struct xvmc_pixfmt_render*)s->next_picture.data[2];
108             if (!next)
109                 return -1;
110             if (next->magic_id != AV_XVMC_RENDER_MAGIC)
111                 return -1;
112             render->p_future_surface = next->p_surface;
113             // no return here, going to set forward prediction
114         case  FF_P_TYPE:
115             last = (struct xvmc_pixfmt_render*)s->last_picture.data[2];
116             if (!last)
117                 last = render; // predict second field from the first
118             if (last->magic_id != AV_XVMC_RENDER_MAGIC)
119                 return -1;
120             render->p_past_surface = last->p_surface;
121             return 0;
122     }
123
124 return -1;
125 }
126
127 /**
128  * This function should be called for every new field and/or frame.
129  * It should be safe to call the function a few times for the same field.
130  */
131 void ff_xvmc_field_end(MpegEncContext *s)
132 {
133     struct xvmc_pixfmt_render *render = (struct xvmc_pixfmt_render*)s->current_picture.data[2];
134     assert(render);
135
136     if (render->filled_mv_blocks_num > 0)
137         ff_draw_horiz_band(s, 0, 0);
138 }
139
140 void ff_xvmc_decode_mb(MpegEncContext *s)
141 {
142     XvMCMacroBlock *mv_block;
143     struct xvmc_pixfmt_render *render;
144     int i, cbp, blocks_per_mb;
145
146     const int mb_xy = s->mb_y * s->mb_stride + s->mb_x;
147
148
149     if (s->encoding) {
150         av_log(s->avctx, AV_LOG_ERROR, "XVMC doesn't support encoding!!!\n");
151         return;
152     }
153
154     // from MPV_decode_mb(), update DC predictors for P macroblocks
155     if (!s->mb_intra) {
156         s->last_dc[0] =
157         s->last_dc[1] =
158         s->last_dc[2] =  128 << s->intra_dc_precision;
159     }
160
161     // MC doesn't skip blocks
162     s->mb_skipped = 0;
163
164
165     // Do I need to export quant when I could not perform postprocessing?
166     // Anyway, it doesn't hurt.
167     s->current_picture.qscale_table[mb_xy] = s->qscale;
168
169     // start of XVMC-specific code
170     render = (struct xvmc_pixfmt_render*)s->current_picture.data[2];
171     assert(render);
172     assert(render->magic_id == AV_XVMC_RENDER_MAGIC);
173     assert(render->mv_blocks);
174
175     // take the next free macroblock
176     mv_block = &render->mv_blocks[render->start_mv_blocks_num +
177                                   render->filled_mv_blocks_num];
178
179     mv_block->x        = s->mb_x;
180     mv_block->y        = s->mb_y;
181     mv_block->dct_type = s->interlaced_dct; // XVMC_DCT_TYPE_FRAME/FIELD;
182     if (s->mb_intra) {
183         mv_block->macroblock_type = XVMC_MB_TYPE_INTRA; // no MC, all done
184     } else {
185         mv_block->macroblock_type = XVMC_MB_TYPE_PATTERN;
186
187         if (s->mv_dir & MV_DIR_FORWARD) {
188             mv_block->macroblock_type |= XVMC_MB_TYPE_MOTION_FORWARD;
189             // PMV[n][dir][xy] = mv[dir][n][xy]
190             mv_block->PMV[0][0][0] = s->mv[0][0][0];
191             mv_block->PMV[0][0][1] = s->mv[0][0][1];
192             mv_block->PMV[1][0][0] = s->mv[0][1][0];
193             mv_block->PMV[1][0][1] = s->mv[0][1][1];
194         }
195         if (s->mv_dir & MV_DIR_BACKWARD) {
196             mv_block->macroblock_type |= XVMC_MB_TYPE_MOTION_BACKWARD;
197             mv_block->PMV[0][1][0] = s->mv[1][0][0];
198             mv_block->PMV[0][1][1] = s->mv[1][0][1];
199             mv_block->PMV[1][1][0] = s->mv[1][1][0];
200             mv_block->PMV[1][1][1] = s->mv[1][1][1];
201         }
202
203         switch(s->mv_type) {
204             case  MV_TYPE_16X16:
205                 mv_block->motion_type = XVMC_PREDICTION_FRAME;
206                 break;
207             case  MV_TYPE_16X8:
208                 mv_block->motion_type = XVMC_PREDICTION_16x8;
209                 break;
210             case  MV_TYPE_FIELD:
211                 mv_block->motion_type = XVMC_PREDICTION_FIELD;
212                 if (s->picture_structure == PICT_FRAME) {
213                     mv_block->PMV[0][0][1] <<= 1;
214                     mv_block->PMV[1][0][1] <<= 1;
215                     mv_block->PMV[0][1][1] <<= 1;
216                     mv_block->PMV[1][1][1] <<= 1;
217                 }
218                 break;
219             case  MV_TYPE_DMV:
220                 mv_block->motion_type = XVMC_PREDICTION_DUAL_PRIME;
221                 if (s->picture_structure == PICT_FRAME) {
222
223                     mv_block->PMV[0][0][0] = s->mv[0][0][0];      // top from top
224                     mv_block->PMV[0][0][1] = s->mv[0][0][1] << 1;
225
226                     mv_block->PMV[0][1][0] = s->mv[0][0][0];      // bottom from bottom
227                     mv_block->PMV[0][1][1] = s->mv[0][0][1] << 1;
228
229                     mv_block->PMV[1][0][0] = s->mv[0][2][0];      // dmv00, top from bottom
230                     mv_block->PMV[1][0][1] = s->mv[0][2][1] << 1; // dmv01
231
232                     mv_block->PMV[1][1][0] = s->mv[0][3][0];      // dmv10, bottom from top
233                     mv_block->PMV[1][1][1] = s->mv[0][3][1] << 1; // dmv11
234
235                 } else {
236                     mv_block->PMV[0][1][0] = s->mv[0][2][0];      // dmv00
237                     mv_block->PMV[0][1][1] = s->mv[0][2][1];      // dmv01
238                 }
239                 break;
240             default:
241                 assert(0);
242         }
243
244         mv_block->motion_vertical_field_select = 0;
245
246         // set correct field references
247         if (s->mv_type == MV_TYPE_FIELD || s->mv_type == MV_TYPE_16X8) {
248             mv_block->motion_vertical_field_select |= s->field_select[0][0];
249             mv_block->motion_vertical_field_select |= s->field_select[1][0] << 1;
250             mv_block->motion_vertical_field_select |= s->field_select[0][1] << 2;
251             mv_block->motion_vertical_field_select |= s->field_select[1][1] << 3;
252         }
253     } // !intra
254     // time to handle data blocks
255     mv_block->index = render->next_free_data_block_num;
256
257     blocks_per_mb = 6;
258     if (s->chroma_format >= 2) {
259         blocks_per_mb = 4 + (1 << s->chroma_format);
260     }
261
262     // calculate cbp
263     cbp = 0;
264     for (i = 0; i < blocks_per_mb; i++) {
265         cbp += cbp;
266         if (s->block_last_index[i] >= 0)
267             cbp++;
268     }
269
270     if (s->flags & CODEC_FLAG_GRAY) {
271         if (s->mb_intra) {                                   // intra frames are always full chroma blocks
272             for (i = 4; i < blocks_per_mb; i++) {
273                 memset(s->pblocks[i], 0, sizeof(short)*64);  // so we need to clear them
274                 if (!render->unsigned_intra)
275                     s->pblocks[i][0] = 1 << 10;
276             }
277         } else {
278             cbp &= 0xf << (blocks_per_mb - 4);
279             blocks_per_mb = 4;                               // luminance blocks only
280         }
281     }
282     mv_block->coded_block_pattern = cbp;
283     if (cbp == 0)
284         mv_block->macroblock_type &= ~XVMC_MB_TYPE_PATTERN;
285
286     for (i = 0; i < blocks_per_mb; i++) {
287         if (s->block_last_index[i] >= 0) {
288             // I do not have unsigned_intra MOCO to test, hope it is OK.
289             if (s->mb_intra && (render->idct || (!render->idct && !render->unsigned_intra)))
290                 s->pblocks[i][0] -= 1 << 10;
291             if (!render->idct) {
292                 s->dsp.idct(s->pblocks[i]);
293                 /* It is unclear if MC hardware requires pixel diff values to be
294                  * in the range [-255;255]. TODO: Clipping if such hardware is
295                  * ever found. As of now it would only be an unnecessary
296                  * slowdown. */
297             }
298             // copy blocks only if the codec doesn't support pblocks reordering
299             if (s->avctx->xvmc_acceleration == 1) {
300                 memcpy(&render->data_blocks[render->next_free_data_block_num*64],
301                        s->pblocks[i], sizeof(short)*64);
302             }
303             render->next_free_data_block_num++;
304         }
305     }
306     render->filled_mv_blocks_num++;
307
308     assert(render->filled_mv_blocks_num     <= render->total_number_of_mv_blocks);
309     assert(render->next_free_data_block_num <= render->total_number_of_data_blocks);
310     /* The above conditions should not be able to fail as long as this function
311      * is used and the following 'if ()' automatically calls a callback to free
312      * blocks. */
313
314
315     if (render->filled_mv_blocks_num == render->total_number_of_mv_blocks)
316         ff_draw_horiz_band(s, 0, 0);
317 }