upipe-blackmagic/upipe_blackmagic_sink.h header reference

Upipe blackmagic sink More

Header inclusion [link] 

Members [link] 

Types [link] 

Functions [link] 

Description [link] 

Upipe blackmagic sink

Members detail [link] 

#define UPIPE_BMD_SINK_INPUT_SIGNATURE [link] 

This macro is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 35.

#define UPIPE_BMD_SINK_SIGNATURE [link] 

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

#define _UPIPE_BLACKMAGIC_UPIPE_BLACKMAGIC_SINK_H_ [link] 

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

uint32_t upipe_bmd_mode_from_flow_def(struct upipe *upipe, struct uref *flow_def) [link] 

This function is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 181.

int upipe_bmd_sink_adjust_timing(struct upipe *upipe, int64_t adj) [link] 

This function is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 161.

This function adjusts the bmd_sink timing.

Parameter list:

  • upipe: description structure of the pipe
  • int64_t: requested timing adjustment

The return value is an error code

struct upipe * upipe_bmd_sink_alloc(struct upipe_mgr *mgr, struct uprobe *uprobe, struct uprobe *uprobe_pic) [link] 

This function is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 177.

This function allocates and initializes a bmd sink pipe.

Parameter list:

  • mgr: management structure for bmd sink type
  • uprobe: structure used to raise events for the super pipe
  • uprobe_pic: structure used to raise events for the pic 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_sink_command [link] 

This enum is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 48.

This enum extends upipe_command with specific commands for avformat source.

IdentifierValueDescription
UPIPE_BMD_SINK_SENTINEL0x8000
UPIPE_BMD_SINK_GET_PIC_SUB1returns the pic subpipe (struct upipe **)
UPIPE_BMD_SINK_GET_UCLOCK2returns the uclock (struct uclock *) *
UPIPE_BMD_SINK_GET_GENLOCK_STATUS3returns the genlock status (int) *
UPIPE_BMD_SINK_GET_GENLOCK_OFFSET4returns the genlock offset (int) *
UPIPE_BMD_SINK_SET_GENLOCK_OFFSET5sets the genlock offset (int) *
UPIPE_BMD_SINK_SET_TIMING_ADJUSTMENT6set timing adjustment value (int64_t)
UPIPE_BMD_SINK_ADJUST_TIMING7adjust timing (int64_t)

enum upipe_bmd_sink_genlock [link] 

This enum is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 41.

IdentifierValueDescription
UPIPE_BMD_SINK_GENLOCK_UNLOCKED0
UPIPE_BMD_SINK_GENLOCK_LOCKED1
UPIPE_BMD_SINK_GENLOCK_UNSUPPORTED2

int upipe_bmd_sink_get_genlock_offset(struct upipe *upipe, int64_t *offset) [link] 

This function is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 123.

This function returns the bmd_sink genlock offset.

Parameter list:

  • upipe: description structure of the super pipe
  • offset: filled with the genlock offset in pixels

The return value is an error code

int upipe_bmd_sink_get_genlock_status(struct upipe *upipe, int *status) [link] 

This function is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 110.

This function returns the bmd_sink genlock status.

Parameter list:

  • upipe: description structure of the super pipe
  • status: filled with a upipe_bmd_sink_genlock value

The return value is an error code

int upipe_bmd_sink_get_pic_sub(struct upipe *upipe, struct upipe **upipe_p) [link] 

This function is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 84.

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

int upipe_bmd_sink_get_uclock(struct upipe *upipe, struct uclock **uclock_p) [link] 

This function is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 97.

This function returns the bmd_sink uclock.

Parameter 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_sink_mgr_alloc(void ) [link] 

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

This function returns the management structure for all bmd sinks.

The return value is pointer to manager

int upipe_bmd_sink_set_genlock_offset(struct upipe *upipe, int64_t offset) [link] 

This function is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 136.

This function sets the bmd_sink genlock offset.

Parameter list:

  • upipe: description structure of the super pipe
  • offset: filled with the genlock offset in pixels

The return value is an error code

int upipe_bmd_sink_set_timing_adjustment(struct upipe *upipe, int64_t timing_adj) [link] 

This function is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 149.

This function sets the bmd_sink timing adjustment.

Parameter list:

  • upipe: description structure of the pipe
  • int64_t: requested timing adjustment

The return value is an error code

int uref_bmd_sink_cmp_channel(struct uref *uref1, struct uref *uref2) [link] 

This function is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 39.

This function compares the blackmagic channel index attribute in two urefs.

Parameter list:

  • uref1: pointer to the first uref
  • uref2: pointer to the second uref

The return value is 0 if both attributes are absent or identical

int uref_bmd_sink_copy_channel(struct uref *uref, struct uref *uref_src) [link] 

This function is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 39.

This function copies the blackmagic channel index attribute from an uref to another.

Parameter list:

  • uref: pointer to the uref
  • uref_src: pointer to the source uref

The return value is an error code

int uref_bmd_sink_delete_channel(struct uref *uref) [link] 

This function is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 39.

This function deletes the blackmagic channel index attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_bmd_sink_get_channel(struct uref *uref, uint8_t *p) [link] 

This function is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 39.

This function returns the blackmagic channel index attribute of a uref.

Parameter list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)

The return value is an error code

int uref_bmd_sink_match_channel(struct uref *uref, uint8_t min, uint8_t max) [link] 

This function is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 39.

This function compares the blackmagic channel index attribute to given values.

Parameter list:

  • uref: pointer to the uref
  • min: minimum value
  • max: maximum value

The return value is an error code

int uref_bmd_sink_set_channel(struct uref *uref, uint8_t v) [link] 

This function is declared in upipe-blackmagic/upipe_blackmagic_sink.h source file, line 39.

This function sets the blackmagic channel index attribute of a uref.

Parameter list:

  • uref: pointer to the uref
  • v: value to set

The return value is an error code

Valid XHTML 1.0 StrictGenerated by cmassiot on Sun Dec 14 18:31:17 2025 using MkDoc