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