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