upipe/ubuf_sound_mem.h header reference
Upipe ubuf manager for sound formats with umem storage More
Header inclusion
Members
Functions
- 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)
 
Description
Upipe ubuf manager for sound formats with umem storage
Members detail
This macro is declared in upipe/ubuf_sound_mem.h source file, line 31.
int ubuf_sound_mem_mgr_add_plane(struct ubuf_mgr *mgr, const char *channel)
This function is declared in upipe/ubuf_sound_mem.h source file, line 67.
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.
Parameters list:
- mgr: pointer to a ubuf_mgr structure
 - channel: channel type (see channel reference)
 
The return value is an error code
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)
This function is declared in upipe/ubuf_sound_mem.h source file, line 57.
This function allocates a new instance of the ubuf manager for sound formats using umem.
Parameters 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