upipe-blackmagic/upipe_blackmagic_source.h header reference

Upipe source module for BlackMagic Design SDI cards More

• upipe/upipe.h

• enum upipe_bmd_src_command

• struct upipe * upipe_bmd_src_alloc(struct upipe_mgr *mgr, struct uprobe *uprobe, struct uprobe *uprobe_pic, struct uprobe *uprobe_sound)
• struct upipe * upipe_bmd_src_alloc_input(struct upipe *upipe, struct upipe_mgr *upipe_mgr, struct uprobe *uprobe, struct uprobe *uprobe_pic, struct uprobe *uprobe_sound)
• struct upipe * upipe_bmd_src_alloc_input_sub(struct upipe *upipe, struct upipe *super_pipe, struct uprobe *uprobe, struct uprobe *uprobe_pic, struct uprobe *uprobe_sound)
• struct upipe * upipe_bmd_src_alloc_output(struct upipe *upipe, struct upipe_mgr *upipe_mgr, struct uprobe *uprobe, struct uprobe *uprobe_pic, struct uprobe *uprobe_sound)
• struct upipe * upipe_bmd_src_alloc_output_sub(struct upipe *upipe, struct upipe *super_pipe, struct uprobe *uprobe, struct uprobe *uprobe_pic, struct uprobe *uprobe_sound)
• struct upipe * upipe_bmd_src_alloc_sub(struct upipe *super_pipe, struct uprobe *uprobe, struct uprobe *uprobe_pic, struct uprobe *uprobe_sound)
• struct upipe * upipe_bmd_src_chain_input(struct upipe *upipe, struct upipe_mgr *upipe_mgr, struct uprobe *uprobe, struct uprobe *uprobe_pic, struct uprobe *uprobe_sound)
• struct upipe * upipe_bmd_src_chain_input_sub(struct upipe *upipe, struct upipe *super_pipe, struct uprobe *uprobe, struct uprobe *uprobe_pic, struct uprobe *uprobe_sound)
• struct upipe * upipe_bmd_src_chain_output(struct upipe *upipe, struct upipe_mgr *upipe_mgr, struct uprobe *uprobe, struct uprobe *uprobe_pic, struct uprobe *uprobe_sound)
• struct upipe * upipe_bmd_src_chain_output_sub(struct upipe *upipe, struct upipe *super_pipe, struct uprobe *uprobe, struct uprobe *uprobe_pic, struct uprobe *uprobe_sound)
• struct upipe * upipe_bmd_src_chain_sub(struct upipe *super_pipe, struct uprobe *uprobe, struct uprobe *uprobe_pic, struct uprobe *uprobe_sound)
• int upipe_bmd_src_get_pic_sub(struct upipe *upipe, struct upipe **upipe_p)
• int upipe_bmd_src_get_sound_sub(struct upipe *upipe, struct upipe **upipe_p)
• struct upipe_mgr * upipe_bmd_src_mgr_alloc(void )
• int upipe_bmd_src_spawn_output(struct upipe *upipe, struct upipe_mgr *upipe_mgr, struct uprobe *uprobe, struct uprobe *uprobe_pic, struct uprobe *uprobe_sound)
• int upipe_bmd_src_spawn_output_sub(struct upipe *upipe, struct upipe *super_pipe, struct uprobe *uprobe, struct uprobe *uprobe_pic, struct uprobe *uprobe_sound)

Note that the allocator requires three additional parameters:

The URI is made of several components: <video connection>://[<card#>|card topology>][/mode=<video mode>][/audio=<audio connection>]

This macro is declared in upipe-blackmagic/upipe_blackmagic_source.h source file, line 45.

This macro is declared in upipe-blackmagic/upipe_blackmagic_source.h source file, line 44.

This macro is declared in upipe-blackmagic/upipe_blackmagic_source.h source file, line 37.

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 15 in upipe-blackmagic/upipe_blackmagic_source.h source file, line 96.

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-blackmagic/upipe_blackmagic_source.h source file, line 96.

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-blackmagic/upipe_blackmagic_source.h source file, line 96.

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-blackmagic/upipe_blackmagic_source.h source file, line 96.

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-blackmagic/upipe_blackmagic_source.h source file, line 96.

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-blackmagic/upipe_blackmagic_source.h source file, line 96.

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-blackmagic/upipe_blackmagic_source.h source file, line 96.

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-blackmagic/upipe_blackmagic_source.h source file, line 96.

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-blackmagic/upipe_blackmagic_source.h source file, line 96.

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-blackmagic/upipe_blackmagic_source.h source file, line 96.

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-blackmagic/upipe_blackmagic_source.h source file, line 96.

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-blackmagic/upipe_blackmagic_source.h source file, line 49.

This enum extends upipe_command with specific commands for bmd sources.

This function is declared in upipe-blackmagic/upipe_blackmagic_source.h source file, line 73.

This function returns the pic 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 pic subpipe

The return value is an error code

This function is declared in upipe-blackmagic/upipe_blackmagic_source.h source file, line 87.

This function returns the sound 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 sound subpipe

The return value is an error code

This function is declared in upipe-blackmagic/upipe_blackmagic_source.h source file, line 62.

This function returns the management structure for all bmd sources.

The return value is pointer to manager

This function is declared in UPIPE_HELPER_ALLOC function like macro expansion, line 90 in upipe-blackmagic/upipe_blackmagic_source.h source file, line 96.

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-blackmagic/upipe_blackmagic_source.h source file, line 96.

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