Merge commit 'a1a143adb0fd11c474221431417cff25db7d920f'
[ffmpeg.git] / libavcodec / frame_thread_encoder.c
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{
45     AVCodecContext *parent_avctx;
46     pthread_mutex_t buffer_mutex;
47
48     AVFifoBuffer *task_fifo;
49     pthread_mutex_t task_fifo_mutex;
50     pthread_cond_t task_fifo_cond;
51
52     Task finished_tasks[BUFFER_SIZE];
53     pthread_mutex_t finished_task_mutex;
54     pthread_cond_t finished_task_cond;
55
56     unsigned task_index;
57     unsigned finished_task_index;
58
59     pthread_t worker[MAX_THREADS];
60     atomic_int exit;
61 } ThreadContext;
62
63 static void * attribute_align_arg worker(void *v){
64     AVCodecContext *avctx = v;
65     ThreadContext *c = avctx->internal->frame_thread_encoder;
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
77         pthread_mutex_lock(&c->task_fifo_mutex);
78         while (av_fifo_size(c->task_fifo) <= 0 || atomic_load(&c->exit)) {
79             if (atomic_load(&c->exit)) {
80                 pthread_mutex_unlock(&c->task_fifo_mutex);
81                 goto end;
82             }
83             pthread_cond_wait(&c->task_fifo_cond, &c->task_fifo_mutex);
84         }
85         av_fifo_generic_read(c->task_fifo, &task, sizeof(task), NULL);
86         pthread_mutex_unlock(&c->task_fifo_mutex);
87         frame = task.indata;
88
89         ret = avcodec_encode_video2(avctx, pkt, frame, &got_packet);
90         pthread_mutex_lock(&c->buffer_mutex);
91         av_frame_unref(frame);
92         pthread_mutex_unlock(&c->buffer_mutex);
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         }
102         pthread_mutex_lock(&c->finished_task_mutex);
103         c->finished_tasks[task.index].outdata = pkt; pkt = NULL;
104         c->finished_tasks[task.index].return_code = ret;
105         pthread_cond_signal(&c->finished_task_cond);
106         pthread_mutex_unlock(&c->finished_task_mutex);
107     }
108 end:
109     av_free(pkt);
110     pthread_mutex_lock(&c->buffer_mutex);
111     avcodec_close(avctx);
112     pthread_mutex_unlock(&c->buffer_mutex);
113     av_freep(&avctx);
114     return NULL;
115 }
116
117 int ff_frame_thread_encoder_init(AVCodecContext *avctx, AVDictionary *options){
118     int i=0;
119     ThreadContext *c;
120
121
122     if(   !(avctx->thread_type & FF_THREAD_FRAME)
123        || !(avctx->codec->capabilities & AV_CODEC_CAP_INTRA_ONLY))
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",
154                                                NULL, AV_DICT_MATCH_CASE);
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
176     av_assert0(!avctx->internal->frame_thread_encoder);
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
183     c->task_fifo = av_fifo_alloc_array(BUFFER_SIZE, sizeof(Task));
184     if(!c->task_fifo)
185         goto fail;
186
187     pthread_mutex_init(&c->task_fifo_mutex, NULL);
188     pthread_mutex_init(&c->finished_task_mutex, NULL);
189     pthread_mutex_init(&c->buffer_mutex, NULL);
190     pthread_cond_init(&c->task_fifo_cond, NULL);
191     pthread_cond_init(&c->finished_task_cond, NULL);
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
231     avctx->active_thread_type = FF_THREAD_FRAME;
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");
237     ff_frame_thread_encoder_free(avctx);
238     return -1;
239 }
240
241 void ff_frame_thread_encoder_free(AVCodecContext *avctx){
242     int i;
243     ThreadContext *c= avctx->internal->frame_thread_encoder;
244
245     pthread_mutex_lock(&c->task_fifo_mutex);
246     atomic_store(&c->exit, 1);
247     pthread_cond_broadcast(&c->task_fifo_cond);
248     pthread_mutex_unlock(&c->task_fifo_mutex);
249
250     for (i=0; i<avctx->thread_count; i++) {
251          pthread_join(c->worker[i], NULL);
252     }
253
254     pthread_mutex_destroy(&c->task_fifo_mutex);
255     pthread_mutex_destroy(&c->finished_task_mutex);
256     pthread_mutex_destroy(&c->buffer_mutex);
257     pthread_cond_destroy(&c->task_fifo_cond);
258     pthread_cond_destroy(&c->finished_task_cond);
259     av_fifo_freep(&c->task_fifo);
260     av_freep(&avctx->internal->frame_thread_encoder);
261 }
262
263 int ff_thread_video_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet_ptr){
264     ThreadContext *c = avctx->internal->frame_thread_encoder;
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;
282         pthread_mutex_lock(&c->task_fifo_mutex);
283         av_fifo_generic_write(c->task_fifo, &task, sizeof(task), NULL);
284         pthread_cond_signal(&c->task_fifo_cond);
285         pthread_mutex_unlock(&c->task_fifo_mutex);
286
287         c->task_index = (c->task_index+1) % BUFFER_SIZE;
288     }
289
290     pthread_mutex_lock(&c->finished_task_mutex);
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)) {
294             pthread_mutex_unlock(&c->finished_task_mutex);
295             return 0;
296         }
297
298     while (!c->finished_tasks[c->finished_task_index].outdata) {
299         pthread_cond_wait(&c->finished_task_cond, &c->finished_task_mutex);
300     }
301     task = c->finished_tasks[c->finished_task_index];
302     *pkt = *(AVPacket*)(task.outdata);
303     if(pkt->data)
304         *got_packet_ptr = 1;
305     av_freep(&c->finished_tasks[c->finished_task_index].outdata);
306     c->finished_task_index = (c->finished_task_index+1) % BUFFER_SIZE;
307     pthread_mutex_unlock(&c->finished_task_mutex);
308
309     return task.return_code;
310 }