fifo.c 5.93 KB
Newer Older
1
/*
2
 * a very simple circular buffer FIFO implementation
3 4 5
 * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
 * Copyright (c) 2006 Roman Shaposhnik
 *
6 7 8
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
9 10
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
11
 * version 2.1 of the License, or (at your option) any later version.
12
 *
13
 * FFmpeg is distributed in the hope that it will be useful,
14 15 16 17 18
 * 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
19
 * License along with FFmpeg; if not, write to the Free Software
20 21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */
22 23

#include "avassert.h"
24 25 26
#include "common.h"
#include "fifo.h"

27
static AVFifoBuffer *fifo_alloc_common(void *buffer, size_t size)
28
{
29 30 31 32 33 34
    AVFifoBuffer *f;
    if (!buffer)
        return NULL;
    f = av_mallocz(sizeof(AVFifoBuffer));
    if (!f) {
        av_free(buffer);
35
        return NULL;
36 37
    }
    f->buffer = buffer;
38
    f->end    = f->buffer + size;
39
    av_fifo_reset(f);
40
    return f;
41 42
}

43 44 45 46 47 48 49 50 51 52 53 54
AVFifoBuffer *av_fifo_alloc(unsigned int size)
{
    void *buffer = av_malloc(size);
    return fifo_alloc_common(buffer, size);
}

AVFifoBuffer *av_fifo_alloc_array(size_t nmemb, size_t size)
{
    void *buffer = av_malloc_array(nmemb, size);
    return fifo_alloc_common(buffer, nmemb * size);
}

55 56
void av_fifo_free(AVFifoBuffer *f)
{
57
    if (f) {
58
        av_freep(&f->buffer);
Michael Niedermayer's avatar
Michael Niedermayer committed
59
        av_free(f);
60
    }
61 62
}

63 64 65 66 67 68 69 70
void av_fifo_freep(AVFifoBuffer **f)
{
    if (f) {
        av_fifo_free(*f);
        *f = NULL;
    }
}

71 72 73 74 75 76
void av_fifo_reset(AVFifoBuffer *f)
{
    f->wptr = f->rptr = f->buffer;
    f->wndx = f->rndx = 0;
}

77
int av_fifo_size(const AVFifoBuffer *f)
78
{
79
    return (uint32_t)(f->wndx - f->rndx);
80 81
}

82
int av_fifo_space(const AVFifoBuffer *f)
83 84 85 86
{
    return f->end - f->buffer - av_fifo_size(f);
}

87 88 89
int av_fifo_realloc2(AVFifoBuffer *f, unsigned int new_size)
{
    unsigned int old_size = f->end - f->buffer;
90

91
    if (old_size < new_size) {
92
        int len          = av_fifo_size(f);
93
        AVFifoBuffer *f2 = av_fifo_alloc(new_size);
94

95
        if (!f2)
96
            return AVERROR(ENOMEM);
97
        av_fifo_generic_read(f, f2->buffer, len, NULL);
98 99
        f2->wptr += len;
        f2->wndx += len;
100
        av_free(f->buffer);
101
        *f = *f2;
102
        av_free(f2);
103
    }
104
    return 0;
105 106
}

107 108 109 110 111 112 113 114 115
int av_fifo_grow(AVFifoBuffer *f, unsigned int size)
{
    unsigned int old_size = f->end - f->buffer;
    if(size + (unsigned)av_fifo_size(f) < size)
        return AVERROR(EINVAL);

    size += av_fifo_size(f);

    if (old_size < size)
116
        return av_fifo_realloc2(f, FFMAX(size, 2*old_size));
117 118 119
    return 0;
}

120 121 122 123
/* src must NOT be const as it can be a context for func that may need
 * updating (like a pointer or byte counter) */
int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size,
                          int (*func)(void *, void *, int))
124 125
{
    int total = size;
126 127 128
    uint32_t wndx= f->wndx;
    uint8_t *wptr= f->wptr;

129
    do {
130
        int len = FFMIN(f->end - wptr, size);
131
        if (func) {
132 133
            len = func(src, wptr, len);
            if (len <= 0)
134 135
                break;
        } else {
136
            memcpy(wptr, src, len);
137
            src = (uint8_t *)src + len;
138
        }
139
// Write memory barrier needed for SMP here in theory
140 141 142
        wptr += len;
        if (wptr >= f->end)
            wptr = f->buffer;
143
        wndx    += len;
144
        size    -= len;
145
    } while (size > 0);
146 147
    f->wndx= wndx;
    f->wptr= wptr;
148
    return total - size;
149 150
}

151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
int av_fifo_generic_peek_at(AVFifoBuffer *f, void *dest, int offset, int buf_size, void (*func)(void*, void*, int))
{
    uint8_t *rptr = f->rptr;

    av_assert2(offset >= 0);

    /*
     * *ndx are indexes modulo 2^32, they are intended to overflow,
     * to handle *ndx greater than 4gb.
     */
    av_assert2(buf_size + (unsigned)offset <= f->wndx - f->rndx);

    if (offset >= f->end - rptr)
        rptr += offset - (f->end - f->buffer);
    else
        rptr += offset;

    while (buf_size > 0) {
        int len;

        if (rptr >= f->end)
            rptr -= f->end - f->buffer;

        len = FFMIN(f->end - rptr, buf_size);
        if (func)
            func(dest, rptr, len);
        else {
            memcpy(dest, rptr, len);
            dest = (uint8_t *)dest + len;
        }

        buf_size -= len;
        rptr     += len;
    }

    return 0;
}

189 190 191 192 193 194 195
int av_fifo_generic_peek(AVFifoBuffer *f, void *dest, int buf_size,
                         void (*func)(void *, void *, int))
{
// Read memory barrier needed for SMP here in theory
    uint8_t *rptr = f->rptr;

    do {
196
        int len = FFMIN(f->end - rptr, buf_size);
197
        if (func)
198
            func(dest, rptr, len);
199
        else {
200
            memcpy(dest, rptr, len);
201 202 203
            dest = (uint8_t *)dest + len;
        }
// memory barrier needed for SMP here in theory
204 205 206
        rptr += len;
        if (rptr >= f->end)
            rptr -= f->end - f->buffer;
207 208 209 210 211 212
        buf_size -= len;
    } while (buf_size > 0);

    return 0;
}

213 214
int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size,
                         void (*func)(void *, void *, int))
215
{
216
// Read memory barrier needed for SMP here in theory
217
    do {
Michael Niedermayer's avatar
Michael Niedermayer committed
218
        int len = FFMIN(f->end - f->rptr, buf_size);
219 220 221
        if (func)
            func(dest, f->rptr, len);
        else {
222
            memcpy(dest, f->rptr, len);
223
            dest = (uint8_t *)dest + len;
224
        }
225
// memory barrier needed for SMP here in theory
226
        av_fifo_drain(f, len);
227
        buf_size -= len;
228
    } while (buf_size > 0);
229 230 231
    return 0;
}

232
/** Discard data from the FIFO. */
233 234
void av_fifo_drain(AVFifoBuffer *f, int size)
{
235
    av_assert2(av_fifo_size(f) >= size);
236 237 238
    f->rptr += size;
    if (f->rptr >= f->end)
        f->rptr -= f->end - f->buffer;
239
    f->rndx += size;
240
}