upipe/upipe_helper_uclock.h header reference

Upipe helper functions for uclock More

Header inclusion [link]

Members [link]

Types [link]

typedef int (*upipe_helper_uclock_check)(struct upipe *, struct uref *)
typedef int (*upipe_helper_uclock_register)(struct upipe *, struct urequest *)

Description [link]

Upipe helper functions for uclock

Members detail [link]

#define UPIPE_HELPER_UCLOCK(STRUCTURE, UCLOCK, REQUEST, CHECK, REGISTER, UNREGISTER) [link]

This macro is declared in upipe/upipe_helper_uclock.h source file, line 95.

This macro declares four functions dealing with the uclock.

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

  struct uclock *uclock;
  struct urequest uclock_request;

You must also declare UPIPE_HELPER_UPIPE prior to using this macro, and provide two functions which will be called 1/ when the uclock is provided, 2/ and 3/ when a request needs to be registered/unregistered.

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

void upipe_foo_init_uclock(struct upipe *upipe)
Typically called in your upipe_foo_alloc() function.
int upipe_foo_provide_uclock(struct upipe *upipe, va_list args)
Internal function called when the request is answered.
int upipe_foo_require_uclock(struct upipe *upipe)
Initializes and registers the request to get a uclock.
void upipe_foo_clean_uclock(struct upipe *upipe)
Typically called from your upipe_foo_free() function.

Parameter list:

STRUCTURE: name of your private upipe structure
UCLOCK: name of the struct uclock * field of your private upipe structure
REQUEST: name of the struct urequest field of your private upipe structure
CHECK: function called after a uclock has been received
REGISTER: function called to register a request
UNREGISTER: function called to unregister a request

#define _UPIPE_UPIPE_HELPER_UCLOCK_H_ [link]

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

typedef int (upipe_helper_uclock_check)(struct upipe , struct uref *) [link]

This typedef is declared in upipe/upipe_helper_uclock.h source file, line 46.

This typedef defines a function that will be called after a uclock has been received. The second argument is an unused uref.

typedef int (upipe_helper_uclock_register)(struct upipe , struct urequest *) [link]

This typedef is declared in upipe/upipe_helper_uclock.h source file, line 50.

This typedef defines a function that will be called to register or unregister a request.