upipe-modules/upipe_crop.h header reference

Upipe module cropping incoming pictures More

Header inclusion  

Members  

Type  

Functions  

Description  

Upipe module cropping incoming pictures

Members detail  

#define UPIPE_CROP_SIGNATURE  

This macro is declared in upipe-modules/upipe_crop.h source file, line 38.

#define _UPIPE_MODULES_UPIPE_CROP_H_  

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

enum upipe_crop_command  

This enum is declared in upipe-modules/upipe_crop.h source file, line 49.

This enum extends upipe_command with specific commands for upipe_crop pipes.

IdentifierValueDescription
UPIPE_CROP_SENTINELUPIPE_CONTROL_LOCAL
UPIPE_CROP_GET_RECTunknowngets the offsets of the cropped rect (int64_t *, int64_t *, int64_t *, int64_t *)
UPIPE_CROP_SET_RECTunknownsets the offsets of the cropped rect (int64_t, int64_t, int64_t, int64_t)

int upipe_crop_get_rect(struct upipe *upipe, int64_t *loffset_p, int64_t *roffset_p, int64_t *toffset_p, int64_t *boffset_p)  

This function is declared in upipe-modules/upipe_crop.h source file, line 73.

This function gets the offsets (from the respective borders of the frame) of the cropped rectangle.

Parameter list:

  • upipe: description structure of the pipe
  • loffset_p: filled in with the offset from the left border
  • roffset_p: filled in with the offset from the right border
  • toffset_p: filled in with the offset from the top border
  • boffset_p: filled in with the offset from the bottom border

The return value is an error code

struct upipe_mgr * upipe_crop_mgr_alloc(void )  

This function is declared in upipe-modules/upipe_crop.h source file, line 45.

This function returns the management structure for crop pipes.

The return value is pointer to manager

int upipe_crop_set_rect(struct upipe *upipe, int64_t loffset, int64_t roffset, int64_t toffset, int64_t boffset)  

This function is declared in upipe-modules/upipe_crop.h source file, line 91.

This function sets the offsets (from the respective borders of the frame) of the cropped rectangle.

Parameter list:

  • upipe: description structure of the pipe
  • loffset: offset from the left border
  • roffset: offset from the right border
  • toffset: offset from the top border
  • boffset: offset from the bottom border

The return value is an error code

Valid XHTML 1.0 StrictGenerated by cmassiot on Fri Feb 2 23:57:18 2018 using MkDoc