FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Macros | Functions | Variables
bprint.h File Reference
#include <stdarg.h>
#include "attributes.h"
#include "avstring.h"

Go to the source code of this file.

Macros

#define FF_PAD_STRUCTURE(name, size,...)
 Define a structure with extra padding to a fixed size This helps ensuring binary compatibility with future versions.
 
#define AV_BPRINT_SIZE_UNLIMITED   ((unsigned)-1)
 
#define AV_BPRINT_SIZE_AUTOMATIC   1
 
#define AV_BPRINT_SIZE_COUNT_ONLY   0
 

Functions

 FF_PAD_STRUCTURE (AVBPrint, 1024, char *str;unsigned len;unsigned size;unsigned size_max;char reserved_internal_buffer[1];) void av_bprint_init(AVBPrint *buf
 Buffer to print data progressively.
 
void av_bprint_init_for_buffer (AVBPrint *buf, char *buffer, unsigned size)
 Init a print buffer using a pre-existing buffer.
 
void av_bprintf (AVBPrint *buf, const char *fmt,...) av_printf_format(2
 Append a formatted string to a print buffer.
 
void void av_vbprintf (AVBPrint *buf, const char *fmt, va_list vl_arg)
 Append a formatted string to a print buffer.
 
void av_bprint_chars (AVBPrint *buf, char c, unsigned n)
 Append char c n times to a print buffer.
 
void av_bprint_append_data (AVBPrint *buf, const char *data, unsigned size)
 Append data to a print buffer.
 
void av_bprint_strftime (AVBPrint *buf, const char *fmt, const struct tm *tm)
 Append a formatted date and time to a print buffer.
 
void av_bprint_get_buffer (AVBPrint *buf, unsigned size, unsigned char **mem, unsigned *actual_size)
 Allocate bytes in the buffer for external use.
 
void av_bprint_clear (AVBPrint *buf)
 Reset the string to "" but keep internal allocated data.
 
static int av_bprint_is_complete (const AVBPrint *buf)
 Test if the print buffer is complete (not truncated).
 
int av_bprint_finalize (AVBPrint *buf, char **ret_str)
 Finalize a print buffer.
 
void av_bprint_escape (AVBPrint *dstbuf, const char *src, const char *special_chars, enum AVEscapeMode mode, int flags)
 Escape the content in src and append it to dstbuf.
 

Variables

unsigned size_init
 
unsigned unsigned size_max
 

Macro Definition Documentation

#define FF_PAD_STRUCTURE (   name,
  size,
  ... 
)
Value:
struct ff_pad_helper_##name { __VA_ARGS__ }; \
typedef struct name { \
__VA_ARGS__ \
char reserved_padding[size - sizeof(struct ff_pad_helper_##name)]; \
} name;

Define a structure with extra padding to a fixed size This helps ensuring binary compatibility with future versions.

Definition at line 34 of file bprint.h.

#define AV_BPRINT_SIZE_UNLIMITED   ((unsigned)-1)
#define AV_BPRINT_SIZE_AUTOMATIC   1
#define AV_BPRINT_SIZE_COUNT_ONLY   0

Function Documentation

FF_PAD_STRUCTURE ( AVBPrint  ,
1024  ,
char *str;unsigned len;unsigned size;unsigned size_max;char reserved_internal_buffer;  [1] 
)

Buffer to print data progressively.

The string buffer grows as necessary and is always 0-terminated. The content of the string is never accessed, and thus is encoding-agnostic and can even hold binary data.

Small buffers are kept in the structure itself, and thus require no memory allocation at all (unless the contents of the buffer is needed after the structure goes out of scope). This is almost as lightweight as declaring a local "char buf[512]".

The length of the string can go beyond the allocated size: the buffer is then truncated, but the functions still keep account of the actual total length.

In other words, buf->len can be greater than buf->size and records the total length of what would have been to the buffer if there had been enough memory.

Append operations do not need to be tested for failure: if a memory allocation fails, data stop being appended to the buffer, but the length is still updated. This situation can be tested with av_bprint_is_complete().

The size_max field determines several possible behaviours:

size_max = -1 (= UINT_MAX) or any large value will let the buffer be reallocated as necessary, with an amortized linear cost.

size_max = 0 prevents writing anything to the buffer: only the total length is computed. The write operations can then possibly be repeated in a buffer with exactly the necessary size (using size_init = size_max = len + 1).

size_max = 1 is automatically replaced by the exact size available in the structure itself, thus ensuring no dynamic memory allocation. The internal buffer is large enough to hold a reasonable paragraph of text, such as the current paragraph. Convenience macros for special values for av_bprint_init() size_max parameter. Init a print buffer.

Parameters
bufbuffer to init
size_initinitial size (including the final 0)
size_maxmaximum size; 0 means do not write anything, just count the length; 1 is replaced by the maximum value for automatic storage; any large value means that the internal buffer will be reallocated as needed up to that limit; -1 is converted to UINT_MAX, the largest limit possible. Check also AV_BPRINT_SIZE_* macros.
void av_bprint_init_for_buffer ( AVBPrint *  buf,
char *  buffer,
unsigned  size 
)

Init a print buffer using a pre-existing buffer.

The buffer will not be reallocated.

Parameters
bufbuffer structure to init
bufferbyte buffer to use for the string data
sizesize of buffer

Definition at line 85 of file bprint.c.

Referenced by av_get_channel_layout_string().

void av_bprintf ( AVBPrint *  buf,
const char *  fmt,
  ... 
)

Append a formatted string to a print buffer.

void void av_vbprintf ( AVBPrint *  buf,
const char *  fmt,
va_list  vl_arg 
)

Append a formatted string to a print buffer.

Definition at line 117 of file bprint.c.

Referenced by format_line(), srt_print(), and webvtt_print().

void av_bprint_chars ( AVBPrint *  buf,
char  c,
unsigned  n 
)
void av_bprint_append_data ( AVBPrint *  buf,
const char *  data,
unsigned  size 
)

Append data to a print buffer.

param buf bprint buffer to use param data pointer to data param size size of data

Definition at line 158 of file bprint.c.

Referenced by av_dict_get_string(), av_opt_serialize(), avio_read_to_bprint(), gen_sub_text(), handle_edm(), srt_text_cb(), validate_string(), and webvtt_text_cb().

void av_bprint_strftime ( AVBPrint *  buf,
const char *  fmt,
const struct tm *  tm 
)

Append a formatted date and time to a print buffer.

param buf bprint buffer to use param fmt date and time format string, see strftime() param tm broken-down time structure to translate

Note
due to poor design of the standard strftime function, it may produce poor results if the format string expands to a very long text and the bprint buffer is near the limit stated by the size_max option.

Definition at line 176 of file bprint.c.

Referenced by draw_text(), and func_strftime().

void av_bprint_get_buffer ( AVBPrint *  buf,
unsigned  size,
unsigned char **  mem,
unsigned *  actual_size 
)

Allocate bytes in the buffer for external use.

Parameters
[in]bufbuffer structure
[in]sizerequired size
[out]mempointer to the memory area
[out]actual_sizesize of the memory area after allocation; can be larger or smaller than size

Definition at line 218 of file bprint.c.

Referenced by decode_zbuf().

void av_bprint_clear ( AVBPrint *  buf)
static int av_bprint_is_complete ( const AVBPrint *  buf)
inlinestatic

Test if the print buffer is complete (not truncated).

It may have been truncated due to a memory allocation failure or the size_max limit (compare size and size_max if necessary).

Definition at line 185 of file bprint.h.

Referenced by av_bprint_alloc(), av_escape(), avio_read_to_bprint(), avpriv_bprint_to_extradata(), draw_text(), expand_text(), ff_ass_add_rect(), ff_ass_add_rect_bprint(), gen_sub_text(), handle_edm(), icecast_open(), init_report(), lavfi_read_header(), lavfi_read_packet(), main(), parse_string(), srt_encode_frame(), webvtt_encode_frame(), and write_frame().

int av_bprint_finalize ( AVBPrint *  buf,
char **  ret_str 
)

Finalize a print buffer.

The print buffer can no longer be used afterwards, but the len and size fields are still valid.

  • [out] ret_str if not NULL, used to return a permanent copy of the buffer contents, or NULL if memory allocation fails; if NULL, the buffer is discarded and freed
    Returns
    0 for success or error code (probably AVERROR(ENOMEM))

Definition at line 235 of file bprint.c.

Referenced by ass_read_header(), av_dict_get_string(), av_escape(), av_log_default_callback(), av_log_format_line(), av_opt_serialize(), avfilter_graph_dump(), avpriv_bprint_to_extradata(), close_decoder(), compact_print_str(), configure_output_audio_filter(), decode_text_chunk(), decode_zbuf(), ff_ass_add_rect(), ff_tadd_bytes_metadata(), ff_tadd_doubles_metadata(), ff_tadd_long_metadata(), ff_tadd_rational_metadata(), ff_tadd_shorts_metadata(), ffprobe_show_program_version(), flat_print_str(), ftp_status(), gen_sub_text(), icecast_open(), ini_print_str(), init_report(), jacosub_decode_frame(), json_print_int(), json_print_item_str(), json_print_section_header(), lavfi_read_header(), lavfi_read_packet(), main(), mpsub_read_header(), parse_file(), parse_psfile(), parse_string(), print_report(), realtext_decode_frame(), realtext_read_header(), sami_close(), sami_read_header(), show_frame(), show_packet(), show_stream(), show_subtitle(), srt_encode_close(), srt_read_header(), subviewer_decode_frame(), subviewer_read_header(), uninit(), validate_string(), webvtt_encode_close(), webvtt_read_header(), write_frame(), writer_close(), writer_print_data(), and xml_print_str().

void av_bprint_escape ( AVBPrint *  dstbuf,
const char *  src,
const char *  special_chars,
enum AVEscapeMode  mode,
int  flags 
)

Escape the content in src and append it to dstbuf.

Parameters
dstbufalready inited destination bprint buffer
srcstring containing the text to escape
special_charsstring containing the special characters which need to be escaped, can be NULL
modeescape mode to employ, see AV_ESCAPE_MODE_* macros. Any unknown value for mode will be considered equivalent to AV_ESCAPE_MODE_BACKSLASH, but this behaviour can change without notice.
flagsflags which control how to escape, see AV_ESCAPE_FLAG_* macros

Definition at line 265 of file bprint.c.

Referenced by av_dict_get_string(), av_escape(), and av_opt_serialize().

Variable Documentation

unsigned size_init

Definition at line 111 of file bprint.h.

unsigned unsigned size_max

Definition at line 111 of file bprint.h.

Referenced by av_bprint_init().