upipe/uref_sound.h header reference

Upipe wrapper for sound ubuf and uref More

Header inclusion [link] 

Members [link] 

Functions [link] 

Macro [link] 

Description [link] 

Upipe wrapper for sound ubuf and uref

Members detail [link] 

#define UREF_SOUND_MAP_TEMPLATE(type) [link] 

This macro is declared in upipe/uref_sound.h source file, line 121.

#define _UPIPE_UREF_SOUND_H_ [link] 

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

struct uref * uref_sound_alloc(struct uref_mgr *uref_mgr, struct ubuf_mgr *ubuf_mgr, int size) [link] 

This function is declared in upipe/uref_sound.h source file, line 57.

This function returns a new uref pointing to a new ubuf pointing to a sound. This is equivalent to the two operations sequentially, and is a shortcut.

Parameter list:

  • uref_mgr: management structure for this uref type
  • ubuf_mgr: management structure for this ubuf type
  • size: size in samples

The return value is pointer to uref or NULL in case of failure

#define uref_sound_foreach_plane(UREF, CHANNEL) [link] 

This macro is declared in upipe/uref_sound.h source file, line 98.

helper for uref_sound_iterate_plane

int uref_sound_interleave(struct uref *uref, uint8_t *buf, int offset, int samples, uint8_t sample_size, uint8_t planes) [link] 

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

See also ubuf_sound_interleave.

int uref_sound_iterate_plane(struct uref *uref, const char **channel_p) [link] 

This function is declared in upipe/uref_sound.h source file, line 84.

See also ubuf_sound_iterate_plane.

int uref_sound_plane_iterate(struct uref *uref, const char **channel_p) [link] 

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

This declaration involves expansion of the UBASE_DEPRECATED macro.

DO NOT USE: deprecated, use uref_sound_iterate_plane instead

int uref_sound_plane_read_double(struct uref *uref, const char *channel, int offset, int size, const double **buffer_p) [link] 

This function is declared in upipe/uref_sound.h source file, line 165.

See also ubuf_sound_plane_read_double.

int uref_sound_plane_read_float(struct uref *uref, const char *channel, int offset, int size, const float **buffer_p) [link] 

This function is declared in upipe/uref_sound.h source file, line 164.

See also ubuf_sound_plane_read_float.

int uref_sound_plane_read_int16_t(struct uref *uref, const char *channel, int offset, int size, const int16_t **buffer_p) [link] 

This function is declared in upipe/uref_sound.h source file, line 162.

See also ubuf_sound_plane_read_int16_t.

int uref_sound_plane_read_int32_t(struct uref *uref, const char *channel, int offset, int size, const int32_t **buffer_p) [link] 

This function is declared in upipe/uref_sound.h source file, line 163.

See also ubuf_sound_plane_read_int32_t.

int uref_sound_plane_read_uint8_t(struct uref *uref, const char *channel, int offset, int size, const uint8_t **buffer_p) [link] 

This function is declared in upipe/uref_sound.h source file, line 161.

See also ubuf_sound_plane_read_uint8_t.

int uref_sound_plane_read_void(struct uref *uref, const char *channel, int offset, int size, const void **buffer_p) [link] 

This function is declared in upipe/uref_sound.h source file, line 160.

See also ubuf_sound_plane_read_void.

int uref_sound_plane_unmap(struct uref *uref, const char *channel, int offset, int size) [link] 

This function is declared in upipe/uref_sound.h source file, line 107.

See also ubuf_sound_plane_unmap.

int uref_sound_plane_write_double(struct uref *uref, const char *channel, int offset, int size, double **buffer_p) [link] 

This function is declared in upipe/uref_sound.h source file, line 165.

See also ubuf_sound_plane_write_double.

int uref_sound_plane_write_float(struct uref *uref, const char *channel, int offset, int size, float **buffer_p) [link] 

This function is declared in upipe/uref_sound.h source file, line 164.

See also ubuf_sound_plane_write_float.

int uref_sound_plane_write_int16_t(struct uref *uref, const char *channel, int offset, int size, int16_t **buffer_p) [link] 

This function is declared in upipe/uref_sound.h source file, line 162.

See also ubuf_sound_plane_write_int16_t.

int uref_sound_plane_write_int32_t(struct uref *uref, const char *channel, int offset, int size, int32_t **buffer_p) [link] 

This function is declared in upipe/uref_sound.h source file, line 163.

See also ubuf_sound_plane_write_int32_t.

int uref_sound_plane_write_uint8_t(struct uref *uref, const char *channel, int offset, int size, uint8_t **buffer_p) [link] 

This function is declared in upipe/uref_sound.h source file, line 161.

See also ubuf_sound_plane_write_uint8_t.

int uref_sound_plane_write_void(struct uref *uref, const char *channel, int offset, int size, void **buffer_p) [link] 

This function is declared in upipe/uref_sound.h source file, line 160.

See also ubuf_sound_plane_write_void.

int uref_sound_read_double(struct uref *uref, int offset, int size, const double *buffers_p[], uint8_t planes) [link] 

This function is declared in upipe/uref_sound.h source file, line 165.

See also ubuf_sound_read_double.

int uref_sound_read_float(struct uref *uref, int offset, int size, const float *buffers_p[], uint8_t planes) [link] 

This function is declared in upipe/uref_sound.h source file, line 164.

See also ubuf_sound_read_float.

int uref_sound_read_int16_t(struct uref *uref, int offset, int size, const int16_t *buffers_p[], uint8_t planes) [link] 

This function is declared in upipe/uref_sound.h source file, line 162.

See also ubuf_sound_read_int16_t.

int uref_sound_read_int32_t(struct uref *uref, int offset, int size, const int32_t *buffers_p[], uint8_t planes) [link] 

This function is declared in upipe/uref_sound.h source file, line 163.

See also ubuf_sound_read_int32_t.

int uref_sound_read_uint8_t(struct uref *uref, int offset, int size, const uint8_t *buffers_p[], uint8_t planes) [link] 

This function is declared in upipe/uref_sound.h source file, line 161.

See also ubuf_sound_read_uint8_t.

int uref_sound_read_void(struct uref *uref, int offset, int size, const void *buffers_p[], uint8_t planes) [link] 

This function is declared in upipe/uref_sound.h source file, line 160.

See also ubuf_sound_read_void.

int uref_sound_replace(struct uref *uref, struct ubuf_mgr *ubuf_mgr, int skip, int new_size) [link] 

This function is declared in upipe/uref_sound.h source file, line 201.

This function allocates a new ubuf of size new_size, and copies part of the old sound ubuf to the new one, switches the ubufs and frees the old one.

Parameter list:

  • uref: pointer to uref structure
  • ubuf_mgr: management structure for the new ubuf
  • skip: number of samples to skip at the beginning of each plane (if < 0, extend the sound upwards)
  • new_size: final size of the buffer, in samples (if set to -1, keep same end)

The return value is an error code

int uref_sound_resize(struct uref *uref, int skip, int new_size) [link] 

This function is declared in upipe/uref_sound.h source file, line 170.

See also ubuf_sound_resize.

int uref_sound_size(struct uref *uref, size_t *size_p, uint8_t *sample_size_p) [link] 

This function is declared in upipe/uref_sound.h source file, line 75.

See also ubuf_sound_size.

int uref_sound_unmap(struct uref *uref, int offset, int size, uint8_t planes) [link] 

This function is declared in upipe/uref_sound.h source file, line 116.

See also ubuf_sound_unmap.

int uref_sound_write_double(struct uref *uref, int offset, int size, double *buffers_p[], uint8_t planes) [link] 

This function is declared in upipe/uref_sound.h source file, line 165.

See also ubuf_sound_write_double.

int uref_sound_write_float(struct uref *uref, int offset, int size, float *buffers_p[], uint8_t planes) [link] 

This function is declared in upipe/uref_sound.h source file, line 164.

See also ubuf_sound_write_float.

int uref_sound_write_int16_t(struct uref *uref, int offset, int size, int16_t *buffers_p[], uint8_t planes) [link] 

This function is declared in upipe/uref_sound.h source file, line 162.

See also ubuf_sound_write_int16_t.

int uref_sound_write_int32_t(struct uref *uref, int offset, int size, int32_t *buffers_p[], uint8_t planes) [link] 

This function is declared in upipe/uref_sound.h source file, line 163.

See also ubuf_sound_write_int32_t.

int uref_sound_write_uint8_t(struct uref *uref, int offset, int size, uint8_t *buffers_p[], uint8_t planes) [link] 

This function is declared in upipe/uref_sound.h source file, line 161.

See also ubuf_sound_write_uint8_t.

int uref_sound_write_void(struct uref *uref, int offset, int size, void *buffers_p[], uint8_t planes) [link] 

This function is declared in upipe/uref_sound.h source file, line 160.

See also ubuf_sound_write_void.

int uref_sound_consume(struct uref *uref, size_t consume, uint64_t samplerate) [link] 

This function is for internal use only.

This function is declared in upipe/uref_sound.h source file, line 217.

This function consumes samples off a sound uref, and adjusts dates and duration accordingly.

Parameter list:

  • uref: uref structure
  • consume: number of samples to consume from uref
  • samplerate: sample rate

The return value is an error code

Valid XHTML 1.0 StrictGenerated by cmassiot on Sun Dec 14 18:31:17 2025 using MkDoc