2 * This file is part of FFmpeg.
4 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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
27 #include <stdatomic.h>
33 #include "pthread_internal.h"
37 #include "libavutil/avassert.h"
38 #include "libavutil/buffer.h"
39 #include "libavutil/common.h"
40 #include "libavutil/cpu.h"
41 #include "libavutil/frame.h"
42 #include "libavutil/internal.h"
43 #include "libavutil/log.h"
44 #include "libavutil/mem.h"
45 #include "libavutil/opt.h"
46 #include "libavutil/thread.h"
49 ///< Set when the thread is awaiting a packet.
51 ///< Set before the codec has called ff_thread_finish_setup().
54 * Set when the codec calls get_buffer().
55 * State is returned to STATE_SETTING_UP afterwards.
59 * Set when the codec calls get_format().
60 * State is returned to STATE_SETTING_UP afterwards.
63 ///< Set after the codec has called ff_thread_finish_setup().
68 * Context used by codec threads and stored in their AVCodecInternal thread_ctx.
70 typedef struct PerThreadContext {
71 struct FrameThreadContext *parent;
75 pthread_cond_t input_cond; ///< Used to wait for a new packet from the main thread.
76 pthread_cond_t progress_cond; ///< Used by child threads to wait for progress to change.
77 pthread_cond_t output_cond; ///< Used by the main thread to wait for frames to finish.
79 pthread_mutex_t mutex; ///< Mutex used to protect the contents of the PerThreadContext.
80 pthread_mutex_t progress_mutex; ///< Mutex used to protect frame progress values and progress_cond.
82 AVCodecContext *avctx; ///< Context used to decode packets passed to this thread.
84 AVPacket avpkt; ///< Input packet (for decoding) or output (for encoding).
86 AVFrame *frame; ///< Output frame (for decoding) or input (for encoding).
87 int got_frame; ///< The output of got_picture_ptr from the last avcodec_decode_video() call.
88 int result; ///< The result of the last codec decode/encode() call.
92 #if FF_API_THREAD_SAFE_CALLBACKS
94 * Array of frames passed to ff_thread_release_buffer().
95 * Frames are released after all threads referencing them are finished.
97 AVFrame **released_buffers;
98 int num_released_buffers;
99 int released_buffers_allocated;
101 AVFrame *requested_frame; ///< AVFrame the codec passed to get_buffer()
102 int requested_flags; ///< flags passed to get_buffer() for requested_frame
104 const enum AVPixelFormat *available_formats; ///< Format array for get_format()
105 enum AVPixelFormat result_format; ///< get_format() result
108 int die; ///< Set when the thread should exit.
110 int hwaccel_serializing;
111 int async_serializing;
113 atomic_int debug_threads; ///< Set if the FF_DEBUG_THREADS option is set.
117 * Context stored in the client AVCodecInternal thread_ctx.
119 typedef struct FrameThreadContext {
120 PerThreadContext *threads; ///< The contexts for each thread.
121 PerThreadContext *prev_thread; ///< The last thread submit_packet() was called on.
123 pthread_mutex_t buffer_mutex; ///< Mutex used to protect get/release_buffer().
125 * This lock is used for ensuring threads run in serial when hwaccel
128 pthread_mutex_t hwaccel_mutex;
129 pthread_mutex_t async_mutex;
130 pthread_cond_t async_cond;
133 int next_decoding; ///< The next context to submit a packet to.
134 int next_finished; ///< The next context to return output from.
137 * Set for the first N packets, where N is the number of threads.
138 * While it is set, ff_thread_en/decode_frame won't return any results.
140 } FrameThreadContext;
142 #if FF_API_THREAD_SAFE_CALLBACKS
143 #define THREAD_SAFE_CALLBACKS(avctx) \
144 ((avctx)->thread_safe_callbacks || (avctx)->get_buffer2 == avcodec_default_get_buffer2)
147 static void async_lock(FrameThreadContext *fctx)
149 pthread_mutex_lock(&fctx->async_mutex);
150 while (fctx->async_lock)
151 pthread_cond_wait(&fctx->async_cond, &fctx->async_mutex);
152 fctx->async_lock = 1;
153 pthread_mutex_unlock(&fctx->async_mutex);
156 static void async_unlock(FrameThreadContext *fctx)
158 pthread_mutex_lock(&fctx->async_mutex);
159 av_assert0(fctx->async_lock);
160 fctx->async_lock = 0;
161 pthread_cond_broadcast(&fctx->async_cond);
162 pthread_mutex_unlock(&fctx->async_mutex);
166 * Codec worker thread.
168 * Automatically calls ff_thread_finish_setup() if the codec does
169 * not provide an update_thread_context method, or if the codec returns
172 static attribute_align_arg void *frame_worker_thread(void *arg)
174 PerThreadContext *p = arg;
175 AVCodecContext *avctx = p->avctx;
176 const AVCodec *codec = avctx->codec;
178 pthread_mutex_lock(&p->mutex);
180 while (atomic_load(&p->state) == STATE_INPUT_READY && !p->die)
181 pthread_cond_wait(&p->input_cond, &p->mutex);
185 FF_DISABLE_DEPRECATION_WARNINGS
186 if (!codec->update_thread_context
187 #if FF_API_THREAD_SAFE_CALLBACKS
188 && THREAD_SAFE_CALLBACKS(avctx)
191 ff_thread_finish_setup(avctx);
192 FF_ENABLE_DEPRECATION_WARNINGS
194 /* If a decoder supports hwaccel, then it must call ff_get_format().
195 * Since that call must happen before ff_thread_finish_setup(), the
196 * decoder is required to implement update_thread_context() and call
197 * ff_thread_finish_setup() manually. Therefore the above
198 * ff_thread_finish_setup() call did not happen and hwaccel_serializing
199 * cannot be true here. */
200 av_assert0(!p->hwaccel_serializing);
202 /* if the previous thread uses hwaccel then we take the lock to ensure
203 * the threads don't run concurrently */
204 if (avctx->hwaccel) {
205 pthread_mutex_lock(&p->parent->hwaccel_mutex);
206 p->hwaccel_serializing = 1;
209 av_frame_unref(p->frame);
211 p->result = codec->decode(avctx, p->frame, &p->got_frame, &p->avpkt);
213 if ((p->result < 0 || !p->got_frame) && p->frame->buf[0]) {
214 if (avctx->codec->caps_internal & FF_CODEC_CAP_ALLOCATE_PROGRESS)
215 av_log(avctx, AV_LOG_ERROR, "A frame threaded decoder did not "
216 "free the frame on failure. This is a bug, please report it.\n");
217 av_frame_unref(p->frame);
220 if (atomic_load(&p->state) == STATE_SETTING_UP)
221 ff_thread_finish_setup(avctx);
223 if (p->hwaccel_serializing) {
224 p->hwaccel_serializing = 0;
225 pthread_mutex_unlock(&p->parent->hwaccel_mutex);
228 if (p->async_serializing) {
229 p->async_serializing = 0;
231 async_unlock(p->parent);
234 pthread_mutex_lock(&p->progress_mutex);
236 atomic_store(&p->state, STATE_INPUT_READY);
238 pthread_cond_broadcast(&p->progress_cond);
239 pthread_cond_signal(&p->output_cond);
240 pthread_mutex_unlock(&p->progress_mutex);
242 pthread_mutex_unlock(&p->mutex);
248 * Update the next thread's AVCodecContext with values from the reference thread's context.
250 * @param dst The destination context.
251 * @param src The source context.
252 * @param for_user 0 if the destination is a codec thread, 1 if the destination is the user's thread
253 * @return 0 on success, negative error code on failure
255 static int update_context_from_thread(AVCodecContext *dst, AVCodecContext *src, int for_user)
259 if (dst != src && (for_user || src->codec->update_thread_context)) {
260 dst->time_base = src->time_base;
261 dst->framerate = src->framerate;
262 dst->width = src->width;
263 dst->height = src->height;
264 dst->pix_fmt = src->pix_fmt;
265 dst->sw_pix_fmt = src->sw_pix_fmt;
267 dst->coded_width = src->coded_width;
268 dst->coded_height = src->coded_height;
270 dst->has_b_frames = src->has_b_frames;
271 dst->idct_algo = src->idct_algo;
273 dst->bits_per_coded_sample = src->bits_per_coded_sample;
274 dst->sample_aspect_ratio = src->sample_aspect_ratio;
276 dst->profile = src->profile;
277 dst->level = src->level;
279 dst->bits_per_raw_sample = src->bits_per_raw_sample;
280 dst->ticks_per_frame = src->ticks_per_frame;
281 dst->color_primaries = src->color_primaries;
283 dst->color_trc = src->color_trc;
284 dst->colorspace = src->colorspace;
285 dst->color_range = src->color_range;
286 dst->chroma_sample_location = src->chroma_sample_location;
288 dst->hwaccel = src->hwaccel;
289 dst->hwaccel_context = src->hwaccel_context;
291 dst->channels = src->channels;
292 dst->sample_rate = src->sample_rate;
293 dst->sample_fmt = src->sample_fmt;
294 dst->channel_layout = src->channel_layout;
295 dst->internal->hwaccel_priv_data = src->internal->hwaccel_priv_data;
297 if (!!dst->hw_frames_ctx != !!src->hw_frames_ctx ||
298 (dst->hw_frames_ctx && dst->hw_frames_ctx->data != src->hw_frames_ctx->data)) {
299 av_buffer_unref(&dst->hw_frames_ctx);
301 if (src->hw_frames_ctx) {
302 dst->hw_frames_ctx = av_buffer_ref(src->hw_frames_ctx);
303 if (!dst->hw_frames_ctx)
304 return AVERROR(ENOMEM);
308 dst->hwaccel_flags = src->hwaccel_flags;
310 err = av_buffer_replace(&dst->internal->pool, src->internal->pool);
316 #if FF_API_CODED_FRAME
317 FF_DISABLE_DEPRECATION_WARNINGS
318 dst->coded_frame = src->coded_frame;
319 FF_ENABLE_DEPRECATION_WARNINGS
322 if (dst->codec->update_thread_context)
323 err = dst->codec->update_thread_context(dst, src);
330 * Update the next thread's AVCodecContext with values set by the user.
332 * @param dst The destination context.
333 * @param src The source context.
334 * @return 0 on success, negative error code on failure
336 static int update_context_from_user(AVCodecContext *dst, AVCodecContext *src)
338 dst->flags = src->flags;
340 dst->draw_horiz_band= src->draw_horiz_band;
341 dst->get_buffer2 = src->get_buffer2;
343 dst->opaque = src->opaque;
344 dst->debug = src->debug;
345 dst->debug_mv = src->debug_mv;
347 dst->slice_flags = src->slice_flags;
348 dst->flags2 = src->flags2;
349 dst->export_side_data = src->export_side_data;
351 dst->skip_loop_filter = src->skip_loop_filter;
352 dst->skip_idct = src->skip_idct;
353 dst->skip_frame = src->skip_frame;
355 dst->frame_number = src->frame_number;
356 dst->reordered_opaque = src->reordered_opaque;
357 #if FF_API_THREAD_SAFE_CALLBACKS
358 FF_DISABLE_DEPRECATION_WARNINGS
359 dst->thread_safe_callbacks = src->thread_safe_callbacks;
360 FF_ENABLE_DEPRECATION_WARNINGS
363 if (src->slice_count && src->slice_offset) {
364 if (dst->slice_count < src->slice_count) {
365 int err = av_reallocp_array(&dst->slice_offset, src->slice_count,
366 sizeof(*dst->slice_offset));
370 memcpy(dst->slice_offset, src->slice_offset,
371 src->slice_count * sizeof(*dst->slice_offset));
373 dst->slice_count = src->slice_count;
377 #if FF_API_THREAD_SAFE_CALLBACKS
378 /// Releases the buffers that this decoding thread was the last user of.
379 static void release_delayed_buffers(PerThreadContext *p)
381 FrameThreadContext *fctx = p->parent;
383 while (p->num_released_buffers > 0) {
386 pthread_mutex_lock(&fctx->buffer_mutex);
388 // fix extended data in case the caller screwed it up
389 av_assert0(p->avctx->codec_type == AVMEDIA_TYPE_VIDEO ||
390 p->avctx->codec_type == AVMEDIA_TYPE_AUDIO);
391 f = p->released_buffers[--p->num_released_buffers];
392 f->extended_data = f->data;
395 pthread_mutex_unlock(&fctx->buffer_mutex);
400 static int submit_packet(PerThreadContext *p, AVCodecContext *user_avctx,
403 FrameThreadContext *fctx = p->parent;
404 PerThreadContext *prev_thread = fctx->prev_thread;
405 const AVCodec *codec = p->avctx->codec;
408 if (!avpkt->size && !(codec->capabilities & AV_CODEC_CAP_DELAY))
411 pthread_mutex_lock(&p->mutex);
413 ret = update_context_from_user(p->avctx, user_avctx);
415 pthread_mutex_unlock(&p->mutex);
418 atomic_store_explicit(&p->debug_threads,
419 (p->avctx->debug & FF_DEBUG_THREADS) != 0,
420 memory_order_relaxed);
422 #if FF_API_THREAD_SAFE_CALLBACKS
423 release_delayed_buffers(p);
428 if (atomic_load(&prev_thread->state) == STATE_SETTING_UP) {
429 pthread_mutex_lock(&prev_thread->progress_mutex);
430 while (atomic_load(&prev_thread->state) == STATE_SETTING_UP)
431 pthread_cond_wait(&prev_thread->progress_cond, &prev_thread->progress_mutex);
432 pthread_mutex_unlock(&prev_thread->progress_mutex);
435 err = update_context_from_thread(p->avctx, prev_thread->avctx, 0);
437 pthread_mutex_unlock(&p->mutex);
442 av_packet_unref(&p->avpkt);
443 ret = av_packet_ref(&p->avpkt, avpkt);
445 pthread_mutex_unlock(&p->mutex);
446 av_log(p->avctx, AV_LOG_ERROR, "av_packet_ref() failed in submit_packet()\n");
450 atomic_store(&p->state, STATE_SETTING_UP);
451 pthread_cond_signal(&p->input_cond);
452 pthread_mutex_unlock(&p->mutex);
454 #if FF_API_THREAD_SAFE_CALLBACKS
455 FF_DISABLE_DEPRECATION_WARNINGS
457 * If the client doesn't have a thread-safe get_buffer(),
458 * then decoding threads call back to the main thread,
459 * and it calls back to the client here.
462 if (!p->avctx->thread_safe_callbacks && (
463 p->avctx->get_format != avcodec_default_get_format ||
464 p->avctx->get_buffer2 != avcodec_default_get_buffer2)) {
465 while (atomic_load(&p->state) != STATE_SETUP_FINISHED && atomic_load(&p->state) != STATE_INPUT_READY) {
467 pthread_mutex_lock(&p->progress_mutex);
468 while (atomic_load(&p->state) == STATE_SETTING_UP)
469 pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
471 switch (atomic_load_explicit(&p->state, memory_order_acquire)) {
472 case STATE_GET_BUFFER:
473 p->result = ff_get_buffer(p->avctx, p->requested_frame, p->requested_flags);
475 case STATE_GET_FORMAT:
476 p->result_format = ff_get_format(p->avctx, p->available_formats);
483 atomic_store(&p->state, STATE_SETTING_UP);
484 pthread_cond_signal(&p->progress_cond);
486 pthread_mutex_unlock(&p->progress_mutex);
489 FF_ENABLE_DEPRECATION_WARNINGS
492 fctx->prev_thread = p;
493 fctx->next_decoding++;
498 int ff_thread_decode_frame(AVCodecContext *avctx,
499 AVFrame *picture, int *got_picture_ptr,
502 FrameThreadContext *fctx = avctx->internal->thread_ctx;
503 int finished = fctx->next_finished;
507 /* release the async lock, permitting blocked hwaccel threads to
508 * go forward while we are in this function */
512 * Submit a packet to the next decoding thread.
515 p = &fctx->threads[fctx->next_decoding];
516 err = submit_packet(p, avctx, avpkt);
521 * If we're still receiving the initial packets, don't return a frame.
524 if (fctx->next_decoding > (avctx->thread_count-1-(avctx->codec_id == AV_CODEC_ID_FFV1)))
527 if (fctx->delaying) {
536 * Return the next available frame from the oldest thread.
537 * If we're at the end of the stream, then we have to skip threads that
538 * didn't output a frame/error, because we don't want to accidentally signal
539 * EOF (avpkt->size == 0 && *got_picture_ptr == 0 && err >= 0).
543 p = &fctx->threads[finished++];
545 if (atomic_load(&p->state) != STATE_INPUT_READY) {
546 pthread_mutex_lock(&p->progress_mutex);
547 while (atomic_load_explicit(&p->state, memory_order_relaxed) != STATE_INPUT_READY)
548 pthread_cond_wait(&p->output_cond, &p->progress_mutex);
549 pthread_mutex_unlock(&p->progress_mutex);
552 av_frame_move_ref(picture, p->frame);
553 *got_picture_ptr = p->got_frame;
554 picture->pkt_dts = p->avpkt.dts;
558 * A later call with avkpt->size == 0 may loop over all threads,
559 * including this one, searching for a frame/error to return before being
560 * stopped by the "finished != fctx->next_finished" condition.
561 * Make sure we don't mistakenly return the same frame/error again.
566 if (finished >= avctx->thread_count) finished = 0;
567 } while (!avpkt->size && !*got_picture_ptr && err >= 0 && finished != fctx->next_finished);
569 update_context_from_thread(avctx, p->avctx, 1);
571 if (fctx->next_decoding >= avctx->thread_count) fctx->next_decoding = 0;
573 fctx->next_finished = finished;
575 /* return the size of the consumed packet if no error occurred */
583 void ff_thread_report_progress(ThreadFrame *f, int n, int field)
586 atomic_int *progress = f->progress ? (atomic_int*)f->progress->data : NULL;
589 atomic_load_explicit(&progress[field], memory_order_relaxed) >= n)
592 p = f->owner[field]->internal->thread_ctx;
594 if (atomic_load_explicit(&p->debug_threads, memory_order_relaxed))
595 av_log(f->owner[field], AV_LOG_DEBUG,
596 "%p finished %d field %d\n", progress, n, field);
598 pthread_mutex_lock(&p->progress_mutex);
600 atomic_store_explicit(&progress[field], n, memory_order_release);
602 pthread_cond_broadcast(&p->progress_cond);
603 pthread_mutex_unlock(&p->progress_mutex);
606 void ff_thread_await_progress(ThreadFrame *f, int n, int field)
609 atomic_int *progress = f->progress ? (atomic_int*)f->progress->data : NULL;
612 atomic_load_explicit(&progress[field], memory_order_acquire) >= n)
615 p = f->owner[field]->internal->thread_ctx;
617 if (atomic_load_explicit(&p->debug_threads, memory_order_relaxed))
618 av_log(f->owner[field], AV_LOG_DEBUG,
619 "thread awaiting %d field %d from %p\n", n, field, progress);
621 pthread_mutex_lock(&p->progress_mutex);
622 while (atomic_load_explicit(&progress[field], memory_order_relaxed) < n)
623 pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
624 pthread_mutex_unlock(&p->progress_mutex);
627 void ff_thread_finish_setup(AVCodecContext *avctx) {
628 PerThreadContext *p = avctx->internal->thread_ctx;
630 if (!(avctx->active_thread_type&FF_THREAD_FRAME)) return;
632 if (avctx->hwaccel && !p->hwaccel_serializing) {
633 pthread_mutex_lock(&p->parent->hwaccel_mutex);
634 p->hwaccel_serializing = 1;
637 /* this assumes that no hwaccel calls happen before ff_thread_finish_setup() */
638 if (avctx->hwaccel &&
639 !(avctx->hwaccel->caps_internal & HWACCEL_CAP_ASYNC_SAFE)) {
640 p->async_serializing = 1;
642 async_lock(p->parent);
645 pthread_mutex_lock(&p->progress_mutex);
646 if(atomic_load(&p->state) == STATE_SETUP_FINISHED){
647 av_log(avctx, AV_LOG_WARNING, "Multiple ff_thread_finish_setup() calls\n");
650 atomic_store(&p->state, STATE_SETUP_FINISHED);
652 pthread_cond_broadcast(&p->progress_cond);
653 pthread_mutex_unlock(&p->progress_mutex);
656 /// Waits for all threads to finish.
657 static void park_frame_worker_threads(FrameThreadContext *fctx, int thread_count)
663 for (i = 0; i < thread_count; i++) {
664 PerThreadContext *p = &fctx->threads[i];
666 if (atomic_load(&p->state) != STATE_INPUT_READY) {
667 pthread_mutex_lock(&p->progress_mutex);
668 while (atomic_load(&p->state) != STATE_INPUT_READY)
669 pthread_cond_wait(&p->output_cond, &p->progress_mutex);
670 pthread_mutex_unlock(&p->progress_mutex);
678 void ff_frame_thread_free(AVCodecContext *avctx, int thread_count)
680 FrameThreadContext *fctx = avctx->internal->thread_ctx;
681 const AVCodec *codec = avctx->codec;
684 park_frame_worker_threads(fctx, thread_count);
686 if (fctx->prev_thread && avctx->internal->hwaccel_priv_data !=
687 fctx->prev_thread->avctx->internal->hwaccel_priv_data) {
688 if (update_context_from_thread(avctx, fctx->prev_thread->avctx, 1) < 0) {
689 av_log(avctx, AV_LOG_ERROR, "Failed to update user thread.\n");
693 if (fctx->prev_thread && fctx->prev_thread != fctx->threads)
694 if (update_context_from_thread(fctx->threads->avctx, fctx->prev_thread->avctx, 0) < 0) {
695 av_log(avctx, AV_LOG_ERROR, "Final thread update failed\n");
696 fctx->prev_thread->avctx->internal->is_copy = fctx->threads->avctx->internal->is_copy;
697 fctx->threads->avctx->internal->is_copy = 1;
700 for (i = 0; i < thread_count; i++) {
701 PerThreadContext *p = &fctx->threads[i];
703 pthread_mutex_lock(&p->mutex);
705 pthread_cond_signal(&p->input_cond);
706 pthread_mutex_unlock(&p->mutex);
709 pthread_join(p->thread, NULL);
712 if (codec->close && p->avctx)
713 codec->close(p->avctx);
715 #if FF_API_THREAD_SAFE_CALLBACKS
716 release_delayed_buffers(p);
718 av_frame_free(&p->frame);
721 for (i = 0; i < thread_count; i++) {
722 PerThreadContext *p = &fctx->threads[i];
724 pthread_mutex_destroy(&p->mutex);
725 pthread_mutex_destroy(&p->progress_mutex);
726 pthread_cond_destroy(&p->input_cond);
727 pthread_cond_destroy(&p->progress_cond);
728 pthread_cond_destroy(&p->output_cond);
729 av_packet_unref(&p->avpkt);
731 #if FF_API_THREAD_SAFE_CALLBACKS
732 for (int j = 0; j < p->released_buffers_allocated; j++)
733 av_frame_free(&p->released_buffers[j]);
734 av_freep(&p->released_buffers);
738 if (codec->priv_class)
739 av_opt_free(p->avctx->priv_data);
740 av_freep(&p->avctx->priv_data);
742 av_freep(&p->avctx->slice_offset);
746 av_buffer_unref(&p->avctx->internal->pool);
747 av_freep(&p->avctx->internal);
748 av_buffer_unref(&p->avctx->hw_frames_ctx);
754 av_freep(&fctx->threads);
755 pthread_mutex_destroy(&fctx->buffer_mutex);
756 pthread_mutex_destroy(&fctx->hwaccel_mutex);
757 pthread_mutex_destroy(&fctx->async_mutex);
758 pthread_cond_destroy(&fctx->async_cond);
760 av_freep(&avctx->internal->thread_ctx);
762 if (avctx->priv_data && avctx->codec && avctx->codec->priv_class)
763 av_opt_free(avctx->priv_data);
767 int ff_frame_thread_init(AVCodecContext *avctx)
769 int thread_count = avctx->thread_count;
770 const AVCodec *codec = avctx->codec;
771 AVCodecContext *src = avctx;
772 FrameThreadContext *fctx;
776 int nb_cpus = av_cpu_count();
778 if ((avctx->debug & (FF_DEBUG_VIS_QP | FF_DEBUG_VIS_MB_TYPE)) || avctx->debug_mv)
781 // use number of cores + 1 as thread count if there is more than one
783 thread_count = avctx->thread_count = FFMIN(nb_cpus + 1, MAX_AUTO_THREADS);
785 thread_count = avctx->thread_count = 1;
788 if (thread_count <= 1) {
789 avctx->active_thread_type = 0;
793 avctx->internal->thread_ctx = fctx = av_mallocz(sizeof(FrameThreadContext));
795 return AVERROR(ENOMEM);
797 fctx->threads = av_mallocz_array(thread_count, sizeof(PerThreadContext));
798 if (!fctx->threads) {
799 av_freep(&avctx->internal->thread_ctx);
800 return AVERROR(ENOMEM);
803 pthread_mutex_init(&fctx->buffer_mutex, NULL);
804 pthread_mutex_init(&fctx->hwaccel_mutex, NULL);
805 pthread_mutex_init(&fctx->async_mutex, NULL);
806 pthread_cond_init(&fctx->async_cond, NULL);
808 fctx->async_lock = 1;
811 if (codec->type == AVMEDIA_TYPE_VIDEO)
812 avctx->delay = src->thread_count - 1;
814 for (i = 0; i < thread_count; i++) {
815 AVCodecContext *copy = av_malloc(sizeof(AVCodecContext));
816 PerThreadContext *p = &fctx->threads[i];
818 pthread_mutex_init(&p->mutex, NULL);
819 pthread_mutex_init(&p->progress_mutex, NULL);
820 pthread_cond_init(&p->input_cond, NULL);
821 pthread_cond_init(&p->progress_cond, NULL);
822 pthread_cond_init(&p->output_cond, NULL);
824 p->frame = av_frame_alloc();
827 err = AVERROR(ENOMEM);
835 err = AVERROR(ENOMEM);
841 copy->internal = av_malloc(sizeof(AVCodecInternal));
842 if (!copy->internal) {
843 copy->priv_data = NULL;
844 err = AVERROR(ENOMEM);
847 *copy->internal = *src->internal;
848 copy->internal->thread_ctx = p;
849 copy->internal->last_pkt_props = &p->avpkt;
851 copy->delay = avctx->delay;
853 if (codec->priv_data_size) {
854 copy->priv_data = av_mallocz(codec->priv_data_size);
855 if (!copy->priv_data) {
856 err = AVERROR(ENOMEM);
860 if (codec->priv_class) {
861 *(const AVClass **)copy->priv_data = codec->priv_class;
862 err = av_opt_copy(copy->priv_data, src->priv_data);
869 copy->internal->is_copy = 1;
872 err = codec->init(copy);
877 update_context_from_thread(avctx, copy, 1);
879 atomic_init(&p->debug_threads, (copy->debug & FF_DEBUG_THREADS) != 0);
881 err = AVERROR(pthread_create(&p->thread, NULL, frame_worker_thread, p));
882 p->thread_init= !err;
890 ff_frame_thread_free(avctx, i+1);
895 void ff_thread_flush(AVCodecContext *avctx)
898 FrameThreadContext *fctx = avctx->internal->thread_ctx;
902 park_frame_worker_threads(fctx, avctx->thread_count);
903 if (fctx->prev_thread) {
904 if (fctx->prev_thread != &fctx->threads[0])
905 update_context_from_thread(fctx->threads[0].avctx, fctx->prev_thread->avctx, 0);
908 fctx->next_decoding = fctx->next_finished = 0;
910 fctx->prev_thread = NULL;
911 for (i = 0; i < avctx->thread_count; i++) {
912 PerThreadContext *p = &fctx->threads[i];
913 // Make sure decode flush calls with size=0 won't return old frames
915 av_frame_unref(p->frame);
918 #if FF_API_THREAD_SAFE_CALLBACKS
919 release_delayed_buffers(p);
922 if (avctx->codec->flush)
923 avctx->codec->flush(p->avctx);
927 int ff_thread_can_start_frame(AVCodecContext *avctx)
929 PerThreadContext *p = avctx->internal->thread_ctx;
930 FF_DISABLE_DEPRECATION_WARNINGS
931 if ((avctx->active_thread_type&FF_THREAD_FRAME) && atomic_load(&p->state) != STATE_SETTING_UP &&
932 (avctx->codec->update_thread_context
933 #if FF_API_THREAD_SAFE_CALLBACKS
934 || !THREAD_SAFE_CALLBACKS(avctx)
939 FF_ENABLE_DEPRECATION_WARNINGS
943 static int thread_get_buffer_internal(AVCodecContext *avctx, ThreadFrame *f, int flags)
945 PerThreadContext *p = avctx->internal->thread_ctx;
948 f->owner[0] = f->owner[1] = avctx;
950 if (!(avctx->active_thread_type & FF_THREAD_FRAME))
951 return ff_get_buffer(avctx, f->f, flags);
953 FF_DISABLE_DEPRECATION_WARNINGS
954 if (atomic_load(&p->state) != STATE_SETTING_UP &&
955 (avctx->codec->update_thread_context
956 #if FF_API_THREAD_SAFE_CALLBACKS
957 || !THREAD_SAFE_CALLBACKS(avctx)
960 FF_ENABLE_DEPRECATION_WARNINGS
961 av_log(avctx, AV_LOG_ERROR, "get_buffer() cannot be called after ff_thread_finish_setup()\n");
965 if (avctx->codec->caps_internal & FF_CODEC_CAP_ALLOCATE_PROGRESS) {
966 atomic_int *progress;
967 f->progress = av_buffer_alloc(2 * sizeof(*progress));
969 return AVERROR(ENOMEM);
971 progress = (atomic_int*)f->progress->data;
973 atomic_init(&progress[0], -1);
974 atomic_init(&progress[1], -1);
977 pthread_mutex_lock(&p->parent->buffer_mutex);
978 #if !FF_API_THREAD_SAFE_CALLBACKS
979 err = ff_get_buffer(avctx, f->f, flags);
981 FF_DISABLE_DEPRECATION_WARNINGS
982 if (THREAD_SAFE_CALLBACKS(avctx)) {
983 err = ff_get_buffer(avctx, f->f, flags);
985 pthread_mutex_lock(&p->progress_mutex);
986 p->requested_frame = f->f;
987 p->requested_flags = flags;
988 atomic_store_explicit(&p->state, STATE_GET_BUFFER, memory_order_release);
989 pthread_cond_broadcast(&p->progress_cond);
991 while (atomic_load(&p->state) != STATE_SETTING_UP)
992 pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
996 pthread_mutex_unlock(&p->progress_mutex);
999 if (!THREAD_SAFE_CALLBACKS(avctx) && !avctx->codec->update_thread_context)
1000 ff_thread_finish_setup(avctx);
1001 FF_ENABLE_DEPRECATION_WARNINGS
1004 av_buffer_unref(&f->progress);
1006 pthread_mutex_unlock(&p->parent->buffer_mutex);
1011 #if FF_API_THREAD_SAFE_CALLBACKS
1012 FF_DISABLE_DEPRECATION_WARNINGS
1013 enum AVPixelFormat ff_thread_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt)
1015 enum AVPixelFormat res;
1016 PerThreadContext *p = avctx->internal->thread_ctx;
1017 if (!(avctx->active_thread_type & FF_THREAD_FRAME) || avctx->thread_safe_callbacks ||
1018 avctx->get_format == avcodec_default_get_format)
1019 return ff_get_format(avctx, fmt);
1020 if (atomic_load(&p->state) != STATE_SETTING_UP) {
1021 av_log(avctx, AV_LOG_ERROR, "get_format() cannot be called after ff_thread_finish_setup()\n");
1024 pthread_mutex_lock(&p->progress_mutex);
1025 p->available_formats = fmt;
1026 atomic_store(&p->state, STATE_GET_FORMAT);
1027 pthread_cond_broadcast(&p->progress_cond);
1029 while (atomic_load(&p->state) != STATE_SETTING_UP)
1030 pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
1032 res = p->result_format;
1034 pthread_mutex_unlock(&p->progress_mutex);
1038 FF_ENABLE_DEPRECATION_WARNINGS
1041 int ff_thread_get_buffer(AVCodecContext *avctx, ThreadFrame *f, int flags)
1043 int ret = thread_get_buffer_internal(avctx, f, flags);
1045 av_log(avctx, AV_LOG_ERROR, "thread_get_buffer() failed\n");
1049 void ff_thread_release_buffer(AVCodecContext *avctx, ThreadFrame *f)
1051 #if FF_API_THREAD_SAFE_CALLBACKS
1052 FF_DISABLE_DEPRECATION_WARNINGS
1053 PerThreadContext *p = avctx->internal->thread_ctx;
1054 FrameThreadContext *fctx;
1057 int can_direct_free = !(avctx->active_thread_type & FF_THREAD_FRAME) ||
1058 THREAD_SAFE_CALLBACKS(avctx);
1059 FF_ENABLE_DEPRECATION_WARNINGS
1065 if (avctx->debug & FF_DEBUG_BUFFERS)
1066 av_log(avctx, AV_LOG_DEBUG, "thread_release_buffer called on pic %p\n", f);
1068 av_buffer_unref(&f->progress);
1069 f->owner[0] = f->owner[1] = NULL;
1071 #if !FF_API_THREAD_SAFE_CALLBACKS
1072 av_frame_unref(f->f);
1074 // when the frame buffers are not allocated, just reset it to clean state
1075 if (can_direct_free || !f->f->buf[0]) {
1076 av_frame_unref(f->f);
1081 pthread_mutex_lock(&fctx->buffer_mutex);
1083 if (p->num_released_buffers == p->released_buffers_allocated) {
1084 AVFrame **tmp = av_realloc_array(p->released_buffers, p->released_buffers_allocated + 1,
1085 sizeof(*p->released_buffers));
1087 tmp[p->released_buffers_allocated] = av_frame_alloc();
1088 p->released_buffers = tmp;
1091 if (!tmp || !tmp[p->released_buffers_allocated]) {
1092 ret = AVERROR(ENOMEM);
1095 p->released_buffers_allocated++;
1098 dst = p->released_buffers[p->num_released_buffers];
1099 av_frame_move_ref(dst, f->f);
1101 p->num_released_buffers++;
1104 pthread_mutex_unlock(&fctx->buffer_mutex);
1106 // make sure the frame is clean even if we fail to free it
1107 // this leaks, but it is better than crashing
1109 av_log(avctx, AV_LOG_ERROR, "Could not queue a frame for freeing, this will leak\n");
1110 memset(f->f->buf, 0, sizeof(f->f->buf));
1111 if (f->f->extended_buf)
1112 memset(f->f->extended_buf, 0, f->f->nb_extended_buf * sizeof(*f->f->extended_buf));
1113 av_frame_unref(f->f);