#include "config.h"
#include <stdatomic.h>
#include <stdint.h>
#include "avcodec.h"
#include "codec_internal.h"
#include "hwconfig.h"
#include "internal.h"
#include "pthread_internal.h"
#include "thread.h"
#include "threadframe.h"
#include "version_major.h"
#include "libavutil/avassert.h"
#include "libavutil/buffer.h"
#include "libavutil/common.h"
#include "libavutil/cpu.h"
#include "libavutil/frame.h"
#include "libavutil/internal.h"
#include "libavutil/log.h"
#include "libavutil/mem.h"
#include "libavutil/opt.h"
#include "libavutil/thread.h"

Data Structures
struct	PerThreadContext
	Context used by codec threads and stored in their AVCodecInternal thread_ctx. More...

struct	FrameThreadContext
	Context stored in the client AVCodecInternal thread_ctx. More...

Macros
#define	THREAD_SAFE_CALLBACKS(avctx) ((avctx)->thread_safe_callbacks \|\| (avctx)->get_buffer2 == avcodec_default_get_buffer2)

#define	OFF(member) offsetof(FrameThreadContext, member)

#define	OFF(member) offsetof(PerThreadContext, member)

Enumerations
enum	{ STATE_INPUT_READY, STATE_SETTING_UP, STATE_GET_BUFFER, STATE_GET_FORMAT, STATE_SETUP_FINISHED }

enum	{ UNINITIALIZED, NEEDS_CLOSE, INITIALIZED }

Functions
static void	async_lock (FrameThreadContext *fctx)

static void	async_unlock (FrameThreadContext *fctx)

static attribute_align_arg void *	frame_worker_thread (void *arg)
	Codec worker thread. More...

static int	update_context_from_thread (AVCodecContext dst, AVCodecContext src, int for_user)
	Update the next thread's AVCodecContext with values from the reference thread's context. More...

static int	update_context_from_user (AVCodecContext dst, AVCodecContext src)
	Update the next thread's AVCodecContext with values set by the user. More...

static void	release_delayed_buffers (PerThreadContext *p)
	Releases the buffers that this decoding thread was the last user of. More...

static int	submit_packet (PerThreadContext p, AVCodecContext user_avctx, AVPacket *avpkt)

int	ff_thread_decode_frame (AVCodecContext avctx, AVFrame picture, int got_picture_ptr, AVPacket avpkt)
	Submit a new frame to a decoding thread. More...

void	ff_thread_report_progress (ThreadFrame *f, int n, int field)
	Notify later decoding threads when part of their reference picture is ready. More...

void	ff_thread_await_progress (ThreadFrame *f, int n, int field)
	Wait for earlier decoding threads to finish reference pictures. More...

void	ff_thread_finish_setup (AVCodecContext *avctx)
	If the codec defines update_thread_context(), call this when they are ready for the next thread to start decoding the next frame. More...

static void	park_frame_worker_threads (FrameThreadContext *fctx, int thread_count)
	Waits for all threads to finish. More...

	DEFINE_OFFSET_ARRAY (FrameThreadContext, thread_ctx, pthread_init_cnt,(OFF(buffer_mutex), OFF(hwaccel_mutex), OFF(async_mutex)),(OFF(async_cond)))

	DEFINE_OFFSET_ARRAY (PerThreadContext, per_thread, pthread_init_cnt,(OFF(progress_mutex), OFF(mutex)),(OFF(input_cond), OFF(progress_cond), OFF(output_cond)))

void	ff_frame_thread_free (AVCodecContext *avctx, int thread_count)

static av_cold int	init_thread (PerThreadContext p, int threads_to_free, FrameThreadContext fctx, AVCodecContext avctx, const FFCodec *codec, int first)

int	ff_frame_thread_init (AVCodecContext *avctx)

void	ff_thread_flush (AVCodecContext *avctx)
	Wait for decoding threads to finish and reset internal state. More...

int	ff_thread_can_start_frame (AVCodecContext *avctx)

static int	thread_get_buffer_internal (AVCodecContext avctx, AVFrame f, int flags)

FF_DISABLE_DEPRECATION_WARNINGS enum AVPixelFormat	ff_thread_get_format (AVCodecContext avctx, const enum AVPixelFormat fmt)
	Wrapper around get_format() for frame-multithreaded codecs. More...

FF_ENABLE_DEPRECATION_WARNINGS int	ff_thread_get_buffer (AVCodecContext avctx, AVFrame f, int flags)
	Wrapper around get_buffer() for frame-multithreaded codecs. More...

int	ff_thread_get_ext_buffer (AVCodecContext avctx, ThreadFrame f, int flags)
	Wrapper around ff_get_buffer() for frame-multithreaded codecs. More...

void	ff_thread_release_buffer (AVCodecContext avctx, AVFrame f)
	Wrapper around release_buffer() frame-for multithreaded codecs. More...

void	ff_thread_release_ext_buffer (AVCodecContext avctx, ThreadFrame f)
	Unref a ThreadFrame. More...

Detailed Description

Frame multithreading support functions

See also: doc/multithreading.txt

Definition in file pthread_frame.c.

Macro Definition Documentation

◆ THREAD_SAFE_CALLBACKS

#define THREAD_SAFE_CALLBACKS ( avctx ) ((avctx)->thread_safe_callbacks || (avctx)->get_buffer2 == avcodec_default_get_buffer2)

Definition at line 153 of file pthread_frame.c.

◆ OFF [1/2]

#define OFF ( member ) offsetof(FrameThreadContext, member)

Definition at line 696 of file pthread_frame.c.

◆ OFF [2/2]

#define OFF ( member ) offsetof(PerThreadContext, member)

Definition at line 696 of file pthread_frame.c.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
STATE_INPUT_READY	Set when the thread is awaiting a packet. Set before the codec has called ff_thread_finish_setup().
STATE_SETTING_UP
STATE_GET_BUFFER	Set when the codec calls get_buffer(). State is returned to STATE_SETTING_UP afterwards.
STATE_GET_FORMAT	Set when the codec calls get_format(). State is returned to STATE_SETTING_UP afterwards. Set after the codec has called ff_thread_finish_setup().
STATE_SETUP_FINISHED

Definition at line 50 of file pthread_frame.c.

◆ anonymous enum

anonymous enum

Enumerator
UNINITIALIZED	Thread has not been created, AVCodec->close mustn't be called.
NEEDS_CLOSE	FFCodec->close needs to be called.
INITIALIZED	Thread has been properly set up.

Definition at line 69 of file pthread_frame.c.

Function Documentation

◆ async_lock()

static void async_lock ( FrameThreadContext * fctx )

static

Definition at line 157 of file pthread_frame.c.

Referenced by ff_thread_decode_frame(), ff_thread_finish_setup(), and park_frame_worker_threads().

◆ async_unlock()

static void async_unlock ( FrameThreadContext * fctx )

static

Definition at line 166 of file pthread_frame.c.

Referenced by ff_thread_decode_frame(), frame_worker_thread(), and park_frame_worker_threads().

◆ frame_worker_thread()

static attribute_align_arg void* frame_worker_thread ( void * arg )

static

Codec worker thread.

Automatically calls ff_thread_finish_setup() if the codec does not provide an update_thread_context method, or if the codec returns before calling it.

Definition at line 182 of file pthread_frame.c.

Referenced by init_thread().

◆ update_context_from_thread()

static int update_context_from_thread	(	AVCodecContext *	dst,
		AVCodecContext *	src,
		int	for_user
	)

static

Update the next thread's AVCodecContext with values from the reference thread's context.

Parameters

dst	The destination context.
src	The source context.
for_user	0 if the destination is a codec thread, 1 if the destination is the user's thread

Returns: 0 on success, negative error code on failure

Definition at line 261 of file pthread_frame.c.

Referenced by ff_frame_thread_free(), ff_thread_decode_frame(), ff_thread_flush(), init_thread(), and submit_packet().

◆ update_context_from_user()

static int update_context_from_user	(	AVCodecContext *	dst,
		AVCodecContext *	src
	)

static

Update the next thread's AVCodecContext with values set by the user.

Parameters

dst	The destination context.
src	The source context.

Returns: 0 on success, negative error code on failure

Definition at line 349 of file pthread_frame.c.

Referenced by submit_packet().

◆ release_delayed_buffers()

static void release_delayed_buffers ( PerThreadContext * p )

static

Releases the buffers that this decoding thread was the last user of.

Definition at line 391 of file pthread_frame.c.

Referenced by ff_frame_thread_free(), ff_thread_flush(), and submit_packet().

◆ submit_packet()

static int submit_packet	(	PerThreadContext *	p,
		AVCodecContext *	user_avctx,
		AVPacket *	avpkt
	)

static

Definition at line 412 of file pthread_frame.c.

Referenced by ff_thread_decode_frame().

◆ ff_thread_decode_frame()

int ff_thread_decode_frame	(	AVCodecContext *	avctx,
		AVFrame *	picture,
		int *	got_picture_ptr,
		AVPacket *	avpkt
	)

Submit a new frame to a decoding thread.

Returns the next available frame in picture. *got_picture_ptr will be 0 if none is available. The return value on success is the size of the consumed packet for compatibility with FFCodec.decode. This means the decoder has to consume the full packet.

Parameters are the same as FFCodec.decode.

Definition at line 510 of file pthread_frame.c.

Referenced by decode_simple_internal().

◆ ff_thread_report_progress()

void ff_thread_report_progress	(	ThreadFrame *	f,
		int	progress,
		int	field
	)

Notify later decoding threads when part of their reference picture is ready.

Call this when some part of the picture is finished decoding. Later calls with lower values of progress have no effect.

Parameters

f	The picture being decoded.
progress	Value, in arbitrary units, of how much of the picture has decoded.
field	The field being decoded, for field-picture codecs. 0 for top field or frame pictures, 1 for bottom field.

Definition at line 595 of file pthread_frame.c.

Referenced by decode(), decode_finish_row(), decode_frame(), decode_frame_common(), decode_nal_units(), decode_slice(), decode_tiles(), ff_h264_field_end(), ff_h264_queue_decode_slice(), ff_hevc_hls_filter(), ff_mpv_frame_end(), ff_mpv_frame_start(), ff_mpv_report_decode_progress(), ff_rv34_decode_frame(), finish_frame(), generate_missing_ref(), h264_field_start(), mimic_decode_frame(), rv34_decode_slice(), vp3_draw_horiz_band(), vp78_decode_frame(), vp78_decode_mb_row_sliced(), vp9_decode_frame(), and wavpack_decode_frame().

◆ ff_thread_await_progress()

void ff_thread_await_progress	(	ThreadFrame *	f,
		int	progress,
		int	field
	)

Wait for earlier decoding threads to finish reference pictures.

Call this before accessing some part of a picture, with a given value for progress, and it will return after the responsible decoding thread calls ff_thread_report_progress() with the same or higher value for progress.

Parameters

f	The picture being referenced.
progress	Value, in arbitrary units, to wait for.
field	The field being referenced, for field-picture codecs. 0 for top field or frame pictures, 1 for bottom field.

Definition at line 618 of file pthread_frame.c.

◆ ff_thread_finish_setup()

void ff_thread_finish_setup ( AVCodecContext * avctx )

If the codec defines update_thread_context(), call this when they are ready for the next thread to start decoding the next frame.

After calling it, do not change any variables read by the update_thread_context() method, or call ff_thread_get_buffer().

Parameters

avctx The context.

Definition at line 639 of file pthread_frame.c.

Referenced by frame_worker_thread(), and thread_get_buffer_internal().

◆ park_frame_worker_threads()

static void park_frame_worker_threads	(	FrameThreadContext *	fctx,
		int	thread_count
	)

static

Waits for all threads to finish.

Definition at line 669 of file pthread_frame.c.

Referenced by ff_frame_thread_free(), and ff_thread_flush().

◆ DEFINE_OFFSET_ARRAY() [1/2]

DEFINE_OFFSET_ARRAY	(	FrameThreadContext	,
		thread_ctx	,
		pthread_init_cnt	,
		(OFF(buffer_mutex), OFF(hwaccel_mutex), OFF(async_mutex))	,
		(OFF(async_cond))
	)

◆ DEFINE_OFFSET_ARRAY() [2/2]

DEFINE_OFFSET_ARRAY	(	PerThreadContext	,
		per_thread	,
		pthread_init_cnt	,
		(OFF(progress_mutex), OFF(mutex))	,
		(OFF(input_cond), OFF(progress_cond), OFF(output_cond))
	)

◆ ff_frame_thread_free()

void ff_frame_thread_free	(	AVCodecContext *	avctx,
		int	thread_count
	)

Definition at line 702 of file pthread_frame.c.

Referenced by ff_frame_thread_init(), and ff_thread_free().

◆ init_thread()

static av_cold int init_thread	(	PerThreadContext *	p,
		int *	threads_to_free,
		FrameThreadContext *	fctx,
		AVCodecContext *	avctx,
		const FFCodec *	codec,
		int	first
	)

static

Definition at line 766 of file pthread_frame.c.

Referenced by ff_frame_thread_init().

◆ ff_frame_thread_init()

int ff_frame_thread_init ( AVCodecContext * avctx )

Definition at line 842 of file pthread_frame.c.

Referenced by ff_thread_init().

◆ ff_thread_flush()

void ff_thread_flush ( AVCodecContext * avctx )

Wait for decoding threads to finish and reset internal state.

Called by avcodec_flush_buffers().

Parameters

avctx The context.

Definition at line 902 of file pthread_frame.c.

Referenced by avcodec_flush_buffers().

◆ ff_thread_can_start_frame()

int ff_thread_can_start_frame ( AVCodecContext * avctx )

Definition at line 934 of file pthread_frame.c.

◆ thread_get_buffer_internal()

static int thread_get_buffer_internal	(	AVCodecContext *	avctx,
		AVFrame *	f,
		int	flags
	)

static

Definition at line 950 of file pthread_frame.c.

Referenced by ff_thread_get_buffer().

◆ ff_thread_get_format()

FF_DISABLE_DEPRECATION_WARNINGS enum AVPixelFormat ff_thread_get_format	(	AVCodecContext *	avctx,
		const enum AVPixelFormat *	fmt
	)

Wrapper around get_format() for frame-multithreaded codecs.

Call this function instead of avctx->get_format(). Cannot be called after the codec has called ff_thread_finish_setup().

Parameters

avctx	The current context.
fmt	The list of available formats.

Definition at line 1005 of file pthread_frame.c.

Referenced by decode_frame_header(), get_format(), get_pixel_format(), mpeg_get_pixelformat(), and update_size().

◆ ff_thread_get_buffer()

FF_ENABLE_DEPRECATION_WARNINGS int ff_thread_get_buffer	(	AVCodecContext *	avctx,
		AVFrame *	f,
		int	flags
	)

Wrapper around get_buffer() for frame-multithreaded codecs.

Call this function instead of ff_get_buffer(f). Cannot be called after the codec has called ff_thread_finish_setup().

Parameters

avctx	The current context.
f	The frame to write into.

Definition at line 1035 of file pthread_frame.c.

Referenced by ff_thread_get_ext_buffer().

◆ ff_thread_get_ext_buffer()

int ff_thread_get_ext_buffer	(	AVCodecContext *	avctx,
		ThreadFrame *	f,
		int	flags
	)

Wrapper around ff_get_buffer() for frame-multithreaded codecs.

Call this function instead of ff_get_buffer() if you might need to wait for progress on this frame. Cannot be called after the codec has called ff_thread_finish_setup().

Parameters

avctx	The current context.
f	The frame to write into.

Note: : It is fine to call this with codecs that do not support frame threading.

Definition at line 1043 of file pthread_frame.c.

Referenced by alloc_frame(), alloc_frame_buffer(), alloc_picture(), decode_frame(), decode_idat_chunk(), mimic_decode_frame(), vp8_alloc_frame(), vp9_frame_alloc(), and wavpack_decode_block().

◆ ff_thread_release_buffer()

void ff_thread_release_buffer	(	AVCodecContext *	avctx,
		AVFrame *	f
	)

Wrapper around release_buffer() frame-for multithreaded codecs.

Call this function instead of avctx->release_buffer(f). The AVFrame will be copied and the actual release_buffer() call will be performed later. The contents of data pointed to by the AVFrame should not be changed until ff_thread_get_buffer() is called on it.

Parameters

avctx	The current context.
f	The picture being released.

Definition at line 1074 of file pthread_frame.c.

Referenced by av1_frame_unref(), ff_h264_replace_picture(), ff_h264_unref_picture(), ff_hevc_unref_frame(), ff_thread_release_ext_buffer(), frame_worker_thread(), vaapi_av1_decode_uninit(), and vaapi_av1_end_frame().

◆ ff_thread_release_ext_buffer()

void ff_thread_release_ext_buffer	(	AVCodecContext *	avctx,
		ThreadFrame *	f
	)

Unref a ThreadFrame.

This is basically a wrapper around av_frame_unref() and should be called instead of it.

Parameters

avctx	The current context.
f	The picture being released.

Definition at line 1141 of file pthread_frame.c.

Referenced by decode_frame(), decode_idat_chunk(), ff_ffv1_close(), ff_h264_replace_picture(), ff_h264_unref_picture(), ff_hevc_unref_frame(), ff_mpeg_unref_picture(), h264_field_start(), mimic_decode_end(), mimic_decode_frame(), png_dec_end(), update_frames(), vp3_decode_flush(), vp8_alloc_frame(), vp8_release_frame(), vp9_decode_flush(), vp9_decode_frame(), vp9_decode_free(), vp9_frame_unref(), wavpack_decode_block(), wavpack_decode_end(), and wavpack_decode_frame().

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ THREAD_SAFE_CALLBACKS

◆ OFF [1/2]

◆ OFF [2/2]

Enumeration Type Documentation

◆ anonymous enum

◆ anonymous enum

Function Documentation

◆ async_lock()

◆ async_unlock()

◆ frame_worker_thread()

◆ update_context_from_thread()

◆ update_context_from_user()

◆ release_delayed_buffers()

◆ submit_packet()

◆ ff_thread_decode_frame()

◆ ff_thread_report_progress()

◆ ff_thread_await_progress()

◆ ff_thread_finish_setup()

◆ park_frame_worker_threads()

◆ DEFINE_OFFSET_ARRAY() [1/2]

◆ DEFINE_OFFSET_ARRAY() [2/2]

◆ ff_frame_thread_free()

◆ init_thread()

◆ ff_frame_thread_init()

◆ ff_thread_flush()

◆ ff_thread_can_start_frame()

◆ thread_get_buffer_internal()

◆ ff_thread_get_format()

◆ ff_thread_get_buffer()

◆ ff_thread_get_ext_buffer()

◆ ff_thread_release_buffer()

◆ ff_thread_release_ext_buffer()