3 * Copyright (c) 2012 Nicolas George
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #ifndef AVFILTER_BUFFERQUEUE_H
23 #define AVFILTER_BUFFERQUEUE_H
26 * FFBufQueue: simple AVFrame queue API
28 * Note: this API is not thread-safe. Concurrent access to the same queue
29 * must be protected by a mutex or any synchronization mechanism.
33 * Maximum size of the queue.
35 * This value can be overridden by definying it before including this
37 * Powers of 2 are recommended.
39 #ifndef FF_BUFQUEUE_SIZE
40 #define FF_BUFQUEUE_SIZE 64
44 #include "libavutil/avassert.h"
47 * Structure holding the queue
50 AVFrame *queue[FF_BUFQUEUE_SIZE];
52 unsigned short available; /**< number of available buffers */
55 #define BUCKET(i) queue->queue[(queue->head + (i)) % FF_BUFQUEUE_SIZE]
58 * Test if a buffer queue is full.
60 static inline int ff_bufqueue_is_full(struct FFBufQueue *queue)
62 return queue->available == FF_BUFQUEUE_SIZE;
66 * Add a buffer to the queue.
68 * If the queue is already full, then the current last buffer is dropped
69 * (and unrefed) with a warning before adding the new buffer.
71 static inline void ff_bufqueue_add(void *log, struct FFBufQueue *queue,
74 if (ff_bufqueue_is_full(queue)) {
75 av_log(log, AV_LOG_WARNING, "Buffer queue overflow, dropping.\n");
76 av_frame_free(&BUCKET(--queue->available));
78 BUCKET(queue->available++) = buf;
82 * Get a buffer from the queue without altering it.
84 * Buffer with index 0 is the first buffer in the queue.
85 * Return NULL if the queue has not enough buffers.
87 static inline AVFrame *ff_bufqueue_peek(struct FFBufQueue *queue,
90 return index < queue->available ? BUCKET(index) : NULL;
94 * Get the first buffer from the queue and remove it.
96 * Do not use on an empty queue.
98 static inline AVFrame *ff_bufqueue_get(struct FFBufQueue *queue)
100 AVFrame *ret = queue->queue[queue->head];
101 av_assert0(queue->available);
103 queue->queue[queue->head] = NULL;
104 queue->head = (queue->head + 1) % FF_BUFQUEUE_SIZE;
109 * Unref and remove all buffers from the queue.
111 static inline void ff_bufqueue_discard_all(struct FFBufQueue *queue)
113 while (queue->available) {
114 AVFrame *buf = ff_bufqueue_get(queue);
121 #endif /* AVFILTER_BUFFERQUEUE_H */