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