upipe-filters/upipe_filter_vanc.h header reference

Upipe filter processing vertical ancillary data More

• upipe/upipe.h

• enum upipe_vanc_command

• struct upipe * upipe_vanc_alloc(struct upipe_mgr *mgr, struct uprobe *uprobe, struct uprobe *uprobe_afd, struct uprobe *uprobe_scte104, struct uprobe *uprobe_op47, struct uprobe *uprobe_cea708)
• struct upipe * upipe_vanc_alloc_input(struct upipe *upipe, struct upipe_mgr *upipe_mgr, struct uprobe *uprobe, struct uprobe *uprobe_afd, struct uprobe *uprobe_scte104, struct uprobe *uprobe_op47, struct uprobe *uprobe_cea708)
• struct upipe * upipe_vanc_alloc_input_sub(struct upipe *upipe, struct upipe *super_pipe, struct uprobe *uprobe, struct uprobe *uprobe_afd, struct uprobe *uprobe_scte104, struct uprobe *uprobe_op47, struct uprobe *uprobe_cea708)
• struct upipe * upipe_vanc_alloc_output(struct upipe *upipe, struct upipe_mgr *upipe_mgr, struct uprobe *uprobe, struct uprobe *uprobe_afd, struct uprobe *uprobe_scte104, struct uprobe *uprobe_op47, struct uprobe *uprobe_cea708)
• struct upipe * upipe_vanc_alloc_output_sub(struct upipe *upipe, struct upipe *super_pipe, struct uprobe *uprobe, struct uprobe *uprobe_afd, struct uprobe *uprobe_scte104, struct uprobe *uprobe_op47, struct uprobe *uprobe_cea708)
• struct upipe * upipe_vanc_alloc_sub(struct upipe *super_pipe, struct uprobe *uprobe, struct uprobe *uprobe_afd, struct uprobe *uprobe_scte104, struct uprobe *uprobe_op47, struct uprobe *uprobe_cea708)
• struct upipe * upipe_vanc_chain_input(struct upipe *upipe, struct upipe_mgr *upipe_mgr, struct uprobe *uprobe, struct uprobe *uprobe_afd, struct uprobe *uprobe_scte104, struct uprobe *uprobe_op47, struct uprobe *uprobe_cea708)
• struct upipe * upipe_vanc_chain_input_sub(struct upipe *upipe, struct upipe *super_pipe, struct uprobe *uprobe, struct uprobe *uprobe_afd, struct uprobe *uprobe_scte104, struct uprobe *uprobe_op47, struct uprobe *uprobe_cea708)
• struct upipe * upipe_vanc_chain_output(struct upipe *upipe, struct upipe_mgr *upipe_mgr, struct uprobe *uprobe, struct uprobe *uprobe_afd, struct uprobe *uprobe_scte104, struct uprobe *uprobe_op47, struct uprobe *uprobe_cea708)
• struct upipe * upipe_vanc_chain_output_sub(struct upipe *upipe, struct upipe *super_pipe, struct uprobe *uprobe, struct uprobe *uprobe_afd, struct uprobe *uprobe_scte104, struct uprobe *uprobe_op47, struct uprobe *uprobe_cea708)
• struct upipe * upipe_vanc_chain_sub(struct upipe *super_pipe, struct uprobe *uprobe, struct uprobe *uprobe_afd, struct uprobe *uprobe_scte104, struct uprobe *uprobe_op47, struct uprobe *uprobe_cea708)
• int upipe_vanc_get_afd_sub(struct upipe *upipe, struct upipe **upipe_p)
• int upipe_vanc_get_cea708_sub(struct upipe *upipe, struct upipe **upipe_p)
• int upipe_vanc_get_op47_sub(struct upipe *upipe, struct upipe **upipe_p)
• int upipe_vanc_get_scte104_sub(struct upipe *upipe, struct upipe **upipe_p)
• struct upipe_mgr * upipe_vanc_mgr_alloc(void )
• int upipe_vanc_spawn_output(struct upipe *upipe, struct upipe_mgr *upipe_mgr, struct uprobe *uprobe, struct uprobe *uprobe_afd, struct uprobe *uprobe_scte104, struct uprobe *uprobe_op47, struct uprobe *uprobe_cea708)
• int upipe_vanc_spawn_output_sub(struct upipe *upipe, struct upipe *super_pipe, struct uprobe *uprobe, struct uprobe *uprobe_afd, struct uprobe *uprobe_scte104, struct uprobe *uprobe_op47, struct uprobe *uprobe_cea708)

Normative references: - SMPTE 291M-2006 (ancillary data packet and space formatting)

This macro is declared in upipe-filters/upipe_filter_vanc.h source file, line 37.

This macro is declared in upipe-filters/upipe_filter_vanc.h source file, line 36.

This macro is declared in upipe-filters/upipe_filter_vanc.h source file, line 29.

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 15 in upipe-filters/upipe_filter_vanc.h source file, line 120.

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 115 in upipe-filters/upipe_filter_vanc.h source file, line 120.

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 284 in upipe-filters/upipe_filter_vanc.h source file, line 120.

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-filters/upipe_filter_vanc.h source file, line 120.

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 210 in upipe-filters/upipe_filter_vanc.h source file, line 120.

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 165 in upipe-filters/upipe_filter_vanc.h source file, line 120.

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 144 in upipe-filters/upipe_filter_vanc.h source file, line 120.

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 309 in upipe-filters/upipe_filter_vanc.h source file, line 120.

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 66 in upipe-filters/upipe_filter_vanc.h source file, line 120.

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 235 in upipe-filters/upipe_filter_vanc.h source file, line 120.

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 187 in upipe-filters/upipe_filter_vanc.h source file, line 120.

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 enum is declared in upipe-filters/upipe_filter_vanc.h source file, line 41.

This enum extends upipe_command with specific commands for vanc pipes.

This function is declared in upipe-filters/upipe_filter_vanc.h source file, line 69.

This function returns the afd subpipe. The refcount is not incremented so you have to use it if you want to keep the pointer.

Parameter list:

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

The return value is an error code

This function is declared in upipe-filters/upipe_filter_vanc.h source file, line 111.

This function returns the cea708 subpipe. The refcount is not incremented so you have to use it if you want to keep the pointer.

Parameter list:

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

The return value is an error code

This function is declared in upipe-filters/upipe_filter_vanc.h source file, line 97.

This function returns the op47 subpipe. The refcount is not incremented so you have to use it if you want to keep the pointer.

Parameter list:

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

The return value is an error code

This function is declared in upipe-filters/upipe_filter_vanc.h source file, line 83.

This function returns the scte104 subpipe. The refcount is not incremented so you have to use it if you want to keep the pointer.

Parameter list:

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

The return value is an error code

This function is declared in upipe-filters/upipe_filter_vanc.h source file, line 58.

This function returns the management structure for all vanc pipes.

The return value is pointer to manager

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 90 in upipe-filters/upipe_filter_vanc.h source file, line 120.

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 259 in upipe-filters/upipe_filter_vanc.h source file, line 120.

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