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/thread.h"
27 #include "avcodec.h"
28 #include "internal.h"
29 #include "thread.h"
30 
31 #define MAX_THREADS 64
32 #define BUFFER_SIZE (2*MAX_THREADS)
33 
34 typedef struct{
35  void *indata;
36  void *outdata;
37  int64_t return_code;
38  unsigned index;
39 } Task;
40 
41 typedef struct{
44 
48 
49  Task finished_tasks[BUFFER_SIZE];
52 
53  unsigned task_index;
55 
57  int exit;
59 
60 static void * attribute_align_arg worker(void *v){
61  AVCodecContext *avctx = v;
63  AVPacket *pkt = NULL;
64 
65  while(!c->exit){
66  int got_packet, ret;
67  AVFrame *frame;
68  Task task;
69 
70  if(!pkt) pkt= av_mallocz(sizeof(*pkt));
71  if(!pkt) continue;
72  av_init_packet(pkt);
73 
75  while (av_fifo_size(c->task_fifo) <= 0 || c->exit) {
76  if(c->exit){
78  goto end;
79  }
81  }
82  av_fifo_generic_read(c->task_fifo, &task, sizeof(task), NULL);
84  frame = task.indata;
85 
86  ret = avcodec_encode_video2(avctx, pkt, frame, &got_packet);
88  av_frame_unref(frame);
90  av_frame_free(&frame);
91  if(got_packet) {
92  int ret2 = av_dup_packet(pkt);
93  if (ret >= 0 && ret2 < 0)
94  ret = ret2;
95  } else {
96  pkt->data = NULL;
97  pkt->size = 0;
98  }
100  c->finished_tasks[task.index].outdata = pkt; pkt = NULL;
101  c->finished_tasks[task.index].return_code = ret;
104  }
105 end:
106  av_free(pkt);
108  avcodec_close(avctx);
110  av_freep(&avctx);
111  return NULL;
112 }
113 
115  int i=0;
116  ThreadContext *c;
117 
118 
119  if( !(avctx->thread_type & FF_THREAD_FRAME)
121  return 0;
122 
123  if( !avctx->thread_count
124  && avctx->codec_id == AV_CODEC_ID_MJPEG
125  && !(avctx->flags & AV_CODEC_FLAG_QSCALE)) {
126  av_log(avctx, AV_LOG_DEBUG,
127  "Forcing thread count to 1 for MJPEG encoding, use -thread_type slice "
128  "or a constant quantizer if you want to use multiple cpu cores\n");
129  avctx->thread_count = 1;
130  }
131  if( avctx->thread_count > 1
132  && avctx->codec_id == AV_CODEC_ID_MJPEG
133  && !(avctx->flags & AV_CODEC_FLAG_QSCALE))
134  av_log(avctx, AV_LOG_WARNING,
135  "MJPEG CBR encoding works badly with frame multi-threading, consider "
136  "using -threads 1, -thread_type slice or a constant quantizer.\n");
137 
138  if (avctx->codec_id == AV_CODEC_ID_HUFFYUV ||
139  avctx->codec_id == AV_CODEC_ID_FFVHUFF) {
140  int warn = 0;
141  int context_model = 0;
142  AVDictionaryEntry *con = av_dict_get(options, "context", NULL, AV_DICT_MATCH_CASE);
143 
144  if (con && con->value)
145  context_model = atoi(con->value);
146 
147  if (avctx->flags & AV_CODEC_FLAG_PASS1)
148  warn = 1;
149  else if(context_model > 0) {
150  AVDictionaryEntry *t = av_dict_get(options, "non_deterministic",
152  warn = !t || !t->value || !atoi(t->value) ? 1 : 0;
153  }
154  // huffyuv does not support these with multiple frame threads currently
155  if (warn) {
156  av_log(avctx, AV_LOG_WARNING,
157  "Forcing thread count to 1 for huffyuv encoding with first pass or context 1\n");
158  avctx->thread_count = 1;
159  }
160  }
161 
162  if(!avctx->thread_count) {
163  avctx->thread_count = av_cpu_count();
164  avctx->thread_count = FFMIN(avctx->thread_count, MAX_THREADS);
165  }
166 
167  if(avctx->thread_count <= 1)
168  return 0;
169 
170  if(avctx->thread_count > MAX_THREADS)
171  return AVERROR(EINVAL);
172 
174  c = avctx->internal->frame_thread_encoder = av_mallocz(sizeof(ThreadContext));
175  if(!c)
176  return AVERROR(ENOMEM);
177 
178  c->parent_avctx = avctx;
179 
181  if(!c->task_fifo)
182  goto fail;
183 
189 
190  for(i=0; i<avctx->thread_count ; i++){
191  AVDictionary *tmp = NULL;
192  void *tmpv;
193  AVCodecContext *thread_avctx = avcodec_alloc_context3(avctx->codec);
194  if(!thread_avctx)
195  goto fail;
196  tmpv = thread_avctx->priv_data;
197  *thread_avctx = *avctx;
198  thread_avctx->priv_data = tmpv;
199  thread_avctx->internal = NULL;
200  memcpy(thread_avctx->priv_data, avctx->priv_data, avctx->codec->priv_data_size);
201  thread_avctx->thread_count = 1;
202  thread_avctx->active_thread_type &= ~FF_THREAD_FRAME;
203 
204  av_dict_copy(&tmp, options, 0);
205  av_dict_set(&tmp, "threads", "1", 0);
206  if(avcodec_open2(thread_avctx, avctx->codec, &tmp) < 0) {
207  av_dict_free(&tmp);
208  goto fail;
209  }
210  av_dict_free(&tmp);
211  av_assert0(!thread_avctx->internal->frame_thread_encoder);
212  thread_avctx->internal->frame_thread_encoder = c;
213  if(pthread_create(&c->worker[i], NULL, worker, thread_avctx)) {
214  goto fail;
215  }
216  }
217 
219 
220  return 0;
221 fail:
222  avctx->thread_count = i;
223  av_log(avctx, AV_LOG_ERROR, "ff_frame_thread_encoder_init failed\n");
225  return -1;
226 }
227 
229  int i;
231 
233  c->exit = 1;
236 
237  for (i=0; i<avctx->thread_count; i++) {
238  pthread_join(c->worker[i], NULL);
239  }
240 
248 }
249 
250 int ff_thread_video_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet_ptr){
252  Task task;
253  int ret;
254 
255  av_assert1(!*got_packet_ptr);
256 
257  if(frame){
258  AVFrame *new = av_frame_alloc();
259  if(!new)
260  return AVERROR(ENOMEM);
261  ret = av_frame_ref(new, frame);
262  if(ret < 0) {
263  av_frame_free(&new);
264  return ret;
265  }
266 
267  task.index = c->task_index;
268  task.indata = (void*)new;
270  av_fifo_generic_write(c->task_fifo, &task, sizeof(task), NULL);
273 
274  c->task_index = (c->task_index+1) % BUFFER_SIZE;
275 
277  return 0;
278  }
279 
280  if(c->task_index == c->finished_task_index)
281  return 0;
282 
284  while (!c->finished_tasks[c->finished_task_index].outdata) {
286  }
287  task = c->finished_tasks[c->finished_task_index];
288  *pkt = *(AVPacket*)(task.outdata);
289  if(pkt->data)
290  *got_packet_ptr = 1;
294 
295  return task.return_code;
296 }
#define NULL
Definition: coverity.c:32
const struct AVCodec * codec
Definition: avcodec.h:1684
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:184
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:256
misc image utilities
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
int size
Definition: avcodec.h:1601
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:252
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:1051
#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:141
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:375
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: avcodec.h:1600
static av_always_inline int pthread_cond_signal(pthread_cond_t *cond)
Definition: os2threads.h:146
const OptionDef options[]
Definition: ffserver.c:3969
#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:2975
#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:154
int active_thread_type
Which multithreading methods are in use by the codec.
Definition: avcodec.h:3125
attribute_deprecated int av_dup_packet(AVPacket *pkt)
Definition: avpacket.c:253
int capabilities
Codec capabilities.
Definition: avcodec.h:3608
#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:1770
simple assert() macros that are a bit more flexible than ISO C assert().
#define fail()
Definition: checkasm.h:82
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:832
#define FF_THREAD_FRAME
Decode more than one frame at once.
Definition: avcodec.h:3117
#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:156
int priv_data_size
Definition: avcodec.h:3625
#define AV_CODEC_FLAG_PASS1
Use internal 2pass ratecontrol in first pass mode.
Definition: avcodec.h:848
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
int thread_count
thread count is used to decide how many independent tasks should be passed to execute() ...
Definition: avcodec.h:3106
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:1692
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:1675
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: utils.c:1927
int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options)
Initialize the AVCodecContext to use the given AVCodec.
Definition: utils.c:1214
AVFifoBuffer * task_fifo
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:485
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: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:1717
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
static av_always_inline int pthread_mutex_unlock(pthread_mutex_t *mutex)
Definition: os2threads.h:120
struct AVCodecInternal * internal
Private context used for internal data.
Definition: avcodec.h:1725
static uint8_t tmp[8]
Definition: des.c:38
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:113
static void *attribute_align_arg worker(void *v)
pthread_cond_t task_fifo_cond
This structure stores compressed data.
Definition: avcodec.h:1577
int thread_type
Which multithreading methods to use.
Definition: avcodec.h:3116