Deploying to gh-pages from @ b0aeef0 🚀

ffmpeg-av/Av/index.html

@@ -15,19 +15,15 @@
   <span><span class="xref-unresolved">Stdlib</span>.Int64.t option</span></span></code></div><div class="spec-doc"><p><code>Av.get_input_duration ~format:fmt input</code> return the duration of an <code>input</code> in the <code>fmt</code> time format (in second by default).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_input_metadata"><a href="#val-get_input_metadata" class="anchor"></a><code><span><span class="keyword">val</span> get_input_metadata : 
   <span><span><a href="../../ffmpeg-avutil/Avutil/index.html#type-input">Avutil.input</a> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span>
   <span><span>(string * string)</span> list</span></span></code></div><div class="spec-doc"><p>Return the input tag (key, vlue) list.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-input_obj"><a href="#val-input_obj" class="anchor"></a><code><span><span class="keyword">val</span> input_obj : <span><span><a href="../../ffmpeg-avutil/Avutil/index.html#type-input">Avutil.input</a> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span> <a href="../../ffmpeg-avutil/Avutil/Options/index.html#type-obj">Avutil.Options.obj</a></span></code></div><div class="spec-doc"><p>Return a value of type <code>obj</code>, suited for use with <code>Avutils.Options</code> getters.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-stream"><a href="#type-stream" class="anchor"></a><code><span><span class="keyword">type</span> <span>('line, 'media, 'mode) stream</span></span></code></div><div class="spec-doc"><p>Input/output, audio/video/subtitle, mode stream type</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_audio_streams"><a href="#val-get_audio_streams" class="anchor"></a><code><span><span class="keyword">val</span> get_audio_streams : 
-  <span><span><a href="../../ffmpeg-avutil/Avutil/index.html#type-input">Avutil.input</a> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span>
-  <span><span>(int * <span><span>(<a href="../../ffmpeg-avutil/Avutil/index.html#type-input">Avutil.input</a>, <a href="../../ffmpeg-avutil/Avutil/index.html#type-audio">Avutil.audio</a>, <span class="type-var">'a</span>)</span> <a href="#type-stream">stream</a></span> * <span><a href="../../ffmpeg-avutil/Avutil/index.html#type-audio">Avutil.audio</a> <a href="../../ffmpeg-avcodec/Avcodec/index.html#type-params">Avcodec.params</a></span>)</span>
-    list</span></span></code></div><div class="spec-doc"><p>Return the audio stream list of the input. The result is a list of tuple containing the index of the stream in the container, the stream and the codec of the stream.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_video_streams"><a href="#val-get_video_streams" class="anchor"></a><code><span><span class="keyword">val</span> get_video_streams : 
-  <span><span><a href="../../ffmpeg-avutil/Avutil/index.html#type-input">Avutil.input</a> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span>
-  <span><span>(int * <span><span>(<a href="../../ffmpeg-avutil/Avutil/index.html#type-input">Avutil.input</a>, <a href="../../ffmpeg-avutil/Avutil/index.html#type-video">Avutil.video</a>, <span class="type-var">'a</span>)</span> <a href="#type-stream">stream</a></span> * <span><a href="../../ffmpeg-avutil/Avutil/index.html#type-video">Avutil.video</a> <a href="../../ffmpeg-avcodec/Avcodec/index.html#type-params">Avcodec.params</a></span>)</span>
-    list</span></span></code></div><div class="spec-doc"><p>Same as <a href="#val-get_audio_streams"><code>Av.get_audio_streams</code></a> for the video streams.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_subtitle_streams"><a href="#val-get_subtitle_streams" class="anchor"></a><code><span><span class="keyword">val</span> get_subtitle_streams : 
-  <span><span><a href="../../ffmpeg-avutil/Avutil/index.html#type-input">Avutil.input</a> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span>
-  <span><span>(int
-   * <span><span>(<a href="../../ffmpeg-avutil/Avutil/index.html#type-input">Avutil.input</a>, <a href="../../ffmpeg-avutil/Avutil/index.html#type-subtitle">Avutil.subtitle</a>, <span class="type-var">'a</span>)</span> <a href="#type-stream">stream</a></span>
-   * <span><a href="../../ffmpeg-avutil/Avutil/index.html#type-subtitle">Avutil.subtitle</a> <a href="../../ffmpeg-avcodec/Avcodec/index.html#type-params">Avcodec.params</a></span>)</span>
+  <span><span><span class="type-var">'a</span> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span>
+  <span><span>(int * <span><span>(<span class="type-var">'a</span>, <a href="../../ffmpeg-avutil/Avutil/index.html#type-audio">Avutil.audio</a>, <span class="type-var">'b</span>)</span> <a href="#type-stream">stream</a></span> * <span><a href="../../ffmpeg-avutil/Avutil/index.html#type-audio">Avutil.audio</a> <a href="../../ffmpeg-avcodec/Avcodec/index.html#type-params">Avcodec.params</a></span>)</span> list</span></span></code></div><div class="spec-doc"><p>Return the audio stream list of the input. The result is a list of tuple containing the index of the stream in the container, the stream and the codec of the stream.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_video_streams"><a href="#val-get_video_streams" class="anchor"></a><code><span><span class="keyword">val</span> get_video_streams : 
+  <span><span><span class="type-var">'a</span> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span>
+  <span><span>(int * <span><span>(<span class="type-var">'a</span>, <a href="../../ffmpeg-avutil/Avutil/index.html#type-video">Avutil.video</a>, <span class="type-var">'b</span>)</span> <a href="#type-stream">stream</a></span> * <span><a href="../../ffmpeg-avutil/Avutil/index.html#type-video">Avutil.video</a> <a href="../../ffmpeg-avcodec/Avcodec/index.html#type-params">Avcodec.params</a></span>)</span> list</span></span></code></div><div class="spec-doc"><p>Same as <a href="#val-get_audio_streams"><code>Av.get_audio_streams</code></a> for the video streams.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_subtitle_streams"><a href="#val-get_subtitle_streams" class="anchor"></a><code><span><span class="keyword">val</span> get_subtitle_streams : 
+  <span><span><span class="type-var">'a</span> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span>
+  <span><span>(int * <span><span>(<span class="type-var">'a</span>, <a href="../../ffmpeg-avutil/Avutil/index.html#type-subtitle">Avutil.subtitle</a>, <span class="type-var">'b</span>)</span> <a href="#type-stream">stream</a></span> * <span><a href="../../ffmpeg-avutil/Avutil/index.html#type-subtitle">Avutil.subtitle</a> <a href="../../ffmpeg-avcodec/Avcodec/index.html#type-params">Avcodec.params</a></span>)</span>
     list</span></span></code></div><div class="spec-doc"><p>Same as <a href="#val-get_audio_streams"><code>Av.get_audio_streams</code></a> for the subtitle streams.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_data_streams"><a href="#val-get_data_streams" class="anchor"></a><code><span><span class="keyword">val</span> get_data_streams : 
-  <span><span><a href="../../ffmpeg-avutil/Avutil/index.html#type-input">Avutil.input</a> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span>
-  <span><span>(int * <span><span>(<a href="../../ffmpeg-avutil/Avutil/index.html#type-input">Avutil.input</a>, <span>[ `Data ]</span>, <span class="type-var">'a</span>)</span> <a href="#type-stream">stream</a></span> * <span><span>[ `Data ]</span> <a href="../../ffmpeg-avcodec/Avcodec/index.html#type-params">Avcodec.params</a></span>)</span> list</span></span></code></div><div class="spec-doc"><p>Same as <a href="#val-get_audio_streams"><code>Av.get_audio_streams</code></a> for the data streams.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_best_audio_stream"><a href="#val-find_best_audio_stream" class="anchor"></a><code><span><span class="keyword">val</span> find_best_audio_stream : 
+  <span><span><span class="type-var">'a</span> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span>
+  <span><span>(int * <span><span>(<span class="type-var">'a</span>, <span>[ `Data ]</span>, <span class="type-var">'b</span>)</span> <a href="#type-stream">stream</a></span> * <span><span>[ `Data ]</span> <a href="../../ffmpeg-avcodec/Avcodec/index.html#type-params">Avcodec.params</a></span>)</span> list</span></span></code></div><div class="spec-doc"><p>Same as <a href="#val-get_audio_streams"><code>Av.get_audio_streams</code></a> for the data streams.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_best_audio_stream"><a href="#val-find_best_audio_stream" class="anchor"></a><code><span><span class="keyword">val</span> find_best_audio_stream : 
   <span><span><a href="../../ffmpeg-avutil/Avutil/index.html#type-input">Avutil.input</a> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span>
   int * <span><span>(<a href="../../ffmpeg-avutil/Avutil/index.html#type-input">Avutil.input</a>, <a href="../../ffmpeg-avutil/Avutil/index.html#type-audio">Avutil.audio</a>, <span class="type-var">'a</span>)</span> <a href="#type-stream">stream</a></span> * <span><a href="../../ffmpeg-avutil/Avutil/index.html#type-audio">Avutil.audio</a> <a href="../../ffmpeg-avcodec/Avcodec/index.html#type-params">Avcodec.params</a></span></span></code></div><div class="spec-doc"><p>Return the best audio stream of the input. The result is a tuple containing the index of the stream in the container, the stream and the codec of the stream. Raise Error if no stream could be found.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_best_video_stream"><a href="#val-find_best_video_stream" class="anchor"></a><code><span><span class="keyword">val</span> find_best_video_stream : 
   <span><span><a href="../../ffmpeg-avutil/Avutil/index.html#type-input">Avutil.input</a> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span>
@@ -113,13 +109,8 @@
   <span><span><span>(<a href="../../ffmpeg-avutil/Avutil/index.html#type-output">Avutil.output</a>, <span class="type-var">'media</span>, <span>[ `Packet ]</span>)</span> <a href="#type-stream">stream</a></span> <span class="arrow">&#45;&gt;</span></span>
   <span><a href="../../ffmpeg-avutil/Avutil/index.html#type-rational">Avutil.rational</a> <span class="arrow">&#45;&gt;</span></span>
   <span><span><span class="type-var">'media</span> <a href="../../ffmpeg-avcodec/Avcodec/Packet/index.html#type-t">Avcodec.Packet.t</a></span> <span class="arrow">&#45;&gt;</span></span>
-  unit</span></code></div><div class="spec-doc"><p><code>Av.write_packet os time_base pkt</code> write the <code>pkt</code> packet to the <code>os</code> output stream. <code>time_base</code> is the packet's PTS/DTS/duration time base. Raise Error if the writing failed.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_frame"><a href="#val-write_frame" class="anchor"></a><code><span><span class="keyword">val</span> write_frame : 
+  unit</span></code></div><div class="spec-doc"><p><code>Av.write_packet os time_base pkt</code> write the <code>pkt</code> packet to the <code>os</code> output stream. <code>time_base</code> is the packet's PTS/DTS/duration time base.</p><p>Raise Error if the writing failed.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_frame"><a href="#val-write_frame" class="anchor"></a><code><span><span class="keyword">val</span> write_frame : 
+  <span><span class="optlabel">?on_keyframe</span>:<span>(<span>unit <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span>
   <span><span><span>(<a href="../../ffmpeg-avutil/Avutil/index.html#type-output">Avutil.output</a>, <span class="type-var">'media</span>, <span>[ `Frame ]</span>)</span> <a href="#type-stream">stream</a></span> <span class="arrow">&#45;&gt;</span></span>
   <span><span><span class="type-var">'media</span> <a href="../../ffmpeg-avutil/Avutil/index.html#type-frame">Avutil.frame</a></span> <span class="arrow">&#45;&gt;</span></span>
-  unit</span></code></div><div class="spec-doc"><p><code>Av.write_frame os frm</code> write the <code>frm</code> frame to the <code>os</code> output stream.</p><p>Frame PTS should be set and counted in units of <code>time_base</code>, as passed when creating the stream</p><p>Raise Error if the writing failed.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-was_keyframe"><a href="#val-was_keyframe" class="anchor"></a><code><span><span class="keyword">val</span> was_keyframe : <span><span><span>(<a href="../../ffmpeg-avutil/Avutil/index.html#type-output">Avutil.output</a>, <span class="type-var">_</span>, <span class="type-var">_</span>)</span> <a href="#type-stream">stream</a></span> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>true</code> if the last processed frame was a video key frame.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_audio_frame"><a href="#val-write_audio_frame" class="anchor"></a><code><span><span class="keyword">val</span> write_audio_frame : 
-  <span><span><a href="../../ffmpeg-avutil/Avutil/index.html#type-output">Avutil.output</a> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span>
-  <span><span><a href="../../ffmpeg-avutil/Avutil/index.html#type-audio">Avutil.audio</a> <a href="../../ffmpeg-avutil/Avutil/index.html#type-frame">Avutil.frame</a></span> <span class="arrow">&#45;&gt;</span></span>
-  unit</span></code></div><div class="spec-doc"><p><code>Av.write_audio_frame dst frm</code> write the <code>frm</code> audio frame to the <code>dst</code> output audio container. Raise Error if the output format is not defined or if the output media type is not compatible with the frame or if the writing failed.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_video_frame"><a href="#val-write_video_frame" class="anchor"></a><code><span><span class="keyword">val</span> write_video_frame : 
-  <span><span><a href="../../ffmpeg-avutil/Avutil/index.html#type-output">Avutil.output</a> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span>
-  <span><span><a href="../../ffmpeg-avutil/Avutil/index.html#type-video">Avutil.video</a> <a href="../../ffmpeg-avutil/Avutil/index.html#type-frame">Avutil.frame</a></span> <span class="arrow">&#45;&gt;</span></span>
-  unit</span></code></div><div class="spec-doc"><p>Same as <a href="#val-write_audio_frame"><code>Av.write_audio_frame</code></a> for output video container.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-flush"><a href="#val-flush" class="anchor"></a><code><span><span class="keyword">val</span> flush : <span><span><a href="../../ffmpeg-avutil/Avutil/index.html#type-output">Avutil.output</a> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Flush the underlying muxer.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-close"><a href="#val-close" class="anchor"></a><code><span><span class="keyword">val</span> close : <span><span><span class="type-var">_</span> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Close an input or output container.</p></div></div></div></body></html>
+  unit</span></code></div><div class="spec-doc"><p><code>Av.write_frame ?on_keyframe os frm</code> write the <code>frm</code> frame to the <code>os</code> output stream.</p><p>Frame PTS should be set and counted in units of <code>time_base</code>, as passed when creating the stream</p><p>If <code>on_keyframe</code> is provided, it is called on keyframe, _before the keyframe is submitted to the muxer.</p><p>Raise Error if the writing failed.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-flush"><a href="#val-flush" class="anchor"></a><code><span><span class="keyword">val</span> flush : <span><span><a href="../../ffmpeg-avutil/Avutil/index.html#type-output">Avutil.output</a> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Flush the underlying muxer.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-close"><a href="#val-close" class="anchor"></a><code><span><span class="keyword">val</span> close : <span><span><span class="type-var">_</span> <a href="../../ffmpeg-avutil/Avutil/index.html#type-container">Avutil.container</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Close an input or output container.</p></div></div></div></body></html>

index.html

@@ -11,14 +11,14 @@
       <div class="by-name">
       <h2>OCaml package documentation</h2>
       <ol>
-      <li><a href="ffmpeg/index.html">ffmpeg</a> <span class="version">1.1.10</span></li>
-      <li><a href="ffmpeg-av/index.html">ffmpeg-av</a> <span class="version">1.1.10</span></li>
-      <li><a href="ffmpeg-avcodec/index.html">ffmpeg-avcodec</a> <span class="version">1.1.10</span></li>
-      <li><a href="ffmpeg-avdevice/index.html">ffmpeg-avdevice</a> <span class="version">1.1.10</span></li>
-      <li><a href="ffmpeg-avfilter/index.html">ffmpeg-avfilter</a> <span class="version">1.1.10</span></li>
-      <li><a href="ffmpeg-avutil/index.html">ffmpeg-avutil</a> <span class="version">1.1.10</span></li>
-      <li><a href="ffmpeg-swresample/index.html">ffmpeg-swresample</a> <span class="version">1.1.10</span></li>
-      <li><a href="ffmpeg-swscale/index.html">ffmpeg-swscale</a> <span class="version">1.1.10</span></li>
+      <li><a href="ffmpeg/index.html">ffmpeg</a> <span class="version">1.2.0</span></li>
+      <li><a href="ffmpeg-av/index.html">ffmpeg-av</a> <span class="version">1.2.0</span></li>
+      <li><a href="ffmpeg-avcodec/index.html">ffmpeg-avcodec</a> <span class="version">1.2.0</span></li>
+      <li><a href="ffmpeg-avdevice/index.html">ffmpeg-avdevice</a> <span class="version">1.2.0</span></li>
+      <li><a href="ffmpeg-avfilter/index.html">ffmpeg-avfilter</a> <span class="version">1.2.0</span></li>
+      <li><a href="ffmpeg-avutil/index.html">ffmpeg-avutil</a> <span class="version">1.2.0</span></li>
+      <li><a href="ffmpeg-swresample/index.html">ffmpeg-swresample</a> <span class="version">1.2.0</span></li>
+      <li><a href="ffmpeg-swscale/index.html">ffmpeg-swscale</a> <span class="version">1.2.0</span></li>
       </ol>
       </div>
     </main>