vp8enc

vp8enc

Properties

gint bitrate Read / Write
gboolean error-resilient Read / Write
gint max-keyframe-distance Read / Write
gint max-latency Read / Write
GstVP8EncMode mode Read / Write
gdouble quality Read / Write
gint speed Read / Write
gint threads Read / Write
gchar * multipass-cache-file Read / Write
GstVP8EncMultipassMode multipass-mode Read / Write
gboolean auto-alt-ref-frames Read / Write
gint max-quantizer Read / Write
gint min-quantizer Read / Write
gint drop-frame Read / Write
guint lag-in-frames Read / Write
guint maxsection-pct Read / Write
guint minsection-pct Read / Write
gint noise-sensitivity Read / Write
gboolean resize-allowed Read / Write
gint sharpness Read / Write
gint static-threshold Read / Write
gint token-parts Read / Write
GstVP8EncTune tune Read / Write

Types and Values

struct GstVP8Enc

Object Hierarchy

    GObject
    ╰── GstObject
        ╰── GstElement
            ╰── GstBaseVideoCodec
                ╰── GstBaseVideoEncoder
                    ╰── GstVP8Enc

Implemented Interfaces

GstVP8Enc implements GstTagSetter and GstPreset.

Description

This element encodes raw video into a VP8 stream.

VP8 is a royalty-free

video codec maintained by Google . It's the successor of On2 VP3, which was the base of the Theora video codec.

To control the quality of the encoding, the “bitrate” and “quality” properties can be used. These two properties are mutualy exclusive. Setting the bitrate property will produce a constant bitrate (CBR) stream while setting the quality property will produce a variable bitrate (VBR) stream.

Example pipeline

1
gst-launch -v videotestsrc num-buffers=1000 ! vp8enc ! webmmux ! filesink location=videotestsrc.webm
This example pipeline will encode a test video source to VP8 muxed in an WebM container.

Functions

Types and Values

struct GstVP8Enc

struct GstVP8Enc;

Property Details

The “bitrate” property

  “bitrate”                  gint

Bit rate (in bits/sec).

Flags: Read / Write

Allowed values: [0,1000000000]

Default value: 0

The “error-resilient” property

  “error-resilient”          gboolean

Encode streams that are error resilient.

Flags: Read / Write

Default value: FALSE

The “max-keyframe-distance” property

  “max-keyframe-distance”    gint

Maximum distance between key frames.

Flags: Read / Write

Allowed values: [0,9999]

Default value: 60

The “max-latency” property

  “max-latency”              gint

Number of frames in encoder queue.

Flags: Read / Write

Allowed values: [0,25]

Default value: 10

The “mode” property

  “mode”                     GstVP8EncMode

Mode.

Flags: Read / Write

Default value: Variable Bit Rate (VBR) mode

The “quality” property

  “quality”                  gdouble

Quality. This parameter sets a constant quantizer.

Flags: Read / Write

Allowed values: [0,10]

Default value: 5

The “speed” property

  “speed”                    gint

Speed.

Flags: Read / Write

Allowed values: [0,7]

Default value: 0

The “threads” property

  “threads”                  gint

Threads.

Flags: Read / Write

Allowed values: [1,64]

Default value: 1

The “multipass-cache-file” property

  “multipass-cache-file”     gchar *

Multipass cache file.

Flags: Read / Write

Default value: "multipass.cache"

The “multipass-mode” property

  “multipass-mode”           GstVP8EncMultipassMode

Multipass encode mode.

Flags: Read / Write

Default value: One pass encoding (default)

The “auto-alt-ref-frames” property

  “auto-alt-ref-frames”      gboolean

Automatically create alternative reference frames.

Flags: Read / Write

Default value: FALSE

The “max-quantizer” property

  “max-quantizer”            gint

Maximum (worst) quantizer.

Flags: Read / Write

Allowed values: [0,63]

Default value: 63

The “min-quantizer” property

  “min-quantizer”            gint

Minimum (best) quantizer.

Flags: Read / Write

Allowed values: [0,63]

Default value: 0

The “drop-frame” property

  “drop-frame”               gint

Drop Frame.

Flags: Read / Write

Allowed values: [0,100]

Default value: 0

The “lag-in-frames” property

  “lag-in-frames”            guint

If set, this value allows the encoder to consume a number of input frames before producing output frames.

Flags: Read / Write

Allowed values: <= 64

Default value: 0

The “maxsection-pct” property

  “maxsection-pct”           guint

The numbers represent a percentage of the average allocation per section (frame).

Flags: Read / Write

Allowed values: [200,800]

Default value: 800

The “minsection-pct” property

  “minsection-pct”           guint

The numbers represent a percentage of the average allocation per section (frame).

Flags: Read / Write

Allowed values: <= 20

Default value: 5

The “noise-sensitivity” property

  “noise-sensitivity”        gint

Noise Sensitivity.

Flags: Read / Write

Allowed values: [0,6]

Default value: 0

The “resize-allowed” property

  “resize-allowed”           gboolean

Resize Allowed.

Flags: Read / Write

Default value: TRUE

The “sharpness” property

  “sharpness”                gint

Sharpness.

Flags: Read / Write

Allowed values: [0,7]

Default value: 0

The “static-threshold” property

  “static-threshold”         gint

Static Threshold.

Flags: Read / Write

Allowed values: [0,1000]

Default value: 0

The “token-parts” property

  “token-parts”              gint

Token Parts.

Flags: Read / Write

Allowed values: [0,3]

Default value: 0

The “tune” property

  “tune”                     GstVP8EncTune

Tune.

Flags: Read / Write

Default value: Tune for PSNR

See Also

vp8dec, webmmux, oggmux