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