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 "frame_thread_encoder.h"
22 
23 #include "libavutil/fifo.h"
24 #include "libavutil/avassert.h"
25 #include "libavutil/imgutils.h"
26 #include "libavutil/opt.h"
27 #include "libavutil/thread.h"
28 #include "avcodec.h"
29 #include "internal.h"
30 #include "thread.h"
31 
32 #define MAX_THREADS 64
33 #define BUFFER_SIZE (2*MAX_THREADS)
34 
35 typedef struct{
36  void *indata;
37  void *outdata;
38  int64_t return_code;
39  unsigned index;
40 } Task;
41 
42 typedef struct{
45 
49 
50  Task finished_tasks[BUFFER_SIZE];
53 
54  unsigned task_index;
56 
58  int exit;
60 
61 static void * attribute_align_arg worker(void *v){
62  AVCodecContext *avctx = v;
64  AVPacket *pkt = NULL;
65 
66  while(!c->exit){
67  int got_packet, ret;
68  AVFrame *frame;
69  Task task;
70 
71  if(!pkt) pkt= av_mallocz(sizeof(*pkt));
72  if(!pkt) continue;
73  av_init_packet(pkt);
74 
76  while (av_fifo_size(c->task_fifo) <= 0 || c->exit) {
77  if(c->exit){
79  goto end;
80  }
82  }
83  av_fifo_generic_read(c->task_fifo, &task, sizeof(task), NULL);
85  frame = task.indata;
86 
87  ret = avcodec_encode_video2(avctx, pkt, frame, &got_packet);
89  av_frame_unref(frame);
91  av_frame_free(&frame);
92  if(got_packet) {
93  int ret2 = av_dup_packet(pkt);
94  if (ret >= 0 && ret2 < 0)
95  ret = ret2;
96  } else {
97  pkt->data = NULL;
98  pkt->size = 0;
99  }
101  c->finished_tasks[task.index].outdata = pkt; pkt = NULL;
102  c->finished_tasks[task.index].return_code = ret;
105  }
106 end:
107  av_free(pkt);
109  avcodec_close(avctx);
111  av_freep(&avctx);
112  return NULL;
113 }
114 
116  int i=0;
117  ThreadContext *c;
118 
119 
120  if( !(avctx->thread_type & FF_THREAD_FRAME)
122  return 0;
123 
124  if( !avctx->thread_count
125  && avctx->codec_id == AV_CODEC_ID_MJPEG
126  && !(avctx->flags & AV_CODEC_FLAG_QSCALE)) {
127  av_log(avctx, AV_LOG_DEBUG,
128  "Forcing thread count to 1 for MJPEG encoding, use -thread_type slice "
129  "or a constant quantizer if you want to use multiple cpu cores\n");
130  avctx->thread_count = 1;
131  }
132  if( avctx->thread_count > 1
133  && avctx->codec_id == AV_CODEC_ID_MJPEG
134  && !(avctx->flags & AV_CODEC_FLAG_QSCALE))
135  av_log(avctx, AV_LOG_WARNING,
136  "MJPEG CBR encoding works badly with frame multi-threading, consider "
137  "using -threads 1, -thread_type slice or a constant quantizer.\n");
138 
139  if (avctx->codec_id == AV_CODEC_ID_HUFFYUV ||
140  avctx->codec_id == AV_CODEC_ID_FFVHUFF) {
141  int warn = 0;
142  int context_model = 0;
143  AVDictionaryEntry *con = av_dict_get(options, "context", NULL, AV_DICT_MATCH_CASE);
144 
145  if (con && con->value)
146  context_model = atoi(con->value);
147 
148  if (avctx->flags & AV_CODEC_FLAG_PASS1)
149  warn = 1;
150  else if(context_model > 0) {
151  AVDictionaryEntry *t = av_dict_get(options, "non_deterministic",
153  warn = !t || !t->value || !atoi(t->value) ? 1 : 0;
154  }
155  // huffyuv does not support these with multiple frame threads currently
156  if (warn) {
157  av_log(avctx, AV_LOG_WARNING,
158  "Forcing thread count to 1 for huffyuv encoding with first pass or context 1\n");
159  avctx->thread_count = 1;
160  }
161  }
162 
163  if(!avctx->thread_count) {
164  avctx->thread_count = av_cpu_count();
165  avctx->thread_count = FFMIN(avctx->thread_count, MAX_THREADS);
166  }
167 
168  if(avctx->thread_count <= 1)
169  return 0;
170 
171  if(avctx->thread_count > MAX_THREADS)
172  return AVERROR(EINVAL);
173 
175  c = avctx->internal->frame_thread_encoder = av_mallocz(sizeof(ThreadContext));
176  if(!c)
177  return AVERROR(ENOMEM);
178 
179  c->parent_avctx = avctx;
180 
182  if(!c->task_fifo)
183  goto fail;
184 
190 
191  for(i=0; i<avctx->thread_count ; i++){
192  AVDictionary *tmp = NULL;
193  void *tmpv;
194  AVCodecContext *thread_avctx = avcodec_alloc_context3(avctx->codec);
195  if(!thread_avctx)
196  goto fail;
197  tmpv = thread_avctx->priv_data;
198  *thread_avctx = *avctx;
199  thread_avctx->priv_data = tmpv;
200  thread_avctx->internal = NULL;
201  if (avctx->codec->priv_class) {
202  int ret = av_opt_copy(thread_avctx->priv_data, avctx->priv_data);
203  if (ret < 0)
204  goto fail;
205  } else
206  memcpy(thread_avctx->priv_data, avctx->priv_data, avctx->codec->priv_data_size);
207  thread_avctx->thread_count = 1;
208  thread_avctx->active_thread_type &= ~FF_THREAD_FRAME;
209 
210  av_dict_copy(&tmp, options, 0);
211  av_dict_set(&tmp, "threads", "1", 0);
212  if(avcodec_open2(thread_avctx, avctx->codec, &tmp) < 0) {
213  av_dict_free(&tmp);
214  goto fail;
215  }
216  av_dict_free(&tmp);
217  av_assert0(!thread_avctx->internal->frame_thread_encoder);
218  thread_avctx->internal->frame_thread_encoder = c;
219  if(pthread_create(&c->worker[i], NULL, worker, thread_avctx)) {
220  goto fail;
221  }
222  }
223 
225 
226  return 0;
227 fail:
228  avctx->thread_count = i;
229  av_log(avctx, AV_LOG_ERROR, "ff_frame_thread_encoder_init failed\n");
231  return -1;
232 }
233 
235  int i;
237 
239  c->exit = 1;
242 
243  for (i=0; i<avctx->thread_count; i++) {
244  pthread_join(c->worker[i], NULL);
245  }
246 
254 }
255 
256 int ff_thread_video_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet_ptr){
258  Task task;
259  int ret;
260 
261  av_assert1(!*got_packet_ptr);
262 
263  if(frame){
264  AVFrame *new = av_frame_alloc();
265  if(!new)
266  return AVERROR(ENOMEM);
267  ret = av_frame_ref(new, frame);
268  if(ret < 0) {
269  av_frame_free(&new);
270  return ret;
271  }
272 
273  task.index = c->task_index;
274  task.indata = (void*)new;
276  av_fifo_generic_write(c->task_fifo, &task, sizeof(task), NULL);
279 
280  c->task_index = (c->task_index+1) % BUFFER_SIZE;
281  }
282 
284  if (c->task_index == c->finished_task_index ||
285  (frame && !c->finished_tasks[c->finished_task_index].outdata &&
286  (c->task_index - c->finished_task_index) % BUFFER_SIZE <= avctx->thread_count)) {
288  return 0;
289  }
290 
291  while (!c->finished_tasks[c->finished_task_index].outdata) {
293  }
294  task = c->finished_tasks[c->finished_task_index];
295  *pkt = *(AVPacket*)(task.outdata);
296  if(pkt->data)
297  *got_packet_ptr = 1;
301 
302  return task.return_code;
303 }
#define NULL
Definition: coverity.c:32
const struct AVCodec * codec
Definition: avcodec.h:1755
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
int av_cpu_count(void)
Definition: cpu.c:261
misc image utilities
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
int size
Definition: avcodec.h:1672
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
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:1094
#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:392
static AVFrame * frame
Task finished_tasks[BUFFER_SIZE]
void * frame_thread_encoder
Definition: internal.h:171
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:1671
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:1163
#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 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:3194
attribute_deprecated int av_dup_packet(AVPacket *pkt)
Definition: avpacket.c:253
int capabilities
Codec capabilities.
Definition: avcodec.h:3741
#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:1841
simple assert() macros that are a bit more flexible than ISO C assert().
#define fail()
Definition: checkasm.h:98
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:875
#define FF_THREAD_FRAME
Decode more than one frame at once.
Definition: avcodec.h:3186
#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:3758
#define AV_CODEC_FLAG_PASS1
Use internal 2pass ratecontrol in first pass mode.
Definition: avcodec.h:891
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:3175
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:1763
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:1746
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:264
int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options)
Initialize the AVCodecContext to use the given AVCodec.
Definition: utils.c:627
AVFifoBuffer * task_fifo
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:502
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:3748
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:1788
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:1796
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:1648
int thread_type
Which multithreading methods to use.
Definition: avcodec.h:3185
static uint8_t tmp[11]
Definition: aes_ctr.c:26