Table of contents   Introduction   Installation   Overview   Tutorials   Rules   Reference   Changelog   Headers list   All declarations
Previous   Next
Upipe reference manual » API documentation » upipe/upipe.h header reference

upipe/upipe.h header reference

Upipe module-level interface, typically implemented by a module More

Header inclusion  

Members  

Macros  

Description  

Upipe module-level interface, typically implemented by a module

Members detail  

#define ARGS  

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

#define ARGS_DECL  

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

#define UPIPE_FLOW_SIGNATURE  

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

#define UPIPE_HELPER_ALLOC(GROUP, SIGNATURE)  

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

This macro declares twelve functions to allocate pipes with a certain pipe allocator.

Supposing the name of the allocator is upipe_foo, it declares:

  • struct upipe *upipe_foo_alloc(struct upipe_mgr *upipe_mgr,
    struct uprobe *uprobe, ...)

    The basic pipe allocator.

  • struct upipe *upipe_foo_alloc_output(struct upipe *upipe,
    struct upipe_mgr *upipe_mgr,
    struct uprobe *uprobe, ...)

    A wrapper to upipe_foo_alloc() which additionally sets the allocated pipe as the output of the upipe argument.

  • struct upipe *upipe_foo_chain_output(struct upipe *upipe,
    struct upipe_mgr *upipe_mgr,
    struct uprobe *uprobe, ...)

    A wrapper to upipe_foo_alloc_output() which additionally releases the upipe argument.

  • int upipe_foo_spawn_output(struct upipe *upipe,
    struct upipe_mgr *upipe_mgr,
    struct uprobe *uprobe, ...)

    A wrapper to upipe_foo_alloc_output() which additionally releases the allocated pipe.

  • struct upipe *upipe_foo_alloc_input(struct upipe *upipe,
    struct upipe_mgr *upipe_mgr,
    struct uprobe *uprobe, ...)

    A wrapper to upipe_foo_alloc() which additionally sets the upipe argument as the output of the allocated pipe.

  • struct upipe *upipe_foo_chain_input(struct upipe *upipe,
    struct upipe_mgr *upipe_mgr,
    struct uprobe *uprobe, ...)

    A wrapper to upipe_foo_alloc_input() which additionally releases the upipe argument.

  • struct upipe *upipe_foo_alloc_sub(struct upipe *super_pipe,
    struct uprobe *uprobe, ...)

    A wrapper to upipe_foo_alloc() which retrieves the subpipe manager from the given super-pipe.

  • struct upipe *upipe_foo_chain_sub(struct upipe *super_pipe,
    struct uprobe *uprobe, ...)

    A wrapper to upipe_foo_alloc_sub() which also releases the super-pipe.

  • struct upipe *upipe_foo_alloc_output_sub(struct upipe *upipe,
    struct upipe *super_pipe,
    struct uprobe *uprobe, ...)

    A wrapper to upipe_foo_alloc_sub() which additionally sets the allocated pipe as the output of the upipe argument.

  • struct upipe *upipe_foo_chain_output_sub(struct upipe *upipe,
    struct upipe *super_pipe,
    struct uprobe *uprobe, ...)

    A wrapper to upipe_foo_alloc_output_sub() which additionally releases the upipe argument.

  • int upipe_foo_spawn_output_sub(struct upipe *upipe,
    struct upipe *super_pipe,
    struct uprobe *uprobe, ...)

    A wrapper to upipe_foo_alloc_output_sub() which additionally releases the allocated pipe.

  • struct upipe *upipe_foo_alloc_input_sub(struct upipe *upipe,
    struct upipe *super_pipe,
    struct uprobe *uprobe, ...)

    A wrapper to upipe_foo_alloc_sub() which additionally sets the upipe argument as the output of the allocated pipe.

  • struct upipe *upipe_foo_chain_input_sub(struct upipe *upipe,
    struct upipe *super_pipe,
    struct uprobe *uprobe, ...)

    A wrapper to upipe_foo_alloc_input() which additionally releases the upipe argument.

Please note that you must declare upipe_foo_alloc before this helper, and the macros ARGS_DECL and ARGS must be filled respectively with the declaration of arguments of upipe_foo_alloc, and the use of them in the call to uprobe_foo_alloc (arguments after uprobe).

Parameter list:

  • GROUP: name of the allocator

#define UPIPE_VOID_SIGNATURE  

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

#define _UPIPE_UPIPE_H_  

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

#define upipe_dbg(upipe, msg)  

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

This macro throws a debug statement event. This event is thrown whenever a pipe wants to send a textual message.

Parameter list:

  • upipe: description structure of the pipe
  • msg: textual message

#define upipe_err(upipe, msg)  

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

This macro throws an error event. This event is thrown whenever a pipe wants to send a textual message.

Parameter list:

  • upipe: description structure of the pipe
  • msg: textual message

#define upipe_foreach_sub(UPIPE, SUB)  

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

This macro defines a helper to iterate over sub pipes.

Parameter list:

  • UPIPE: description of the pipe structure
  • SUB: name of the struct upipe * used to iterate

#define upipe_get_opaque(upipe, type)  

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

This macro gets the opaque member of a pipe.

Parameter list:

  • upipe: pointer to upipe
  • type: type to cast to

The return value is opaque

#define upipe_notice(upipe, msg)  

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

This macro throws a notice statement event. This event is thrown whenever a pipe wants to send a textual message.

Parameter list:

  • upipe: description structure of the pipe
  • msg: textual message

#define upipe_split_foreach(UPIPE, FLOW_DEF)  

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

This macro defines a helper to iterate over split.

Parameter list:

  • UPIPE: description of the pipe structure
  • FLOW_DEF: name of the struct uref * used to iterate

#define upipe_throw_error(upipe, errcode)  

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

This macro throws an error event.

Parameter list:

  • upipe: description structure of the pipe
  • errcode: error code

The return value is an error code

#define upipe_throw_fatal(upipe, errcode)  

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

This macro throws a fatal error event. After this event, the behaviour of a pipe is undefined, except for calls to upipe_release.

Parameter list:

  • upipe: description structure of the pipe
  • errcode: error code

The return value is an error code

#define upipe_verbose(upipe, msg)  

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

This macro throws a verbose statement event. This event is thrown whenever a pipe wants to send a textual message.

Parameter list:

  • upipe: description structure of the pipe
  • msg: textual message

#define upipe_warn(upipe, msg)  

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

This macro throws a warning event. This event is thrown whenever a pipe wants to send a textual message.

Parameter list:

  • upipe: description structure of the pipe
  • msg: textual message

#define UPIPE_CONTROL_TEMPLATE(group, GROUP, name, NAME, type, desc)  

This macro is for internal use only.

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

This macro allows to easily define accessors for control commands.

Parameter list:

  • group: group of commands in lower-case
  • GROUP: group of commands in upper-case
  • name: name of the command in lower-case
  • NAME: name of the command in upper-case
  • type: C-type representation of the parameter
  • desc: description for auto-generated documentation

#define upipe_log(upipe, level, msg)  

This macro is for internal use only.

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

This declaration involves expansion of the UBASE_FROM_TO, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, UBASE_FMT_PRINTF, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, likely, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, upipe_dbg, unlikely, UBASE_DEPRECATED, UPIPE_HELPER_ALLOC and UPIPE_HELPER_ALLOC macros.

This macro throws a log event. This event is thrown whenever a pipe wants to send a textual message.

Parameter list:

  • upipe: description structure of the pipe
  • level: level of importance of the message
  • msg: textual message
Table of contents   Introduction   Installation   Overview   Tutorials   Rules   Reference   Changelog   Headers list   All declarations
Previous   Next
Upipe reference manual » API documentation » upipe/upipe.h header reference

Valid XHTML 1.0 StrictGenerated by cmassiot on Fri Feb 2 23:57:19 2018 using MkDoc