splitmuxsink

splitmuxsink — Muxer wrapper for splitting output stream by size or time

Synopsis

struct              GstSplitMuxSink;

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GstObject
               +----GstElement
                     +----GstBin
                           +----GstSplitMuxSink

Implemented Interfaces

GstSplitMuxSink implements GstChildProxy.

Properties

  "location"                 gchar*                : Read / Write
  "max-size-bytes"           guint64               : Read / Write
  "max-size-time"            guint64               : Read / Write
  "mux-overhead"             gdouble               : Read / Write
  "muxer"                    GstElement*           : Read / Write
  "sink"                     GstElement*           : Read / Write
  "max-files"                guint                 : Read / Write
  "send-keyframe-requests"   gboolean              : Read / Write

Signals

  "format-location"                                : Run Last

Description

This element wraps a muxer and a sink, and starts a new file when the mux contents are about to cross a threshold of maximum size of maximum time, splitting at video keyframe boundaries. Exactly one input video stream can be muxed, with as many accompanying audio and subtitle streams as desired.

By default, it uses mp4mux and filesink, but they can be changed via the 'muxer' and 'sink' properties.

The minimum file size is 1 GOP, however - so limits may be overrun if the distance between any 2 keyframes is larger than the limits.

If a video stream is available, the splitting process is driven by the video stream contents, and the video stream must contain closed GOPs for the output file parts to be played individually correctly. In the absence of a video stream, the first available stream is used as reference for synchronization.

Example pipelines

1
gst-launch-1.0 -e v4l2src num-buffers=500 ! video/x-raw,width=320,height=240 ! videoconvert ! queue ! timeoverlay ! x264enc key-int-max=10 ! h264parse ! splitmuxsink location=video%02d.mov max-size-time=10000000000 max-size-bytes=1000000
Records a video stream captured from a v4l2 device and muxes it into ISO mp4 files, splitting as needed to limit size/duration to 10 seconds and 1MB maximum size.

Synopsis

Element Information

plugin

multifile

author

Jan Schmidt <jan@centricular.com>

class

Generic/Bin/Muxer

Element Pads

name

audio_%u

direction

sink

presence

request

details

ANY

name

subtitle_%u

direction

sink

presence

request

details

ANY

name

video

direction

sink

presence

request

details

ANY

Details

struct GstSplitMuxSink

struct GstSplitMuxSink;

Property Details

The "location" property

  "location"                 gchar*                : Read / Write

Format string pattern for the location of the files to write (e.g. video%05d.mp4).

Default value: NULL


The "max-size-bytes" property

  "max-size-bytes"           guint64               : Read / Write

Max. amount of data per file (in bytes, 0=disable).

Default value: 0


The "max-size-time" property

  "max-size-time"            guint64               : Read / Write

Max. amount of time per file (in ns, 0=disable).

Default value: 0


The "mux-overhead" property

  "mux-overhead"             gdouble               : Read / Write

Extra size overhead of muxing (0.02 = 2%).

Allowed values: [0,1]

Default value: 0.02


The "muxer" property

  "muxer"                    GstElement*           : Read / Write

The muxer element to use (NULL = default mp4mux).


The "sink" property

  "sink"                     GstElement*           : Read / Write

The sink element (or element chain) to use (NULL = default filesink).


The "max-files" property

  "max-files"                guint                 : Read / Write

Maximum number of files to keep on disk. Once the maximum is reached,old files start to be deleted to make room for new ones.

Default value: 0


The "send-keyframe-requests" property

  "send-keyframe-requests"   gboolean              : Read / Write

Request a keyframe every max-size-time ns to try splitting at that point. Needs max-size-bytes to be 0 in order to be effective.

Default value: FALSE

Signal Details

The "format-location" signal

gchar*              user_function                      (GstSplitMuxSink *splitmux,
                                                        guint            fragment_id,
                                                        gpointer         user_data)        : Run Last

splitmux :

the GstSplitMuxSink

fragment_id :

the sequence number of the file to be created

user_data :

user data set when the signal handler was connected.

Returns :

the location to be used for the next output file