FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Typedefs | Functions
thread.h File Reference

Multithreading support functions. More...

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

Go to the source code of this file.

Data Structures

struct  ThreadFrame
 

Typedefs

typedef struct ThreadFrame ThreadFrame
 

Functions

void ff_thread_flush (AVCodecContext *avctx)
 Wait for decoding threads to finish and reset internal state.
 
int ff_thread_decode_frame (AVCodecContext *avctx, AVFrame *picture, int *got_picture_ptr, AVPacket *avpkt)
 Submit a new frame to a decoding thread.
 
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.
 
void ff_thread_report_progress (ThreadFrame *f, int progress, int field)
 Notify later decoding threads when part of their reference picture is ready.
 
void ff_thread_await_progress (ThreadFrame *f, int progress, int field)
 Wait for earlier decoding threads to finish reference pictures.
 
enum AVPixelFormat ff_thread_get_format (AVCodecContext *avctx, const enum AVPixelFormat *fmt)
 Wrapper around get_format() for frame-multithreaded codecs.
 
int ff_thread_get_buffer (AVCodecContext *avctx, ThreadFrame *f, int flags)
 Wrapper around get_buffer() for frame-multithreaded codecs.
 
void ff_thread_release_buffer (AVCodecContext *avctx, ThreadFrame *f)
 Wrapper around release_buffer() frame-for multithreaded codecs.
 
int ff_thread_ref_frame (ThreadFrame *dst, ThreadFrame *src)
 
int ff_thread_init (AVCodecContext *s)
 
void ff_thread_free (AVCodecContext *s)
 

Detailed Description

Multithreading support functions.

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

Definition in file thread.h.

Typedef Documentation

typedef struct ThreadFrame ThreadFrame

Function Documentation

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 931 of file pthread.c.

Referenced by avcodec_flush_buffers().

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 avcodec_decode_video2(). This means the decoder has to consume the full packet.

Parameters are the same as avcodec_decode_video2().

Definition at line 631 of file pthread.c.

Referenced by avcodec_decode_video2().

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 741 of file pthread.c.

Referenced by decode_frame(), decode_postinit(), ff_h263_decode_frame(), ff_rv34_decode_frame(), frame_worker_thread(), mimic_decode_frame(), mpeg_field_start(), thread_get_buffer_internal(), and vp8_decode_frame().

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 705 of file pthread.c.

Referenced by decode(), decode_finish_row(), decode_frame(), decode_nal_units(), decode_slice_header(), ff_MPV_frame_end(), ff_MPV_frame_start(), ff_MPV_report_decode_progress(), ff_rv34_decode_frame(), field_end(), finish_frame(), mimic_decode_frame(), rv34_decode_slice(), vp3_draw_horiz_band(), vp8_decode_frame(), and vp8_decode_mb_row_sliced().

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
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 723 of file pthread.c.

Referenced by await_reference_mb_row(), await_reference_row(), await_references(), decode(), decode_frame(), decode_slice(), ff_er_frame_end(), guess_mv(), is_intra_more_likely(), mpeg4_decode_mb(), MPV_decode_mb_internal(), rv34_decode_mv(), rv34_mc(), vp8_decode_frame(), vp8_mc_chroma(), and vp8_mc_luma().

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
avctxThe current context.
fmtThe list of available formats.

Definition at line 1032 of file pthread.c.

Referenced by get_pixel_format(), and mpeg_get_pixelformat().

int ff_thread_get_buffer ( AVCodecContext avctx,
ThreadFrame 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
avctxThe current context.
fThe frame to write into.

Definition at line 1058 of file pthread.c.

Referenced by alloc_frame_buffer(), alloc_picture(), decode_frame(), dnxhd_decode_frame(), get_siz(), jpeg2000_decode_frame(), lag_decode_frame(), libopenjpeg_decode_frame(), mimic_decode_frame(), and vp8_alloc_frame().

void ff_thread_release_buffer ( AVCodecContext avctx,
ThreadFrame 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
avctxThe current context.
fThe picture being released.

Definition at line 1066 of file pthread.c.

Referenced by decode_frame(), ff_mpeg_unref_picture(), ff_thread_ref_frame(), ffv1_close(), mimic_decode_end(), mimic_decode_frame(), mimic_decode_update_thread_context(), ref_frame(), unref_picture(), update_frames(), update_thread_context(), vp3_decode_flush(), vp8_alloc_frame(), and vp8_release_frame().

int ff_thread_ref_frame ( ThreadFrame dst,
ThreadFrame src 
)
int ff_thread_init ( AVCodecContext s)

Definition at line 1147 of file pthread.c.

Referenced by avcodec_open2().

void ff_thread_free ( AVCodecContext s)

Definition at line 1163 of file pthread.c.

Referenced by avcodec_close(), and thread_init().