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