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 "hwconfig.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
 111     atomic_int debug_threads;       ///< Set if the FF_DEBUG_THREADS option is set.
 112 } PerThreadContext;
 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      */
 126     pthread_mutex_t hwaccel_mutex;
 127     pthread_mutex_t async_mutex;
 128     pthread_cond_t async_cond;
 129     int async_lock;
 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                                     */
 138 } FrameThreadContext;
 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 {
 145     pthread_mutex_lock(&fctx->async_mutex);
 146     while (fctx->async_lock)
 147         pthread_cond_wait(&fctx->async_cond, &fctx->async_mutex);
 148     fctx->async_lock = 1;
 149     pthread_mutex_unlock(&fctx->async_mutex);
 150 }
 151
 152 static void async_unlock(FrameThreadContext *fctx)
 153 {
 154     pthread_mutex_lock(&fctx->async_mutex);
 155     av_assert0(fctx->async_lock);
 156     fctx->async_lock = 0;
 157     pthread_cond_broadcast(&fctx->async_cond);
 158     pthread_mutex_unlock(&fctx->async_mutex);
 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  */
 168 static attribute_align_arg void *frame_worker_thread(void *arg)
 169 {
 170     PerThreadContext *p = arg;
 171     AVCodecContext *avctx = p->avctx;
 172     const AVCodec *codec = avctx->codec;
 173
 174     pthread_mutex_lock(&p->mutex);
 175     while (1) {
 176         while (atomic_load(&p->state) == STATE_INPUT_READY && !p->die)
 177             pthread_cond_wait(&p->input_cond, &p->mutex);
 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. */
 190         av_assert0(!p->hwaccel_serializing);
 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) {
 195             pthread_mutex_lock(&p->parent->hwaccel_mutex);
 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->codec->caps_internal & FF_CODEC_CAP_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;
 215             pthread_mutex_unlock(&p->parent->hwaccel_mutex);
 216         }
 217
 218         if (p->async_serializing) {
 219             p->async_serializing = 0;
 220
 221             async_unlock(p->parent);
 222         }
 223
 224         pthread_mutex_lock(&p->progress_mutex);
 225
 226         atomic_store(&p->state, STATE_INPUT_READY);
 227
 228         pthread_cond_broadcast(&p->progress_cond);
 229         pthread_cond_signal(&p->output_cond);
 230         pthread_mutex_unlock(&p->progress_mutex);
 231     }
 232     pthread_mutex_unlock(&p->mutex);
 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  */
 245 static int update_context_from_thread(AVCodecContext *dst, AVCodecContext *src, int for_user)
 246 {
 247     int err = 0;
 248
 249     if (dst != src && (for_user || src->codec->update_thread_context)) {
 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
 263         dst->bits_per_coded_sample = src->bits_per_coded_sample;
 264         dst->sample_aspect_ratio   = src->sample_aspect_ratio;
 265
 266         dst->profile = src->profile;
 267         dst->level   = src->level;
 268
 269         dst->bits_per_raw_sample = src->bits_per_raw_sample;
 270         dst->ticks_per_frame     = src->ticks_per_frame;
 271         dst->color_primaries     = src->color_primaries;
 272
 273         dst->color_trc   = src->color_trc;
 274         dst->colorspace  = src->colorspace;
 275         dst->color_range = src->color_range;
 276         dst->chroma_sample_location = src->chroma_sample_location;
 277
 278         dst->hwaccel = src->hwaccel;
 279         dst->hwaccel_context = src->hwaccel_context;
 280
 281         dst->channels       = src->channels;
 282         dst->sample_rate    = src->sample_rate;
 283         dst->sample_fmt     = src->sample_fmt;
 284         dst->channel_layout = src->channel_layout;
 285         dst->internal->hwaccel_priv_data = src->internal->hwaccel_priv_data;
 286
 287         if (!!dst->hw_frames_ctx != !!src->hw_frames_ctx ||
 288             (dst->hw_frames_ctx && dst->hw_frames_ctx->data != src->hw_frames_ctx->data)) {
 289             av_buffer_unref(&dst->hw_frames_ctx);
 290
 291             if (src->hw_frames_ctx) {
 292                 dst->hw_frames_ctx = av_buffer_ref(src->hw_frames_ctx);
 293                 if (!dst->hw_frames_ctx)
 294                     return AVERROR(ENOMEM);
 295             }
 296         }
 297
 298         dst->hwaccel_flags = src->hwaccel_flags;
 299
 300         if (!!dst->internal->pool != !!src->internal->pool ||
 301             (dst->internal->pool && dst->internal->pool->data != src->internal->pool->data)) {
 302             av_buffer_unref(&dst->internal->pool);
 303
 304             if (src->internal->pool) {
 305                 dst->internal->pool = av_buffer_ref(src->internal->pool);
 306                 if (!dst->internal->pool)
 307                     return AVERROR(ENOMEM);
 308             }
 309         }
 310     }
 311
 312     if (for_user) {
 313 #if FF_API_CODED_FRAME
 314 FF_DISABLE_DEPRECATION_WARNINGS
 315         dst->coded_frame = src->coded_frame;
 316 FF_ENABLE_DEPRECATION_WARNINGS
 317 #endif
 318     } else {
 319         if (dst->codec->update_thread_context)
 320             err = dst->codec->update_thread_context(dst, src);
 321     }
 322
 323     return err;
 324 }
 325
 326 /**
 327  * Update the next thread's AVCodecContext with values set by the user.
 328  *
 329  * @param dst The destination context.
 330  * @param src The source context.
 331  * @return 0 on success, negative error code on failure
 332  */
 333 static int update_context_from_user(AVCodecContext *dst, AVCodecContext *src)
 334 {
 335     dst->flags          = src->flags;
 336
 337     dst->draw_horiz_band= src->draw_horiz_band;
 338     dst->get_buffer2    = src->get_buffer2;
 339
 340     dst->opaque   = src->opaque;
 341     dst->debug    = src->debug;
 342     dst->debug_mv = src->debug_mv;
 343
 344     dst->slice_flags = src->slice_flags;
 345     dst->flags2      = src->flags2;
 346     dst->export_side_data = src->export_side_data;
 347
 348     dst->skip_loop_filter = src->skip_loop_filter;
 349     dst->skip_idct        = src->skip_idct;
 350     dst->skip_frame       = src->skip_frame;
 351
 352     dst->frame_number     = src->frame_number;
 353     dst->reordered_opaque = src->reordered_opaque;
 354     dst->thread_safe_callbacks = src->thread_safe_callbacks;
 355
 356     if (src->slice_count && src->slice_offset) {
 357         if (dst->slice_count < src->slice_count) {
 358             int err = av_reallocp_array(&dst->slice_offset, src->slice_count,
 359                                         sizeof(*dst->slice_offset));
 360             if (err < 0)
 361                 return err;
 362         }
 363         memcpy(dst->slice_offset, src->slice_offset,
 364                src->slice_count * sizeof(*dst->slice_offset));
 365     }
 366     dst->slice_count = src->slice_count;
 367     return 0;
 368 }
 369
 370 /// Releases the buffers that this decoding thread was the last user of.
 371 static void release_delayed_buffers(PerThreadContext *p)
 372 {
 373     FrameThreadContext *fctx = p->parent;
 374
 375     while (p->num_released_buffers > 0) {
 376         AVFrame *f;
 377
 378         pthread_mutex_lock(&fctx->buffer_mutex);
 379
 380         // fix extended data in case the caller screwed it up
 381         av_assert0(p->avctx->codec_type == AVMEDIA_TYPE_VIDEO ||
 382                    p->avctx->codec_type == AVMEDIA_TYPE_AUDIO);
 383         f = p->released_buffers[--p->num_released_buffers];
 384         f->extended_data = f->data;
 385         av_frame_unref(f);
 386
 387         pthread_mutex_unlock(&fctx->buffer_mutex);
 388     }
 389 }
 390
 391 static int submit_packet(PerThreadContext *p, AVCodecContext *user_avctx,
 392                          AVPacket *avpkt)
 393 {
 394     FrameThreadContext *fctx = p->parent;
 395     PerThreadContext *prev_thread = fctx->prev_thread;
 396     const AVCodec *codec = p->avctx->codec;
 397     int ret;
 398
 399     if (!avpkt->size && !(codec->capabilities & AV_CODEC_CAP_DELAY))
 400         return 0;
 401
 402     pthread_mutex_lock(&p->mutex);
 403
 404     ret = update_context_from_user(p->avctx, user_avctx);
 405     if (ret) {
 406         pthread_mutex_unlock(&p->mutex);
 407         return ret;
 408     }
 409     atomic_store_explicit(&p->debug_threads,
 410                           (p->avctx->debug & FF_DEBUG_THREADS) != 0,
 411                           memory_order_relaxed);
 412
 413     release_delayed_buffers(p);
 414
 415     if (prev_thread) {
 416         int err;
 417         if (atomic_load(&prev_thread->state) == STATE_SETTING_UP) {
 418             pthread_mutex_lock(&prev_thread->progress_mutex);
 419             while (atomic_load(&prev_thread->state) == STATE_SETTING_UP)
 420                 pthread_cond_wait(&prev_thread->progress_cond, &prev_thread->progress_mutex);
 421             pthread_mutex_unlock(&prev_thread->progress_mutex);
 422         }
 423
 424         err = update_context_from_thread(p->avctx, prev_thread->avctx, 0);
 425         if (err) {
 426             pthread_mutex_unlock(&p->mutex);
 427             return err;
 428         }
 429     }
 430
 431     av_packet_unref(&p->avpkt);
 432     ret = av_packet_ref(&p->avpkt, avpkt);
 433     if (ret < 0) {
 434         pthread_mutex_unlock(&p->mutex);
 435         av_log(p->avctx, AV_LOG_ERROR, "av_packet_ref() failed in submit_packet()\n");
 436         return ret;
 437     }
 438
 439     atomic_store(&p->state, STATE_SETTING_UP);
 440     pthread_cond_signal(&p->input_cond);
 441     pthread_mutex_unlock(&p->mutex);
 442
 443     /*
 444      * If the client doesn't have a thread-safe get_buffer(),
 445      * then decoding threads call back to the main thread,
 446      * and it calls back to the client here.
 447      */
 448
 449     if (!p->avctx->thread_safe_callbacks && (
 450          p->avctx->get_format != avcodec_default_get_format ||
 451          p->avctx->get_buffer2 != avcodec_default_get_buffer2)) {
 452         while (atomic_load(&p->state) != STATE_SETUP_FINISHED && atomic_load(&p->state) != STATE_INPUT_READY) {
 453             int call_done = 1;
 454             pthread_mutex_lock(&p->progress_mutex);
 455             while (atomic_load(&p->state) == STATE_SETTING_UP)
 456                 pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
 457
 458             switch (atomic_load_explicit(&p->state, memory_order_acquire)) {
 459             case STATE_GET_BUFFER:
 460                 p->result = ff_get_buffer(p->avctx, p->requested_frame, p->requested_flags);
 461                 break;
 462             case STATE_GET_FORMAT:
 463                 p->result_format = ff_get_format(p->avctx, p->available_formats);
 464                 break;
 465             default:
 466                 call_done = 0;
 467                 break;
 468             }
 469             if (call_done) {
 470                 atomic_store(&p->state, STATE_SETTING_UP);
 471                 pthread_cond_signal(&p->progress_cond);
 472             }
 473             pthread_mutex_unlock(&p->progress_mutex);
 474         }
 475     }
 476
 477     fctx->prev_thread = p;
 478     fctx->next_decoding++;
 479
 480     return 0;
 481 }
 482
 483 int ff_thread_decode_frame(AVCodecContext *avctx,
 484                            AVFrame *picture, int *got_picture_ptr,
 485                            AVPacket *avpkt)
 486 {
 487     FrameThreadContext *fctx = avctx->internal->thread_ctx;
 488     int finished = fctx->next_finished;
 489     PerThreadContext *p;
 490     int err;
 491
 492     /* release the async lock, permitting blocked hwaccel threads to
 493      * go forward while we are in this function */
 494     async_unlock(fctx);
 495
 496     /*
 497      * Submit a packet to the next decoding thread.
 498      */
 499
 500     p = &fctx->threads[fctx->next_decoding];
 501     err = submit_packet(p, avctx, avpkt);
 502     if (err)
 503         goto finish;
 504
 505     /*
 506      * If we're still receiving the initial packets, don't return a frame.
 507      */
 508
 509     if (fctx->next_decoding > (avctx->thread_count-1-(avctx->codec_id == AV_CODEC_ID_FFV1)))
 510         fctx->delaying = 0;
 511
 512     if (fctx->delaying) {
 513         *got_picture_ptr=0;
 514         if (avpkt->size) {
 515             err = avpkt->size;
 516             goto finish;
 517         }
 518     }
 519
 520     /*
 521      * Return the next available frame from the oldest thread.
 522      * If we're at the end of the stream, then we have to skip threads that
 523      * didn't output a frame/error, because we don't want to accidentally signal
 524      * EOF (avpkt->size == 0 && *got_picture_ptr == 0 && err >= 0).
 525      */
 526
 527     do {
 528         p = &fctx->threads[finished++];
 529
 530         if (atomic_load(&p->state) != STATE_INPUT_READY) {
 531             pthread_mutex_lock(&p->progress_mutex);
 532             while (atomic_load_explicit(&p->state, memory_order_relaxed) != STATE_INPUT_READY)
 533                 pthread_cond_wait(&p->output_cond, &p->progress_mutex);
 534             pthread_mutex_unlock(&p->progress_mutex);
 535         }
 536
 537         av_frame_move_ref(picture, p->frame);
 538         *got_picture_ptr = p->got_frame;
 539         picture->pkt_dts = p->avpkt.dts;
 540         err = p->result;
 541
 542         /*
 543          * A later call with avkpt->size == 0 may loop over all threads,
 544          * including this one, searching for a frame/error to return before being
 545          * stopped by the "finished != fctx->next_finished" condition.
 546          * Make sure we don't mistakenly return the same frame/error again.
 547          */
 548         p->got_frame = 0;
 549         p->result = 0;
 550
 551         if (finished >= avctx->thread_count) finished = 0;
 552     } while (!avpkt->size && !*got_picture_ptr && err >= 0 && finished != fctx->next_finished);
 553
 554     update_context_from_thread(avctx, p->avctx, 1);
 555
 556     if (fctx->next_decoding >= avctx->thread_count) fctx->next_decoding = 0;
 557
 558     fctx->next_finished = finished;
 559
 560     /* return the size of the consumed packet if no error occurred */
 561     if (err >= 0)
 562         err = avpkt->size;
 563 finish:
 564     async_lock(fctx);
 565     return err;
 566 }
 567
 568 void ff_thread_report_progress(ThreadFrame *f, int n, int field)
 569 {
 570     PerThreadContext *p;
 571     atomic_int *progress = f->progress ? (atomic_int*)f->progress->data : NULL;
 572
 573     if (!progress ||
 574         atomic_load_explicit(&progress[field], memory_order_relaxed) >= n)
 575         return;
 576
 577     p = f->owner[field]->internal->thread_ctx;
 578
 579     if (atomic_load_explicit(&p->debug_threads, memory_order_relaxed))
 580         av_log(f->owner[field], AV_LOG_DEBUG,
 581                "%p finished %d field %d\n", progress, n, field);
 582
 583     pthread_mutex_lock(&p->progress_mutex);
 584
 585     atomic_store_explicit(&progress[field], n, memory_order_release);
 586
 587     pthread_cond_broadcast(&p->progress_cond);
 588     pthread_mutex_unlock(&p->progress_mutex);
 589 }
 590
 591 void ff_thread_await_progress(ThreadFrame *f, int n, int field)
 592 {
 593     PerThreadContext *p;
 594     atomic_int *progress = f->progress ? (atomic_int*)f->progress->data : NULL;
 595
 596     if (!progress ||
 597         atomic_load_explicit(&progress[field], memory_order_acquire) >= n)
 598         return;
 599
 600     p = f->owner[field]->internal->thread_ctx;
 601
 602     if (atomic_load_explicit(&p->debug_threads, memory_order_relaxed))
 603         av_log(f->owner[field], AV_LOG_DEBUG,
 604                "thread awaiting %d field %d from %p\n", n, field, progress);
 605
 606     pthread_mutex_lock(&p->progress_mutex);
 607     while (atomic_load_explicit(&progress[field], memory_order_relaxed) < n)
 608         pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
 609     pthread_mutex_unlock(&p->progress_mutex);
 610 }
 611
 612 void ff_thread_finish_setup(AVCodecContext *avctx) {
 613     PerThreadContext *p = avctx->internal->thread_ctx;
 614
 615     if (!(avctx->active_thread_type&FF_THREAD_FRAME)) return;
 616
 617     if (avctx->hwaccel && !p->hwaccel_serializing) {
 618         pthread_mutex_lock(&p->parent->hwaccel_mutex);
 619         p->hwaccel_serializing = 1;
 620     }
 621
 622     /* this assumes that no hwaccel calls happen before ff_thread_finish_setup() */
 623     if (avctx->hwaccel &&
 624         !(avctx->hwaccel->caps_internal & HWACCEL_CAP_ASYNC_SAFE)) {
 625         p->async_serializing = 1;
 626
 627         async_lock(p->parent);
 628     }
 629
 630     pthread_mutex_lock(&p->progress_mutex);
 631     if(atomic_load(&p->state) == STATE_SETUP_FINISHED){
 632         av_log(avctx, AV_LOG_WARNING, "Multiple ff_thread_finish_setup() calls\n");
 633     }
 634
 635     atomic_store(&p->state, STATE_SETUP_FINISHED);
 636
 637     pthread_cond_broadcast(&p->progress_cond);
 638     pthread_mutex_unlock(&p->progress_mutex);
 639 }
 640
 641 /// Waits for all threads to finish.
 642 static void park_frame_worker_threads(FrameThreadContext *fctx, int thread_count)
 643 {
 644     int i;
 645
 646     async_unlock(fctx);
 647
 648     for (i = 0; i < thread_count; i++) {
 649         PerThreadContext *p = &fctx->threads[i];
 650
 651         if (atomic_load(&p->state) != STATE_INPUT_READY) {
 652             pthread_mutex_lock(&p->progress_mutex);
 653             while (atomic_load(&p->state) != STATE_INPUT_READY)
 654                 pthread_cond_wait(&p->output_cond, &p->progress_mutex);
 655             pthread_mutex_unlock(&p->progress_mutex);
 656         }
 657         p->got_frame = 0;
 658     }
 659
 660     async_lock(fctx);
 661 }
 662
 663 void ff_frame_thread_free(AVCodecContext *avctx, int thread_count)
 664 {
 665     FrameThreadContext *fctx = avctx->internal->thread_ctx;
 666     const AVCodec *codec = avctx->codec;
 667     int i, j;
 668
 669     park_frame_worker_threads(fctx, thread_count);
 670
 671     if (fctx->prev_thread && avctx->internal->hwaccel_priv_data !=
 672                              fctx->prev_thread->avctx->internal->hwaccel_priv_data) {
 673         if (update_context_from_thread(avctx, fctx->prev_thread->avctx, 1) < 0) {
 674             av_log(avctx, AV_LOG_ERROR, "Failed to update user thread.\n");
 675         }
 676     }
 677
 678     if (fctx->prev_thread && fctx->prev_thread != fctx->threads)
 679         if (update_context_from_thread(fctx->threads->avctx, fctx->prev_thread->avctx, 0) < 0) {
 680             av_log(avctx, AV_LOG_ERROR, "Final thread update failed\n");
 681             fctx->prev_thread->avctx->internal->is_copy = fctx->threads->avctx->internal->is_copy;
 682             fctx->threads->avctx->internal->is_copy = 1;
 683         }
 684
 685     for (i = 0; i < thread_count; i++) {
 686         PerThreadContext *p = &fctx->threads[i];
 687
 688         pthread_mutex_lock(&p->mutex);
 689         p->die = 1;
 690         pthread_cond_signal(&p->input_cond);
 691         pthread_mutex_unlock(&p->mutex);
 692
 693         if (p->thread_init)
 694             pthread_join(p->thread, NULL);
 695         p->thread_init=0;
 696
 697         if (codec->close && p->avctx)
 698             codec->close(p->avctx);
 699
 700         release_delayed_buffers(p);
 701         av_frame_free(&p->frame);
 702     }
 703
 704     for (i = 0; i < thread_count; i++) {
 705         PerThreadContext *p = &fctx->threads[i];
 706
 707         pthread_mutex_destroy(&p->mutex);
 708         pthread_mutex_destroy(&p->progress_mutex);
 709         pthread_cond_destroy(&p->input_cond);
 710         pthread_cond_destroy(&p->progress_cond);
 711         pthread_cond_destroy(&p->output_cond);
 712         av_packet_unref(&p->avpkt);
 713
 714         for (j = 0; j < p->released_buffers_allocated; j++)
 715             av_frame_free(&p->released_buffers[j]);
 716         av_freep(&p->released_buffers);
 717
 718         if (p->avctx) {
 719             if (codec->priv_class)
 720                 av_opt_free(p->avctx->priv_data);
 721             av_freep(&p->avctx->priv_data);
 722
 723             av_freep(&p->avctx->slice_offset);
 724         }
 725
 726         if (p->avctx) {
 727             av_buffer_unref(&p->avctx->internal->pool);
 728             av_freep(&p->avctx->internal);
 729             av_buffer_unref(&p->avctx->hw_frames_ctx);
 730         }
 731
 732         av_freep(&p->avctx);
 733     }
 734
 735     av_freep(&fctx->threads);
 736     pthread_mutex_destroy(&fctx->buffer_mutex);
 737     pthread_mutex_destroy(&fctx->hwaccel_mutex);
 738     pthread_mutex_destroy(&fctx->async_mutex);
 739     pthread_cond_destroy(&fctx->async_cond);
 740
 741     av_freep(&avctx->internal->thread_ctx);
 742
 743     if (avctx->priv_data && avctx->codec && avctx->codec->priv_class)
 744         av_opt_free(avctx->priv_data);
 745     avctx->codec = NULL;
 746 }
 747
 748 int ff_frame_thread_init(AVCodecContext *avctx)
 749 {
 750     int thread_count = avctx->thread_count;
 751     const AVCodec *codec = avctx->codec;
 752     AVCodecContext *src = avctx;
 753     FrameThreadContext *fctx;
 754     int i, err = 0;
 755
 756     if (!thread_count) {
 757         int nb_cpus = av_cpu_count();
 758 #if FF_API_DEBUG_MV
 759         if ((avctx->debug & (FF_DEBUG_VIS_QP | FF_DEBUG_VIS_MB_TYPE)) || avctx->debug_mv)
 760             nb_cpus = 1;
 761 #endif
 762         // use number of cores + 1 as thread count if there is more than one
 763         if (nb_cpus > 1)
 764             thread_count = avctx->thread_count = FFMIN(nb_cpus + 1, MAX_AUTO_THREADS);
 765         else
 766             thread_count = avctx->thread_count = 1;
 767     }
 768
 769     if (thread_count <= 1) {
 770         avctx->active_thread_type = 0;
 771         return 0;
 772     }
 773
 774     avctx->internal->thread_ctx = fctx = av_mallocz(sizeof(FrameThreadContext));
 775     if (!fctx)
 776         return AVERROR(ENOMEM);
 777
 778     fctx->threads = av_mallocz_array(thread_count, sizeof(PerThreadContext));
 779     if (!fctx->threads) {
 780         av_freep(&avctx->internal->thread_ctx);
 781         return AVERROR(ENOMEM);
 782     }
 783
 784     pthread_mutex_init(&fctx->buffer_mutex, NULL);
 785     pthread_mutex_init(&fctx->hwaccel_mutex, NULL);
 786     pthread_mutex_init(&fctx->async_mutex, NULL);
 787     pthread_cond_init(&fctx->async_cond, NULL);
 788
 789     fctx->async_lock = 1;
 790     fctx->delaying = 1;
 791
 792     if (codec->type == AVMEDIA_TYPE_VIDEO)
 793         avctx->delay = src->thread_count - 1;
 794
 795     for (i = 0; i < thread_count; i++) {
 796         AVCodecContext *copy = av_malloc(sizeof(AVCodecContext));
 797         PerThreadContext *p  = &fctx->threads[i];
 798
 799         pthread_mutex_init(&p->mutex, NULL);
 800         pthread_mutex_init(&p->progress_mutex, NULL);
 801         pthread_cond_init(&p->input_cond, NULL);
 802         pthread_cond_init(&p->progress_cond, NULL);
 803         pthread_cond_init(&p->output_cond, NULL);
 804
 805         p->frame = av_frame_alloc();
 806         if (!p->frame) {
 807             av_freep(&copy);
 808             err = AVERROR(ENOMEM);
 809             goto error;
 810         }
 811
 812         p->parent = fctx;
 813         p->avctx  = copy;
 814
 815         if (!copy) {
 816             err = AVERROR(ENOMEM);
 817             goto error;
 818         }
 819
 820         *copy = *src;
 821
 822         copy->internal = av_malloc(sizeof(AVCodecInternal));
 823         if (!copy->internal) {
 824             copy->priv_data = NULL;
 825             err = AVERROR(ENOMEM);
 826             goto error;
 827         }
 828         *copy->internal = *src->internal;
 829         copy->internal->thread_ctx = p;
 830         copy->internal->last_pkt_props = &p->avpkt;
 831
 832         copy->delay = avctx->delay;
 833
 834         if (codec->priv_data_size) {
 835             copy->priv_data = av_mallocz(codec->priv_data_size);
 836             if (!copy->priv_data) {
 837                 err = AVERROR(ENOMEM);
 838                 goto error;
 839             }
 840
 841             if (codec->priv_class) {
 842                 *(const AVClass **)copy->priv_data = codec->priv_class;
 843                 err = av_opt_copy(copy->priv_data, src->priv_data);
 844                 if (err < 0)
 845                     goto error;
 846             }
 847         }
 848
 849         if (i)
 850             copy->internal->is_copy = 1;
 851
 852         if (codec->init)
 853             err = codec->init(copy);
 854
 855         if (err) goto error;
 856
 857         if (!i)
 858             update_context_from_thread(avctx, copy, 1);
 859
 860         atomic_init(&p->debug_threads, (copy->debug & FF_DEBUG_THREADS) != 0);
 861
 862         err = AVERROR(pthread_create(&p->thread, NULL, frame_worker_thread, p));
 863         p->thread_init= !err;
 864         if(!p->thread_init)
 865             goto error;
 866     }
 867
 868     return 0;
 869
 870 error:
 871     ff_frame_thread_free(avctx, i+1);
 872
 873     return err;
 874 }
 875
 876 void ff_thread_flush(AVCodecContext *avctx)
 877 {
 878     int i;
 879     FrameThreadContext *fctx = avctx->internal->thread_ctx;
 880
 881     if (!fctx) return;
 882
 883     park_frame_worker_threads(fctx, avctx->thread_count);
 884     if (fctx->prev_thread) {
 885         if (fctx->prev_thread != &fctx->threads[0])
 886             update_context_from_thread(fctx->threads[0].avctx, fctx->prev_thread->avctx, 0);
 887     }
 888
 889     fctx->next_decoding = fctx->next_finished = 0;
 890     fctx->delaying = 1;
 891     fctx->prev_thread = NULL;
 892     for (i = 0; i < avctx->thread_count; i++) {
 893         PerThreadContext *p = &fctx->threads[i];
 894         // Make sure decode flush calls with size=0 won't return old frames
 895         p->got_frame = 0;
 896         av_frame_unref(p->frame);
 897         p->result = 0;
 898
 899         release_delayed_buffers(p);
 900
 901         if (avctx->codec->flush)
 902             avctx->codec->flush(p->avctx);
 903     }
 904 }
 905
 906 int ff_thread_can_start_frame(AVCodecContext *avctx)
 907 {
 908     PerThreadContext *p = avctx->internal->thread_ctx;
 909     if ((avctx->active_thread_type&FF_THREAD_FRAME) && atomic_load(&p->state) != STATE_SETTING_UP &&
 910         (avctx->codec->update_thread_context || !THREAD_SAFE_CALLBACKS(avctx))) {
 911         return 0;
 912     }
 913     return 1;
 914 }
 915
 916 static int thread_get_buffer_internal(AVCodecContext *avctx, ThreadFrame *f, int flags)
 917 {
 918     PerThreadContext *p = avctx->internal->thread_ctx;
 919     int err;
 920
 921     f->owner[0] = f->owner[1] = avctx;
 922
 923     if (!(avctx->active_thread_type & FF_THREAD_FRAME))
 924         return ff_get_buffer(avctx, f->f, flags);
 925
 926     if (atomic_load(&p->state) != STATE_SETTING_UP &&
 927         (avctx->codec->update_thread_context || !THREAD_SAFE_CALLBACKS(avctx))) {
 928         av_log(avctx, AV_LOG_ERROR, "get_buffer() cannot be called after ff_thread_finish_setup()\n");
 929         return -1;
 930     }
 931
 932     if (avctx->codec->caps_internal & FF_CODEC_CAP_ALLOCATE_PROGRESS) {
 933         atomic_int *progress;
 934         f->progress = av_buffer_alloc(2 * sizeof(*progress));
 935         if (!f->progress) {
 936             return AVERROR(ENOMEM);
 937         }
 938         progress = (atomic_int*)f->progress->data;
 939
 940         atomic_init(&progress[0], -1);
 941         atomic_init(&progress[1], -1);
 942     }
 943
 944     pthread_mutex_lock(&p->parent->buffer_mutex);
 945     if (THREAD_SAFE_CALLBACKS(avctx)) {
 946         err = ff_get_buffer(avctx, f->f, flags);
 947     } else {
 948         pthread_mutex_lock(&p->progress_mutex);
 949         p->requested_frame = f->f;
 950         p->requested_flags = flags;
 951         atomic_store_explicit(&p->state, STATE_GET_BUFFER, memory_order_release);
 952         pthread_cond_broadcast(&p->progress_cond);
 953
 954         while (atomic_load(&p->state) != STATE_SETTING_UP)
 955             pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
 956
 957         err = p->result;
 958
 959         pthread_mutex_unlock(&p->progress_mutex);
 960
 961     }
 962     if (!THREAD_SAFE_CALLBACKS(avctx) && !avctx->codec->update_thread_context)
 963         ff_thread_finish_setup(avctx);
 964     if (err)
 965         av_buffer_unref(&f->progress);
 966
 967     pthread_mutex_unlock(&p->parent->buffer_mutex);
 968
 969     return err;
 970 }
 971
 972 enum AVPixelFormat ff_thread_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt)
 973 {
 974     enum AVPixelFormat res;
 975     PerThreadContext *p = avctx->internal->thread_ctx;
 976     if (!(avctx->active_thread_type & FF_THREAD_FRAME) || avctx->thread_safe_callbacks ||
 977         avctx->get_format == avcodec_default_get_format)
 978         return ff_get_format(avctx, fmt);
 979     if (atomic_load(&p->state) != STATE_SETTING_UP) {
 980         av_log(avctx, AV_LOG_ERROR, "get_format() cannot be called after ff_thread_finish_setup()\n");
 981         return -1;
 982     }
 983     pthread_mutex_lock(&p->progress_mutex);
 984     p->available_formats = fmt;
 985     atomic_store(&p->state, STATE_GET_FORMAT);
 986     pthread_cond_broadcast(&p->progress_cond);
 987
 988     while (atomic_load(&p->state) != STATE_SETTING_UP)
 989         pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
 990
 991     res = p->result_format;
 992
 993     pthread_mutex_unlock(&p->progress_mutex);
 994
 995     return res;
 996 }
 997
 998 int ff_thread_get_buffer(AVCodecContext *avctx, ThreadFrame *f, int flags)
 999 {
1000     int ret = thread_get_buffer_internal(avctx, f, flags);
1001     if (ret < 0)
1002         av_log(avctx, AV_LOG_ERROR, "thread_get_buffer() failed\n");
1003     return ret;
1004 }
1005
1006 void ff_thread_release_buffer(AVCodecContext *avctx, ThreadFrame *f)
1007 {
1008     PerThreadContext *p = avctx->internal->thread_ctx;
1009     FrameThreadContext *fctx;
1010     AVFrame *dst;
1011     int ret = 0;
1012     int can_direct_free = !(avctx->active_thread_type & FF_THREAD_FRAME) ||
1013                           THREAD_SAFE_CALLBACKS(avctx);
1014
1015     if (!f->f)
1016         return;
1017
1018     if (avctx->debug & FF_DEBUG_BUFFERS)
1019         av_log(avctx, AV_LOG_DEBUG, "thread_release_buffer called on pic %p\n", f);
1020
1021     av_buffer_unref(&f->progress);
1022     f->owner[0] = f->owner[1] = NULL;
1023
1024     // when the frame buffers are not allocated, just reset it to clean state
1025     if (can_direct_free || !f->f->buf[0]) {
1026         av_frame_unref(f->f);
1027         return;
1028     }
1029
1030     fctx = p->parent;
1031     pthread_mutex_lock(&fctx->buffer_mutex);
1032
1033     if (p->num_released_buffers == p->released_buffers_allocated) {
1034         AVFrame **tmp = av_realloc_array(p->released_buffers, p->released_buffers_allocated + 1,
1035                                          sizeof(*p->released_buffers));
1036         if (tmp) {
1037             tmp[p->released_buffers_allocated] = av_frame_alloc();
1038             p->released_buffers = tmp;
1039         }
1040
1041         if (!tmp || !tmp[p->released_buffers_allocated]) {
1042             ret = AVERROR(ENOMEM);
1043             goto fail;
1044         }
1045         p->released_buffers_allocated++;
1046     }
1047
1048     dst = p->released_buffers[p->num_released_buffers];
1049     av_frame_move_ref(dst, f->f);
1050
1051     p->num_released_buffers++;
1052
1053 fail:
1054     pthread_mutex_unlock(&fctx->buffer_mutex);
1055
1056     // make sure the frame is clean even if we fail to free it
1057     // this leaks, but it is better than crashing
1058     if (ret < 0) {
1059         av_log(avctx, AV_LOG_ERROR, "Could not queue a frame for freeing, this will leak\n");
1060         memset(f->f->buf, 0, sizeof(f->f->buf));
1061         if (f->f->extended_buf)
1062             memset(f->f->extended_buf, 0, f->f->nb_extended_buf * sizeof(*f->f->extended_buf));
1063         av_frame_unref(f->f);
1064     }
1065 }