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