upipe/upipe_helper_upipe.h header reference

Upipe helper functions for public upipe structure More

• upipe/ubase.h
• upipe/upipe.h

• UPIPE_HELPER_UPIPE

Upipe helper functions for public upipe structure

This macro is declared in upipe/upipe_helper_upipe.h source file, line 67.

This macro declares two functions dealing with public and private parts of the allocated pipe structure.

You must add the upipe structure to your private pipe structure:

Supposing the name of your structure is upipe_foo, it declares:

• struct upipe *upipe_foo_to_upipe(struct upipe_foo *s)

  Returns a pointer to the public upipe structure.

• struct upipe_foo *upipe_foo_from_upipe(struct upipe *upipe)

  Returns a pointer to the private upipe_foo structure.

Parameter list:

• STRUCTURE: name of your private upipe structure
• UPIPE: name of the struct upipe field of your private upipe structure
• SIGNATURE: signature of the manager of the upipe

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