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