upipe/ubuf_sound_mem.h header reference

Upipe ubuf manager for sound formats with umem storage More

• upipe/ubase.h
• upipe/ubuf.h

• enum ubuf_sound_mem_command

• int ubuf_sound_mem_get_shared(struct ubuf *ubuf, const char *channel, struct ubuf_mem_shared **shared_p, size_t *offset_p, size_t *size_p)
• int ubuf_sound_mem_mgr_add_plane(struct ubuf_mgr *mgr, const char *channel)
• struct ubuf_mgr * ubuf_sound_mem_mgr_alloc(uint16_t ubuf_pool_depth, uint16_t shared_pool_depth, struct umem_mgr *umem_mgr, uint8_t sample_size, uint64_t align)

• UBUF_SOUND_MEM_SIGNATURE

Upipe ubuf manager for sound formats with umem storage

This macro is declared in upipe/ubuf_sound_mem.h source file, line 44.

This macro is a simple signature to make sure the ubuf_control internal API is used properly.

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

This enum is declared in upipe/ubuf_sound_mem.h source file, line 53.

This enum extends ubuf_command with specific commands for sound mem manager.

This function is declared in upipe/ubuf_sound_mem.h source file, line 74.

This function returns the underlying shared buffer. The reference counter is not incremented.

Parameter list:

• ubuf: pointer to ubuf
• channel: channel type (see channel reference)
• shared_p: filled in with a pointer to the underlying shared buffer
• offset_p: filled in with the offset in the shared buffer for the plane
• size_p: filled in with the size of the plane

The return value is an error code

This function is declared in upipe/ubuf_sound_mem.h source file, line 104.

This function adds a new plane to a ubuf manager for sound formats using umem. It may only be called on initializing the manager, before any ubuf is allocated.

Parameter list:

• mgr: pointer to a ubuf_mgr structure
• channel: channel type (see channel reference)

The return value is an error code

This function is declared in upipe/ubuf_sound_mem.h source file, line 94.

This function allocates a new instance of the ubuf manager for sound formats using umem.

Parameter list:

• ubuf_pool_depth: maximum number of ubuf structures in the pool
• shared_pool_depth: maximum number of shared structures in the pool
• umem_mgr: memory allocator to use for buffers
• sample_size: number of octets in a sample for a plane
• align: alignment in octets

The return value is pointer to manager, or NULL in case of error