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 "avcodec.h"
27 #include "internal.h"
28 #include "thread.h"
29 
30 #if HAVE_PTHREADS
31 #include <pthread.h>
32 #elif HAVE_W32THREADS
33 #include "compat/w32pthreads.h"
34 #elif HAVE_OS2THREADS
35 #include "compat/os2threads.h"
36 #endif
37 
38 #define MAX_THREADS 64
39 #define BUFFER_SIZE (2*MAX_THREADS)
40 
41 typedef struct{
42  void *indata;
43  void *outdata;
44  int64_t return_code;
45  unsigned index;
46 } Task;
47 
48 typedef struct{
51 
55 
56  Task finished_tasks[BUFFER_SIZE];
59 
60  unsigned task_index;
62 
64  int exit;
66 
67 static void * attribute_align_arg worker(void *v){
68  AVCodecContext *avctx = v;
70  AVPacket *pkt = NULL;
71 
72  while(!c->exit){
73  int got_packet, ret;
74  AVFrame *frame;
75  Task task;
76 
77  if(!pkt) pkt= av_mallocz(sizeof(*pkt));
78  if(!pkt) continue;
79  av_init_packet(pkt);
80 
82  while (av_fifo_size(c->task_fifo) <= 0 || c->exit) {
83  if(c->exit){
85  goto end;
86  }
88  }
89  av_fifo_generic_read(c->task_fifo, &task, sizeof(task), NULL);
91  frame = task.indata;
92 
93  ret = avcodec_encode_video2(avctx, pkt, frame, &got_packet);
95  av_frame_unref(frame);
97  av_frame_free(&frame);
98  if(got_packet) {
99  av_dup_packet(pkt);
100  } else {
101  pkt->data = NULL;
102  pkt->size = 0;
103  }
105  c->finished_tasks[task.index].outdata = pkt; pkt = NULL;
106  c->finished_tasks[task.index].return_code = ret;
109  }
110 end:
111  av_free(pkt);
113  avcodec_close(avctx);
115  av_freep(&avctx);
116  return NULL;
117 }
118 
120  int i=0;
121  ThreadContext *c;
122 
123 
124  if( !(avctx->thread_type & FF_THREAD_FRAME)
125  || !(avctx->codec->capabilities & CODEC_CAP_INTRA_ONLY))
126  return 0;
127 
128  if( !avctx->thread_count
129  && avctx->codec_id == AV_CODEC_ID_MJPEG
130  && !(avctx->flags & CODEC_FLAG_QSCALE)) {
131  av_log(avctx, AV_LOG_DEBUG,
132  "Forcing thread count to 1 for MJPEG encoding, use -thread_type slice "
133  "or a constant quantizer if you want to use multiple cpu cores\n");
134  avctx->thread_count = 1;
135  }
136  if( avctx->thread_count > 1
137  && avctx->codec_id == AV_CODEC_ID_MJPEG
138  && !(avctx->flags & CODEC_FLAG_QSCALE))
139  av_log(avctx, AV_LOG_WARNING,
140  "MJPEG CBR encoding works badly with frame multi-threading, consider "
141  "using -threads 1, -thread_type slice or a constant quantizer.\n");
142 
143  if (avctx->codec_id == AV_CODEC_ID_HUFFYUV ||
144  avctx->codec_id == AV_CODEC_ID_FFVHUFF) {
145  int warn = 0;
146  if (avctx->flags & CODEC_FLAG_PASS1)
147  warn = 1;
148  else if(avctx->context_model > 0) {
149  AVDictionaryEntry *t = av_dict_get(options, "non_deterministic",
151  warn = !t || !t->value || !atoi(t->value) ? 1 : 0;
152  }
153  // huffyuv does not support these with multiple frame threads currently
154  if (warn) {
155  av_log(avctx, AV_LOG_WARNING,
156  "Forcing thread count to 1 for huffyuv encoding with first pass or context 1\n");
157  avctx->thread_count = 1;
158  }
159  }
160 
161  if(!avctx->thread_count) {
162  avctx->thread_count = av_cpu_count();
163  avctx->thread_count = FFMIN(avctx->thread_count, MAX_THREADS);
164  }
165 
166  if(avctx->thread_count <= 1)
167  return 0;
168 
169  if(avctx->thread_count > MAX_THREADS)
170  return AVERROR(EINVAL);
171 
173  c = avctx->internal->frame_thread_encoder = av_mallocz(sizeof(ThreadContext));
174  if(!c)
175  return AVERROR(ENOMEM);
176 
177  c->parent_avctx = avctx;
178 
180  if(!c->task_fifo)
181  goto fail;
182 
188 
189  for(i=0; i<avctx->thread_count ; i++){
190  AVDictionary *tmp = NULL;
191  void *tmpv;
192  AVCodecContext *thread_avctx = avcodec_alloc_context3(avctx->codec);
193  if(!thread_avctx)
194  goto fail;
195  tmpv = thread_avctx->priv_data;
196  *thread_avctx = *avctx;
197  thread_avctx->priv_data = tmpv;
198  thread_avctx->internal = NULL;
199  memcpy(thread_avctx->priv_data, avctx->priv_data, avctx->codec->priv_data_size);
200  thread_avctx->thread_count = 1;
201  thread_avctx->active_thread_type &= ~FF_THREAD_FRAME;
202 
203  av_dict_copy(&tmp, options, 0);
204  av_dict_set(&tmp, "threads", "1", 0);
205  if(avcodec_open2(thread_avctx, avctx->codec, &tmp) < 0) {
206  av_dict_free(&tmp);
207  goto fail;
208  }
209  av_dict_free(&tmp);
210  av_assert0(!thread_avctx->internal->frame_thread_encoder);
211  thread_avctx->internal->frame_thread_encoder = c;
212  if(pthread_create(&c->worker[i], NULL, worker, thread_avctx)) {
213  goto fail;
214  }
215  }
216 
218 
219  return 0;
220 fail:
221  avctx->thread_count = i;
222  av_log(avctx, AV_LOG_ERROR, "ff_frame_thread_encoder_init failed\n");
224  return -1;
225 }
226 
228  int i;
230 
232  c->exit = 1;
235 
236  for (i=0; i<avctx->thread_count; i++) {
237  pthread_join(c->worker[i], NULL);
238  }
239 
247 }
248 
249 int ff_thread_video_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet_ptr){
251  Task task;
252  int ret;
253 
254  av_assert1(!*got_packet_ptr);
255 
256  if(frame){
257  AVFrame *new = av_frame_alloc();
258  if(!new)
259  return AVERROR(ENOMEM);
260  ret = av_frame_ref(new, frame);
261  if(ret < 0) {
262  av_frame_free(&new);
263  return ret;
264  }
265 
266  task.index = c->task_index;
267  task.indata = (void*)new;
269  av_fifo_generic_write(c->task_fifo, &task, sizeof(task), NULL);
272 
273  c->task_index = (c->task_index+1) % BUFFER_SIZE;
274 
276  return 0;
277  }
278 
279  if(c->task_index == c->finished_task_index)
280  return 0;
281 
283  while (!c->finished_tasks[c->finished_task_index].outdata) {
285  }
286  task = c->finished_tasks[c->finished_task_index];
287  *pkt = *(AVPacket*)(task.outdata);
288  if(pkt->data)
289  *got_packet_ptr = 1;
293 
294  return task.return_code;
295 }
#define NULL
Definition: coverity.c:32
const struct AVCodec * codec
Definition: avcodec.h:1250
float v
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:94
unsigned finished_task_index
This structure describes decoded (raw) audio or video data.
Definition: frame.h:171
static av_always_inline int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex)
Definition: os2threads.h:153
int av_cpu_count(void)
Definition: cpu.c:251
misc image utilities
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
#define CODEC_FLAG_PASS1
Use internal 2pass ratecontrol in first pass mode.
Definition: avcodec.h:736
int size
Definition: avcodec.h:1163
os2threads to pthreads wrapper
AVCodecContext * parent_avctx
static AVPacket pkt
int av_dup_packet(AVPacket *pkt)
Definition: avpacket.c:248
static av_always_inline int pthread_cond_destroy(pthread_cond_t *cond)
Definition: os2threads.h:124
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
int context_model
context model
Definition: avcodec.h:2387
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
HMTX pthread_mutex_t
Definition: os2threads.h:40
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:135
#define CODEC_CAP_INTRA_ONLY
Codec is intra only.
Definition: avcodec.h:886
static av_cold int end(AVCodecContext *avctx)
Definition: avrndec.c:67
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:363
int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
Encode a frame of video.
Definition: utils.c:2101
static AVFrame * frame
Task finished_tasks[BUFFER_SIZE]
void * frame_thread_encoder
Definition: internal.h:151
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:39
uint8_t * data
Definition: avcodec.h:1162
static av_always_inline int pthread_cond_signal(pthread_cond_t *cond)
Definition: os2threads.h:131
const OptionDef options[]
Definition: ffserver.c:3798
void av_dict_copy(AVDictionary **dst, const AVDictionary *src, int flags)
Copy entries from one AVDictionary struct into another.
Definition: dict.c:213
#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:2843
#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:71
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:148
int active_thread_type
Which multithreading methods are in use by the codec.
Definition: avcodec.h:2772
int capabilities
Codec capabilities.
Definition: avcodec.h:3200
#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:150
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:199
int flags
CODEC_FLAG_*.
Definition: avcodec.h:1335
#define CODEC_FLAG_QSCALE
Use fixed qscale.
Definition: avcodec.h:712
simple assert() macros that are a bit more flexible than ISO C assert().
Libavcodec external API header.
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 FFMIN(a, b)
Definition: common.h:66
AVCodecContext * avcodec_alloc_context3(const AVCodec *codec)
Allocate an AVCodecContext and set its fields to default values.
Definition: options.c:147
ret
Definition: avfilter.c:974
int priv_data_size
Definition: avcodec.h:3219
static av_always_inline int pthread_join(pthread_t thread, void **value_ptr)
Definition: os2threads.h:80
static av_always_inline int pthread_mutex_init(pthread_mutex_t *mutex, const pthread_mutexattr_t *attr)
Definition: os2threads.h:87
pthread_mutex_t task_fifo_mutex
int thread_count
thread count is used to decide how many independent tasks should be passed to execute() ...
Definition: avcodec.h:2753
static av_always_inline int pthread_create(pthread_t *thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
Definition: os2threads.h:64
enum AVCodecID codec_id
Definition: avcodec.h:1258
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:1241
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:69
#define FF_THREAD_FRAME
Decode more than one frame at once.
Definition: avcodec.h:2764
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:1330
AVFifoBuffer * task_fifo
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:462
AVFifoBuffer * av_fifo_alloc_array(size_t nmemb, size_t size)
Initialize an AVFifoBuffer.
Definition: fifo.c:49
int64_t return_code
common internal api header.
static double c[64]
static av_always_inline int pthread_cond_init(pthread_cond_t *cond, const pthread_condattr_t *attr)
Definition: os2threads.h:115
void av_init_packet(AVPacket *pkt)
Initialize optional fields of a packet with default values.
Definition: avpacket.c:49
void * priv_data
Definition: avcodec.h:1283
pthread_mutex_t finished_task_mutex
#define av_free(p)
char * value
Definition: dict.h:88
#define BUFFER_SIZE
static av_always_inline int pthread_cond_broadcast(pthread_cond_t *cond)
Definition: os2threads.h:142
static av_always_inline int pthread_mutex_unlock(pthread_mutex_t *mutex)
Definition: os2threads.h:108
struct AVCodecInternal * internal
Private context used for internal data.
Definition: avcodec.h:1291
w32threads to pthreads wrapper
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 av_always_inline int pthread_mutex_lock(pthread_mutex_t *mutex)
Definition: os2threads.h:101
static void *attribute_align_arg worker(void *v)
pthread_cond_t task_fifo_cond
This structure stores compressed data.
Definition: avcodec.h:1139
void * av_mallocz(size_t size)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:250
int thread_type
Which multithreading methods to use.
Definition: avcodec.h:2763