upipe-blackmagic/upipe_blackmagic_source.h header reference

Upipe source module for BlackMagic Design SDI cards More

Header inclusion  

Members  

Type  

Functions  

Description  

Upipe source module for BlackMagic Design SDI cards

Members detail  

#define UPIPE_BMD_SRC_OUTPUT_SIGNATURE  

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

#define UPIPE_BMD_SRC_SIGNATURE  

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

#define _UPIPE_BLACKMAGIC_UPIPE_BLACKMAGIC_SOURCE_H_  

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

struct upipe * upipe_bmd_src_alloc(struct upipe_mgr *mgr, struct uprobe *uprobe, struct uprobe *uprobe_pic, struct uprobe *uprobe_sound, struct uprobe *uprobe_subpic)  

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

This function allocates and initializes a bmd source pipe.

Parameters list:

  • mgr: management structure for bmd source type
  • uprobe: structure used to raise events for the super pipe
  • uprobe_pic: structure used to raise events for the pic subpipe
  • uprobe_sound: structure used to raise events for the sound subpipe
  • uprobe_subpic: structure used to raise events for the subpic subpipe

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

enum upipe_bmd_src_command  

This enum is declared in upipe-blackmagic/upipe_blackmagic_source.h source file, line 38.

This enum extends upipe_command with specific commands for bmd sources.

IdentifierValueDescription
UPIPE_BMD_SRC_SENTINEL0
UPIPE_BMD_SRC_GET_PIC_SUB1returns the pic subpipe (struct upipe **)
UPIPE_BMD_SRC_GET_SOUND_SUB2returns the sound subpipe (struct upipe **)
UPIPE_BMD_SRC_GET_SUBPIC_SUB3returns the subpic subpipe (struct upipe **)

int upipe_bmd_src_get_pic_sub(struct upipe *upipe, struct upipe **upipe_p)  

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

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

Parameters 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

int upipe_bmd_src_get_sound_sub(struct upipe *upipe, struct upipe **upipe_p)  

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

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

Parameters 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

int upipe_bmd_src_get_subpic_sub(struct upipe *upipe, struct upipe **upipe_p)  

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

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

Parameters list:

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

The return value is an error code

struct upipe_mgr * upipe_bmd_src_mgr_alloc(void )  

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

This function returns the management structure for all bmd sources.

The return value is pointer to manager

Valid XHTML 1.0 StrictGenerated by cmassiot on Thu Nov 6 12:15:19 2014 using MkDoc