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