pthread: make sure AVFrame.extended_data is set properly.
[ffmpeg.git] / libavcodec / pthread.c
1 /*
2  * Copyright (c) 2004 Roman Shaposhnik
3  * Copyright (c) 2008 Alexander Strange (astrange@ithinksw.com)
4  *
5  * Many thanks to Steven M. Schultz for providing clever ideas and
6  * to Michael Niedermayer <michaelni@gmx.at> for writing initial
7  * implementation.
8  *
9  * This file is part of Libav.
10  *
11  * Libav is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * Libav is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public
22  * License along with Libav; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24  */
25
26 /**
27  * @file
28  * Multithreading support functions
29  * @see doc/multithreading.txt
30  */
31
32 #include "config.h"
33
34 #if HAVE_SCHED_GETAFFINITY
35 #define _GNU_SOURCE
36 #include <sched.h>
37 #endif
38 #if HAVE_GETPROCESSAFFINITYMASK
39 #include <windows.h>
40 #endif
41 #if HAVE_SYSCTL
42 #if HAVE_SYS_PARAM_H
43 #include <sys/param.h>
44 #endif
45 #include <sys/types.h>
46 #include <sys/sysctl.h>
47 #endif
48 #if HAVE_SYSCONF
49 #include <unistd.h>
50 #endif
51
52 #include "avcodec.h"
53 #include "internal.h"
54 #include "thread.h"
55 #include "libavutil/common.h"
56
57 #if HAVE_PTHREADS
58 #include <pthread.h>
59 #elif HAVE_W32THREADS
60 #include "w32pthreads.h"
61 #endif
62
63 typedef int (action_func)(AVCodecContext *c, void *arg);
64 typedef int (action_func2)(AVCodecContext *c, void *arg, int jobnr, int threadnr);
65
66 typedef struct ThreadContext {
67     pthread_t *workers;
68     action_func *func;
69     action_func2 *func2;
70     void *args;
71     int *rets;
72     int rets_count;
73     int job_count;
74     int job_size;
75
76     pthread_cond_t last_job_cond;
77     pthread_cond_t current_job_cond;
78     pthread_mutex_t current_job_lock;
79     int current_job;
80     int done;
81 } ThreadContext;
82
83 /// Max number of frame buffers that can be allocated when using frame threads.
84 #define MAX_BUFFERS (32+1)
85
86 /**
87  * Context used by codec threads and stored in their AVCodecContext thread_opaque.
88  */
89 typedef struct PerThreadContext {
90     struct FrameThreadContext *parent;
91
92     pthread_t      thread;
93     int            thread_init;
94     pthread_cond_t input_cond;      ///< Used to wait for a new packet from the main thread.
95     pthread_cond_t progress_cond;   ///< Used by child threads to wait for progress to change.
96     pthread_cond_t output_cond;     ///< Used by the main thread to wait for frames to finish.
97
98     pthread_mutex_t mutex;          ///< Mutex used to protect the contents of the PerThreadContext.
99     pthread_mutex_t progress_mutex; ///< Mutex used to protect frame progress values and progress_cond.
100
101     AVCodecContext *avctx;          ///< Context used to decode packets passed to this thread.
102
103     AVPacket       avpkt;           ///< Input packet (for decoding) or output (for encoding).
104     int            allocated_buf_size; ///< Size allocated for avpkt.data
105
106     AVFrame frame;                  ///< Output frame (for decoding) or input (for encoding).
107     int     got_frame;              ///< The output of got_picture_ptr from the last avcodec_decode_video() call.
108     int     result;                 ///< The result of the last codec decode/encode() call.
109
110     enum {
111         STATE_INPUT_READY,          ///< Set when the thread is awaiting a packet.
112         STATE_SETTING_UP,           ///< Set before the codec has called ff_thread_finish_setup().
113         STATE_GET_BUFFER,           /**<
114                                      * Set when the codec calls get_buffer().
115                                      * State is returned to STATE_SETTING_UP afterwards.
116                                      */
117         STATE_SETUP_FINISHED        ///< Set after the codec has called ff_thread_finish_setup().
118     } state;
119
120     /**
121      * Array of frames passed to ff_thread_release_buffer().
122      * Frames are released after all threads referencing them are finished.
123      */
124     AVFrame released_buffers[MAX_BUFFERS];
125     int     num_released_buffers;
126
127     /**
128      * Array of progress values used by ff_thread_get_buffer().
129      */
130     int     progress[MAX_BUFFERS][2];
131     uint8_t progress_used[MAX_BUFFERS];
132
133     AVFrame *requested_frame;       ///< AVFrame the codec passed to get_buffer()
134 } PerThreadContext;
135
136 /**
137  * Context stored in the client AVCodecContext thread_opaque.
138  */
139 typedef struct FrameThreadContext {
140     PerThreadContext *threads;     ///< The contexts for each thread.
141     PerThreadContext *prev_thread; ///< The last thread submit_packet() was called on.
142
143     pthread_mutex_t buffer_mutex;  ///< Mutex used to protect get/release_buffer().
144
145     int next_decoding;             ///< The next context to submit a packet to.
146     int next_finished;             ///< The next context to return output from.
147
148     int delaying;                  /**<
149                                     * Set for the first N packets, where N is the number of threads.
150                                     * While it is set, ff_thread_en/decode_frame won't return any results.
151                                     */
152
153     int die;                       ///< Set when threads should exit.
154 } FrameThreadContext;
155
156
157 /* H264 slice threading seems to be buggy with more than 16 threads,
158  * limit the number of threads to 16 for automatic detection */
159 #define MAX_AUTO_THREADS 16
160
161 static int get_logical_cpus(AVCodecContext *avctx)
162 {
163     int ret, nb_cpus = 1;
164 #if HAVE_SCHED_GETAFFINITY && defined(CPU_COUNT)
165     cpu_set_t cpuset;
166
167     CPU_ZERO(&cpuset);
168
169     ret = sched_getaffinity(0, sizeof(cpuset), &cpuset);
170     if (!ret) {
171         nb_cpus = CPU_COUNT(&cpuset);
172     }
173 #elif HAVE_GETPROCESSAFFINITYMASK
174     DWORD_PTR proc_aff, sys_aff;
175     ret = GetProcessAffinityMask(GetCurrentProcess(), &proc_aff, &sys_aff);
176     if (ret)
177         nb_cpus = av_popcount64(proc_aff);
178 #elif HAVE_SYSCTL && defined(HW_NCPU)
179     int mib[2] = { CTL_HW, HW_NCPU };
180     size_t len = sizeof(nb_cpus);
181
182     ret = sysctl(mib, 2, &nb_cpus, &len, NULL, 0);
183     if (ret == -1)
184         nb_cpus = 0;
185 #elif HAVE_SYSCONF && defined(_SC_NPROC_ONLN)
186     nb_cpus = sysconf(_SC_NPROC_ONLN);
187 #elif HAVE_SYSCONF && defined(_SC_NPROCESSORS_ONLN)
188     nb_cpus = sysconf(_SC_NPROCESSORS_ONLN);
189 #endif
190     av_log(avctx, AV_LOG_DEBUG, "detected %d logical cores\n", nb_cpus);
191     return nb_cpus;
192 }
193
194
195 static void* attribute_align_arg worker(void *v)
196 {
197     AVCodecContext *avctx = v;
198     ThreadContext *c = avctx->thread_opaque;
199     int our_job = c->job_count;
200     int thread_count = avctx->thread_count;
201     int self_id;
202
203     pthread_mutex_lock(&c->current_job_lock);
204     self_id = c->current_job++;
205     for (;;){
206         while (our_job >= c->job_count) {
207             if (c->current_job == thread_count + c->job_count)
208                 pthread_cond_signal(&c->last_job_cond);
209
210             pthread_cond_wait(&c->current_job_cond, &c->current_job_lock);
211             our_job = self_id;
212
213             if (c->done) {
214                 pthread_mutex_unlock(&c->current_job_lock);
215                 return NULL;
216             }
217         }
218         pthread_mutex_unlock(&c->current_job_lock);
219
220         c->rets[our_job%c->rets_count] = c->func ? c->func(avctx, (char*)c->args + our_job*c->job_size):
221                                                    c->func2(avctx, c->args, our_job, self_id);
222
223         pthread_mutex_lock(&c->current_job_lock);
224         our_job = c->current_job++;
225     }
226 }
227
228 static av_always_inline void avcodec_thread_park_workers(ThreadContext *c, int thread_count)
229 {
230     pthread_cond_wait(&c->last_job_cond, &c->current_job_lock);
231     pthread_mutex_unlock(&c->current_job_lock);
232 }
233
234 static void thread_free(AVCodecContext *avctx)
235 {
236     ThreadContext *c = avctx->thread_opaque;
237     int i;
238
239     pthread_mutex_lock(&c->current_job_lock);
240     c->done = 1;
241     pthread_cond_broadcast(&c->current_job_cond);
242     pthread_mutex_unlock(&c->current_job_lock);
243
244     for (i=0; i<avctx->thread_count; i++)
245          pthread_join(c->workers[i], NULL);
246
247     pthread_mutex_destroy(&c->current_job_lock);
248     pthread_cond_destroy(&c->current_job_cond);
249     pthread_cond_destroy(&c->last_job_cond);
250     av_free(c->workers);
251     av_freep(&avctx->thread_opaque);
252 }
253
254 static int avcodec_thread_execute(AVCodecContext *avctx, action_func* func, void *arg, int *ret, int job_count, int job_size)
255 {
256     ThreadContext *c= avctx->thread_opaque;
257     int dummy_ret;
258
259     if (!(avctx->active_thread_type&FF_THREAD_SLICE) || avctx->thread_count <= 1)
260         return avcodec_default_execute(avctx, func, arg, ret, job_count, job_size);
261
262     if (job_count <= 0)
263         return 0;
264
265     pthread_mutex_lock(&c->current_job_lock);
266
267     c->current_job = avctx->thread_count;
268     c->job_count = job_count;
269     c->job_size = job_size;
270     c->args = arg;
271     c->func = func;
272     if (ret) {
273         c->rets = ret;
274         c->rets_count = job_count;
275     } else {
276         c->rets = &dummy_ret;
277         c->rets_count = 1;
278     }
279     pthread_cond_broadcast(&c->current_job_cond);
280
281     avcodec_thread_park_workers(c, avctx->thread_count);
282
283     return 0;
284 }
285
286 static int avcodec_thread_execute2(AVCodecContext *avctx, action_func2* func2, void *arg, int *ret, int job_count)
287 {
288     ThreadContext *c= avctx->thread_opaque;
289     c->func2 = func2;
290     return avcodec_thread_execute(avctx, NULL, arg, ret, job_count, 0);
291 }
292
293 static int thread_init(AVCodecContext *avctx)
294 {
295     int i;
296     ThreadContext *c;
297     int thread_count = avctx->thread_count;
298
299     if (!thread_count) {
300         int nb_cpus = get_logical_cpus(avctx);
301         // use number of cores + 1 as thread count if there is more than one
302         if (nb_cpus > 1)
303             thread_count = avctx->thread_count = FFMIN(nb_cpus + 1, MAX_AUTO_THREADS);
304         else
305             thread_count = avctx->thread_count = 1;
306     }
307
308     if (thread_count <= 1) {
309         avctx->active_thread_type = 0;
310         return 0;
311     }
312
313     c = av_mallocz(sizeof(ThreadContext));
314     if (!c)
315         return -1;
316
317     c->workers = av_mallocz(sizeof(pthread_t)*thread_count);
318     if (!c->workers) {
319         av_free(c);
320         return -1;
321     }
322
323     avctx->thread_opaque = c;
324     c->current_job = 0;
325     c->job_count = 0;
326     c->job_size = 0;
327     c->done = 0;
328     pthread_cond_init(&c->current_job_cond, NULL);
329     pthread_cond_init(&c->last_job_cond, NULL);
330     pthread_mutex_init(&c->current_job_lock, NULL);
331     pthread_mutex_lock(&c->current_job_lock);
332     for (i=0; i<thread_count; i++) {
333         if(pthread_create(&c->workers[i], NULL, worker, avctx)) {
334            avctx->thread_count = i;
335            pthread_mutex_unlock(&c->current_job_lock);
336            ff_thread_free(avctx);
337            return -1;
338         }
339     }
340
341     avcodec_thread_park_workers(c, thread_count);
342
343     avctx->execute = avcodec_thread_execute;
344     avctx->execute2 = avcodec_thread_execute2;
345     return 0;
346 }
347
348 /**
349  * Codec worker thread.
350  *
351  * Automatically calls ff_thread_finish_setup() if the codec does
352  * not provide an update_thread_context method, or if the codec returns
353  * before calling it.
354  */
355 static attribute_align_arg void *frame_worker_thread(void *arg)
356 {
357     PerThreadContext *p = arg;
358     FrameThreadContext *fctx = p->parent;
359     AVCodecContext *avctx = p->avctx;
360     const AVCodec *codec = avctx->codec;
361
362     while (1) {
363         if (p->state == STATE_INPUT_READY && !fctx->die) {
364             pthread_mutex_lock(&p->mutex);
365             while (p->state == STATE_INPUT_READY && !fctx->die)
366                 pthread_cond_wait(&p->input_cond, &p->mutex);
367             pthread_mutex_unlock(&p->mutex);
368         }
369
370         if (fctx->die) break;
371
372         if (!codec->update_thread_context && avctx->thread_safe_callbacks)
373             ff_thread_finish_setup(avctx);
374
375         pthread_mutex_lock(&p->mutex);
376         avcodec_get_frame_defaults(&p->frame);
377         p->got_frame = 0;
378         p->result = codec->decode(avctx, &p->frame, &p->got_frame, &p->avpkt);
379
380         /* many decoders assign whole AVFrames, thus overwriting extended_data;
381          * make sure it's set correctly */
382         p->frame.extended_data = p->frame.data;
383
384         if (p->state == STATE_SETTING_UP) ff_thread_finish_setup(avctx);
385
386         p->state = STATE_INPUT_READY;
387
388         pthread_mutex_lock(&p->progress_mutex);
389         pthread_cond_signal(&p->output_cond);
390         pthread_mutex_unlock(&p->progress_mutex);
391
392         pthread_mutex_unlock(&p->mutex);
393     }
394
395     return NULL;
396 }
397
398 /**
399  * Update the next thread's AVCodecContext with values from the reference thread's context.
400  *
401  * @param dst The destination context.
402  * @param src The source context.
403  * @param for_user 0 if the destination is a codec thread, 1 if the destination is the user's thread
404  */
405 static int update_context_from_thread(AVCodecContext *dst, AVCodecContext *src, int for_user)
406 {
407     int err = 0;
408
409     if (dst != src) {
410         dst->time_base = src->time_base;
411         dst->width     = src->width;
412         dst->height    = src->height;
413         dst->pix_fmt   = src->pix_fmt;
414
415         dst->coded_width  = src->coded_width;
416         dst->coded_height = src->coded_height;
417
418         dst->has_b_frames = src->has_b_frames;
419         dst->idct_algo    = src->idct_algo;
420
421         dst->bits_per_coded_sample = src->bits_per_coded_sample;
422         dst->sample_aspect_ratio   = src->sample_aspect_ratio;
423         dst->dtg_active_format     = src->dtg_active_format;
424
425         dst->profile = src->profile;
426         dst->level   = src->level;
427
428         dst->bits_per_raw_sample = src->bits_per_raw_sample;
429         dst->ticks_per_frame     = src->ticks_per_frame;
430         dst->color_primaries     = src->color_primaries;
431
432         dst->color_trc   = src->color_trc;
433         dst->colorspace  = src->colorspace;
434         dst->color_range = src->color_range;
435         dst->chroma_sample_location = src->chroma_sample_location;
436     }
437
438     if (for_user) {
439         dst->coded_frame = src->coded_frame;
440     } else {
441         if (dst->codec->update_thread_context)
442             err = dst->codec->update_thread_context(dst, src);
443     }
444
445     return err;
446 }
447
448 /**
449  * Update the next thread's AVCodecContext with values set by the user.
450  *
451  * @param dst The destination context.
452  * @param src The source context.
453  * @return 0 on success, negative error code on failure
454  */
455 static int update_context_from_user(AVCodecContext *dst, AVCodecContext *src)
456 {
457 #define copy_fields(s, e) memcpy(&dst->s, &src->s, (char*)&dst->e - (char*)&dst->s);
458     dst->flags          = src->flags;
459
460     dst->draw_horiz_band= src->draw_horiz_band;
461     dst->get_buffer     = src->get_buffer;
462     dst->release_buffer = src->release_buffer;
463
464     dst->opaque   = src->opaque;
465     dst->debug    = src->debug;
466     dst->debug_mv = src->debug_mv;
467
468     dst->slice_flags = src->slice_flags;
469     dst->flags2      = src->flags2;
470
471     copy_fields(skip_loop_filter, subtitle_header);
472
473     dst->frame_number     = src->frame_number;
474     dst->reordered_opaque = src->reordered_opaque;
475
476     if (src->slice_count && src->slice_offset) {
477         if (dst->slice_count < src->slice_count) {
478             int *tmp = av_realloc(dst->slice_offset, src->slice_count *
479                                   sizeof(*dst->slice_offset));
480             if (!tmp) {
481                 av_free(dst->slice_offset);
482                 return AVERROR(ENOMEM);
483             }
484             dst->slice_offset = tmp;
485         }
486         memcpy(dst->slice_offset, src->slice_offset,
487                src->slice_count * sizeof(*dst->slice_offset));
488     }
489     dst->slice_count = src->slice_count;
490     return 0;
491 #undef copy_fields
492 }
493
494 static void free_progress(AVFrame *f)
495 {
496     PerThreadContext *p = f->owner->thread_opaque;
497     int *progress = f->thread_opaque;
498
499     p->progress_used[(progress - p->progress[0]) / 2] = 0;
500 }
501
502 /// Releases the buffers that this decoding thread was the last user of.
503 static void release_delayed_buffers(PerThreadContext *p)
504 {
505     FrameThreadContext *fctx = p->parent;
506
507     while (p->num_released_buffers > 0) {
508         AVFrame *f;
509
510         pthread_mutex_lock(&fctx->buffer_mutex);
511         f = &p->released_buffers[--p->num_released_buffers];
512         free_progress(f);
513         f->thread_opaque = NULL;
514
515         f->owner->release_buffer(f->owner, f);
516         pthread_mutex_unlock(&fctx->buffer_mutex);
517     }
518 }
519
520 static int submit_packet(PerThreadContext *p, AVPacket *avpkt)
521 {
522     FrameThreadContext *fctx = p->parent;
523     PerThreadContext *prev_thread = fctx->prev_thread;
524     const AVCodec *codec = p->avctx->codec;
525     uint8_t *buf = p->avpkt.data;
526
527     if (!avpkt->size && !(codec->capabilities & CODEC_CAP_DELAY)) return 0;
528
529     pthread_mutex_lock(&p->mutex);
530
531     release_delayed_buffers(p);
532
533     if (prev_thread) {
534         int err;
535         if (prev_thread->state == STATE_SETTING_UP) {
536             pthread_mutex_lock(&prev_thread->progress_mutex);
537             while (prev_thread->state == STATE_SETTING_UP)
538                 pthread_cond_wait(&prev_thread->progress_cond, &prev_thread->progress_mutex);
539             pthread_mutex_unlock(&prev_thread->progress_mutex);
540         }
541
542         err = update_context_from_thread(p->avctx, prev_thread->avctx, 0);
543         if (err) {
544             pthread_mutex_unlock(&p->mutex);
545             return err;
546         }
547     }
548
549     av_fast_malloc(&buf, &p->allocated_buf_size, avpkt->size + FF_INPUT_BUFFER_PADDING_SIZE);
550     p->avpkt = *avpkt;
551     p->avpkt.data = buf;
552     memcpy(buf, avpkt->data, avpkt->size);
553     memset(buf + avpkt->size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
554
555     p->state = STATE_SETTING_UP;
556     pthread_cond_signal(&p->input_cond);
557     pthread_mutex_unlock(&p->mutex);
558
559     /*
560      * If the client doesn't have a thread-safe get_buffer(),
561      * then decoding threads call back to the main thread,
562      * and it calls back to the client here.
563      */
564
565     if (!p->avctx->thread_safe_callbacks &&
566          p->avctx->get_buffer != avcodec_default_get_buffer) {
567         while (p->state != STATE_SETUP_FINISHED && p->state != STATE_INPUT_READY) {
568             pthread_mutex_lock(&p->progress_mutex);
569             while (p->state == STATE_SETTING_UP)
570                 pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
571
572             if (p->state == STATE_GET_BUFFER) {
573                 p->result = p->avctx->get_buffer(p->avctx, p->requested_frame);
574                 p->state  = STATE_SETTING_UP;
575                 pthread_cond_signal(&p->progress_cond);
576             }
577             pthread_mutex_unlock(&p->progress_mutex);
578         }
579     }
580
581     fctx->prev_thread = p;
582     fctx->next_decoding++;
583
584     return 0;
585 }
586
587 int ff_thread_decode_frame(AVCodecContext *avctx,
588                            AVFrame *picture, int *got_picture_ptr,
589                            AVPacket *avpkt)
590 {
591     FrameThreadContext *fctx = avctx->thread_opaque;
592     int finished = fctx->next_finished;
593     PerThreadContext *p;
594     int err;
595
596     /*
597      * Submit a packet to the next decoding thread.
598      */
599
600     p = &fctx->threads[fctx->next_decoding];
601     err = update_context_from_user(p->avctx, avctx);
602     if (err) return err;
603     err = submit_packet(p, avpkt);
604     if (err) return err;
605
606     /*
607      * If we're still receiving the initial packets, don't return a frame.
608      */
609
610     if (fctx->delaying) {
611         if (fctx->next_decoding >= (avctx->thread_count-1)) fctx->delaying = 0;
612
613         *got_picture_ptr=0;
614         if (avpkt->size)
615             return avpkt->size;
616     }
617
618     /*
619      * Return the next available frame from the oldest thread.
620      * If we're at the end of the stream, then we have to skip threads that
621      * didn't output a frame, because we don't want to accidentally signal
622      * EOF (avpkt->size == 0 && *got_picture_ptr == 0).
623      */
624
625     do {
626         p = &fctx->threads[finished++];
627
628         if (p->state != STATE_INPUT_READY) {
629             pthread_mutex_lock(&p->progress_mutex);
630             while (p->state != STATE_INPUT_READY)
631                 pthread_cond_wait(&p->output_cond, &p->progress_mutex);
632             pthread_mutex_unlock(&p->progress_mutex);
633         }
634
635         *picture = p->frame;
636         *got_picture_ptr = p->got_frame;
637         picture->pkt_dts = p->avpkt.dts;
638
639         /*
640          * A later call with avkpt->size == 0 may loop over all threads,
641          * including this one, searching for a frame to return before being
642          * stopped by the "finished != fctx->next_finished" condition.
643          * Make sure we don't mistakenly return the same frame again.
644          */
645         p->got_frame = 0;
646
647         if (finished >= avctx->thread_count) finished = 0;
648     } while (!avpkt->size && !*got_picture_ptr && finished != fctx->next_finished);
649
650     update_context_from_thread(avctx, p->avctx, 1);
651
652     if (fctx->next_decoding >= avctx->thread_count) fctx->next_decoding = 0;
653
654     fctx->next_finished = finished;
655
656     /* return the size of the consumed packet if no error occurred */
657     return (p->result >= 0) ? avpkt->size : p->result;
658 }
659
660 void ff_thread_report_progress(AVFrame *f, int n, int field)
661 {
662     PerThreadContext *p;
663     int *progress = f->thread_opaque;
664
665     if (!progress || progress[field] >= n) return;
666
667     p = f->owner->thread_opaque;
668
669     if (f->owner->debug&FF_DEBUG_THREADS)
670         av_log(f->owner, AV_LOG_DEBUG, "%p finished %d field %d\n", progress, n, field);
671
672     pthread_mutex_lock(&p->progress_mutex);
673     progress[field] = n;
674     pthread_cond_broadcast(&p->progress_cond);
675     pthread_mutex_unlock(&p->progress_mutex);
676 }
677
678 void ff_thread_await_progress(AVFrame *f, int n, int field)
679 {
680     PerThreadContext *p;
681     int *progress = f->thread_opaque;
682
683     if (!progress || progress[field] >= n) return;
684
685     p = f->owner->thread_opaque;
686
687     if (f->owner->debug&FF_DEBUG_THREADS)
688         av_log(f->owner, AV_LOG_DEBUG, "thread awaiting %d field %d from %p\n", n, field, progress);
689
690     pthread_mutex_lock(&p->progress_mutex);
691     while (progress[field] < n)
692         pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
693     pthread_mutex_unlock(&p->progress_mutex);
694 }
695
696 void ff_thread_finish_setup(AVCodecContext *avctx) {
697     PerThreadContext *p = avctx->thread_opaque;
698
699     if (!(avctx->active_thread_type&FF_THREAD_FRAME)) return;
700
701     pthread_mutex_lock(&p->progress_mutex);
702     p->state = STATE_SETUP_FINISHED;
703     pthread_cond_broadcast(&p->progress_cond);
704     pthread_mutex_unlock(&p->progress_mutex);
705 }
706
707 /// Waits for all threads to finish.
708 static void park_frame_worker_threads(FrameThreadContext *fctx, int thread_count)
709 {
710     int i;
711
712     for (i = 0; i < thread_count; i++) {
713         PerThreadContext *p = &fctx->threads[i];
714
715         if (p->state != STATE_INPUT_READY) {
716             pthread_mutex_lock(&p->progress_mutex);
717             while (p->state != STATE_INPUT_READY)
718                 pthread_cond_wait(&p->output_cond, &p->progress_mutex);
719             pthread_mutex_unlock(&p->progress_mutex);
720         }
721     }
722 }
723
724 static void frame_thread_free(AVCodecContext *avctx, int thread_count)
725 {
726     FrameThreadContext *fctx = avctx->thread_opaque;
727     const AVCodec *codec = avctx->codec;
728     int i;
729
730     park_frame_worker_threads(fctx, thread_count);
731
732     if (fctx->prev_thread && fctx->prev_thread != fctx->threads)
733         update_context_from_thread(fctx->threads->avctx, fctx->prev_thread->avctx, 0);
734
735     fctx->die = 1;
736
737     for (i = 0; i < thread_count; i++) {
738         PerThreadContext *p = &fctx->threads[i];
739
740         pthread_mutex_lock(&p->mutex);
741         pthread_cond_signal(&p->input_cond);
742         pthread_mutex_unlock(&p->mutex);
743
744         if (p->thread_init)
745             pthread_join(p->thread, NULL);
746
747         if (codec->close)
748             codec->close(p->avctx);
749
750         avctx->codec = NULL;
751
752         release_delayed_buffers(p);
753     }
754
755     for (i = 0; i < thread_count; i++) {
756         PerThreadContext *p = &fctx->threads[i];
757
758         avcodec_default_free_buffers(p->avctx);
759
760         pthread_mutex_destroy(&p->mutex);
761         pthread_mutex_destroy(&p->progress_mutex);
762         pthread_cond_destroy(&p->input_cond);
763         pthread_cond_destroy(&p->progress_cond);
764         pthread_cond_destroy(&p->output_cond);
765         av_freep(&p->avpkt.data);
766
767         if (i) {
768             av_freep(&p->avctx->priv_data);
769             av_freep(&p->avctx->internal);
770             av_freep(&p->avctx->slice_offset);
771         }
772
773         av_freep(&p->avctx);
774     }
775
776     av_freep(&fctx->threads);
777     pthread_mutex_destroy(&fctx->buffer_mutex);
778     av_freep(&avctx->thread_opaque);
779 }
780
781 static int frame_thread_init(AVCodecContext *avctx)
782 {
783     int thread_count = avctx->thread_count;
784     const AVCodec *codec = avctx->codec;
785     AVCodecContext *src = avctx;
786     FrameThreadContext *fctx;
787     int i, err = 0;
788
789     if (!thread_count) {
790         int nb_cpus = get_logical_cpus(avctx);
791         // use number of cores + 1 as thread count if there is more than one
792         if (nb_cpus > 1)
793             thread_count = avctx->thread_count = FFMIN(nb_cpus + 1, MAX_AUTO_THREADS);
794         else
795             thread_count = avctx->thread_count = 1;
796     }
797
798     if (thread_count <= 1) {
799         avctx->active_thread_type = 0;
800         return 0;
801     }
802
803     avctx->thread_opaque = fctx = av_mallocz(sizeof(FrameThreadContext));
804
805     fctx->threads = av_mallocz(sizeof(PerThreadContext) * thread_count);
806     pthread_mutex_init(&fctx->buffer_mutex, NULL);
807     fctx->delaying = 1;
808
809     for (i = 0; i < thread_count; i++) {
810         AVCodecContext *copy = av_malloc(sizeof(AVCodecContext));
811         PerThreadContext *p  = &fctx->threads[i];
812
813         pthread_mutex_init(&p->mutex, NULL);
814         pthread_mutex_init(&p->progress_mutex, NULL);
815         pthread_cond_init(&p->input_cond, NULL);
816         pthread_cond_init(&p->progress_cond, NULL);
817         pthread_cond_init(&p->output_cond, NULL);
818
819         p->parent = fctx;
820         p->avctx  = copy;
821
822         if (!copy) {
823             err = AVERROR(ENOMEM);
824             goto error;
825         }
826
827         *copy = *src;
828         copy->thread_opaque = p;
829         copy->pkt = &p->avpkt;
830
831         if (!i) {
832             src = copy;
833
834             if (codec->init)
835                 err = codec->init(copy);
836
837             update_context_from_thread(avctx, copy, 1);
838         } else {
839             copy->priv_data = av_malloc(codec->priv_data_size);
840             if (!copy->priv_data) {
841                 err = AVERROR(ENOMEM);
842                 goto error;
843             }
844             memcpy(copy->priv_data, src->priv_data, codec->priv_data_size);
845             copy->internal = av_malloc(sizeof(AVCodecInternal));
846             if (!copy->internal) {
847                 err = AVERROR(ENOMEM);
848                 goto error;
849             }
850             *copy->internal = *src->internal;
851             copy->internal->is_copy = 1;
852
853             if (codec->init_thread_copy)
854                 err = codec->init_thread_copy(copy);
855         }
856
857         if (err) goto error;
858
859         if (!pthread_create(&p->thread, NULL, frame_worker_thread, p))
860             p->thread_init = 1;
861     }
862
863     return 0;
864
865 error:
866     frame_thread_free(avctx, i+1);
867
868     return err;
869 }
870
871 void ff_thread_flush(AVCodecContext *avctx)
872 {
873     int i;
874     FrameThreadContext *fctx = avctx->thread_opaque;
875
876     if (!avctx->thread_opaque) return;
877
878     park_frame_worker_threads(fctx, avctx->thread_count);
879     if (fctx->prev_thread) {
880         if (fctx->prev_thread != &fctx->threads[0])
881             update_context_from_thread(fctx->threads[0].avctx, fctx->prev_thread->avctx, 0);
882         if (avctx->codec->flush)
883             avctx->codec->flush(fctx->threads[0].avctx);
884     }
885
886     fctx->next_decoding = fctx->next_finished = 0;
887     fctx->delaying = 1;
888     fctx->prev_thread = NULL;
889     for (i = 0; i < avctx->thread_count; i++) {
890         PerThreadContext *p = &fctx->threads[i];
891         // Make sure decode flush calls with size=0 won't return old frames
892         p->got_frame = 0;
893
894         release_delayed_buffers(p);
895     }
896 }
897
898 static int *allocate_progress(PerThreadContext *p)
899 {
900     int i;
901
902     for (i = 0; i < MAX_BUFFERS; i++)
903         if (!p->progress_used[i]) break;
904
905     if (i == MAX_BUFFERS) {
906         av_log(p->avctx, AV_LOG_ERROR, "allocate_progress() overflow\n");
907         return NULL;
908     }
909
910     p->progress_used[i] = 1;
911
912     return p->progress[i];
913 }
914
915 int ff_thread_get_buffer(AVCodecContext *avctx, AVFrame *f)
916 {
917     PerThreadContext *p = avctx->thread_opaque;
918     int *progress, err;
919
920     f->owner = avctx;
921
922     if (!(avctx->active_thread_type&FF_THREAD_FRAME)) {
923         f->thread_opaque = NULL;
924         return avctx->get_buffer(avctx, f);
925     }
926
927     if (p->state != STATE_SETTING_UP &&
928         (avctx->codec->update_thread_context || !avctx->thread_safe_callbacks)) {
929         av_log(avctx, AV_LOG_ERROR, "get_buffer() cannot be called after ff_thread_finish_setup()\n");
930         return -1;
931     }
932
933     pthread_mutex_lock(&p->parent->buffer_mutex);
934     f->thread_opaque = progress = allocate_progress(p);
935
936     if (!progress) {
937         pthread_mutex_unlock(&p->parent->buffer_mutex);
938         return -1;
939     }
940
941     progress[0] =
942     progress[1] = -1;
943
944     if (avctx->thread_safe_callbacks ||
945         avctx->get_buffer == avcodec_default_get_buffer) {
946         err = avctx->get_buffer(avctx, f);
947     } else {
948         p->requested_frame = f;
949         p->state = STATE_GET_BUFFER;
950         pthread_mutex_lock(&p->progress_mutex);
951         pthread_cond_signal(&p->progress_cond);
952
953         while (p->state != STATE_SETTING_UP)
954             pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
955
956         err = p->result;
957
958         pthread_mutex_unlock(&p->progress_mutex);
959
960         if (!avctx->codec->update_thread_context)
961             ff_thread_finish_setup(avctx);
962     }
963
964     if (err) {
965         free_progress(f);
966         f->thread_opaque = NULL;
967     }
968     pthread_mutex_unlock(&p->parent->buffer_mutex);
969
970     return err;
971 }
972
973 void ff_thread_release_buffer(AVCodecContext *avctx, AVFrame *f)
974 {
975     PerThreadContext *p = avctx->thread_opaque;
976     FrameThreadContext *fctx;
977
978     if (!(avctx->active_thread_type&FF_THREAD_FRAME)) {
979         avctx->release_buffer(avctx, f);
980         return;
981     }
982
983     if (p->num_released_buffers >= MAX_BUFFERS) {
984         av_log(p->avctx, AV_LOG_ERROR, "too many thread_release_buffer calls!\n");
985         return;
986     }
987
988     if(avctx->debug & FF_DEBUG_BUFFERS)
989         av_log(avctx, AV_LOG_DEBUG, "thread_release_buffer called on pic %p\n", f);
990
991     fctx = p->parent;
992     pthread_mutex_lock(&fctx->buffer_mutex);
993     p->released_buffers[p->num_released_buffers++] = *f;
994     pthread_mutex_unlock(&fctx->buffer_mutex);
995     memset(f->data, 0, sizeof(f->data));
996 }
997
998 /**
999  * Set the threading algorithms used.
1000  *
1001  * Threading requires more than one thread.
1002  * Frame threading requires entire frames to be passed to the codec,
1003  * and introduces extra decoding delay, so is incompatible with low_delay.
1004  *
1005  * @param avctx The context.
1006  */
1007 static void validate_thread_parameters(AVCodecContext *avctx)
1008 {
1009     int frame_threading_supported = (avctx->codec->capabilities & CODEC_CAP_FRAME_THREADS)
1010                                 && !(avctx->flags & CODEC_FLAG_TRUNCATED)
1011                                 && !(avctx->flags & CODEC_FLAG_LOW_DELAY)
1012                                 && !(avctx->flags2 & CODEC_FLAG2_CHUNKS);
1013     if (avctx->thread_count == 1) {
1014         avctx->active_thread_type = 0;
1015     } else if (frame_threading_supported && (avctx->thread_type & FF_THREAD_FRAME)) {
1016         avctx->active_thread_type = FF_THREAD_FRAME;
1017     } else if (avctx->codec->capabilities & CODEC_CAP_SLICE_THREADS &&
1018                avctx->thread_type & FF_THREAD_SLICE) {
1019         avctx->active_thread_type = FF_THREAD_SLICE;
1020     } else if (!(avctx->codec->capabilities & CODEC_CAP_AUTO_THREADS)) {
1021         avctx->thread_count       = 1;
1022         avctx->active_thread_type = 0;
1023     }
1024
1025     if (avctx->thread_count > MAX_AUTO_THREADS)
1026         av_log(avctx, AV_LOG_WARNING,
1027                "Application has requested %d threads. Using a thread count greater than %d is not recommended.\n",
1028                avctx->thread_count, MAX_AUTO_THREADS);
1029 }
1030
1031 int ff_thread_init(AVCodecContext *avctx)
1032 {
1033     if (avctx->thread_opaque) {
1034         av_log(avctx, AV_LOG_ERROR, "avcodec_thread_init is ignored after avcodec_open\n");
1035         return -1;
1036     }
1037
1038 #if HAVE_W32THREADS
1039     w32thread_init();
1040 #endif
1041
1042     if (avctx->codec) {
1043         validate_thread_parameters(avctx);
1044
1045         if (avctx->active_thread_type&FF_THREAD_SLICE)
1046             return thread_init(avctx);
1047         else if (avctx->active_thread_type&FF_THREAD_FRAME)
1048             return frame_thread_init(avctx);
1049     }
1050
1051     return 0;
1052 }
1053
1054 void ff_thread_free(AVCodecContext *avctx)
1055 {
1056     if (avctx->active_thread_type&FF_THREAD_FRAME)
1057         frame_thread_free(avctx, avctx->thread_count);
1058     else
1059         thread_free(avctx);
1060 }