upipe/upipe_helper_inner.h header reference

Upipe helper functions for inner pipes More

• UPIPE_HELPER_INNER

Upipe helper functions for inner pipes

This macro is declared in upipe/upipe_helper_inner.h source file, line 73.

This macro declares functions dealing with inner pipes, which internally implement an inner pipeline to handle a given task.

You must add four members to your private upipe structure, for instance:

You must also declare UPIPE_HELPER_UPIPE prior to using this macro.

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

• void upipe_foo_init_inner(struct upipe *upipe)

  Typically called in your upipe_foo_alloc() function.

• void upipe_foo_store_inner(struct upipe *upipe, struct upipe *inner)

  Called whenever you change the inner pipe of this pipe.

• int upipe_foo_control_inner(struct upipe *upipe,
enum upipe_command command, va_list args)

  Typically called from your upipe_foo_control() handler. It acts as a proxy for commands.

• void upipe_foo_clean_inner(struct upipe *upipe)

  Typically called from your upipe_foo_free() function.

Parameter list:

• STRUCTURE: name of your private upipe structure
• INNER: name of the struct upipe * field of your private upipe structure, pointing to the inner pipe

This macro is declared in upipe/upipe_helper_inner.h source file, line 28.