Blame docs/plugins/html/gst-plugins-base-plugins-videorate.html

Packit 971217
Packit 971217
<html>
Packit 971217
<head>
Packit 971217
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 971217
<title>videorate: 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-videoconvert.html" title="videoconvert">
Packit 971217
<link rel="next" href="gst-plugins-base-plugins-videoscale.html" title="videoscale">
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
                  Properties
Packit 971217
Packit 971217
Home
Packit 971217
Up
Packit 971217
Prev
Packit 971217
Next
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

videorate

Packit 971217

videorate

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
guint64
Packit 971217
average-period
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
guint64
Packit 971217
drop
Packit 971217
Read
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
drop-only
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
guint64
Packit 971217
duplicate
Packit 971217
Read
Packit 971217
Packit 971217
Packit 971217
guint64
Packit 971217
in
Packit 971217
Read
Packit 971217
Packit 971217
Packit 971217
gint
Packit 971217
max-rate
Packit 971217
Read / Write / Construct
Packit 971217
Packit 971217
Packit 971217
gdouble
Packit 971217
new-pref
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
guint64
Packit 971217
out
Packit 971217
Read
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
silent
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
skip-to-first
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gdouble
Packit 971217
rate
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
struct
Packit 971217
GstVideoRate
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
                ╰── GstBaseTransform
Packit 971217
                    ╰── GstVideoRate
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Description

Packit 971217

This element takes an incoming stream of timestamped video frames.

Packit 971217
It will produce a perfect stream that matches the source pad's framerate.

Packit 971217

The correction is performed by dropping and duplicating frames, no fancy

Packit 971217
algorithm is used to interpolate frames (yet).

Packit 971217

By default the element will simply negotiate the same framerate on its

Packit 971217
source and sink pad.

Packit 971217

This operation is useful to link to elements that require a perfect stream.

Packit 971217
Typical examples are formats that do not store timestamps for video frames,
Packit 971217
but only store a framerate, like Ogg and AVI.

Packit 971217

A conversion to a specific framerate can be forced by using filtered caps on

Packit 971217
the source pad.

Packit 971217

The properties “in”, “out”, “duplicate”

Packit 971217
and “drop” can be read to obtain information about number of
Packit 971217
input frames, output frames, dropped frames (i.e. the number of unused input
Packit 971217
frames) and duplicated frames (i.e. the number of times an input frame was
Packit 971217
duplicated, beside being used normally).

Packit 971217

An input stream that needs no adjustments will thus never have dropped or

Packit 971217
duplicated frames.

Packit 971217

When the “silent” property is set to FALSE, a GObject property

Packit 971217
notification will be emitted whenever one of the “duplicate” or
Packit 971217
“drop” values changes.
Packit 971217
This can potentially cause performance degradation.
Packit 971217
Note that property notification will happen from the streaming thread, so
Packit 971217
applications should be prepared for this.

Packit 971217

The property “rate” allows the modification of video speed by a

Packit 971217
certain factor. It must not be confused with framerate. Think of rate as
Packit 971217
speed and framerate as flow.

Packit 971217
Packit 971217

Example pipelines

Packit 971217
Packit 971217
  
Packit 971217
    
Packit 971217
      
Packit 971217
        
1
Packit 971217
        
gst-launch-1.0 -v uridecodebin uri=file:///path/to/video.ogg ! videoconvert ! videoscale ! videorate ! video/x-raw,framerate=15/1 ! autovideosink
Packit 971217
      
Packit 971217
    
Packit 971217
  
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 Decode a video file and adjust the framerate to 15 fps before playing.
Packit 971217
To create a test Ogg/Theora file refer to the documentation of theoraenc.

Packit 971217
Packit 971217
  
Packit 971217
    
Packit 971217
      
Packit 971217
        
1
Packit 971217
        
gst-launch-1.0 -v v4l2src ! videorate ! video/x-raw,framerate=25/2 ! theoraenc ! oggmux ! filesink location=recording.ogg
Packit 971217
      
Packit 971217
    
Packit 971217
  
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 Capture video from a V4L device, and adjust the stream to 12.5 fps before
Packit 971217
encoding to Ogg/Theora.

Packit 971217
Packit 971217
  
Packit 971217
    
Packit 971217
      
Packit 971217
        
1
Packit 971217
        
gst-launch-1.0 -v uridecodebin uri=file:///path/to/video.ogg ! videoconvert ! videoscale ! videorate ! video/x-raw,framerate=1/5 ! jpegenc ! multifilesink location=snapshot-%05d.jpg
Packit 971217
      
Packit 971217
    
Packit 971217
  
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 Decode a video file and save a snapshot every 5 seconds as consecutively numbered jpeg file.

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
            videorate
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
Filter/Effect/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(ANY)
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 video/x-bayer(ANY)
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 image/jpeg(ANY)
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 image/png(ANY)
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-raw(ANY)
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 video/x-bayer(ANY)
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 image/jpeg(ANY)
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 image/png(ANY)
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 GstVideoRate

Packit 971217
struct GstVideoRate;
Packit 971217

Opaque data structure.

Packit 971217
Packit 971217
Packit 971217
Packit 971217

Property Details

Packit 971217
Packit 971217

The “average-period” property

Packit 971217
  “average-period”           guint64
Packit 971217

Arrange for maximum framerate by dropping frames beyond a certain framerate,

Packit 971217
where the framerate is calculated using a moving average over the
Packit 971217
configured.

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: <= G_MAXLONG

Packit 971217

Default value: 0

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “drop” property

Packit 971217
  “drop”                     guint64
Packit 971217

Number of dropped frames.

Packit 971217

Flags: Read

Packit 971217

Default value: 0

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “drop-only” property

Packit 971217
  “drop-only”                gboolean
Packit 971217

Only drop frames, no duplicates are produced.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: FALSE

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “duplicate” property

Packit 971217
  “duplicate”                guint64
Packit 971217

Number of duplicated frames.

Packit 971217

Flags: Read

Packit 971217

Default value: 0

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “in” property

Packit 971217
  “in”                       guint64
Packit 971217

Number of input frames.

Packit 971217

Flags: Read

Packit 971217

Default value: 0

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “max-rate” property

Packit 971217
  “max-rate”                 gint
Packit 971217

maximum framerate to pass through

Packit 971217

Flags: Read / Write / Construct

Packit 971217

Allowed values: >= 1

Packit 971217

Default value: 2147483647

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “new-pref” property

Packit 971217
  “new-pref”                 gdouble
Packit 971217

Value indicating how much to prefer new frames (unused).

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: [0,1]

Packit 971217

Default value: 1

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “out” property

Packit 971217
  “out”                      guint64
Packit 971217

Number of output frames.

Packit 971217

Flags: Read

Packit 971217

Default value: 0

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “silent” property

Packit 971217
  “silent”                   gboolean
Packit 971217

Don't emit notify for dropped and duplicated frames.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: TRUE

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “skip-to-first” property

Packit 971217
  “skip-to-first”            gboolean
Packit 971217

Don't produce buffers before the first one we receive.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: FALSE

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “rate” property

Packit 971217
  “rate”                     gdouble
Packit 971217

Factor of speed for frame displaying

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: >= 0

Packit 971217

Default value: 1

Packit 971217

Since: 1.12

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Generated by GTK-Doc V1.27
Packit 971217
</body>
Packit 971217
</html>