FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
pthread_frame.c
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
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.
8  *
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.
13  *
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
17  */
18 
19 /**
20  * @file
21  * Frame multithreading support functions
22  * @see doc/multithreading.txt
23  */
24 
25 #include "config.h"
26 
27 #include <stdatomic.h>
28 #include <stdint.h>
29 
30 #include "avcodec.h"
31 #include "hwaccel.h"
32 #include "internal.h"
33 #include "pthread_internal.h"
34 #include "thread.h"
35 #include "version.h"
36 
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"
47 
48 enum {
49  ///< Set when the thread is awaiting a packet.
51  ///< Set before the codec has called ff_thread_finish_setup().
53  /**
54  * Set when the codec calls get_buffer().
55  * State is returned to STATE_SETTING_UP afterwards.
56  */
58  /**
59  * Set when the codec calls get_format().
60  * State is returned to STATE_SETTING_UP afterwards.
61  */
63  ///< Set after the codec has called ff_thread_finish_setup().
65 };
66 
67 /**
68  * Context used by codec threads and stored in their AVCodecInternal thread_ctx.
69  */
70 typedef struct PerThreadContext {
72 
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.
78 
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.
81 
82  AVCodecContext *avctx; ///< Context used to decode packets passed to this thread.
83 
84  AVPacket avpkt; ///< Input packet (for decoding) or output (for encoding).
85 
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.
89 
91 
92  /**
93  * Array of frames passed to ff_thread_release_buffer().
94  * Frames are released after all threads referencing them are finished.
95  */
99 
100  AVFrame *requested_frame; ///< AVFrame the codec passed to get_buffer()
101  int requested_flags; ///< flags passed to get_buffer() for requested_frame
102 
103  const enum AVPixelFormat *available_formats; ///< Format array for get_format()
104  enum AVPixelFormat result_format; ///< get_format() result
105 
106  int die; ///< Set when the thread should exit.
107 
110 
111  atomic_int debug_threads; ///< Set if the FF_DEBUG_THREADS option is set.
113 
114 /**
115  * Context stored in the client AVCodecInternal thread_ctx.
116  */
117 typedef struct FrameThreadContext {
118  PerThreadContext *threads; ///< The contexts for each thread.
119  PerThreadContext *prev_thread; ///< The last thread submit_packet() was called on.
120 
121  pthread_mutex_t buffer_mutex; ///< Mutex used to protect get/release_buffer().
122  /**
123  * This lock is used for ensuring threads run in serial when hwaccel
124  * is used.
125  */
130 
131  int next_decoding; ///< The next context to submit a packet to.
132  int next_finished; ///< The next context to return output from.
133 
134  int delaying; /**<
135  * Set for the first N packets, where N is the number of threads.
136  * While it is set, ff_thread_en/decode_frame won't return any results.
137  */
139 
140 #define THREAD_SAFE_CALLBACKS(avctx) \
141 ((avctx)->thread_safe_callbacks || (avctx)->get_buffer2 == avcodec_default_get_buffer2)
142 
143 static void async_lock(FrameThreadContext *fctx)
144 {
146  while (fctx->async_lock)
147  pthread_cond_wait(&fctx->async_cond, &fctx->async_mutex);
148  fctx->async_lock = 1;
150 }
151 
153 {
155  av_assert0(fctx->async_lock);
156  fctx->async_lock = 0;
159 }
160 
161 /**
162  * Codec worker thread.
163  *
164  * Automatically calls ff_thread_finish_setup() if the codec does
165  * not provide an update_thread_context method, or if the codec returns
166  * before calling it.
167  */
169 {
170  PerThreadContext *p = arg;
171  AVCodecContext *avctx = p->avctx;
172  const AVCodec *codec = avctx->codec;
173 
175  while (1) {
176  while (atomic_load(&p->state) == STATE_INPUT_READY && !p->die)
178 
179  if (p->die) break;
180 
181  if (!codec->update_thread_context && THREAD_SAFE_CALLBACKS(avctx))
182  ff_thread_finish_setup(avctx);
183 
184  /* If a decoder supports hwaccel, then it must call ff_get_format().
185  * Since that call must happen before ff_thread_finish_setup(), the
186  * decoder is required to implement update_thread_context() and call
187  * ff_thread_finish_setup() manually. Therefore the above
188  * ff_thread_finish_setup() call did not happen and hwaccel_serializing
189  * cannot be true here. */
191 
192  /* if the previous thread uses hwaccel then we take the lock to ensure
193  * the threads don't run concurrently */
194  if (avctx->hwaccel) {
196  p->hwaccel_serializing = 1;
197  }
198 
199  av_frame_unref(p->frame);
200  p->got_frame = 0;
201  p->result = codec->decode(avctx, p->frame, &p->got_frame, &p->avpkt);
202 
203  if ((p->result < 0 || !p->got_frame) && p->frame->buf[0]) {
204  if (avctx->internal->allocate_progress)
205  av_log(avctx, AV_LOG_ERROR, "A frame threaded decoder did not "
206  "free the frame on failure. This is a bug, please report it.\n");
207  av_frame_unref(p->frame);
208  }
209 
210  if (atomic_load(&p->state) == STATE_SETTING_UP)
211  ff_thread_finish_setup(avctx);
212 
213  if (p->hwaccel_serializing) {
214  p->hwaccel_serializing = 0;
216  }
217 
218  if (p->async_serializing) {
219  p->async_serializing = 0;
220 
221  async_unlock(p->parent);
222  }
223 
225 
227 
231  }
233 
234  return NULL;
235 }
236 
237 /**
238  * Update the next thread's AVCodecContext with values from the reference thread's context.
239  *
240  * @param dst The destination context.
241  * @param src The source context.
242  * @param for_user 0 if the destination is a codec thread, 1 if the destination is the user's thread
243  * @return 0 on success, negative error code on failure
244  */
246 {
247  int err = 0;
248 
249  if (dst != src && (for_user || !(av_codec_get_codec_descriptor(src)->props & AV_CODEC_PROP_INTRA_ONLY))) {
250  dst->time_base = src->time_base;
251  dst->framerate = src->framerate;
252  dst->width = src->width;
253  dst->height = src->height;
254  dst->pix_fmt = src->pix_fmt;
255  dst->sw_pix_fmt = src->sw_pix_fmt;
256 
257  dst->coded_width = src->coded_width;
258  dst->coded_height = src->coded_height;
259 
260  dst->has_b_frames = src->has_b_frames;
261  dst->idct_algo = src->idct_algo;
262 
265 #if FF_API_AFD
267  dst->dtg_active_format = src->dtg_active_format;
269 #endif /* FF_API_AFD */
270 
271  dst->profile = src->profile;
272  dst->level = src->level;
273 
275  dst->ticks_per_frame = src->ticks_per_frame;
276  dst->color_primaries = src->color_primaries;
277 
278  dst->color_trc = src->color_trc;
279  dst->colorspace = src->colorspace;
280  dst->color_range = src->color_range;
282 
283  dst->hwaccel = src->hwaccel;
284  dst->hwaccel_context = src->hwaccel_context;
285 
286  dst->channels = src->channels;
287  dst->sample_rate = src->sample_rate;
288  dst->sample_fmt = src->sample_fmt;
289  dst->channel_layout = src->channel_layout;
291 
292  if (!!dst->hw_frames_ctx != !!src->hw_frames_ctx ||
293  (dst->hw_frames_ctx && dst->hw_frames_ctx->data != src->hw_frames_ctx->data)) {
295 
296  if (src->hw_frames_ctx) {
298  if (!dst->hw_frames_ctx)
299  return AVERROR(ENOMEM);
300  }
301  }
302 
303  dst->hwaccel_flags = src->hwaccel_flags;
304  }
305 
306  if (for_user) {
307  dst->delay = src->thread_count - 1;
308 #if FF_API_CODED_FRAME
310  dst->coded_frame = src->coded_frame;
312 #endif
313  } else {
314  if (dst->codec->update_thread_context)
315  err = dst->codec->update_thread_context(dst, src);
316  }
317 
318  return err;
319 }
320 
321 /**
322  * Update the next thread's AVCodecContext with values set by the user.
323  *
324  * @param dst The destination context.
325  * @param src The source context.
326  * @return 0 on success, negative error code on failure
327  */
329 {
330 #define copy_fields(s, e) memcpy(&dst->s, &src->s, (char*)&dst->e - (char*)&dst->s);
331  dst->flags = src->flags;
332 
333  dst->draw_horiz_band= src->draw_horiz_band;
334  dst->get_buffer2 = src->get_buffer2;
335 
336  dst->opaque = src->opaque;
337  dst->debug = src->debug;
338  dst->debug_mv = src->debug_mv;
339 
340  dst->slice_flags = src->slice_flags;
341  dst->flags2 = src->flags2;
342 
343  copy_fields(skip_loop_filter, subtitle_header);
344 
345  dst->frame_number = src->frame_number;
348 
349  if (src->slice_count && src->slice_offset) {
350  if (dst->slice_count < src->slice_count) {
351  int err = av_reallocp_array(&dst->slice_offset, src->slice_count,
352  sizeof(*dst->slice_offset));
353  if (err < 0)
354  return err;
355  }
356  memcpy(dst->slice_offset, src->slice_offset,
357  src->slice_count * sizeof(*dst->slice_offset));
358  }
359  dst->slice_count = src->slice_count;
360  return 0;
361 #undef copy_fields
362 }
363 
364 /// Releases the buffers that this decoding thread was the last user of.
366 {
367  FrameThreadContext *fctx = p->parent;
368 
369  while (p->num_released_buffers > 0) {
370  AVFrame *f;
371 
373 
374  // fix extended data in case the caller screwed it up
378  f->extended_data = f->data;
379  av_frame_unref(f);
380 
382  }
383 }
384 
385 static int submit_packet(PerThreadContext *p, AVCodecContext *user_avctx,
386  AVPacket *avpkt)
387 {
388  FrameThreadContext *fctx = p->parent;
389  PerThreadContext *prev_thread = fctx->prev_thread;
390  const AVCodec *codec = p->avctx->codec;
391  int ret;
392 
393  if (!avpkt->size && !(codec->capabilities & AV_CODEC_CAP_DELAY))
394  return 0;
395 
397 
398  ret = update_context_from_user(p->avctx, user_avctx);
399  if (ret) {
401  return ret;
402  }
404  (p->avctx->debug & FF_DEBUG_THREADS) != 0,
405  memory_order_relaxed);
406 
408 
409  if (prev_thread) {
410  int err;
411  if (atomic_load(&prev_thread->state) == STATE_SETTING_UP) {
412  pthread_mutex_lock(&prev_thread->progress_mutex);
413  while (atomic_load(&prev_thread->state) == STATE_SETTING_UP)
414  pthread_cond_wait(&prev_thread->progress_cond, &prev_thread->progress_mutex);
415  pthread_mutex_unlock(&prev_thread->progress_mutex);
416  }
417 
418  err = update_context_from_thread(p->avctx, prev_thread->avctx, 0);
419  if (err) {
421  return err;
422  }
423  }
424 
425  av_packet_unref(&p->avpkt);
426  ret = av_packet_ref(&p->avpkt, avpkt);
427  if (ret < 0) {
429  av_log(p->avctx, AV_LOG_ERROR, "av_packet_ref() failed in submit_packet()\n");
430  return ret;
431  }
432 
436 
437  /*
438  * If the client doesn't have a thread-safe get_buffer(),
439  * then decoding threads call back to the main thread,
440  * and it calls back to the client here.
441  */
442 
443  if (!p->avctx->thread_safe_callbacks && (
447  int call_done = 1;
449  while (atomic_load(&p->state) == STATE_SETTING_UP)
451 
452  switch (atomic_load_explicit(&p->state, memory_order_acquire)) {
453  case STATE_GET_BUFFER:
455  break;
456  case STATE_GET_FORMAT:
458  break;
459  default:
460  call_done = 0;
461  break;
462  }
463  if (call_done) {
466  }
468  }
469  }
470 
471  fctx->prev_thread = p;
472  fctx->next_decoding++;
473 
474  return 0;
475 }
476 
478  AVFrame *picture, int *got_picture_ptr,
479  AVPacket *avpkt)
480 {
481  FrameThreadContext *fctx = avctx->internal->thread_ctx;
482  int finished = fctx->next_finished;
483  PerThreadContext *p;
484  int err;
485 
486  /* release the async lock, permitting blocked hwaccel threads to
487  * go forward while we are in this function */
488  async_unlock(fctx);
489 
490  /*
491  * Submit a packet to the next decoding thread.
492  */
493 
494  p = &fctx->threads[fctx->next_decoding];
495  err = submit_packet(p, avctx, avpkt);
496  if (err)
497  goto finish;
498 
499  /*
500  * If we're still receiving the initial packets, don't return a frame.
501  */
502 
503  if (fctx->next_decoding > (avctx->thread_count-1-(avctx->codec_id == AV_CODEC_ID_FFV1)))
504  fctx->delaying = 0;
505 
506  if (fctx->delaying) {
507  *got_picture_ptr=0;
508  if (avpkt->size) {
509  err = avpkt->size;
510  goto finish;
511  }
512  }
513 
514  /*
515  * Return the next available frame from the oldest thread.
516  * If we're at the end of the stream, then we have to skip threads that
517  * didn't output a frame/error, because we don't want to accidentally signal
518  * EOF (avpkt->size == 0 && *got_picture_ptr == 0 && err >= 0).
519  */
520 
521  do {
522  p = &fctx->threads[finished++];
523 
524  if (atomic_load(&p->state) != STATE_INPUT_READY) {
526  while (atomic_load_explicit(&p->state, memory_order_relaxed) != STATE_INPUT_READY)
529  }
530 
531  av_frame_move_ref(picture, p->frame);
532  *got_picture_ptr = p->got_frame;
533  picture->pkt_dts = p->avpkt.dts;
534  err = p->result;
535 
536  /*
537  * A later call with avkpt->size == 0 may loop over all threads,
538  * including this one, searching for a frame/error to return before being
539  * stopped by the "finished != fctx->next_finished" condition.
540  * Make sure we don't mistakenly return the same frame/error again.
541  */
542  p->got_frame = 0;
543  p->result = 0;
544 
545  if (finished >= avctx->thread_count) finished = 0;
546  } while (!avpkt->size && !*got_picture_ptr && err >= 0 && finished != fctx->next_finished);
547 
548  update_context_from_thread(avctx, p->avctx, 1);
549 
550  if (fctx->next_decoding >= avctx->thread_count) fctx->next_decoding = 0;
551 
552  fctx->next_finished = finished;
553 
554  /* return the size of the consumed packet if no error occurred */
555  if (err >= 0)
556  err = avpkt->size;
557 finish:
558  async_lock(fctx);
559  return err;
560 }
561 
562 void ff_thread_report_progress(ThreadFrame *f, int n, int field)
563 {
564  PerThreadContext *p;
565  atomic_int *progress = f->progress ? (atomic_int*)f->progress->data : NULL;
566 
567  if (!progress ||
568  atomic_load_explicit(&progress[field], memory_order_relaxed) >= n)
569  return;
570 
571  p = f->owner[field]->internal->thread_ctx;
572 
573  if (atomic_load_explicit(&p->debug_threads, memory_order_relaxed))
574  av_log(f->owner[field], AV_LOG_DEBUG,
575  "%p finished %d field %d\n", progress, n, field);
576 
578 
579  atomic_store_explicit(&progress[field], n, memory_order_release);
580 
583 }
584 
585 void ff_thread_await_progress(ThreadFrame *f, int n, int field)
586 {
587  PerThreadContext *p;
588  atomic_int *progress = f->progress ? (atomic_int*)f->progress->data : NULL;
589 
590  if (!progress ||
591  atomic_load_explicit(&progress[field], memory_order_acquire) >= n)
592  return;
593 
594  p = f->owner[field]->internal->thread_ctx;
595 
596  if (atomic_load_explicit(&p->debug_threads, memory_order_relaxed))
597  av_log(f->owner[field], AV_LOG_DEBUG,
598  "thread awaiting %d field %d from %p\n", n, field, progress);
599 
601  while (atomic_load_explicit(&progress[field], memory_order_relaxed) < n)
604 }
605 
607  PerThreadContext *p = avctx->internal->thread_ctx;
608 
609  if (!(avctx->active_thread_type&FF_THREAD_FRAME)) return;
610 
611  if (avctx->hwaccel && !p->hwaccel_serializing) {
613  p->hwaccel_serializing = 1;
614  }
615 
616  /* this assumes that no hwaccel calls happen before ff_thread_finish_setup() */
617  if (avctx->hwaccel &&
619  p->async_serializing = 1;
620 
621  async_lock(p->parent);
622  }
623 
626  av_log(avctx, AV_LOG_WARNING, "Multiple ff_thread_finish_setup() calls\n");
627  }
628 
630 
633 }
634 
635 /// Waits for all threads to finish.
636 static void park_frame_worker_threads(FrameThreadContext *fctx, int thread_count)
637 {
638  int i;
639 
640  async_unlock(fctx);
641 
642  for (i = 0; i < thread_count; i++) {
643  PerThreadContext *p = &fctx->threads[i];
644 
645  if (atomic_load(&p->state) != STATE_INPUT_READY) {
647  while (atomic_load(&p->state) != STATE_INPUT_READY)
650  }
651  p->got_frame = 0;
652  }
653 
654  async_lock(fctx);
655 }
656 
657 void ff_frame_thread_free(AVCodecContext *avctx, int thread_count)
658 {
659  FrameThreadContext *fctx = avctx->internal->thread_ctx;
660  const AVCodec *codec = avctx->codec;
661  int i;
662 
663  park_frame_worker_threads(fctx, thread_count);
664 
665  if (fctx->prev_thread && fctx->prev_thread != fctx->threads)
666  if (update_context_from_thread(fctx->threads->avctx, fctx->prev_thread->avctx, 0) < 0) {
667  av_log(avctx, AV_LOG_ERROR, "Final thread update failed\n");
669  fctx->threads->avctx->internal->is_copy = 1;
670  }
671 
672  for (i = 0; i < thread_count; i++) {
673  PerThreadContext *p = &fctx->threads[i];
674 
676  p->die = 1;
679 
680  if (p->thread_init)
681  pthread_join(p->thread, NULL);
682  p->thread_init=0;
683 
684  if (codec->close && p->avctx)
685  codec->close(p->avctx);
686 
688  av_frame_free(&p->frame);
689  }
690 
691  for (i = 0; i < thread_count; i++) {
692  PerThreadContext *p = &fctx->threads[i];
693 
699  av_packet_unref(&p->avpkt);
701 
702  if (i && p->avctx) {
703  av_freep(&p->avctx->priv_data);
705  }
706 
707  if (p->avctx) {
708  av_freep(&p->avctx->internal);
710  }
711 
712  av_freep(&p->avctx);
713  }
714 
715  av_freep(&fctx->threads);
720 
721  av_freep(&avctx->internal->thread_ctx);
722 
723  if (avctx->priv_data && avctx->codec && avctx->codec->priv_class)
724  av_opt_free(avctx->priv_data);
725  avctx->codec = NULL;
726 }
727 
729 {
730  int thread_count = avctx->thread_count;
731  const AVCodec *codec = avctx->codec;
732  AVCodecContext *src = avctx;
733  FrameThreadContext *fctx;
734  int i, err = 0;
735 
736 #if HAVE_W32THREADS
737  w32thread_init();
738 #endif
739 
740  if (!thread_count) {
741  int nb_cpus = av_cpu_count();
742 #if FF_API_DEBUG_MV
743  if ((avctx->debug & (FF_DEBUG_VIS_QP | FF_DEBUG_VIS_MB_TYPE)) || avctx->debug_mv)
744  nb_cpus = 1;
745 #endif
746  // use number of cores + 1 as thread count if there is more than one
747  if (nb_cpus > 1)
748  thread_count = avctx->thread_count = FFMIN(nb_cpus + 1, MAX_AUTO_THREADS);
749  else
750  thread_count = avctx->thread_count = 1;
751  }
752 
753  if (thread_count <= 1) {
754  avctx->active_thread_type = 0;
755  return 0;
756  }
757 
758  avctx->internal->thread_ctx = fctx = av_mallocz(sizeof(FrameThreadContext));
759  if (!fctx)
760  return AVERROR(ENOMEM);
761 
762  fctx->threads = av_mallocz_array(thread_count, sizeof(PerThreadContext));
763  if (!fctx->threads) {
764  av_freep(&avctx->internal->thread_ctx);
765  return AVERROR(ENOMEM);
766  }
767 
772 
773  fctx->async_lock = 1;
774  fctx->delaying = 1;
775 
776  for (i = 0; i < thread_count; i++) {
778  PerThreadContext *p = &fctx->threads[i];
779 
785 
786  p->frame = av_frame_alloc();
787  if (!p->frame) {
788  av_freep(&copy);
789  err = AVERROR(ENOMEM);
790  goto error;
791  }
792 
793  p->parent = fctx;
794  p->avctx = copy;
795 
796  if (!copy) {
797  err = AVERROR(ENOMEM);
798  goto error;
799  }
800 
801  *copy = *src;
802 
803  copy->internal = av_malloc(sizeof(AVCodecInternal));
804  if (!copy->internal) {
805  copy->priv_data = NULL;
806  err = AVERROR(ENOMEM);
807  goto error;
808  }
809  *copy->internal = *src->internal;
810  copy->internal->thread_ctx = p;
811  copy->internal->last_pkt_props = &p->avpkt;
812 
813  if (!i) {
814  src = copy;
815 
816  if (codec->init)
817  err = codec->init(copy);
818 
819  update_context_from_thread(avctx, copy, 1);
820  } else {
821  copy->priv_data = av_malloc(codec->priv_data_size);
822  if (!copy->priv_data) {
823  err = AVERROR(ENOMEM);
824  goto error;
825  }
826  memcpy(copy->priv_data, src->priv_data, codec->priv_data_size);
827  copy->internal->is_copy = 1;
828 
829  if (codec->init_thread_copy)
830  err = codec->init_thread_copy(copy);
831  }
832 
833  if (err) goto error;
834 
835  atomic_init(&p->debug_threads, (copy->debug & FF_DEBUG_THREADS) != 0);
836 
838  p->thread_init= !err;
839  if(!p->thread_init)
840  goto error;
841  }
842 
843  return 0;
844 
845 error:
846  ff_frame_thread_free(avctx, i+1);
847 
848  return err;
849 }
850 
852 {
853  int i;
854  FrameThreadContext *fctx = avctx->internal->thread_ctx;
855 
856  if (!fctx) return;
857 
859  if (fctx->prev_thread) {
860  if (fctx->prev_thread != &fctx->threads[0])
862  }
863 
864  fctx->next_decoding = fctx->next_finished = 0;
865  fctx->delaying = 1;
866  fctx->prev_thread = NULL;
867  for (i = 0; i < avctx->thread_count; i++) {
868  PerThreadContext *p = &fctx->threads[i];
869  // Make sure decode flush calls with size=0 won't return old frames
870  p->got_frame = 0;
871  av_frame_unref(p->frame);
872  p->result = 0;
873 
875 
876  if (avctx->codec->flush)
877  avctx->codec->flush(p->avctx);
878  }
879 }
880 
882 {
883  PerThreadContext *p = avctx->internal->thread_ctx;
885  (avctx->codec->update_thread_context || !THREAD_SAFE_CALLBACKS(avctx))) {
886  return 0;
887  }
888  return 1;
889 }
890 
892 {
893  PerThreadContext *p = avctx->internal->thread_ctx;
894  int err;
895 
896  f->owner[0] = f->owner[1] = avctx;
897 
898  ff_init_buffer_info(avctx, f->f);
899 
900  if (!(avctx->active_thread_type & FF_THREAD_FRAME))
901  return ff_get_buffer(avctx, f->f, flags);
902 
903  if (atomic_load(&p->state) != STATE_SETTING_UP &&
904  (avctx->codec->update_thread_context || !THREAD_SAFE_CALLBACKS(avctx))) {
905  av_log(avctx, AV_LOG_ERROR, "get_buffer() cannot be called after ff_thread_finish_setup()\n");
906  return -1;
907  }
908 
909  if (avctx->internal->allocate_progress) {
910  atomic_int *progress;
911  f->progress = av_buffer_alloc(2 * sizeof(*progress));
912  if (!f->progress) {
913  return AVERROR(ENOMEM);
914  }
915  progress = (atomic_int*)f->progress->data;
916 
917  atomic_init(&progress[0], -1);
918  atomic_init(&progress[1], -1);
919  }
920 
922  if (avctx->thread_safe_callbacks ||
924  err = ff_get_buffer(avctx, f->f, flags);
925  } else {
927  p->requested_frame = f->f;
928  p->requested_flags = flags;
929  atomic_store_explicit(&p->state, STATE_GET_BUFFER, memory_order_release);
931 
932  while (atomic_load(&p->state) != STATE_SETTING_UP)
934 
935  err = p->result;
936 
938 
939  }
940  if (!THREAD_SAFE_CALLBACKS(avctx) && !avctx->codec->update_thread_context)
941  ff_thread_finish_setup(avctx);
942  if (err)
944 
946 
947  return err;
948 }
949 
951 {
952  enum AVPixelFormat res;
953  PerThreadContext *p = avctx->internal->thread_ctx;
954  if (!(avctx->active_thread_type & FF_THREAD_FRAME) || avctx->thread_safe_callbacks ||
956  return ff_get_format(avctx, fmt);
957  if (atomic_load(&p->state) != STATE_SETTING_UP) {
958  av_log(avctx, AV_LOG_ERROR, "get_format() cannot be called after ff_thread_finish_setup()\n");
959  return -1;
960  }
962  p->available_formats = fmt;
965 
966  while (atomic_load(&p->state) != STATE_SETTING_UP)
968 
969  res = p->result_format;
970 
972 
973  return res;
974 }
975 
977 {
978  int ret = thread_get_buffer_internal(avctx, f, flags);
979  if (ret < 0)
980  av_log(avctx, AV_LOG_ERROR, "thread_get_buffer() failed\n");
981  return ret;
982 }
983 
985 {
986  PerThreadContext *p = avctx->internal->thread_ctx;
987  FrameThreadContext *fctx;
988  AVFrame *dst, *tmp;
989  int can_direct_free = !(avctx->active_thread_type & FF_THREAD_FRAME) ||
990  avctx->thread_safe_callbacks ||
992 
993  if (!f->f || !f->f->buf[0])
994  return;
995 
996  if (avctx->debug & FF_DEBUG_BUFFERS)
997  av_log(avctx, AV_LOG_DEBUG, "thread_release_buffer called on pic %p\n", f);
998 
1000  f->owner[0] = f->owner[1] = NULL;
1001 
1002  if (can_direct_free) {
1003  av_frame_unref(f->f);
1004  return;
1005  }
1006 
1007  fctx = p->parent;
1009 
1010  if (p->num_released_buffers + 1 >= INT_MAX / sizeof(*p->released_buffers))
1011  goto fail;
1013  (p->num_released_buffers + 1) *
1014  sizeof(*p->released_buffers));
1015  if (!tmp)
1016  goto fail;
1017  p->released_buffers = tmp;
1018 
1019  dst = &p->released_buffers[p->num_released_buffers];
1020  av_frame_move_ref(dst, f->f);
1021 
1022  p->num_released_buffers++;
1023 
1024 fail:
1026 }
static int thread_get_buffer_internal(AVCodecContext *avctx, ThreadFrame *f, int flags)
static av_unused void w32thread_init(void)
Definition: w32pthreads.h:397
int caps_internal
Internal hwaccel capabilities.
Definition: avcodec.h:3985
pthread_cond_t progress_cond
Used by child threads to wait for progress to change.
Definition: pthread_frame.c:76
#define NULL
Definition: coverity.c:32
int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt)
Select the (possibly hardware accelerated) pixel format.
Definition: decode.c:1123
const struct AVCodec * codec
Definition: avcodec.h:1752
AVRational framerate
Definition: avcodec.h:3442
#define AV_CODEC_PROP_INTRA_ONLY
Codec uses only intra compression.
Definition: avcodec.h:731
static av_always_inline int pthread_mutex_destroy(pthread_mutex_t *mutex)
Definition: os2threads.h:106
static void copy(const float *p1, float *p2, const int length)
void av_buffer_unref(AVBufferRef **buf)
Free a given reference and automatically free the buffer if there are no more references to it...
Definition: buffer.c:125
#define copy_fields(s, e)
This structure describes decoded (raw) audio or video data.
Definition: frame.h:201
#define pthread_mutex_lock(a)
Definition: ffprobe.c:61
static av_always_inline int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex)
Definition: os2threads.h:164
#define atomic_store(object, desired)
Definition: stdatomic.h:85
Context used by codec threads and stored in their AVCodecInternal thread_ctx.
Definition: pthread_frame.c:70
int av_cpu_count(void)
Definition: cpu.c:263
AVFrame * requested_frame
AVFrame the codec passed to get_buffer()
int coded_width
Bitstream width / height, may be different from width/height e.g.
Definition: avcodec.h:1945
int ff_init_buffer_info(AVCodecContext *avctx, AVFrame *frame)
does needed setup of pkt_pts/pos and such for (re)get_buffer();
Definition: decode.c:1418
const char * fmt
Definition: avisynth_c.h:769
void(* flush)(AVCodecContext *)
Flush buffers.
Definition: avcodec.h:3827
atomic_int state
Definition: pthread_frame.c:90
AVPacket * last_pkt_props
Properties (timestamps+side data) extracted from the last packet passed for decoding.
Definition: internal.h:174
static int submit_packet(PerThreadContext *p, AVCodecContext *user_avctx, AVPacket *avpkt)
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
AVFrame * f
Definition: thread.h:36
Memory handling functions.
AVBufferRef * buf[AV_NUM_DATA_POINTERS]
AVBuffer references backing the data for this frame.
Definition: frame.h:393
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition: avcodec.h:2480
int size
Definition: avcodec.h:1662
AVRational sample_aspect_ratio
sample aspect ratio (0 if unknown) That is the width of a pixel divided by the height of the pixel...
Definition: avcodec.h:2154
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1971
void av_frame_move_ref(AVFrame *dst, AVFrame *src)
Move everything contained in src to dst and reset src.
Definition: frame.c:529
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:222
int(* decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt)
Definition: avcodec.h:3804
int bits_per_raw_sample
Bits per sample/pixel of internal libavcodec pixel/sample format.
Definition: avcodec.h:3146
pthread_cond_t input_cond
Used to wait for a new packet from the main thread.
Definition: pthread_frame.c:75
intptr_t atomic_int
Definition: stdatomic.h:55
void ff_thread_await_progress(ThreadFrame *f, int n, int field)
Wait for earlier decoding threads to finish reference pictures.
#define src
Definition: vp8dsp.c:254
int profile
profile
Definition: avcodec.h:3248
enum AVPixelFormat * available_formats
Format array for get_format()
AVCodec.
Definition: avcodec.h:3721
static av_always_inline int pthread_cond_destroy(pthread_cond_t *cond)
Definition: os2threads.h:138
AVPacket avpkt
Input packet (for decoding) or output (for encoding).
Definition: pthread_frame.c:84
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avcodec.h:1880
struct AVHWAccel * hwaccel
Hardware accelerator in use.
Definition: avcodec.h:3064
#define AV_CODEC_CAP_DELAY
Encoder or decoder requires flushing with NULL input at the end in order to give the complete and cor...
Definition: avcodec.h:1021
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
int(* init_thread_copy)(AVCodecContext *)
If defined, called on thread contexts when they are created.
Definition: avcodec.h:3768
HMTX pthread_mutex_t
Definition: os2threads.h:49
enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat *fmt)
Definition: decode.c:1064
enum AVSampleFormat sample_fmt
audio sample format
Definition: avcodec.h:2513
#define av_malloc(s)
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:148
void * hwaccel_context
Hardware accelerator context.
Definition: avcodec.h:3076
AVOptions.
static attribute_align_arg void * frame_worker_thread(void *arg)
Codec worker thread.
void * thread_ctx
Definition: internal.h:165
Multithreading support functions.
#define THREAD_SAFE_CALLBACKS(avctx)
pthread_mutex_t hwaccel_mutex
This lock is used for ensuring threads run in serial when hwaccel is used.
static void finish(void)
Definition: movenc.c:344
int requested_flags
flags passed to get_buffer() for requested_frame
int next_decoding
The next context to submit a packet to.
static int flags
Definition: log.c:57
static av_always_inline int pthread_cond_signal(pthread_cond_t *cond)
Definition: os2threads.h:146
const AVCodecDescriptor * av_codec_get_codec_descriptor(const AVCodecContext *avctx)
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:3139
void ff_thread_finish_setup(AVCodecContext *avctx)
If the codec defines update_thread_context(), call this when they are ready for the next thread to st...
enum AVChromaLocation chroma_sample_location
This defines the location of chroma samples.
Definition: avcodec.h:2487
Context stored in the client AVCodecInternal thread_ctx.
AVCodecContext * avctx
Context used to decode packets passed to this thread.
Definition: pthread_frame.c:82
#define av_log(a,...)
int av_packet_ref(AVPacket *dst, const AVPacket *src)
Setup a new reference to the data described by a given packet.
Definition: avpacket.c:599
int die
Set when the thread should exit.
int ff_thread_decode_frame(AVCodecContext *avctx, AVFrame *picture, int *got_picture_ptr, AVPacket *avpkt)
Submit a new frame to a decoding thread.
int slice_count
slice count
Definition: avcodec.h:2129
Libavcodec version macros.
int(* close)(AVCodecContext *)
Definition: avcodec.h:3805
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
int has_b_frames
Size of the frame reordering buffer in the decoder.
Definition: avcodec.h:2065
PerThreadContext * prev_thread
The last thread submit_packet() was called on.
void ff_frame_thread_free(AVCodecContext *avctx, int thread_count)
void ff_thread_release_buffer(AVCodecContext *avctx, ThreadFrame *f)
Wrapper around release_buffer() frame-for multithreaded codecs.
#define atomic_load(object)
Definition: stdatomic.h:93
int is_copy
Whether the parent AVCodecContext is a copy of the context which had init() called on it...
Definition: internal.h:138
#define AVERROR(e)
Definition: error.h:43
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:161
int active_thread_type
Which multithreading methods are in use by the codec.
Definition: avcodec.h:3193
int capabilities
Codec capabilities.
Definition: avcodec.h:3740
int result
The result of the last codec decode/encode() call.
Definition: pthread_frame.c:88
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:197
const char * arg
Definition: jacosubdec.c:66
int flags
AV_CODEC_FLAG_*.
Definition: avcodec.h:1838
simple assert() macros that are a bit more flexible than ISO C assert().
static void * av_mallocz_array(size_t nmemb, size_t size)
Definition: mem.h:229
#define fail()
Definition: checkasm.h:109
reference-counted frame API
uint64_t channel_layout
Audio channel layout.
Definition: avcodec.h:2556
int av_reallocp_array(void *ptr, size_t nmemb, size_t size)
Definition: mem.c:191
common internal API header
pthread_cond_t output_cond
Used by the main thread to wait for frames to finish.
Definition: pthread_frame.c:77
void(* draw_horiz_band)(struct AVCodecContext *s, const AVFrame *src, int offset[AV_NUM_DATA_POINTERS], int y, int type, int height)
If non NULL, 'draw_horiz_band' is called by the libavcodec decoder to draw a horizontal band...
Definition: avcodec.h:2004
#define FF_THREAD_FRAME
Decode more than one frame at once.
Definition: avcodec.h:3185
#define FFMIN(a, b)
Definition: common.h:96
int width
picture width / height.
Definition: avcodec.h:1930
int idct_algo
IDCT algorithm, see FF_IDCT_* below.
Definition: avcodec.h:3103
AVBufferRef * hw_frames_ctx
A reference to the AVHWFramesContext describing the input (for encoding) or output (decoding) frames...
Definition: avcodec.h:3598
int priv_data_size
Definition: avcodec.h:3757
void ff_thread_report_progress(ThreadFrame *f, int n, int field)
Notify later decoding threads when part of their reference picture is ready.
#define atomic_load_explicit(object, order)
Definition: stdatomic.h:96
enum AVColorPrimaries color_primaries
Chromaticity coordinates of the source primaries.
Definition: avcodec.h:2459
static av_always_inline int pthread_join(pthread_t thread, void **value_ptr)
Definition: os2threads.h:88
static av_always_inline int pthread_mutex_init(pthread_mutex_t *mutex, const pthread_mutexattr_t *attr)
Definition: os2threads.h:98
int level
level
Definition: avcodec.h:3346
#define FF_DEBUG_BUFFERS
Definition: avcodec.h:3010
void * av_fast_realloc(void *ptr, unsigned int *size, size_t min_size)
Reallocate the given buffer if it is not large enough, otherwise do nothing.
Definition: mem.c:450
int64_t reordered_opaque
opaque 64-bit number (generally a PTS) that will be reordered and output in AVFrame.reordered_opaque
Definition: avcodec.h:3057
int n
Definition: avisynth_c.h:684
int ticks_per_frame
For some codecs, the time base is closer to the field rate than the frame rate.
Definition: avcodec.h:1889
pthread_t thread
Definition: pthread_frame.c:73
#define pthread_mutex_unlock(a)
Definition: ffprobe.c:65
#define FF_DEBUG_THREADS
Definition: avcodec.h:3011
static void error(const char *err)
int thread_count
thread count is used to decide how many independent tasks should be passed to execute() ...
Definition: avcodec.h:3174
int got_frame
The output of got_picture_ptr from the last avcodec_decode_video() call.
Definition: pthread_frame.c:87
static int update_context_from_user(AVCodecContext *dst, AVCodecContext *src)
Update the next thread's AVCodecContext with values set by the user.
pthread_mutex_t buffer_mutex
Mutex used to protect get/release_buffer().
AVBufferRef * progress
Definition: thread.h:40
pthread_mutex_t progress_mutex
Mutex used to protect frame progress values and progress_cond.
Definition: pthread_frame.c:80
#define attribute_align_arg
Definition: internal.h:61
static av_always_inline int pthread_create(pthread_t *thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
Definition: os2threads.h:74
pthread_cond_t async_cond
int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags)
The default callback for AVCodecContext.get_buffer2().
Definition: decode.c:1382
Libavcodec external API header.
enum AVMediaType codec_type
Definition: avcodec.h:1751
enum AVCodecID codec_id
Definition: avcodec.h:1760
AVBufferRef * av_buffer_alloc(int size)
Allocate an AVBuffer of the given size using av_malloc().
Definition: buffer.c:67
int sample_rate
samples per second
Definition: avcodec.h:2505
int debug
debug
Definition: avcodec.h:2985
int ff_thread_get_buffer(AVCodecContext *avctx, ThreadFrame *f, int flags)
Wrapper around get_buffer() for frame-multithreaded codecs.
main external API structure.
Definition: avcodec.h:1743
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:590
uint8_t * data
The data buffer.
Definition: buffer.h:89
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1604
int slice_flags
slice flags
Definition: avcodec.h:2286
AVCodecContext * owner[2]
Definition: thread.h:37
int coded_height
Definition: avcodec.h:1945
enum AVPixelFormat(* get_format)(struct AVCodecContext *s, const enum AVPixelFormat *fmt)
callback to negotiate the pixelFormat
Definition: avcodec.h:2021
enum AVColorSpace colorspace
YUV colorspace type.
Definition: avcodec.h:2473
enum AVColorTransferCharacteristic color_trc
Color Transfer Characteristic.
Definition: avcodec.h:2466
enum AVPixelFormat result_format
get_format() result
int delaying
Set for the first N packets, where N is the number of threads.
refcounted data buffer API
enum AVPixelFormat ff_thread_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt)
Wrapper around get_format() for frame-multithreaded codecs.
int(* get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags)
This callback is called at the beginning of each frame to get data buffer(s) for it.
Definition: avcodec.h:2660
#define atomic_store_explicit(object, desired, order)
Definition: stdatomic.h:90
static void async_unlock(FrameThreadContext *fctx)
PerThreadContext * threads
The contexts for each thread.
int allocate_progress
Whether to allocate progress for frame threading.
Definition: internal.h:153
static void async_lock(FrameThreadContext *fctx)
#define MAX_AUTO_THREADS
AVFrame * released_buffers
Array of frames passed to ff_thread_release_buffer().
Definition: pthread_frame.c:96
struct FrameThreadContext * parent
Definition: pthread_frame.c:71
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:503
const AVClass * priv_class
AVClass for the private context.
Definition: avcodec.h:3747
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:215
int64_t pkt_dts
DTS copied from the AVPacket that triggered returning this frame.
Definition: frame.h:310
Set when the codec calls get_format().
Definition: pthread_frame.c:62
void av_opt_free(void *obj)
Free all allocated objects in obj.
Definition: opt.c:1544
#define FF_DISABLE_DEPRECATION_WARNINGS
Definition: internal.h:83
common internal api header.
common internal and external API header
if(ret< 0)
Definition: vf_mcdeint.c:279
int released_buffers_allocated
Definition: pthread_frame.c:98
void * hwaccel_priv_data
hwaccel-specific private data
Definition: internal.h:192
AVBufferRef * av_buffer_ref(AVBufferRef *buf)
Create a new reference to an AVBuffer.
Definition: buffer.c:93
static int update_context_from_thread(AVCodecContext *dst, AVCodecContext *src, int for_user)
Update the next thread's AVCodecContext with values from the reference thread's context.
static av_always_inline int pthread_cond_init(pthread_cond_t *cond, const pthread_condattr_t *attr)
Definition: os2threads.h:127
attribute_deprecated AVFrame * coded_frame
the picture in the bitstream
Definition: avcodec.h:3165
int thread_safe_callbacks
Set by the client if its custom get_buffer() callback can be called synchronously from another thread...
Definition: avcodec.h:3203
#define HWACCEL_CAP_ASYNC_SAFE
Definition: hwaccel.h:22
void * priv_data
Definition: avcodec.h:1785
int(* update_thread_context)(AVCodecContext *dst, const AVCodecContext *src)
Copy necessary context variables from a previous thread context to the current one.
Definition: avcodec.h:3776
void ff_thread_flush(AVCodecContext *avctx)
Wait for decoding threads to finish and reset internal state.
AVFrame * frame
Output frame (for decoding) or input (for encoding).
Definition: pthread_frame.c:86
int ff_thread_can_start_frame(AVCodecContext *avctx)
#define FF_ENABLE_DEPRECATION_WARNINGS
Definition: internal.h:84
static av_always_inline int pthread_cond_broadcast(pthread_cond_t *cond)
Definition: os2threads.h:156
int channels
number of audio channels
Definition: avcodec.h:2506
struct AVCodecInternal * internal
Private context used for internal data.
Definition: avcodec.h:1793
pthread_mutex_t mutex
Mutex used to protect the contents of the PerThreadContext.
Definition: pthread_frame.c:79
int flags2
AV_CODEC_FLAG2_*.
Definition: avcodec.h:1845
static void park_frame_worker_threads(FrameThreadContext *fctx, int thread_count)
Waits for all threads to finish.
Set when the codec calls get_buffer().
Definition: pthread_frame.c:57
pthread_mutex_t async_mutex
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed...
Definition: avcodec.h:1660
int * slice_offset
slice offsets in the frame in bytes
Definition: avcodec.h:2145
int frame_number
Frame counter, set by libavcodec.
Definition: avcodec.h:2536
atomic_int debug_threads
Set if the FF_DEBUG_THREADS option is set.
static void release_delayed_buffers(PerThreadContext *p)
Releases the buffers that this decoding thread was the last user of.
#define atomic_init(obj, value)
Definition: stdatomic.h:33
#define av_freep(p)
int hwaccel_flags
Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated decoding (if active)...
Definition: avcodec.h:3659
int debug_mv
debug motion vectors
Definition: avcodec.h:3529
int next_finished
The next context to return output from.
int(* init)(AVCodecContext *)
Definition: avcodec.h:3789
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:248
AVPixelFormat
Pixel format.
Definition: pixfmt.h:60
This structure stores compressed data.
Definition: avcodec.h:1638
int delay
Codec delay.
Definition: avcodec.h:1913
int ff_frame_thread_init(AVCodecContext *avctx)
enum AVPixelFormat sw_pix_fmt
Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:3449
void * opaque
Private data of the user, can be used to carry app specific stuff.
Definition: avcodec.h:1800
Set when the thread is awaiting a packet.
Definition: pthread_frame.c:50
static uint8_t tmp[11]
Definition: aes_ctr.c:26