FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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;
40  int64_t return_code;
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, 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 = avcodec_encode_video2(avctx, pkt, frame, &got_packet);
91  av_frame_unref(frame);
93  av_frame_free(&frame);
94  if(got_packet) {
95  int ret2 = av_dup_packet(pkt);
96  if (ret >= 0 && ret2 < 0)
97  ret = ret2;
98  } else {
99  pkt->data = NULL;
100  pkt->size = 0;
101  }
103  c->finished_tasks[task.index].outdata = pkt; pkt = NULL;
104  c->finished_tasks[task.index].return_code = ret;
107  }
108 end:
109  av_free(pkt);
111  avcodec_close(avctx);
113  av_freep(&avctx);
114  return NULL;
115 }
116 
118  int i=0;
119  ThreadContext *c;
120 
121 
122  if( !(avctx->thread_type & FF_THREAD_FRAME)
124  return 0;
125 
126  if( !avctx->thread_count
127  && avctx->codec_id == AV_CODEC_ID_MJPEG
128  && !(avctx->flags & AV_CODEC_FLAG_QSCALE)) {
129  av_log(avctx, AV_LOG_DEBUG,
130  "Forcing thread count to 1 for MJPEG encoding, use -thread_type slice "
131  "or a constant quantizer if you want to use multiple cpu cores\n");
132  avctx->thread_count = 1;
133  }
134  if( avctx->thread_count > 1
135  && avctx->codec_id == AV_CODEC_ID_MJPEG
136  && !(avctx->flags & AV_CODEC_FLAG_QSCALE))
137  av_log(avctx, AV_LOG_WARNING,
138  "MJPEG CBR encoding works badly with frame multi-threading, consider "
139  "using -threads 1, -thread_type slice or a constant quantizer.\n");
140 
141  if (avctx->codec_id == AV_CODEC_ID_HUFFYUV ||
142  avctx->codec_id == AV_CODEC_ID_FFVHUFF) {
143  int warn = 0;
144  int context_model = 0;
145  AVDictionaryEntry *con = av_dict_get(options, "context", NULL, AV_DICT_MATCH_CASE);
146 
147  if (con && con->value)
148  context_model = atoi(con->value);
149 
150  if (avctx->flags & AV_CODEC_FLAG_PASS1)
151  warn = 1;
152  else if(context_model > 0) {
153  AVDictionaryEntry *t = av_dict_get(options, "non_deterministic",
155  warn = !t || !t->value || !atoi(t->value) ? 1 : 0;
156  }
157  // huffyuv does not support these with multiple frame threads currently
158  if (warn) {
159  av_log(avctx, AV_LOG_WARNING,
160  "Forcing thread count to 1 for huffyuv encoding with first pass or context 1\n");
161  avctx->thread_count = 1;
162  }
163  }
164 
165  if(!avctx->thread_count) {
166  avctx->thread_count = av_cpu_count();
167  avctx->thread_count = FFMIN(avctx->thread_count, MAX_THREADS);
168  }
169 
170  if(avctx->thread_count <= 1)
171  return 0;
172 
173  if(avctx->thread_count > MAX_THREADS)
174  return AVERROR(EINVAL);
175 
177  c = avctx->internal->frame_thread_encoder = av_mallocz(sizeof(ThreadContext));
178  if(!c)
179  return AVERROR(ENOMEM);
180 
181  c->parent_avctx = avctx;
182 
184  if(!c->task_fifo)
185  goto fail;
186 
192  atomic_init(&c->exit, 0);
193 
194  for(i=0; i<avctx->thread_count ; i++){
195  AVDictionary *tmp = NULL;
196  int ret;
197  void *tmpv;
198  AVCodecContext *thread_avctx = avcodec_alloc_context3(avctx->codec);
199  if(!thread_avctx)
200  goto fail;
201  tmpv = thread_avctx->priv_data;
202  *thread_avctx = *avctx;
203  ret = av_opt_copy(thread_avctx, avctx);
204  if (ret < 0)
205  goto fail;
206  thread_avctx->priv_data = tmpv;
207  thread_avctx->internal = NULL;
208  if (avctx->codec->priv_class) {
209  int ret = av_opt_copy(thread_avctx->priv_data, avctx->priv_data);
210  if (ret < 0)
211  goto fail;
212  } else
213  memcpy(thread_avctx->priv_data, avctx->priv_data, avctx->codec->priv_data_size);
214  thread_avctx->thread_count = 1;
215  thread_avctx->active_thread_type &= ~FF_THREAD_FRAME;
216 
217  av_dict_copy(&tmp, options, 0);
218  av_dict_set(&tmp, "threads", "1", 0);
219  if(avcodec_open2(thread_avctx, avctx->codec, &tmp) < 0) {
220  av_dict_free(&tmp);
221  goto fail;
222  }
223  av_dict_free(&tmp);
224  av_assert0(!thread_avctx->internal->frame_thread_encoder);
225  thread_avctx->internal->frame_thread_encoder = c;
226  if(pthread_create(&c->worker[i], NULL, worker, thread_avctx)) {
227  goto fail;
228  }
229  }
230 
232 
233  return 0;
234 fail:
235  avctx->thread_count = i;
236  av_log(avctx, AV_LOG_ERROR, "ff_frame_thread_encoder_init failed\n");
238  return -1;
239 }
240 
242  int i;
244 
246  atomic_store(&c->exit, 1);
249 
250  for (i=0; i<avctx->thread_count; i++) {
251  pthread_join(c->worker[i], NULL);
252  }
253 
261 }
262 
263 int ff_thread_video_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet_ptr){
265  Task task;
266  int ret;
267 
268  av_assert1(!*got_packet_ptr);
269 
270  if(frame){
271  AVFrame *new = av_frame_alloc();
272  if(!new)
273  return AVERROR(ENOMEM);
274  ret = av_frame_ref(new, frame);
275  if(ret < 0) {
276  av_frame_free(&new);
277  return ret;
278  }
279 
280  task.index = c->task_index;
281  task.indata = (void*)new;
283  av_fifo_generic_write(c->task_fifo, &task, sizeof(task), NULL);
286 
287  c->task_index = (c->task_index+1) % BUFFER_SIZE;
288  }
289 
291  if (c->task_index == c->finished_task_index ||
292  (frame && !c->finished_tasks[c->finished_task_index].outdata &&
293  (c->task_index - c->finished_task_index) % BUFFER_SIZE <= avctx->thread_count)) {
295  return 0;
296  }
297 
298  while (!c->finished_tasks[c->finished_task_index].outdata) {
300  }
301  task = c->finished_tasks[c->finished_task_index];
302  *pkt = *(AVPacket*)(task.outdata);
303  if(pkt->data)
304  *got_packet_ptr = 1;
308 
309  return task.return_code;
310 }
#define NULL
Definition: coverity.c:32
const struct AVCodec * codec
Definition: avcodec.h:1752
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:106
unsigned finished_task_index
This structure describes decoded (raw) audio or video data.
Definition: frame.h:201
#define pthread_mutex_lock(a)
Definition: ffprobe.c:61
static av_always_inline int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex)
Definition: os2threads.h:164
#define atomic_store(object, desired)
Definition: stdatomic.h:85
int av_cpu_count(void)
Definition: cpu.c:263
misc image utilities
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
int size
Definition: avcodec.h:1662
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
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:222
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:138
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_CODEC_CAP_INTRA_ONLY
Codec is intra only.
Definition: avcodec.h:1082
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
HMTX pthread_mutex_t
Definition: os2threads.h:49
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:150
AVOptions.
static av_cold int end(AVCodecContext *avctx)
Definition: avrndec.c:90
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:395
static AVFrame * frame
Task finished_tasks[BUFFER_SIZE]
void * frame_thread_encoder
Definition: internal.h:182
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: avcodec.h:1661
static av_always_inline int pthread_cond_signal(pthread_cond_t *cond)
Definition: os2threads.h:146
const OptionDef options[]
Definition: ffserver.c:3952
#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:1153
#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:163
int active_thread_type
Which multithreading methods are in use by the codec.
Definition: avcodec.h:3193
attribute_deprecated int av_dup_packet(AVPacket *pkt)
Definition: avpacket.c:251
int capabilities
Codec capabilities.
Definition: avcodec.h:3740
#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:1838
simple assert() macros that are a bit more flexible than ISO C assert().
#define fail()
Definition: checkasm.h:109
int ff_frame_thread_encoder_init(AVCodecContext *avctx, AVDictionary *options)
#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:870
#define FF_THREAD_FRAME
Decode more than one frame at once.
Definition: avcodec.h:3185
#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
int priv_data_size
Definition: avcodec.h:3757
#define AV_CODEC_FLAG_PASS1
Use internal 2pass ratecontrol in first pass mode.
Definition: avcodec.h:886
static av_always_inline int pthread_join(pthread_t thread, void **value_ptr)
Definition: os2threads.h:88
static av_always_inline int pthread_mutex_init(pthread_mutex_t *mutex, const pthread_mutexattr_t *attr)
Definition: os2threads.h:98
pthread_mutex_t task_fifo_mutex
#define pthread_mutex_unlock(a)
Definition: ffprobe.c:65
int thread_count
thread count is used to decide how many independent tasks should be passed to execute() ...
Definition: avcodec.h:3174
#define attribute_align_arg
Definition: internal.h:61
static av_always_inline int pthread_create(pthread_t *thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
Definition: os2threads.h:74
Libavcodec external API header.
enum AVCodecID codec_id
Definition: avcodec.h:1760
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:1743
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]
attribute_deprecated int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
Encode a frame of video.
Definition: encode.c:267
int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options)
Initialize the AVCodecContext to use the given AVCodec.
Definition: utils.c:617
AVFifoBuffer * task_fifo
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:505
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: avcodec.h:3747
int64_t return_code
common internal api header.
static double c[64]
int av_opt_copy(void *dst, const void *src)
Copy options from src object into dest object.
Definition: opt.c:1702
static av_always_inline int pthread_cond_init(pthread_cond_t *cond, const pthread_condattr_t *attr)
Definition: os2threads.h:127
void av_init_packet(AVPacket *pkt)
Initialize optional fields of a packet with default values.
Definition: avpacket.c:33
void * priv_data
Definition: avcodec.h:1785
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:156
struct AVCodecInternal * internal
Private context used for internal data.
Definition: avcodec.h:1793
AVPacket * av_packet_alloc(void)
Allocate an AVPacket and set its fields to default values.
Definition: avpacket.c:51
#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: avcodec.h:1638
int thread_type
Which multithreading methods to use.
Definition: avcodec.h:3184
static uint8_t tmp[11]
Definition: aes_ctr.c:26