upipe/upipe.h header reference

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

• upipe/ubase.h
• upipe/urefcount.h
• upipe/uprobe.h
• upipe/urequest.h
• upipe/udict_dump.h

Upipe module-level interface, typically implemented by a module

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

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

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

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

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

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

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

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

This struct is declared in upipe/ubuf_mem.h source file, line 42.

This struct is declared in upipe/uprobe_uclock.h source file, line 42.

This struct is declared in upipe/upipe.h source file, line 170.

This function is declared in upipe/upipe.h source file, line 1276.

This function sends a request to attach a ubuf manager.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1266.

This function sends a request to attach a uclock.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1256.

This function sends a request to attach a upump manager.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1246.

This function sends a request to attach a uref manager.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1406.

This function freezes the inner pipes if they are in a worker thread.

Parameter list:

• upipe: description structure of the bin pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1428.

This function returns the first inner pipe of the bin for debug purposes.

Parameter list:

• upipe: description structure of the bin pipe
• p: filled in with a pointer to the first inner pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1440.

This function returns the last inner pipe of the bin for debug purposes.

Parameter list:

• upipe: description structure of the bin pipe
• p: filled in with a pointer to the last inner pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1416.

This function thaws the inner pipes if they are in a worker thread.

Parameter list:

• upipe: description structure of the bin pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 580.

This function should be called by the module writer before it disposes of its upipe structure.

Parameter list:

• upipe: description structure of the pipe

This enum is declared in upipe/upipe.h source file, line 66.

This enum defines standard commands which upipe modules may implement.

This function is declared in upipe/upipe.h source file, line 353.

This function return the corresponding command string.

Parameter list:

• upipe: description structure of the pipe
• cmd: the command value

The return value is the command string

This function is declared in upipe/upipe.h source file, line 840.

This function handles control commands for registering/unregistering request when an event need to be thrown.

Parameter list:

• upipe: description structure of the pipe
• command: control command to handle
• args: optional arguments

The return value is an error code

This function is declared in upipe/upipe.h source file, line 690.

This function 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
• msg: textual message

This function is declared in upipe/upipe.h source file, line 690.

This function throws a log event, with printf-style message generation.

Parameter list:

• upipe: description structure of the pipe
• format: format of the textual message, followed by optional arguments

This function is declared in upipe/upipe.h source file, line 519.

This function checks if the pipe has no more references.

Parameter list:

• upipe: pointer to upipe

The return value is true if there is no reference to the pipe

This function is declared in upipe/upipe.h source file, line 1324.

This function ends the preroll period in a pipe.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 686.

This function 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
• msg: textual message

This function is declared in upipe/upipe.h source file, line 337.

This function return the corresponding error string.

Parameter list:

• upipe: description structure of the pipe
• err: the error value

The return value is the error string

This function is declared in upipe/upipe.h source file, line 686.

This function throws a log event, with printf-style message generation.

Parameter list:

• upipe: description structure of the pipe
• format: format of the textual message, followed by optional arguments

This function is declared in upipe/upipe.h source file, line 406.

This function return the corresponding event string.

Parameter list:

• upipe: description structure of the pipe
• event: the event value

The return value is the event string

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 15 in upipe/upipe.h source file, line 1944.

This function allocates and initializes a pipe from the given manager.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• mgr: management structure for this pipe type
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is pointer to allocated pipe, or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 113 in upipe/upipe.h source file, line 1944.

This function allocates a new pipe from the given manager, and sets it as the input of the given pipe.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe
• upipe_mgr: manager for the input pipe
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is pointer to allocated input pipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 282 in upipe/upipe.h source file, line 1944.

This function allocates a subpipe from the given super-pipe, and sets it as the input of the given pipe.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe
• super_pipe: description structure of the super-pipe
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is pointer to allocated input pipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 37 in upipe/upipe.h source file, line 1944.

This function allocates a new pipe from the given manager, and sets it as the output of the given pipe.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the existing pipe
• upipe_mgr: manager for the output pipe
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is pointer to allocated output pipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 208 in upipe/upipe.h source file, line 1944.

This function allocates a subpipe from the given super-pipe, and sets it as the output of the given pipe.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe
• super_pipe: description structure of the super-pipe
• uprobe: structure used to raise events (belongs to the callee) followed by arguments for the allocator ()

The return value is pointer to allocated output subpipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 163 in upipe/upipe.h source file, line 1944.

This function allocates and initializes a subpipe from the given super-pipe.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• super_upipe: description structure of the super-pipe
• uprobe: structure used to raise events (belongs to the callee) followed by arguments for the allocator ()

The return value is pointer to allocated subpipe, or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 142 in upipe/upipe.h source file, line 1944.

This function allocates a new pipe from the given manager, sets it as the input of the given pipe, and releases it.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe (belongs to the callee)
• upipe_mgr: manager for the input pipe
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is pointer to allocated input pipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 307 in upipe/upipe.h source file, line 1944.

This function allocates a new pipe from the given manager, sets it as the input of the given pipe, and releases it.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe (belongs to the callee)
• super_pipe: description structure of the super-pipe
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is pointer to allocated input pipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 64 in upipe/upipe.h source file, line 1944.

This function allocates a new pipe from the given manager, sets it as the output of the given pipe, and releases the latter.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe (belongs to the callee)
• upipe_mgr: manager for the output pipe
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is pointer to allocated output pipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 233 in upipe/upipe.h source file, line 1944.

This function allocates a subpipe from the given super-pipe, sets it as the output of the given pipe, and releases the latter.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe
• super_pipe: description structure of the super-pipe
• uprobe: structure used to raise events (belongs to the callee) followed by arguments for the allocator ()

The return value is pointer to allocated output subpipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 185 in upipe/upipe.h source file, line 1944.

This function allocates and initializes a subpipe from the given super-pipe, and releases the super-pipe.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• super_upipe: description structure of the super-pipe
• uprobe: structure used to raise events (belongs to the callee) followed by arguments for the allocator ()

The return value is pointer to allocated subpipe, or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 88 in upipe/upipe.h source file, line 1944.

This function allocates a new pipe from the given manager, sets it as the output of the given pipe, and releases it.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe (belongs to the callee)
• upipe_mgr: manager for the output pipe
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is an error code

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 257 in upipe/upipe.h source file, line 1944.

This function allocates a subpipe from the given super-pipe, sets it as the output of the given pipe, and releases it.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe
• super_pipe: description structure of the super-pipe
• uprobe: structure used to raise events (belongs to the callee) followed by arguments for the allocator ()

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1314.

This function flushes all currently held buffers, and unblocks the sources.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

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

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

This function is declared in upipe/upipe.h source file, line 1205.

This function gets a pointer to the flow definition of the output.

Parameter list:

• upipe: description structure of the pipe
• p: reference to a value, will be modified

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1209.

This function gets a pointer to the max length of the internal queue.

Parameter list:

• upipe: description structure of the pipe
• p: reference to a value, will be modified

The return value is an error code

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

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

This function is declared in upipe/upipe.h source file, line 1223.

This function gets a string option.

Parameter list:

• upipe: description structure of the pipe
• option: name of the option
• value_p: filled with the value of the option

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1207.

This function gets a pointer to the pipe acting as output.

Parameter list:

• upipe: description structure of the pipe
• p: reference to a value, will be modified

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1211.

This function gets a pointer to the packet size of the output.

Parameter list:

• upipe: description structure of the pipe
• p: reference to a value, will be modified

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1362.

This function returns the subpipe manager of a super-pipe.

Parameter list:

• upipe: description structure of the super-pipe
• p: filled in with a pointer to the subpipe manager

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1202.

This function gets a pointer to the uniform resource identifier.

Parameter list:

• upipe: description structure of the pipe
• p: reference to a value, will be modified

The return value is an error code

This function is declared in upipe/upipe.h source file, line 689.

This function 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
• msg: textual message

This function is declared in upipe/upipe.h source file, line 689.

This function throws a log event, with printf-style message generation.

Parameter list:

• upipe: description structure of the pipe
• format: format of the textual message, followed by optional arguments

This function is declared in upipe/upipe.h source file, line 469.

This function initializes the public members of a pipe.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe
• mgr: management structure for this pipe type
• uprobe: structure used to raise events

This function is declared in upipe/upipe.h source file, line 1056.

This function sends an input buffer into a pipe. Note that all inputs and control commands must be executed from the same thread - no reentrancy or locking is required from the pipe. Also note that uref is then owned by the callee and shouldn't be used any longer.

Parameter list:

• upipe: description structure of the pipe
• uref: uref structure to send
• upump_p: reference to the pump that generated the buffer

This function is declared in upipe/upipe.h source file, line 1375.

This function iterates over the subpipes of a super-pipe. Note that it is forbidden to release the returned subpipe (but you may release any other subpipe).

Parameter list:

• upipe: description structure of the super-pipe
• p: filled in with a pointer to the next subpipe, initialize at NULL

The return value is an error code

This struct is declared in upipe/uprobe_source_mgr.h source file, line 40.

This function is declared in upipe/upipe.h source file, line 326.

This function checks that a specific flow def is supported.

Parameter list:

• mgr: pointer to upipe manager
• flow_def: flow def to check

The return value is an error code

This enum is declared in upipe/upipe.h source file, line 187.

This enum defines standard commands which upipe managers may implement.

This function is declared in upipe/upipe.h source file, line 232.

This function initializes a upipe manager structure with default values.

Parameter list:

• mgr: pointer to upipe manager

This function is declared in upipe/upipe.h source file, line 264.

This function decrements the reference count of a upipe manager or frees it.

Parameter list:

• mgr: pointer to upipe manager

This function is declared in upipe/upipe.h source file, line 252.

This function increments the reference count of a upipe manager.

Parameter list:

• mgr: pointer to upipe manager

The return value is same pointer to upipe manager

This function is declared in upipe/upipe.h source file, line 314.

This function instructs an existing upipe manager to release all structures currently kept in pools. It is intended as a debug tool only.

Parameter list:

• mgr: pointer to upipe manager

The return value is an error code

This function is declared in upipe/upipe.h source file, line 688.

This function 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
• msg: textual message

This function is declared in upipe/upipe.h source file, line 688.

This function throws a log event, with printf-style message generation.

Parameter list:

• upipe: description structure of the pipe
• format: format of the textual message, followed by optional arguments

This function is declared in upipe/upipe.h source file, line 567.

This function deletes the first probe from the LIFO of probes associated with a pipe, and returns it so it can be released.

Please note that this function does not _release() the popped probe, so it must be done by the caller.

Parameter list:

• upipe: description structure of the pipe

The return value is uprobe pointer to popped probe

This function is declared in upipe/upipe.h source file, line 552.

This function adds the given probe to the LIFO of probes associated with a pipe. The new probe will be executed first.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe
• uprobe: pointer to probe

This function is declared in upipe/upipe.h source file, line 1288.

This function registers a request.

Parameter list:

• upipe: description structure of the pipe
• urequest: description structure of the request

The return value is an error code

This function is declared in upipe/upipe.h source file, line 497.

This function decrements the reference count of a upipe or frees it.

Parameter list:

• upipe: pointer to upipe

This function is declared in upipe/upipe.h source file, line 1205.

This function sets the flow definition of the output.

Parameter list:

• upipe: description structure of the pipe
• s: new value

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1209.

This function sets the max length of the internal queue.

Parameter list:

• upipe: description structure of the pipe
• s: new value

The return value is an error code

This function is declared in upipe/upipe.h source file, line 538.

This function sets the opaque member of a pipe.

Parameter list:

• upipe: pointer to upipe
• opaque: opaque

This function is declared in upipe/upipe.h source file, line 1236.

This function sets a string option.

Parameter list:

• upipe: description structure of the pipe
• option: name of the option
• value: value of the option

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1207.

This function sets the pipe acting as output.

Parameter list:

• upipe: description structure of the pipe
• s: new value

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1211.

This function sets the packet size of the output.

Parameter list:

• upipe: description structure of the pipe
• s: new value

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1202.

This function sets the uniform resource identifier.

Parameter list:

• upipe: description structure of the pipe
• s: new value

The return value is an error code

This function is declared in upipe/upipe.h source file, line 508.

This function checks if the pipe has more than one reference.

Parameter list:

• upipe: pointer to upipe

The return value is true if there is only one reference to the pipe

This function is deprecated.

This function is declared in upipe/upipe.h source file, line 1330.

This declaration involves expansion of the UBASE_DEPRECATED macro.

See also upipe_flush.

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

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

This function is declared in upipe/upipe.h source file, line 1341.

This function iterates over the list of possible output flow definitions.

Parameter list:

• upipe: description structure of the pipe
• p: filled in with the next flow def, initialize at NULL

The return value is an error code

This function is declared in upipe/upipe.h source file, line 946.

This function throws an update event. This event is thrown whenever a split pipe declares a new output flow list.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1463.

This function returns the reading position of the current source.

Parameter list:

• upipe: description structure of the pipe
• position_p: filled in with the reading position, in octets

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1489.

This function returns the reading range of the current source.

Parameter list:

• upipe: description structure of the pipe
• offset_p: filled in with range start, in octets
• length_p: filled in with the reading length, in octets.

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1451.

This function returns the size of the currently opened source.

Parameter list:

• upipe: description structure of the pipe
• size_p: filled in with the size of the source, in octets

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1475.

This function request the given reading position for the current source.

Parameter list:

• upipe: description structure of the pipe
• position: new reading position, in octets (between 0 and the size)

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1503.

This function request the given range for the current source.

Parameter list:

• upipe: description structure of the pipe
• offset: range starts at offset, in octets
• length: octets to read from offset, in octets

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1396.

This function returns the super-pipe of a subpipe.

Parameter list:

• upipe: description structure of the subpipe
• p: filled in with a pointer to the super-pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 984.

This function throws an event telling that the given uref carries a clock reference.

Parameter list:

• upipe: description structure of the pipe
• uref: uref carrying a clock reference
• clock_ref: clock reference, in 27 MHz scale
• discontinuity: 1 if there is a suspicion of discontinuity

The return value is an error code

This function is declared in upipe/upipe.h source file, line 999.

This function throws an event telling that the given uref carries a presentation and/or a decoding timestamp. The uref must at least have k.dts.orig set. Depending on the module documentation, k.dts may also be set. A probe is entitled to adding new attributes such as k.pts.sys and/or k.dts.sys.

Parameter list:

• upipe: description structure of the pipe
• uref: uref carrying a presentation and/or a decoding timestamp

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1014.

This function throws an event telling that the given uref carries a UTC clock reference.

Parameter list:

• upipe: description structure of the pipe
• uref: uref carrying a clock reference
• clock_utc: UTC clock reference, in 27 MHz scale starting at Epoch (1970-01-01T00:00:00Z)

The return value is an error code

This function is declared in upipe/upipe.h source file, line 734.

This function throws a dead event. This event is thrown whenever a pipe is about to be destroyed and will no longer accept input and control commands.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

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

This macro throws an error event.

Parameter list:

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

The return value is an error code

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

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

This function is declared in upipe/upipe.h source file, line 892.

This function throws an event asking to freeze the upump manager of the current thread. This allows to prepare pipes that will be deported later.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

See also upipe_throw_thaw_upump_mgr.

This function is declared in upipe/upipe.h source file, line 786.

This function throws an event asking for an output, either because no output pipe has been defined, or because the output pipe rejected the flow definition.

Parameter list:

• upipe: description structure of the pipe
• flow_def: output flow definition

The return value is an error code

This function is declared in upipe/upipe.h source file, line 805.

This function throws an event asking for a source pipe manager because a source pipe must be allocated.

Parameter list:

• upipe: description structure of the pipe
• source_mgr_p: pointer filled with the provided source pipe manager

The return value is an error code

This function is declared in upipe/upipe.h source file, line 866.

This function throws an event asking for a upump manager. Note that all parameters belong to the caller, so there is no need to upump_mgr_use the given manager.

Parameter list:

• upipe: description structure of the pipe
• upump_mgr_p: filled in with a pointer to the upump manager

The return value is an error code

This function is declared in upipe/upipe.h source file, line 918.

This function throws an event declaring a new flow definition on the output.

Parameter list:

• upipe: description structure of the pipe
• flow_def: definition for this flow

The return value is an error code

This function is declared in upipe/upipe.h source file, line 935.

This function throws an event declaring a new random access point in the input.

Parameter list:

• upipe: description structure of the pipe
• uref: uref containing the random access point

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1024.

This function throws an event telling that the preroll is finished.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 821.

This function throws an event asking to provide a urequest. It is thrown by a pipe when it has no output, or when it would make no sense to forward the request to the output (for instance a request for a ubuf manager when the pipe is a decoder or encoder).

Parameter list:

• upipe: description structure of the pipe
• urequest: request to provide

The return value is an error code

This function is declared in upipe/upipe.h source file, line 1039.

This function catches an event coming from an inner pipe, and rethrows is as if it were sent by the outermost pipe.

Parameter list:

• upipe: pointer to outermost pipe
• inner: pointer to inner pipe
• event: event thrown
• args: optional arguments of the event

The return value is an error code

This function is declared in upipe/upipe.h source file, line 721.

This function throws a ready event. This event is thrown whenever a pipe is ready to accept input or respond to control commands.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 771.

This function throws a sink end event. This event is thrown when a pipe is unable to write to an output because the disk is full, or another error occurred.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 759.

This function throws a source end event. This event is thrown when a pipe is unable to read from an input because the end of file was reached, or because an error occurred.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 746.

This function throws a stalled event. This event is thrown whenever a queue is stalled due to a full FIFO.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 957.

This function throws an event telling that a pipe synchronized on its input.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 969.

This function throws an event telling that a pipe lost synchronization with its input.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

This function is declared in upipe/upipe.h source file, line 905.

This function throws an event asking to thaw the upump manager of the current thread. This allows to prepare pipes that will be deported later.

Parameter list:

• upipe: description structure of the pipe

The return value is an error code

See also upipe_throw_freeze_upump_mgr.

This function is declared in upipe/upipe.h source file, line 1302.

This function unregisters a request.

Parameter list:

• upipe: description structure of the pipe
• urequest: description structure of the request

The return value is an error code

This function is declared in upipe/upipe.h source file, line 485.

This function increments the reference count of a upipe.

Parameter list:

• upipe: pointer to upipe

The return value is same pointer to upipe

This function is declared in upipe/upipe.h source file, line 691.

This function 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
• msg: textual message

This function is declared in upipe/upipe.h source file, line 691.

This function throws a log event, with printf-style message generation.

Parameter list:

• upipe: description structure of the pipe
• format: format of the textual message, followed by optional arguments

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 15 in upipe/upipe.h source file, line 1936.

This function allocates and initializes a pipe from the given manager.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• mgr: management structure for this pipe type
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is pointer to allocated pipe, or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 113 in upipe/upipe.h source file, line 1936.

This function allocates a new pipe from the given manager, and sets it as the input of the given pipe.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe
• upipe_mgr: manager for the input pipe
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is pointer to allocated input pipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 282 in upipe/upipe.h source file, line 1936.

This function allocates a subpipe from the given super-pipe, and sets it as the input of the given pipe.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe
• super_pipe: description structure of the super-pipe
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is pointer to allocated input pipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 37 in upipe/upipe.h source file, line 1936.

This function allocates a new pipe from the given manager, and sets it as the output of the given pipe.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the existing pipe
• upipe_mgr: manager for the output pipe
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is pointer to allocated output pipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 208 in upipe/upipe.h source file, line 1936.

This function allocates a subpipe from the given super-pipe, and sets it as the output of the given pipe.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe
• super_pipe: description structure of the super-pipe
• uprobe: structure used to raise events (belongs to the callee) followed by arguments for the allocator ()

The return value is pointer to allocated output subpipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 163 in upipe/upipe.h source file, line 1936.

This function allocates and initializes a subpipe from the given super-pipe.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• super_upipe: description structure of the super-pipe
• uprobe: structure used to raise events (belongs to the callee) followed by arguments for the allocator ()

The return value is pointer to allocated subpipe, or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 142 in upipe/upipe.h source file, line 1936.

This function allocates a new pipe from the given manager, sets it as the input of the given pipe, and releases it.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe (belongs to the callee)
• upipe_mgr: manager for the input pipe
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is pointer to allocated input pipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 307 in upipe/upipe.h source file, line 1936.

This function allocates a new pipe from the given manager, sets it as the input of the given pipe, and releases it.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe (belongs to the callee)
• super_pipe: description structure of the super-pipe
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is pointer to allocated input pipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 64 in upipe/upipe.h source file, line 1936.

This function allocates a new pipe from the given manager, sets it as the output of the given pipe, and releases the latter.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe (belongs to the callee)
• upipe_mgr: manager for the output pipe
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is pointer to allocated output pipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 233 in upipe/upipe.h source file, line 1936.

This function allocates a subpipe from the given super-pipe, sets it as the output of the given pipe, and releases the latter.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe
• super_pipe: description structure of the super-pipe
• uprobe: structure used to raise events (belongs to the callee) followed by arguments for the allocator ()

The return value is pointer to allocated output subpipe (which must be stored or released), or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 185 in upipe/upipe.h source file, line 1936.

This function allocates and initializes a subpipe from the given super-pipe, and releases the super-pipe.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• super_upipe: description structure of the super-pipe
• uprobe: structure used to raise events (belongs to the callee) followed by arguments for the allocator ()

The return value is pointer to allocated subpipe, or NULL in case of failure

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 88 in upipe/upipe.h source file, line 1936.

This function allocates a new pipe from the given manager, sets it as the output of the given pipe, and releases it.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe (belongs to the callee)
• upipe_mgr: manager for the output pipe
• uprobe: structure used to raise events (belongs to the callee), followed by arguments for the allocator ()

The return value is an error code

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 257 in upipe/upipe.h source file, line 1936.

This function allocates a subpipe from the given super-pipe, sets it as the output of the given pipe, and releases it.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• upipe: description structure of the pipe
• super_pipe: description structure of the super-pipe
• uprobe: structure used to raise events (belongs to the callee) followed by arguments for the allocator ()

The return value is an error code

This function is declared in upipe/upipe.h source file, line 687.

This function 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
• msg: textual message

This function is declared in upipe/upipe.h source file, line 687.

This function throws a log event, with printf-style message generation.

Parameter list:

• upipe: description structure of the pipe
• format: format of the textual message, followed by optional arguments

This struct is declared in upipe/upump.h source file, line 109.

This struct is declared in upipe/uprobe_upump_mgr.h source file, line 43.

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

This struct is declared in upipe/uprobe_uref_mgr.h source file, line 42.

This macro is for internal use only.

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

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

This function is for internal use only.

This function is declared in upipe/upipe.h source file, line 450.

This function allocates and initializes a pipe with a variable list of arguments.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• mgr: management structure for this pipe type
• uprobe: structure used to raise events (belongs to the caller and must be kept alive for all the duration of the pipe)
• signature: signature of the pipe allocator, followed by optional arguments

The return value is pointer to allocated pipe, or NULL in case of failure

This function is for internal use only.

This function is declared in upipe/upipe.h source file, line 430.

This function allocates and initializes a pipe.

Please note that this function does not _use() the probe, so if you want to reuse an existing probe, you have to use it first.

Parameter list:

• mgr: management structure for this pipe type
• uprobe: structure used to raise events (belongs to the caller and must be kept alive for all the duration of the pipe)
• signature: signature of the pipe allocator
• args: optional arguments

The return value is pointer to allocated pipe, or NULL in case of failure

This function is for internal use only.

This function is declared in upipe/upipe.h source file, line 1161.

This function sends a control command to the pipe. Note that all control commands must be executed from the same thread - no reentrancy or locking is required from the pipe. Also note that all arguments are owned by the caller.

Parameter list:

• upipe: description structure of the pipe
• command: control command to send, followed by optional read or write parameters

The return value is an error code

This function is for internal use only.

This function is declared in upipe/upipe.h source file, line 1141.

This function sends a control command to the pipe. Note that all control commands must be executed from the same thread - no reentrancy or locking is required from the pipe. Also note that all arguments are owned by the caller.

This version doesn't print debug messages to avoid overflowing the console.

Parameter list:

• upipe: description structure of the pipe
• command: control command to send, followed by optional read or write parameters

The return value is an error code

This function is for internal use only.

This function is declared in upipe/upipe.h source file, line 1082.

This function sends a control command to the pipe. Note that all control commands must be executed from the same thread - no reentrancy or locking is required from the pipe. Also note that all arguments are owned by the caller.

This version doesn't print debug messages to avoid overflowing the console.

Parameter list:

• upipe: description structure of the pipe
• command: control command to send
• args: optional read or write parameters

The return value is an error code

This function is for internal use only.

This function is declared in upipe/upipe.h source file, line 1106.

This function sends a control command to the pipe. Note that all control commands must be executed from the same thread - no reentrancy or locking is required from the pipe. Also note that all arguments are owned by the caller.

Parameter list:

• upipe: description structure of the pipe
• command: control command to send
• args: optional read or write parameters

The return value is an error code

This function is for internal use only.

This function is declared in UBASE_FROM_TO function like macro expansion, line 19 in upipe/upipe.h source file, line 184.

This function returns a pointer to uchain.

Parameter list:

• sub: pointer to struct uchain

The return value is pointer to struct upipe

This function is for internal use only.

This function is declared in upipe/upipe.h source file, line 623.

This function 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

This function is for internal use only.

This function is declared in upipe/upipe.h source file, line 652.

This function throws a log event, with printf-style message generation.

Parameter list:

• upipe: description structure of the pipe
• level: level of importance of the message
• format: format of the textual message, followed by optional arguments

This function is for internal use only.

This function is declared in upipe/upipe.h source file, line 298.

This function sends a control command to the pipe manager. Note that thread semantics depend on the pipe manager. Also note that all arguments are owned by the caller.

Parameter list:

• mgr: pointer to upipe manager
• command: control manager command to send, followed by optional read or write parameters

The return value is an error code

This function is for internal use only.

This function is declared in upipe/upipe.h source file, line 280.

This function sends a control command to the pipe manager. Note that thread semantics depend on the pipe manager. Also note that all arguments are owned by the caller.

Parameter list:

• mgr: pointer to upipe manager
• command: manager control command to send
• args: optional read or write parameters

The return value is an error code

This function is for internal use only.

This function is declared in upipe/upipe.h source file, line 605.

This function throws generic events with optional arguments.

Parameter list:

• upipe: description structure of the pipe
• event: event to throw, followed by arguments

The return value is an error code

This function is for internal use only.

This function is declared in upipe/upipe.h source file, line 594.

This function throws generic events with optional arguments.

Parameter list:

• upipe: description structure of the pipe
• event: event to throw
• args: arguments

The return value is an error code

This function is for internal use only.

This function is declared in UBASE_FROM_TO function like macro expansion, line 9 in upipe/upipe.h source file, line 184.

This function returns a pointer to uchain.

Parameter list:

• upipe: pointer to struct upipe

The return value is pointer to struct uchain

This function is for internal use only.

This function is declared in upipe/upipe.h source file, line 638.

This function throws a log event, with vprintf-style message generation.

Parameter list:

• upipe: description structure of the pipe
• level: level of importance of the message
• format: format of the textual message
• args: arguments for the format string