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

   1 /*
   2  * Copyright (c) 2004 Roman Shaposhnik
   3  * Copyright (c) 2008 Alexander Strange (astrange@ithinksw.com)
   4  *
   5  * Many thanks to Steven M. Schultz for providing clever ideas and
   6  * to Michael Niedermayer <michaelni@gmx.at> for writing initial
   7  * implementation.
   8  *
   9  * This file is part of FFmpeg.
  10  *
  11  * FFmpeg is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public
  13  * License as published by the Free Software Foundation; either
  14  * version 2.1 of the License, or (at your option) any later version.
  15  *
  16  * FFmpeg is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with FFmpeg; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  24  */
  25
  26 /**
  27  * @file
  28  * Multithreading support functions
  29  * @see doc/multithreading.txt
  30  */
  31
  32 #include "config.h"
  33
  34 #if HAVE_SCHED_GETAFFINITY
  35 #ifndef _GNU_SOURCE
  36 # define _GNU_SOURCE
  37 #endif
  38 #include <sched.h>
  39 #endif
  40 #if HAVE_GETPROCESSAFFINITYMASK
  41 #include <windows.h>
  42 #endif
  43 #if HAVE_SYSCTL
  44 #if HAVE_SYS_PARAM_H
  45 #include <sys/param.h>
  46 #endif
  47 #include <sys/types.h>
  48 #include <sys/param.h>
  49 #include <sys/sysctl.h>
  50 #endif
  51 #if HAVE_SYSCONF
  52 #include <unistd.h>
  53 #endif
  54
  55 #include "avcodec.h"
  56 #include "internal.h"
  57 #include "thread.h"
  58 #include "libavutil/avassert.h"
  59 #include "libavutil/common.h"
  60
  61 #if HAVE_PTHREADS
  62 #include <pthread.h>
  63 #elif HAVE_W32THREADS
  64 #include "w32pthreads.h"
  65 #elif HAVE_OS2THREADS
  66 #include "os2threads.h"
  67 #endif
  68
  69 typedef int (action_func)(AVCodecContext *c, void *arg);
  70 typedef int (action_func2)(AVCodecContext *c, void *arg, int jobnr, int threadnr);
  71
  72 typedef struct ThreadContext {
  73     pthread_t *workers;
  74     action_func *func;
  75     action_func2 *func2;
  76     void *args;
  77     int *rets;
  78     int rets_count;
  79     int job_count;
  80     int job_size;
  81
  82     pthread_cond_t last_job_cond;
  83     pthread_cond_t current_job_cond;
  84     pthread_mutex_t current_job_lock;
  85     int current_job;
  86     unsigned int current_execute;
  87     int done;
  88 } ThreadContext;
  89
  90 /**
  91  * Context used by codec threads and stored in their AVCodecContext thread_opaque.
  92  */
  93 typedef struct PerThreadContext {
  94     struct FrameThreadContext *parent;
  95
  96     pthread_t      thread;
  97     int            thread_init;
  98     pthread_cond_t input_cond;      ///< Used to wait for a new packet from the main thread.
  99     pthread_cond_t progress_cond;   ///< Used by child threads to wait for progress to change.
 100     pthread_cond_t output_cond;     ///< Used by the main thread to wait for frames to finish.
 101
 102     pthread_mutex_t mutex;          ///< Mutex used to protect the contents of the PerThreadContext.
 103     pthread_mutex_t progress_mutex; ///< Mutex used to protect frame progress values and progress_cond.
 104
 105     AVCodecContext *avctx;          ///< Context used to decode packets passed to this thread.
 106
 107     AVPacket       avpkt;           ///< Input packet (for decoding) or output (for encoding).
 108     uint8_t       *buf;             ///< backup storage for packet data when the input packet is not refcounted
 109     int            allocated_buf_size; ///< Size allocated for buf
 110
 111     AVFrame frame;                  ///< Output frame (for decoding) or input (for encoding).
 112     int     got_frame;              ///< The output of got_picture_ptr from the last avcodec_decode_video() call.
 113     int     result;                 ///< The result of the last codec decode/encode() call.
 114
 115     enum {
 116         STATE_INPUT_READY,          ///< Set when the thread is awaiting a packet.
 117         STATE_SETTING_UP,           ///< Set before the codec has called ff_thread_finish_setup().
 118         STATE_GET_BUFFER,           /**<
 119                                      * Set when the codec calls get_buffer().
 120                                      * State is returned to STATE_SETTING_UP afterwards.
 121                                      */
 122         STATE_GET_FORMAT,           /**<
 123                                      * Set when the codec calls get_format().
 124                                      * State is returned to STATE_SETTING_UP afterwards.
 125                                      */
 126         STATE_SETUP_FINISHED        ///< Set after the codec has called ff_thread_finish_setup().
 127     } state;
 128
 129     /**
 130      * Array of frames passed to ff_thread_release_buffer().
 131      * Frames are released after all threads referencing them are finished.
 132      */
 133     AVFrame *released_buffers;
 134     int  num_released_buffers;
 135     int      released_buffers_allocated;
 136
 137     AVFrame *requested_frame;       ///< AVFrame the codec passed to get_buffer()
 138     int      requested_flags;       ///< flags passed to get_buffer() for requested_frame
 139
 140     const enum AVPixelFormat *available_formats; ///< Format array for get_format()
 141     enum AVPixelFormat result_format;            ///< get_format() result
 142 } PerThreadContext;
 143
 144 /**
 145  * Context stored in the client AVCodecContext thread_opaque.
 146  */
 147 typedef struct FrameThreadContext {
 148     PerThreadContext *threads;     ///< The contexts for each thread.
 149     PerThreadContext *prev_thread; ///< The last thread submit_packet() was called on.
 150
 151     pthread_mutex_t buffer_mutex;  ///< Mutex used to protect get/release_buffer().
 152
 153     int next_decoding;             ///< The next context to submit a packet to.
 154     int next_finished;             ///< The next context to return output from.
 155
 156     int delaying;                  /**<
 157                                     * Set for the first N packets, where N is the number of threads.
 158                                     * While it is set, ff_thread_en/decode_frame won't return any results.
 159                                     */
 160
 161     int die;                       ///< Set when threads should exit.
 162 } FrameThreadContext;
 163
 164
 165 /* H264 slice threading seems to be buggy with more than 16 threads,
 166  * limit the number of threads to 16 for automatic detection */
 167 #define MAX_AUTO_THREADS 16
 168
 169 int ff_get_logical_cpus(AVCodecContext *avctx)
 170 {
 171     int ret, nb_cpus = 1;
 172 #if HAVE_SCHED_GETAFFINITY && defined(CPU_COUNT)
 173     cpu_set_t cpuset;
 174
 175     CPU_ZERO(&cpuset);
 176
 177     ret = sched_getaffinity(0, sizeof(cpuset), &cpuset);
 178     if (!ret) {
 179         nb_cpus = CPU_COUNT(&cpuset);
 180     }
 181 #elif HAVE_GETPROCESSAFFINITYMASK
 182     DWORD_PTR proc_aff, sys_aff;
 183     ret = GetProcessAffinityMask(GetCurrentProcess(), &proc_aff, &sys_aff);
 184     if (ret)
 185         nb_cpus = av_popcount64(proc_aff);
 186 #elif HAVE_SYSCTL && defined(HW_NCPU)
 187     int mib[2] = { CTL_HW, HW_NCPU };
 188     size_t len = sizeof(nb_cpus);
 189
 190     ret = sysctl(mib, 2, &nb_cpus, &len, NULL, 0);
 191     if (ret == -1)
 192         nb_cpus = 0;
 193 #elif HAVE_SYSCONF && defined(_SC_NPROC_ONLN)
 194     nb_cpus = sysconf(_SC_NPROC_ONLN);
 195 #elif HAVE_SYSCONF && defined(_SC_NPROCESSORS_ONLN)
 196     nb_cpus = sysconf(_SC_NPROCESSORS_ONLN);
 197 #endif
 198     av_log(avctx, AV_LOG_DEBUG, "detected %d logical cores\n", nb_cpus);
 199
 200     if  (avctx->height)
 201         nb_cpus = FFMIN(nb_cpus, (avctx->height+15)/16);
 202
 203     return nb_cpus;
 204 }
 205
 206
 207 static void* attribute_align_arg worker(void *v)
 208 {
 209     AVCodecContext *avctx = v;
 210     ThreadContext *c = avctx->thread_opaque;
 211     int our_job = c->job_count;
 212     int last_execute = 0;
 213     int thread_count = avctx->thread_count;
 214     int self_id;
 215
 216     pthread_mutex_lock(&c->current_job_lock);
 217     self_id = c->current_job++;
 218     for (;;){
 219         while (our_job >= c->job_count) {
 220             if (c->current_job == thread_count + c->job_count)
 221                 pthread_cond_signal(&c->last_job_cond);
 222
 223             while (last_execute == c->current_execute && !c->done)
 224                 pthread_cond_wait(&c->current_job_cond, &c->current_job_lock);
 225             last_execute = c->current_execute;
 226             our_job = self_id;
 227
 228             if (c->done) {
 229                 pthread_mutex_unlock(&c->current_job_lock);
 230                 return NULL;
 231             }
 232         }
 233         pthread_mutex_unlock(&c->current_job_lock);
 234
 235         c->rets[our_job%c->rets_count] = c->func ? c->func(avctx, (char*)c->args + our_job*c->job_size):
 236                                                    c->func2(avctx, c->args, our_job, self_id);
 237
 238         pthread_mutex_lock(&c->current_job_lock);
 239         our_job = c->current_job++;
 240     }
 241 }
 242
 243 static av_always_inline void avcodec_thread_park_workers(ThreadContext *c, int thread_count)
 244 {
 245     while (c->current_job != thread_count + c->job_count)
 246         pthread_cond_wait(&c->last_job_cond, &c->current_job_lock);
 247     pthread_mutex_unlock(&c->current_job_lock);
 248 }
 249
 250 static void thread_free(AVCodecContext *avctx)
 251 {
 252     ThreadContext *c = avctx->thread_opaque;
 253     int i;
 254
 255     pthread_mutex_lock(&c->current_job_lock);
 256     c->done = 1;
 257     pthread_cond_broadcast(&c->current_job_cond);
 258     pthread_mutex_unlock(&c->current_job_lock);
 259
 260     for (i=0; i<avctx->thread_count; i++)
 261          pthread_join(c->workers[i], NULL);
 262
 263     pthread_mutex_destroy(&c->current_job_lock);
 264     pthread_cond_destroy(&c->current_job_cond);
 265     pthread_cond_destroy(&c->last_job_cond);
 266     av_free(c->workers);
 267     av_freep(&avctx->thread_opaque);
 268 }
 269
 270 static int avcodec_thread_execute(AVCodecContext *avctx, action_func* func, void *arg, int *ret, int job_count, int job_size)
 271 {
 272     ThreadContext *c= avctx->thread_opaque;
 273     int dummy_ret;
 274
 275     if (!(avctx->active_thread_type&FF_THREAD_SLICE) || avctx->thread_count <= 1)
 276         return avcodec_default_execute(avctx, func, arg, ret, job_count, job_size);
 277
 278     if (job_count <= 0)
 279         return 0;
 280
 281     pthread_mutex_lock(&c->current_job_lock);
 282
 283     c->current_job = avctx->thread_count;
 284     c->job_count = job_count;
 285     c->job_size = job_size;
 286     c->args = arg;
 287     c->func = func;
 288     if (ret) {
 289         c->rets = ret;
 290         c->rets_count = job_count;
 291     } else {
 292         c->rets = &dummy_ret;
 293         c->rets_count = 1;
 294     }
 295     c->current_execute++;
 296     pthread_cond_broadcast(&c->current_job_cond);
 297
 298     avcodec_thread_park_workers(c, avctx->thread_count);
 299
 300     return 0;
 301 }
 302
 303 static int avcodec_thread_execute2(AVCodecContext *avctx, action_func2* func2, void *arg, int *ret, int job_count)
 304 {
 305     ThreadContext *c= avctx->thread_opaque;
 306     c->func2 = func2;
 307     return avcodec_thread_execute(avctx, NULL, arg, ret, job_count, 0);
 308 }
 309
 310 static int thread_init(AVCodecContext *avctx)
 311 {
 312     int i;
 313     ThreadContext *c;
 314     int thread_count = avctx->thread_count;
 315
 316     if (!thread_count) {
 317         int nb_cpus = ff_get_logical_cpus(avctx);
 318         // use number of cores + 1 as thread count if there is more than one
 319         if (nb_cpus > 1)
 320             thread_count = avctx->thread_count = FFMIN(nb_cpus + 1, MAX_AUTO_THREADS);
 321         else
 322             thread_count = avctx->thread_count = 1;
 323     }
 324
 325     if (thread_count <= 1) {
 326         avctx->active_thread_type = 0;
 327         return 0;
 328     }
 329
 330     c = av_mallocz(sizeof(ThreadContext));
 331     if (!c)
 332         return -1;
 333
 334     c->workers = av_mallocz(sizeof(pthread_t)*thread_count);
 335     if (!c->workers) {
 336         av_free(c);
 337         return -1;
 338     }
 339
 340     avctx->thread_opaque = c;
 341     c->current_job = 0;
 342     c->job_count = 0;
 343     c->job_size = 0;
 344     c->done = 0;
 345     pthread_cond_init(&c->current_job_cond, NULL);
 346     pthread_cond_init(&c->last_job_cond, NULL);
 347     pthread_mutex_init(&c->current_job_lock, NULL);
 348     pthread_mutex_lock(&c->current_job_lock);
 349     for (i=0; i<thread_count; i++) {
 350         if(pthread_create(&c->workers[i], NULL, worker, avctx)) {
 351            avctx->thread_count = i;
 352            pthread_mutex_unlock(&c->current_job_lock);
 353            ff_thread_free(avctx);
 354            return -1;
 355         }
 356     }
 357
 358     avcodec_thread_park_workers(c, thread_count);
 359
 360     avctx->execute = avcodec_thread_execute;
 361     avctx->execute2 = avcodec_thread_execute2;
 362     return 0;
 363 }
 364
 365 #define THREAD_SAFE_CALLBACKS(avctx) \
 366 ((avctx)->thread_safe_callbacks || (!(avctx)->get_buffer && (avctx)->get_buffer2 == avcodec_default_get_buffer2))
 367
 368 /**
 369  * Codec worker thread.
 370  *
 371  * Automatically calls ff_thread_finish_setup() if the codec does
 372  * not provide an update_thread_context method, or if the codec returns
 373  * before calling it.
 374  */
 375 static attribute_align_arg void *frame_worker_thread(void *arg)
 376 {
 377     PerThreadContext *p = arg;
 378     FrameThreadContext *fctx = p->parent;
 379     AVCodecContext *avctx = p->avctx;
 380     const AVCodec *codec = avctx->codec;
 381
 382     pthread_mutex_lock(&p->mutex);
 383     while (1) {
 384             while (p->state == STATE_INPUT_READY && !fctx->die)
 385                 pthread_cond_wait(&p->input_cond, &p->mutex);
 386
 387         if (fctx->die) break;
 388
 389         if (!codec->update_thread_context && THREAD_SAFE_CALLBACKS(avctx))
 390             ff_thread_finish_setup(avctx);
 391
 392         avcodec_get_frame_defaults(&p->frame);
 393         p->got_frame = 0;
 394         p->result = codec->decode(avctx, &p->frame, &p->got_frame, &p->avpkt);
 395
 396         /* many decoders assign whole AVFrames, thus overwriting extended_data;
 397          * make sure it's set correctly */
 398         p->frame.extended_data = p->frame.data;
 399
 400         if (p->state == STATE_SETTING_UP) ff_thread_finish_setup(avctx);
 401
 402         pthread_mutex_lock(&p->progress_mutex);
 403 #if 0 //BUFREF-FIXME
 404         for (i = 0; i < MAX_BUFFERS; i++)
 405             if (p->progress_used[i] && (p->got_frame || p->result<0 || avctx->codec_id != AV_CODEC_ID_H264)) {
 406                 p->progress[i][0] = INT_MAX;
 407                 p->progress[i][1] = INT_MAX;
 408             }
 409 #endif
 410         p->state = STATE_INPUT_READY;
 411
 412         pthread_cond_broadcast(&p->progress_cond);
 413         pthread_cond_signal(&p->output_cond);
 414         pthread_mutex_unlock(&p->progress_mutex);
 415     }
 416     pthread_mutex_unlock(&p->mutex);
 417
 418     return NULL;
 419 }
 420
 421 /**
 422  * Update the next thread's AVCodecContext with values from the reference thread's context.
 423  *
 424  * @param dst The destination context.
 425  * @param src The source context.
 426  * @param for_user 0 if the destination is a codec thread, 1 if the destination is the user's thread
 427  */
 428 static int update_context_from_thread(AVCodecContext *dst, AVCodecContext *src, int for_user)
 429 {
 430     int err = 0;
 431
 432     if (dst != src) {
 433         dst->time_base = src->time_base;
 434         dst->width     = src->width;
 435         dst->height    = src->height;
 436         dst->pix_fmt   = src->pix_fmt;
 437
 438         dst->coded_width  = src->coded_width;
 439         dst->coded_height = src->coded_height;
 440
 441         dst->has_b_frames = src->has_b_frames;
 442         dst->idct_algo    = src->idct_algo;
 443
 444         dst->bits_per_coded_sample = src->bits_per_coded_sample;
 445         dst->sample_aspect_ratio   = src->sample_aspect_ratio;
 446         dst->dtg_active_format     = src->dtg_active_format;
 447
 448         dst->profile = src->profile;
 449         dst->level   = src->level;
 450
 451         dst->bits_per_raw_sample = src->bits_per_raw_sample;
 452         dst->ticks_per_frame     = src->ticks_per_frame;
 453         dst->color_primaries     = src->color_primaries;
 454
 455         dst->color_trc   = src->color_trc;
 456         dst->colorspace  = src->colorspace;
 457         dst->color_range = src->color_range;
 458         dst->chroma_sample_location = src->chroma_sample_location;
 459
 460         dst->hwaccel = src->hwaccel;
 461         dst->hwaccel_context = src->hwaccel_context;
 462     }
 463
 464     if (for_user) {
 465         dst->delay       = src->thread_count - 1;
 466         dst->coded_frame = src->coded_frame;
 467     } else {
 468         if (dst->codec->update_thread_context)
 469             err = dst->codec->update_thread_context(dst, src);
 470     }
 471
 472     return err;
 473 }
 474
 475 /**
 476  * Update the next thread's AVCodecContext with values set by the user.
 477  *
 478  * @param dst The destination context.
 479  * @param src The source context.
 480  * @return 0 on success, negative error code on failure
 481  */
 482 static int update_context_from_user(AVCodecContext *dst, AVCodecContext *src)
 483 {
 484 #define copy_fields(s, e) memcpy(&dst->s, &src->s, (char*)&dst->e - (char*)&dst->s);
 485     dst->flags          = src->flags;
 486
 487     dst->draw_horiz_band= src->draw_horiz_band;
 488     dst->get_buffer2    = src->get_buffer2;
 489 #if FF_API_GET_BUFFER
 490     dst->get_buffer     = src->get_buffer;
 491     dst->release_buffer = src->release_buffer;
 492 #endif
 493
 494     dst->opaque   = src->opaque;
 495     dst->debug    = src->debug;
 496     dst->debug_mv = src->debug_mv;
 497
 498     dst->slice_flags = src->slice_flags;
 499     dst->flags2      = src->flags2;
 500
 501     copy_fields(skip_loop_filter, subtitle_header);
 502
 503     dst->frame_number     = src->frame_number;
 504     dst->reordered_opaque = src->reordered_opaque;
 505     dst->thread_safe_callbacks = src->thread_safe_callbacks;
 506
 507     if (src->slice_count && src->slice_offset) {
 508         if (dst->slice_count < src->slice_count) {
 509             int *tmp = av_realloc(dst->slice_offset, src->slice_count *
 510                                   sizeof(*dst->slice_offset));
 511             if (!tmp) {
 512                 av_free(dst->slice_offset);
 513                 return AVERROR(ENOMEM);
 514             }
 515             dst->slice_offset = tmp;
 516         }
 517         memcpy(dst->slice_offset, src->slice_offset,
 518                src->slice_count * sizeof(*dst->slice_offset));
 519     }
 520     dst->slice_count = src->slice_count;
 521     return 0;
 522 #undef copy_fields
 523 }
 524
 525 /// Releases the buffers that this decoding thread was the last user of.
 526 static void release_delayed_buffers(PerThreadContext *p)
 527 {
 528     FrameThreadContext *fctx = p->parent;
 529
 530     while (p->num_released_buffers > 0) {
 531         AVFrame *f;
 532
 533         pthread_mutex_lock(&fctx->buffer_mutex);
 534
 535         // fix extended data in case the caller screwed it up
 536         av_assert0(p->avctx->codec_type == AVMEDIA_TYPE_VIDEO);
 537         f = &p->released_buffers[--p->num_released_buffers];
 538         f->extended_data = f->data;
 539         av_frame_unref(f);
 540
 541         pthread_mutex_unlock(&fctx->buffer_mutex);
 542     }
 543 }
 544
 545 static int submit_packet(PerThreadContext *p, AVPacket *avpkt)
 546 {
 547     FrameThreadContext *fctx = p->parent;
 548     PerThreadContext *prev_thread = fctx->prev_thread;
 549     const AVCodec *codec = p->avctx->codec;
 550
 551     if (!avpkt->size && !(codec->capabilities & CODEC_CAP_DELAY)) return 0;
 552
 553     pthread_mutex_lock(&p->mutex);
 554
 555     release_delayed_buffers(p);
 556
 557     if (prev_thread) {
 558         int err;
 559         if (prev_thread->state == STATE_SETTING_UP) {
 560             pthread_mutex_lock(&prev_thread->progress_mutex);
 561             while (prev_thread->state == STATE_SETTING_UP)
 562                 pthread_cond_wait(&prev_thread->progress_cond, &prev_thread->progress_mutex);
 563             pthread_mutex_unlock(&prev_thread->progress_mutex);
 564         }
 565
 566         err = update_context_from_thread(p->avctx, prev_thread->avctx, 0);
 567         if (err) {
 568             pthread_mutex_unlock(&p->mutex);
 569             return err;
 570         }
 571     }
 572
 573     av_buffer_unref(&p->avpkt.buf);
 574     p->avpkt = *avpkt;
 575     if (avpkt->buf)
 576         p->avpkt.buf = av_buffer_ref(avpkt->buf);
 577     else {
 578         av_fast_malloc(&p->buf, &p->allocated_buf_size, avpkt->size + FF_INPUT_BUFFER_PADDING_SIZE);
 579         p->avpkt.data = p->buf;
 580         memcpy(p->buf, avpkt->data, avpkt->size);
 581         memset(p->buf + avpkt->size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
 582     }
 583
 584     p->state = STATE_SETTING_UP;
 585     pthread_cond_signal(&p->input_cond);
 586     pthread_mutex_unlock(&p->mutex);
 587
 588     /*
 589      * If the client doesn't have a thread-safe get_buffer(),
 590      * then decoding threads call back to the main thread,
 591      * and it calls back to the client here.
 592      */
 593
 594     if (!p->avctx->thread_safe_callbacks && (
 595          p->avctx->get_format != avcodec_default_get_format ||
 596 #if FF_API_GET_BUFFER
 597          p->avctx->get_buffer ||
 598 #endif
 599          p->avctx->get_buffer2 != avcodec_default_get_buffer2)) {
 600         while (p->state != STATE_SETUP_FINISHED && p->state != STATE_INPUT_READY) {
 601             int call_done = 1;
 602             pthread_mutex_lock(&p->progress_mutex);
 603             while (p->state == STATE_SETTING_UP)
 604                 pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
 605
 606             switch (p->state) {
 607             case STATE_GET_BUFFER:
 608                 p->result = ff_get_buffer(p->avctx, p->requested_frame, p->requested_flags);
 609                 break;
 610             case STATE_GET_FORMAT:
 611                 p->result_format = p->avctx->get_format(p->avctx, p->available_formats);
 612                 break;
 613             default:
 614                 call_done = 0;
 615                 break;
 616             }
 617             if (call_done) {
 618                 p->state  = STATE_SETTING_UP;
 619                 pthread_cond_signal(&p->progress_cond);
 620             }
 621             pthread_mutex_unlock(&p->progress_mutex);
 622         }
 623     }
 624
 625     fctx->prev_thread = p;
 626     fctx->next_decoding++;
 627
 628     return 0;
 629 }
 630
 631 int ff_thread_decode_frame(AVCodecContext *avctx,
 632                            AVFrame *picture, int *got_picture_ptr,
 633                            AVPacket *avpkt)
 634 {
 635     FrameThreadContext *fctx = avctx->thread_opaque;
 636     int finished = fctx->next_finished;
 637     PerThreadContext *p;
 638     int err;
 639
 640     /*
 641      * Submit a packet to the next decoding thread.
 642      */
 643
 644     p = &fctx->threads[fctx->next_decoding];
 645     err = update_context_from_user(p->avctx, avctx);
 646     if (err) return err;
 647     err = submit_packet(p, avpkt);
 648     if (err) return err;
 649
 650     /*
 651      * If we're still receiving the initial packets, don't return a frame.
 652      */
 653
 654     if (fctx->next_decoding > (avctx->thread_count-1-(avctx->codec_id == AV_CODEC_ID_FFV1)))
 655         fctx->delaying = 0;
 656
 657     if (fctx->delaying) {
 658         *got_picture_ptr=0;
 659         if (avpkt->size)
 660             return avpkt->size;
 661     }
 662
 663     /*
 664      * Return the next available frame from the oldest thread.
 665      * If we're at the end of the stream, then we have to skip threads that
 666      * didn't output a frame, because we don't want to accidentally signal
 667      * EOF (avpkt->size == 0 && *got_picture_ptr == 0).
 668      */
 669
 670     do {
 671         p = &fctx->threads[finished++];
 672
 673         if (p->state != STATE_INPUT_READY) {
 674             pthread_mutex_lock(&p->progress_mutex);
 675             while (p->state != STATE_INPUT_READY)
 676                 pthread_cond_wait(&p->output_cond, &p->progress_mutex);
 677             pthread_mutex_unlock(&p->progress_mutex);
 678         }
 679
 680         av_frame_move_ref(picture, &p->frame);
 681         *got_picture_ptr = p->got_frame;
 682         picture->pkt_dts = p->avpkt.dts;
 683
 684         /*
 685          * A later call with avkpt->size == 0 may loop over all threads,
 686          * including this one, searching for a frame to return before being
 687          * stopped by the "finished != fctx->next_finished" condition.
 688          * Make sure we don't mistakenly return the same frame again.
 689          */
 690         p->got_frame = 0;
 691
 692         if (finished >= avctx->thread_count) finished = 0;
 693     } while (!avpkt->size && !*got_picture_ptr && finished != fctx->next_finished);
 694
 695     update_context_from_thread(avctx, p->avctx, 1);
 696
 697     if (fctx->next_decoding >= avctx->thread_count) fctx->next_decoding = 0;
 698
 699     fctx->next_finished = finished;
 700
 701     /* return the size of the consumed packet if no error occurred */
 702     return (p->result >= 0) ? avpkt->size : p->result;
 703 }
 704
 705 void ff_thread_report_progress(ThreadFrame *f, int n, int field)
 706 {
 707     PerThreadContext *p;
 708     volatile int *progress = f->progress ? (int*)f->progress->data : NULL;
 709
 710     if (!progress || progress[field] >= n) return;
 711
 712     p = f->owner->thread_opaque;
 713
 714     if (f->owner->debug&FF_DEBUG_THREADS)
 715         av_log(f->owner, AV_LOG_DEBUG, "%p finished %d field %d\n", progress, n, field);
 716
 717     pthread_mutex_lock(&p->progress_mutex);
 718     progress[field] = n;
 719     pthread_cond_broadcast(&p->progress_cond);
 720     pthread_mutex_unlock(&p->progress_mutex);
 721 }
 722
 723 void ff_thread_await_progress(ThreadFrame *f, int n, int field)
 724 {
 725     PerThreadContext *p;
 726     volatile int *progress = f->progress ? (int*)f->progress->data : NULL;
 727
 728     if (!progress || progress[field] >= n) return;
 729
 730     p = f->owner->thread_opaque;
 731
 732     if (f->owner->debug&FF_DEBUG_THREADS)
 733         av_log(f->owner, AV_LOG_DEBUG, "thread awaiting %d field %d from %p\n", n, field, progress);
 734
 735     pthread_mutex_lock(&p->progress_mutex);
 736     while (progress[field] < n)
 737         pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
 738     pthread_mutex_unlock(&p->progress_mutex);
 739 }
 740
 741 void ff_thread_finish_setup(AVCodecContext *avctx) {
 742     PerThreadContext *p = avctx->thread_opaque;
 743
 744     if (!(avctx->active_thread_type&FF_THREAD_FRAME)) return;
 745
 746     if(p->state == STATE_SETUP_FINISHED){
 747         av_log(avctx, AV_LOG_WARNING, "Multiple ff_thread_finish_setup() calls\n");
 748     }
 749
 750     pthread_mutex_lock(&p->progress_mutex);
 751     p->state = STATE_SETUP_FINISHED;
 752     pthread_cond_broadcast(&p->progress_cond);
 753     pthread_mutex_unlock(&p->progress_mutex);
 754 }
 755
 756 /// Waits for all threads to finish.
 757 static void park_frame_worker_threads(FrameThreadContext *fctx, int thread_count)
 758 {
 759     int i;
 760
 761     for (i = 0; i < thread_count; i++) {
 762         PerThreadContext *p = &fctx->threads[i];
 763
 764         if (p->state != STATE_INPUT_READY) {
 765             pthread_mutex_lock(&p->progress_mutex);
 766             while (p->state != STATE_INPUT_READY)
 767                 pthread_cond_wait(&p->output_cond, &p->progress_mutex);
 768             pthread_mutex_unlock(&p->progress_mutex);
 769         }
 770         p->got_frame = 0;
 771     }
 772 }
 773
 774 static void frame_thread_free(AVCodecContext *avctx, int thread_count)
 775 {
 776     FrameThreadContext *fctx = avctx->thread_opaque;
 777     const AVCodec *codec = avctx->codec;
 778     int i;
 779
 780     park_frame_worker_threads(fctx, thread_count);
 781
 782     if (fctx->prev_thread && fctx->prev_thread != fctx->threads)
 783         if (update_context_from_thread(fctx->threads->avctx, fctx->prev_thread->avctx, 0) < 0) {
 784             av_log(avctx, AV_LOG_ERROR, "Final thread update failed\n");
 785             fctx->prev_thread->avctx->internal->is_copy = fctx->threads->avctx->internal->is_copy;
 786             fctx->threads->avctx->internal->is_copy = 1;
 787         }
 788
 789     fctx->die = 1;
 790
 791     for (i = 0; i < thread_count; i++) {
 792         PerThreadContext *p = &fctx->threads[i];
 793
 794         pthread_mutex_lock(&p->mutex);
 795         pthread_cond_signal(&p->input_cond);
 796         pthread_mutex_unlock(&p->mutex);
 797
 798         if (p->thread_init)
 799             pthread_join(p->thread, NULL);
 800         p->thread_init=0;
 801
 802         if (codec->close)
 803             codec->close(p->avctx);
 804
 805         avctx->codec = NULL;
 806
 807         release_delayed_buffers(p);
 808         av_frame_unref(&p->frame);
 809     }
 810
 811     for (i = 0; i < thread_count; i++) {
 812         PerThreadContext *p = &fctx->threads[i];
 813
 814         pthread_mutex_destroy(&p->mutex);
 815         pthread_mutex_destroy(&p->progress_mutex);
 816         pthread_cond_destroy(&p->input_cond);
 817         pthread_cond_destroy(&p->progress_cond);
 818         pthread_cond_destroy(&p->output_cond);
 819         av_buffer_unref(&p->avpkt.buf);
 820         av_freep(&p->buf);
 821         av_freep(&p->released_buffers);
 822
 823         if (i) {
 824             av_freep(&p->avctx->priv_data);
 825             av_freep(&p->avctx->internal);
 826             av_freep(&p->avctx->slice_offset);
 827         }
 828
 829         av_freep(&p->avctx);
 830     }
 831
 832     av_freep(&fctx->threads);
 833     pthread_mutex_destroy(&fctx->buffer_mutex);
 834     av_freep(&avctx->thread_opaque);
 835 }
 836
 837 static int frame_thread_init(AVCodecContext *avctx)
 838 {
 839     int thread_count = avctx->thread_count;
 840     const AVCodec *codec = avctx->codec;
 841     AVCodecContext *src = avctx;
 842     FrameThreadContext *fctx;
 843     int i, err = 0;
 844
 845     if (!thread_count) {
 846         int nb_cpus = ff_get_logical_cpus(avctx);
 847         if ((avctx->debug & (FF_DEBUG_VIS_QP | FF_DEBUG_VIS_MB_TYPE)) || avctx->debug_mv)
 848             nb_cpus = 1;
 849         // use number of cores + 1 as thread count if there is more than one
 850         if (nb_cpus > 1)
 851             thread_count = avctx->thread_count = FFMIN(nb_cpus + 1, MAX_AUTO_THREADS);
 852         else
 853             thread_count = avctx->thread_count = 1;
 854     }
 855
 856     if (thread_count <= 1) {
 857         avctx->active_thread_type = 0;
 858         return 0;
 859     }
 860
 861     avctx->thread_opaque = fctx = av_mallocz(sizeof(FrameThreadContext));
 862
 863     fctx->threads = av_mallocz(sizeof(PerThreadContext) * thread_count);
 864     pthread_mutex_init(&fctx->buffer_mutex, NULL);
 865     fctx->delaying = 1;
 866
 867     for (i = 0; i < thread_count; i++) {
 868         AVCodecContext *copy = av_malloc(sizeof(AVCodecContext));
 869         PerThreadContext *p  = &fctx->threads[i];
 870
 871         pthread_mutex_init(&p->mutex, NULL);
 872         pthread_mutex_init(&p->progress_mutex, NULL);
 873         pthread_cond_init(&p->input_cond, NULL);
 874         pthread_cond_init(&p->progress_cond, NULL);
 875         pthread_cond_init(&p->output_cond, NULL);
 876
 877         p->parent = fctx;
 878         p->avctx  = copy;
 879
 880         if (!copy) {
 881             err = AVERROR(ENOMEM);
 882             goto error;
 883         }
 884
 885         *copy = *src;
 886         copy->thread_opaque = p;
 887         copy->pkt = &p->avpkt;
 888
 889         if (!i) {
 890             src = copy;
 891
 892             if (codec->init)
 893                 err = codec->init(copy);
 894
 895             update_context_from_thread(avctx, copy, 1);
 896         } else {
 897             copy->priv_data = av_malloc(codec->priv_data_size);
 898             if (!copy->priv_data) {
 899                 err = AVERROR(ENOMEM);
 900                 goto error;
 901             }
 902             memcpy(copy->priv_data, src->priv_data, codec->priv_data_size);
 903             copy->internal = av_malloc(sizeof(AVCodecInternal));
 904             if (!copy->internal) {
 905                 err = AVERROR(ENOMEM);
 906                 goto error;
 907             }
 908             *copy->internal = *src->internal;
 909             copy->internal->is_copy = 1;
 910
 911             if (codec->init_thread_copy)
 912                 err = codec->init_thread_copy(copy);
 913         }
 914
 915         if (err) goto error;
 916
 917         err = AVERROR(pthread_create(&p->thread, NULL, frame_worker_thread, p));
 918         p->thread_init= !err;
 919         if(!p->thread_init)
 920             goto error;
 921     }
 922
 923     return 0;
 924
 925 error:
 926     frame_thread_free(avctx, i+1);
 927
 928     return err;
 929 }
 930
 931 void ff_thread_flush(AVCodecContext *avctx)
 932 {
 933     int i;
 934     FrameThreadContext *fctx = avctx->thread_opaque;
 935
 936     if (!avctx->thread_opaque) return;
 937
 938     park_frame_worker_threads(fctx, avctx->thread_count);
 939     if (fctx->prev_thread) {
 940         if (fctx->prev_thread != &fctx->threads[0])
 941             update_context_from_thread(fctx->threads[0].avctx, fctx->prev_thread->avctx, 0);
 942         if (avctx->codec->flush)
 943             avctx->codec->flush(fctx->threads[0].avctx);
 944     }
 945
 946     fctx->next_decoding = fctx->next_finished = 0;
 947     fctx->delaying = 1;
 948     fctx->prev_thread = NULL;
 949     for (i = 0; i < avctx->thread_count; i++) {
 950         PerThreadContext *p = &fctx->threads[i];
 951         // Make sure decode flush calls with size=0 won't return old frames
 952         p->got_frame = 0;
 953         av_frame_unref(&p->frame);
 954
 955         release_delayed_buffers(p);
 956     }
 957 }
 958
 959 int ff_thread_can_start_frame(AVCodecContext *avctx)
 960 {
 961     PerThreadContext *p = avctx->thread_opaque;
 962     if ((avctx->active_thread_type&FF_THREAD_FRAME) && p->state != STATE_SETTING_UP &&
 963         (avctx->codec->update_thread_context || !THREAD_SAFE_CALLBACKS(avctx))) {
 964         return 0;
 965     }
 966     return 1;
 967 }
 968
 969 static int thread_get_buffer_internal(AVCodecContext *avctx, ThreadFrame *f, int flags)
 970 {
 971     PerThreadContext *p = avctx->thread_opaque;
 972     int err;
 973
 974     f->owner = avctx;
 975
 976     ff_init_buffer_info(avctx, f->f);
 977
 978     if (!(avctx->active_thread_type & FF_THREAD_FRAME))
 979         return ff_get_buffer(avctx, f->f, flags);
 980
 981     if (p->state != STATE_SETTING_UP &&
 982         (avctx->codec->update_thread_context || !THREAD_SAFE_CALLBACKS(avctx))) {
 983         av_log(avctx, AV_LOG_ERROR, "get_buffer() cannot be called after ff_thread_finish_setup()\n");
 984         return -1;
 985     }
 986
 987     if (avctx->internal->allocate_progress) {
 988         int *progress;
 989         f->progress = av_buffer_alloc(2 * sizeof(int));
 990         if (!f->progress) {
 991             return AVERROR(ENOMEM);
 992         }
 993         progress = (int*)f->progress->data;
 994
 995         progress[0] = progress[1] = -1;
 996     }
 997
 998     pthread_mutex_lock(&p->parent->buffer_mutex);
 999
1000     if (avctx->thread_safe_callbacks || (
1001 #if FF_API_GET_BUFFER
1002         !avctx->get_buffer &&
1003 #endif
1004         avctx->get_buffer2 == avcodec_default_get_buffer2)) {
1005         err = ff_get_buffer(avctx, f->f, flags);
1006     } else {
1007         pthread_mutex_lock(&p->progress_mutex);
1008         p->requested_frame = f->f;
1009         p->requested_flags = flags;
1010         p->state = STATE_GET_BUFFER;
1011         pthread_cond_broadcast(&p->progress_cond);
1012
1013         while (p->state != STATE_SETTING_UP)
1014             pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
1015
1016         err = p->result;
1017
1018         pthread_mutex_unlock(&p->progress_mutex);
1019
1020     }
1021     if (!THREAD_SAFE_CALLBACKS(avctx) && !avctx->codec->update_thread_context)
1022         ff_thread_finish_setup(avctx);
1023
1024     if (err)
1025         av_buffer_unref(&f->progress);
1026
1027     pthread_mutex_unlock(&p->parent->buffer_mutex);
1028
1029     return err;
1030 }
1031
1032 enum AVPixelFormat ff_thread_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt)
1033 {
1034     enum AVPixelFormat res;
1035     PerThreadContext *p = avctx->thread_opaque;
1036     if (!(avctx->active_thread_type & FF_THREAD_FRAME) || avctx->thread_safe_callbacks ||
1037         avctx->get_format == avcodec_default_get_format)
1038         return avctx->get_format(avctx, fmt);
1039     if (p->state != STATE_SETTING_UP) {
1040         av_log(avctx, AV_LOG_ERROR, "get_format() cannot be called after ff_thread_finish_setup()\n");
1041         return -1;
1042     }
1043     pthread_mutex_lock(&p->progress_mutex);
1044     p->available_formats = fmt;
1045     p->state = STATE_GET_FORMAT;
1046     pthread_cond_broadcast(&p->progress_cond);
1047
1048     while (p->state != STATE_SETTING_UP)
1049         pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
1050
1051     res = p->result_format;
1052
1053     pthread_mutex_unlock(&p->progress_mutex);
1054
1055     return res;
1056 }
1057
1058 int ff_thread_get_buffer(AVCodecContext *avctx, ThreadFrame *f, int flags)
1059 {
1060     int ret = thread_get_buffer_internal(avctx, f, flags);
1061     if (ret < 0)
1062         av_log(avctx, AV_LOG_ERROR, "thread_get_buffer() failed\n");
1063     return ret;
1064 }
1065
1066 void ff_thread_release_buffer(AVCodecContext *avctx, ThreadFrame *f)
1067 {
1068     PerThreadContext *p = avctx->thread_opaque;
1069     FrameThreadContext *fctx;
1070     AVFrame *dst, *tmp;
1071     int can_direct_free = !(avctx->active_thread_type & FF_THREAD_FRAME) ||
1072                           avctx->thread_safe_callbacks                   ||
1073                           (
1074 #if FF_API_GET_BUFFER
1075                            !avctx->get_buffer &&
1076 #endif
1077                            avctx->get_buffer2 == avcodec_default_get_buffer2);
1078
1079     if (!f->f->data[0])
1080         return;
1081
1082     if (avctx->debug & FF_DEBUG_BUFFERS)
1083         av_log(avctx, AV_LOG_DEBUG, "thread_release_buffer called on pic %p\n", f);
1084
1085     av_buffer_unref(&f->progress);
1086     f->owner    = NULL;
1087
1088     if (can_direct_free) {
1089         av_frame_unref(f->f);
1090         return;
1091     }
1092
1093     fctx = p->parent;
1094     pthread_mutex_lock(&fctx->buffer_mutex);
1095
1096     if (p->num_released_buffers + 1 >= INT_MAX / sizeof(*p->released_buffers))
1097         goto fail;
1098     tmp = av_fast_realloc(p->released_buffers, &p->released_buffers_allocated,
1099                           (p->num_released_buffers + 1) *
1100                           sizeof(*p->released_buffers));
1101     if (!tmp)
1102         goto fail;
1103     p->released_buffers = tmp;
1104
1105     dst = &p->released_buffers[p->num_released_buffers];
1106     av_frame_move_ref(dst, f->f);
1107
1108     p->num_released_buffers++;
1109
1110 fail:
1111     pthread_mutex_unlock(&fctx->buffer_mutex);
1112 }
1113
1114 /**
1115  * Set the threading algorithms used.
1116  *
1117  * Threading requires more than one thread.
1118  * Frame threading requires entire frames to be passed to the codec,
1119  * and introduces extra decoding delay, so is incompatible with low_delay.
1120  *
1121  * @param avctx The context.
1122  */
1123 static void validate_thread_parameters(AVCodecContext *avctx)
1124 {
1125     int frame_threading_supported = (avctx->codec->capabilities & CODEC_CAP_FRAME_THREADS)
1126                                 && !(avctx->flags & CODEC_FLAG_TRUNCATED)
1127                                 && !(avctx->flags & CODEC_FLAG_LOW_DELAY)
1128                                 && !(avctx->flags2 & CODEC_FLAG2_CHUNKS);
1129     if (avctx->thread_count == 1) {
1130         avctx->active_thread_type = 0;
1131     } else if (frame_threading_supported && (avctx->thread_type & FF_THREAD_FRAME)) {
1132         avctx->active_thread_type = FF_THREAD_FRAME;
1133     } else if (avctx->codec->capabilities & CODEC_CAP_SLICE_THREADS &&
1134                avctx->thread_type & FF_THREAD_SLICE) {
1135         avctx->active_thread_type = FF_THREAD_SLICE;
1136     } else if (!(avctx->codec->capabilities & CODEC_CAP_AUTO_THREADS)) {
1137         avctx->thread_count       = 1;
1138         avctx->active_thread_type = 0;
1139     }
1140
1141     if (avctx->thread_count > MAX_AUTO_THREADS)
1142         av_log(avctx, AV_LOG_WARNING,
1143                "Application has requested %d threads. Using a thread count greater than %d is not recommended.\n",
1144                avctx->thread_count, MAX_AUTO_THREADS);
1145 }
1146
1147 int ff_thread_init(AVCodecContext *avctx)
1148 {
1149 #if HAVE_W32THREADS
1150     w32thread_init();
1151 #endif
1152
1153     validate_thread_parameters(avctx);
1154
1155     if (avctx->active_thread_type&FF_THREAD_SLICE)
1156         return thread_init(avctx);
1157     else if (avctx->active_thread_type&FF_THREAD_FRAME)
1158         return frame_thread_init(avctx);
1159
1160     return 0;
1161 }
1162
1163 void ff_thread_free(AVCodecContext *avctx)
1164 {
1165     if (avctx->active_thread_type&FF_THREAD_FRAME)
1166         frame_thread_free(avctx, avctx->thread_count);
1167     else
1168         thread_free(avctx);
1169 }