Ticket #7298: trac-7298-ogv.patch

sage/misc/html.py

@@ -267 +267 @@
             column_tag = "<th>%s</th>"
 
         from sage.plot.plot import Graphics
+        from sage.plot.animate import Animation
         import types
         if isinstance(row, types.GeneratorType):
             row = list(row)
@@ -274 +275 @@
             row = [row]
 
         for column in xrange(len(row)):
-            if isinstance(row[column], Graphics):
+            if isinstance(row[column], (Graphics, Animation)):
                 print column_tag % row[column].show(linkmode = True)
             elif isinstance(row[column], str):
                 print column_tag % math_parse(row[column])

sage/plot/animate.py

@@ -350 +350 @@
             print ""
             print "See www.imagemagick.org, for example."
 
-    def show(self, delay=20, iterations=0):
+    def ogv(self, delay=20, savefile=None, iterations=0, show_path=False):
+        r"""
+        Returns an Ogg Theora video of the graphics
+        objects in self.
+        
+        This function will only work if the libtheora spkg is installed.
+        
+        INPUT:
+        
+        
+        -  ``delay`` - (default: 20) delay in hundredths of a
+           second between frames
+        
+        -  ``savefile`` - file that the Ogg Theora video gets saved
+           to
+        
+        -  ``iterations`` - integer (default: 0); number of
+           iterations of animation. If 0, loop forever.
+        
+        -  ``show_path`` - boolean (default: False); if True,
+           print the path to the saved file
+        
+        
+        If savefile is not specified: in notebook mode, display the
+        animation; otherwise, save it to a default file name.
+        
+        EXAMPLES::
+        
+            sage: a = animate([sin(x + float(k)) for k in srange(0,2*pi,0.7)], 
+            ...                xmin=0, xmax=2*pi, figsize=[2,1])
+            sage: a.ogv()                                            # optional -- requires libtheora
+            sage: a.ogv(delay=35, iterations=3)                      # optional -- requires libtheora
+            sage: a.ogv(savefile='my_animation.ogv')                 # optional -- requires libtheora
+            sage: a.ogv(savefile='my_animation.ogv', show_path=True) # optional -- requires libtheora
+            Animation saved to .../my_animation.ogv.
+        
+        .. note::
+
+           If libtheora is not installed, you will get an error
+           message like this::
+
+              Error: libtheora does not appear to be installed. Saving an
+              animation to a Ogg Theora file or displaying an animation
+              requires the libtheora spkg, so please install it and try again.
+        """
+        if not savefile:
+            savefile = sage.misc.misc.graphics_filename(ext='ogv')
+        if not savefile.endswith('.ogv'):
+            savefile += '.ogv'
+        savefile = os.path.abspath(savefile)
+        d = self.png()
+        #cmd = 'cd "%s"; sage-native-execute ffmpeg2theora %%08d.png --inputfps %s -o "%s" 2> /dev/null'%(d, 100/delay, savefile)
+        cmd = 'cd "%s"; sage-native-execute png2theora -o "%s" -f %s  %%08d.png 2> /dev/null'%(d, savefile, int(100/delay))
+        from subprocess import check_call, CalledProcessError
+        try:
+            check_call(cmd, shell=True)
+            if show_path:
+                print "Animation saved to file %s." % savefile
+        except (CalledProcessError, OSError):
+            print ""
+            print "Error: libtheora does not appear to be installed. Saving an"
+            print "animation to a Ogg Theora file or displaying an animation requires the"
+            print "libtheora spkg, so please install it and try again."
+
+
+    def show(self, delay=20, iterations=0, format='gif', linkmode = False):
         r"""
         Show this animation.
         
@@ -363 +428 @@
         -  ``iterations`` - integer (default: 0); number of
            iterations of animation. If 0, loop forever.
         
+        - ``format`` - (default: 'gif') the output format.
+          Either 'gif' or 'ogv'.
         
         .. note::
 
@@ -376 +443 @@
             sage: a = animate([sin(x + float(k)) for k in srange(0,2*pi,0.7)], 
             ...                xmin=0, xmax=2*pi, figsize=[2,1])
             sage: a.show()       # optional -- requires convert command
+
+            sage: b = animate([sin(y*x^2)*cos(x/2) for y in srange(0,2,0.05)], xmin = -pi, xmax=pi, ymax = 1, ymin = -1)
+            sage: b.show(format = 'ogv')  # optional -- requires libtheora
         
         The preceding will loop the animation forever. If you want to show
         only three iterations instead::
@@ -401 +471 @@
             See www.imagemagick.org, for example.
         """
         if plot.DOCTEST_MODE:
-            self.gif(delay = delay, iterations = iterations)
+            if format == 'ogv':
+                self.ogv(delay = delay, iterations = iterations)
+            else:
+                self.gif(delay = delay, iterations = iterations)
+            
             return
         
         if plot.EMBEDDED_MODE:
-            self.gif(delay = delay, iterations = iterations)
+            if format == 'ogv':
+                filename = sage.misc.misc.graphics_filename(ext='ogv')
+                self.ogv(delay = delay, savefile=filename, iterations = iterations)
+                video_tag = """<video autoplay controls>
+                <source src="cell://%s" type="video/ogg" />
+                <a target="_new" href="cell://%s" class="file_link">ogv</a>
+                </video>""" % (filename, filename)
+                if linkmode == True:
+                    return video_tag
+                else:
+                    from sage.misc.html import html
+                    html(video_tag)
+            else:
+                filename = sage.misc.misc.graphics_filename(ext='gif')
+                self.gif(delay = delay, savefile=filename, iterations = iterations)
+                gif_tag = """<img src="cell://%s"/>""" % filename
+                if linkmode == True:
+                    return gif_tag
+                else:
+                    from sage.misc.html import html
+                    html(gif_tag)
         else:
-            filename = sage.misc.misc.tmp_filename() + '.gif'
-            self.gif(delay=delay, savefile=filename, iterations=iterations)
+            if format == 'ogv':
+                filename = sage.misc.misc.tmp_filename() + '.ogv'
+                self.ogv(delay=delay, savefile=filename, iterations=iterations)
+            else:
+                filename = sage.misc.misc.tmp_filename() + '.gif'
+                self.gif(delay=delay, savefile=filename, iterations=iterations)
             os.system('%s %s 2>/dev/null 1>/dev/null &'%(
                 sage.misc.viewer.browser(), filename))
 
     def save(self, filename=None, show_path=False):
         """
-        Save this animation into a gif or sobj file.
+        Save this animation into a gif, ogv (Ogg Theora video) or sobj file.
         
         INPUT:
         
@@ -428 +526 @@
         If filename is None, then in notebook mode, display the animation;
         otherwise, save the animation to a gif file. If filename ends in
         '.gif', save to a gif file. If filename ends in '.sobj', save to an
-        sobj file.
+        sobj file, and if it ends with '.ogv', save it to an Ogg Theora
+        video file.
         
         In all other cases, print an error.
         
@@ -440 +539 @@
             sage: a.save('wave.gif')   # optional
             sage: a.save('wave.gif', show_path=True)   # optional
             Animation saved to file .../wave.gif.
+            sage: a.save('wave.ogv', show_path=True)   # optional -- requires libtheora
+            Animation saved to file .../wave.ogv.
             sage: a.save('wave0.sobj')  # optional
             sage: a.save('wave1.sobj', show_path=True)  # optional
             Animation saved to file wave1.sobj.
@@ -447 +548 @@
         if filename is None or filename.endswith('.gif'):
             self.gif(savefile=filename, show_path=show_path)
             return
+        elif filename.endswith('.ogv'):
+            self.ogv(savefile=filename, show_path=show_path)
+            return
         elif filename.endswith('.sobj'):
             SageObject.save(self, filename)
             if show_path: