upipe/uref_sound.h header reference

Upipe wrapper for sound ubuf and uref More

Header inclusion  

Members  

Functions  

Description  

Upipe wrapper for sound ubuf and uref

Members detail  

#define UREF_SOUND_MAP_TEMPLATE(type)  

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

#define _UPIPE_UREF_SOUND_H_  

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)  

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

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.

Parameters 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

int uref_sound_plane_iterate(struct uref *uref, const char **channel_p)  

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

See also ubuf_sound_plane_iterate function.

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

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

See also ubuf_sound_plane_read_double function.

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

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

See also ubuf_sound_plane_read_float function.

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

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

See also ubuf_sound_plane_read_int16_t function.

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

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

See also ubuf_sound_plane_read_int32_t function.

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

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

See also ubuf_sound_plane_read_uint8_t function.

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

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

See also ubuf_sound_plane_read_void function.

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

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

See also ubuf_sound_plane_unmap function.

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

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

See also ubuf_sound_plane_write_double function.

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

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

See also ubuf_sound_plane_write_float function.

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

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

See also ubuf_sound_plane_write_int16_t function.

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

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

See also ubuf_sound_plane_write_int32_t function.

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

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

See also ubuf_sound_plane_write_uint8_t function.

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

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

See also ubuf_sound_plane_write_void function.

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

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

See also ubuf_sound_read_double function.

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

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

See also ubuf_sound_read_float function.

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

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

See also ubuf_sound_read_int16_t function.

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

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

See also ubuf_sound_read_int32_t function.

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

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

See also ubuf_sound_read_uint8_t function.

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

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

See also ubuf_sound_read_void function.

int uref_sound_replace(struct uref *uref, struct ubuf_mgr *ubuf_mgr, int skip, int new_size)  

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

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.

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

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

See also ubuf_sound_resize function.

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

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

See also ubuf_sound_size function.

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

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

See also ubuf_sound_unmap function.

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

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

See also ubuf_sound_write_double function.

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

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

See also ubuf_sound_write_float function.

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

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

See also ubuf_sound_write_int16_t function.

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

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

See also ubuf_sound_write_int32_t function.

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

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

See also ubuf_sound_write_uint8_t function.

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

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

See also ubuf_sound_write_void function.

Valid XHTML 1.0 StrictGenerated by cmassiot on Thu Nov 6 12:15:45 2014 using MkDoc