git.sesse.net Git - ffmpeg/blob - libavcodec/pthread_frame.c

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