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