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