FFmpeg
Data Structures | Macros | Enumerations | Functions
pthread_frame.c File Reference
#include <stdatomic.h>
#include "avcodec.h"
#include "avcodec_internal.h"
#include "codec_desc.h"
#include "codec_internal.h"
#include "decode.h"
#include "hwaccel_internal.h"
#include "hwconfig.h"
#include "internal.h"
#include "pthread_internal.h"
#include "refstruct.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"

Go to the source code of this file.

Data Structures

struct  ThreadFrameProgress
 
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 OFF(member)   offsetof(FrameThreadContext, member)
 
#define OFF(member)   offsetof(PerThreadContext, member)
 

Enumerations

enum  { STATE_INPUT_READY, STATE_SETTING_UP, STATE_SETUP_FINISHED }
 
enum  { UNINITIALIZED, NEEDS_CLOSE, INITIALIZED }
 

Functions

static int hwaccel_serial (const AVCodecContext *avctx)
 
static void async_lock (FrameThreadContext *fctx)
 
static void async_unlock (FrameThreadContext *fctx)
 
static void thread_set_name (PerThreadContext *p)
 
static attribute_align_arg void * frame_worker_thread (void *arg)
 Codec worker thread. More...
 
static int update_context_from_thread (AVCodecContext *dst, const 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, const AVCodecContext *src)
 Update the next thread's AVCodecContext with values set by the user. 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 (const 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)
 
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_ext_buffer (ThreadFrame *f)
 Unref a ThreadFrame. More...
 
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. More...
 

Detailed Description

Frame multithreading support functions

See also
doc/multithreading.txt

Definition in file pthread_frame.c.

Macro Definition Documentation

◆ OFF [1/2]

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

Definition at line 694 of file pthread_frame.c.

◆ OFF [2/2]

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

Definition at line 694 of file pthread_frame.c.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
STATE_INPUT_READY 

Set when the thread is awaiting a packet.

STATE_SETTING_UP 

Set before the codec has called ff_thread_finish_setup().

STATE_SETUP_FINISHED 

Set after the codec has called ff_thread_finish_setup().

Definition at line 52 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 61 of file pthread_frame.c.

Function Documentation

◆ hwaccel_serial()

static int hwaccel_serial ( const AVCodecContext avctx)
static

Definition at line 149 of file pthread_frame.c.

Referenced by ff_thread_finish_setup(), and frame_worker_thread().

◆ async_lock()

static void async_lock ( FrameThreadContext fctx)
static

◆ async_unlock()

static void async_unlock ( FrameThreadContext fctx)
static

◆ thread_set_name()

static void thread_set_name ( PerThreadContext p)
static

Definition at line 172 of file pthread_frame.c.

Referenced by frame_worker_thread().

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

Referenced by init_thread().

◆ update_context_from_thread()

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

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

Parameters
dstThe destination context.
srcThe source context.
for_user0 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 277 of file pthread_frame.c.

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

◆ update_context_from_user()

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

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

Parameters
dstThe destination context.
srcThe source context.
Returns
0 on success, negative error code on failure

Definition at line 398 of file pthread_frame.c.

Referenced by submit_packet().

◆ submit_packet()

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

Definition at line 428 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 492 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
fThe picture being decoded.
progressValue, in arbitrary units, of how much of the picture has decoded.
fieldThe field being decoded, for field-picture codecs. 0 for top field or frame pictures, 1 for bottom field.

Definition at line 577 of file pthread_frame.c.

Referenced by alloc_dummy_frame(), decode_finish_row(), decode_nal_units(), ff_h264_field_end(), ff_h264_queue_decode_slice(), ff_mpv_frame_end(), ff_mpv_report_decode_progress(), ff_rv34_decode_frame(), finish_frame(), h264_field_start(), and rv34_decode_slice().

◆ ff_thread_await_progress()

void ff_thread_await_progress ( const 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
fThe picture being referenced.
progressValue, in arbitrary units, to wait for.
fieldThe field being referenced, for field-picture codecs. 0 for top field or frame pictures, 1 for bottom field.

Definition at line 600 of file pthread_frame.c.

Referenced by await_reference_mb_row(), await_references(), ff_er_frame_end(), guess_mv(), h264_field_start(), is_intra_more_likely(), mpeg4_decode_mb(), mpv_reconstruct_mb_internal(), rv34_decode_mv(), and rv34_mc().

◆ 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
avctxThe context.

Definition at line 621 of file pthread_frame.c.

Referenced by frame_worker_thread().

◆ 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 667 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 700 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 763 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 862 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
avctxThe context.

Definition at line 922 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 950 of file pthread_frame.c.

Referenced by ff_mpv_frame_start(), and h264_frame_start().

◆ thread_get_buffer_internal()

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

Definition at line 963 of file pthread_frame.c.

Referenced by ff_thread_get_buffer().

◆ ff_thread_get_buffer()

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

◆ 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
avctxThe current context.
fThe frame to write into.
Note
: It is fine to call this with codecs that do not support frame threading.

Definition at line 994 of file pthread_frame.c.

Referenced by alloc_picture().

◆ ff_thread_release_ext_buffer()

void ff_thread_release_ext_buffer ( ThreadFrame f)

Unref a ThreadFrame.

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

Parameters
avctxThe current context.
fThe picture being released.

Definition at line 1020 of file pthread_frame.c.

Referenced by ff_h264_unref_picture(), ff_mpeg_unref_picture(), and h264_field_start().

◆ 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
avctxan AVCodecContext
offsetoffset of the RefStruct reference in avctx's private data
Return values
FF_THREAD_IS_COPYif 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_THREADif frame-threading is in use and the calling thread is the main thread.
FF_THREAD_NO_FRAME_THREADINGif frame-threading is not in use.

Definition at line 1028 of file pthread_frame.c.