1 /* 2 * Copyright (c) 2008 Alexander Strange <astrange@ithinksw.com> 3 * 4 * This file is part of FFmpeg. 5 * 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. 10 * 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. 15 * 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 19 */ 20 21 /** 22 * @file 23 * Multithreading support functions 24 * @author Alexander Strange <astrange@ithinksw.com> 25 */ 26 27 #ifndef AVCODEC_THREAD_H 28 #define AVCODEC_THREAD_H 29 30 #include "libavutil/buffer.h" 31 32 #include "avcodec.h" 33 34 /** 35 * Wait for decoding threads to finish and reset internal state. 36 * Called by avcodec_flush_buffers(). 37 * 38 * @param avctx The context. 39 */ 40 void ff_thread_flush(AVCodecContext *avctx); 41 42 /** 43 * Submit a new frame to a decoding thread. 44 * Returns the next available frame in picture. *got_picture_ptr 45 * will be 0 if none is available. 46 * The return value on success is the size of the consumed packet for 47 * compatibility with FFCodec.decode. This means the decoder 48 * has to consume the full packet. 49 * 50 * Parameters are the same as FFCodec.decode. 51 */ 52 int ff_thread_decode_frame(AVCodecContext *avctx, AVFrame *picture, 53 int *got_picture_ptr, AVPacket *avpkt); 54 55 /** 56 * If the codec defines update_thread_context(), call this 57 * when they are ready for the next thread to start decoding 58 * the next frame. After calling it, do not change any variables 59 * read by the update_thread_context() method, or call ff_thread_get_buffer(). 60 * 61 * @param avctx The context. 62 */ 63 void ff_thread_finish_setup(AVCodecContext *avctx); 64 65 #if FF_API_THREAD_SAFE_CALLBACKS 66 /** 67 * Wrapper around get_format() for frame-multithreaded codecs. 68 * Call this function instead of avctx->get_format(). 69 * Cannot be called after the codec has called ff_thread_finish_setup(). 70 * 71 * @param avctx The current context. 72 * @param fmt The list of available formats. 73 */ 74 enum AVPixelFormat ff_thread_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt); 75 #else 76 #define ff_thread_get_format ff_get_format 77 #endif 78 79 /** 80 * Wrapper around get_buffer() for frame-multithreaded codecs. 81 * Call this function instead of ff_get_buffer(f). 82 * Cannot be called after the codec has called ff_thread_finish_setup(). 83 * 84 * @param avctx The current context. 85 * @param f The frame to write into. 86 */ 87 int ff_thread_get_buffer(AVCodecContext *avctx, AVFrame *f, int flags); 88 89 /** 90 * Wrapper around release_buffer() frame-for multithreaded codecs. 91 * Call this function instead of avctx->release_buffer(f). 92 * The AVFrame will be copied and the actual release_buffer() call 93 * will be performed later. The contents of data pointed to by the 94 * AVFrame should not be changed until ff_thread_get_buffer() is called 95 * on it. 96 * 97 * @param avctx The current context. 98 * @param f The picture being released. 99 */ 100 void ff_thread_release_buffer(AVCodecContext *avctx, AVFrame *f); 101 102 int ff_thread_init(AVCodecContext *s); 103 int ff_slice_thread_execute_with_mainfunc(AVCodecContext *avctx, 104 int (*action_func2)(AVCodecContext *c, void *arg, int jobnr, int threadnr), 105 int (*main_func)(AVCodecContext *c), void *arg, int *ret, int job_count); 106 void ff_thread_free(AVCodecContext *s); 107 int ff_alloc_entries(AVCodecContext *avctx, int count); 108 void ff_reset_entries(AVCodecContext *avctx); 109 int ff_slice_thread_init_progress(AVCodecContext *avctx); 110 void ff_thread_report_progress2(AVCodecContext *avctx, int field, int thread, int n); 111 void ff_thread_await_progress2(AVCodecContext *avctx, int field, int thread, int shift); 112 113 #endif /* AVCODEC_THREAD_H */ 114