upipe-x265/upipe_x265.h header reference

Upipe x265 module More

Header inclusion  

Members  

Type  

Functions  

Description  

Upipe x265 module

Members detail  

#define UPIPE_X265_SIGNATURE  

This macro is declared in upipe-x265/upipe_x265.h source file, line 40.

#define _UPIPE_X265_UPIPE_X265_H_  

This macro is declared in upipe-x265/upipe_x265.h source file, line 33.

void upipe_x265_cleanup(void )  

This function is declared in upipe-x265/upipe_x265.h source file, line 152.

This function frees process globals.

enum upipe_x265_command  

This enum is declared in upipe-x265/upipe_x265.h source file, line 44.

This enum extends upipe_command with specific commands for x265.

IdentifierValueDescription
UPIPE_X265_SENTINELUPIPE_CONTROL_LOCAL
UPIPE_X265_RECONFIGunknownreconfigure encoder with updated parameters
UPIPE_X265_SET_DEFAULTunknownset default params
UPIPE_X265_SET_DEFAULT_PRESETunknownset default params for preset (const char *, const char *)
UPIPE_X265_SET_PROFILEunknownenforce profile (const char *)
UPIPE_X265_SET_SC_LATENCYunknownswitches to speedcontrol mode with the given latency (uint64_t)
UPIPE_X265_SET_SLICE_TYPE_ENFORCEunknownset slice type enforcement mode (int)

struct upipe_mgr * upipe_x265_mgr_alloc(void )  

This function is declared in upipe-x265/upipe_x265.h source file, line 148.

This function returns the management structure for x265 pipes.

The return value is pointer to manager

int upipe_x265_reconfigure(struct upipe *upipe)  

This function is declared in upipe-x265/upipe_x265.h source file, line 72.

This function reconfigures encoder with updated parameters.

Parameter list:

  • upipe: description structure of the pipe

The return value is an error code

int upipe_x265_set_default(struct upipe *upipe, int bit_depth)  

This function is declared in upipe-x265/upipe_x265.h source file, line 84.

This function sets default parameters (and runs CPU detection).

Parameter list:

  • upipe: description structure of the pipe
  • bit_depth: codec bit depth (8, 10 or 12)

The return value is an error code

int upipe_x265_set_default_preset(struct upipe *upipe, const char *preset, const char *tuning)  

This function is declared in upipe-x265/upipe_x265.h source file, line 99.

This function sets default parameters for specified preset.

Parameter list:

  • upipe: description structure of the pipe
  • preset: x265 preset
  • tuning: x265 tuning

The return value is an error code

int upipe_x265_set_profile(struct upipe *upipe, const char *profile)  

This function is declared in upipe-x265/upipe_x265.h source file, line 112.

This function enforces profile.

Parameter list:

  • upipe: description structure of the pipe
  • profile: x265 profile

The return value is an error code

int upipe_x265_set_sc_latency(struct upipe *upipe, uint64_t sc_latency)  

This function is declared in upipe-x265/upipe_x265.h source file, line 126.

This function switches upipe-x265 into speedcontrol mode, with the given latency (size of sc buffer).

Parameter list:

  • upipe: description structure of the pipe
  • latency: size (in units of a 27 MHz) of the speedcontrol buffer

The return value is an error code

int upipe_x265_set_slice_type_enforce(struct upipe *upipe, bool enforce)  

This function is declared in upipe-x265/upipe_x265.h source file, line 139.

This function sets the slice type enforcement mode (true or false).

Parameter list:

  • upipe: description structure of the pipe
  • enforce: true if the incoming slice types must be enforced

The return value is an error code

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