upipe/ubuf_block_common.h header reference

Upipe useful common definitions for block managers More

• upipe/ubuf.h
• upipe/ubuf_block.h

• 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)

Upipe useful common definitions for block managers

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.

Parameter list:

• ubuf: pointer to ubuf
• new_ubuf: pointer to ubuf to overwrite

The return value is an error code

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

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

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 containg the next segments of the current ubuf.

Parameter list:

• ubuf: pointer to ubuf

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

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