lavu: add av_bprintf and related.
[ffmpeg.git] / libavutil / bprint.c
1 /*
2  * Copyright (c) 2012 Nicolas George
3  *
4  * This file is part of FFmpeg.
5  *
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.
10  *
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.
15  *
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
19  */
20
21 #include <stdarg.h>
22 #include <stdio.h>
23 #include <string.h>
24 #include "bprint.h"
25 #include "common.h"
26 #include "error.h"
27 #include "mem.h"
28
29 #define av_bprint_room(buf) ((buf)->size - FFMIN((buf)->len, (buf)->size))
30 #define av_bprint_is_allocated(buf) ((buf)->str != (buf)->reserved_internal_buffer)
31
32 static int av_bprint_alloc(AVBPrint *buf, unsigned room)
33 {
34     char *old_str, *new_str;
35     unsigned min_size, new_size;
36
37     if (buf->size == buf->size_max)
38         return AVERROR(EIO);
39     if (!av_bprint_is_complete(buf))
40         return AVERROR_INVALIDDATA; /* it is already truncated anyway */
41     min_size = buf->len + 1 + FFMIN(UINT_MAX - buf->len - 1, room);
42     new_size = buf->size > buf->size_max / 2 ? buf->size_max : buf->size * 2;
43     if (new_size < min_size)
44         new_size = FFMIN(buf->size_max, min_size);
45     old_str = av_bprint_is_allocated(buf) ? buf->str : NULL;
46     new_str = av_realloc(old_str, new_size);
47     if (!new_str)
48         return AVERROR(ENOMEM);
49     if (!old_str)
50         memcpy(new_str, buf->str, buf->len + 1);
51     buf->str  = new_str;
52     buf->size = new_size;
53     return 0;
54 }
55
56 static void av_bprint_grow(AVBPrint *buf, unsigned extra_len)
57 {
58     /* arbitrary margin to avoid small overflows */
59     extra_len = FFMIN(extra_len, UINT_MAX - 5 - buf->len);
60     buf->len += extra_len;
61     if (buf->size)
62         buf->str[FFMIN(buf->len, buf->size - 1)] = 0;
63 }
64
65 void av_bprint_init(AVBPrint *buf, unsigned size_init, unsigned size_max)
66 {
67     unsigned size_auto = (char *)buf + sizeof(*buf) -
68                          buf->reserved_internal_buffer;
69
70     if (size_max == 1)
71         size_max = size_auto;
72     buf->str      = buf->reserved_internal_buffer;
73     buf->len      = 0;
74     buf->size     = FFMIN(size_auto, size_max);
75     buf->size_max = size_max;
76     *buf->str = 0;
77     if (size_init > buf->size)
78         av_bprint_alloc(buf, size_init - 1);
79 }
80
81 void av_bprintf(AVBPrint *buf, const char *fmt, ...)
82 {
83     unsigned room;
84     char *dst;
85     va_list vl;
86     int extra_len;
87
88     while (1) {
89         room = av_bprint_room(buf);
90         dst = room ? buf->str + buf->len : NULL;
91         va_start(vl, fmt);
92         extra_len = vsnprintf(dst, room, fmt, vl);
93         va_end(vl);
94         if (extra_len <= 0)
95             return;
96         if (extra_len < room)
97             break;
98         if (av_bprint_alloc(buf, extra_len))
99             break;
100     }
101     av_bprint_grow(buf, extra_len);
102 }
103
104 void av_bprint_chars(AVBPrint *buf, char c, unsigned n)
105 {
106     unsigned room, real_n;
107
108     while (1) {
109         room = av_bprint_room(buf);
110         if (n < room)
111             break;
112         if (av_bprint_alloc(buf, n))
113             break;
114     }
115     if (room) {
116         real_n = FFMIN(n, room - 1);
117         memset(buf->str + buf->len, c, real_n);
118     }
119     av_bprint_grow(buf, n);
120 }
121
122 int av_bprint_finalize(AVBPrint *buf, char **ret_str)
123 {
124     unsigned real_size = FFMIN(buf->len + 1, buf->size);
125     char *str;
126     int ret = 0;
127
128     if (ret_str) {
129         if (av_bprint_is_allocated(buf)) {
130             str = av_realloc(buf->str, real_size);
131             if (!str)
132                 str = buf->str;
133             buf->str = NULL;
134         } else {
135             str = av_malloc(real_size);
136             if (str)
137                 memcpy(str, buf->str, real_size);
138             else
139                 ret = AVERROR(ENOMEM);
140         }
141         *ret_str = str;
142     } else {
143         if (av_bprint_is_allocated(buf))
144             av_freep(&buf->str);
145     }
146     buf->size = real_size;
147     return ret;
148 }
149
150 #ifdef TEST
151
152 #undef printf
153
154 static void bprint_pascal(AVBPrint *b, unsigned size)
155 {
156     unsigned p[size + 1], i, j;
157
158     p[0] = 1;
159     av_bprintf(b, "%8d\n", 1);
160     for (i = 1; i <= size; i++) {
161         p[i] = 1;
162         for (j = i - 1; j > 0; j--)
163             p[j] = p[j] + p[j - 1];
164         for (j = 0; j <= i; j++)
165             av_bprintf(b, "%8d", p[j]);
166         av_bprintf(b, "\n");
167     }
168 }
169
170 int main(void)
171 {
172     AVBPrint b;
173
174     av_bprint_init(&b, 0, -1);
175     bprint_pascal(&b, 5);
176     printf("Short text in unlimited buffer: %zu/%u\n", strlen(b.str), b.len);
177     printf("%s\n", b.str);
178     av_bprint_finalize(&b, NULL);
179
180     av_bprint_init(&b, 0, -1);
181     bprint_pascal(&b, 25);
182     printf("Long text in unlimited buffer: %zu/%u\n", strlen(b.str), b.len);
183     av_bprint_finalize(&b, NULL);
184
185     av_bprint_init(&b, 0, 2048);
186     bprint_pascal(&b, 25);
187     printf("Long text in limited buffer: %zu/%u\n", strlen(b.str), b.len);
188     av_bprint_finalize(&b, NULL);
189
190     av_bprint_init(&b, 0, 1);
191     bprint_pascal(&b, 5);
192     printf("Short text in automatic buffer: %zu/%u\n", strlen(b.str), b.len);
193
194     av_bprint_init(&b, 0, 1);
195     bprint_pascal(&b, 25);
196     printf("Long text in automatic buffer: %zu/%u\n", strlen(b.str), b.len);
197     /* Note that the size of the automatic buffer is arch-dependant. */
198
199     av_bprint_init(&b, 0, 0);
200     bprint_pascal(&b, 25);
201     printf("Long text count only buffer: %zu/%u\n", strlen(b.str), b.len);
202
203     return 0;
204 }
205
206 #endif