upipe/ubuf_sound_mem.h header reference
Upipe ubuf manager for sound formats with umem storage More
Header inclusion [link]
Members [link]
Types [link]
- struct ubuf_mem_shared
- enum ubuf_sound_mem_command
Functions [link]
- 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)
Macro [link]
Description [link]
Upipe ubuf manager for sound formats with umem storage
Members detail [link]
#define UBUF_SOUND_MEM_SIGNATURE [link]
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.
#define _UPIPE_UBUF_SOUND_MEM_H_ [link]
This macro is declared in upipe/ubuf_sound_mem.h source file, line 31.
[link]
This struct is declared in upipe/ubuf_sound_mem.h source file, line 50.
This header is the low-level shared structure with reference counting, pointing to the actual data.
enum ubuf_sound_mem_command [link]
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.
| Identifier | Value | Description |
|---|---|---|
| UBUF_SOUND_MEM_SENTINEL | 0x8000 | |
| UBUF_SOUND_MEM_GET_SHARED | 1 | returns the shared substructure (const char *, struct ubuf_mem_shared **, size_t *, size_t *) |
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) [link]
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
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) [link]
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
[link]
This struct is declared in upipe/uprobe_ubuf_mem_pool.h source file, line 43.
| Field | Description |
|---|---|
| struct urefcount * refcount; | pointer to refcount management structure |
| bool (*umem_alloc)(struct umem_mgr *, struct umem *, size_t ) ; | function to allocate a new memory block |
| bool (*umem_realloc)(struct umem *, size_t ) ; | function to resize umem |
| void (*umem_free)(struct umem *) ; | function to free a umem |
| void (*umem_mgr_vacuum)(struct umem_mgr *) ; | function to release all buffers kept in pools |