1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 /**
20  * @file
21  * Frame multithreading support functions
22  * @see doc/multithreading.txt
23  */
24 
25 #include "config.h"
26 
27 #include <stdatomic.h>
28 #include <stdint.h>
29 
30 #include "avcodec.h"
31 #include "hwaccel.h"
32 #include "internal.h"
33 #include "pthread_internal.h"
34 #include "thread.h"
35 #include "version.h"
36 
37 #include "libavutil/avassert.h"
38 #include "libavutil/buffer.h"
39 #include "libavutil/common.h"
40 #include "libavutil/cpu.h"
41 #include "libavutil/frame.h"
42 #include "libavutil/internal.h"
43 #include "libavutil/log.h"
44 #include "libavutil/mem.h"
45 #include "libavutil/opt.h"
46 #include "libavutil/thread.h"
47 
48 enum {
49     ///< Set when the thread is awaiting a packet.
50     STATE_INPUT_READY,
51     ///< Set before the codec has called ff_thread_finish_setup().
52     STATE_SETTING_UP,
53     /**
54      * Set when the codec calls get_buffer().
55      * State is returned to STATE_SETTING_UP afterwards.
56      */
57     STATE_GET_BUFFER,
58      /**
59       * Set when the codec calls get_format().
60       * State is returned to STATE_SETTING_UP afterwards.
61       */
62     STATE_GET_FORMAT,
63     ///< Set after the codec has called ff_thread_finish_setup().
64     STATE_SETUP_FINISHED,
65 };
66 
67 /**
68  * Context used by codec threads and stored in their AVCodecInternal thread_ctx.
69  */
70 typedef struct PerThreadContext {
71     struct FrameThreadContext *parent;
72 
73     pthread_t      thread;
74     int            thread_init;
75     pthread_cond_t input_cond;      ///< Used to wait for a new packet from the main thread.
76     pthread_cond_t progress_cond;   ///< Used by child threads to wait for progress to change.
77     pthread_cond_t output_cond;     ///< Used by the main thread to wait for frames to finish.
78 
79     pthread_mutex_t mutex;          ///< Mutex used to protect the contents of the PerThreadContext.
80     pthread_mutex_t progress_mutex; ///< Mutex used to protect frame progress values and progress_cond.
81 
82     AVCodecContext *avctx;          ///< Context used to decode packets passed to this thread.
83 
84     AVPacket       avpkt;           ///< Input packet (for decoding) or output (for encoding).
85 
86     AVFrame *frame;                 ///< Output frame (for decoding) or input (for encoding).
87     int     got_frame;              ///< The output of got_picture_ptr from the last avcodec_decode_video() call.
88     int     result;                 ///< The result of the last codec decode/encode() call.
89 
90     atomic_int state;
91 
92     /**
93      * Array of frames passed to ff_thread_release_buffer().
94      * Frames are released after all threads referencing them are finished.
95      */
96     AVFrame *released_buffers;
97     int  num_released_buffers;
98     int      released_buffers_allocated;
99 
100     AVFrame *requested_frame;       ///< AVFrame the codec passed to get_buffer()
101     int      requested_flags;       ///< flags passed to get_buffer() for requested_frame
102 
103     const enum AVPixelFormat *available_formats; ///< Format array for get_format()
104     enum AVPixelFormat result_format;            ///< get_format() result
105 
106     int die;                        ///< Set when the thread should exit.
107 
108     int hwaccel_serializing;
109     int async_serializing;
110 
111     atomic_int debug_threads;       ///< Set if the FF_DEBUG_THREADS option is set.
112 } PerThreadContext;
113 
114 /**
115  * Context stored in the client AVCodecInternal thread_ctx.
116  */
117 typedef struct FrameThreadContext {
118     PerThreadContext *threads;     ///< The contexts for each thread.
119     PerThreadContext *prev_thread; ///< The last thread submit_packet() was called on.
120 
121     pthread_mutex_t buffer_mutex;  ///< Mutex used to protect get/release_buffer().
122     /**
123      * This lock is used for ensuring threads run in serial when hwaccel
124      * is used.
125      */
126     pthread_mutex_t hwaccel_mutex;
127     pthread_mutex_t async_mutex;
128     pthread_cond_t async_cond;
129     int async_lock;
130 
131     int next_decoding;             ///< The next context to submit a packet to.
132     int next_finished;             ///< The next context to return output from.
133 
134     int delaying;                  /**<
135                                     * Set for the first N packets, where N is the number of threads.
136                                     * While it is set, ff_thread_en/decode_frame won't return any results.
137                                     */
138 } FrameThreadContext;
139 
140 #define THREAD_SAFE_CALLBACKS(avctx) \
141 ((avctx)->thread_safe_callbacks || (avctx)->get_buffer2 == avcodec_default_get_buffer2)
142 
async_lock(FrameThreadContext * fctx)143 static void async_lock(FrameThreadContext *fctx)
144 {
145     pthread_mutex_lock(&fctx->async_mutex);
146     while (fctx->async_lock)
147         pthread_cond_wait(&fctx->async_cond, &fctx->async_mutex);
148     fctx->async_lock = 1;
149     pthread_mutex_unlock(&fctx->async_mutex);
150 }
151 
async_unlock(FrameThreadContext * fctx)152 static void async_unlock(FrameThreadContext *fctx)
153 {
154     pthread_mutex_lock(&fctx->async_mutex);
155     av_assert0(fctx->async_lock);
156     fctx->async_lock = 0;
157     pthread_cond_broadcast(&fctx->async_cond);
158     pthread_mutex_unlock(&fctx->async_mutex);
159 }
160 
161 /**
162  * Codec worker thread.
163  *
164  * Automatically calls ff_thread_finish_setup() if the codec does
165  * not provide an update_thread_context method, or if the codec returns
166  * before calling it.
167  */
frame_worker_thread(void * arg)168 static attribute_align_arg void *frame_worker_thread(void *arg)
169 {
170     PerThreadContext *p = arg;
171     AVCodecContext *avctx = p->avctx;
172     const AVCodec *codec = avctx->codec;
173 
174     pthread_mutex_lock(&p->mutex);
175     while (1) {
176         while (atomic_load(&p->state) == STATE_INPUT_READY && !p->die)
177             pthread_cond_wait(&p->input_cond, &p->mutex);
178 
179         if (p->die) break;
180 
181         if (!codec->update_thread_context && THREAD_SAFE_CALLBACKS(avctx))
182             ff_thread_finish_setup(avctx);
183 
184         /* If a decoder supports hwaccel, then it must call ff_get_format().
185          * Since that call must happen before ff_thread_finish_setup(), the
186          * decoder is required to implement update_thread_context() and call
187          * ff_thread_finish_setup() manually. Therefore the above
188          * ff_thread_finish_setup() call did not happen and hwaccel_serializing
189          * cannot be true here. */
190         av_assert0(!p->hwaccel_serializing);
191 
192         /* if the previous thread uses hwaccel then we take the lock to ensure
193          * the threads don't run concurrently */
194         if (avctx->hwaccel) {
195             pthread_mutex_lock(&p->parent->hwaccel_mutex);
196             p->hwaccel_serializing = 1;
197         }
198 
199         av_frame_unref(p->frame);
200         p->got_frame = 0;
201         p->result = codec->decode(avctx, p->frame, &p->got_frame, &p->avpkt);
202 
203         if ((p->result < 0 || !p->got_frame) && p->frame->buf[0]) {
204             if (avctx->internal->allocate_progress)
205                 av_log(avctx, AV_LOG_ERROR, "A frame threaded decoder did not "
206                        "free the frame on failure. This is a bug, please report it.\n");
207             av_frame_unref(p->frame);
208         }
209 
210         if (atomic_load(&p->state) == STATE_SETTING_UP)
211             ff_thread_finish_setup(avctx);
212 
213         if (p->hwaccel_serializing) {
214             p->hwaccel_serializing = 0;
215             pthread_mutex_unlock(&p->parent->hwaccel_mutex);
216         }
217 
218         if (p->async_serializing) {
219             p->async_serializing = 0;
220 
221             async_unlock(p->parent);
222         }
223 
224         pthread_mutex_lock(&p->progress_mutex);
225 
226         atomic_store(&p->state, STATE_INPUT_READY);
227 
228         pthread_cond_broadcast(&p->progress_cond);
229         pthread_cond_signal(&p->output_cond);
230         pthread_mutex_unlock(&p->progress_mutex);
231     }
232     pthread_mutex_unlock(&p->mutex);
233 
234     return NULL;
235 }
236 
237 /**
238  * Update the next thread's AVCodecContext with values from the reference thread's context.
239  *
240  * @param dst The destination context.
241  * @param src The source context.
242  * @param for_user 0 if the destination is a codec thread, 1 if the destination is the user's thread
243  * @return 0 on success, negative error code on failure
244  */
update_context_from_thread(AVCodecContext * dst,AVCodecContext * src,int for_user)245 static int update_context_from_thread(AVCodecContext *dst, AVCodecContext *src, int for_user)
246 {
247     int err = 0;
248 
249     if (dst != src && (for_user || !(src->codec_descriptor->props & AV_CODEC_PROP_INTRA_ONLY))) {
250         dst->time_base = src->time_base;
251         dst->framerate = src->framerate;
252         dst->width     = src->width;
253         dst->height    = src->height;
254         dst->pix_fmt   = src->pix_fmt;
255         dst->sw_pix_fmt = src->sw_pix_fmt;
256 
257         dst->coded_width  = src->coded_width;
258         dst->coded_height = src->coded_height;
259 
260         dst->has_b_frames = src->has_b_frames;
261         dst->idct_algo    = src->idct_algo;
262 
263         dst->bits_per_coded_sample = src->bits_per_coded_sample;
264         dst->sample_aspect_ratio   = src->sample_aspect_ratio;
265 
266         dst->profile = src->profile;
267         dst->level   = src->level;
268 
269         dst->bits_per_raw_sample = src->bits_per_raw_sample;
270         dst->ticks_per_frame     = src->ticks_per_frame;
271         dst->color_primaries     = src->color_primaries;
272 
273         dst->color_trc   = src->color_trc;
274         dst->colorspace  = src->colorspace;
275         dst->color_range = src->color_range;
276         dst->chroma_sample_location = src->chroma_sample_location;
277 
278         dst->hwaccel = src->hwaccel;
279         dst->hwaccel_context = src->hwaccel_context;
280 
281         dst->channels       = src->channels;
282         dst->sample_rate    = src->sample_rate;
283         dst->sample_fmt     = src->sample_fmt;
284         dst->channel_layout = src->channel_layout;
285         dst->internal->hwaccel_priv_data = src->internal->hwaccel_priv_data;
286 
287         if (!!dst->hw_frames_ctx != !!src->hw_frames_ctx ||
288             (dst->hw_frames_ctx && dst->hw_frames_ctx->data != src->hw_frames_ctx->data)) {
289             av_buffer_unref(&dst->hw_frames_ctx);
290 
291             if (src->hw_frames_ctx) {
292                 dst->hw_frames_ctx = av_buffer_ref(src->hw_frames_ctx);
293                 if (!dst->hw_frames_ctx)
294                     return AVERROR(ENOMEM);
295             }
296         }
297 
298         dst->hwaccel_flags = src->hwaccel_flags;
299     }
300 
301     if (for_user) {
302         dst->delay       = src->thread_count - 1;
303 #if FF_API_CODED_FRAME
304 FF_DISABLE_DEPRECATION_WARNINGS
305         dst->coded_frame = src->coded_frame;
306 FF_ENABLE_DEPRECATION_WARNINGS
307 #endif
308     } else {
309         if (dst->codec->update_thread_context)
310             err = dst->codec->update_thread_context(dst, src);
311     }
312 
313     return err;
314 }
315 
316 /**
317  * Update the next thread's AVCodecContext with values set by the user.
318  *
319  * @param dst The destination context.
320  * @param src The source context.
321  * @return 0 on success, negative error code on failure
322  */
update_context_from_user(AVCodecContext * dst,AVCodecContext * src)323 static int update_context_from_user(AVCodecContext *dst, AVCodecContext *src)
324 {
325 #define copy_fields(s, e) memcpy(&dst->s, &src->s, (char*)&dst->e - (char*)&dst->s);
326     dst->flags          = src->flags;
327 
328     dst->draw_horiz_band= src->draw_horiz_band;
329     dst->get_buffer2    = src->get_buffer2;
330 
331     dst->opaque   = src->opaque;
332     dst->debug    = src->debug;
333     dst->debug_mv = src->debug_mv;
334 
335     dst->slice_flags = src->slice_flags;
336     dst->flags2      = src->flags2;
337 
338     copy_fields(skip_loop_filter, subtitle_header);
339 
340     dst->frame_number     = src->frame_number;
341     dst->reordered_opaque = src->reordered_opaque;
342     dst->thread_safe_callbacks = src->thread_safe_callbacks;
343 
344     if (src->slice_count && src->slice_offset) {
345         if (dst->slice_count < src->slice_count) {
346             int err = av_reallocp_array(&dst->slice_offset, src->slice_count,
347                                         sizeof(*dst->slice_offset));
348             if (err < 0)
349                 return err;
350         }
351         memcpy(dst->slice_offset, src->slice_offset,
352                src->slice_count * sizeof(*dst->slice_offset));
353     }
354     dst->slice_count = src->slice_count;
355     return 0;
356 #undef copy_fields
357 }
358 
359 /// Releases the buffers that this decoding thread was the last user of.
release_delayed_buffers(PerThreadContext * p)360 static void release_delayed_buffers(PerThreadContext *p)
361 {
362     FrameThreadContext *fctx = p->parent;
363 
364     while (p->num_released_buffers > 0) {
365         AVFrame *f;
366 
367         pthread_mutex_lock(&fctx->buffer_mutex);
368 
369         // fix extended data in case the caller screwed it up
370         av_assert0(p->avctx->codec_type == AVMEDIA_TYPE_VIDEO ||
371                    p->avctx->codec_type == AVMEDIA_TYPE_AUDIO);
372         f = &p->released_buffers[--p->num_released_buffers];
373         f->extended_data = f->data;
374         av_frame_unref(f);
375 
376         pthread_mutex_unlock(&fctx->buffer_mutex);
377     }
378 }
379 
submit_packet(PerThreadContext * p,AVCodecContext * user_avctx,AVPacket * avpkt)380 static int submit_packet(PerThreadContext *p, AVCodecContext *user_avctx,
381                          AVPacket *avpkt)
382 {
383     FrameThreadContext *fctx = p->parent;
384     PerThreadContext *prev_thread = fctx->prev_thread;
385     const AVCodec *codec = p->avctx->codec;
386     int ret;
387 
388     if (!avpkt->size && !(codec->capabilities & AV_CODEC_CAP_DELAY))
389         return 0;
390 
391     pthread_mutex_lock(&p->mutex);
392 
393     ret = update_context_from_user(p->avctx, user_avctx);
394     if (ret) {
395         pthread_mutex_unlock(&p->mutex);
396         return ret;
397     }
398     atomic_store_explicit(&p->debug_threads,
399                           (p->avctx->debug & FF_DEBUG_THREADS) != 0,
400                           memory_order_relaxed);
401 
402     release_delayed_buffers(p);
403 
404     if (prev_thread) {
405         int err;
406         if (atomic_load(&prev_thread->state) == STATE_SETTING_UP) {
407             pthread_mutex_lock(&prev_thread->progress_mutex);
408             while (atomic_load(&prev_thread->state) == STATE_SETTING_UP)
409                 pthread_cond_wait(&prev_thread->progress_cond, &prev_thread->progress_mutex);
410             pthread_mutex_unlock(&prev_thread->progress_mutex);
411         }
412 
413         err = update_context_from_thread(p->avctx, prev_thread->avctx, 0);
414         if (err) {
415             pthread_mutex_unlock(&p->mutex);
416             return err;
417         }
418     }
419 
420     av_packet_unref(&p->avpkt);
421     ret = av_packet_ref(&p->avpkt, avpkt);
422     if (ret < 0) {
423         pthread_mutex_unlock(&p->mutex);
424         av_log(p->avctx, AV_LOG_ERROR, "av_packet_ref() failed in submit_packet()\n");
425         return ret;
426     }
427 
428     atomic_store(&p->state, STATE_SETTING_UP);
429     pthread_cond_signal(&p->input_cond);
430     pthread_mutex_unlock(&p->mutex);
431 
432     /*
433      * If the client doesn't have a thread-safe get_buffer(),
434      * then decoding threads call back to the main thread,
435      * and it calls back to the client here.
436      */
437 
438     if (!p->avctx->thread_safe_callbacks && (
439          p->avctx->get_format != avcodec_default_get_format ||
440          p->avctx->get_buffer2 != avcodec_default_get_buffer2)) {
441         while (atomic_load(&p->state) != STATE_SETUP_FINISHED && atomic_load(&p->state) != STATE_INPUT_READY) {
442             int call_done = 1;
443             pthread_mutex_lock(&p->progress_mutex);
444             while (atomic_load(&p->state) == STATE_SETTING_UP)
445                 pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
446 
447             switch (atomic_load_explicit(&p->state, memory_order_acquire)) {
448             case STATE_GET_BUFFER:
449                 p->result = ff_get_buffer(p->avctx, p->requested_frame, p->requested_flags);
450                 break;
451             case STATE_GET_FORMAT:
452                 p->result_format = ff_get_format(p->avctx, p->available_formats);
453                 break;
454             default:
455                 call_done = 0;
456                 break;
457             }
458             if (call_done) {
459                 atomic_store(&p->state, STATE_SETTING_UP);
460                 pthread_cond_signal(&p->progress_cond);
461             }
462             pthread_mutex_unlock(&p->progress_mutex);
463         }
464     }
465 
466     fctx->prev_thread = p;
467     fctx->next_decoding++;
468 
469     return 0;
470 }
471 
ff_thread_decode_frame(AVCodecContext * avctx,AVFrame * picture,int * got_picture_ptr,AVPacket * avpkt)472 int ff_thread_decode_frame(AVCodecContext *avctx,
473                            AVFrame *picture, int *got_picture_ptr,
474                            AVPacket *avpkt)
475 {
476     FrameThreadContext *fctx = avctx->internal->thread_ctx;
477     int finished = fctx->next_finished;
478     PerThreadContext *p;
479     int err;
480 
481     /* release the async lock, permitting blocked hwaccel threads to
482      * go forward while we are in this function */
483     async_unlock(fctx);
484 
485     /*
486      * Submit a packet to the next decoding thread.
487      */
488 
489     p = &fctx->threads[fctx->next_decoding];
490     err = submit_packet(p, avctx, avpkt);
491     if (err)
492         goto finish;
493 
494     /*
495      * If we're still receiving the initial packets, don't return a frame.
496      */
497 
498     if (fctx->next_decoding > (avctx->thread_count-1-(avctx->codec_id == AV_CODEC_ID_FFV1)))
499         fctx->delaying = 0;
500 
501     if (fctx->delaying) {
502         *got_picture_ptr=0;
503         if (avpkt->size) {
504             err = avpkt->size;
505             goto finish;
506         }
507     }
508 
509     /*
510      * Return the next available frame from the oldest thread.
511      * If we're at the end of the stream, then we have to skip threads that
512      * didn't output a frame/error, because we don't want to accidentally signal
513      * EOF (avpkt->size == 0 && *got_picture_ptr == 0 && err >= 0).
514      */
515 
516     do {
517         p = &fctx->threads[finished++];
518 
519         if (atomic_load(&p->state) != STATE_INPUT_READY) {
520             pthread_mutex_lock(&p->progress_mutex);
521             while (atomic_load_explicit(&p->state, memory_order_relaxed) != STATE_INPUT_READY)
522                 pthread_cond_wait(&p->output_cond, &p->progress_mutex);
523             pthread_mutex_unlock(&p->progress_mutex);
524         }
525 
526         av_frame_move_ref(picture, p->frame);
527         *got_picture_ptr = p->got_frame;
528         picture->pkt_dts = p->avpkt.dts;
529         err = p->result;
530 
531         /*
532          * A later call with avkpt->size == 0 may loop over all threads,
533          * including this one, searching for a frame/error to return before being
534          * stopped by the "finished != fctx->next_finished" condition.
535          * Make sure we don't mistakenly return the same frame/error again.
536          */
537         p->got_frame = 0;
538         p->result = 0;
539 
540         if (finished >= avctx->thread_count) finished = 0;
541     } while (!avpkt->size && !*got_picture_ptr && err >= 0 && finished != fctx->next_finished);
542 
543     update_context_from_thread(avctx, p->avctx, 1);
544 
545     if (fctx->next_decoding >= avctx->thread_count) fctx->next_decoding = 0;
546 
547     fctx->next_finished = finished;
548 
549     /* return the size of the consumed packet if no error occurred */
550     if (err >= 0)
551         err = avpkt->size;
552 finish:
553     async_lock(fctx);
554     return err;
555 }
556 
ff_thread_report_progress(ThreadFrame * f,int n,int field)557 void ff_thread_report_progress(ThreadFrame *f, int n, int field)
558 {
559     PerThreadContext *p;
560     atomic_int *progress = f->progress ? (atomic_int*)f->progress->data : NULL;
561 
562     if (!progress ||
563         atomic_load_explicit(&progress[field], memory_order_relaxed) >= n)
564         return;
565 
566     p = f->owner[field]->internal->thread_ctx;
567 
568     if (atomic_load_explicit(&p->debug_threads, memory_order_relaxed))
569         av_log(f->owner[field], AV_LOG_DEBUG,
570                "%p finished %d field %d\n", progress, n, field);
571 
572     pthread_mutex_lock(&p->progress_mutex);
573 
574     atomic_store_explicit(&progress[field], n, memory_order_release);
575 
576     pthread_cond_broadcast(&p->progress_cond);
577     pthread_mutex_unlock(&p->progress_mutex);
578 }
579 
ff_thread_await_progress(ThreadFrame * f,int n,int field)580 void ff_thread_await_progress(ThreadFrame *f, int n, int field)
581 {
582     PerThreadContext *p;
583     atomic_int *progress = f->progress ? (atomic_int*)f->progress->data : NULL;
584 
585     if (!progress ||
586         atomic_load_explicit(&progress[field], memory_order_acquire) >= n)
587         return;
588 
589     p = f->owner[field]->internal->thread_ctx;
590 
591     if (atomic_load_explicit(&p->debug_threads, memory_order_relaxed))
592         av_log(f->owner[field], AV_LOG_DEBUG,
593                "thread awaiting %d field %d from %p\n", n, field, progress);
594 
595     pthread_mutex_lock(&p->progress_mutex);
596     while (atomic_load_explicit(&progress[field], memory_order_relaxed) < n)
597         pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
598     pthread_mutex_unlock(&p->progress_mutex);
599 }
600 
ff_thread_finish_setup(AVCodecContext * avctx)601 void ff_thread_finish_setup(AVCodecContext *avctx) {
602     PerThreadContext *p = avctx->internal->thread_ctx;
603 
604     if (!(avctx->active_thread_type&FF_THREAD_FRAME)) return;
605 
606     if (avctx->hwaccel && !p->hwaccel_serializing) {
607         pthread_mutex_lock(&p->parent->hwaccel_mutex);
608         p->hwaccel_serializing = 1;
609     }
610 
611     /* this assumes that no hwaccel calls happen before ff_thread_finish_setup() */
612     if (avctx->hwaccel &&
613         !(avctx->hwaccel->caps_internal & HWACCEL_CAP_ASYNC_SAFE)) {
614         p->async_serializing = 1;
615 
616         async_lock(p->parent);
617     }
618 
619     pthread_mutex_lock(&p->progress_mutex);
620     if(atomic_load(&p->state) == STATE_SETUP_FINISHED){
621         av_log(avctx, AV_LOG_WARNING, "Multiple ff_thread_finish_setup() calls\n");
622     }
623 
624     atomic_store(&p->state, STATE_SETUP_FINISHED);
625 
626     pthread_cond_broadcast(&p->progress_cond);
627     pthread_mutex_unlock(&p->progress_mutex);
628 }
629 
630 /// Waits for all threads to finish.
park_frame_worker_threads(FrameThreadContext * fctx,int thread_count)631 static void park_frame_worker_threads(FrameThreadContext *fctx, int thread_count)
632 {
633     int i;
634 
635     async_unlock(fctx);
636 
637     for (i = 0; i < thread_count; i++) {
638         PerThreadContext *p = &fctx->threads[i];
639 
640         if (atomic_load(&p->state) != STATE_INPUT_READY) {
641             pthread_mutex_lock(&p->progress_mutex);
642             while (atomic_load(&p->state) != STATE_INPUT_READY)
643                 pthread_cond_wait(&p->output_cond, &p->progress_mutex);
644             pthread_mutex_unlock(&p->progress_mutex);
645         }
646         p->got_frame = 0;
647     }
648 
649     async_lock(fctx);
650 }
651 
ff_frame_thread_free(AVCodecContext * avctx,int thread_count)652 void ff_frame_thread_free(AVCodecContext *avctx, int thread_count)
653 {
654     FrameThreadContext *fctx = avctx->internal->thread_ctx;
655     const AVCodec *codec = avctx->codec;
656     int i;
657 
658     park_frame_worker_threads(fctx, thread_count);
659 
660     if (fctx->prev_thread && fctx->prev_thread != fctx->threads)
661         if (update_context_from_thread(fctx->threads->avctx, fctx->prev_thread->avctx, 0) < 0) {
662             av_log(avctx, AV_LOG_ERROR, "Final thread update failed\n");
663             fctx->prev_thread->avctx->internal->is_copy = fctx->threads->avctx->internal->is_copy;
664             fctx->threads->avctx->internal->is_copy = 1;
665         }
666 
667     for (i = 0; i < thread_count; i++) {
668         PerThreadContext *p = &fctx->threads[i];
669 
670         pthread_mutex_lock(&p->mutex);
671         p->die = 1;
672         pthread_cond_signal(&p->input_cond);
673         pthread_mutex_unlock(&p->mutex);
674 
675         if (p->thread_init)
676             pthread_join(p->thread, NULL);
677         p->thread_init=0;
678 
679         if (codec->close && p->avctx)
680             codec->close(p->avctx);
681 
682         release_delayed_buffers(p);
683         av_frame_free(&p->frame);
684     }
685 
686     for (i = 0; i < thread_count; i++) {
687         PerThreadContext *p = &fctx->threads[i];
688 
689         pthread_mutex_destroy(&p->mutex);
690         pthread_mutex_destroy(&p->progress_mutex);
691         pthread_cond_destroy(&p->input_cond);
692         pthread_cond_destroy(&p->progress_cond);
693         pthread_cond_destroy(&p->output_cond);
694         av_packet_unref(&p->avpkt);
695         av_freep(&p->released_buffers);
696 
697         if (i && p->avctx) {
698             av_freep(&p->avctx->priv_data);
699             av_freep(&p->avctx->slice_offset);
700         }
701 
702         if (p->avctx) {
703             av_freep(&p->avctx->internal);
704             av_buffer_unref(&p->avctx->hw_frames_ctx);
705         }
706 
707         av_freep(&p->avctx);
708     }
709 
710     av_freep(&fctx->threads);
711     pthread_mutex_destroy(&fctx->buffer_mutex);
712     pthread_mutex_destroy(&fctx->hwaccel_mutex);
713     pthread_mutex_destroy(&fctx->async_mutex);
714     pthread_cond_destroy(&fctx->async_cond);
715 
716     av_freep(&avctx->internal->thread_ctx);
717 
718     if (avctx->priv_data && avctx->codec && avctx->codec->priv_class)
719         av_opt_free(avctx->priv_data);
720     avctx->codec = NULL;
721 }
722 
ff_frame_thread_init(AVCodecContext * avctx)723 int ff_frame_thread_init(AVCodecContext *avctx)
724 {
725     int thread_count = avctx->thread_count;
726     const AVCodec *codec = avctx->codec;
727     AVCodecContext *src = avctx;
728     FrameThreadContext *fctx;
729     int i, err = 0;
730 
731     if (!thread_count) {
732         int nb_cpus = av_cpu_count();
733 #if FF_API_DEBUG_MV
734         if ((avctx->debug & (FF_DEBUG_VIS_QP | FF_DEBUG_VIS_MB_TYPE)) || avctx->debug_mv)
735             nb_cpus = 1;
736 #endif
737         // use number of cores + 1 as thread count if there is more than one
738         if (nb_cpus > 1)
739             thread_count = avctx->thread_count = FFMIN(nb_cpus + 1, MAX_AUTO_THREADS);
740         else
741             thread_count = avctx->thread_count = 1;
742     }
743 
744     if (thread_count <= 1) {
745         avctx->active_thread_type = 0;
746         return 0;
747     }
748 
749     avctx->internal->thread_ctx = fctx = av_mallocz(sizeof(FrameThreadContext));
750     if (!fctx)
751         return AVERROR(ENOMEM);
752 
753     fctx->threads = av_mallocz_array(thread_count, sizeof(PerThreadContext));
754     if (!fctx->threads) {
755         av_freep(&avctx->internal->thread_ctx);
756         return AVERROR(ENOMEM);
757     }
758 
759     pthread_mutex_init(&fctx->buffer_mutex, NULL);
760     pthread_mutex_init(&fctx->hwaccel_mutex, NULL);
761     pthread_mutex_init(&fctx->async_mutex, NULL);
762     pthread_cond_init(&fctx->async_cond, NULL);
763 
764     fctx->async_lock = 1;
765     fctx->delaying = 1;
766 
767     for (i = 0; i < thread_count; i++) {
768         AVCodecContext *copy = av_malloc(sizeof(AVCodecContext));
769         PerThreadContext *p  = &fctx->threads[i];
770 
771         pthread_mutex_init(&p->mutex, NULL);
772         pthread_mutex_init(&p->progress_mutex, NULL);
773         pthread_cond_init(&p->input_cond, NULL);
774         pthread_cond_init(&p->progress_cond, NULL);
775         pthread_cond_init(&p->output_cond, NULL);
776 
777         p->frame = av_frame_alloc();
778         if (!p->frame) {
779             av_freep(&copy);
780             err = AVERROR(ENOMEM);
781             goto error;
782         }
783 
784         p->parent = fctx;
785         p->avctx  = copy;
786 
787         if (!copy) {
788             err = AVERROR(ENOMEM);
789             goto error;
790         }
791 
792         *copy = *src;
793 
794         copy->internal = av_malloc(sizeof(AVCodecInternal));
795         if (!copy->internal) {
796             copy->priv_data = NULL;
797             err = AVERROR(ENOMEM);
798             goto error;
799         }
800         *copy->internal = *src->internal;
801         copy->internal->thread_ctx = p;
802         copy->internal->last_pkt_props = &p->avpkt;
803 
804         if (!i) {
805             src = copy;
806 
807             if (codec->init)
808                 err = codec->init(copy);
809 
810             update_context_from_thread(avctx, copy, 1);
811         } else {
812             copy->priv_data = av_malloc(codec->priv_data_size);
813             if (!copy->priv_data) {
814                 err = AVERROR(ENOMEM);
815                 goto error;
816             }
817             memcpy(copy->priv_data, src->priv_data, codec->priv_data_size);
818             copy->internal->is_copy = 1;
819 
820             if (codec->init_thread_copy)
821                 err = codec->init_thread_copy(copy);
822         }
823 
824         if (err) goto error;
825 
826         atomic_init(&p->debug_threads, (copy->debug & FF_DEBUG_THREADS) != 0);
827 
828         err = AVERROR(pthread_create(&p->thread, NULL, frame_worker_thread, p));
829         p->thread_init= !err;
830         if(!p->thread_init)
831             goto error;
832     }
833 
834     return 0;
835 
836 error:
837     ff_frame_thread_free(avctx, i+1);
838 
839     return err;
840 }
841 
ff_thread_flush(AVCodecContext * avctx)842 void ff_thread_flush(AVCodecContext *avctx)
843 {
844     int i;
845     FrameThreadContext *fctx = avctx->internal->thread_ctx;
846 
847     if (!fctx) return;
848 
849     park_frame_worker_threads(fctx, avctx->thread_count);
850     if (fctx->prev_thread) {
851         if (fctx->prev_thread != &fctx->threads[0])
852             update_context_from_thread(fctx->threads[0].avctx, fctx->prev_thread->avctx, 0);
853     }
854 
855     fctx->next_decoding = fctx->next_finished = 0;
856     fctx->delaying = 1;
857     fctx->prev_thread = NULL;
858     for (i = 0; i < avctx->thread_count; i++) {
859         PerThreadContext *p = &fctx->threads[i];
860         // Make sure decode flush calls with size=0 won't return old frames
861         p->got_frame = 0;
862         av_frame_unref(p->frame);
863         p->result = 0;
864 
865         release_delayed_buffers(p);
866 
867         if (avctx->codec->flush)
868             avctx->codec->flush(p->avctx);
869     }
870 }
871 
ff_thread_can_start_frame(AVCodecContext * avctx)872 int ff_thread_can_start_frame(AVCodecContext *avctx)
873 {
874     PerThreadContext *p = avctx->internal->thread_ctx;
875     if ((avctx->active_thread_type&FF_THREAD_FRAME) && atomic_load(&p->state) != STATE_SETTING_UP &&
876         (avctx->codec->update_thread_context || !THREAD_SAFE_CALLBACKS(avctx))) {
877         return 0;
878     }
879     return 1;
880 }
881 
thread_get_buffer_internal(AVCodecContext * avctx,ThreadFrame * f,int flags)882 static int thread_get_buffer_internal(AVCodecContext *avctx, ThreadFrame *f, int flags)
883 {
884     PerThreadContext *p = avctx->internal->thread_ctx;
885     int err;
886 
887     f->owner[0] = f->owner[1] = avctx;
888 
889     if (!(avctx->active_thread_type & FF_THREAD_FRAME))
890         return ff_get_buffer(avctx, f->f, flags);
891 
892     if (atomic_load(&p->state) != STATE_SETTING_UP &&
893         (avctx->codec->update_thread_context || !THREAD_SAFE_CALLBACKS(avctx))) {
894         av_log(avctx, AV_LOG_ERROR, "get_buffer() cannot be called after ff_thread_finish_setup()\n");
895         return -1;
896     }
897 
898     if (avctx->internal->allocate_progress) {
899         atomic_int *progress;
900         f->progress = av_buffer_alloc(2 * sizeof(*progress));
901         if (!f->progress) {
902             return AVERROR(ENOMEM);
903         }
904         progress = (atomic_int*)f->progress->data;
905 
906         atomic_init(&progress[0], -1);
907         atomic_init(&progress[1], -1);
908     }
909 
910     pthread_mutex_lock(&p->parent->buffer_mutex);
911     if (THREAD_SAFE_CALLBACKS(avctx)) {
912         err = ff_get_buffer(avctx, f->f, flags);
913     } else {
914         pthread_mutex_lock(&p->progress_mutex);
915         p->requested_frame = f->f;
916         p->requested_flags = flags;
917         atomic_store_explicit(&p->state, STATE_GET_BUFFER, memory_order_release);
918         pthread_cond_broadcast(&p->progress_cond);
919 
920         while (atomic_load(&p->state) != STATE_SETTING_UP)
921             pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
922 
923         err = p->result;
924 
925         pthread_mutex_unlock(&p->progress_mutex);
926 
927     }
928     if (!THREAD_SAFE_CALLBACKS(avctx) && !avctx->codec->update_thread_context)
929         ff_thread_finish_setup(avctx);
930     if (err)
931         av_buffer_unref(&f->progress);
932 
933     pthread_mutex_unlock(&p->parent->buffer_mutex);
934 
935     return err;
936 }
937 
ff_thread_get_format(AVCodecContext * avctx,const enum AVPixelFormat * fmt)938 enum AVPixelFormat ff_thread_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt)
939 {
940     enum AVPixelFormat res;
941     PerThreadContext *p = avctx->internal->thread_ctx;
942     if (!(avctx->active_thread_type & FF_THREAD_FRAME) || avctx->thread_safe_callbacks ||
943         avctx->get_format == avcodec_default_get_format)
944         return ff_get_format(avctx, fmt);
945     if (atomic_load(&p->state) != STATE_SETTING_UP) {
946         av_log(avctx, AV_LOG_ERROR, "get_format() cannot be called after ff_thread_finish_setup()\n");
947         return -1;
948     }
949     pthread_mutex_lock(&p->progress_mutex);
950     p->available_formats = fmt;
951     atomic_store(&p->state, STATE_GET_FORMAT);
952     pthread_cond_broadcast(&p->progress_cond);
953 
954     while (atomic_load(&p->state) != STATE_SETTING_UP)
955         pthread_cond_wait(&p->progress_cond, &p->progress_mutex);
956 
957     res = p->result_format;
958 
959     pthread_mutex_unlock(&p->progress_mutex);
960 
961     return res;
962 }
963 
ff_thread_get_buffer(AVCodecContext * avctx,ThreadFrame * f,int flags)964 int ff_thread_get_buffer(AVCodecContext *avctx, ThreadFrame *f, int flags)
965 {
966     int ret = thread_get_buffer_internal(avctx, f, flags);
967     if (ret < 0)
968         av_log(avctx, AV_LOG_ERROR, "thread_get_buffer() failed\n");
969     return ret;
970 }
971 
ff_thread_release_buffer(AVCodecContext * avctx,ThreadFrame * f)972 void ff_thread_release_buffer(AVCodecContext *avctx, ThreadFrame *f)
973 {
974     PerThreadContext *p = avctx->internal->thread_ctx;
975     FrameThreadContext *fctx;
976     AVFrame *dst, *tmp;
977     int can_direct_free = !(avctx->active_thread_type & FF_THREAD_FRAME) ||
978                           THREAD_SAFE_CALLBACKS(avctx);
979 
980     if (!f->f || !f->f->buf[0])
981         return;
982 
983     if (avctx->debug & FF_DEBUG_BUFFERS)
984         av_log(avctx, AV_LOG_DEBUG, "thread_release_buffer called on pic %p\n", f);
985 
986     av_buffer_unref(&f->progress);
987     f->owner[0] = f->owner[1] = NULL;
988 
989     if (can_direct_free) {
990         av_frame_unref(f->f);
991         return;
992     }
993 
994     fctx = p->parent;
995     pthread_mutex_lock(&fctx->buffer_mutex);
996 
997     if (p->num_released_buffers + 1 >= INT_MAX / sizeof(*p->released_buffers))
998         goto fail;
999     tmp = av_fast_realloc(p->released_buffers, &p->released_buffers_allocated,
1000                           (p->num_released_buffers + 1) *
1001                           sizeof(*p->released_buffers));
1002     if (!tmp)
1003         goto fail;
1004     p->released_buffers = tmp;
1005 
1006     dst = &p->released_buffers[p->num_released_buffers];
1007     av_frame_move_ref(dst, f->f);
1008 
1009     p->num_released_buffers++;
1010 
1011 fail:
1012     pthread_mutex_unlock(&fctx->buffer_mutex);
1013 }
1014