|
Packit |
971217 |
|
|
Packit |
971217 |
<html>
|
|
Packit |
971217 |
<head>
|
|
Packit |
971217 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
971217 |
<title>theoraenc: GStreamer Base Plugins 1.0 Plugins Reference Manual</title>
|
|
Packit |
971217 |
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
|
|
Packit |
971217 |
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Plugins Reference Manual">
|
|
Packit |
971217 |
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
|
|
Packit |
971217 |
<link rel="prev" href="gst-plugins-base-plugins-theoradec.html" title="theoradec">
|
|
Packit |
971217 |
<link rel="next" href="gst-plugins-base-plugins-theoraparse.html" title="theoraparse">
|
|
Packit |
971217 |
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
|
|
Packit |
971217 |
<link rel="stylesheet" href="style.css" type="text/css">
|
|
Packit |
971217 |
</head>
|
|
Packit |
971217 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Top |
|
|
Packit |
971217 |
Description |
|
|
Packit |
971217 |
Object Hierarchy |
|
|
Packit |
971217 |
Implemented Interfaces |
|
|
Packit |
971217 |
Properties
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
theoraenc
|
|
Packit |
971217 |
theoraenc
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Properties
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gint
|
|
Packit |
971217 |
bitrate
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
cap-overflow
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
cap-underflow
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
drop-frames
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
keyframe-auto
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gint
|
|
Packit |
971217 |
keyframe-force
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gint
|
|
Packit |
971217 |
keyframe-freq
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gchar *
|
|
Packit |
971217 |
multipass-cache-file
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstTheoraEncMultipassMode
|
|
Packit |
971217 |
multipass-mode
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gint
|
|
Packit |
971217 |
quality
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gint
|
|
Packit |
971217 |
rate-buffer
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gint
|
|
Packit |
971217 |
speed-level
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
vp3-compatible
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Types and Values
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
struct
|
|
Packit |
971217 |
GstTheoraEnc
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enum
|
|
Packit |
971217 |
GstTheoraEncMultipassMode
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Object Hierarchy
|
|
Packit |
971217 |
GObject
|
|
Packit |
971217 |
╰── GInitiallyUnowned
|
|
Packit |
971217 |
╰── GstObject
|
|
Packit |
971217 |
╰── GstElement
|
|
Packit |
971217 |
╰── GstVideoEncoder
|
|
Packit |
971217 |
╰── GstTheoraEnc
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Implemented Interfaces
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstTheoraEnc implements
|
|
Packit |
971217 |
GstPreset.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Description
|
|
Packit |
971217 |
This element encodes raw video into a Theora stream.
|
|
Packit |
971217 |
Theora is a royalty-free
|
|
Packit |
971217 |
video codec maintained by the Xiph.org
|
|
Packit |
971217 |
Foundation, based on the VP3 codec.
|
|
Packit |
971217 |
The theora codec internally only supports encoding of images that are a
|
|
Packit |
971217 |
multiple of 16 pixels in both X and Y direction. It is however perfectly
|
|
Packit |
971217 |
possible to encode images with other dimensions because an arbitrary
|
|
Packit |
971217 |
rectangular cropping region can be set up. This element will automatically
|
|
Packit |
971217 |
set up a correct cropping region if the dimensions are not multiples of 16
|
|
Packit |
971217 |
pixels.
|
|
Packit |
971217 |
To control the quality of the encoding, the “bitrate” and
|
|
Packit |
971217 |
“quality” properties can be used. These two properties are
|
|
Packit |
971217 |
mutualy exclusive. Setting the bitrate property will produce a constant
|
|
Packit |
971217 |
bitrate (CBR) stream while setting the quality property will produce a
|
|
Packit |
971217 |
variable bitrate (VBR) stream.
|
|
Packit |
971217 |
A videorate element is often required in front of theoraenc, especially
|
|
Packit |
971217 |
when transcoding and when putting Theora into the Ogg container.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Example pipeline
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
1
|
|
Packit |
971217 |
gst-launch-1.0 -v videotestsrc num-buffers=500 ! video/x-raw,width=1280,height=720 ! queue ! progressreport ! theoraenc ! oggmux ! filesink location=videotestsrc.ogg
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
This example pipeline will encode a test video source to theora muxed in an
|
|
Packit |
971217 |
ogg container. Refer to the theoradec documentation to decode the create
|
|
Packit |
971217 |
stream.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Synopsis
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Element Information
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
plugin
|
|
Packit |
971217 |
|
|
Packit |
971217 |
theora
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
author
|
|
Packit |
971217 |
Wim Taymans <wim@fluendo.com>
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
class
|
|
Packit |
971217 |
Codec/Encoder/Video
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Element Pads
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
name
|
|
Packit |
971217 |
sink
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
direction
|
|
Packit |
971217 |
sink
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
presence
|
|
Packit |
971217 |
always
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
details
|
|
Packit |
971217 |
video/x-raw, format=(string){ I420, Y42B, Y444 }, framerate=(fraction)[ 1/2147483647, 2147483647/1 ], width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ]
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
name
|
|
Packit |
971217 |
src
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
direction
|
|
Packit |
971217 |
source
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
presence
|
|
Packit |
971217 |
always
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
details
|
|
Packit |
971217 |
video/x-theora, framerate=(fraction)[ 1/2147483647, 2147483647/1 ], width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ]
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Functions
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Types and Values
|
|
Packit |
971217 |
|
|
Packit |
971217 |
struct GstTheoraEnc
|
|
Packit |
971217 |
struct GstTheoraEnc;
|
|
Packit |
971217 |
Opaque data structure.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enum GstTheoraEncMultipassMode
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Members
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
MULTIPASS_MODE_SINGLE_PASS
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Single pass encoding
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
MULTIPASS_MODE_FIRST_PASS
|
|
Packit |
971217 |
|
|
Packit |
971217 |
First pass of two pass encoding
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
MULTIPASS_MODE_SECOND_PASS
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Second pass of two pass encoding
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Property Details
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “bitrate” property
|
|
Packit |
971217 |
“bitrate” gint
|
|
Packit |
971217 |
Compressed video bitrate (kbps).
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Allowed values: [0,16777215]
|
|
Packit |
971217 |
Default value: 0
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “cap-overflow” property
|
|
Packit |
971217 |
“cap-overflow” gboolean
|
|
Packit |
971217 |
Enable capping of bit reservoir overflows.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Default value: TRUE
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “cap-underflow” property
|
|
Packit |
971217 |
“cap-underflow” gboolean
|
|
Packit |
971217 |
Enable capping of bit reservoir underflows.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Default value: FALSE
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “drop-frames” property
|
|
Packit |
971217 |
“drop-frames” gboolean
|
|
Packit |
971217 |
Allow or disallow frame dropping.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Default value: TRUE
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “keyframe-auto” property
|
|
Packit |
971217 |
“keyframe-auto” gboolean
|
|
Packit |
971217 |
Automatic keyframe detection.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Default value: TRUE
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “keyframe-force” property
|
|
Packit |
971217 |
“keyframe-force” gint
|
|
Packit |
971217 |
Force keyframe every N frames.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Allowed values: [1,32768]
|
|
Packit |
971217 |
Default value: 64
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “keyframe-freq” property
|
|
Packit |
971217 |
“keyframe-freq” gint
|
|
Packit |
971217 |
Keyframe frequency.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Allowed values: [1,32768]
|
|
Packit |
971217 |
Default value: 64
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “multipass-cache-file” property
|
|
Packit |
971217 |
“multipass-cache-file” gchar *
|
|
Packit |
971217 |
Multipass cache file.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Default value: NULL
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “multipass-mode” property
|
|
Packit |
971217 |
“multipass-mode” GstTheoraEncMultipassMode
|
|
Packit |
971217 |
Single pass or first/second pass.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Default value: Single pass
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “quality” property
|
|
Packit |
971217 |
“quality” gint
|
|
Packit |
971217 |
Video quality.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Allowed values: [0,63]
|
|
Packit |
971217 |
Default value: 48
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “rate-buffer” property
|
|
Packit |
971217 |
“rate-buffer” gint
|
|
Packit |
971217 |
Sets the size of the rate control buffer, in units of frames. The default value of 0 instructs the encoder to automatically select an appropriate value.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Allowed values: [0,1000]
|
|
Packit |
971217 |
Default value: 0
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “speed-level” property
|
|
Packit |
971217 |
“speed-level” gint
|
|
Packit |
971217 |
Controls the amount of motion vector searching done while encoding.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Allowed values: [0,3]
|
|
Packit |
971217 |
Default value: 1
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “vp3-compatible” property
|
|
Packit |
971217 |
“vp3-compatible” gboolean
|
|
Packit |
971217 |
Disables non-VP3 compatible features.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Default value: FALSE
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
See Also
|
|
Packit |
971217 |
theoradec, oggmux
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Generated by GTK-Doc V1.27
|
|
Packit |
971217 |
</body>
|
|
Packit |
971217 |
</html>
|