Reduce lookahead memory usage, cache misses
[x262.git] / common / frame.c
1 /*****************************************************************************
2  * frame.c: h264 encoder library
3  *****************************************************************************
4  * Copyright (C) 2003-2008 x264 project
5  *
6  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7  *          Loren Merritt <lorenm@u.washington.edu>
8  *          Jason Garrett-Glaser <darkshikari@gmail.com>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111, USA.
23  *****************************************************************************/
24
25 #include "common.h"
26
27 #define ALIGN(x,a) (((x)+((a)-1))&~((a)-1))
28
29 x264_frame_t *x264_frame_new( x264_t *h, int b_fdec )
30 {
31     x264_frame_t *frame;
32
33     int i_mb_count = h->mb.i_mb_count;
34     int i_stride, i_width, i_lines;
35     int i_padv = PADV << h->param.b_interlaced;
36     int luma_plane_size;
37     int chroma_plane_size;
38     int align = h->param.cpu&X264_CPU_CACHELINE_64 ? 64 : h->param.cpu&X264_CPU_CACHELINE_32 ? 32 : 16;
39
40     CHECKED_MALLOCZERO( frame, sizeof(x264_frame_t) );
41
42     /* allocate frame data (+64 for extra data for me) */
43     i_width  = ALIGN( h->param.i_width, 16 );
44     i_stride = ALIGN( i_width + 2*PADH, align );
45     i_lines  = ALIGN( h->param.i_height, 16<<h->param.b_interlaced );
46
47     frame->i_plane = 3;
48     for( int i = 0; i < 3; i++ )
49     {
50         frame->i_stride[i] = ALIGN( i_stride >> !!i, align );
51         frame->i_width[i] = i_width >> !!i;
52         frame->i_lines[i] = i_lines >> !!i;
53     }
54
55     luma_plane_size = (frame->i_stride[0] * (frame->i_lines[0] + 2*i_padv));
56     chroma_plane_size = (frame->i_stride[1] * (frame->i_lines[1] + 2*i_padv));
57     for( int i = 1; i < 3; i++ )
58     {
59         CHECKED_MALLOC( frame->buffer[i], chroma_plane_size );
60         frame->plane[i] = frame->buffer[i] + (frame->i_stride[i] * i_padv + PADH)/2;
61     }
62
63     for( int i = 0; i < h->param.i_bframe + 2; i++ )
64         for( int j = 0; j < h->param.i_bframe + 2; j++ )
65             CHECKED_MALLOC( frame->i_row_satds[i][j], i_lines/16 * sizeof(int) );
66
67     frame->i_poc = -1;
68     frame->i_type = X264_TYPE_AUTO;
69     frame->i_qpplus1 = 0;
70     frame->i_pts = -1;
71     frame->i_frame = -1;
72     frame->i_frame_num = -1;
73     frame->i_lines_completed = -1;
74     frame->b_fdec = b_fdec;
75     frame->i_pic_struct = PIC_STRUCT_AUTO;
76     frame->i_field_cnt = -1;
77     frame->i_duration =
78     frame->i_cpb_duration =
79     frame->i_dpb_output_delay =
80     frame->i_cpb_delay = 0;
81     frame->i_coded_fields_lookahead =
82     frame->i_cpb_delay_lookahead = -1;
83
84     frame->orig = frame;
85
86     /* all 4 luma planes allocated together, since the cacheline split code
87      * requires them to be in-phase wrt cacheline alignment. */
88     if( h->param.analyse.i_subpel_refine && b_fdec )
89     {
90         CHECKED_MALLOC( frame->buffer[0], 4*luma_plane_size );
91         for( int i = 0; i < 4; i++ )
92             frame->filtered[i] = frame->buffer[0] + i*luma_plane_size + frame->i_stride[0] * i_padv + PADH;
93         frame->plane[0] = frame->filtered[0];
94     }
95     else
96     {
97         CHECKED_MALLOC( frame->buffer[0], luma_plane_size );
98         frame->filtered[0] = frame->plane[0] = frame->buffer[0] + frame->i_stride[0] * i_padv + PADH;
99     }
100
101     frame->b_duplicate = 0;
102
103     if( b_fdec ) /* fdec frame */
104     {
105         CHECKED_MALLOC( frame->mb_type, i_mb_count * sizeof(int8_t));
106         CHECKED_MALLOC( frame->mb_partition, i_mb_count * sizeof(uint8_t));
107         CHECKED_MALLOC( frame->mv[0], 2*16 * i_mb_count * sizeof(int16_t) );
108         CHECKED_MALLOC( frame->ref[0], 4 * i_mb_count * sizeof(int8_t) );
109         if( h->param.i_bframe )
110         {
111             CHECKED_MALLOC( frame->mv[1], 2*16 * i_mb_count * sizeof(int16_t) );
112             CHECKED_MALLOC( frame->ref[1], 4 * i_mb_count * sizeof(int8_t) );
113         }
114         else
115         {
116             frame->mv[1]  = NULL;
117             frame->ref[1] = NULL;
118         }
119         CHECKED_MALLOC( frame->i_row_bits, i_lines/16 * sizeof(int) );
120         CHECKED_MALLOC( frame->i_row_qp, i_lines/16 * sizeof(int) );
121         if( h->param.analyse.i_me_method >= X264_ME_ESA )
122         {
123             CHECKED_MALLOC( frame->buffer[3],
124                             frame->i_stride[0] * (frame->i_lines[0] + 2*i_padv) * sizeof(uint16_t) << h->frames.b_have_sub8x8_esa );
125             frame->integral = (uint16_t*)frame->buffer[3] + frame->i_stride[0] * i_padv + PADH;
126         }
127     }
128     else /* fenc frame */
129     {
130         if( h->frames.b_have_lowres )
131         {
132             frame->i_width_lowres = frame->i_width[0]/2;
133             frame->i_stride_lowres = ALIGN( frame->i_width_lowres + 2*PADH, align );
134             frame->i_lines_lowres = frame->i_lines[0]/2;
135
136             luma_plane_size = frame->i_stride_lowres * (frame->i_lines[0]/2 + 2*PADV);
137
138             CHECKED_MALLOC( frame->buffer_lowres[0], 4 * luma_plane_size );
139             for( int i = 0; i < 4; i++ )
140                 frame->lowres[i] = frame->buffer_lowres[0] + (frame->i_stride_lowres * PADV + PADH) + i * luma_plane_size;
141
142             for( int j = 0; j <= !!h->param.i_bframe; j++ )
143                 for( int i = 0; i <= h->param.i_bframe; i++ )
144                 {
145                     CHECKED_MALLOCZERO( frame->lowres_mvs[j][i], 2*h->mb.i_mb_count*sizeof(int16_t) );
146                     CHECKED_MALLOC( frame->lowres_mv_costs[j][i], h->mb.i_mb_count*sizeof(int) );
147                 }
148             CHECKED_MALLOC( frame->i_propagate_cost, (i_mb_count+3) * sizeof(uint16_t) );
149             for( int j = 0; j <= h->param.i_bframe+1; j++ )
150                 for( int i = 0; i <= h->param.i_bframe+1; i++ )
151                     CHECKED_MALLOC( frame->lowres_costs[j][i], (i_mb_count+3) * sizeof(uint16_t) );
152             frame->i_intra_cost = frame->lowres_costs[0][0];
153             memset( frame->i_intra_cost, -1, (i_mb_count+3) * sizeof(uint16_t) );
154         }
155         if( h->param.rc.i_aq_mode )
156         {
157             CHECKED_MALLOC( frame->f_qp_offset, h->mb.i_mb_count * sizeof(float) );
158             CHECKED_MALLOC( frame->f_qp_offset_aq, h->mb.i_mb_count * sizeof(float) );
159             if( h->frames.b_have_lowres )
160                 /* shouldn't really be initialized, just silences a valgrind false-positive in x264_mbtree_propagate_cost_sse2 */
161                 CHECKED_MALLOCZERO( frame->i_inv_qscale_factor, (h->mb.i_mb_count+3) * sizeof(uint16_t) );
162         }
163     }
164
165     if( x264_pthread_mutex_init( &frame->mutex, NULL ) )
166         goto fail;
167     if( x264_pthread_cond_init( &frame->cv, NULL ) )
168         goto fail;
169
170     return frame;
171
172 fail:
173     x264_free( frame );
174     return NULL;
175 }
176
177 void x264_frame_delete( x264_frame_t *frame )
178 {
179     /* Duplicate frames are blank copies of real frames (including pointers),
180      * so freeing those pointers would cause a double free later. */
181     if( !frame->b_duplicate )
182     {
183         for( int i = 0; i < 4; i++ )
184             x264_free( frame->buffer[i] );
185         for( int i = 0; i < 4; i++ )
186             x264_free( frame->buffer_lowres[i] );
187         for( int i = 0; i < X264_BFRAME_MAX+2; i++ )
188             for( int j = 0; j < X264_BFRAME_MAX+2; j++ )
189                 x264_free( frame->i_row_satds[i][j] );
190         for( int j = 0; j < 2; j++ )
191             for( int i = 0; i <= X264_BFRAME_MAX; i++ )
192             {
193                 x264_free( frame->lowres_mvs[j][i] );
194                 x264_free( frame->lowres_mv_costs[j][i] );
195             }
196         x264_free( frame->i_propagate_cost );
197         for( int j = 0; j <= X264_BFRAME_MAX+1; j++ )
198             for( int i = 0; i <= X264_BFRAME_MAX+1; i++ )
199                 x264_free( frame->lowres_costs[j][i] );
200         x264_free( frame->f_qp_offset );
201         x264_free( frame->f_qp_offset_aq );
202         x264_free( frame->i_inv_qscale_factor );
203         x264_free( frame->i_row_bits );
204         x264_free( frame->i_row_qp );
205         x264_free( frame->mb_type );
206         x264_free( frame->mb_partition );
207         x264_free( frame->mv[0] );
208         x264_free( frame->mv[1] );
209         x264_free( frame->ref[0] );
210         x264_free( frame->ref[1] );
211         x264_pthread_mutex_destroy( &frame->mutex );
212         x264_pthread_cond_destroy( &frame->cv );
213     }
214     x264_free( frame );
215 }
216
217 int x264_frame_copy_picture( x264_t *h, x264_frame_t *dst, x264_picture_t *src )
218 {
219     int i_csp = src->img.i_csp & X264_CSP_MASK;
220     if( i_csp != X264_CSP_I420 && i_csp != X264_CSP_YV12 )
221     {
222         x264_log( h, X264_LOG_ERROR, "Arg invalid CSP\n" );
223         return -1;
224     }
225
226     dst->i_type     = src->i_type;
227     dst->i_qpplus1  = src->i_qpplus1;
228     dst->i_pts      = dst->i_reordered_pts = src->i_pts;
229     dst->param      = src->param;
230     dst->i_pic_struct = src->i_pic_struct;
231
232     for( int i = 0; i < 3; i++ )
233     {
234         int s = (i_csp == X264_CSP_YV12 && i) ? i^3 : i;
235         uint8_t *plane = src->img.plane[s];
236         int stride = src->img.i_stride[s];
237         int width = h->param.i_width >> !!i;
238         int height = h->param.i_height >> !!i;
239         if( src->img.i_csp & X264_CSP_VFLIP )
240         {
241             plane += (height-1)*stride;
242             stride = -stride;
243         }
244         h->mc.plane_copy( dst->plane[i], dst->i_stride[i], plane, stride, width, height );
245     }
246     return 0;
247 }
248
249
250
251 static void plane_expand_border( uint8_t *pix, int i_stride, int i_width, int i_height, int i_padh, int i_padv, int b_pad_top, int b_pad_bottom )
252 {
253 #define PPIXEL(x, y) ( pix + (x) + (y)*i_stride )
254     for( int y = 0; y < i_height; y++ )
255     {
256         /* left band */
257         memset( PPIXEL(-i_padh, y), PPIXEL(0, y)[0], i_padh );
258         /* right band */
259         memset( PPIXEL(i_width, y), PPIXEL(i_width-1, y)[0], i_padh );
260     }
261     /* upper band */
262     if( b_pad_top )
263         for( int y = 0; y < i_padv; y++ )
264             memcpy( PPIXEL(-i_padh, -y-1), PPIXEL(-i_padh, 0), i_width+2*i_padh );
265     /* lower band */
266     if( b_pad_bottom )
267         for( int y = 0; y < i_padv; y++ )
268             memcpy( PPIXEL(-i_padh, i_height+y), PPIXEL(-i_padh, i_height-1), i_width+2*i_padh );
269 #undef PPIXEL
270 }
271
272 void x264_frame_expand_border( x264_t *h, x264_frame_t *frame, int mb_y, int b_end )
273 {
274     int b_start = !mb_y;
275     if( mb_y & h->sh.b_mbaff )
276         return;
277     for( int i = 0; i < frame->i_plane; i++ )
278     {
279         int stride = frame->i_stride[i];
280         int width = 16*h->sps->i_mb_width >> !!i;
281         int height = (b_end ? 16*(h->sps->i_mb_height - mb_y) >> h->sh.b_mbaff : 16) >> !!i;
282         int padh = PADH >> !!i;
283         int padv = PADV >> !!i;
284         // buffer: 2 chroma, 3 luma (rounded to 4) because deblocking goes beyond the top of the mb
285         uint8_t *pix = frame->plane[i] + X264_MAX(0, (16*mb_y-4)*stride >> !!i);
286         if( b_end && !b_start )
287             height += 4 >> (!!i + h->sh.b_mbaff);
288         if( h->sh.b_mbaff )
289         {
290             plane_expand_border( pix, stride*2, width, height, padh, padv, b_start, b_end );
291             plane_expand_border( pix+stride, stride*2, width, height, padh, padv, b_start, b_end );
292         }
293         else
294         {
295             plane_expand_border( pix, stride, width, height, padh, padv, b_start, b_end );
296         }
297     }
298 }
299
300 void x264_frame_expand_border_filtered( x264_t *h, x264_frame_t *frame, int mb_y, int b_end )
301 {
302     /* during filtering, 8 extra pixels were filtered on each edge,
303      * but up to 3 of the horizontal ones may be wrong.
304        we want to expand border from the last filtered pixel */
305     int b_start = !mb_y;
306     int stride = frame->i_stride[0];
307     int width = 16*h->sps->i_mb_width + 8;
308     int height = b_end ? (16*(h->sps->i_mb_height - mb_y) >> h->sh.b_mbaff) + 16 : 16;
309     int padh = PADH - 4;
310     int padv = PADV - 8;
311     for( int i = 1; i < 4; i++ )
312     {
313         // buffer: 8 luma, to match the hpel filter
314         uint8_t *pix = frame->filtered[i] + (16*mb_y - (8 << h->sh.b_mbaff)) * stride - 4;
315         if( h->sh.b_mbaff )
316         {
317             plane_expand_border( pix, stride*2, width, height, padh, padv, b_start, b_end );
318             plane_expand_border( pix+stride, stride*2, width, height, padh, padv, b_start, b_end );
319         }
320         else
321             plane_expand_border( pix, stride, width, height, padh, padv, b_start, b_end );
322     }
323 }
324
325 void x264_frame_expand_border_lowres( x264_frame_t *frame )
326 {
327     for( int i = 0; i < 4; i++ )
328         plane_expand_border( frame->lowres[i], frame->i_stride_lowres, frame->i_width_lowres, frame->i_lines_lowres, PADH, PADV, 1, 1 );
329 }
330
331 void x264_frame_expand_border_mod16( x264_t *h, x264_frame_t *frame )
332 {
333     for( int i = 0; i < frame->i_plane; i++ )
334     {
335         int i_subsample = i ? 1 : 0;
336         int i_width = h->param.i_width >> i_subsample;
337         int i_height = h->param.i_height >> i_subsample;
338         int i_padx = (h->sps->i_mb_width * 16 - h->param.i_width) >> i_subsample;
339         int i_pady = (h->sps->i_mb_height * 16 - h->param.i_height) >> i_subsample;
340
341         if( i_padx )
342         {
343             for( int y = 0; y < i_height; y++ )
344                 memset( &frame->plane[i][y*frame->i_stride[i] + i_width],
345                          frame->plane[i][y*frame->i_stride[i] + i_width - 1],
346                          i_padx );
347         }
348         if( i_pady )
349         {
350             for( int y = i_height; y < i_height + i_pady; y++ )
351                 memcpy( &frame->plane[i][y*frame->i_stride[i]],
352                         &frame->plane[i][(i_height-(~y&h->param.b_interlaced)-1)*frame->i_stride[i]],
353                         i_width + i_padx );
354         }
355     }
356 }
357
358 /* threading */
359 void x264_frame_cond_broadcast( x264_frame_t *frame, int i_lines_completed )
360 {
361     x264_pthread_mutex_lock( &frame->mutex );
362     frame->i_lines_completed = i_lines_completed;
363     x264_pthread_cond_broadcast( &frame->cv );
364     x264_pthread_mutex_unlock( &frame->mutex );
365 }
366
367 void x264_frame_cond_wait( x264_frame_t *frame, int i_lines_completed )
368 {
369     x264_pthread_mutex_lock( &frame->mutex );
370     while( frame->i_lines_completed < i_lines_completed )
371         x264_pthread_cond_wait( &frame->cv, &frame->mutex );
372     x264_pthread_mutex_unlock( &frame->mutex );
373 }
374
375 /* list operators */
376
377 void x264_frame_push( x264_frame_t **list, x264_frame_t *frame )
378 {
379     int i = 0;
380     while( list[i] ) i++;
381     list[i] = frame;
382 }
383
384 x264_frame_t *x264_frame_pop( x264_frame_t **list )
385 {
386     x264_frame_t *frame;
387     int i = 0;
388     assert( list[0] );
389     while( list[i+1] ) i++;
390     frame = list[i];
391     list[i] = NULL;
392     return frame;
393 }
394
395 void x264_frame_unshift( x264_frame_t **list, x264_frame_t *frame )
396 {
397     int i = 0;
398     while( list[i] ) i++;
399     while( i-- )
400         list[i+1] = list[i];
401     list[0] = frame;
402 }
403
404 x264_frame_t *x264_frame_shift( x264_frame_t **list )
405 {
406     x264_frame_t *frame = list[0];
407     int i;
408     for( i = 0; list[i]; i++ )
409         list[i] = list[i+1];
410     assert(frame);
411     return frame;
412 }
413
414 void x264_frame_push_unused( x264_t *h, x264_frame_t *frame )
415 {
416     assert( frame->i_reference_count > 0 );
417     frame->i_reference_count--;
418     if( frame->i_reference_count == 0 )
419         x264_frame_push( h->frames.unused[frame->b_fdec], frame );
420 }
421
422 x264_frame_t *x264_frame_pop_unused( x264_t *h, int b_fdec )
423 {
424     x264_frame_t *frame;
425     if( h->frames.unused[b_fdec][0] )
426         frame = x264_frame_pop( h->frames.unused[b_fdec] );
427     else
428         frame = x264_frame_new( h, b_fdec );
429     if( !frame )
430         return NULL;
431     frame->b_last_minigop_bframe = 0;
432     frame->i_reference_count = 1;
433     frame->b_intra_calculated = 0;
434     frame->b_scenecut = 1;
435     frame->b_keyframe = 0;
436
437     memset( frame->weight, 0, sizeof(frame->weight) );
438     memset( frame->f_weighted_cost_delta, 0, sizeof(frame->f_weighted_cost_delta) );
439
440     return frame;
441 }
442
443 void x264_frame_push_blank_unused( x264_t *h, x264_frame_t *frame )
444 {
445     assert( frame->i_reference_count > 0 );
446     frame->i_reference_count--;
447     if( frame->i_reference_count == 0 )
448         x264_frame_push( h->frames.blank_unused, frame );
449 }
450
451 x264_frame_t *x264_frame_pop_blank_unused( x264_t *h )
452 {
453     x264_frame_t *frame;
454     if( h->frames.blank_unused[0] )
455         frame = x264_frame_pop( h->frames.blank_unused );
456     else
457         frame = x264_malloc( sizeof(x264_frame_t) );
458     if( !frame )
459         return NULL;
460     frame->b_duplicate = 1;
461     frame->i_reference_count = 1;
462     return frame;
463 }
464
465 void x264_frame_sort( x264_frame_t **list, int b_dts )
466 {
467     int b_ok;
468     do {
469         b_ok = 1;
470         for( int i = 0; list[i+1]; i++ )
471         {
472             int dtype = list[i]->i_type - list[i+1]->i_type;
473             int dtime = list[i]->i_frame - list[i+1]->i_frame;
474             int swap = b_dts ? dtype > 0 || ( dtype == 0 && dtime > 0 )
475                              : dtime > 0;
476             if( swap )
477             {
478                 XCHG( x264_frame_t*, list[i], list[i+1] );
479                 b_ok = 0;
480             }
481         }
482     } while( !b_ok );
483 }
484
485 void x264_weight_scale_plane( x264_t *h, uint8_t *dst, int i_dst_stride, uint8_t *src, int i_src_stride,
486                          int i_width, int i_height, x264_weight_t *w )
487 {
488     /* Weight horizontal strips of height 16. This was found to be the optimal height
489      * in terms of the cache loads. */
490     while( i_height > 0 )
491     {
492         for( int x = 0; x < i_width; x += 16 )
493             w->weightfn[16>>2]( dst+x, i_dst_stride, src+x, i_src_stride, w, X264_MIN( i_height, 16 ) );
494         i_height -= 16;
495         dst += 16 * i_dst_stride;
496         src += 16 * i_src_stride;
497     }
498 }
499
500 void x264_frame_delete_list( x264_frame_t **list )
501 {
502     int i = 0;
503     if( !list )
504         return;
505     while( list[i] )
506         x264_frame_delete( list[i++] );
507     x264_free( list );
508 }
509
510 int x264_synch_frame_list_init( x264_synch_frame_list_t *slist, int max_size )
511 {
512     if( max_size < 0 )
513         return -1;
514     slist->i_max_size = max_size;
515     slist->i_size = 0;
516     CHECKED_MALLOCZERO( slist->list, (max_size+1) * sizeof(x264_frame_t*) );
517     if( x264_pthread_mutex_init( &slist->mutex, NULL ) ||
518         x264_pthread_cond_init( &slist->cv_fill, NULL ) ||
519         x264_pthread_cond_init( &slist->cv_empty, NULL ) )
520         return -1;
521     return 0;
522 fail:
523     return -1;
524 }
525
526 void x264_synch_frame_list_delete( x264_synch_frame_list_t *slist )
527 {
528     x264_pthread_mutex_destroy( &slist->mutex );
529     x264_pthread_cond_destroy( &slist->cv_fill );
530     x264_pthread_cond_destroy( &slist->cv_empty );
531     x264_frame_delete_list( slist->list );
532 }
533
534 void x264_synch_frame_list_push( x264_synch_frame_list_t *slist, x264_frame_t *frame )
535 {
536     x264_pthread_mutex_lock( &slist->mutex );
537     while( slist->i_size == slist->i_max_size )
538         x264_pthread_cond_wait( &slist->cv_empty, &slist->mutex );
539     slist->list[ slist->i_size++ ] = frame;
540     x264_pthread_mutex_unlock( &slist->mutex );
541     x264_pthread_cond_broadcast( &slist->cv_fill );
542 }