upipe/upipe_helper_source_read_size.h header reference

Upipe helper functions for read size More

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

• UPIPE_HELPER_SOURCE_READ_SIZE

Upipe helper functions for read size

This macro is declared in upipe/upipe_helper_source_read_size.h source file, line 90.

This macro declares four functions dealing with the read size of a source pipe.

You must add one member 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, it declares:

• void upipe_foo_init_read_size(struct upipe *upipe, unsigned int read_size)

  Typically called in your upipe_foo_alloc() function. The read_size parameter is used for initialization.

• int upipe_foo_get_read_size(struct upipe *upipe, unsigned int *p)

  Typically called from your upipe_foo_control() handler, such as:

  case UPIPE_SOURCE_GET_READ_SIZE: {
unsgigned int *p = va_arg(args, unsigned int *);
return upipe_foo_get_read_size(upipe, p);
}
• int upipe_foo_set_read_size(struct upipe *upipe, unsigned int read_size)

  Typically called from your upipe_foo_control() handler, such as:

  case UPIPE_SET_READ_SIZE: {
unsigned int read_size = va_arg(args, unsigned int);
return upipe_foo_set_read_size(upipe, read_size);
}
• void upipe_foo_clean_read_size(struct upipe *upipe)

  Typically called from your upipe_foo_free() function.

Parameters list:

• STRUCTURE: name of your private upipe structure
• READ_SIZE: name of the unsigned int field of your private upipe structure

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