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

   1 /*
   2  * Copyright (c) 2012 Michael Niedermayer <michaelni@gmx.at>
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #include <stdatomic.h>
  22
  23 #include "frame_thread_encoder.h"
  24
  25 #include "libavutil/fifo.h"
  26 #include "libavutil/avassert.h"
  27 #include "libavutil/imgutils.h"
  28 #include "libavutil/opt.h"
  29 #include "libavutil/thread.h"
  30 #include "avcodec.h"
  31 #include "internal.h"
  32 #include "thread.h"
  33
  34 #define MAX_THREADS 64
  35 /* There can be as many as MAX_THREADS + 1 outstanding tasks.
  36  * An additional + 1 is needed so that one can distinguish
  37  * the case of zero and MAX_THREADS + 1 outstanding tasks modulo
  38  * the number of buffers. */
  39 #define BUFFER_SIZE (MAX_THREADS + 2)
  40
  41 typedef struct{
  42     AVFrame  *indata;
  43     AVPacket *outdata;
  44     int64_t return_code;
  45     unsigned index;
  46     int       finished;
  47 } Task;
  48
  49 typedef struct{
  50     AVCodecContext *parent_avctx;
  51     pthread_mutex_t buffer_mutex;
  52
  53     AVFifoBuffer *task_fifo;
  54     pthread_mutex_t task_fifo_mutex;
  55     pthread_cond_t task_fifo_cond;
  56
  57     unsigned max_tasks;
  58     Task tasks[BUFFER_SIZE];
  59     pthread_mutex_t finished_task_mutex; /* Guards tasks[i].finished */
  60     pthread_cond_t finished_task_cond;
  61
  62     unsigned task_index;
  63     unsigned finished_task_index;
  64
  65     pthread_t worker[MAX_THREADS];
  66     atomic_int exit;
  67 } ThreadContext;
  68
  69 static void * attribute_align_arg worker(void *v){
  70     AVCodecContext *avctx = v;
  71     ThreadContext *c = avctx->internal->frame_thread_encoder;
  72
  73     while (!atomic_load(&c->exit)) {
  74         int got_packet = 0, ret;
  75         AVPacket *pkt;
  76         AVFrame *frame;
  77         Task task;
  78
  79         pthread_mutex_lock(&c->task_fifo_mutex);
  80         while (av_fifo_size(c->task_fifo) <= 0 || atomic_load(&c->exit)) {
  81             if (atomic_load(&c->exit)) {
  82                 pthread_mutex_unlock(&c->task_fifo_mutex);
  83                 goto end;
  84             }
  85             pthread_cond_wait(&c->task_fifo_cond, &c->task_fifo_mutex);
  86         }
  87         av_fifo_generic_read(c->task_fifo, &task, sizeof(task), NULL);
  88         pthread_mutex_unlock(&c->task_fifo_mutex);
  89         /* The main thread ensures that any two outstanding tasks have
  90          * different indices, ergo each worker thread owns its element
  91          * of c->tasks with the exception of finished, which is shared
  92          * with the main thread and guarded by finished_task_mutex. */
  93         frame = task.indata;
  94         pkt   = c->tasks[task.index].outdata;
  95
  96         ret = avctx->codec->encode2(avctx, pkt, frame, &got_packet);
  97         if(got_packet) {
  98             int ret2 = av_packet_make_refcounted(pkt);
  99             if (ret >= 0 && ret2 < 0)
 100                 ret = ret2;
 101             pkt->pts = pkt->dts = frame->pts;
 102         } else {
 103             pkt->data = NULL;
 104             pkt->size = 0;
 105         }
 106         pthread_mutex_lock(&c->buffer_mutex);
 107         av_frame_unref(frame);
 108         pthread_mutex_unlock(&c->buffer_mutex);
 109         av_frame_free(&frame);
 110         pthread_mutex_lock(&c->finished_task_mutex);
 111         c->tasks[task.index].return_code = ret;
 112         c->tasks[task.index].finished    = 1;
 113         pthread_cond_signal(&c->finished_task_cond);
 114         pthread_mutex_unlock(&c->finished_task_mutex);
 115     }
 116 end:
 117     pthread_mutex_lock(&c->buffer_mutex);
 118     avcodec_close(avctx);
 119     pthread_mutex_unlock(&c->buffer_mutex);
 120     av_freep(&avctx);
 121     return NULL;
 122 }
 123
 124 int ff_frame_thread_encoder_init(AVCodecContext *avctx, AVDictionary *options){
 125     int i=0;
 126     ThreadContext *c;
 127
 128
 129     if(   !(avctx->thread_type & FF_THREAD_FRAME)
 130        || !(avctx->codec->capabilities & AV_CODEC_CAP_FRAME_THREADS))
 131         return 0;
 132
 133     if(   !avctx->thread_count
 134        && avctx->codec_id == AV_CODEC_ID_MJPEG
 135        && !(avctx->flags & AV_CODEC_FLAG_QSCALE)) {
 136         av_log(avctx, AV_LOG_DEBUG,
 137                "Forcing thread count to 1 for MJPEG encoding, use -thread_type slice "
 138                "or a constant quantizer if you want to use multiple cpu cores\n");
 139         avctx->thread_count = 1;
 140     }
 141     if(   avctx->thread_count > 1
 142        && avctx->codec_id == AV_CODEC_ID_MJPEG
 143        && !(avctx->flags & AV_CODEC_FLAG_QSCALE))
 144         av_log(avctx, AV_LOG_WARNING,
 145                "MJPEG CBR encoding works badly with frame multi-threading, consider "
 146                "using -threads 1, -thread_type slice or a constant quantizer.\n");
 147
 148     if (avctx->codec_id == AV_CODEC_ID_HUFFYUV ||
 149         avctx->codec_id == AV_CODEC_ID_FFVHUFF) {
 150         int warn = 0;
 151         int context_model = 0;
 152         AVDictionaryEntry *con = av_dict_get(options, "context", NULL, AV_DICT_MATCH_CASE);
 153
 154         if (con && con->value)
 155             context_model = atoi(con->value);
 156
 157         if (avctx->flags & AV_CODEC_FLAG_PASS1)
 158             warn = 1;
 159         else if(context_model > 0) {
 160             AVDictionaryEntry *t = av_dict_get(options, "non_deterministic",
 161                                                NULL, AV_DICT_MATCH_CASE);
 162             warn = !t || !t->value || !atoi(t->value) ? 1 : 0;
 163         }
 164         // huffyuv does not support these with multiple frame threads currently
 165         if (warn) {
 166             av_log(avctx, AV_LOG_WARNING,
 167                "Forcing thread count to 1 for huffyuv encoding with first pass or context 1\n");
 168             avctx->thread_count = 1;
 169         }
 170     }
 171
 172     if(!avctx->thread_count) {
 173         avctx->thread_count = av_cpu_count();
 174         avctx->thread_count = FFMIN(avctx->thread_count, MAX_THREADS);
 175     }
 176
 177     if(avctx->thread_count <= 1)
 178         return 0;
 179
 180     if(avctx->thread_count > MAX_THREADS)
 181         return AVERROR(EINVAL);
 182
 183     av_assert0(!avctx->internal->frame_thread_encoder);
 184     c = avctx->internal->frame_thread_encoder = av_mallocz(sizeof(ThreadContext));
 185     if(!c)
 186         return AVERROR(ENOMEM);
 187
 188     c->parent_avctx = avctx;
 189
 190     c->task_fifo = av_fifo_alloc_array(BUFFER_SIZE, sizeof(Task));
 191     if (!c->task_fifo) {
 192         av_freep(&avctx->internal->frame_thread_encoder);
 193         return AVERROR(ENOMEM);
 194     }
 195
 196     pthread_mutex_init(&c->task_fifo_mutex, NULL);
 197     pthread_mutex_init(&c->finished_task_mutex, NULL);
 198     pthread_mutex_init(&c->buffer_mutex, NULL);
 199     pthread_cond_init(&c->task_fifo_cond, NULL);
 200     pthread_cond_init(&c->finished_task_cond, NULL);
 201     atomic_init(&c->exit, 0);
 202
 203     c->max_tasks = avctx->thread_count + 2;
 204     for (unsigned i = 0; i < c->max_tasks; i++) {
 205         if (!(c->tasks[i].outdata = av_packet_alloc()))
 206             goto fail;
 207     }
 208
 209     for(i=0; i<avctx->thread_count ; i++){
 210         AVDictionary *tmp = NULL;
 211         int ret;
 212         void *tmpv;
 213         AVCodecContext *thread_avctx = avcodec_alloc_context3(avctx->codec);
 214         if(!thread_avctx)
 215             goto fail;
 216         tmpv = thread_avctx->priv_data;
 217         *thread_avctx = *avctx;
 218         ret = av_opt_copy(thread_avctx, avctx);
 219         if (ret < 0)
 220             goto fail;
 221         thread_avctx->priv_data = tmpv;
 222         thread_avctx->internal = NULL;
 223         if (avctx->codec->priv_class) {
 224             int ret = av_opt_copy(thread_avctx->priv_data, avctx->priv_data);
 225             if (ret < 0)
 226                 goto fail;
 227         } else if (avctx->codec->priv_data_size) {
 228             memcpy(thread_avctx->priv_data, avctx->priv_data, avctx->codec->priv_data_size);
 229         }
 230         thread_avctx->thread_count = 1;
 231         thread_avctx->active_thread_type &= ~FF_THREAD_FRAME;
 232
 233         av_dict_copy(&tmp, options, 0);
 234         av_dict_set(&tmp, "threads", "1", 0);
 235         if(avcodec_open2(thread_avctx, avctx->codec, &tmp) < 0) {
 236             av_dict_free(&tmp);
 237             goto fail;
 238         }
 239         av_dict_free(&tmp);
 240         av_assert0(!thread_avctx->internal->frame_thread_encoder);
 241         thread_avctx->internal->frame_thread_encoder = c;
 242         if(pthread_create(&c->worker[i], NULL, worker, thread_avctx)) {
 243             goto fail;
 244         }
 245     }
 246
 247     avctx->active_thread_type = FF_THREAD_FRAME;
 248
 249     return 0;
 250 fail:
 251     avctx->thread_count = i;
 252     av_log(avctx, AV_LOG_ERROR, "ff_frame_thread_encoder_init failed\n");
 253     ff_frame_thread_encoder_free(avctx);
 254     return -1;
 255 }
 256
 257 void ff_frame_thread_encoder_free(AVCodecContext *avctx){
 258     int i;
 259     ThreadContext *c= avctx->internal->frame_thread_encoder;
 260
 261     pthread_mutex_lock(&c->task_fifo_mutex);
 262     atomic_store(&c->exit, 1);
 263     pthread_cond_broadcast(&c->task_fifo_cond);
 264     pthread_mutex_unlock(&c->task_fifo_mutex);
 265
 266     for (i=0; i<avctx->thread_count; i++) {
 267          pthread_join(c->worker[i], NULL);
 268     }
 269
 270     while (av_fifo_size(c->task_fifo) > 0) {
 271         Task task;
 272         av_fifo_generic_read(c->task_fifo, &task, sizeof(task), NULL);
 273         av_frame_free(&task.indata);
 274     }
 275
 276     for (unsigned i = 0; i < c->max_tasks; i++) {
 277         av_packet_free(&c->tasks[i].outdata);
 278     }
 279
 280     pthread_mutex_destroy(&c->task_fifo_mutex);
 281     pthread_mutex_destroy(&c->finished_task_mutex);
 282     pthread_mutex_destroy(&c->buffer_mutex);
 283     pthread_cond_destroy(&c->task_fifo_cond);
 284     pthread_cond_destroy(&c->finished_task_cond);
 285     av_fifo_freep(&c->task_fifo);
 286     av_freep(&avctx->internal->frame_thread_encoder);
 287 }
 288
 289 int ff_thread_video_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet_ptr){
 290     ThreadContext *c = avctx->internal->frame_thread_encoder;
 291     Task *outtask, task;
 292     int ret;
 293
 294     av_assert1(!*got_packet_ptr);
 295
 296     if(frame){
 297         AVFrame *new = av_frame_alloc();
 298         if(!new)
 299             return AVERROR(ENOMEM);
 300         ret = av_frame_ref(new, frame);
 301         if(ret < 0) {
 302             av_frame_free(&new);
 303             return ret;
 304         }
 305
 306         task.index = c->task_index;
 307         task.indata = (void*)new;
 308         pthread_mutex_lock(&c->task_fifo_mutex);
 309         av_fifo_generic_write(c->task_fifo, &task, sizeof(task), NULL);
 310         pthread_cond_signal(&c->task_fifo_cond);
 311         pthread_mutex_unlock(&c->task_fifo_mutex);
 312
 313         c->task_index = (c->task_index + 1) % c->max_tasks;
 314     }
 315
 316     outtask = &c->tasks[c->finished_task_index];
 317     pthread_mutex_lock(&c->finished_task_mutex);
 318     if (c->task_index == c->finished_task_index ||
 319         (frame && !outtask->finished &&
 320          (c->task_index - c->finished_task_index + c->max_tasks) % c->max_tasks <= avctx->thread_count)) {
 321             pthread_mutex_unlock(&c->finished_task_mutex);
 322             return 0;
 323         }
 324     while (!outtask->finished) {
 325         pthread_cond_wait(&c->finished_task_cond, &c->finished_task_mutex);
 326     }
 327     /* We now own outtask completely: No worker thread touches it any more,
 328      * because there is no outstanding task with this index. */
 329     outtask->finished = 0;
 330     av_packet_move_ref(pkt, outtask->outdata);
 331     if(pkt->data)
 332         *got_packet_ptr = 1;
 333     c->finished_task_index = (c->finished_task_index + 1) % c->max_tasks;
 334     pthread_mutex_unlock(&c->finished_task_mutex);
 335
 336     return outtask->return_code;
 337 }