2 * This file is part of FFmpeg.
4 * Copyright (c) 2015 Matthieu Bouron <matthieu.bouron stupeflix.com>
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
21 #ifndef AVFILTER_FRAMEPOOL_H
22 #define AVFILTER_FRAMEPOOL_H
24 #include "libavutil/buffer.h"
25 #include "libavutil/frame.h"
26 #include "libavutil/internal.h"
29 * Frame pool. This structure is opaque and not meant to be accessed
30 * directly. It is allocated with ff_frame_pool_init() and freed with
31 * ff_frame_pool_uninit().
33 typedef struct FFFramePool FFFramePool;
36 * Allocate and initialize a video frame pool.
38 * @param alloc a function that will be used to allocate new frame buffers when
39 * the pool is empty. May be NULL, then the default allocator will be used
40 * (av_buffer_alloc()).
41 * @param width width of each frame in this pool
42 * @param height height of each frame in this pool
43 * @param format format of each frame in this pool
44 * @param align buffers alignement of each frame in this pool
45 * @return newly created video frame pool on success, NULL on error.
47 FFFramePool *ff_frame_pool_video_init(AVBufferRef* (*alloc)(size_t size),
50 enum AVPixelFormat format,
54 * Allocate and initialize an audio frame pool.
56 * @param alloc a function that will be used to allocate new frame buffers when
57 * the pool is empty. May be NULL, then the default allocator will be used
58 * (av_buffer_alloc()).
59 * @param channels channels of each frame in this pool
60 * @param nb_samples number of samples of each frame in this pool
61 * @param format format of each frame in this pool
62 * @param align buffers alignement of each frame in this pool
63 * @return newly created audio frame pool on success, NULL on error.
65 FFFramePool *ff_frame_pool_audio_init(AVBufferRef* (*alloc)(size_t size),
68 enum AVSampleFormat format,
72 * Deallocate the frame pool. It is safe to call this function while
73 * some of the allocated frame are still in use.
75 * @param pool pointer to the frame pool to be freed. It will be set to NULL.
77 void ff_frame_pool_uninit(FFFramePool **pool);
80 * Get the video frame pool configuration.
82 * @param width width of each frame in this pool
83 * @param height height of each frame in this pool
84 * @param format format of each frame in this pool
85 * @param align buffers alignement of each frame in this pool
86 * @return 0 on success, a negative AVERROR otherwise.
88 int ff_frame_pool_get_video_config(FFFramePool *pool,
91 enum AVPixelFormat *format,
95 * Get the audio frame pool configuration.
97 * @param channels channels of each frame in this pool
98 * @param nb_samples number of samples of each frame in this pool
99 * @param format format of each frame in this pool
100 * @param align buffers alignement of each frame in this pool
101 * @return 0 on success, a negative AVERROR otherwise.
103 int ff_frame_pool_get_audio_config(FFFramePool *pool,
106 enum AVSampleFormat *format,
111 * Allocate a new AVFrame, reussing old buffers from the pool when available.
112 * This function may be called simultaneously from multiple threads.
114 * @return a new AVFrame on success, NULL on error.
116 AVFrame *ff_frame_pool_get(FFFramePool *pool);
119 #endif /* AVFILTER_FRAMEPOOL_H */