upipe/ubuf_block_common.h header reference

Upipe useful common definitions for block managers More

Header inclusion [link] 

Members [link] 

Functions [link] 

Description [link] 

Upipe useful common definitions for block managers

Members detail [link] 

#define _UPIPE_UBUF_BLOCK_COMMON_H_ [link] 

This macro is declared in upipe/ubuf_block_common.h source file, line 31.

int ubuf_block_common_dup(struct ubuf *ubuf, struct ubuf *new_ubuf) [link] 

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.

Parameter 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) [link] 

This function is declared in upipe/ubuf_block_common.h source file, line 51.

This function initializes common sections of a block ubuf.

Parameter 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

int ubuf_block_common_splice(struct ubuf *ubuf, struct ubuf *new_ubuf, int offset, int size) [link] 

This function is declared in upipe/ubuf_block_common.h source file, line 139.

This function duplicates common sections of a block ubuf, and duplicates part of other segments.

Parameter 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) [link] 

This function is for internal use only.

This function is declared in upipe/ubuf_block_common.h source file, line 180.

This function frees the ubuf containing the next segments of the current ubuf.

Parameter list:

  • ubuf: pointer to ubuf

void ubuf_block_common_set(struct ubuf *ubuf, size_t offset, size_t size) [link] 

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.

Parameter list:

  • ubuf: pointer to ubuf
  • offset: new offset
  • size: new size

void ubuf_block_common_set_buffer(struct ubuf *ubuf, uint8_t *buffer) [link] 

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.

Parameter list:

  • buffer: optional pointer to the buffer
Valid XHTML 1.0 StrictGenerated by cmassiot on Sun Dec 14 18:31:17 2025 using MkDoc