o h@sNddlZddlZddlZddlmZmZddlZddlZddlm Z ddl Z ddl Z ddl Z ddl mZddlZddlZddlZddlmZddlZddlmZmZmZmZddlmZmZddlmZ e!e"Z#e j$dkrqe j%ndZ&d d Z'Gd d d Z(e(Z)Gd ddej*Z+Gddde+Z,Gddde,Z-e).dGddde+Z/GdddZ0e).dGddde0e,Z1e).dGddde0e-Z2GdddZ3e).d Gd!d"d"e3e,Z4e).d#Gd$d%d%e3e-Z5d&d'Z6d(d)Z7e).d*Gd+d,d,e-Z8Gd-d.d.Z9Gd/d0d0e9Z:Gd1d2d2e:Z;Gd3d4d4e:Z.correct_roundoff)r)whrrrwnewhnewrrradjusted_figsize src@s@eZdZdZddZddZddZdd Zd d Zd d Z dS)MovieWriterRegistryz.wrapperr)r"r&r'rr%rregisterJs zMovieWriterRegistry.registercCs*z |j|}W|StyYdSw)z Check if given writer is available by name. Parameters ---------- name : str Returns ------- bool F)r KeyError isAvailable)r"r&clsrrr is_availableYs   z MovieWriterRegistry.is_availableccs"|jD] }||r|VqdS)z-Iterate over names of available writer class.N)r r,r"r&rrr__iter__ks   zMovieWriterRegistry.__iter__cCsg|S)z%Get a list of available MovieWriters.rr!rrrlistqzMovieWriterRegistry.listcCs$||r |j|Std|d)z,Get an available writer class from its name.zRequested MovieWriter (z) not available)r,r RuntimeErrorr-rrr __getitem__us  zMovieWriterRegistry.__getitem__N) __name__ __module__ __qualname____doc__r#r(r,r.r/r2rrrrrDs rc@sheZdZdZdddZejdddZedd Z d d Z ejd d Z ejddZ e jddZdS)AbstractMovieWritera Abstract base class for writing movies, providing a way to grab frames by calling `~AbstractMovieWriter.grab_frame`. `setup` is called to start the process and `finish` is called afterwards. `saving` is provided as a context manager to facilitate this process as :: with moviewriter.saving(fig, outfile='myfile.mp4', dpi=100): # Iterate over frames moviewriter.grab_frame(**savefig_kwargs) The use of the context manager ensures that `setup` and `finish` are performed as necessary. An instance of a concrete subclass of this class can be given as the ``writer`` argument of `Animation.save()`. NcCs8||_|dur |ni|_t|d|_t|d|_dS)Nzanimation.codecanimation.bitrate)fpsmetadatampl _val_or_rccodecbitrate)r"r:r;r>r?rrrr#szAbstractMovieWriter.__init__cCs8t|jjdd||_||_|dur|jj}||_dS)a Setup for writing the movie file. Parameters ---------- fig : `~matplotlib.figure.Figure` The figure object that contains the information for frames. outfile : str The filename of the resulting movie file. dpi : float, default: ``fig.dpi`` The DPI (or resolution) for the file. This controls the size in pixels of the resulting movie file. TstrictN)rparentresolveoutfilefigrr"rErDrrrrsetups  zAbstractMovieWriter.setupcCs*|j\}}t||jt||jfS)z7A tuple ``(width, height)`` in pixels of a movie frame.)rEget_size_inchesrr)r"rrrrr frame_sizeszAbstractMovieWriter.frame_sizecCdS)z Whether this writer supports transparency. Writers may consult output file type and codec to determine this at runtime. Frr!rrr_supports_transparencysz*AbstractMovieWriter._supports_transparencycKrJ)a= Grab the image information from the figure and save as a movie frame. All keyword arguments in *savefig_kwargs* are passed on to the `~.Figure.savefig` call that saves the figure. However, several keyword arguments that are supported by `~.Figure.savefig` may not be passed as they are controlled by the MovieWriter: - *dpi*, *bbox_inches*: These may not be passed because each frame of the animation much be exactly the same size in pixels. - *format*: This is controlled by the MovieWriter. Nrr"savefig_kwargsrrr grab_framezAbstractMovieWriter.grab_framecCrJ),Finish any processing for writing the movie.Nrr!rrrfinishrOzAbstractMovieWriter.finishc ostjddkr td|j|||g|Ri|tddiz |VW|n|wWddS1s=wYdS)z Context manager to facilitate writing the movie file. ``*args, **kw`` are any parameters that should be passed to `setup`. savefig.bboxtightzkDisabling savefig.bbox = 'tight', as it may cause frame size to vary, which is inappropriate for animation.N)r<rcParams_loginforG rc_contextrQ)r"rErDrargskwargsrrrsavings "zAbstractMovieWriter.saving)r8NNNr)r3r4r5r6r#abcabstractmethodrGpropertyrIrKrNrQ contextlibcontextmanagerrZrrrrr7s     r7cszeZdZdZdgZ  dfdd ZddZdfd d Zd d Zd dZ ddZ ddZ e ddZ e ddZZS) MovieWritera Base class for writing movies. This is a base class for MovieWriter subclasses that write a movie frame data to a pipe. You cannot instantiate this class directly. See examples for how to use its subclasses. Attributes ---------- frame_format : str The format used in writing frame data, defaults to 'rgba'. fig : `~matplotlib.figure.Figure` The figure to capture data from. This must be provided by the subclasses. rgbar8Ncs>t|tur tdtj||||d|jd|_||_dS)a@ Parameters ---------- fps : int, default: 5 Movie frame rate (per second). codec : str or None, default: :rc:`animation.codec` The codec to use. bitrate : int, default: :rc:`animation.bitrate` The bitrate of the movie, in kilobits per second. Higher values means higher quality movies, but increase the file size. A value of -1 lets the underlying movie encoder select the bitrate. extra_args : list of str or None, optional Extra command-line arguments passed to the underlying movie encoder. These arguments are passed last to the encoder, just before the filename. The default, None, means to use :rc:`animation.[name-of-encoder]_args` for the builtin writers. metadata : dict[str, str], default: {} A dictionary of keys and values for metadata to include in the output file. Some keys that may be of use include: title, artist, genre, subject, copyright, srcform, comment. zNMovieWriter cannot be instantiated directly. Please use one of its subclasses.)r:r;r>r?rN)typer` TypeErrorsuperr#supported_formats frame_format extra_args)r"r:r>r?rgr; __class__rrr#s    zMovieWriter.__init__cCs|jdkr1|j\}}t|||jd\}}||f||fkr0|jj||ddtd||||n|j\}}tjdg|j R||fS)Nh264T)forwardz?figure size in inches has been adjusted from %s x %s to %s x %szframe size in pixels is %s x %s) r>rErHrrset_size_inchesrUrVdebugrI)r"wohorrrrr_adjust_frame_size%s zMovieWriter._adjust_frame_sizecs.tj|||d|\|_|_|dSN)r)rdrGrq_w_h_runrFrhrrrG2s zMovieWriter.setupcCs:|}tdt|tj}tj||||td|_ dS)Nz%MovieWriter._run: running command: %s)stdinstdoutstderr creationflags) _argsrUrVr _pformat_subprocess subprocessPIPEPopensubprocess_creation_flags_proc)r"commandr}rrrru:s zMovieWriter._runcCs|j\}}tt|}tt|}|r(t|jjr"tj ntj d||r9t|jjr3tj ntj d||jjrIt |jj|jj ||dS)rPzMovieWriter stdout: %szMovieWriter stderr: %sN)r communicaterrreadrUlog returncodeloggingWARNINGDEBUGr|CalledProcessErrorrX)r"outerrrrrrQFs$zMovieWriter.finishcKsJt|td|j|j|j|jj|jj f|j |j d|dS)Nz'MovieWriter.grab_frame: Grabbing frame.formatr) _validate_grabframe_kwargsrUrnrErmrsrtsavefigrrvrfrrLrrrrNXs  zMovieWriter.grab_framecCstdS)z9Assemble list of encoder-specific command-line arguments.z)args needs to be implemented by subclass.NotImplementedErrorr!rrrrzcr0zMovieWriter._argscCsttj|jS)z Return the binary path to the commandline tool used by a specific subclass. This is a class method so that the tool can be looked for before making a particular MovieWriter subclass available. )strr<rT _exec_keyr+rrrbin_pathgszMovieWriter.bin_pathcCst|duS)zbmpdpxgifpngapngavrpcfhdffv1tiffv408ljpegqtrletargaproresffvhuffhuffyuvutvideojpeg2000rawvideo prores_aw prores_ks)rrDsuffixr>r"rrrrrK s  z!FFMpegBase._supports_transparencycCsg}t|jj}|dvr|dd|_n|d|jg|jdur$|jntj|j}|jdkr;d|vr;|ddgn!|jdkrLd|vrL|dd gn|jd kr\d|vr\|gd |j d krk|d d|j g|j D]\}}|d|d|gqp|||d|jgS)Nrr-vcodecrj-pix_fmtyuv420pr-filter_complexz1split [a][b];[a] palettegen [p];[b][p] paletteuseavif)rz.split [rgb][rgba]; [rgba] alphaextract [alpha]-mapz[rgb]rz[alpha]rz-bz%dkz -metadata=z-y) rrDrr>extendrgr<rT _args_keyr?r;items)r"rXrrgkvrrr output_argss,    zFFMpegBase.output_argsN) r3r4r5r6rrrKr]rrrrrrsrffmpegc@seZdZdZddZdS) FFMpegWriterat Pipe-based ffmpeg writer. Frames are streamed directly to ffmpeg via a pipe and written in a single pass. This effectively works as a slideshow input to ffmpeg with the fps passed as ``-framerate``, so see also `their notes on frame rates`_ for further details. .. _their notes on frame rates: https://trac.ffmpeg.org/wiki/Slideshow#Framerates c Cs\|dddddd|jd|jdt|jg }ttjkr#|dd g7}|d d g|j 7}|S) N-frrz-s%dx%dr -framerate -loglevelerror-izpipe:) rrIrfrr:rUgetEffectiveLevelrrrr"rXrrrrzKs  zFFMpegWriter._argsN)r3r4r5r6rzrrrrr?s r ffmpeg_filec@s eZdZdZgdZddZdS)FFMpegFileWriteray File-based ffmpeg writer. Frames are written to temporary files on disk and then stitched together at the end. This effectively works as a slideshow input to ffmpeg with the fps passed as ``-framerate``, so see also `their notes on frame rates`_ for further details. .. _their notes on frame rates: https://trac.ffmpeg.org/wiki/Slideshow#Framerates rjpegrrrac Csg}|jdvr|dddddd|jdd g7}|d t|jd |g7}|js/|d t|jg7}tt j kr<|d dg7}| g||j S)N>rrarimage2rrz -video_sizerz -pixel_formatrarrz -frames:vrr) rfrIrr:rrrrUrrrrrrrrrrzis   zFFMpegFileWriter._argsN)r3r4r5r6rerzrrrrr[s rcsLeZdZdZdZdZddZddZefdd Z efd d Z Z S) ImageMagickBasea Mixin class for ImageMagick output. This is a base class for the concrete `ImageMagickWriter` and `ImageMagickFileWriter` classes, which define an ``input_names`` attribute (or property) specifying the input names passed to ImageMagick. zanimation.convert_pathzanimation.convert_argscCst|jj}|dvS)Nr)rrDrrrrrrKs z&ImageMagickBase._supports_transparencyc Csr|jdkrdn|j}|jdur|jntj|j}|dd|jdddtd|jd d |d |j g ||j S) Nrraz-sizez%ix%iz-depth8z-delaydz-loop0:) rfrgr<rTrrrIrr: input_namesrD)r"fmtrgrrrrzs  zImageMagickBase._argscs"t}|dkrtdj}|S)Nrmagick)rdrr<_get_executable_info executable)r+binpathrhrrrs  zImageMagickBase.bin_pathc sBztWStjy }z td|WYd}~dSd}~ww)Nz"ImageMagick unavailable due to: %sF)rdr*r<ExecutableNotFoundErrorrUrn)r+_enfrhrrr*s  zImageMagickBase.isAvailable) r3r4r5r6rrrKrzrrr*rrrrhrrsr imagemagickc@seZdZdZdZdS)ImageMagickWriterz Pipe-based animated gif writer. Frames are streamed directly to ImageMagick via a pipe and written in a single pass. -N)r3r4r5r6rrrrrrsrimagemagick_filec@s$eZdZdZgdZeddZdS)ImageMagickFileWriterz File-based animated gif writer. Frames are written to temporary files on disk and then stitched together at the end. rcCs|jd|jS)Nz*.)rrfr!rrrzImageMagickFileWriter.N)r3r4r5r6rer]rrrrrrs rcCstj|||dS)N)Nframes frame_dirrf)rr) frame_countrfrrrr_included_framessrcs2dkrddddfddt|DS)z7frame_list should be a list of base64-encoded png filessvgzsvg+xmlz, frames[{0}] = "data:image/{1};base64,{2}"  c 3s*|]\}}||ddVqdS)rz\ N)rreplace).0i frame_datarftemplaterr s  z#_embedded_frames..)join enumerate) frame_listrfrr!r_embedded_framess  r'htmlcs^eZdZdZgdZeddZ   dfd d Zdfd d Zfd dZ ddZ Z S) HTMLWriterz(Writer for JavaScript-based HTML movies.)rrrrcCrJrrrrrrr*rzHTMLWriter.isAvailableNFrc sj|rtdd}||_||_tjgd|jdt|d|_ |j d9_ t |||||dS)NzHTMLWriter ignores 'extra_args'r)roncereflect) default_modeanimation.embed_limit) rUwarning embed_frameslowerr-r check_in_listr<r= _bytes_limitrdr#) r"r:r>r?rgr;r1r- embed_limitrhrrr#s   zHTMLWriter.__init__cst|}tjddg|jdg|_d|_d|_|js2|dur&||j d}|j ddd|d }nd}t ||||d|_ dS) Nz.htmlz.htm)outfile_extensionrFrT)parentsexist_okframe)rr r3r _saved_frames _total_bytes _hit_limitr1 with_namestemmkdirrdrG _clear_temp)r"rErDrrrrhrrrGs  zHTMLWriter.setupc st||jrM|jr dSt}|jj|f|j|jd|t |  d}|j t |7_ |j |jkrEtd|j |jd|_dS|j|dStjdi|S)NrasciizAnimation size has reached %s bytes, exceeding the limit of %s. If you're sure you want a larger animation embedded, set the animation.embed_limit rc parameter to a larger value (in MB). This and further frames will be dropped.Tr)rr1r<rrErrfrbase64 encodebytesgetvaluedecoder;lenr4rUr0r:rrdrN)r"rMf imgdata64rhrrrNs(  zHTMLWriter.grab_framec Cs|jrt|j|j}t|j}nt|j}t||j|jdj|j j}t dddd}d||j d<d|j }t |j d"}|tt|tjd tj|||d|Wdn1scwY|jrytd |j|jdSdS) Nrr) once_checked loop_checkedreflect_checkedchecked_checkedrr)idr fill_framesintervalrr)r1r'r:rfrFrrrB relative_torDrr-r:rwriter r rruuiduuid4hexrrUrnr)r"rOr mode_dictrPofrrrrQ(s<     zHTMLWriter.finish)r*NNNNFrNr) r3r4r5r6rerr*r#rGrNrQrrrrhrr)s  r)c@seZdZdZd4ddZddZdd Zd d Z   d5dd d dZddZ ddZ ddZ ddZ ddZ ddZddZddZdd Zd!d"Zd#d$Zd%d&Zd'd(Zd6d)d*Zd7d,d-Zd.d/Zd0d1Zd2d3ZdS)8 Animationa A base class for Animations. This class is not usable as is, and should be subclassed to provide needed behavior. .. note:: You must store the created Animation in a variable that lives as long as the animation should run. Otherwise, the Animation object will be garbage-collected and the animation stops. Parameters ---------- fig : `~matplotlib.figure.Figure` The figure object used to get needed events, such as draw or resize. event_source : object, optional A class that can run a callback when desired events are generated, as well as be stopped and started. Examples include timers (see `TimedAnimation`) and file system notifications. blit : bool, default: False Whether blitting is used to optimize drawing. If the backend does not support blitting, then this parameter has no effect. See Also -------- FuncAnimation, ArtistAnimation NFcCsfd|_||_|o |jj|_||_||_|jd|j |_ |jjd|j |_ |jr1| dSdS)NF draw_event close_event)_draw_was_started_figcanvas supports_blit_blit new_frame_seq frame_seq event_source mpl_connect_start_first_draw_id_stop _close_id _setup_blit)r"rErbblitrrrr#os   zAnimation.__init__cCst|dds tddSdS)Nr[TzAnimation was deleted without rendering anything. This is most likely not intended. To prevent deletion, assign the Animation to a variable, e.g. `anim`, that exists until you output the Animation using `plt.show()` or `anim.save()`.)getattrwarningswarnr!rrrrs zAnimation.__del__cGsD|jjrdS|jj|j||j|j|j dS)z Starts interactive animation. Adds the draw frame command to the GUI handler, calls show to start the event loop. N) r\r] is_savingmpl_disconnectre _init_drawrb add_callback_stepstartrrrrrds zAnimation._startcGs>|jr |jj|j|jj|j|j|jd|_dSr) r_r\r]rn _resize_idrgrbremove_callbackrqrrrrrfs  zAnimation._stop)progress_callbackc  sg} | dur| fdd| D| D]} d| _q|dur%tjd}nt|ts Any where *current_frame* is the current frame number and *total_frames* is the total number of frames to be saved. *total_frames* is set to None, if the total number of frames cannot be determined. Return values may exist but are ignored. Example code to write the progress to stdout:: progress_callback = lambda i, n: print(f'Saving frame {i}/{n}') Notes ----- *fps*, *codec*, *bitrate*, *extra_args* and *metadata* are used to construct a `.MovieWriter` instance and can only be passed if *writer* is a string. If they are passed as non-*None* and *writer* is a `.MovieWriter`, a `RuntimeError` will be raised. Nc3s |] }|jjur|VqdSr)r\)ranimr!rrr#s  z!Animation.save..Tanimation.writercss|]}|duVqdSrr)rargrrrr#szPassing in values for arguments fps, codec, bitrate, extra_args, or metadata is not supported when writer is an existing MovieWriter instance. These should instead be passed as arguments when creating the MovieWriter instance. _interval@@z savefig.dpifigurer>r?rgr;z1MovieWriter %s unavailable; using Pillow instead.zAnimation.save using %s bbox_incheszWarning: discarding the 'bbox_inches' argument in 'savefig_kwargs' as it may cause frame size to vary, which is inappropriate for animation.cSs.t|\}}}}|t|||gd|S)Nr)mcolorsto_rgbararray)colorrgbarrr_pre_composite_to_whiteCsz/Animation.save.._pre_composite_to_white) _is_savingmanager facecolorzsavefig.facecolorautoF transparentrcSsg|]}t|ddqS) _save_countN)rjrrrrr Ysz"Animation.save..cSsg|]}|qSr)new_saved_frame_seqrrrrr_s)rirr)!rr[r<rT isinstanceranyr1rrryr=r\rwritersrrUr0rVrbpoprZr _setattr_cmr]rKget get_facecolorrosumzip_draw_next_framerN)r"filenamewriterr:rr>r?rgr; extra_animrMruall_animrv writer_kwargsr$rr frame_numbersave_count_list total_framesdatadrr!rrsM                 TzAnimation.savecGs4zt|j}|||jWdStyYdSw)z Handler for getting events. By default, gets the next frame in the sequence and hands the data off to be drawn. TF)nextrarr_ StopIteration)r"rX framedatarrrrqhs  zAnimation._stepcCs t|jS)z+Return a new sequence of frame information.)iter _framedatar!rrrr`w zAnimation.new_frame_seqcC|S)z8Return a new sequence of saved/cached frame information.)r`r!rrrr|szAnimation.new_saved_frame_seqcCs&||||||||dSr) _pre_draw _draw_frame _post_drawr"rrirrrrs  zAnimation._draw_next_framecCs d|_dSr)r[r!rrrrorzAnimation._init_drawcCs|r ||jdSdSr) _blit_clear_drawn_artistsrrrrrszAnimation._pre_drawcCstd)NzDNeeds to be implemented by subclasses to actually make an animation.r)r"rrrrrr0zAnimation._draw_framecCs*|r |jr ||jdS|jjdSr)r _blit_drawr\r] draw_idlerrrrrs zAnimation._post_drawcCsdd|D}|D]#}|}|j|tdf\}}||kr,||jj|jf|j|<q |D]}|j |q/|D] }|jj |jq:dS)NcSh|]}|jqSraxesrrrr rz'Animation._blit_draw..) _get_view _blit_cacherobjectr{r]copy_from_bboxbboxr draw_artistri)r"artists updated_axaxcur_viewviewbgrrrrrs zAnimation._blit_drawc Csjdd|D}|D])}z |j|\}}Wn tyYq w||kr,|jj|q |j|q dS)NcSrrrrrrrrrz(Animation._blit_clear..)rr)rr{r]restore_regionr)r"rrrrrrrrrs  zAnimation._blit_clearcCs<t|_g|_|d|j||jjd|j |_ dS)N resize_event) rrrrr_ror\r]rc _on_resizersr!rrrrhs  zAnimation._setup_blitcCsD|jj|j|j|j||jj d|j |_dS)NrY) r\r]rnrsrbstoprclearrorc _end_redrawr"eventrrrrs    zAnimation._on_resizecCs>|dd|j|jj|j|jjd|j|_dS)NFr) rrbrrr\r]rnrsrcrrrrrrs    zAnimation._end_redrawc Csd}t|dsjt|d}|d9}t1}t|d}ttjd}|dtjdd |jd }|jt ||d t | }Wd n1sHwYt |}||kr]td ||n |d|_dj|j|_t|drddg} t|ddr~| d|j|j|jd| dSdS)a Convert the animation to an HTML5 ``