Bump dates to 2011
[x262.git] / encoder / lookahead.c
1 /*****************************************************************************
2  * lookahead.c: high-level lookahead functions
3  *****************************************************************************
4  * Copyright (C) 2010-2011 Avail Media and x264 project
5  *
6  * Authors: Michael Kazmier <mkazmier@availmedia.com>
7  *          Alex Giladi <agiladi@availmedia.com>
8  *          Steven Walters <kemuri9@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  * This program is also available under a commercial proprietary license.
25  * For more information, contact us at licensing@x264.com.
26  *****************************************************************************/
27
28 /* LOOKAHEAD (threaded and non-threaded mode)
29  *
30  * Lookahead types:
31  *     [1] Slice type / scene cut;
32  *
33  * In non-threaded mode, we run the existing slicetype decision code as it was.
34  * In threaded mode, we run in a separate thread, that lives between the calls
35  * to x264_encoder_open() and x264_encoder_close(), and performs lookahead for
36  * the number of frames specified in rc_lookahead.  Recommended setting is
37  * # of bframes + # of threads.
38  */
39 #include "common/common.h"
40 #include "analyse.h"
41
42 static void x264_lookahead_shift( x264_sync_frame_list_t *dst, x264_sync_frame_list_t *src, int count )
43 {
44     int i = count;
45     while( i-- )
46     {
47         assert( dst->i_size < dst->i_max_size );
48         assert( src->i_size );
49         dst->list[ dst->i_size++ ] = x264_frame_shift( src->list );
50         src->i_size--;
51     }
52     if( count )
53     {
54         x264_pthread_cond_broadcast( &dst->cv_fill );
55         x264_pthread_cond_broadcast( &src->cv_empty );
56     }
57 }
58
59 static void x264_lookahead_update_last_nonb( x264_t *h, x264_frame_t *new_nonb )
60 {
61     if( h->lookahead->last_nonb )
62         x264_frame_push_unused( h, h->lookahead->last_nonb );
63     h->lookahead->last_nonb = new_nonb;
64     new_nonb->i_reference_count++;
65 }
66
67 #if HAVE_THREAD
68 static void x264_lookahead_slicetype_decide( x264_t *h )
69 {
70     x264_stack_align( x264_slicetype_decide, h );
71
72     x264_lookahead_update_last_nonb( h, h->lookahead->next.list[0] );
73
74     x264_pthread_mutex_lock( &h->lookahead->ofbuf.mutex );
75     while( h->lookahead->ofbuf.i_size == h->lookahead->ofbuf.i_max_size )
76         x264_pthread_cond_wait( &h->lookahead->ofbuf.cv_empty, &h->lookahead->ofbuf.mutex );
77
78     x264_pthread_mutex_lock( &h->lookahead->next.mutex );
79     x264_lookahead_shift( &h->lookahead->ofbuf, &h->lookahead->next, h->lookahead->next.list[0]->i_bframes + 1 );
80     x264_pthread_mutex_unlock( &h->lookahead->next.mutex );
81
82     /* For MB-tree and VBV lookahead, we have to perform propagation analysis on I-frames too. */
83     if( h->lookahead->b_analyse_keyframe && IS_X264_TYPE_I( h->lookahead->last_nonb->i_type ) )
84         x264_stack_align( x264_slicetype_analyse, h, 1 );
85
86     x264_pthread_mutex_unlock( &h->lookahead->ofbuf.mutex );
87 }
88
89 static void x264_lookahead_thread( x264_t *h )
90 {
91     int shift;
92 #if HAVE_MMX
93     if( h->param.cpu&X264_CPU_SSE_MISALIGN )
94         x264_cpu_mask_misalign_sse();
95 #endif
96     while( !h->lookahead->b_exit_thread )
97     {
98         x264_pthread_mutex_lock( &h->lookahead->ifbuf.mutex );
99         x264_pthread_mutex_lock( &h->lookahead->next.mutex );
100         shift = X264_MIN( h->lookahead->next.i_max_size - h->lookahead->next.i_size, h->lookahead->ifbuf.i_size );
101         x264_lookahead_shift( &h->lookahead->next, &h->lookahead->ifbuf, shift );
102         x264_pthread_mutex_unlock( &h->lookahead->next.mutex );
103         if( h->lookahead->next.i_size <= h->lookahead->i_slicetype_length )
104         {
105             while( !h->lookahead->ifbuf.i_size && !h->lookahead->b_exit_thread )
106                 x264_pthread_cond_wait( &h->lookahead->ifbuf.cv_fill, &h->lookahead->ifbuf.mutex );
107             x264_pthread_mutex_unlock( &h->lookahead->ifbuf.mutex );
108         }
109         else
110         {
111             x264_pthread_mutex_unlock( &h->lookahead->ifbuf.mutex );
112             x264_lookahead_slicetype_decide( h );
113         }
114     }   /* end of input frames */
115     x264_pthread_mutex_lock( &h->lookahead->ifbuf.mutex );
116     x264_pthread_mutex_lock( &h->lookahead->next.mutex );
117     x264_lookahead_shift( &h->lookahead->next, &h->lookahead->ifbuf, h->lookahead->ifbuf.i_size );
118     x264_pthread_mutex_unlock( &h->lookahead->next.mutex );
119     x264_pthread_mutex_unlock( &h->lookahead->ifbuf.mutex );
120     while( h->lookahead->next.i_size )
121         x264_lookahead_slicetype_decide( h );
122     x264_pthread_mutex_lock( &h->lookahead->ofbuf.mutex );
123     h->lookahead->b_thread_active = 0;
124     x264_pthread_cond_broadcast( &h->lookahead->ofbuf.cv_fill );
125     x264_pthread_mutex_unlock( &h->lookahead->ofbuf.mutex );
126 }
127 #endif
128
129 int x264_lookahead_init( x264_t *h, int i_slicetype_length )
130 {
131     x264_lookahead_t *look;
132     CHECKED_MALLOCZERO( look, sizeof(x264_lookahead_t) );
133     for( int i = 0; i < h->param.i_threads; i++ )
134         h->thread[i]->lookahead = look;
135
136     look->i_last_keyframe = - h->param.i_keyint_max;
137     look->b_analyse_keyframe = (h->param.rc.b_mb_tree || (h->param.rc.i_vbv_buffer_size && h->param.rc.i_lookahead))
138                                && !h->param.rc.b_stat_read;
139     look->i_slicetype_length = i_slicetype_length;
140
141     /* init frame lists */
142     if( x264_sync_frame_list_init( &look->ifbuf, h->param.i_sync_lookahead+3 ) ||
143         x264_sync_frame_list_init( &look->next, h->frames.i_delay+3 ) ||
144         x264_sync_frame_list_init( &look->ofbuf, h->frames.i_delay+3 ) )
145         goto fail;
146
147     if( !h->param.i_sync_lookahead )
148         return 0;
149
150     x264_t *look_h = h->thread[h->param.i_threads];
151     *look_h = *h;
152     if( x264_macroblock_cache_allocate( look_h ) )
153         goto fail;
154
155     if( x264_macroblock_thread_allocate( look_h, 1 ) < 0 )
156         goto fail;
157
158     if( x264_pthread_create( &look->thread_handle, NULL, (void*)x264_lookahead_thread, look_h ) )
159         goto fail;
160     look->b_thread_active = 1;
161
162     return 0;
163 fail:
164     x264_free( look );
165     return -1;
166 }
167
168 void x264_lookahead_delete( x264_t *h )
169 {
170     if( h->param.i_sync_lookahead )
171     {
172         x264_pthread_mutex_lock( &h->lookahead->ifbuf.mutex );
173         h->lookahead->b_exit_thread = 1;
174         x264_pthread_cond_broadcast( &h->lookahead->ifbuf.cv_fill );
175         x264_pthread_mutex_unlock( &h->lookahead->ifbuf.mutex );
176         x264_pthread_join( h->lookahead->thread_handle, NULL );
177         x264_macroblock_cache_free( h->thread[h->param.i_threads] );
178         x264_macroblock_thread_free( h->thread[h->param.i_threads], 1 );
179         x264_free( h->thread[h->param.i_threads] );
180     }
181     x264_sync_frame_list_delete( &h->lookahead->ifbuf );
182     x264_sync_frame_list_delete( &h->lookahead->next );
183     if( h->lookahead->last_nonb )
184         x264_frame_push_unused( h, h->lookahead->last_nonb );
185     x264_sync_frame_list_delete( &h->lookahead->ofbuf );
186     x264_free( h->lookahead );
187 }
188
189 void x264_lookahead_put_frame( x264_t *h, x264_frame_t *frame )
190 {
191     if( h->param.i_sync_lookahead )
192         x264_sync_frame_list_push( &h->lookahead->ifbuf, frame );
193     else
194         x264_sync_frame_list_push( &h->lookahead->next, frame );
195 }
196
197 int x264_lookahead_is_empty( x264_t *h )
198 {
199     x264_pthread_mutex_lock( &h->lookahead->ofbuf.mutex );
200     x264_pthread_mutex_lock( &h->lookahead->next.mutex );
201     int b_empty = !h->lookahead->next.i_size && !h->lookahead->ofbuf.i_size;
202     x264_pthread_mutex_unlock( &h->lookahead->next.mutex );
203     x264_pthread_mutex_unlock( &h->lookahead->ofbuf.mutex );
204     return b_empty;
205 }
206
207 static void x264_lookahead_encoder_shift( x264_t *h )
208 {
209     if( !h->lookahead->ofbuf.i_size )
210         return;
211     int i_frames = h->lookahead->ofbuf.list[0]->i_bframes + 1;
212     while( i_frames-- )
213     {
214         x264_frame_push( h->frames.current, x264_frame_shift( h->lookahead->ofbuf.list ) );
215         h->lookahead->ofbuf.i_size--;
216     }
217     x264_pthread_cond_broadcast( &h->lookahead->ofbuf.cv_empty );
218 }
219
220 void x264_lookahead_get_frames( x264_t *h )
221 {
222     if( h->param.i_sync_lookahead )
223     {   /* We have a lookahead thread, so get frames from there */
224         x264_pthread_mutex_lock( &h->lookahead->ofbuf.mutex );
225         while( !h->lookahead->ofbuf.i_size && h->lookahead->b_thread_active )
226             x264_pthread_cond_wait( &h->lookahead->ofbuf.cv_fill, &h->lookahead->ofbuf.mutex );
227         x264_lookahead_encoder_shift( h );
228         x264_pthread_mutex_unlock( &h->lookahead->ofbuf.mutex );
229     }
230     else
231     {   /* We are not running a lookahead thread, so perform all the slicetype decide on the fly */
232
233         if( h->frames.current[0] || !h->lookahead->next.i_size )
234             return;
235
236         x264_stack_align( x264_slicetype_decide, h );
237         x264_lookahead_update_last_nonb( h, h->lookahead->next.list[0] );
238         x264_lookahead_shift( &h->lookahead->ofbuf, &h->lookahead->next, h->lookahead->next.list[0]->i_bframes + 1 );
239
240         /* For MB-tree and VBV lookahead, we have to perform propagation analysis on I-frames too. */
241         if( h->lookahead->b_analyse_keyframe && IS_X264_TYPE_I( h->lookahead->last_nonb->i_type ) )
242             x264_stack_align( x264_slicetype_analyse, h, 1 );
243
244         x264_lookahead_encoder_shift( h );
245     }
246 }