aboutsummaryrefslogtreecommitdiff
path: root/docs/plugins/html/gst-plugins-good-plugins-mp4mux.html
blob: ec84c2dc960c83b94886c230806d478589173f73 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>mp4mux</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
<link rel="prev" href="gst-plugins-good-plugins-mpegaudioparse.html" title="mpegaudioparse">
<link rel="next" href="gst-plugins-good-plugins-mulawdec.html" title="mulawdec">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gst-plugins-good-plugins-mpegaudioparse.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Good Plugins 1.0 Plugins Reference Manual</th>
<td><a accesskey="n" href="gst-plugins-good-plugins-mulawdec.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gst-plugins-good-plugins-mp4mux.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#gst-plugins-good-plugins-mp4mux.description" class="shortcut">Description</a>
                   | 
                  <a href="#gst-plugins-good-plugins-mp4mux.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#gst-plugins-good-plugins-mp4mux.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#gst-plugins-good-plugins-mp4mux.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="gst-plugins-good-plugins-mp4mux"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-mp4mux.top_of_page"></a>mp4mux</span></h2>
<p>mp4mux — Muxer for ISO MPEG-4 (.mp4) files</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gst-plugins-good-plugins-mp4mux.synopsis"></a><h2>Synopsis</h2>
<a name="GstMP4Mux"></a><pre class="synopsis">typedef             <a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux">GstMP4Mux</a>;
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-mp4mux.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
         +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
               +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
                     +----GstMP4Mux
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-mp4mux.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GstMP4Mux implements
 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstTagSetter.html">GstTagSetter</a> and  GstTagXmpWriter.</p>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-mp4mux.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux--dts-method" title='The "dts-method" property'>dts-method</a>"               <span class="type">GstQTMuxDtsMethods</span>    : Read / Write / Construct
  "<a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux--faststart" title='The "faststart" property'>faststart</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  "<a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux--faststart-file" title='The "faststart-file" property'>faststart-file</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct
  "<a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux--fragment-duration" title='The "fragment-duration" property'>fragment-duration</a>"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct
  "<a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux--moov-recovery-file" title='The "moov-recovery-file" property'>moov-recovery-file</a>"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct
  "<a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux--movie-timescale" title='The "movie-timescale" property'>movie-timescale</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct
  "<a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux--presentation-time" title='The "presentation-time" property'>presentation-time</a>"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
  "<a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux--streamable" title='The "streamable" property'>streamable</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
  "<a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux--trak-timescale" title='The "trak-timescale" property'>trak-timescale</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-mp4mux.description"></a><h2>Description</h2>
<p>
This element merges streams (audio and video) into ISO MPEG-4 (.mp4) files.
</p>
<p>
The following background intends to explain why various similar muxers
are present in this plugin.
</p>
<p>
The <a class="ulink" href="http://www.apple.com/quicktime/resources/qtfileformat.pdf" target="_top">
QuickTime file format specification</a> served as basis for the MP4 file
format specification (mp4mux), and as such the QuickTime file structure is
nearly identical to the so-called ISO Base Media file format defined in
ISO 14496-12 (except for some media specific parts).
In turn, the latter ISO Base Media format was further specialized as a
Motion JPEG-2000 file format in ISO 15444-3 (mj2mux)
and in various 3GPP(2) specs (3gppmux).
The fragmented file features defined (only) in ISO Base Media are used by
ISMV files making up (a.o.) Smooth Streaming (ismlmux).
</p>
<p>
A few properties (<a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux--movie-timescale" title='The "movie-timescale" property'>movie-timescale</a>,
<a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux--trak-timescale" title='The "trak-timescale" property'>trak-timescale</a>) allow adjusting
some technical parameters, which might be useful in (rare) cases to resolve
compatibility issues in some situations.
</p>
<p>
Some other properties influence the result more fundamentally.
A typical mov/mp4 file's metadata (aka moov) is located at the end of the file,
somewhat contrary to this usually being called "the header".
However, a <a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux--faststart" title='The "faststart" property'>faststart</a> file will
(with some effort) arrange this to be located near start of the file,
which then allows it e.g. to be played while downloading.
Alternatively, rather than having one chunk of metadata at start (or end),
there can be some metadata at start and most of the other data can be spread
out into fragments of <a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux--fragment-duration" title='The "fragment-duration" property'>fragment-duration</a>.
If such fragmented layout is intended for streaming purposes, then
<a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux--streamable" title='The "streamable" property'>streamable</a> allows foregoing to add
index metadata (at the end of file).
</p>
<p>
<a class="link" href="gst-plugins-good-plugins-mp4mux.html#GstMP4Mux--dts-method" title='The "dts-method" property'>dts-method</a> allows selecting a
method for managing input timestamps (stay tuned for 0.11 to have this
automagically settled).  The default delta/duration method should handle nice
(aka perfect streams) just fine, but may experience problems otherwise
(e.g. input stream with re-ordered B-frames and/or with frame dropping).
The re-ordering approach re-assigns incoming timestamps in ascending order
to incoming buffers and offers an alternative in such cases.  In cases where
that might fail, the remaining method can be tried, which is exact and
according to specs, but might experience playback on not so spec-wise players.
Note that this latter approach also requires one to enable
presentation-timestamp.
</p>
<p>
</p>
<div class="refsect2">
<a name="id-1.2.80.7.8.1"></a><h3>Example pipelines</h3>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1</pre></td>
        <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> v4l2src num<span class="gtkdoc opt">-</span>buffers<span class="gtkdoc opt">=</span><span class="number">50</span> <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> x264enc <span class="gtkdoc opt">!</span> mp4mux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>video<span class="gtkdoc opt">.</span>mp4</pre></td>
      </tr>
    </tbody>
  </table>
</div>

Records a video stream captured from a v4l2 device, encodes it into H.264
and muxes it into an mp4 file.
</div>
<p>
</p>
<p>
Documentation last reviewed on 2011-04-21
</p>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="id-1.2.80.7.10.1"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">plugin</span></p></td>
<td>
            <a class="link" href="gst-plugins-good-plugins-plugin-isomp4.html#plugin-isomp4">isomp4</a>
          </td>
</tr>
<tr>
<td><p><span class="term">author</span></p></td>
<td>Thiago Sousa Santos &lt;thiagoss@embedded.ufcg.edu.br&gt;</td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Codec/Muxer</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.80.7.10.2"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>audio_%u</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>request</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>audio/mpeg, mpegversion=(int)1, layer=(int)3, channels=(int)[ 1, 2 ], rate=(int)[ 1, 2147483647 ]</td>
</tr>
<tr>
<td><p><span class="term"></span></p></td>
<td> audio/mpeg, mpegversion=(int)4, stream-format=(string)raw, channels=(int)[ 1, 8 ], rate=(int)[ 1, 2147483647 ]</td>
</tr>
<tr>
<td><p><span class="term"></span></p></td>
<td> audio/x-alac, channels=(int)[ 1, 2 ], rate=(int)[ 1, 2147483647 ]</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>video_%u</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>request</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>video/mpeg, mpegversion=(int)4, systemstream=(boolean)false, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
<tr>
<td><p><span class="term"></span></p></td>
<td> video/x-divx, divxversion=(int)5, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
<tr>
<td><p><span class="term"></span></p></td>
<td> video/x-h264, stream-format=(string)avc, alignment=(string)au, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
<tr>
<td><p><span class="term"></span></p></td>
<td> video/x-mp4-part, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>src</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>source</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>video/quicktime, variant=(string)iso</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-mp4mux.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GstMP4Mux"></a><h3>GstMP4Mux</h3>
<pre class="programlisting">typedef struct _Gst3GPPMux GstMP4Mux;
</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-mp4mux.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstMP4Mux--dts-method"></a><h3>The <code class="literal">"dts-method"</code> property</h3>
<pre class="programlisting">  "dts-method"               <span class="type">GstQTMuxDtsMethods</span>    : Read / Write / Construct</pre>
<p>(DEPRECATED) Method to determine DTS time.</p>
<p>Default value: reorder</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMP4Mux--faststart"></a><h3>The <code class="literal">"faststart"</code> property</h3>
<pre class="programlisting">  "faststart"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
<p>If the file should be formatted for faststart (headers first).</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMP4Mux--faststart-file"></a><h3>The <code class="literal">"faststart-file"</code> property</h3>
<pre class="programlisting">  "faststart-file"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct</pre>
<p>File that will be used temporarily to store data from the stream when creating a faststart file. If null a filepath will be created automatically.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMP4Mux--fragment-duration"></a><h3>The <code class="literal">"fragment-duration"</code> property</h3>
<pre class="programlisting">  "fragment-duration"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct</pre>
<p>Fragment durations in ms (produce a fragmented file if &gt; 0).</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMP4Mux--moov-recovery-file"></a><h3>The <code class="literal">"moov-recovery-file"</code> property</h3>
<pre class="programlisting">  "moov-recovery-file"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct</pre>
<p>File to be used to store data for moov atom making movie file recovery possible in case of a crash during muxing. Null for disabled. (Experimental).</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMP4Mux--movie-timescale"></a><h3>The <code class="literal">"movie-timescale"</code> property</h3>
<pre class="programlisting">  "movie-timescale"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct</pre>
<p>Timescale to use in the movie (units per second).</p>
<p>Allowed values: &gt;= 1</p>
<p>Default value: 1000</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMP4Mux--presentation-time"></a><h3>The <code class="literal">"presentation-time"</code> property</h3>
<pre class="programlisting">  "presentation-time"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
<p>Calculate and include presentation/composition time (in addition to decoding time).</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMP4Mux--streamable"></a><h3>The <code class="literal">"streamable"</code> property</h3>
<pre class="programlisting">  "streamable"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
<p>If set to true, the output should be as if it is to be streamed and hence no indexes written or duration written.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMP4Mux--trak-timescale"></a><h3>The <code class="literal">"trak-timescale"</code> property</h3>
<pre class="programlisting">  "trak-timescale"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct</pre>
<p>Timescale to use for the tracks (units per second, 0 is automatic).</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>