upipe/ubuf_block_common.h header reference
Upipe useful common definitions for block managers More
Header inclusion
Members
Functions
- int ubuf_block_common_dup(struct ubuf *ubuf, struct ubuf *new_ubuf)
- void ubuf_block_common_init(struct ubuf *ubuf, bool map)
- int ubuf_block_common_splice(struct ubuf *ubuf, struct ubuf *new_ubuf, int offset, int size)
Description
Members detail
This macro is declared in upipe/ubuf_block_common.h source file, line 31.
This function is declared in upipe/ubuf_block_common.h source file, line 102.
This function duplicates common sections of a block ubuf, and duplicates other segments.
Parameters list:
- ubuf: pointer to ubuf
- new_ubuf: pointer to ubuf to overwrite
The return value is an error code
void ubuf_block_common_init(struct ubuf *ubuf, bool map)
This function is declared in upipe/ubuf_block_common.h source file, line 51.
This function initializes common sections of a block ubuf.
Parameters list:
- ubuf: pointer to ubuf
- bool: true if UBUF_MAP_BLOCK & UBUF_UNMAP_BLOCK need to be called
The return value is pointer to ubuf or NULL in case of failure
This function is declared in upipe/ubuf_block_common.h source file, line 130.
This function duplicates common sections of a block ubuf, and duplicates part of other segments.
Parameters list:
- ubuf: pointer to ubuf
- new_ubuf: pointer to ubuf to overwrite
- offset: offset in the buffer
- size: final size of the buffer
The return value is an error code
void ubuf_block_common_clean(struct ubuf *ubuf)
This function is for internal use only.
This function is declared in upipe/ubuf_block_common.h source file, line 159.
This function frees the ubuf containg the next segments of the current ubuf.
Parameters list:
- ubuf: pointer to ubuf
void ubuf_block_common_set(struct ubuf *ubuf, size_t offset, size_t size)
This function is for internal use only.
This function is declared in upipe/ubuf_block_common.h source file, line 74.
This function sets the members of the block structure for block ubuf.
Parameters list:
- ubuf: pointer to ubuf
- offset: new offset
- size: new size
void ubuf_block_common_set_buffer(struct ubuf *ubuf, uint8_t *buffer)
This function is for internal use only.
This function is declared in upipe/ubuf_block_common.h source file, line 88.
This function sets the buffer member of the block structure for block ubuf.
Parameters list:
- buffer: optional pointer to the buffer