diff options
Diffstat (limited to 'libavfilter/framepool.h')
-rw-r--r-- | libavfilter/framepool.h | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/libavfilter/framepool.h b/libavfilter/framepool.h new file mode 100644 index 0000000000..2a6c9e8636 --- /dev/null +++ b/libavfilter/framepool.h @@ -0,0 +1,84 @@ +/* + * This file is part of FFmpeg. + * + * Copyright (c) 2015 Matthieu Bouron <matthieu.bouron stupeflix.com> + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVFILTER_FRAMEPOOL_H +#define AVFILTER_FRAMEPOOL_H + +#include "libavutil/buffer.h" +#include "libavutil/frame.h" + +/** + * Video frame pool. This structure is opaque and not meant to be accessed + * directly. It is allocated with ff_video_frame_pool_init() and freed with + * ff_video_frame_pool_uninit(). + */ +typedef struct FFVideoFramePool FFVideoFramePool; + +/** + * Allocate and initialize a video frame pool. + * + * @param alloc a function that will be used to allocate new frame buffers when + * the pool is empty. May be NULL, then the default allocator will be used + * (av_buffer_alloc()). + * @param width width of each frame in this pool + * @param height height of each frame in this pool + * @param format format of each frame in this pool + * @param align buffers alignement of each frame in this pool + * @return newly created video frame pool on success, NULL on error. + */ +FFVideoFramePool *ff_video_frame_pool_init(AVBufferRef* (*alloc)(int size), + int width, + int height, + enum AVPixelFormat format, + int align); + +/** + * Deallocate the video frame pool. It is safe to call this function while + * some of the allocated video frame are still in use. + * + * @param pool pointer to the video frame pool to be freed. It will be set to NULL. + */ +void ff_video_frame_pool_uninit(FFVideoFramePool **pool); + +/** + * Get the video frame pool configuration. + * + * @param width width of each frame in this pool + * @param height height of each frame in this pool + * @param format format of each frame in this pool + * @param align buffers alignement of each frame in this pool + * @return 0 on success, a negative AVERROR otherwise. + */ +int ff_video_frame_pool_get_config(FFVideoFramePool *pool, + int *width, + int *height, + enum AVPixelFormat *format, + int *align); + +/** + * Allocate a new AVFrame, reussing old buffers from the pool when available. + * This function may be called simultaneously from multiple threads. + * + * @return a new AVFrame on success, NULL on error. + */ +AVFrame *ff_video_frame_pool_get(FFVideoFramePool *pool); + + +#endif /* AVFILTER_FRAMEPOOL_H */ |