Table of contents   Introduction   Installation   Overview   Tutorials   Rules   Reference   Changelog   Headers list   All declarations
Previous   Next
Upipe reference manual » API documentation » upipe/uref_block_flow.h header reference

upipe/uref_block_flow.h header reference

Upipe block flow definition attributes for uref More

Header inclusion  

Members  

Functions  

Description  

Upipe block flow definition attributes for uref

Members detail  

#define _UPIPE_UREF_BLOCK_FLOW_H_  

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

struct uref * uref_block_flow_alloc_def(struct uref_mgr *mgr, const char *def_suffix)  

This function is declared in upipe/uref_block_flow.h source file, line 72.

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

Parameter list:

  • mgr: uref management structure
  • def_suffix: suffix to append to "block." flow definition

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

struct uref * uref_block_flow_alloc_def_va(struct uref_mgr *mgr, const char *format, ...)  

This function is declared in upipe/uref_block_flow.h source file, line 98.

This function allocates a control packet to define a new block flow, with printf-style definition suffix generation

Parameter list:

  • mgr: uref management structure
  • def_suffix: suffix to append to "block." flow definition

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

void uref_block_flow_clear_format(struct uref *uref)  

This function is declared in upipe/uref_block_flow.h source file, line 108.

This function clears the attributes that are no longer relevant when the block is decoded.

Parameter list:

  • uref: uref control packet

int uref_block_flow_cmp_align(struct uref *uref1, struct uref *uref2)  

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

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

int uref_block_flow_cmp_align_offset(struct uref *uref1, struct uref *uref2)  

This function is declared in upipe/uref_block_flow.h source file, line 61.

This function compares the offset of the aligned octet 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

int uref_block_flow_cmp_append(struct uref *uref1, struct uref *uref2)  

This function is declared in upipe/uref_block_flow.h source file, line 59.

This function compares the extra bytes allocated after buffer 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

int uref_block_flow_cmp_buffer_size(struct uref *uref1, struct uref *uref2)  

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

This function compares the size of coded buffer 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

int uref_block_flow_cmp_max_buffer_size(struct uref *uref1, struct uref *uref2)  

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

This function compares the maximum size of coded buffer 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

int uref_block_flow_cmp_max_octetrate(struct uref *uref1, struct uref *uref2)  

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

This function compares the maximum octets per second for profile/level 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

int uref_block_flow_cmp_octetrate(struct uref *uref1, struct uref *uref2)  

This function is declared in upipe/uref_block_flow.h source file, line 48.

This function compares the octets 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

int uref_block_flow_cmp_prepend(struct uref *uref1, struct uref *uref2)  

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

This function compares the extra bytes allocated before buffer 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

int uref_block_flow_cmp_size(struct uref *uref1, struct uref *uref2)  

This function is declared in upipe/uref_block_flow.h source file, line 62.

This function compares the block size 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

int uref_block_flow_copy_align(struct uref *uref, struct uref *uref_src)  

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

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

int uref_block_flow_copy_align_offset(struct uref *uref, struct uref *uref_src)  

This function is declared in upipe/uref_block_flow.h source file, line 61.

This function copies the offset of the aligned octet 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

int uref_block_flow_copy_append(struct uref *uref, struct uref *uref_src)  

This function is declared in upipe/uref_block_flow.h source file, line 59.

This function copies the extra bytes allocated after buffer 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

int uref_block_flow_copy_buffer_size(struct uref *uref, struct uref *uref_src)  

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

This function copies the size of coded buffer 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

int uref_block_flow_copy_max_buffer_size(struct uref *uref, struct uref *uref_src)  

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

This function copies the maximum size of coded buffer 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

int uref_block_flow_copy_max_octetrate(struct uref *uref, struct uref *uref_src)  

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

This function copies the maximum octets per second for profile/level 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

int uref_block_flow_copy_octetrate(struct uref *uref, struct uref *uref_src)  

This function is declared in upipe/uref_block_flow.h source file, line 48.

This function copies the octets 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

int uref_block_flow_copy_prepend(struct uref *uref, struct uref *uref_src)  

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

This function copies the extra bytes allocated before buffer 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

int uref_block_flow_copy_size(struct uref *uref, struct uref *uref_src)  

This function is declared in upipe/uref_block_flow.h source file, line 62.

This function copies the block size 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

int uref_block_flow_delete_align(struct uref *uref)  

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

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

int uref_block_flow_delete_align_offset(struct uref *uref)  

This function is declared in upipe/uref_block_flow.h source file, line 61.

This function deletes the offset of the aligned octet attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_block_flow_delete_append(struct uref *uref)  

This function is declared in upipe/uref_block_flow.h source file, line 59.

This function deletes the extra bytes allocated after buffer attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_block_flow_delete_buffer_size(struct uref *uref)  

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

This function deletes the size of coded buffer in octets attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_block_flow_delete_max_buffer_size(struct uref *uref)  

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

This function deletes the maximum size of coded buffer in octets attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_block_flow_delete_max_octetrate(struct uref *uref)  

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

This function deletes the maximum octets per second for profile/level attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_block_flow_delete_octetrate(struct uref *uref)  

This function is declared in upipe/uref_block_flow.h source file, line 48.

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

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_block_flow_delete_prepend(struct uref *uref)  

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

This function deletes the extra bytes allocated before buffer attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_block_flow_delete_size(struct uref *uref)  

This function is declared in upipe/uref_block_flow.h source file, line 62.

This function deletes the block size attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_block_flow_get_align(struct uref *uref, uint64_t *p)  

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

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

int uref_block_flow_get_align_offset(struct uref *uref, int64_t *p)  

This function is declared in upipe/uref_block_flow.h source file, line 61.

This function returns the offset of the aligned octet 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

int uref_block_flow_get_append(struct uref *uref, uint64_t *p)  

This function is declared in upipe/uref_block_flow.h source file, line 59.

This function returns the extra bytes allocated after buffer 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

int uref_block_flow_get_buffer_size(struct uref *uref, uint64_t *p)  

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

This function returns the size of coded buffer 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

int uref_block_flow_get_max_buffer_size(struct uref *uref, uint64_t *p)  

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

This function returns the maximum size of coded buffer 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

int uref_block_flow_get_max_octetrate(struct uref *uref, uint64_t *p)  

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

This function returns the maximum octets per second for profile/level 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

int uref_block_flow_get_octetrate(struct uref *uref, uint64_t *p)  

This function is declared in upipe/uref_block_flow.h source file, line 48.

This function returns the octets 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

int uref_block_flow_get_prepend(struct uref *uref, uint64_t *p)  

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

This function returns the extra bytes allocated before buffer 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

int uref_block_flow_get_size(struct uref *uref, uint64_t *p)  

This function is declared in upipe/uref_block_flow.h source file, line 62.

This function returns the block size 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

int uref_block_flow_match_align(struct uref *uref, uint64_t min, uint64_t max)  

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

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

int uref_block_flow_match_append(struct uref *uref, uint64_t min, uint64_t max)  

This function is declared in upipe/uref_block_flow.h source file, line 59.

This function compares the extra bytes allocated after buffer attribute to given values.

Parameter list:

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

The return value is an error code

int uref_block_flow_match_buffer_size(struct uref *uref, uint64_t min, uint64_t max)  

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

This function compares the size of coded buffer 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

int uref_block_flow_match_max_buffer_size(struct uref *uref, uint64_t min, uint64_t max)  

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

This function compares the maximum size of coded buffer 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

int uref_block_flow_match_max_octetrate(struct uref *uref, uint64_t min, uint64_t max)  

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

This function compares the maximum octets per second for profile/level attribute to given values.

Parameter list:

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

The return value is an error code

int uref_block_flow_match_octetrate(struct uref *uref, uint64_t min, uint64_t max)  

This function is declared in upipe/uref_block_flow.h source file, line 48.

This function compares the octets 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

int uref_block_flow_match_prepend(struct uref *uref, uint64_t min, uint64_t max)  

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

This function compares the extra bytes allocated before buffer attribute to given values.

Parameter list:

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

The return value is an error code

int uref_block_flow_match_size(struct uref *uref, uint64_t min, uint64_t max)  

This function is declared in upipe/uref_block_flow.h source file, line 62.

This function compares the block size attribute to given values.

Parameter list:

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

The return value is an error code

int uref_block_flow_set_align(struct uref *uref, uint64_t v)  

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

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

int uref_block_flow_set_align_offset(struct uref *uref, int64_t v)  

This function is declared in upipe/uref_block_flow.h source file, line 61.

This function sets the offset of the aligned octet attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_block_flow_set_append(struct uref *uref, uint64_t v)  

This function is declared in upipe/uref_block_flow.h source file, line 59.

This function sets the extra bytes allocated after buffer attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_block_flow_set_buffer_size(struct uref *uref, uint64_t v)  

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

This function sets the size of coded buffer in octets attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_block_flow_set_max_buffer_size(struct uref *uref, uint64_t v)  

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

This function sets the maximum size of coded buffer in octets attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_block_flow_set_max_octetrate(struct uref *uref, uint64_t v)  

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

This function sets the maximum octets per second for profile/level attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_block_flow_set_octetrate(struct uref *uref, uint64_t v)  

This function is declared in upipe/uref_block_flow.h source file, line 48.

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

Parameter list:

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

The return value is an error code

int uref_block_flow_set_prepend(struct uref *uref, uint64_t v)  

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

This function sets the extra bytes allocated before buffer attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_block_flow_set_size(struct uref *uref, uint64_t v)  

This function is declared in upipe/uref_block_flow.h source file, line 62.

This function sets the block size attribute of a uref.

Parameter list:

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

The return value is an error code

#define UREF_BLOCK_FLOW_DEF  

This macro is for internal use only.

This macro is declared in upipe/uref_block_flow.h source file, line 45.

flow definition prefix for block allocator

Table of contents   Introduction   Installation   Overview   Tutorials   Rules   Reference   Changelog   Headers list   All declarations
Previous   Next
Upipe reference manual » API documentation » upipe/uref_block_flow.h header reference

Valid XHTML 1.0 StrictGenerated by cmassiot on Fri Feb 2 23:57:19 2018 using MkDoc