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