FFmpeg  4.3.8
frame_thread_encoder.c
Go to the documentation of this file.
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 #define BUFFER_SIZE (2*MAX_THREADS)
36 
37 typedef struct{
38  void *indata;
39  void *outdata;
41  unsigned index;
42 } Task;
43 
44 typedef struct{
47 
51 
52  Task finished_tasks[BUFFER_SIZE];
55 
56  unsigned task_index;
58 
62 
63 static void * attribute_align_arg worker(void *v){
64  AVCodecContext *avctx = v;
66  AVPacket *pkt = NULL;
67 
68  while (!atomic_load(&c->exit)) {
69  int got_packet = 0, ret;
70  AVFrame *frame;
71  Task task;
72 
73  if(!pkt) pkt = av_packet_alloc();
74  if(!pkt) continue;
75  av_init_packet(pkt);
76 
78  while (av_fifo_size(c->task_fifo) <= 0 || atomic_load(&c->exit)) {
79  if (atomic_load(&c->exit)) {
81  goto end;
82  }
84  }
85  av_fifo_generic_read(c->task_fifo, &task, sizeof(task), NULL);
87  frame = task.indata;
88 
89  ret = avctx->codec->encode2(avctx, pkt, frame, &got_packet);
90  if(got_packet) {
91  int ret2 = av_packet_make_refcounted(pkt);
92  if (ret >= 0 && ret2 < 0)
93  ret = ret2;
94  pkt->pts = pkt->dts = frame->pts;
95  } else {
96  pkt->data = NULL;
97  pkt->size = 0;
98  }
100  av_frame_unref(frame);
102  av_frame_free(&frame);
104  c->finished_tasks[task.index].outdata = pkt; pkt = NULL;
105  c->finished_tasks[task.index].return_code = ret;
108  }
109 end:
110  av_free(pkt);
112  avcodec_close(avctx);
114  av_freep(&avctx);
115  return NULL;
116 }
117 
119  int i=0;
120  ThreadContext *c;
121  AVCodecContext *thread_avctx = NULL;
122 
123  if( !(avctx->thread_type & FF_THREAD_FRAME)
125  return 0;
126 
127  if( !avctx->thread_count
128  && avctx->codec_id == AV_CODEC_ID_MJPEG
129  && !(avctx->flags & AV_CODEC_FLAG_QSCALE)) {
130  av_log(avctx, AV_LOG_DEBUG,
131  "Forcing thread count to 1 for MJPEG encoding, use -thread_type slice "
132  "or a constant quantizer if you want to use multiple cpu cores\n");
133  avctx->thread_count = 1;
134  }
135  if( avctx->thread_count > 1
136  && avctx->codec_id == AV_CODEC_ID_MJPEG
137  && !(avctx->flags & AV_CODEC_FLAG_QSCALE))
138  av_log(avctx, AV_LOG_WARNING,
139  "MJPEG CBR encoding works badly with frame multi-threading, consider "
140  "using -threads 1, -thread_type slice or a constant quantizer.\n");
141 
142  if (avctx->codec_id == AV_CODEC_ID_HUFFYUV ||
143  avctx->codec_id == AV_CODEC_ID_FFVHUFF) {
144  int warn = 0;
145  int context_model = 0;
146  AVDictionaryEntry *con = av_dict_get(options, "context", NULL, AV_DICT_MATCH_CASE);
147 
148  if (con && con->value)
149  context_model = atoi(con->value);
150 
151  if (avctx->flags & AV_CODEC_FLAG_PASS1)
152  warn = 1;
153  else if(context_model > 0) {
154  AVDictionaryEntry *t = av_dict_get(options, "non_deterministic",
156  warn = !t || !t->value || !atoi(t->value) ? 1 : 0;
157  }
158  // huffyuv does not support these with multiple frame threads currently
159  if (warn) {
160  av_log(avctx, AV_LOG_WARNING,
161  "Forcing thread count to 1 for huffyuv encoding with first pass or context 1\n");
162  avctx->thread_count = 1;
163  }
164  }
165 
166  if(!avctx->thread_count) {
167  avctx->thread_count = av_cpu_count();
168  avctx->thread_count = FFMIN(avctx->thread_count, MAX_THREADS);
169  }
170 
171  if(avctx->thread_count <= 1)
172  return 0;
173 
174  if(avctx->thread_count > MAX_THREADS)
175  return AVERROR(EINVAL);
176 
178  c = avctx->internal->frame_thread_encoder = av_mallocz(sizeof(ThreadContext));
179  if(!c)
180  return AVERROR(ENOMEM);
181 
182  c->parent_avctx = avctx;
183 
185  if (!c->task_fifo) {
187  return AVERROR(ENOMEM);
188  }
189 
195  atomic_init(&c->exit, 0);
196 
197  for(i=0; i<avctx->thread_count ; i++){
198  AVDictionary *tmp = NULL;
199  int ret;
200  void *tmpv;
201  thread_avctx = avcodec_alloc_context3(avctx->codec);
202  if(!thread_avctx)
203  goto fail;
204  tmpv = thread_avctx->priv_data;
205  *thread_avctx = *avctx;
206  thread_avctx->priv_data = tmpv;
207  thread_avctx->internal = NULL;
208  thread_avctx->hw_frames_ctx = NULL;
209  ret = av_opt_copy(thread_avctx, avctx);
210  if (ret < 0)
211  goto fail;
212  if (avctx->codec->priv_class) {
213  int ret = av_opt_copy(thread_avctx->priv_data, avctx->priv_data);
214  if (ret < 0)
215  goto fail;
216  } else if (avctx->codec->priv_data_size) {
217  memcpy(thread_avctx->priv_data, avctx->priv_data, avctx->codec->priv_data_size);
218  }
219  thread_avctx->thread_count = 1;
220  thread_avctx->active_thread_type &= ~FF_THREAD_FRAME;
221 
222  av_dict_copy(&tmp, options, 0);
223  av_dict_set(&tmp, "threads", "1", 0);
224  if(avcodec_open2(thread_avctx, avctx->codec, &tmp) < 0) {
225  av_dict_free(&tmp);
226  goto fail;
227  }
228  av_dict_free(&tmp);
229  av_assert0(!thread_avctx->internal->frame_thread_encoder);
230  thread_avctx->internal->frame_thread_encoder = c;
231  if(pthread_create(&c->worker[i], NULL, worker, thread_avctx)) {
232  goto fail;
233  }
234  }
235 
237 
238  return 0;
239 fail:
240  avcodec_close(thread_avctx);
241  av_freep(&thread_avctx);
242  avctx->thread_count = i;
243  av_log(avctx, AV_LOG_ERROR, "ff_frame_thread_encoder_init failed\n");
245  return -1;
246 }
247 
249  int i;
251 
253  atomic_store(&c->exit, 1);
256 
257  for (i=0; i<avctx->thread_count; i++) {
258  pthread_join(c->worker[i], NULL);
259  }
260 
261  while (av_fifo_size(c->task_fifo) > 0) {
262  Task task;
263  AVFrame *frame;
264  av_fifo_generic_read(c->task_fifo, &task, sizeof(task), NULL);
265  frame = task.indata;
266  av_frame_free(&frame);
267  task.indata = NULL;
268  }
269 
270  for (i=0; i<BUFFER_SIZE; i++) {
271  if (c->finished_tasks[i].outdata != NULL) {
273  av_packet_free(&pkt);
275  }
276  }
277 
285 }
286 
287 int ff_thread_video_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet_ptr){
289  Task task;
290  int ret;
291 
292  av_assert1(!*got_packet_ptr);
293 
294  if(frame){
295  AVFrame *new = av_frame_alloc();
296  if(!new)
297  return AVERROR(ENOMEM);
298  ret = av_frame_ref(new, frame);
299  if(ret < 0) {
300  av_frame_free(&new);
301  return ret;
302  }
303 
304  task.index = c->task_index;
305  task.indata = (void*)new;
307  av_fifo_generic_write(c->task_fifo, &task, sizeof(task), NULL);
310 
311  c->task_index = (c->task_index+1) % BUFFER_SIZE;
312  }
313 
315  if (c->task_index == c->finished_task_index ||
316  (frame && !c->finished_tasks[c->finished_task_index].outdata &&
317  (c->task_index - c->finished_task_index) % BUFFER_SIZE <= avctx->thread_count)) {
319  return 0;
320  }
321 
322  while (!c->finished_tasks[c->finished_task_index].outdata) {
324  }
325  task = c->finished_tasks[c->finished_task_index];
326  *pkt = *(AVPacket*)(task.outdata);
327  if(pkt->data)
328  *got_packet_ptr = 1;
332 
333  return task.return_code;
334 }
#define NULL
Definition: coverity.c:32
const struct AVCodec * codec
Definition: avcodec.h:535
int ff_thread_video_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet_ptr)
static av_always_inline int pthread_mutex_destroy(pthread_mutex_t *mutex)
Definition: os2threads.h:112
unsigned finished_task_index
This structure describes decoded (raw) audio or video data.
Definition: frame.h:300
#define pthread_mutex_lock(a)
Definition: ffprobe.c:62
static av_always_inline int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex)
Definition: os2threads.h:192
#define atomic_store(object, desired)
Definition: stdatomic.h:85
int av_cpu_count(void)
Definition: cpu.c:267
misc image utilities
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
int size
Definition: packet.h:356
int av_dict_copy(AVDictionary **dst, const AVDictionary *src, int flags)
Copy entries from one AVDictionary struct into another.
Definition: dict.c:217
AVCodecContext * parent_avctx
static AVPacket pkt
intptr_t atomic_int
Definition: stdatomic.h:55
static av_always_inline int pthread_cond_destroy(pthread_cond_t *cond)
Definition: os2threads.h:144
int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int(*func)(void *, void *, int))
Feed data from a user-supplied callback to an AVFifoBuffer.
Definition: fifo.c:122
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
void av_packet_free(AVPacket **pkt)
Free the packet, if the packet is reference counted, it will be unreferenced first.
Definition: avpacket.c:64
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:190
AVOptions.
static av_cold int end(AVCodecContext *avctx)
Definition: avrndec.c:92
void * indata
Multithreading support functions.
int av_frame_ref(AVFrame *dst, const AVFrame *src)
Set up a new reference to the data described by the source frame.
Definition: frame.c:444
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:393
int(* encode2)(struct AVCodecContext *avctx, struct AVPacket *avpkt, const struct AVFrame *frame, int *got_packet_ptr)
Encode data to an AVPacket.
Definition: codec.h:280
static AVFrame * frame
Task finished_tasks[BUFFER_SIZE]
void * frame_thread_encoder
Definition: internal.h:152
AVDictionaryEntry * av_dict_get(const AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags)
Get a dictionary entry with matching key.
Definition: dict.c:40
uint8_t * data
Definition: packet.h:355
static av_always_inline int pthread_cond_signal(pthread_cond_t *cond)
Definition: os2threads.h:152
#define av_log(a,...)
pthread_mutex_t buffer_mutex
int avcodec_close(AVCodecContext *avctx)
Close a given AVCodecContext and free all the data associated with it (but not the AVCodecContext its...
Definition: utils.c:1152
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
#define AV_DICT_MATCH_CASE
Only get an entry with exact-case key match.
Definition: dict.h:69
unsigned index
#define atomic_load(object)
Definition: stdatomic.h:93
#define AVERROR(e)
Definition: error.h:43
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:203
int active_thread_type
Which multithreading methods are in use by the codec.
Definition: avcodec.h:1804
int capabilities
Codec capabilities.
Definition: codec.h:209
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:197
int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void(*func)(void *, void *, int))
Feed data from an AVFifoBuffer to a user-supplied callback.
Definition: fifo.c:213
pthread_cond_t finished_task_cond
void av_dict_free(AVDictionary **pm)
Free all the memory allocated for an AVDictionary struct and all keys and values. ...
Definition: dict.c:203
int flags
AV_CODEC_FLAG_*.
Definition: avcodec.h:606
simple assert() macros that are a bit more flexible than ISO C assert().
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:237
#define fail()
Definition: checkasm.h:123
#define AV_CODEC_CAP_FRAME_THREADS
Codec supports frame-level multithreading.
Definition: codec.h:106
int ff_frame_thread_encoder_init(AVCodecContext *avctx, AVDictionary *options)
Initialize frame thread encoder.
#define MAX_THREADS
#define av_assert1(cond)
assert() equivalent, that does not lie in speed critical code.
Definition: avassert.h:53
#define AV_CODEC_FLAG_QSCALE
Use fixed qscale.
Definition: avcodec.h:275
#define FF_THREAD_FRAME
Decode more than one frame at once.
Definition: avcodec.h:1796
#define FFMIN(a, b)
Definition: common.h:96
AVCodecContext * avcodec_alloc_context3(const AVCodec *codec)
Allocate an AVCodecContext and set its fields to default values.
Definition: options.c:157
AVBufferRef * hw_frames_ctx
A reference to the AVHWFramesContext describing the input (for encoding) or output (decoding) frames...
Definition: avcodec.h:2226
int priv_data_size
Definition: codec.h:238
int av_packet_make_refcounted(AVPacket *pkt)
Ensure the data described by a given packet is reference counted.
Definition: avpacket.c:671
#define AV_CODEC_FLAG_PASS1
Use internal 2pass ratecontrol in first pass mode.
Definition: avcodec.h:296
static av_always_inline int pthread_join(pthread_t thread, void **value_ptr)
Definition: os2threads.h:94
static av_always_inline int pthread_mutex_init(pthread_mutex_t *mutex, const pthread_mutexattr_t *attr)
Definition: os2threads.h:104
pthread_mutex_t task_fifo_mutex
#define pthread_mutex_unlock(a)
Definition: ffprobe.c:66
int thread_count
thread count is used to decide how many independent tasks should be passed to execute() ...
Definition: avcodec.h:1785
#define attribute_align_arg
Definition: internal.h:62
static av_always_inline int pthread_create(pthread_t *thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
Definition: os2threads.h:80
Libavcodec external API header.
enum AVCodecID codec_id
Definition: avcodec.h:536
int av_fifo_size(const AVFifoBuffer *f)
Return the amount of data in bytes in the AVFifoBuffer, that is the amount of data you can read from ...
Definition: fifo.c:77
void * outdata
main external API structure.
Definition: avcodec.h:526
long long int64_t
Definition: coverity.c:34
a very simple circular buffer FIFO implementation
int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags)
Set the given entry in *pm, overwriting an existing entry.
Definition: dict.c:70
pthread_t worker[MAX_THREADS]
int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options)
Initialize the AVCodecContext to use the given AVCodec.
Definition: utils.c:574
AVFifoBuffer * task_fifo
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:554
AVFifoBuffer * av_fifo_alloc_array(size_t nmemb, size_t size)
Initialize an AVFifoBuffer.
Definition: fifo.c:49
const AVClass * priv_class
AVClass for the private context.
Definition: codec.h:216
const OptionDef options[]
Definition: ffmpeg_opt.c:3388
int64_t return_code
common internal api header.
_fmutex pthread_mutex_t
Definition: os2threads.h:53
static double c[64]
int av_opt_copy(void *dst, const void *src)
Copy options from src object into dest object.
Definition: opt.c:1768
static av_always_inline int pthread_cond_init(pthread_cond_t *cond, const pthread_condattr_t *attr)
Definition: os2threads.h:133
void av_init_packet(AVPacket *pkt)
Initialize optional fields of a packet with default values.
Definition: avpacket.c:35
void * priv_data
Definition: avcodec.h:553
pthread_mutex_t finished_task_mutex
#define av_free(p)
char * value
Definition: dict.h:87
#define BUFFER_SIZE
static av_always_inline int pthread_cond_broadcast(pthread_cond_t *cond)
Definition: os2threads.h:162
struct AVCodecInternal * internal
Private context used for internal data.
Definition: avcodec.h:561
AVPacket * av_packet_alloc(void)
Allocate an AVPacket and set its fields to default values.
Definition: avpacket.c:53
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed...
Definition: packet.h:354
#define atomic_init(obj, value)
Definition: stdatomic.h:33
void ff_frame_thread_encoder_free(AVCodecContext *avctx)
#define av_freep(p)
void av_fifo_freep(AVFifoBuffer **f)
Free an AVFifoBuffer and reset pointer to NULL.
Definition: fifo.c:63
static void *attribute_align_arg worker(void *v)
pthread_cond_t task_fifo_cond
This structure stores compressed data.
Definition: packet.h:332
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:348
int thread_type
Which multithreading methods to use.
Definition: avcodec.h:1795
static uint8_t tmp[11]
Definition: aes_ctr.c:26