2 * This file is part of Libav.
4 * Libav is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
9 * Libav is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with Libav; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 * Frame multithreading support functions
22 * @see doc/multithreading.txt
32 #include "compat/w32pthreads.h"
37 #include "pthread_internal.h"
41 #include "libavutil/avassert.h"
42 #include "libavutil/buffer.h"
43 #include "libavutil/common.h"
44 #include "libavutil/cpu.h"
45 #include "libavutil/frame.h"
46 #include "libavutil/internal.h"
47 #include "libavutil/log.h"
48 #include "libavutil/mem.h"
51 * Context used by codec threads and stored in their AVCodecInternal thread_ctx.
53 typedef struct PerThreadContext {
54 struct FrameThreadContext *parent;
58 pthread_cond_t input_cond; ///< Used to wait for a new packet from the main thread.
59 pthread_cond_t progress_cond; ///< Used by child threads to wait for progress to change.
60 pthread_cond_t output_cond; ///< Used by the main thread to wait for frames to finish.
62 pthread_mutex_t mutex; ///< Mutex used to protect the contents of the PerThreadContext.
63 pthread_mutex_t progress_mutex; ///< Mutex used to protect frame progress values and progress_cond.
65 AVCodecContext *avctx; ///< Context used to decode packets passed to this thread.
67 AVPacket avpkt; ///< Input packet (for decoding) or output (for encoding).
69 AVFrame *frame; ///< Output frame (for decoding) or input (for encoding).
70 int got_frame; ///< The output of got_picture_ptr from the last avcodec_decode_video() call.
71 int result; ///< The result of the last codec decode/encode() call.
74 STATE_INPUT_READY, ///< Set when the thread is awaiting a packet.
75 STATE_SETTING_UP, ///< Set before the codec has called ff_thread_finish_setup().
76 STATE_GET_BUFFER, /**<
77 * Set when the codec calls get_buffer().
78 * State is returned to STATE_SETTING_UP afterwards.
80 STATE_SETUP_FINISHED ///< Set after the codec has called ff_thread_finish_setup().
84 * Array of frames passed to ff_thread_release_buffer().
85 * Frames are released after all threads referencing them are finished.
87 AVFrame *released_buffers;
88 int num_released_buffers;
89 int released_buffers_allocated;
91 AVFrame *requested_frame; ///< AVFrame the codec passed to get_buffer()
92 int requested_flags; ///< flags passed to get_buffer() for requested_frame
96 * Context stored in the client AVCodecInternal thread_ctx.
98 typedef struct FrameThreadContext {
99 PerThreadContext *threads; ///< The contexts for each thread.
100 PerThreadContext *prev_thread; ///< The last thread submit_packet() was called on.
102 pthread_mutex_t buffer_mutex; ///< Mutex used to protect get/release_buffer().
104 int next_decoding; ///< The next context to submit a packet to.
105 int next_finished; ///< The next context to return output from.
108 * Set for the first N packets, where N is the number of threads.
109 * While it is set, ff_thread_en/decode_frame won't return any results.
112 int die; ///< Set when threads should exit.
113 } FrameThreadContext;
116 * Codec worker thread.
118 * Automatically calls ff_thread_finish_setup() if the codec does
119 * not provide an update_thread_context method, or if the codec returns
122 static attribute_align_arg void *frame_worker_thread(void *arg)
124 PerThreadContext *p = arg;
125 FrameThreadContext *fctx = p->parent;
126 AVCodecContext *avctx = p->avctx;
127 const AVCodec *codec = avctx->codec;
130 if (p->state == STATE_INPUT_READY && !fctx->die) {
131 pthread_mutex_lock(&p->mutex);
132 while (p->state == STATE_INPUT_READY && !fctx->die)
133 pthread_cond_wait(&p->input_cond, &p->mutex);
134 pthread_mutex_unlock(&p->mutex);
137 if (fctx->die) break;
139 if (!codec->update_thread_context && avctx->thread_safe_callbacks)
140 ff_thread_finish_setup(avctx);
142 pthread_mutex_lock(&p->mutex);
143 av_frame_unref(p->frame);
145 p->result = codec->decode(avctx, p->frame, &p->got_frame, &p->avpkt);
147 if ((p->result < 0 || !p->got_frame) && p->frame->buf[0]) {
148 if (avctx->internal->allocate_progress)
149 av_log(avctx, AV_LOG_ERROR, "A frame threaded decoder did not "
150 "free the frame on failure. This is a bug, please report it.\n");
151 av_frame_unref(p->frame);
154 if (p->state == STATE_SETTING_UP) ff_thread_finish_setup(avctx);
156 p->state = STATE_INPUT_READY;
158 pthread_mutex_lock(&p->progress_mutex);
159 pthread_cond_signal(&p->output_cond);
160 pthread_mutex_unlock(&p->progress_mutex);
162 pthread_mutex_unlock(&p->mutex);
169 * Update the next thread's AVCodecContext with values from the reference thread's context.
171 * @param dst The destination context.
172 * @param src The source context.
173 * @param for_user 0 if the destination is a codec thread, 1 if the destination is the user's thread
175 static int update_context_from_thread(AVCodecContext *dst, AVCodecContext *src, int for_user)
180 dst->time_base = src->time_base;
181 dst->framerate = src->framerate;
182 dst->width = src->width;
183 dst->height = src->height;
184 dst->pix_fmt = src->pix_fmt;
186 dst->coded_width = src->coded_width;
187 dst->coded_height = src->coded_height;
189 dst->has_b_frames = src->has_b_frames;
190 dst->idct_algo = src->idct_algo;
192 dst->bits_per_coded_sample = src->bits_per_coded_sample;
193 dst->sample_aspect_ratio = src->sample_aspect_ratio;
195 FF_DISABLE_DEPRECATION_WARNINGS
196 dst->dtg_active_format = src->dtg_active_format;
197 FF_ENABLE_DEPRECATION_WARNINGS
198 #endif /* FF_API_AFD */
200 dst->profile = src->profile;
201 dst->level = src->level;
203 dst->bits_per_raw_sample = src->bits_per_raw_sample;
204 dst->ticks_per_frame = src->ticks_per_frame;
205 dst->color_primaries = src->color_primaries;
207 dst->color_trc = src->color_trc;
208 dst->colorspace = src->colorspace;
209 dst->color_range = src->color_range;
210 dst->chroma_sample_location = src->chroma_sample_location;
212 dst->hwaccel = src->hwaccel;
213 dst->hwaccel_context = src->hwaccel_context;
214 dst->internal->hwaccel_priv_data = src->internal->hwaccel_priv_data;
218 #if FF_API_CODED_FRAME
219 FF_DISABLE_DEPRECATION_WARNINGS
220 dst->coded_frame = src->coded_frame;
221 FF_ENABLE_DEPRECATION_WARNINGS
224 if (dst->codec->update_thread_context)
225 err = dst->codec->update_thread_context(dst, src);
232 * Update the next thread's AVCodecContext with values set by the user.
234 * @param dst The destination context.
235 * @param src The source context.
236 * @return 0 on success, negative error code on failure
238 static int update_context_from_user(AVCodecContext *dst, AVCodecContext *src)
240 #define copy_fields(s, e) memcpy(&dst->s, &src->s, (char*)&dst->e - (char*)&dst->s);
241 dst->flags = src->flags;
243 dst->draw_horiz_band= src->draw_horiz_band;
244 dst->get_buffer2 = src->get_buffer2;
245 #if FF_API_GET_BUFFER
246 FF_DISABLE_DEPRECATION_WARNINGS
247 dst->get_buffer = src->get_buffer;
248 dst->release_buffer = src->release_buffer;
249 FF_ENABLE_DEPRECATION_WARNINGS
252 dst->opaque = src->opaque;
253 dst->debug = src->debug;
255 dst->slice_flags = src->slice_flags;
256 dst->flags2 = src->flags2;
258 copy_fields(skip_loop_filter, subtitle_header);
260 dst->frame_number = src->frame_number;
261 dst->reordered_opaque = src->reordered_opaque;
263 if (src->slice_count && src->slice_offset) {
264 if (dst->slice_count < src->slice_count) {
265 int *tmp = av_realloc(dst->slice_offset, src->slice_count *
266 sizeof(*dst->slice_offset));
268 av_free(dst->slice_offset);
269 return AVERROR(ENOMEM);
271 dst->slice_offset = tmp;
273 memcpy(dst->slice_offset, src->slice_offset,
274 src->slice_count * sizeof(*dst->slice_offset));
276 dst->slice_count = src->slice_count;
281 /// Releases the buffers that this decoding thread was the last user of.
282 static void release_delayed_buffers(PerThreadContext *p)
284 FrameThreadContext *fctx = p->parent;
286 while (p->num_released_buffers > 0) {
289 pthread_mutex_lock(&fctx->buffer_mutex);
291 // fix extended data in case the caller screwed it up
292 av_assert0(p->avctx->codec_type == AVMEDIA_TYPE_VIDEO);
293 f = &p->released_buffers[--p->num_released_buffers];
294 f->extended_data = f->data;
297 pthread_mutex_unlock(&fctx->buffer_mutex);
301 static int submit_packet(PerThreadContext *p, AVPacket *avpkt)
303 FrameThreadContext *fctx = p->parent;
304 PerThreadContext *prev_thread = fctx->prev_thread;
305 const AVCodec *codec = p->avctx->codec;
307 if (!avpkt->size && !(codec->capabilities & CODEC_CAP_DELAY)) return 0;
309 pthread_mutex_lock(&p->mutex);
311 release_delayed_buffers(p);
315 if (prev_thread->state == STATE_SETTING_UP) {
316 pthread_mutex_lock(&prev_thread->progress_mutex);
317 while (prev_thread->state == STATE_SETTING_UP)
318 pthread_cond_wait(&prev_thread->progress_cond, &prev_thread->progress_mutex);
319 pthread_mutex_unlock(&prev_thread->progress_mutex);
322 err = update_context_from_thread(p->avctx, prev_thread->avctx, 0);
324 pthread_mutex_unlock(&p->mutex);
329 av_packet_unref(&p->avpkt);
330 av_packet_ref(&p->avpkt, avpkt);
332 p->state = STATE_SETTING_UP;
333 pthread_cond_signal(&p->input_cond);
334 pthread_mutex_unlock(&p->mutex);
337 * If the client doesn't have a thread-safe get_buffer(),
338 * then decoding threads call back to the main thread,
339 * and it calls back to the client here.
342 FF_DISABLE_DEPRECATION_WARNINGS
343 if (!p->avctx->thread_safe_callbacks && (
344 #if FF_API_GET_BUFFER
345 p->avctx->get_buffer ||
347 p->avctx->get_buffer2 != avcodec_default_get_buffer2)) {
348 FF_ENABLE_DEPRECATION_WARNINGS
349 while (p->state != STATE_SETUP_FINISHED && p->state != STATE_INPUT_READY) {
350 pthread_mutex_lock(&p->progress_mutex);
351 while (p->state == STATE_SETTING_UP)
352 pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
354 if (p->state == STATE_GET_BUFFER) {
355 p->result = ff_get_buffer(p->avctx, p->requested_frame, p->requested_flags);
356 p->state = STATE_SETTING_UP;
357 pthread_cond_signal(&p->progress_cond);
359 pthread_mutex_unlock(&p->progress_mutex);
363 fctx->prev_thread = p;
364 fctx->next_decoding++;
369 int ff_thread_decode_frame(AVCodecContext *avctx,
370 AVFrame *picture, int *got_picture_ptr,
373 FrameThreadContext *fctx = avctx->internal->thread_ctx;
374 int finished = fctx->next_finished;
379 * Submit a packet to the next decoding thread.
382 p = &fctx->threads[fctx->next_decoding];
383 err = update_context_from_user(p->avctx, avctx);
385 err = submit_packet(p, avpkt);
389 * If we're still receiving the initial packets, don't return a frame.
392 if (fctx->delaying) {
393 if (fctx->next_decoding >= (avctx->thread_count-1)) fctx->delaying = 0;
401 * Return the next available frame from the oldest thread.
402 * If we're at the end of the stream, then we have to skip threads that
403 * didn't output a frame, because we don't want to accidentally signal
404 * EOF (avpkt->size == 0 && *got_picture_ptr == 0).
408 p = &fctx->threads[finished++];
410 if (p->state != STATE_INPUT_READY) {
411 pthread_mutex_lock(&p->progress_mutex);
412 while (p->state != STATE_INPUT_READY)
413 pthread_cond_wait(&p->output_cond, &p->progress_mutex);
414 pthread_mutex_unlock(&p->progress_mutex);
417 av_frame_move_ref(picture, p->frame);
418 *got_picture_ptr = p->got_frame;
419 picture->pkt_dts = p->avpkt.dts;
422 * A later call with avkpt->size == 0 may loop over all threads,
423 * including this one, searching for a frame to return before being
424 * stopped by the "finished != fctx->next_finished" condition.
425 * Make sure we don't mistakenly return the same frame again.
429 if (finished >= avctx->thread_count) finished = 0;
430 } while (!avpkt->size && !*got_picture_ptr && finished != fctx->next_finished);
432 update_context_from_thread(avctx, p->avctx, 1);
434 if (fctx->next_decoding >= avctx->thread_count) fctx->next_decoding = 0;
436 fctx->next_finished = finished;
438 /* return the size of the consumed packet if no error occurred */
439 return (p->result >= 0) ? avpkt->size : p->result;
442 void ff_thread_report_progress(ThreadFrame *f, int n, int field)
445 int *progress = f->progress ? (int*)f->progress->data : NULL;
447 if (!progress || progress[field] >= n) return;
449 p = f->owner->internal->thread_ctx;
451 if (f->owner->debug&FF_DEBUG_THREADS)
452 av_log(f->owner, AV_LOG_DEBUG, "%p finished %d field %d\n", progress, n, field);
454 pthread_mutex_lock(&p->progress_mutex);
456 pthread_cond_broadcast(&p->progress_cond);
457 pthread_mutex_unlock(&p->progress_mutex);
460 void ff_thread_await_progress(ThreadFrame *f, int n, int field)
463 int *progress = f->progress ? (int*)f->progress->data : NULL;
465 if (!progress || progress[field] >= n) return;
467 p = f->owner->internal->thread_ctx;
469 if (f->owner->debug&FF_DEBUG_THREADS)
470 av_log(f->owner, AV_LOG_DEBUG, "thread awaiting %d field %d from %p\n", n, field, progress);
472 pthread_mutex_lock(&p->progress_mutex);
473 while (progress[field] < n)
474 pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
475 pthread_mutex_unlock(&p->progress_mutex);
478 void ff_thread_finish_setup(AVCodecContext *avctx) {
479 PerThreadContext *p = avctx->internal->thread_ctx;
481 if (!(avctx->active_thread_type&FF_THREAD_FRAME)) return;
483 pthread_mutex_lock(&p->progress_mutex);
484 p->state = STATE_SETUP_FINISHED;
485 pthread_cond_broadcast(&p->progress_cond);
486 pthread_mutex_unlock(&p->progress_mutex);
489 /// Waits for all threads to finish.
490 static void park_frame_worker_threads(FrameThreadContext *fctx, int thread_count)
494 for (i = 0; i < thread_count; i++) {
495 PerThreadContext *p = &fctx->threads[i];
497 if (p->state != STATE_INPUT_READY) {
498 pthread_mutex_lock(&p->progress_mutex);
499 while (p->state != STATE_INPUT_READY)
500 pthread_cond_wait(&p->output_cond, &p->progress_mutex);
501 pthread_mutex_unlock(&p->progress_mutex);
506 void ff_frame_thread_free(AVCodecContext *avctx, int thread_count)
508 FrameThreadContext *fctx = avctx->internal->thread_ctx;
509 const AVCodec *codec = avctx->codec;
512 park_frame_worker_threads(fctx, thread_count);
514 if (fctx->prev_thread && fctx->prev_thread != fctx->threads)
515 update_context_from_thread(fctx->threads->avctx, fctx->prev_thread->avctx, 0);
519 for (i = 0; i < thread_count; i++) {
520 PerThreadContext *p = &fctx->threads[i];
522 pthread_mutex_lock(&p->mutex);
523 pthread_cond_signal(&p->input_cond);
524 pthread_mutex_unlock(&p->mutex);
527 pthread_join(p->thread, NULL);
530 codec->close(p->avctx);
534 release_delayed_buffers(p);
535 av_frame_free(&p->frame);
538 for (i = 0; i < thread_count; i++) {
539 PerThreadContext *p = &fctx->threads[i];
541 pthread_mutex_destroy(&p->mutex);
542 pthread_mutex_destroy(&p->progress_mutex);
543 pthread_cond_destroy(&p->input_cond);
544 pthread_cond_destroy(&p->progress_cond);
545 pthread_cond_destroy(&p->output_cond);
546 av_packet_unref(&p->avpkt);
547 av_freep(&p->released_buffers);
550 av_freep(&p->avctx->priv_data);
551 av_freep(&p->avctx->slice_offset);
554 av_freep(&p->avctx->internal);
558 av_freep(&fctx->threads);
559 pthread_mutex_destroy(&fctx->buffer_mutex);
560 av_freep(&avctx->internal->thread_ctx);
563 int ff_frame_thread_init(AVCodecContext *avctx)
565 int thread_count = avctx->thread_count;
566 const AVCodec *codec = avctx->codec;
567 AVCodecContext *src = avctx;
568 FrameThreadContext *fctx;
576 int nb_cpus = av_cpu_count();
577 av_log(avctx, AV_LOG_DEBUG, "detected %d logical cores\n", nb_cpus);
578 // use number of cores + 1 as thread count if there is more than one
580 thread_count = avctx->thread_count = FFMIN(nb_cpus + 1, MAX_AUTO_THREADS);
582 thread_count = avctx->thread_count = 1;
585 if (thread_count <= 1) {
586 avctx->active_thread_type = 0;
590 avctx->internal->thread_ctx = fctx = av_mallocz(sizeof(FrameThreadContext));
592 return AVERROR(ENOMEM);
594 fctx->threads = av_mallocz(sizeof(PerThreadContext) * thread_count);
595 if (!fctx->threads) {
596 av_freep(&avctx->internal->thread_ctx);
597 return AVERROR(ENOMEM);
600 pthread_mutex_init(&fctx->buffer_mutex, NULL);
603 for (i = 0; i < thread_count; i++) {
604 AVCodecContext *copy = av_malloc(sizeof(AVCodecContext));
605 PerThreadContext *p = &fctx->threads[i];
607 pthread_mutex_init(&p->mutex, NULL);
608 pthread_mutex_init(&p->progress_mutex, NULL);
609 pthread_cond_init(&p->input_cond, NULL);
610 pthread_cond_init(&p->progress_cond, NULL);
611 pthread_cond_init(&p->output_cond, NULL);
613 p->frame = av_frame_alloc();
616 err = AVERROR(ENOMEM);
624 err = AVERROR(ENOMEM);
630 copy->internal = av_malloc(sizeof(AVCodecInternal));
631 if (!copy->internal) {
632 err = AVERROR(ENOMEM);
635 *copy->internal = *src->internal;
636 copy->internal->thread_ctx = p;
637 copy->internal->pkt = &p->avpkt;
643 err = codec->init(copy);
645 update_context_from_thread(avctx, copy, 1);
647 copy->priv_data = av_malloc(codec->priv_data_size);
648 if (!copy->priv_data) {
649 err = AVERROR(ENOMEM);
652 memcpy(copy->priv_data, src->priv_data, codec->priv_data_size);
653 copy->internal->is_copy = 1;
655 if (codec->init_thread_copy)
656 err = codec->init_thread_copy(copy);
661 if (!pthread_create(&p->thread, NULL, frame_worker_thread, p))
668 ff_frame_thread_free(avctx, i+1);
673 void ff_thread_flush(AVCodecContext *avctx)
676 FrameThreadContext *fctx = avctx->internal->thread_ctx;
680 park_frame_worker_threads(fctx, avctx->thread_count);
681 if (fctx->prev_thread) {
682 if (fctx->prev_thread != &fctx->threads[0])
683 update_context_from_thread(fctx->threads[0].avctx, fctx->prev_thread->avctx, 0);
686 fctx->next_decoding = fctx->next_finished = 0;
688 fctx->prev_thread = NULL;
689 for (i = 0; i < avctx->thread_count; i++) {
690 PerThreadContext *p = &fctx->threads[i];
691 // Make sure decode flush calls with size=0 won't return old frames
693 av_frame_unref(p->frame);
695 release_delayed_buffers(p);
697 if (avctx->codec->flush)
698 avctx->codec->flush(p->avctx);
702 int ff_thread_get_buffer(AVCodecContext *avctx, ThreadFrame *f, int flags)
704 PerThreadContext *p = avctx->internal->thread_ctx;
709 if (!(avctx->active_thread_type & FF_THREAD_FRAME))
710 return ff_get_buffer(avctx, f->f, flags);
712 if (p->state != STATE_SETTING_UP &&
713 (avctx->codec->update_thread_context || !avctx->thread_safe_callbacks)) {
714 av_log(avctx, AV_LOG_ERROR, "get_buffer() cannot be called after ff_thread_finish_setup()\n");
718 if (avctx->internal->allocate_progress) {
720 f->progress = av_buffer_alloc(2 * sizeof(int));
722 return AVERROR(ENOMEM);
724 progress = (int*)f->progress->data;
726 progress[0] = progress[1] = -1;
729 pthread_mutex_lock(&p->parent->buffer_mutex);
730 FF_DISABLE_DEPRECATION_WARNINGS
731 if (avctx->thread_safe_callbacks || (
732 #if FF_API_GET_BUFFER
733 !avctx->get_buffer &&
735 avctx->get_buffer2 == avcodec_default_get_buffer2)) {
736 FF_ENABLE_DEPRECATION_WARNINGS
737 err = ff_get_buffer(avctx, f->f, flags);
739 p->requested_frame = f->f;
740 p->requested_flags = flags;
741 p->state = STATE_GET_BUFFER;
742 pthread_mutex_lock(&p->progress_mutex);
743 pthread_cond_signal(&p->progress_cond);
745 while (p->state != STATE_SETTING_UP)
746 pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
750 pthread_mutex_unlock(&p->progress_mutex);
753 if (!avctx->thread_safe_callbacks && !avctx->codec->update_thread_context)
754 ff_thread_finish_setup(avctx);
757 av_buffer_unref(&f->progress);
759 pthread_mutex_unlock(&p->parent->buffer_mutex);
764 void ff_thread_release_buffer(AVCodecContext *avctx, ThreadFrame *f)
766 PerThreadContext *p = avctx->internal->thread_ctx;
767 FrameThreadContext *fctx;
769 FF_DISABLE_DEPRECATION_WARNINGS
770 int can_direct_free = !(avctx->active_thread_type & FF_THREAD_FRAME) ||
771 avctx->thread_safe_callbacks ||
773 #if FF_API_GET_BUFFER
774 !avctx->get_buffer &&
776 avctx->get_buffer2 == avcodec_default_get_buffer2);
777 FF_ENABLE_DEPRECATION_WARNINGS
779 if (!f->f || !f->f->buf[0])
782 if (avctx->debug & FF_DEBUG_BUFFERS)
783 av_log(avctx, AV_LOG_DEBUG, "thread_release_buffer called on pic %p\n", f);
785 av_buffer_unref(&f->progress);
788 if (can_direct_free) {
789 av_frame_unref(f->f);
794 pthread_mutex_lock(&fctx->buffer_mutex);
796 if (p->num_released_buffers + 1 >= INT_MAX / sizeof(*p->released_buffers))
798 tmp = av_fast_realloc(p->released_buffers, &p->released_buffers_allocated,
799 (p->num_released_buffers + 1) *
800 sizeof(*p->released_buffers));
803 p->released_buffers = tmp;
805 dst = &p->released_buffers[p->num_released_buffers];
806 av_frame_move_ref(dst, f->f);
808 p->num_released_buffers++;
811 pthread_mutex_unlock(&fctx->buffer_mutex);