2 * Copyright (c) 2008 Alexander Strange <astrange@ithinksw.com>
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 * Multithreading support functions
24 * @author Alexander Strange <astrange@ithinksw.com>
27 #ifndef AVCODEC_THREAD_H
28 #define AVCODEC_THREAD_H
30 #include "libavutil/buffer.h"
35 typedef struct ThreadFrame {
37 AVCodecContext *owner;
38 // progress->data is an array of 2 ints holding progress for top/bottom
40 AVBufferRef *progress;
44 * Wait for decoding threads to finish and reset internal state.
45 * Called by avcodec_flush_buffers().
47 * @param avctx The context.
49 void ff_thread_flush(AVCodecContext *avctx);
52 * Submit a new frame to a decoding thread.
53 * Returns the next available frame in picture. *got_picture_ptr
54 * will be 0 if none is available.
55 * The return value on success is the size of the consumed packet for
56 * compatibility with avcodec_decode_video2(). This means the decoder
57 * has to consume the full packet.
59 * Parameters are the same as avcodec_decode_video2().
61 int ff_thread_decode_frame(AVCodecContext *avctx, AVFrame *picture,
62 int *got_picture_ptr, AVPacket *avpkt);
65 * If the codec defines update_thread_context(), call this
66 * when they are ready for the next thread to start decoding
67 * the next frame. After calling it, do not change any variables
68 * read by the update_thread_context() method, or call ff_thread_get_buffer().
70 * @param avctx The context.
72 void ff_thread_finish_setup(AVCodecContext *avctx);
75 * Notify later decoding threads when part of their reference picture is ready.
76 * Call this when some part of the picture is finished decoding.
77 * Later calls with lower values of progress have no effect.
79 * @param f The picture being decoded.
80 * @param progress Value, in arbitrary units, of how much of the picture has decoded.
81 * @param field The field being decoded, for field-picture codecs.
82 * 0 for top field or frame pictures, 1 for bottom field.
84 void ff_thread_report_progress(ThreadFrame *f, int progress, int field);
87 * Wait for earlier decoding threads to finish reference pictures.
88 * Call this before accessing some part of a picture, with a given
89 * value for progress, and it will return after the responsible decoding
90 * thread calls ff_thread_report_progress() with the same or
91 * higher value for progress.
93 * @param f The picture being referenced.
94 * @param progress Value, in arbitrary units, to wait for.
95 * @param field The field being referenced, for field-picture codecs.
96 * 0 for top field or frame pictures, 1 for bottom field.
98 void ff_thread_await_progress(ThreadFrame *f, int progress, int field);
101 * Wrapper around get_buffer() for frame-multithreaded codecs.
102 * Call this function instead of ff_get_buffer(f).
103 * Cannot be called after the codec has called ff_thread_finish_setup().
105 * @param avctx The current context.
106 * @param f The frame to write into.
108 int ff_thread_get_buffer(AVCodecContext *avctx, ThreadFrame *f, int flags);
111 * Wrapper around release_buffer() frame-for multithreaded codecs.
112 * Call this function instead of avctx->release_buffer(f).
113 * The AVFrame will be copied and the actual release_buffer() call
114 * will be performed later. The contents of data pointed to by the
115 * AVFrame should not be changed until ff_thread_get_buffer() is called
118 * @param avctx The current context.
119 * @param f The picture being released.
121 void ff_thread_release_buffer(AVCodecContext *avctx, ThreadFrame *f);
123 int ff_thread_ref_frame(ThreadFrame *dst, ThreadFrame *src);
125 int ff_thread_init(AVCodecContext *s);
126 void ff_thread_free(AVCodecContext *s);
128 #endif /* AVCODEC_THREAD_H */