annotate fifo.c @ 566:34198f8250cf libavutil

Cosmetics: remove a redundant and misplaced doxy.
author stefano
date Tue, 19 Aug 2008 22:17:13 +0000
parents a0dab9157d6a
children 5a8d0e6cdcfb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
1 /*
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
2 * A very simple circular buffer FIFO implementation
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
3 * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
4 * Copyright (c) 2006 Roman Shaposhnik
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
5 *
116
d76a36742464 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 110
diff changeset
6 * This file is part of FFmpeg.
d76a36742464 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 110
diff changeset
7 *
d76a36742464 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 110
diff changeset
8 * FFmpeg is free software; you can redistribute it and/or
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
9 * modify it under the terms of the GNU Lesser General Public
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
10 * License as published by the Free Software Foundation; either
116
d76a36742464 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 110
diff changeset
11 * version 2.1 of the License, or (at your option) any later version.
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
12 *
116
d76a36742464 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 110
diff changeset
13 * FFmpeg is distributed in the hope that it will be useful,
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
16 * Lesser General Public License for more details.
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
17 *
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
18 * You should have received a copy of the GNU Lesser General Public
116
d76a36742464 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 110
diff changeset
19 * License along with FFmpeg; if not, write to the Free Software
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
21 */
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
22 #include "common.h"
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
23 #include "fifo.h"
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
24
511
5accd0bccc76 Ensure that one can store X bytes in a fifo of size X.
michael
parents: 510
diff changeset
25 int av_fifo_init(AVFifoBuffer *f, unsigned int size)
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
26 {
511
5accd0bccc76 Ensure that one can store X bytes in a fifo of size X.
michael
parents: 510
diff changeset
27 size= FFMAX(size, size+1);
226
fb0c5c158c67 better to set things to NULL instead of random in case of out of mem
michael
parents: 225
diff changeset
28 f->wptr = f->rptr =
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
29 f->buffer = av_malloc(size);
229
3f5c648b82c4 simpler branch structure in init (16 bytes smaller object file)
michael
parents: 228
diff changeset
30 f->end = f->buffer + size;
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
31 if (!f->buffer)
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
32 return -1;
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
33 return 0;
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
34 }
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
35
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
36 void av_fifo_free(AVFifoBuffer *f)
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
37 {
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
38 av_free(f->buffer);
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
39 }
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
40
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
41 int av_fifo_size(AVFifoBuffer *f)
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
42 {
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
43 int size = f->wptr - f->rptr;
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
44 if (size < 0)
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
45 size += f->end - f->buffer;
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
46 return size;
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
47 }
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
48
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
49 int av_fifo_read(AVFifoBuffer *f, uint8_t *buf, int buf_size)
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
50 {
224
a9880a7685e7 remove near duplicate function
michael
parents: 223
diff changeset
51 return av_fifo_generic_read(f, buf_size, NULL, buf);
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
52 }
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
53
565
a0dab9157d6a Deprecate av_fifo_realloc(). av_fifo_realloc2() should be used instead.
stefano
parents: 564
diff changeset
54 #if LIBAVUTIL_VERSION_MAJOR < 50
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
55 void av_fifo_realloc(AVFifoBuffer *f, unsigned int new_size) {
564
a1ac1cb9a91b Implement av_fifo_realloc2().
stefano
parents: 511
diff changeset
56 av_fifo_realloc2(f, new_size);
a1ac1cb9a91b Implement av_fifo_realloc2().
stefano
parents: 511
diff changeset
57 }
565
a0dab9157d6a Deprecate av_fifo_realloc(). av_fifo_realloc2() should be used instead.
stefano
parents: 564
diff changeset
58 #endif
564
a1ac1cb9a91b Implement av_fifo_realloc2().
stefano
parents: 511
diff changeset
59
a1ac1cb9a91b Implement av_fifo_realloc2().
stefano
parents: 511
diff changeset
60 int av_fifo_realloc2(AVFifoBuffer *f, unsigned int new_size) {
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
61 unsigned int old_size= f->end - f->buffer;
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
62
511
5accd0bccc76 Ensure that one can store X bytes in a fifo of size X.
michael
parents: 510
diff changeset
63 if(old_size <= new_size){
225
0b93dab98397 simplify av_fifo_realloc()
michael
parents: 224
diff changeset
64 int len= av_fifo_size(f);
0b93dab98397 simplify av_fifo_realloc()
michael
parents: 224
diff changeset
65 AVFifoBuffer f2;
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
66
564
a1ac1cb9a91b Implement av_fifo_realloc2().
stefano
parents: 511
diff changeset
67 if (av_fifo_init(&f2, new_size) < 0)
a1ac1cb9a91b Implement av_fifo_realloc2().
stefano
parents: 511
diff changeset
68 return -1;
225
0b93dab98397 simplify av_fifo_realloc()
michael
parents: 224
diff changeset
69 av_fifo_read(f, f2.buffer, len);
0b93dab98397 simplify av_fifo_realloc()
michael
parents: 224
diff changeset
70 f2.wptr += len;
0b93dab98397 simplify av_fifo_realloc()
michael
parents: 224
diff changeset
71 av_free(f->buffer);
0b93dab98397 simplify av_fifo_realloc()
michael
parents: 224
diff changeset
72 *f= f2;
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
73 }
564
a1ac1cb9a91b Implement av_fifo_realloc2().
stefano
parents: 511
diff changeset
74 return 0;
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
75 }
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
76
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
77 void av_fifo_write(AVFifoBuffer *f, const uint8_t *buf, int size)
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
78 {
492
75f096258d14 Add a generic write function to av_fifo.
benoit
parents: 230
diff changeset
79 av_fifo_generic_write(f, (void *)buf, size, NULL);
75f096258d14 Add a generic write function to av_fifo.
benoit
parents: 230
diff changeset
80 }
75f096258d14 Add a generic write function to av_fifo.
benoit
parents: 230
diff changeset
81
493
97dd9756349c cosmetics (by Bj«Órn Axelsson)
benoit
parents: 492
diff changeset
82 int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int))
492
75f096258d14 Add a generic write function to av_fifo.
benoit
parents: 230
diff changeset
83 {
75f096258d14 Add a generic write function to av_fifo.
benoit
parents: 230
diff changeset
84 int total = size;
230
4c85ac99ab37 change while loops to do-while as the condition is true the first time and the check just wastes cpu cycles
michael
parents: 229
diff changeset
85 do {
223
df2f250bda3f simplify
michael
parents: 222
diff changeset
86 int len = FFMIN(f->end - f->wptr, size);
492
75f096258d14 Add a generic write function to av_fifo.
benoit
parents: 230
diff changeset
87 if(func) {
493
97dd9756349c cosmetics (by Bj«Órn Axelsson)
benoit
parents: 492
diff changeset
88 if(func(src, f->wptr, len) <= 0)
492
75f096258d14 Add a generic write function to av_fifo.
benoit
parents: 230
diff changeset
89 break;
75f096258d14 Add a generic write function to av_fifo.
benoit
parents: 230
diff changeset
90 } else {
493
97dd9756349c cosmetics (by Bj«Órn Axelsson)
benoit
parents: 492
diff changeset
91 memcpy(f->wptr, src, len);
97dd9756349c cosmetics (by Bj«Órn Axelsson)
benoit
parents: 492
diff changeset
92 src = (uint8_t*)src + len;
492
75f096258d14 Add a generic write function to av_fifo.
benoit
parents: 230
diff changeset
93 }
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
94 f->wptr += len;
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
95 if (f->wptr >= f->end)
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
96 f->wptr = f->buffer;
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
97 size -= len;
230
4c85ac99ab37 change while loops to do-while as the condition is true the first time and the check just wastes cpu cycles
michael
parents: 229
diff changeset
98 } while (size > 0);
492
75f096258d14 Add a generic write function to av_fifo.
benoit
parents: 230
diff changeset
99 return total - size;
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
100 }
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
101
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
102
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
103 int av_fifo_generic_read(AVFifoBuffer *f, int buf_size, void (*func)(void*, void*, int), void* dest)
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
104 {
230
4c85ac99ab37 change while loops to do-while as the condition is true the first time and the check just wastes cpu cycles
michael
parents: 229
diff changeset
105 do {
223
df2f250bda3f simplify
michael
parents: 222
diff changeset
106 int len = FFMIN(f->end - f->rptr, buf_size);
224
a9880a7685e7 remove near duplicate function
michael
parents: 223
diff changeset
107 if(func) func(dest, f->rptr, len);
a9880a7685e7 remove near duplicate function
michael
parents: 223
diff changeset
108 else{
a9880a7685e7 remove near duplicate function
michael
parents: 223
diff changeset
109 memcpy(dest, f->rptr, len);
a9880a7685e7 remove near duplicate function
michael
parents: 223
diff changeset
110 dest = (uint8_t*)dest + len;
a9880a7685e7 remove near duplicate function
michael
parents: 223
diff changeset
111 }
227
158b400d2f75 avoid code duplication
michael
parents: 226
diff changeset
112 av_fifo_drain(f, len);
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
113 buf_size -= len;
230
4c85ac99ab37 change while loops to do-while as the condition is true the first time and the check just wastes cpu cycles
michael
parents: 229
diff changeset
114 } while (buf_size > 0);
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
115 return 0;
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
116 }
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
117
228
a9a6ed6ec73d doxygenize
michael
parents: 227
diff changeset
118 /** discard data from the fifo */
110
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
119 void av_fifo_drain(AVFifoBuffer *f, int size)
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
120 {
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
121 f->rptr += size;
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
122 if (f->rptr >= f->end)
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
123 f->rptr -= f->end - f->buffer;
813b7366ac3f * Moving FifoBuffer out of libavformat/avformat.h and
romansh
parents:
diff changeset
124 }