forked from matplotlib/matplotlib.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathanimation.html
More file actions
1912 lines (1578 loc) · 225 KB
/
animation.html
File metadata and controls
1912 lines (1578 loc) · 225 KB
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>matplotlib.animation — Matplotlib 3.1.0 documentation</title>
<link rel="stylesheet" href="../../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../../_static/gallery.css" type="text/css" />
<link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/language_data.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script>
<script type="text/javascript" src="../../_static/copybutton.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.1.0 documentation"
href="../../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../genindex.html"
/>
<link rel="search" title="Search" href="../../search.html"
/>
<link rel="top" title="Matplotlib 3.1.0 documentation" href="../../index.html" />
<link rel="up" title="matplotlib" href="../matplotlib.html" />
<link rel="canonical" href="https://matplotlib.org/3.1.0/_modules/matplotlib/animation.html" />
</head>
<body>
<div id="plotting-contest" style="padding: 6px; background-color: teal; color: white;">
<p style="margin: 0;">The 2019 SciPy John Hunter Excellence in Plotting Contest is accepting submissions!
<br />
<a href="https://docs.google.com/forms/d/e/1FAIpQLSe-_AnKvYSzeQWfNDRoXgW0vl7_8q6jj3QbLIac8eUcb9lSAA/viewform?usp=sf_link" style="font-weight: bold;">Apply by June 8th</a></p>
</div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.1.0</span></div>
<img src="../../_static/logo2.png" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">home</a>| </li>
<li><a href="../../gallery/index.html">examples</a>| </li>
<li><a href="../../tutorials/index.html">tutorials</a>| </li>
<li><a href="../../api/index.html">API</a>| </li>
<li><a href="../../contents.html">contents</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
<li><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
<li><a href="../matplotlib.html">matplotlib</a><ul>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for matplotlib.animation</h1><div class="highlight"><pre>
<span></span><span class="c1"># TODO:</span>
<span class="c1"># * Documentation -- this will need a new section of the User's Guide.</span>
<span class="c1"># Both for Animations and just timers.</span>
<span class="c1"># - Also need to update http://www.scipy.org/Cookbook/Matplotlib/Animations</span>
<span class="c1"># * Blit</span>
<span class="c1"># * Currently broken with Qt4 for widgets that don't start on screen</span>
<span class="c1"># * Still a few edge cases that aren't working correctly</span>
<span class="c1"># * Can this integrate better with existing matplotlib animation artist flag?</span>
<span class="c1"># - If animated removes from default draw(), perhaps we could use this to</span>
<span class="c1"># simplify initial draw.</span>
<span class="c1"># * Example</span>
<span class="c1"># * Frameless animation - pure procedural with no loop</span>
<span class="c1"># * Need example that uses something like inotify or subprocess</span>
<span class="c1"># * Complex syncing examples</span>
<span class="c1"># * Movies</span>
<span class="c1"># * Can blit be enabled for movies?</span>
<span class="c1"># * Need to consider event sources to allow clicking through multiple figures</span>
<span class="kn">import</span> <span class="nn">abc</span>
<span class="kn">import</span> <span class="nn">base64</span>
<span class="kn">import</span> <span class="nn">contextlib</span>
<span class="kn">from</span> <span class="nn">io</span> <span class="k">import</span> <span class="n">BytesIO</span><span class="p">,</span> <span class="n">TextIOWrapper</span>
<span class="kn">import</span> <span class="nn">itertools</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">from</span> <span class="nn">pathlib</span> <span class="k">import</span> <span class="n">Path</span>
<span class="kn">import</span> <span class="nn">platform</span>
<span class="kn">import</span> <span class="nn">shutil</span>
<span class="kn">import</span> <span class="nn">subprocess</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">from</span> <span class="nn">tempfile</span> <span class="k">import</span> <span class="n">TemporaryDirectory</span>
<span class="kn">import</span> <span class="nn">uuid</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">matplotlib</span> <span class="k">as</span> <span class="nn">mpl</span>
<span class="kn">from</span> <span class="nn">matplotlib._animation_data</span> <span class="k">import</span> <span class="p">(</span>
<span class="n">DISPLAY_TEMPLATE</span><span class="p">,</span> <span class="n">INCLUDED_FRAMES</span><span class="p">,</span> <span class="n">JS_INCLUDE</span><span class="p">,</span> <span class="n">STYLE_INCLUDE</span><span class="p">)</span>
<span class="kn">from</span> <span class="nn">matplotlib</span> <span class="k">import</span> <span class="n">cbook</span><span class="p">,</span> <span class="n">rcParams</span><span class="p">,</span> <span class="n">rcParamsDefault</span><span class="p">,</span> <span class="n">rc_context</span>
<span class="n">_log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
<span class="c1"># Process creation flag for subprocess to prevent it raising a terminal</span>
<span class="c1"># window. See for example:</span>
<span class="c1"># https://stackoverflow.com/questions/24130623/using-python-subprocess-popen-cant-prevent-exe-stopped-working-prompt</span>
<span class="k">if</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'Windows'</span><span class="p">:</span>
<span class="n">subprocess_creation_flags</span> <span class="o">=</span> <span class="n">CREATE_NO_WINDOW</span> <span class="o">=</span> <span class="mh">0x08000000</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Apparently None won't work here</span>
<span class="n">subprocess_creation_flags</span> <span class="o">=</span> <span class="mi">0</span>
<span class="c1"># Other potential writing methods:</span>
<span class="c1"># * http://pymedia.org/</span>
<span class="c1"># * libming (produces swf) python wrappers: https://github.com/libming/libming</span>
<span class="c1"># * Wrap x264 API:</span>
<span class="c1"># (http://stackoverflow.com/questions/2940671/</span>
<span class="c1"># how-to-encode-series-of-images-into-h264-using-x264-api-c-c )</span>
<span class="k">def</span> <span class="nf">adjusted_figsize</span><span class="p">(</span><span class="n">w</span><span class="p">,</span> <span class="n">h</span><span class="p">,</span> <span class="n">dpi</span><span class="p">,</span> <span class="n">n</span><span class="p">):</span>
<span class="sd">'''Compute figure size so that pixels are a multiple of n</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> w, h : float</span>
<span class="sd"> Size in inches</span>
<span class="sd"> dpi : float</span>
<span class="sd"> The dpi</span>
<span class="sd"> n : int</span>
<span class="sd"> The target multiple</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> wnew, hnew : float</span>
<span class="sd"> The new figure size in inches.</span>
<span class="sd"> '''</span>
<span class="c1"># this maybe simplified if / when we adopt consistent rounding for</span>
<span class="c1"># pixel size across the whole library</span>
<span class="k">def</span> <span class="nf">correct_roundoff</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">dpi</span><span class="p">,</span> <span class="n">n</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">int</span><span class="p">(</span><span class="n">x</span><span class="o">*</span><span class="n">dpi</span><span class="p">)</span> <span class="o">%</span> <span class="n">n</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">nextafter</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">inf</span><span class="p">)</span><span class="o">*</span><span class="n">dpi</span><span class="p">)</span> <span class="o">%</span> <span class="n">n</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nextafter</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">inf</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">nextafter</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">inf</span><span class="p">)</span><span class="o">*</span><span class="n">dpi</span><span class="p">)</span> <span class="o">%</span> <span class="n">n</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">nextafter</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">inf</span><span class="p">)</span>
<span class="k">return</span> <span class="n">x</span>
<span class="n">wnew</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">w</span> <span class="o">*</span> <span class="n">dpi</span> <span class="o">/</span> <span class="n">n</span><span class="p">)</span> <span class="o">*</span> <span class="n">n</span> <span class="o">/</span> <span class="n">dpi</span>
<span class="n">hnew</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">h</span> <span class="o">*</span> <span class="n">dpi</span> <span class="o">/</span> <span class="n">n</span><span class="p">)</span> <span class="o">*</span> <span class="n">n</span> <span class="o">/</span> <span class="n">dpi</span>
<span class="k">return</span> <span class="p">(</span><span class="n">correct_roundoff</span><span class="p">(</span><span class="n">wnew</span><span class="p">,</span> <span class="n">dpi</span><span class="p">,</span> <span class="n">n</span><span class="p">),</span> <span class="n">correct_roundoff</span><span class="p">(</span><span class="n">hnew</span><span class="p">,</span> <span class="n">dpi</span><span class="p">,</span> <span class="n">n</span><span class="p">))</span>
<span class="c1"># A registry for available MovieWriter classes</span>
<div class="viewcode-block" id="MovieWriterRegistry"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriterRegistry.html#matplotlib.animation.MovieWriterRegistry">[docs]</a><span class="k">class</span> <span class="nc">MovieWriterRegistry</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">'''Registry of available writer classes by human readable name.'''</span>
<div class="viewcode-block" id="MovieWriterRegistry.__init__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriterRegistry.html#matplotlib.animation.MovieWriterRegistry.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">avail</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_registered</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_dirty</span> <span class="o">=</span> <span class="kc">False</span></div>
<div class="viewcode-block" id="MovieWriterRegistry.set_dirty"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriterRegistry.html#matplotlib.animation.MovieWriterRegistry.set_dirty">[docs]</a> <span class="k">def</span> <span class="nf">set_dirty</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Sets a flag to re-setup the writers."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_dirty</span> <span class="o">=</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="MovieWriterRegistry.register"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriterRegistry.html#matplotlib.animation.MovieWriterRegistry.register">[docs]</a> <span class="k">def</span> <span class="nf">register</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="sd">"""Decorator for registering a class under a name.</span>
<span class="sd"> Example use::</span>
<span class="sd"> @registry.register(name)</span>
<span class="sd"> class Foo:</span>
<span class="sd"> pass</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">wrapper</span><span class="p">(</span><span class="n">writerClass</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_registered</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">writerClass</span>
<span class="k">if</span> <span class="n">writerClass</span><span class="o">.</span><span class="n">isAvailable</span><span class="p">():</span>
<span class="bp">self</span><span class="o">.</span><span class="n">avail</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">writerClass</span>
<span class="k">return</span> <span class="n">writerClass</span>
<span class="k">return</span> <span class="n">wrapper</span></div>
<div class="viewcode-block" id="MovieWriterRegistry.ensure_not_dirty"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriterRegistry.html#matplotlib.animation.MovieWriterRegistry.ensure_not_dirty">[docs]</a> <span class="k">def</span> <span class="nf">ensure_not_dirty</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""If dirty, reasks the writers if they are available"""</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dirty</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reset_available_writers</span><span class="p">()</span></div>
<div class="viewcode-block" id="MovieWriterRegistry.reset_available_writers"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriterRegistry.html#matplotlib.animation.MovieWriterRegistry.reset_available_writers">[docs]</a> <span class="k">def</span> <span class="nf">reset_available_writers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Reset the available state of all registered writers"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">avail</span> <span class="o">=</span> <span class="p">{</span><span class="n">name</span><span class="p">:</span> <span class="n">writerClass</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">writerClass</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_registered</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
<span class="k">if</span> <span class="n">writerClass</span><span class="o">.</span><span class="n">isAvailable</span><span class="p">()}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_dirty</span> <span class="o">=</span> <span class="kc">False</span></div>
<div class="viewcode-block" id="MovieWriterRegistry.list"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriterRegistry.html#matplotlib.animation.MovieWriterRegistry.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''Get a list of available MovieWriters.'''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ensure_not_dirty</span><span class="p">()</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">avail</span><span class="p">)</span></div>
<div class="viewcode-block" id="MovieWriterRegistry.is_available"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriterRegistry.html#matplotlib.animation.MovieWriterRegistry.is_available">[docs]</a> <span class="k">def</span> <span class="nf">is_available</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="sd">'''Check if given writer is available by name.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> name : str</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> available : bool</span>
<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ensure_not_dirty</span><span class="p">()</span>
<span class="k">return</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">avail</span></div>
<span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ensure_not_dirty</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">avail</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">"No MovieWriters available!"</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">avail</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span>
<span class="s1">'Requested MovieWriter (</span><span class="si">{}</span><span class="s1">) not available'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">name</span><span class="p">))</span></div>
<span class="n">writers</span> <span class="o">=</span> <span class="n">MovieWriterRegistry</span><span class="p">()</span>
<div class="viewcode-block" id="AbstractMovieWriter"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.AbstractMovieWriter.html#matplotlib.animation.AbstractMovieWriter">[docs]</a><span class="k">class</span> <span class="nc">AbstractMovieWriter</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Abstract base class for writing movies. Fundamentally, what a MovieWriter</span>
<span class="sd"> does is provide is a way to grab frames by calling grab_frame().</span>
<span class="sd"> setup() is called to start the process and finish() is called afterwards.</span>
<span class="sd"> This class is set up to provide for writing movie frame data to a pipe.</span>
<span class="sd"> saving() is provided as a context manager to facilitate this process as::</span>
<span class="sd"> with moviewriter.saving(fig, outfile='myfile.mp4', dpi=100):</span>
<span class="sd"> # Iterate over frames</span>
<span class="sd"> moviewriter.grab_frame(**savefig_kwargs)</span>
<span class="sd"> The use of the context manager ensures that setup() and finish() are</span>
<span class="sd"> performed as necessary.</span>
<span class="sd"> An instance of a concrete subclass of this class can be given as the</span>
<span class="sd"> ``writer`` argument of `Animation.save()`.</span>
<span class="sd"> '''</span>
<div class="viewcode-block" id="AbstractMovieWriter.setup"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.AbstractMovieWriter.html#matplotlib.animation.AbstractMovieWriter.setup">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span> <span class="nf">setup</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fig</span><span class="p">,</span> <span class="n">outfile</span><span class="p">,</span> <span class="n">dpi</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Perform setup for writing the movie file.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> fig : `matplotlib.figure.Figure` instance</span>
<span class="sd"> The figure object that contains the information for frames</span>
<span class="sd"> outfile : string</span>
<span class="sd"> The filename of the resulting movie file</span>
<span class="sd"> dpi : int, optional</span>
<span class="sd"> The DPI (or resolution) for the file. This controls the size</span>
<span class="sd"> in pixels of the resulting movie file. Default is ``fig.dpi``.</span>
<span class="sd"> '''</span></div>
<div class="viewcode-block" id="AbstractMovieWriter.grab_frame"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.AbstractMovieWriter.html#matplotlib.animation.AbstractMovieWriter.grab_frame">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span> <span class="nf">grab_frame</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">savefig_kwargs</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Grab the image information from the figure and save as a movie frame.</span>
<span class="sd"> All keyword arguments in savefig_kwargs are passed on to the `savefig`</span>
<span class="sd"> command that saves the figure.</span>
<span class="sd"> '''</span></div>
<div class="viewcode-block" id="AbstractMovieWriter.finish"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.AbstractMovieWriter.html#matplotlib.animation.AbstractMovieWriter.finish">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''Finish any processing for writing the movie.'''</span></div>
<div class="viewcode-block" id="AbstractMovieWriter.saving"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.AbstractMovieWriter.html#matplotlib.animation.AbstractMovieWriter.saving">[docs]</a> <span class="nd">@contextlib</span><span class="o">.</span><span class="n">contextmanager</span>
<span class="k">def</span> <span class="nf">saving</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fig</span><span class="p">,</span> <span class="n">outfile</span><span class="p">,</span> <span class="n">dpi</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Context manager to facilitate writing the movie file.</span>
<span class="sd"> ``*args, **kw`` are any parameters that should be passed to `setup`.</span>
<span class="sd"> '''</span>
<span class="c1"># This particular sequence is what contextlib.contextmanager wants</span>
<span class="bp">self</span><span class="o">.</span><span class="n">setup</span><span class="p">(</span><span class="n">fig</span><span class="p">,</span> <span class="n">outfile</span><span class="p">,</span> <span class="n">dpi</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">yield</span> <span class="bp">self</span>
<span class="k">finally</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">finish</span><span class="p">()</span></div></div>
<div class="viewcode-block" id="MovieWriter"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter">[docs]</a><span class="k">class</span> <span class="nc">MovieWriter</span><span class="p">(</span><span class="n">AbstractMovieWriter</span><span class="p">):</span>
<span class="sd">'''Base class for writing movies.</span>
<span class="sd"> This is a base class for MovieWriter subclasses that write a movie frame</span>
<span class="sd"> data to a pipe. You cannot instantiate this class directly.</span>
<span class="sd"> See examples for how to use its subclasses.</span>
<span class="sd"> Attributes</span>
<span class="sd"> ----------</span>
<span class="sd"> frame_format : str</span>
<span class="sd"> The format used in writing frame data, defaults to 'rgba'</span>
<span class="sd"> fig : `~matplotlib.figure.Figure`</span>
<span class="sd"> The figure to capture data from.</span>
<span class="sd"> This must be provided by the sub-classes.</span>
<span class="sd"> '''</span>
<div class="viewcode-block" id="MovieWriter.__init__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fps</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">codec</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">bitrate</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">extra_args</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">'''MovieWriter</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> fps : int</span>
<span class="sd"> Framerate for movie.</span>
<span class="sd"> codec : string or None, optional</span>
<span class="sd"> The codec to use. If ``None`` (the default) the ``animation.codec``</span>
<span class="sd"> rcParam is used.</span>
<span class="sd"> bitrate : int or None, optional</span>
<span class="sd"> The bitrate for the saved movie file, which is one way to control</span>
<span class="sd"> the output file size and quality. The default value is ``None``,</span>
<span class="sd"> which uses the ``animation.bitrate`` rcParam. A value of -1</span>
<span class="sd"> implies that the bitrate should be determined automatically by the</span>
<span class="sd"> underlying utility.</span>
<span class="sd"> extra_args : list of strings or None, optional</span>
<span class="sd"> A list of extra string arguments to be passed to the underlying</span>
<span class="sd"> movie utility. The default is ``None``, which passes the additional</span>
<span class="sd"> arguments in the ``animation.extra_args`` rcParam.</span>
<span class="sd"> metadata : Dict[str, str] or None</span>
<span class="sd"> A dictionary of keys and values for metadata to include in the</span>
<span class="sd"> output file. Some keys that may be of use include:</span>
<span class="sd"> title, artist, genre, subject, copyright, srcform, comment.</span>
<span class="sd"> '''</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span> <span class="ow">is</span> <span class="n">MovieWriter</span><span class="p">:</span>
<span class="c1"># TODO MovieWriter is still an abstract class and needs to be</span>
<span class="c1"># extended with a mixin. This should be clearer in naming</span>
<span class="c1"># and description. For now, just give a reasonable error</span>
<span class="c1"># message to users.</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span>
<span class="s1">'MovieWriter cannot be instantiated directly. Please use one '</span>
<span class="s1">'of its subclasses.'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fps</span> <span class="o">=</span> <span class="n">fps</span>
<span class="bp">self</span><span class="o">.</span><span class="n">frame_format</span> <span class="o">=</span> <span class="s1">'rgba'</span>
<span class="k">if</span> <span class="n">codec</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">codec</span> <span class="o">=</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'animation.codec'</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">codec</span> <span class="o">=</span> <span class="n">codec</span>
<span class="k">if</span> <span class="n">bitrate</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bitrate</span> <span class="o">=</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'animation.bitrate'</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bitrate</span> <span class="o">=</span> <span class="n">bitrate</span>
<span class="k">if</span> <span class="n">extra_args</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">extra_args</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">rcParams</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">args_key</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">extra_args</span> <span class="o">=</span> <span class="n">extra_args</span>
<span class="k">if</span> <span class="n">metadata</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">frame_size</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''A tuple ``(width, height)`` in pixels of a movie frame.'''</span>
<span class="n">w</span><span class="p">,</span> <span class="n">h</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fig</span><span class="o">.</span><span class="n">get_size_inches</span><span class="p">()</span>
<span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">w</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">dpi</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">h</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">dpi</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_adjust_frame_size</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">codec</span> <span class="o">==</span> <span class="s1">'h264'</span><span class="p">:</span>
<span class="n">wo</span><span class="p">,</span> <span class="n">ho</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fig</span><span class="o">.</span><span class="n">get_size_inches</span><span class="p">()</span>
<span class="n">w</span><span class="p">,</span> <span class="n">h</span> <span class="o">=</span> <span class="n">adjusted_figsize</span><span class="p">(</span><span class="n">wo</span><span class="p">,</span> <span class="n">ho</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dpi</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">wo</span><span class="p">,</span> <span class="n">ho</span><span class="p">)</span> <span class="o">==</span> <span class="p">(</span><span class="n">w</span><span class="p">,</span> <span class="n">h</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fig</span><span class="o">.</span><span class="n">set_size_inches</span><span class="p">(</span><span class="n">w</span><span class="p">,</span> <span class="n">h</span><span class="p">,</span> <span class="n">forward</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">_log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'figure size (inches) has been adjusted '</span>
<span class="s1">'from </span><span class="si">%s</span><span class="s1"> x </span><span class="si">%s</span><span class="s1"> to </span><span class="si">%s</span><span class="s1"> x </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">wo</span><span class="p">,</span> <span class="n">ho</span><span class="p">,</span> <span class="n">w</span><span class="p">,</span> <span class="n">h</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">w</span><span class="p">,</span> <span class="n">h</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fig</span><span class="o">.</span><span class="n">get_size_inches</span><span class="p">()</span>
<span class="n">_log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'frame size in pixels is </span><span class="si">%s</span><span class="s1"> x </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">frame_size</span><span class="p">)</span>
<span class="k">return</span> <span class="n">w</span><span class="p">,</span> <span class="n">h</span>
<div class="viewcode-block" id="MovieWriter.setup"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter.setup">[docs]</a> <span class="k">def</span> <span class="nf">setup</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fig</span><span class="p">,</span> <span class="n">outfile</span><span class="p">,</span> <span class="n">dpi</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Perform setup for writing the movie file.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> fig : matplotlib.figure.Figure</span>
<span class="sd"> The figure object that contains the information for frames</span>
<span class="sd"> outfile : string</span>
<span class="sd"> The filename of the resulting movie file</span>
<span class="sd"> dpi : int, optional</span>
<span class="sd"> The DPI (or resolution) for the file. This controls the size</span>
<span class="sd"> in pixels of the resulting movie file. Default is fig.dpi.</span>
<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">outfile</span> <span class="o">=</span> <span class="n">outfile</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fig</span> <span class="o">=</span> <span class="n">fig</span>
<span class="k">if</span> <span class="n">dpi</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">dpi</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fig</span><span class="o">.</span><span class="n">dpi</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dpi</span> <span class="o">=</span> <span class="n">dpi</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_w</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_h</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_adjust_frame_size</span><span class="p">()</span>
<span class="c1"># Run here so that grab_frame() can write the data to a pipe. This</span>
<span class="c1"># eliminates the need for temp files.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_run</span><span class="p">()</span></div>
<span class="k">def</span> <span class="nf">_run</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Uses subprocess to call the program for assembling frames into a</span>
<span class="c1"># movie file. *args* returns the sequence of command line arguments</span>
<span class="c1"># from a few configuration options.</span>
<span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_args</span><span class="p">()</span>
<span class="n">_log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'MovieWriter.run: running command: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">command</span><span class="p">)</span>
<span class="n">PIPE</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_proc</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span>
<span class="n">command</span><span class="p">,</span> <span class="n">stdin</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stdout</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stderr</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span>
<span class="n">creationflags</span><span class="o">=</span><span class="n">subprocess_creation_flags</span><span class="p">)</span>
<div class="viewcode-block" id="MovieWriter.finish"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter.finish">[docs]</a> <span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''Finish any processing for writing the movie.'''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cleanup</span><span class="p">()</span></div>
<div class="viewcode-block" id="MovieWriter.grab_frame"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter.grab_frame">[docs]</a> <span class="k">def</span> <span class="nf">grab_frame</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">savefig_kwargs</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Grab the image information from the figure and save as a movie frame.</span>
<span class="sd"> All keyword arguments in savefig_kwargs are passed on to the `savefig`</span>
<span class="sd"> command that saves the figure.</span>
<span class="sd"> '''</span>
<span class="n">_log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'MovieWriter.grab_frame: Grabbing frame.'</span><span class="p">)</span>
<span class="c1"># re-adjust the figure size in case it has been changed by the</span>
<span class="c1"># user. We must ensure that every frame is the same size or</span>
<span class="c1"># the movie will not save correctly.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fig</span><span class="o">.</span><span class="n">set_size_inches</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_w</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_h</span><span class="p">)</span>
<span class="c1"># Tell the figure to save its data to the sink, using the</span>
<span class="c1"># frame format and dpi.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fig</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_frame_sink</span><span class="p">(),</span> <span class="nb">format</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">frame_format</span><span class="p">,</span>
<span class="n">dpi</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">dpi</span><span class="p">,</span> <span class="o">**</span><span class="n">savefig_kwargs</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_frame_sink</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''Return the place to which frames should be written.'''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_proc</span><span class="o">.</span><span class="n">stdin</span>
<span class="k">def</span> <span class="nf">_args</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''Assemble list of utility-specific command-line arguments.'''</span>
<span class="k">return</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"args needs to be implemented by subclass."</span><span class="p">)</span>
<div class="viewcode-block" id="MovieWriter.cleanup"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter.cleanup">[docs]</a> <span class="k">def</span> <span class="nf">cleanup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''Clean-up and collect the process used to write the movie file.'''</span>
<span class="n">out</span><span class="p">,</span> <span class="n">err</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_proc</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_frame_sink</span><span class="p">()</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="c1"># Use the encoding/errors that universal_newlines would use.</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">TextIOWrapper</span><span class="p">(</span><span class="n">BytesIO</span><span class="p">(</span><span class="n">out</span><span class="p">))</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="n">err</span> <span class="o">=</span> <span class="n">TextIOWrapper</span><span class="p">(</span><span class="n">BytesIO</span><span class="p">(</span><span class="n">err</span><span class="p">))</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="k">if</span> <span class="n">out</span><span class="p">:</span>
<span class="n">_log</span><span class="o">.</span><span class="n">log</span><span class="p">(</span>
<span class="n">logging</span><span class="o">.</span><span class="n">WARNING</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_proc</span><span class="o">.</span><span class="n">returncode</span> <span class="k">else</span> <span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span>
<span class="s2">"MovieWriter stdout:</span><span class="se">\n</span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">out</span><span class="p">)</span>
<span class="k">if</span> <span class="n">err</span><span class="p">:</span>
<span class="n">_log</span><span class="o">.</span><span class="n">log</span><span class="p">(</span>
<span class="n">logging</span><span class="o">.</span><span class="n">WARNING</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_proc</span><span class="o">.</span><span class="n">returncode</span> <span class="k">else</span> <span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span>
<span class="s2">"MovieWriter stderr:</span><span class="se">\n</span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_proc</span><span class="o">.</span><span class="n">returncode</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">CalledProcessError</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_proc</span><span class="o">.</span><span class="n">returncode</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_proc</span><span class="o">.</span><span class="n">args</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span></div>
<div class="viewcode-block" id="MovieWriter.bin_path"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter.bin_path">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">bin_path</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Return the binary path to the commandline tool used by a specific</span>
<span class="sd"> subclass. This is a class method so that the tool can be looked for</span>
<span class="sd"> before making a particular MovieWriter subclass available.</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">rcParams</span><span class="p">[</span><span class="bp">cls</span><span class="o">.</span><span class="n">exec_key</span><span class="p">])</span></div>
<div class="viewcode-block" id="MovieWriter.isAvailable"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter.isAvailable">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">isAvailable</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Check to see if a MovieWriter subclass is actually available.</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="n">shutil</span><span class="o">.</span><span class="n">which</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">bin_path</span><span class="p">())</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span></div></div>
<div class="viewcode-block" id="FileMovieWriter"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.FileMovieWriter.html#matplotlib.animation.FileMovieWriter">[docs]</a><span class="k">class</span> <span class="nc">FileMovieWriter</span><span class="p">(</span><span class="n">MovieWriter</span><span class="p">):</span>
<span class="sd">'''`MovieWriter` for writing to individual files and stitching at the end.</span>
<span class="sd"> This must be sub-classed to be useful.</span>
<span class="sd"> '''</span>
<div class="viewcode-block" id="FileMovieWriter.__init__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.FileMovieWriter.html#matplotlib.animation.FileMovieWriter.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">MovieWriter</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">frame_format</span> <span class="o">=</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'animation.frame_format'</span><span class="p">]</span></div>
<div class="viewcode-block" id="FileMovieWriter.setup"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.FileMovieWriter.html#matplotlib.animation.FileMovieWriter.setup">[docs]</a> <span class="k">def</span> <span class="nf">setup</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fig</span><span class="p">,</span> <span class="n">outfile</span><span class="p">,</span> <span class="n">dpi</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">frame_prefix</span><span class="o">=</span><span class="s1">'_tmp'</span><span class="p">,</span>
<span class="n">clear_temp</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">'''Perform setup for writing the movie file.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> fig : matplotlib.figure.Figure</span>
<span class="sd"> The figure to grab the rendered frames from.</span>
<span class="sd"> outfile : str</span>
<span class="sd"> The filename of the resulting movie file.</span>
<span class="sd"> dpi : number, optional</span>
<span class="sd"> The dpi of the output file. This, with the figure size,</span>
<span class="sd"> controls the size in pixels of the resulting movie file.</span>
<span class="sd"> Default is fig.dpi.</span>
<span class="sd"> frame_prefix : str, optional</span>
<span class="sd"> The filename prefix to use for temporary files. Defaults to</span>
<span class="sd"> ``'_tmp'``.</span>
<span class="sd"> clear_temp : bool, optional</span>
<span class="sd"> If the temporary files should be deleted after stitching</span>
<span class="sd"> the final result. Setting this to ``False`` can be useful for</span>
<span class="sd"> debugging. Defaults to ``True``.</span>
<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fig</span> <span class="o">=</span> <span class="n">fig</span>
<span class="bp">self</span><span class="o">.</span><span class="n">outfile</span> <span class="o">=</span> <span class="n">outfile</span>
<span class="k">if</span> <span class="n">dpi</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">dpi</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fig</span><span class="o">.</span><span class="n">dpi</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dpi</span> <span class="o">=</span> <span class="n">dpi</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_adjust_frame_size</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">clear_temp</span> <span class="o">=</span> <span class="n">clear_temp</span>
<span class="bp">self</span><span class="o">.</span><span class="n">temp_prefix</span> <span class="o">=</span> <span class="n">frame_prefix</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_frame_counter</span> <span class="o">=</span> <span class="mi">0</span> <span class="c1"># used for generating sequential file names</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_temp_names</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fname_format_str</span> <span class="o">=</span> <span class="s1">'</span><span class="si">%s%%</span><span class="s1">07d.</span><span class="si">%s</span><span class="s1">'</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">frame_format</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Format (png, jpeg, etc.) to use for saving the frames, which can be</span>
<span class="sd"> decided by the individual subclasses.</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_frame_format</span>
<span class="nd">@frame_format</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">frame_format</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">frame_format</span><span class="p">):</span>
<span class="k">if</span> <span class="n">frame_format</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">supported_formats</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_frame_format</span> <span class="o">=</span> <span class="n">frame_format</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_frame_format</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">supported_formats</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">_base_temp_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Generates a template name (without number) given the frame format</span>
<span class="c1"># for extension and the prefix.</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">fname_format_str</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">temp_prefix</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">frame_format</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_frame_sink</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Creates a filename for saving using the basename and the current</span>
<span class="c1"># counter.</span>
<span class="n">fname</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_base_temp_name</span><span class="p">()</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">_frame_counter</span>
<span class="c1"># Save the filename so we can delete it later if necessary</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_temp_names</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span>
<span class="n">_log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'FileMovieWriter.frame_sink: saving frame </span><span class="si">%d</span><span class="s1"> to fname=</span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_frame_counter</span><span class="p">,</span> <span class="n">fname</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_frame_counter</span> <span class="o">+=</span> <span class="mi">1</span> <span class="c1"># Ensures each created name is 'unique'</span>
<span class="c1"># This file returned here will be closed once it's used by savefig()</span>
<span class="c1"># because it will no longer be referenced and will be gc-ed.</span>
<span class="k">return</span> <span class="nb">open</span><span class="p">(</span><span class="n">fname</span><span class="p">,</span> <span class="s1">'wb'</span><span class="p">)</span>
<div class="viewcode-block" id="FileMovieWriter.grab_frame"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.FileMovieWriter.html#matplotlib.animation.FileMovieWriter.grab_frame">[docs]</a> <span class="k">def</span> <span class="nf">grab_frame</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">savefig_kwargs</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Grab the image information from the figure and save as a movie frame.</span>
<span class="sd"> All keyword arguments in savefig_kwargs are passed on to the `savefig`</span>
<span class="sd"> command that saves the figure.</span>
<span class="sd"> '''</span>
<span class="c1"># Overloaded to explicitly close temp file.</span>
<span class="n">_log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'MovieWriter.grab_frame: Grabbing frame.'</span><span class="p">)</span>
<span class="c1"># Tell the figure to save its data to the sink, using the</span>
<span class="c1"># frame format and dpi.</span>
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_frame_sink</span><span class="p">()</span> <span class="k">as</span> <span class="n">myframesink</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fig</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">myframesink</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">frame_format</span><span class="p">,</span>
<span class="n">dpi</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">dpi</span><span class="p">,</span> <span class="o">**</span><span class="n">savefig_kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="FileMovieWriter.finish"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.FileMovieWriter.html#matplotlib.animation.FileMovieWriter.finish">[docs]</a> <span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Call run here now that all frame grabbing is done. All temp files</span>
<span class="c1"># are available to be assembled.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_run</span><span class="p">()</span>
<span class="n">MovieWriter</span><span class="o">.</span><span class="n">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="c1"># Will call clean-up</span></div>
<div class="viewcode-block" id="FileMovieWriter.cleanup"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.FileMovieWriter.html#matplotlib.animation.FileMovieWriter.cleanup">[docs]</a> <span class="k">def</span> <span class="nf">cleanup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">MovieWriter</span><span class="o">.</span><span class="n">cleanup</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="c1"># Delete temporary files</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">clear_temp</span><span class="p">:</span>
<span class="n">_log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'MovieWriter: clearing temporary fnames=</span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_temp_names</span><span class="p">)</span>
<span class="k">for</span> <span class="n">fname</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_temp_names</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="PillowWriter"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.PillowWriter.html#matplotlib.animation.PillowWriter">[docs]</a><span class="nd">@writers</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="s1">'pillow'</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">PillowWriter</span><span class="p">(</span><span class="n">MovieWriter</span><span class="p">):</span>
<div class="viewcode-block" id="PillowWriter.isAvailable"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.PillowWriter.html#matplotlib.animation.PillowWriter.isAvailable">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">isAvailable</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">PIL</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="PillowWriter.__init__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.PillowWriter.html#matplotlib.animation.PillowWriter.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">if</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"extra_args"</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"extra_args"</span><span class="p">]</span> <span class="o">=</span> <span class="p">()</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="PillowWriter.setup"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.PillowWriter.html#matplotlib.animation.PillowWriter.setup">[docs]</a> <span class="k">def</span> <span class="nf">setup</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fig</span><span class="p">,</span> <span class="n">outfile</span><span class="p">,</span> <span class="n">dpi</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_frames</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_outfile</span> <span class="o">=</span> <span class="n">outfile</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_dpi</span> <span class="o">=</span> <span class="n">dpi</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_fig</span> <span class="o">=</span> <span class="n">fig</span></div>
<div class="viewcode-block" id="PillowWriter.grab_frame"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.PillowWriter.html#matplotlib.animation.PillowWriter.grab_frame">[docs]</a> <span class="k">def</span> <span class="nf">grab_frame</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">savefig_kwargs</span><span class="p">):</span>
<span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
<span class="n">buf</span> <span class="o">=</span> <span class="n">BytesIO</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_fig</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">buf</span><span class="p">,</span> <span class="o">**</span><span class="nb">dict</span><span class="p">(</span><span class="n">savefig_kwargs</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s2">"rgba"</span><span class="p">))</span>
<span class="n">renderer</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fig</span><span class="o">.</span><span class="n">canvas</span><span class="o">.</span><span class="n">get_renderer</span><span class="p">()</span>
<span class="c1"># Using frombuffer / getbuffer may be slightly more efficient, but</span>
<span class="c1"># Py3-only.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_frames</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">Image</span><span class="o">.</span><span class="n">frombytes</span><span class="p">(</span>
<span class="s2">"RGBA"</span><span class="p">,</span>
<span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">renderer</span><span class="o">.</span><span class="n">width</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">renderer</span><span class="o">.</span><span class="n">height</span><span class="p">)),</span>
<span class="n">buf</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()))</span></div>
<div class="viewcode-block" id="PillowWriter.finish"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.PillowWriter.html#matplotlib.animation.PillowWriter.finish">[docs]</a> <span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_frames</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">save</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_outfile</span><span class="p">,</span> <span class="n">save_all</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">append_images</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_frames</span><span class="p">[</span><span class="mi">1</span><span class="p">:],</span>
<span class="n">duration</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span><span class="mi">1000</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">fps</span><span class="p">),</span> <span class="n">loop</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span></div></div>
<span class="c1"># Base class of ffmpeg information. Has the config keys and the common set</span>
<span class="c1"># of arguments that controls the *output* side of things.</span>
<div class="viewcode-block" id="FFMpegBase"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.FFMpegBase.html#matplotlib.animation.FFMpegBase">[docs]</a><span class="k">class</span> <span class="nc">FFMpegBase</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">'''Mixin class for FFMpeg output.</span>
<span class="sd"> To be useful this must be multiply-inherited from with a</span>
<span class="sd"> `MovieWriterBase` sub-class.</span>
<span class="sd"> '''</span>
<span class="n">exec_key</span> <span class="o">=</span> <span class="s1">'animation.ffmpeg_path'</span>
<span class="n">args_key</span> <span class="o">=</span> <span class="s1">'animation.ffmpeg_args'</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">output_args</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'-vcodec'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">codec</span><span class="p">]</span>
<span class="c1"># For h264, the default format is yuv444p, which is not compatible</span>
<span class="c1"># with quicktime (and others). Specifying yuv420p fixes playback on</span>
<span class="c1"># iOS,as well as HTML5 video in firefox and safari (on both Win and</span>
<span class="c1"># OSX). Also fixes internet explorer. This is as of 2015/10/29.</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">codec</span> <span class="o">==</span> <span class="s1">'h264'</span> <span class="ow">and</span> <span class="s1">'-pix_fmt'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">extra_args</span><span class="p">:</span>
<span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s1">'-pix_fmt'</span><span class="p">,</span> <span class="s1">'yuv420p'</span><span class="p">])</span>
<span class="c1"># The %dk adds 'k' as a suffix so that ffmpeg treats our bitrate as in</span>
<span class="c1"># kbps</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">bitrate</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s1">'-b'</span><span class="p">,</span> <span class="s1">'</span><span class="si">%d</span><span class="s1">k'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">bitrate</span><span class="p">])</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">extra_args</span><span class="p">:</span>
<span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">extra_args</span><span class="p">)</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s1">'-metadata'</span><span class="p">,</span> <span class="s1">'</span><span class="si">%s</span><span class="s1">=</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)])</span>
<span class="k">return</span> <span class="n">args</span> <span class="o">+</span> <span class="p">[</span><span class="s1">'-y'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">outfile</span><span class="p">]</span>
<div class="viewcode-block" id="FFMpegBase.isAvailable"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.FFMpegBase.html#matplotlib.animation.FFMpegBase.isAvailable">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">isAvailable</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="k">return</span> <span class="p">(</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">isAvailable</span><span class="p">()</span>
<span class="c1"># Ubuntu 12.04 ships a broken ffmpeg binary which we shouldn't use.</span>
<span class="c1"># NOTE: when removed, remove the same method in AVConvBase.</span>
<span class="ow">and</span> <span class="sa">b</span><span class="s1">'LibAv'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">run</span><span class="p">(</span>
<span class="p">[</span><span class="bp">cls</span><span class="o">.</span><span class="n">bin_path</span><span class="p">()],</span> <span class="n">creationflags</span><span class="o">=</span><span class="n">subprocess_creation_flags</span><span class="p">,</span>
<span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">DEVNULL</span><span class="p">,</span> <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span><span class="o">.</span><span class="n">stderr</span><span class="p">)</span></div></div>
<span class="c1"># Combine FFMpeg options with pipe-based writing</span>
<div class="viewcode-block" id="FFMpegWriter"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.FFMpegWriter.html#matplotlib.animation.FFMpegWriter">[docs]</a><span class="nd">@writers</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="s1">'ffmpeg'</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">FFMpegWriter</span><span class="p">(</span><span class="n">FFMpegBase</span><span class="p">,</span> <span class="n">MovieWriter</span><span class="p">):</span>
<span class="sd">'''Pipe-based ffmpeg writer.</span>
<span class="sd"> Frames are streamed directly to ffmpeg via a pipe and written in a single</span>
<span class="sd"> pass.</span>
<span class="sd"> '''</span>
<span class="k">def</span> <span class="nf">_args</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Returns the command line parameters for subprocess to use</span>
<span class="c1"># ffmpeg to create a movie using a pipe.</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">bin_path</span><span class="p">(),</span> <span class="s1">'-f'</span><span class="p">,</span> <span class="s1">'rawvideo'</span><span class="p">,</span> <span class="s1">'-vcodec'</span><span class="p">,</span> <span class="s1">'rawvideo'</span><span class="p">,</span>
<span class="s1">'-s'</span><span class="p">,</span> <span class="s1">'</span><span class="si">%d</span><span class="s1">x</span><span class="si">%d</span><span class="s1">'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">frame_size</span><span class="p">,</span> <span class="s1">'-pix_fmt'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">frame_format</span><span class="p">,</span>
<span class="s1">'-r'</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fps</span><span class="p">)]</span>
<span class="c1"># Logging is quieted because subprocess.PIPE has limited buffer size.</span>
<span class="c1"># If you have a lot of frames in your animation and set logging to</span>
<span class="c1"># DEBUG, you will have a buffer overrun.</span>
<span class="k">if</span> <span class="n">_log</span><span class="o">.</span><span class="n">getEffectiveLevel</span><span class="p">()</span> <span class="o">></span> <span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">:</span>
<span class="n">args</span> <span class="o">+=</span> <span class="p">[</span><span class="s1">'-loglevel'</span><span class="p">,</span> <span class="s1">'error'</span><span class="p">]</span>
<span class="n">args</span> <span class="o">+=</span> <span class="p">[</span><span class="s1">'-i'</span><span class="p">,</span> <span class="s1">'pipe:'</span><span class="p">]</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_args</span>
<span class="k">return</span> <span class="n">args</span></div>
<span class="c1"># Combine FFMpeg options with temp file-based writing</span>
<div class="viewcode-block" id="FFMpegFileWriter"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.FFMpegFileWriter.html#matplotlib.animation.FFMpegFileWriter">[docs]</a><span class="nd">@writers</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="s1">'ffmpeg_file'</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">FFMpegFileWriter</span><span class="p">(</span><span class="n">FFMpegBase</span><span class="p">,</span> <span class="n">FileMovieWriter</span><span class="p">):</span>
<span class="sd">'''File-based ffmpeg writer.</span>
<span class="sd"> Frames are written to temporary files on disk and then stitched</span>
<span class="sd"> together at the end.</span>
<span class="sd"> '''</span>
<span class="n">supported_formats</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'png'</span><span class="p">,</span> <span class="s1">'jpeg'</span><span class="p">,</span> <span class="s1">'ppm'</span><span class="p">,</span> <span class="s1">'tiff'</span><span class="p">,</span> <span class="s1">'sgi'</span><span class="p">,</span> <span class="s1">'bmp'</span><span class="p">,</span>
<span class="s1">'pbm'</span><span class="p">,</span> <span class="s1">'raw'</span><span class="p">,</span> <span class="s1">'rgba'</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">_args</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Returns the command line parameters for subprocess to use</span>
<span class="c1"># ffmpeg to create a movie using a collection of temp images</span>
<span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">bin_path</span><span class="p">(),</span> <span class="s1">'-r'</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fps</span><span class="p">),</span>
<span class="s1">'-i'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_base_temp_name</span><span class="p">(),</span>
<span class="s1">'-vframes'</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_frame_counter</span><span class="p">)]</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_args</span></div>
<span class="c1"># Base class of avconv information. AVConv has identical arguments to FFMpeg.</span>
<div class="viewcode-block" id="AVConvBase"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.AVConvBase.html#matplotlib.animation.AVConvBase">[docs]</a><span class="k">class</span> <span class="nc">AVConvBase</span><span class="p">(</span><span class="n">FFMpegBase</span><span class="p">):</span>
<span class="sd">'''Mixin class for avconv output.</span>
<span class="sd"> To be useful this must be multiply-inherited from with a</span>
<span class="sd"> `MovieWriterBase` sub-class.</span>
<span class="sd"> '''</span>
<span class="n">exec_key</span> <span class="o">=</span> <span class="s1">'animation.avconv_path'</span>
<span class="n">args_key</span> <span class="o">=</span> <span class="s1">'animation.avconv_args'</span>
<span class="c1"># NOTE : should be removed when the same method is removed in FFMpegBase.</span>
<span class="n">isAvailable</span> <span class="o">=</span> <span class="nb">classmethod</span><span class="p">(</span><span class="n">MovieWriter</span><span class="o">.</span><span class="n">isAvailable</span><span class="o">.</span><span class="vm">__func__</span><span class="p">)</span></div>
<span class="c1"># Combine AVConv options with pipe-based writing</span>
<div class="viewcode-block" id="AVConvWriter"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.AVConvWriter.html#matplotlib.animation.AVConvWriter">[docs]</a><span class="nd">@writers</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="s1">'avconv'</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">AVConvWriter</span><span class="p">(</span><span class="n">AVConvBase</span><span class="p">,</span> <span class="n">FFMpegWriter</span><span class="p">):</span>
<span class="sd">'''Pipe-based avconv writer.</span>
<span class="sd"> Frames are streamed directly to avconv via a pipe and written in a single</span>
<span class="sd"> pass.</span>
<span class="sd"> '''</span></div>
<span class="c1"># Combine AVConv options with file-based writing</span>
<div class="viewcode-block" id="AVConvFileWriter"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.AVConvFileWriter.html#matplotlib.animation.AVConvFileWriter">[docs]</a><span class="nd">@writers</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="s1">'avconv_file'</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">AVConvFileWriter</span><span class="p">(</span><span class="n">AVConvBase</span><span class="p">,</span> <span class="n">FFMpegFileWriter</span><span class="p">):</span>
<span class="sd">'''File-based avconv writer.</span>
<span class="sd"> Frames are written to temporary files on disk and then stitched</span>
<span class="sd"> together at the end.</span>
<span class="sd"> '''</span></div>
<span class="c1"># Base class for animated GIFs with ImageMagick</span>
<div class="viewcode-block" id="ImageMagickBase"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.ImageMagickBase.html#matplotlib.animation.ImageMagickBase">[docs]</a><span class="k">class</span> <span class="nc">ImageMagickBase</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">'''Mixin class for ImageMagick output.</span>
<span class="sd"> To be useful this must be multiply-inherited from with a</span>
<span class="sd"> `MovieWriterBase` sub-class.</span>
<span class="sd"> '''</span>
<span class="n">exec_key</span> <span class="o">=</span> <span class="s1">'animation.convert_path'</span>
<span class="n">args_key</span> <span class="o">=</span> <span class="s1">'animation.convert_args'</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">delay</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="mf">100.</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">fps</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">output_args</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">outfile</span><span class="p">]</span>
<div class="viewcode-block" id="ImageMagickBase.bin_path"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.ImageMagickBase.html#matplotlib.animation.ImageMagickBase.bin_path">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">bin_path</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="n">binpath</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">bin_path</span><span class="p">()</span>
<span class="k">if</span> <span class="n">binpath</span> <span class="o">==</span> <span class="s1">'convert'</span><span class="p">:</span>
<span class="n">binpath</span> <span class="o">=</span> <span class="n">mpl</span><span class="o">.</span><span class="n">_get_executable_info</span><span class="p">(</span><span class="s1">'magick'</span><span class="p">)</span><span class="o">.</span><span class="n">executable</span>
<span class="k">return</span> <span class="n">binpath</span></div>
<div class="viewcode-block" id="ImageMagickBase.isAvailable"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.ImageMagickBase.html#matplotlib.animation.ImageMagickBase.isAvailable">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">isAvailable</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">isAvailable</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">FileNotFoundError</span><span class="p">:</span> <span class="c1"># May be raised by get_executable_info.</span>
<span class="k">return</span> <span class="kc">False</span></div></div>
<span class="c1"># Combine ImageMagick options with pipe-based writing</span>
<div class="viewcode-block" id="ImageMagickWriter"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.ImageMagickWriter.html#matplotlib.animation.ImageMagickWriter">[docs]</a><span class="nd">@writers</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="s1">'imagemagick'</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">ImageMagickWriter</span><span class="p">(</span><span class="n">ImageMagickBase</span><span class="p">,</span> <span class="n">MovieWriter</span><span class="p">):</span>
<span class="sd">'''Pipe-based animated gif.</span>
<span class="sd"> Frames are streamed directly to ImageMagick via a pipe and written</span>
<span class="sd"> in a single pass.</span>
<span class="sd"> '''</span>
<span class="k">def</span> <span class="nf">_args</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">bin_path</span><span class="p">(),</span>
<span class="s1">'-size'</span><span class="p">,</span> <span class="s1">'</span><span class="si">%i</span><span class="s1">x</span><span class="si">%i</span><span class="s1">'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">frame_size</span><span class="p">,</span> <span class="s1">'-depth'</span><span class="p">,</span> <span class="s1">'8'</span><span class="p">,</span>
<span class="s1">'-delay'</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">delay</span><span class="p">),</span> <span class="s1">'-loop'</span><span class="p">,</span> <span class="s1">'0'</span><span class="p">,</span>
<span class="s1">'</span><span class="si">%s</span><span class="s1">:-'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">frame_format</span><span class="p">]</span>
<span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_args</span><span class="p">)</span></div>
<span class="c1"># Combine ImageMagick options with temp file-based writing</span>
<div class="viewcode-block" id="ImageMagickFileWriter"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.animation.ImageMagickFileWriter.html#matplotlib.animation.ImageMagickFileWriter">[docs]</a><span class="nd">@writers</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="s1">'imagemagick_file'</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">ImageMagickFileWriter</span><span class="p">(</span><span class="n">ImageMagickBase</span><span class="p">,</span> <span class="n">FileMovieWriter</span><span class="p">):</span>
<span class="sd">'''File-based animated gif writer.</span>
<span class="sd"> Frames are written to temporary files on disk and then stitched</span>
<span class="sd"> together at the end.</span>
<span class="sd"> '''</span>
<span class="n">supported_formats</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'png'</span><span class="p">,</span> <span class="s1">'jpeg'</span><span class="p">,</span> <span class="s1">'ppm'</span><span class="p">,</span> <span class="s1">'tiff'</span><span class="p">,</span> <span class="s1">'sgi'</span><span class="p">,</span> <span class="s1">'bmp'</span><span class="p">,</span>
<span class="s1">'pbm'</span><span class="p">,</span> <span class="s1">'raw'</span><span class="p">,</span> <span class="s1">'rgba'</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">_args</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">bin_path</span><span class="p">(),</span> <span class="s1">'-delay'</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">delay</span><span class="p">),</span> <span class="s1">'-loop'</span><span class="p">,</span> <span class="s1">'0'</span><span class="p">,</span>
<span class="s1">'</span><span class="si">%s</span><span class="s1">*.</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">temp_prefix</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">frame_format</span><span class="p">)]</span>
<span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_args</span><span class="p">)</span></div>
<span class="c1"># Taken directly from jakevdp's JSAnimation package at</span>
<span class="c1"># http://github.com/jakevdp/JSAnimation</span>
<span class="k">def</span> <span class="nf">_included_frames</span><span class="p">(</span><span class="n">frame_list</span><span class="p">,</span> <span class="n">frame_format</span><span class="p">):</span>
<span class="sd">"""frame_list should be a list of filenames"""</span>
<span class="k">return</span> <span class="n">INCLUDED_FRAMES</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">Nframes</span><span class="o">=</span><span class="nb">len</span><span class="p">(</span><span class="n">frame_list</span><span class="p">),</span>
<span class="n">frame_dir</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">frame_list</span><span class="p">[</span><span class="mi">0</span><span class="p">]),</span>
<span class="n">frame_format</span><span class="o">=</span><span class="n">frame_format</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_embedded_frames</span><span class="p">(</span><span class="n">frame_list</span><span class="p">,</span> <span class="n">frame_format</span><span class="p">):</span>
<span class="sd">"""frame_list should be a list of base64-encoded png files"""</span>
<span class="n">template</span> <span class="o">=</span> <span class="s1">' frames[</span><span class="si">{0}</span><span class="s1">] = "data:image/</span><span class="si">{1}</span><span class="s1">;base64,</span><span class="si">{2}</span><span class="s1">"</span><span class="se">\n</span><span class="s1">'</span>
<span class="k">return</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
<span class="n">template</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">frame_format</span><span class="p">,</span> <span class="n">frame_data</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\\n</span><span class="s1">'</span><span class="p">))</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">frame_data</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">frame_list</span><span class="p">))</span>
<span class="nd">@writers</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="s1">'html'</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">HTMLWriter</span><span class="p">(</span><span class="n">FileMovieWriter</span><span class="p">):</span>
<span class="n">supported_formats</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'png'</span><span class="p">,</span> <span class="s1">'jpeg'</span><span class="p">,</span> <span class="s1">'tiff'</span><span class="p">,</span> <span class="s1">'svg'</span><span class="p">]</span>
<span class="n">args_key</span> <span class="o">=</span> <span class="s1">'animation.html_args'</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">isAvailable</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fps</span><span class="o">=</span><span class="mi">30</span><span class="p">,</span> <span class="n">codec</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">bitrate</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">extra_args</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">embed_frames</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">default_mode</span><span class="o">=</span><span class="s1">'loop'</span><span class="p">,</span>
<span class="n">embed_limit</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">embed_frames</span> <span class="o">=</span> <span class="n">embed_frames</span>
<span class="bp">self</span><span class="o">.</span><span class="n">default_mode</span> <span class="o">=</span> <span class="n">default_mode</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="c1"># Save embed limit, which is given in MB</span>
<span class="k">if</span> <span class="n">embed_limit</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_bytes_limit</span> <span class="o">=</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'animation.embed_limit'</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_bytes_limit</span> <span class="o">=</span> <span class="n">embed_limit</span>
<span class="c1"># Convert from MB to bytes</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_bytes_limit</span> <span class="o">*=</span> <span class="mi">1024</span> <span class="o">*</span> <span class="mi">1024</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_mode</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'loop'</span><span class="p">,</span> <span class="s1">'once'</span><span class="p">,</span> <span class="s1">'reflect'</span><span class="p">]:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s2">"unrecognized default_mode </span><span class="si">{!r}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">default_mode</span><span class="p">))</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">fps</span><span class="p">,</span> <span class="n">codec</span><span class="p">,</span> <span class="n">bitrate</span><span class="p">,</span> <span class="n">extra_args</span><span class="p">,</span> <span class="n">metadata</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">setup</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fig</span><span class="p">,</span> <span class="n">outfile</span><span class="p">,</span> <span class="n">dpi</span><span class="p">,</span> <span class="n">frame_dir</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">root</span><span class="p">,</span> <span class="n">ext</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">outfile</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ext</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'.html'</span><span class="p">,</span> <span class="s1">'.htm'</span><span class="p">]:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"outfile must be *.htm or *.html"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_saved_frames</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_total_bytes</span> <span class="o">=</span> <span class="mi">0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_hit_limit</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">embed_frames</span><span class="p">:</span>
<span class="k">if</span> <span class="n">frame_dir</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">frame_dir</span> <span class="o">=</span> <span class="n">root</span> <span class="o">+</span> <span class="s1">'_frames'</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">frame_dir</span><span class="p">):</span>
<span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">frame_dir</span><span class="p">)</span>
<span class="n">frame_prefix</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">frame_dir</span><span class="p">,</span> <span class="s1">'frame'</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">frame_prefix</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">setup</span><span class="p">(</span><span class="n">fig</span><span class="p">,</span> <span class="n">outfile</span><span class="p">,</span> <span class="n">dpi</span><span class="p">,</span> <span class="n">frame_prefix</span><span class="p">,</span> <span class="n">clear_temp</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">grab_frame</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">savefig_kwargs</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">embed_frames</span><span class="p">:</span>
<span class="c1"># Just stop processing if we hit the limit</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hit_limit</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">f</span> <span class="o">=</span> <span class="n">BytesIO</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fig</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">frame_format</span><span class="p">,</span>
<span class="n">dpi</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">dpi</span><span class="p">,</span> <span class="o">**</span><span class="n">savefig_kwargs</span><span class="p">)</span>
<span class="n">imgdata64</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">encodebytes</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">getvalue</span><span class="p">())</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'ascii'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_total_bytes</span> <span class="o">+=</span> <span class="nb">len</span><span class="p">(</span><span class="n">imgdata64</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_total_bytes</span> <span class="o">>=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bytes_limit</span><span class="p">:</span>
<span class="n">_log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
<span class="s2">"Animation size has reached </span><span class="si">%s</span><span class="s2"> bytes, exceeding the limit "</span>
<span class="s2">"of </span><span class="si">%s</span><span class="s2">. If you're sure you want a larger animation "</span>
<span class="s2">"embedded, set the animation.embed_limit rc parameter to "</span>
<span class="s2">"a larger value (in MB). This and further frames will be "</span>
<span class="s2">"dropped."</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_total_bytes</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bytes_limit</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_hit_limit</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_saved_frames</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">imgdata64</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">grab_frame</span><span class="p">(</span><span class="o">**</span><span class="n">savefig_kwargs</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># save the frames to an html file</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">embed_frames</span><span class="p">:</span>
<span class="n">fill_frames</span> <span class="o">=</span> <span class="n">_embedded_frames</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_saved_frames</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">frame_format</span><span class="p">)</span>
<span class="n">Nframes</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_saved_frames</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># temp names is filled by FileMovieWriter</span>
<span class="n">fill_frames</span> <span class="o">=</span> <span class="n">_included_frames</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_temp_names</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">frame_format</span><span class="p">)</span>
<span class="n">Nframes</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_temp_names</span><span class="p">)</span>
<span class="n">mode_dict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">once_checked</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span>
<span class="n">loop_checked</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span>
<span class="n">reflect_checked</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span>
<span class="n">mode_dict</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">default_mode</span> <span class="o">+</span> <span class="s1">'_checked'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'checked'</span>
<span class="n">interval</span> <span class="o">=</span> <span class="mi">1000</span> <span class="o">//</span> <span class="bp">self</span><span class="o">.</span><span class="n">fps</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">outfile</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">)</span> <span class="k">as</span> <span class="n">of</span><span class="p">:</span>
<span class="n">of</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">JS_INCLUDE</span> <span class="o">+</span> <span class="n">STYLE_INCLUDE</span><span class="p">)</span>
<span class="n">of</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">DISPLAY_TEMPLATE</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">()</span><span class="o">.</span><span class="n">hex</span><span class="p">,</span>
<span class="n">Nframes</span><span class="o">=</span><span class="n">Nframes</span><span class="p">,</span>
<span class="n">fill_frames</span><span class="o">=</span><span class="n">fill_frames</span><span class="p">,</span>