Merge pull request #1160 from sandialabs/update-ffmpeg

Clean up ffmpeg

docs/html/_modules/slycat/web/client.html

@@ -298,7 +298,9 @@ <h1>Source code for slycat.web.client</h1><div class="highlight"><pre>
     <span class="n">host_name</span> <span class="o">=</span> <span class="n">host_name</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 
     <span class="c1"># host and port</span>
-    <span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="o">=</span> <span class="n">host</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">host_alias</span><span class="p">,</span> <span class="n">host_name</span><span class="p">)</span>
+    <span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="o">=</span> <span class="n">host</span>
+    <span class="k">if</span> <span class="n">host</span> <span class="o">!=</span> <span class="n">HOST_DEFAULT</span><span class="p">:</span>
+      <span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="o">=</span> <span class="n">host</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">host_alias</span><span class="p">,</span> <span class="n">host_name</span><span class="p">)</span>
     <span class="k">if</span> <span class="n">port</span><span class="p">:</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="o">+</span> <span class="s1">&#39;:&#39;</span> <span class="o">+</span> <span class="n">port</span>
 
@@ -1046,9 +1048,6 @@ <h1>Source code for slycat.web.client</h1><div class="highlight"><pre>
 <span class="sd">    rid: string</span>
 <span class="sd">      Unique reference identifier.</span>
 
-<span class="sd">    See Also</span>
-<span class="sd">    --------</span>
-<span class="sd">    :http:post:`/api/projects/(pid)/references`</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="s2">&quot;POST&quot;</span><span class="p">,</span> <span class="s2">&quot;/api/projects/</span><span class="si">%s</span><span class="s2">/references&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">pid</span><span class="p">),</span> 

docs/html/_sources/manual/MediaSet.rst.txt

@@ -58,27 +58,22 @@ our web-based delivery, videos must be created in a very specific way to be view
 
 Video Source Files
 ==================
-There is no standardized support for videos between browsers.  We have found that the h264 codec in combination with an mp4
-container format is compatible with Firefox, Chrome, and Safari on both Windows and Mac platforms.  In our testing, we have 
-found that initial key frames are frequently lost, rendering the following compressed frames useless.  This requires explicit 
-key frame forcing during movie creation.  We use the ffmpeg utility to convert images into videos.  Make sure that your 
-version of ffmpeg was built with the h264 library, since some versions of ffmpeg don’t include this codec by default.
+There is no standardized support for videos between browsers. We have found that the h264 codec
+in combination with an mp4 container format is compatible with Firefox, Chrome, and Safari on both
+Windows and Mac platforms. In our testing, we have found that initial key frames are frequently lost,
+rendering the following compressed frames useless. This requires explicit key frame forcing during
+movie creation. We use the ffmpeg utility to convert images into videos. Make sure that your version of
+ffmpeg was built with the h264 library, since some versions of ffmpeg don’t include this codec by default.
 
-If you are within Sandia, we provide this custom version of the library on the cluster machines.  You can generate Slycat™ 
-compatible movies as follows:
-
-::
-
-   > module load slycat
-
-If your images are PNGs, they must be first converted to JPG format (ffmpeg won’t complain about the input images being PNG, 
-but the movie that it generates won’t play).  If you already have JPG images, skip this step:
+If your images are PNGs, they must be first converted to JPG format.  The ffmpeg utility won’t complain
+about the input images being PNG, but the movie that it generates won’t play. (If you already have JPG
+images, skip this step.)  Here’s one possible conversion method:
 
 ::
 
    > mogrify -format jpg myImageName.0*
 
-This last step generates the mp4.  Don’t forget to enclose the image path in single quotes:
+Here is our recommended syntax to generate an mp4 video. Don’t forget to enclose the image path in single quotes:
 
 ::
 

docs/html/manual/MediaSet.html

@@ -146,22 +146,19 @@ <h1>Media Set<a class="headerlink" href="#media-set" title="Permalink to this he
 our web-based delivery, videos must be created in a very specific way to be viewable in Slycat™.</p>
 <section id="video-source-files">
 <h2>Video Source Files<a class="headerlink" href="#video-source-files" title="Permalink to this heading"></a></h2>
-<p>There is no standardized support for videos between browsers.  We have found that the h264 codec in combination with an mp4
-container format is compatible with Firefox, Chrome, and Safari on both Windows and Mac platforms.  In our testing, we have
-found that initial key frames are frequently lost, rendering the following compressed frames useless.  This requires explicit
-key frame forcing during movie creation.  We use the ffmpeg utility to convert images into videos.  Make sure that your
-version of ffmpeg was built with the h264 library, since some versions of ffmpeg don’t include this codec by default.</p>
-<p>If you are within Sandia, we provide this custom version of the library on the cluster machines.  You can generate Slycat™
-compatible movies as follows:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">&gt;</span> <span class="n">module</span> <span class="n">load</span> <span class="n">slycat</span>
-</pre></div>
-</div>
-<p>If your images are PNGs, they must be first converted to JPG format (ffmpeg won’t complain about the input images being PNG,
-but the movie that it generates won’t play).  If you already have JPG images, skip this step:</p>
+<p>There is no standardized support for videos between browsers. We have found that the h264 codec
+in combination with an mp4 container format is compatible with Firefox, Chrome, and Safari on both
+Windows and Mac platforms. In our testing, we have found that initial key frames are frequently lost,
+rendering the following compressed frames useless. This requires explicit key frame forcing during
+movie creation. We use the ffmpeg utility to convert images into videos. Make sure that your version of
+ffmpeg was built with the h264 library, since some versions of ffmpeg don’t include this codec by default.</p>
+<p>If your images are PNGs, they must be first converted to JPG format.  The ffmpeg utility won’t complain
+about the input images being PNG, but the movie that it generates won’t play. (If you already have JPG
+images, skip this step.)  Here’s one possible conversion method:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">&gt;</span> <span class="n">mogrify</span> <span class="o">-</span><span class="nb">format</span> <span class="n">jpg</span> <span class="n">myImageName</span><span class="mf">.0</span><span class="o">*</span>
 </pre></div>
 </div>
-<p>This last step generates the mp4.  Don’t forget to enclose the image path in single quotes:</p>
+<p>Here is our recommended syntax to generate an mp4 video. Don’t forget to enclose the image path in single quotes:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">&gt;</span>  <span class="n">ffmpeg</span> <span class="o">-</span><span class="n">pattern_type</span> <span class="n">glob</span> <span class="o">-</span><span class="n">i</span> <span class="s1">&#39;/someDisk/someUser/someDirectoryPath/myImageName.0*.jpg&#39;</span> <span class="o">-</span><span class="n">force_key_frames</span> <span class="mf">0.0</span><span class="p">,</span><span class="mf">0.04</span><span class="p">,</span><span class="mf">0.08</span> <span class="n">myMovieName</span><span class="o">.</span><span class="n">mp4</span>
 </pre></div>
 </div>

docs/html/slycat-packages/slycat.web.client.html

@@ -933,10 +933,6 @@
 <dd class="field-odd"><p>string</p>
 </dd>
 </dl>
-<div class="admonition seealso">
-<p class="admonition-title">See also</p>
-<p><code class="xref http http-post docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/api/projects/(pid)/references</span></code></p>
-</div>
 </dd></dl>
 
 <dl class="py method">

docs/source/manual/MediaSet.rst

@@ -58,27 +58,22 @@ our web-based delivery, videos must be created in a very specific way to be view
 
 Video Source Files
 ==================
-There is no standardized support for videos between browsers.  We have found that the h264 codec in combination with an mp4
-container format is compatible with Firefox, Chrome, and Safari on both Windows and Mac platforms.  In our testing, we have 
-found that initial key frames are frequently lost, rendering the following compressed frames useless.  This requires explicit 
-key frame forcing during movie creation.  We use the ffmpeg utility to convert images into videos.  Make sure that your 
-version of ffmpeg was built with the h264 library, since some versions of ffmpeg don’t include this codec by default.
+There is no standardized support for videos between browsers. We have found that the h264 codec
+in combination with an mp4 container format is compatible with Firefox, Chrome, and Safari on both
+Windows and Mac platforms. In our testing, we have found that initial key frames are frequently lost,
+rendering the following compressed frames useless. This requires explicit key frame forcing during
+movie creation. We use the ffmpeg utility to convert images into videos. Make sure that your version of
+ffmpeg was built with the h264 library, since some versions of ffmpeg don’t include this codec by default.
 
-If you are within Sandia, we provide this custom version of the library on the cluster machines.  You can generate Slycat™ 
-compatible movies as follows:
-
-::
-
-   > module load slycat
-
-If your images are PNGs, they must be first converted to JPG format (ffmpeg won’t complain about the input images being PNG, 
-but the movie that it generates won’t play).  If you already have JPG images, skip this step:
+If your images are PNGs, they must be first converted to JPG format.  The ffmpeg utility won’t complain
+about the input images being PNG, but the movie that it generates won’t play. (If you already have JPG
+images, skip this step.)  Here’s one possible conversion method:
 
 ::
 
    > mogrify -format jpg myImageName.0*
 
-This last step generates the mp4.  Don’t forget to enclose the image path in single quotes:
+Here is our recommended syntax to generate an mp4 video. Don’t forget to enclose the image path in single quotes:
 
 ::
 

packages/slycat/web/client/__init__.py

@@ -974,9 +974,6 @@ def post_project_references(self, pid, name, mtype=None, mid=None, bid=None):
     rid: string
       Unique reference identifier.
 
-    See Also
-    --------
-    :http:post:`/api/projects/(pid)/references`
     """
 
     return self.request("POST", "/api/projects/%s/references" % (pid), 

web-client/slycat/web/client/__init__.py

@@ -974,9 +974,6 @@ def post_project_references(self, pid, name, mtype=None, mid=None, bid=None):
     rid: string
       Unique reference identifier.
 
-    See Also
-    --------
-    :http:post:`/api/projects/(pid)/references`
     """
 
     return self.request("POST", "/api/projects/%s/references" % (pid),