upipe-x264/upipe_x264.h header reference

Upipe x264 module More

Header inclusion  

Members  

Type  

Functions  

Description  

Upipe x264 module

Members detail  

#define UPIPE_X264_SIGNATURE  

This macro is declared in upipe-x264/upipe_x264.h source file, line 40.

#define _UPIPE_MODULES_UPIPE_X264_H_  

This macro is declared in upipe-x264/upipe_x264.h source file, line 33.

enum upipe_x264_command  

This enum is declared in upipe-x264/upipe_x264.h source file, line 44.

This enum extends upipe_command with specific commands for x264.

IdentifierValueDescription
UPIPE_X264_SENTINEL0
UPIPE_X264_RECONFIG1reconfigure encoder with updated parameters
UPIPE_X264_SET_DEFAULT2set default params
UPIPE_X264_SET_DEFAULT_MPEG23set default mpeg2 params
UPIPE_X264_SET_DEFAULT_PRESET4set default params for preset (const char *, const char *)
UPIPE_X264_SET_PROFILE5enforce profile (const char *)
UPIPE_X264_SET_SC_LATENCY6switches to speedcontrol mode with the given latency (uint64_t)

struct upipe_mgr * upipe_x264_mgr_alloc(void )  

This function is declared in upipe-x264/upipe_x264.h source file, line 141.

This function returns the management structure for x264 pipes.

The return value is pointer to manager

bool upipe_x264_reconfigure(struct upipe *upipe)  

This function is declared in upipe-x264/upipe_x264.h source file, line 72.

This function reconfigures encoder with updated parameters.

Parameters list:

  • upipe: description structure of the pipe

The return value is false in case of error

bool upipe_x264_set_default(struct upipe *upipe)  

This function is declared in upipe-x264/upipe_x264.h source file, line 82.

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

Parameters list:

  • upipe: description structure of the pipe

The return value is false in case of error

bool upipe_x264_set_default_mpeg2(struct upipe *upipe)  

This function is declared in upipe-x264/upipe_x264.h source file, line 92.

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

Parameters list:

  • upipe: description structure of the pipe

The return value is false in case of error

bool upipe_x264_set_default_preset(struct upipe *upipe, const char *preset, const char *tuning)  

This function is declared in upipe-x264/upipe_x264.h source file, line 106.

This function sets default parameters for specified preset.

Parameters list:

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

The return value is false in case of error

bool upipe_x264_set_profile(struct upipe *upipe, const char *profile)  

This function is declared in upipe-x264/upipe_x264.h source file, line 118.

This function enforces profile.

Parameters list:

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

The return value is false in case of error

bool upipe_x264_set_sc_latency(struct upipe *upipe, uint64_t sc_latency)  

This function is declared in upipe-x264/upipe_x264.h source file, line 132.

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

Parameters list:

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

The return value is false in case of error

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