thread.h File Reference

Multithreading API for decoders. More...

#include "libavutil/buffer.h"
#include "avcodec.h"

Go to the source code of this file.

Enumerations
enum	ThreadingStatus { FF_THREAD_IS_COPY , FF_THREAD_IS_FIRST_THREAD , FF_THREAD_NO_FRAME_THREADING }

Functions
int	ff_thread_can_start_frame (AVCodecContext *avctx)
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.
int	ff_thread_get_buffer (AVCodecContext *avctx, AVFrame *f, int flags)
	Wrapper around get_buffer() for frame-multithreaded codecs.
int	ff_slice_thread_execute_with_mainfunc (AVCodecContext *avctx, int(*action_func2)(AVCodecContext *c, void *arg, int jobnr, int threadnr), int(*main_func)(AVCodecContext *c), void *arg, int *ret, int job_count)
enum ThreadingStatus	ff_thread_sync_ref (AVCodecContext *avctx, size_t offset)
	Allows to synchronize objects whose lifetime is the whole decoding process among all frame threads.

Detailed Description

Multithreading API for decoders.

Author

Alexander Strange astra.nosp@m.nge@.nosp@m.ithin.nosp@m.ksw..nosp@m.com

Definition in file thread.h.

Enumeration Type Documentation

ThreadingStatus

enum ThreadingStatus

Enumerator
FF_THREAD_IS_COPY
FF_THREAD_IS_FIRST_THREAD
FF_THREAD_NO_FRAME_THREADING

Definition at line 60 of file thread.h.

Function Documentation

ff_thread_can_start_frame()

int ff_thread_can_start_frame

(

AVCodecContext *

avctx

)

Definition at line 1001 of file pthread_frame.c.

Referenced by ff_mpv_frame_start(), and h264_frame_start().

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 665 of file pthread_frame.c.

Referenced by apv_decode(), cfhd_decode(), decode_frame(), decode_frame(), decode_idat_chunk(), decode_nal_units(), ff_h263_decode_frame(), ff_rv34_decode_frame(), frame_worker_thread(), hevc_frame_start(), mimic_decode_frame(), tak_decode_frame(), vp3_decode_frame(), vp78_decode_frame(), vp9_decode_frame(), and wavpack_decode_block().

ff_thread_get_buffer()

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 1037 of file pthread_frame.c.

Referenced by aic_decode_frame(), alloc_frame(), alloc_frame(), alloc_picture(), alloc_picture(), apv_decode(), bitpacked_decode_yuv422p10(), cfhd_decode(), check_film_grain(), cllc_decode_frame(), cri_decode_frame(), decode_blocks(), decode_element(), decode_entropy_coded_image(), decode_frame(), decode_frame(), decode_frame(), decode_frame(), decode_frame(), decode_frame(), decode_frame(), decode_frame(), decode_frame(), decode_frame(), decode_frame(), decode_frame(), decode_frame(), decode_idat_chunk(), dnxhd_decode_frame(), dvvideo_decode_frame(), dxtory_decode_v1_410(), dxtory_decode_v1_420(), dxtory_decode_v1_444(), dxtory_decode_v1_rgb(), dxtory_decode_v2(), dxv_decode(), ff_progress_frame_get_buffer(), ff_thread_get_ext_buffer(), flac_decode_frame(), hap_decode(), hdr_decode_frame(), hevc_frame_start(), hqx_decode_frame(), init_image(), jpeg2000_decode_frame(), lag_decode_frame(), magy_decode_frame(), photocd_decode_frame(), pixlet_decode_frame(), qoi_decode_frame(), speedhq_decode_frame(), tak_decode_frame(), tta_decode_frame(), vaapi_av1_start_frame(), vble_decode_frame(), wavpack_decode_block(), and wbmp_decode_frame().

ff_slice_thread_execute_with_mainfunc()

int ff_slice_thread_execute_with_mainfunc	(	AVCodecContext *	avctx,
		int(*	action_func2 )(AVCodecContext *c, void *arg, int jobnr, int threadnr),
		int(*	main_func )(AVCodecContext *c),
		void *	arg,
		int *	ret,
		int	job_count )

ff_thread_sync_ref()

enum ThreadingStatus ff_thread_sync_ref	(	AVCodecContext *	avctx,
		size_t	offset )

Allows to synchronize objects whose lifetime is the whole decoding process among all frame threads.

When called from a non-copy thread, do nothing. When called from another thread, place a new RefStruct reference at the given offset in the calling thread's private data from the RefStruct reference in the private data of the first decoding thread. The first thread must have a valid RefStruct reference at the given offset in its private data; the calling thread must not have a reference at this offset in its private data (must be NULL).

Parameters

avctx	an AVCodecContext
offset	offset of the RefStruct reference in avctx's private data

Return values

FF_THREAD_IS_COPY	if frame-threading is in use and the calling thread is a copy; in this case, the RefStruct reference will be set.
FF_THREAD_IS_MAIN_THREAD	if frame-threading is in use and the calling thread is the main thread.
FF_THREAD_NO_FRAME_THREADING	if frame-threading is not in use.

Definition at line 1990 of file decode.c.

Referenced by ff_mpv_decode_init(), vp3_decode_init(), and wavpack_decode_init().