upipe/uref_pic.h header reference

Upipe wrapper for picture ubuf and uref More

• upipe/uref.h
• upipe/uref_attr.h
• upipe/ubuf.h
• upipe/ubuf_pic.h

• struct uref * uref_pic_alloc(struct uref_mgr *uref_mgr, struct ubuf_mgr *ubuf_mgr, int hsize, int vsize)
• int uref_pic_clear(struct uref *uref, int hoffset, int voffset, int hsize, int vsize)
• int uref_pic_cmp_bf(struct uref *uref1, struct uref *uref2)
• int uref_pic_cmp_hposition(struct uref *uref1, struct uref *uref2)
• int uref_pic_cmp_key(struct uref *uref1, struct uref *uref2)
• int uref_pic_cmp_number(struct uref *uref1, struct uref *uref2)
• int uref_pic_cmp_progressive(struct uref *uref1, struct uref *uref2)
• int uref_pic_cmp_tf(struct uref *uref1, struct uref *uref2)
• int uref_pic_cmp_tff(struct uref *uref1, struct uref *uref2)
• int uref_pic_cmp_vposition(struct uref *uref1, struct uref *uref2)
• int uref_pic_delete_bf(struct uref *uref)
• int uref_pic_delete_hposition(struct uref *uref)
• int uref_pic_delete_key(struct uref *uref)
• int uref_pic_delete_number(struct uref *uref)
• int uref_pic_delete_progressive(struct uref *uref)
• int uref_pic_delete_tf(struct uref *uref)
• int uref_pic_delete_tff(struct uref *uref)
• int uref_pic_delete_vposition(struct uref *uref)
• int uref_pic_get_bf(struct uref *uref)
• int uref_pic_get_hposition(struct uref *uref, uint64_t *p)
• int uref_pic_get_key(struct uref *uref)
• int uref_pic_get_number(struct uref *uref, uint64_t *p)
• int uref_pic_get_progressive(struct uref *uref)
• int uref_pic_get_tf(struct uref *uref)
• int uref_pic_get_tff(struct uref *uref)
• int uref_pic_get_vposition(struct uref *uref, uint64_t *p)
• int uref_pic_match_hposition(struct uref *uref, uint64_t min, uint64_t max)
• int uref_pic_match_number(struct uref *uref, uint64_t min, uint64_t max)
• int uref_pic_match_vposition(struct uref *uref, uint64_t min, uint64_t max)
• int uref_pic_plane_clear(struct uref *uref, const char *chroma, int hoffset, int voffset, int hsize, int vsize)
• int uref_pic_plane_iterate(struct uref *uref, const char **chroma_p)
• int uref_pic_plane_read(struct uref *uref, const char *chroma, int hoffset, int voffset, int hsize, int vsize, const uint8_t **buffer_p)
• int uref_pic_plane_size(struct uref *uref, const char *chroma, size_t *stride_p, uint8_t *hsub_p, uint8_t *vsub_p, uint8_t *macropixel_size_p)
• int uref_pic_plane_unmap(struct uref *uref, const char *chroma, int hoffset, int voffset, int hsize, int vsize)
• int uref_pic_plane_write(struct uref *uref, const char *chroma, int hoffset, int voffset, int hsize, int vsize, uint8_t **buffer_p)
• int uref_pic_replace(struct uref *uref, struct ubuf_mgr *ubuf_mgr, int hskip, int vskip, int new_hsize, int new_vsize)
• int uref_pic_resize(struct uref *uref, int hskip, int vskip, int new_hsize, int new_vsize)
• int uref_pic_set_bf(struct uref *uref)
• int uref_pic_set_hposition(struct uref *uref, uint64_t v)
• int uref_pic_set_key(struct uref *uref)
• int uref_pic_set_number(struct uref *uref, uint64_t v)
• int uref_pic_set_progressive(struct uref *uref)
• int uref_pic_set_tf(struct uref *uref)
• int uref_pic_set_tff(struct uref *uref)
• int uref_pic_set_vposition(struct uref *uref, uint64_t v)
• int uref_pic_size(struct uref *uref, size_t *hsize_p, size_t *vsize_p, uint8_t *macropixel_p)

Upipe wrapper for picture ubuf and uref

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

This function is declared in upipe/uref_pic.h source file, line 67.

This function returns a new uref pointing to a new ubuf pointing to a picture. 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
• hsize: horizontal size in pixels
• vsize: vertical size in lines

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

This function is declared in upipe/uref_pic.h source file, line 166.

See also ubuf_pic_clear function.

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

This function compares the bottom field present attribute in two refs.

Parameters 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_pic.h source file, line 47.

This function compares the horizontal position attribute in two refs.

Parameters 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_pic.h source file, line 45.

This function compares the key picture attribute in two refs.

Parameters 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_pic.h source file, line 44.

This function compares the picture number attribute in two refs.

Parameters 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_pic.h source file, line 50.

This function compares the progressive attribute in two refs.

Parameters 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_pic.h source file, line 51.

This function compares the top field present attribute in two refs.

Parameters 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_pic.h source file, line 53.

This function compares the top field first attribute in two refs.

Parameters 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_pic.h source file, line 49.

This function compares the vertical position attribute in two refs.

Parameters 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_pic.h source file, line 52.

This function deletes a bottom field present attribute from a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

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

This function deletes the horizontal position attribute of a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_pic.h source file, line 45.

This function deletes a key picture attribute from a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_pic.h source file, line 44.

This function deletes the picture number attribute of a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

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

This function deletes a progressive attribute from a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_pic.h source file, line 51.

This function deletes a top field present attribute from a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_pic.h source file, line 53.

This function deletes a top field first attribute from a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

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

This function deletes the vertical position attribute of a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

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

This function returns the presence of a bottom field present attribute in a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

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

This function returns the horizontal position attribute of a uref.

Parameters 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_pic.h source file, line 45.

This function returns the presence of a key picture attribute in a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_pic.h source file, line 44.

This function returns the picture number attribute of a uref.

Parameters 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_pic.h source file, line 50.

This function returns the presence of a progressive attribute in a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_pic.h source file, line 51.

This function returns the presence of a top field present attribute in a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_pic.h source file, line 53.

This function returns the presence of a top field first attribute in a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

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

This function returns the vertical position attribute of a uref.

Parameters 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_pic.h source file, line 47.

This function compares the horizontal position attribute to given values.

Parameters 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_pic.h source file, line 44.

This function compares the picture number attribute to given values.

Parameters 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_pic.h source file, line 49.

This function compares the vertical position attribute to given values.

Parameters 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_pic.h source file, line 147.

See also ubuf_pic_plane_clear function.

This function is declared in upipe/uref_pic.h source file, line 95.

See also ubuf_pic_plane_iterate function.

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

See also ubuf_pic_plane_read function.

This function is declared in upipe/uref_pic.h source file, line 105.

See also ubuf_pic_plane_size function.

This function is declared in upipe/uref_pic.h source file, line 137.

See also ubuf_pic_plane_unmap function.

This function is declared in upipe/uref_pic.h source file, line 127.

See also ubuf_pic_plane_write function.

This function is declared in upipe/uref_pic.h source file, line 191.

This function allocates a new ubuf of size new_hsize/new_vsize, and copies part of the old picture 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
• hskip: number of pixels to skip at the beginning of each line (if < 0, extend the picture leftwards)
• vskip: number of lines to skip at the beginning of the picture (if < 0, extend the picture upwards)
• new_hsize: final horizontal size of the buffer, in pixels (if set to -1, keep same line ends)
• new_vsize: final vertical size of the buffer, in lines (if set to -1, keep same last line)

The return value is an error code

This function is declared in upipe/uref_pic.h source file, line 157.

See also ubuf_pic_resize function.

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

This function sets a bottom field present attribute in a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

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

This function sets the horizontal position attribute of a uref.

Parameters list:

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

The return value is an error code

This function is declared in upipe/uref_pic.h source file, line 45.

This function sets a key picture attribute in a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_pic.h source file, line 44.

This function sets the picture number attribute of a uref.

Parameters list:

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

The return value is an error code

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

This function sets a progressive attribute in a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_pic.h source file, line 51.

This function sets a top field present attribute in a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

This function is declared in upipe/uref_pic.h source file, line 53.

This function sets a top field first attribute in a uref.

Parameters list:

• uref: pointer to the uref

The return value is an error code

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

This function sets the vertical position attribute of a uref.

Parameters list:

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

The return value is an error code

This function is declared in upipe/uref_pic.h source file, line 86.

See also ubuf_pic_size function.