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