upipe/uref_sound_flow.h header reference

Upipe sound flow definition attributes for uref More

• upipe/uref.h
• upipe/uref_attr.h
• upipe/uref_flow.h

• int uref_sound_flow_add_plane(struct uref *uref, const char *channel)
• struct uref * uref_sound_flow_alloc_def(struct uref_mgr *mgr, const char *format, uint8_t channels, uint8_t sample_size)
• int uref_sound_flow_check_channel(struct uref *uref, const char *channel)
• void uref_sound_flow_clear_format(struct uref *uref)
• int uref_sound_flow_cmp_align(struct uref *uref1, struct uref *uref2)
• int uref_sound_flow_cmp_channel(struct uref *uref1, struct uref *uref2, uint8_t plane)
• int uref_sound_flow_cmp_channels(struct uref *uref1, struct uref *uref2)
• int uref_sound_flow_cmp_planes(struct uref *uref1, struct uref *uref2)
• int uref_sound_flow_cmp_rate(struct uref *uref1, struct uref *uref2)
• int uref_sound_flow_cmp_raw_sample_size(struct uref *uref1, struct uref *uref2)
• int uref_sound_flow_cmp_sample_size(struct uref *uref1, struct uref *uref2)
• int uref_sound_flow_cmp_samples(struct uref *uref1, struct uref *uref2)
• bool uref_sound_flow_compare_format(struct uref *uref1, struct uref *uref2)
• int uref_sound_flow_copy_align(struct uref *uref, struct uref *uref_src)
• int uref_sound_flow_copy_channel(struct uref *uref, struct uref *uref_src, uint8_t plane)
• int uref_sound_flow_copy_channels(struct uref *uref, struct uref *uref_src)
• int uref_sound_flow_copy_format(struct uref *uref_dst, struct uref *uref_src)
• int uref_sound_flow_copy_planes(struct uref *uref, struct uref *uref_src)
• int uref_sound_flow_copy_rate(struct uref *uref, struct uref *uref_src)
• int uref_sound_flow_copy_raw_sample_size(struct uref *uref, struct uref *uref_src)
• int uref_sound_flow_copy_sample_size(struct uref *uref, struct uref *uref_src)
• int uref_sound_flow_copy_samples(struct uref *uref, struct uref *uref_src)
• int uref_sound_flow_delete_align(struct uref *uref)
• int uref_sound_flow_delete_channel(struct uref *uref, uint8_t plane)
• int uref_sound_flow_delete_channels(struct uref *uref)
• int uref_sound_flow_delete_planes(struct uref *uref)
• int uref_sound_flow_delete_rate(struct uref *uref)
• int uref_sound_flow_delete_raw_sample_size(struct uref *uref)
• int uref_sound_flow_delete_sample_size(struct uref *uref)
• int uref_sound_flow_delete_samples(struct uref *uref)
• int uref_sound_flow_get_align(struct uref *uref, uint64_t *p)
• int uref_sound_flow_get_channel(struct uref *uref, const char **p, uint8_t plane)
• int uref_sound_flow_get_channels(struct uref *uref, uint8_t *p)
• int uref_sound_flow_get_planes(struct uref *uref, uint8_t *p)
• int uref_sound_flow_get_rate(struct uref *uref, uint64_t *p)
• int uref_sound_flow_get_raw_sample_size(struct uref *uref, uint8_t *p)
• int uref_sound_flow_get_sample_size(struct uref *uref, uint8_t *p)
• int uref_sound_flow_get_samples(struct uref *uref, uint64_t *p)
• int uref_sound_flow_match_align(struct uref *uref, uint64_t min, uint64_t max)
• int uref_sound_flow_match_channel(struct uref *uref, const char *prefix, uint8_t plane)
• int uref_sound_flow_match_channels(struct uref *uref, uint8_t min, uint8_t max)
• int uref_sound_flow_match_planes(struct uref *uref, uint8_t min, uint8_t max)
• int uref_sound_flow_match_rate(struct uref *uref, uint64_t min, uint64_t max)
• int uref_sound_flow_match_raw_sample_size(struct uref *uref, uint8_t min, uint8_t max)
• int uref_sound_flow_match_sample_size(struct uref *uref, uint8_t min, uint8_t max)
• int uref_sound_flow_match_samples(struct uref *uref, uint64_t min, uint64_t max)
• int uref_sound_flow_set_align(struct uref *uref, uint64_t v)
• int uref_sound_flow_set_channel(struct uref *uref, const char *v, uint8_t plane)
• int uref_sound_flow_set_channels(struct uref *uref, uint8_t v)
• int uref_sound_flow_set_planes(struct uref *uref, uint8_t v)
• int uref_sound_flow_set_rate(struct uref *uref, uint64_t v)
• int uref_sound_flow_set_raw_sample_size(struct uref *uref, uint8_t v)
• int uref_sound_flow_set_sample_size(struct uref *uref, uint8_t v)
• int uref_sound_flow_set_samples(struct uref *uref, uint64_t v)

Upipe sound flow definition attributes for uref

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

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

This function registers a new plane in the sound flow definition packet.

Parameter list:

• uref: uref control packet
• channel: channel type (see channel reference)

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 71.

This function allocates a control packet to define a new sound flow.

Parameter list:

• mgr: uref management structure
• format: format string
• channels: number of channels
• sample_size: size in octets of a sample of an audio plane

The return value is pointer to uref control packet, or NULL in case of error

This function is declared in upipe/uref_sound_flow.h source file, line 138.

This function checks if there is a plane with the given properties.

Parameter list:

• uref: uref control packet
• channel: channel type

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 175.

This function clears the attributes defining the ubuf_sound manager format.

Parameter list:

• uref: uref control packet

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

This function compares the alignment in octets attribute in two urefs.

Parameter list:

• uref1: pointer to the first uref
• uref2: pointer to the second uref

The return value is 0 if both attributes are absent or identical

This function is declared in upipe/uref_sound_flow.h source file, line 49.

This function compares the channel type attribute in two urefs.

Parameter list:

• uref1: pointer to the first uref
• uref2: pointer to the second uref

The return value is 0 if both attributes are absent or identical

This function is declared in upipe/uref_sound_flow.h source file, line 50.

This function compares the number of channels attribute in two urefs.

Parameter list:

• uref1: pointer to the first uref
• uref2: pointer to the second uref

The return value is 0 if both attributes are absent or identical

This function is declared in upipe/uref_sound_flow.h source file, line 47.

This function compares the number of planes attribute in two urefs.

Parameter list:

• uref1: pointer to the first uref
• uref2: pointer to the second uref

The return value is 0 if both attributes are absent or identical

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

This function compares the samples per second attribute in two urefs.

Parameter list:

• uref1: pointer to the first uref
• uref2: pointer to the second uref

The return value is 0 if both attributes are absent or identical

This function is declared in upipe/uref_sound_flow.h source file, line 54.

This function compares the size in bits of an audio sample attribute in two urefs.

Parameter list:

• uref1: pointer to the first uref
• uref2: pointer to the second uref

The return value is 0 if both attributes are absent or identical

This function is declared in upipe/uref_sound_flow.h source file, line 52.

This function compares the size in octets of a sample of an audio plane attribute in two urefs.

Parameter list:

• uref1: pointer to the first uref
• uref2: pointer to the second uref

The return value is 0 if both attributes are absent or identical

This function is declared in upipe/uref_sound_flow.h source file, line 56.

This function compares the number of samples attribute in two urefs.

Parameter list:

• uref1: pointer to the first uref
• uref2: pointer to the second uref

The return value is 0 if both attributes are absent or identical

This function is declared in upipe/uref_sound_flow.h source file, line 195.

This function compares the format flow definition between two urefs.

Parameter list:

• uref1: first uref
• uref2: second uref

The return value is true if both urefs describe the same format

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

This function copies the alignment in octets attribute from an uref to another.

Parameter list:

• uref: pointer to the uref
• uref_src: pointer to the source uref

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 49.

This function copies the channel type attribute from an uref to another.

Parameter list:

• uref: pointer to the uref
• uref_src: pointer to the source uref

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 50.

This function copies the number of channels attribute from an uref to another.

Parameter list:

• uref: pointer to the uref
• uref_src: pointer to the source uref

The return value is an error code

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

This function copies the attributes defining the ubuf manager format to another uref.

Parameter list:

• uref_dst: destination uref
• uref_src: source uref

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 47.

This function copies the number of planes attribute from an uref to another.

Parameter list:

• uref: pointer to the uref
• uref_src: pointer to the source uref

The return value is an error code

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

This function copies the samples per second attribute from an uref to another.

Parameter list:

• uref: pointer to the uref
• uref_src: pointer to the source uref

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 54.

This function copies the size in bits of an audio sample attribute from an uref to another.

Parameter list:

• uref: pointer to the uref
• uref_src: pointer to the source uref

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 52.

This function copies the size in octets of a sample of an audio plane attribute from an uref to another.

Parameter list:

• uref: pointer to the uref
• uref_src: pointer to the source uref

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 56.

This function copies the number of samples attribute from an uref to another.

Parameter list:

• uref: pointer to the uref
• uref_src: pointer to the source uref

The return value is an error code

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

This function deletes the alignment in octets attribute of a uref.

Parameter list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 49.

This function deletes the channel type attribute of a uref.

Parameter list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 50.

This function deletes the number of channels attribute of a uref.

Parameter list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 47.

This function deletes the number of planes attribute of a uref.

Parameter list:

• uref: pointer to the uref

The return value is an error code

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

This function deletes the samples per second attribute of a uref.

Parameter list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 54.

This function deletes the size in bits of an audio sample attribute of a uref.

Parameter list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 52.

This function deletes the size in octets of a sample of an audio plane attribute of a uref.

Parameter list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 56.

This function deletes the number of samples attribute of a uref.

Parameter list:

• uref: pointer to the uref

The return value is an error code

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

This function returns the alignment in octets attribute of a uref.

Parameter list:

• uref: pointer to the uref
• p: pointer to the retrieved value (modified during execution)

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 49.

This function returns the channel type attribute of a uref.

Parameter list:

• uref: pointer to the uref
• p: pointer to the retrieved value (modified during execution)

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 50.

This function returns the number of channels attribute of a uref.

Parameter list:

• uref: pointer to the uref
• p: pointer to the retrieved value (modified during execution)

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 47.

This function returns the number of planes attribute of a uref.

Parameter list:

• uref: pointer to the uref
• p: pointer to the retrieved value (modified during execution)

The return value is an error code

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

This function returns the samples per second attribute of a uref.

Parameter list:

• uref: pointer to the uref
• p: pointer to the retrieved value (modified during execution)

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 54.

This function returns the size in bits of an audio sample attribute of a uref.

Parameter list:

• uref: pointer to the uref
• p: pointer to the retrieved value (modified during execution)

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 52.

This function returns the size in octets of a sample of an audio plane attribute of a uref.

Parameter list:

• uref: pointer to the uref
• p: pointer to the retrieved value (modified during execution)

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 56.

This function returns the number of samples attribute of a uref.

Parameter list:

• uref: pointer to the uref
• p: pointer to the retrieved value (modified during execution)

The return value is an error code

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

This function compares the alignment in octets attribute to given values.

Parameter list:

• uref: pointer to the uref
• min: minimum value
• max: maximum value

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 49.

This function compares the channel type attribute to a given prefix.

Parameter list:

• uref: pointer to the uref
• prefix: prefix to match

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 50.

This function compares the number of channels attribute to given values.

Parameter list:

• uref: pointer to the uref
• min: minimum value
• max: maximum value

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 47.

This function compares the number of planes attribute to given values.

Parameter list:

• uref: pointer to the uref
• min: minimum value
• max: maximum value

The return value is an error code

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

This function compares the samples per second attribute to given values.

Parameter list:

• uref: pointer to the uref
• min: minimum value
• max: maximum value

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 54.

This function compares the size in bits of an audio sample attribute to given values.

Parameter list:

• uref: pointer to the uref
• min: minimum value
• max: maximum value

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 52.

This function compares the size in octets of a sample of an audio plane attribute to given values.

Parameter list:

• uref: pointer to the uref
• min: minimum value
• max: maximum value

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 56.

This function compares the number of samples attribute to given values.

Parameter list:

• uref: pointer to the uref
• min: minimum value
• max: maximum value

The return value is an error code

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

This function sets the alignment in octets attribute of a uref.

Parameter list:

• uref: pointer to the uref
• v: value to set

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 49.

This function sets the channel type attribute of a uref.

Parameter list:

• uref: pointer to the uref
• v: value to set

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 50.

This function sets the number of channels attribute of a uref.

Parameter list:

• uref: pointer to the uref
• v: value to set

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 47.

This function sets the number of planes attribute of a uref.

Parameter list:

• uref: pointer to the uref
• v: value to set

The return value is an error code

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

This function sets the samples per second attribute of a uref.

Parameter list:

• uref: pointer to the uref
• v: value to set

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 54.

This function sets the size in bits of an audio sample attribute of a uref.

Parameter list:

• uref: pointer to the uref
• v: value to set

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 52.

This function sets the size in octets of a sample of an audio plane attribute of a uref.

Parameter list:

• uref: pointer to the uref
• v: value to set

The return value is an error code

This function is declared in upipe/uref_sound_flow.h source file, line 56.

This function sets the number of samples attribute of a uref.

Parameter list:

• uref: pointer to the uref
• v: value to set

The return value is an error code

This macro is for internal use only.

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

flow definition prefix for sound allocator

This function is for internal use only.

This function is declared in upipe/uref_sound_flow.h source file, line 114.

This function finds a plane by its channel.

Parameter list:

• uref: uref control packet
• channel: channel type
• plane_p: written with the matching plane number

The return value is an error code