<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>PIL.IcoImagePlugin — Pillow (PIL Fork) 5.4.1 documentation</title>
<script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
<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="../../_static/js/script.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="author" title="About these documents" href="../../about.html" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home"> Pillow (PIL Fork)
</a>
<div class="version">
5.4.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../handbook/index.html">Handbook</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../reference/index.html">Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../porting.html">Porting</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../about.html">About</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../releasenotes/index.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../deprecations.html">Deprecations and removals</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">Pillow (PIL Fork)</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> »</li>
<li><a href="../index.html">Module code</a> »</li>
<li>PIL.IcoImagePlugin</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for PIL.IcoImagePlugin</h1><div class="highlight"><pre>
<span></span><span class="c1">#</span>
<span class="c1"># The Python Imaging Library.</span>
<span class="c1"># $Id$</span>
<span class="c1">#</span>
<span class="c1"># Windows Icon support for PIL</span>
<span class="c1">#</span>
<span class="c1"># History:</span>
<span class="c1"># 96-05-27 fl Created</span>
<span class="c1">#</span>
<span class="c1"># Copyright (c) Secret Labs AB 1997.</span>
<span class="c1"># Copyright (c) Fredrik Lundh 1996.</span>
<span class="c1">#</span>
<span class="c1"># See the README file for information on usage and redistribution.</span>
<span class="c1">#</span>
<span class="c1"># This plugin is a refactored version of Win32IconImagePlugin by Bryan Davis</span>
<span class="c1"># <casadebender@gmail.com>.</span>
<span class="c1"># https://code.google.com/archive/p/casadebender/wikis/Win32IconImagePlugin.wiki</span>
<span class="c1">#</span>
<span class="c1"># Icon format references:</span>
<span class="c1"># * https://en.wikipedia.org/wiki/ICO_(file_format)</span>
<span class="c1"># * https://msdn.microsoft.com/en-us/library/ms997538.aspx</span>
<span class="kn">import</span> <span class="nn">struct</span>
<span class="kn">from</span> <span class="nn">io</span> <span class="k">import</span> <span class="n">BytesIO</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">Image</span><span class="p">,</span> <span class="n">ImageFile</span><span class="p">,</span> <span class="n">BmpImagePlugin</span><span class="p">,</span> <span class="n">PngImagePlugin</span>
<span class="kn">from</span> <span class="nn">._binary</span> <span class="k">import</span> <span class="n">i8</span><span class="p">,</span> <span class="n">i16le</span> <span class="k">as</span> <span class="n">i16</span><span class="p">,</span> <span class="n">i32le</span> <span class="k">as</span> <span class="n">i32</span>
<span class="kn">from</span> <span class="nn">math</span> <span class="k">import</span> <span class="n">log</span><span class="p">,</span> <span class="n">ceil</span>
<span class="n">__version__</span> <span class="o">=</span> <span class="s2">"0.1"</span>
<span class="c1">#</span>
<span class="c1"># --------------------------------------------------------------------</span>
<span class="n">_MAGIC</span> <span class="o">=</span> <span class="sa">b</span><span class="s2">"</span><span class="se">\0\0\1\0</span><span class="s2">"</span>
<span class="k">def</span> <span class="nf">_save</span><span class="p">(</span><span class="n">im</span><span class="p">,</span> <span class="n">fp</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
<span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_MAGIC</span><span class="p">)</span> <span class="c1"># (2+2)</span>
<span class="n">sizes</span> <span class="o">=</span> <span class="n">im</span><span class="o">.</span><span class="n">encoderinfo</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"sizes"</span><span class="p">,</span>
<span class="p">[(</span><span class="mi">16</span><span class="p">,</span> <span class="mi">16</span><span class="p">),</span> <span class="p">(</span><span class="mi">24</span><span class="p">,</span> <span class="mi">24</span><span class="p">),</span> <span class="p">(</span><span class="mi">32</span><span class="p">,</span> <span class="mi">32</span><span class="p">),</span> <span class="p">(</span><span class="mi">48</span><span class="p">,</span> <span class="mi">48</span><span class="p">),</span>
<span class="p">(</span><span class="mi">64</span><span class="p">,</span> <span class="mi">64</span><span class="p">),</span> <span class="p">(</span><span class="mi">128</span><span class="p">,</span> <span class="mi">128</span><span class="p">),</span> <span class="p">(</span><span class="mi">256</span><span class="p">,</span> <span class="mi">256</span><span class="p">)])</span>
<span class="n">width</span><span class="p">,</span> <span class="n">height</span> <span class="o">=</span> <span class="n">im</span><span class="o">.</span><span class="n">size</span>
<span class="n">sizes</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="kc">False</span> <span class="k">if</span> <span class="p">(</span><span class="n">x</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">></span> <span class="n">width</span> <span class="ow">or</span> <span class="n">x</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">></span> <span class="n">height</span> <span class="ow">or</span>
<span class="n">x</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">></span> <span class="mi">256</span> <span class="ow">or</span> <span class="n">x</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">></span> <span class="mi">256</span><span class="p">)</span> <span class="k">else</span> <span class="kc">True</span><span class="p">,</span>
<span class="n">sizes</span><span class="p">)</span>
<span class="n">sizes</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">sizes</span><span class="p">)</span>
<span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s2">"<H"</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">sizes</span><span class="p">)))</span> <span class="c1"># idCount(2)</span>
<span class="n">offset</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">tell</span><span class="p">()</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">sizes</span><span class="p">)</span><span class="o">*</span><span class="mi">16</span>
<span class="k">for</span> <span class="n">size</span> <span class="ow">in</span> <span class="n">sizes</span><span class="p">:</span>
<span class="n">width</span><span class="p">,</span> <span class="n">height</span> <span class="o">=</span> <span class="n">size</span>
<span class="c1"># 0 means 256</span>
<span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s2">"B"</span><span class="p">,</span> <span class="n">width</span> <span class="k">if</span> <span class="n">width</span> <span class="o"><</span> <span class="mi">256</span> <span class="k">else</span> <span class="mi">0</span><span class="p">))</span> <span class="c1"># bWidth(1)</span>
<span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s2">"B"</span><span class="p">,</span> <span class="n">height</span> <span class="k">if</span> <span class="n">height</span> <span class="o"><</span> <span class="mi">256</span> <span class="k">else</span> <span class="mi">0</span><span class="p">))</span> <span class="c1"># bHeight(1)</span>
<span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="sa">b</span><span class="s2">"</span><span class="se">\0</span><span class="s2">"</span><span class="p">)</span> <span class="c1"># bColorCount(1)</span>
<span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="sa">b</span><span class="s2">"</span><span class="se">\0</span><span class="s2">"</span><span class="p">)</span> <span class="c1"># bReserved(1)</span>
<span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="sa">b</span><span class="s2">"</span><span class="se">\0\0</span><span class="s2">"</span><span class="p">)</span> <span class="c1"># wPlanes(2)</span>
<span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s2">"<H"</span><span class="p">,</span> <span class="mi">32</span><span class="p">))</span> <span class="c1"># wBitCount(2)</span>
<span class="n">image_io</span> <span class="o">=</span> <span class="n">BytesIO</span><span class="p">()</span>
<span class="n">tmp</span> <span class="o">=</span> <span class="n">im</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">tmp</span><span class="o">.</span><span class="n">thumbnail</span><span class="p">(</span><span class="n">size</span><span class="p">,</span> <span class="n">Image</span><span class="o">.</span><span class="n">LANCZOS</span><span class="p">)</span>
<span class="n">tmp</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">image_io</span><span class="p">,</span> <span class="s2">"png"</span><span class="p">)</span>
<span class="n">image_io</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="n">image_bytes</span> <span class="o">=</span> <span class="n">image_io</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="n">bytes_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">image_bytes</span><span class="p">)</span>
<span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s2">"<I"</span><span class="p">,</span> <span class="n">bytes_len</span><span class="p">))</span> <span class="c1"># dwBytesInRes(4)</span>
<span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s2">"<I"</span><span class="p">,</span> <span class="n">offset</span><span class="p">))</span> <span class="c1"># dwImageOffset(4)</span>
<span class="n">current</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">tell</span><span class="p">()</span>
<span class="n">fp</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="n">offset</span><span class="p">)</span>
<span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">image_bytes</span><span class="p">)</span>
<span class="n">offset</span> <span class="o">=</span> <span class="n">offset</span> <span class="o">+</span> <span class="n">bytes_len</span>
<span class="n">fp</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="n">current</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_accept</span><span class="p">(</span><span class="n">prefix</span><span class="p">):</span>
<span class="k">return</span> <span class="n">prefix</span><span class="p">[:</span><span class="mi">4</span><span class="p">]</span> <span class="o">==</span> <span class="n">_MAGIC</span>
<div class="viewcode-block" id="IcoFile"><a class="viewcode-back" href="../../reference/plugins.html#PIL.IcoImagePlugin.IcoFile">[docs]</a><span class="k">class</span> <span class="nc">IcoFile</span><span class="p">(</span><span class="nb">object</span><span class="p">):</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">buf</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Parse image from file-like object containing ico file data</span>
<span class="sd"> """</span>
<span class="c1"># check magic</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">buf</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">6</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_accept</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">SyntaxError</span><span class="p">(</span><span class="s2">"not an ICO file"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">buf</span> <span class="o">=</span> <span class="n">buf</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entry</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c1"># Number of items in file</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nb_items</span> <span class="o">=</span> <span class="n">i16</span><span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="mi">4</span><span class="p">:])</span>
<span class="c1"># Get headers for each item</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">nb_items</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">buf</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">16</span><span class="p">)</span>
<span class="n">icon_header</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'width'</span><span class="p">:</span> <span class="n">i8</span><span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="mi">0</span><span class="p">]),</span>
<span class="s1">'height'</span><span class="p">:</span> <span class="n">i8</span><span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="mi">1</span><span class="p">]),</span>
<span class="s1">'nb_color'</span><span class="p">:</span> <span class="n">i8</span><span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="mi">2</span><span class="p">]),</span> <span class="c1"># No. of colors in image (0 if >=8bpp)</span>
<span class="s1">'reserved'</span><span class="p">:</span> <span class="n">i8</span><span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="mi">3</span><span class="p">]),</span>
<span class="s1">'planes'</span><span class="p">:</span> <span class="n">i16</span><span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="mi">4</span><span class="p">:]),</span>
<span class="s1">'bpp'</span><span class="p">:</span> <span class="n">i16</span><span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="mi">6</span><span class="p">:]),</span>
<span class="s1">'size'</span><span class="p">:</span> <span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="mi">8</span><span class="p">:]),</span>
<span class="s1">'offset'</span><span class="p">:</span> <span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="mi">12</span><span class="p">:])</span>
<span class="p">}</span>
<span class="c1"># See Wikipedia</span>
<span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'width'</span><span class="p">,</span> <span class="s1">'height'</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">icon_header</span><span class="p">[</span><span class="n">j</span><span class="p">]:</span>
<span class="n">icon_header</span><span class="p">[</span><span class="n">j</span><span class="p">]</span> <span class="o">=</span> <span class="mi">256</span>
<span class="c1"># See Wikipedia notes about color depth.</span>
<span class="c1"># We need this just to differ images with equal sizes</span>
<span class="n">icon_header</span><span class="p">[</span><span class="s1">'color_depth'</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">icon_header</span><span class="p">[</span><span class="s1">'bpp'</span><span class="p">]</span> <span class="ow">or</span>
<span class="p">(</span><span class="n">icon_header</span><span class="p">[</span><span class="s1">'nb_color'</span><span class="p">]</span> <span class="o">!=</span> <span class="mi">0</span> <span class="ow">and</span>
<span class="n">ceil</span><span class="p">(</span><span class="n">log</span><span class="p">(</span><span class="n">icon_header</span><span class="p">[</span><span class="s1">'nb_color'</span><span class="p">],</span>
<span class="mi">2</span><span class="p">)))</span> <span class="ow">or</span> <span class="mi">256</span><span class="p">)</span>
<span class="n">icon_header</span><span class="p">[</span><span class="s1">'dim'</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">icon_header</span><span class="p">[</span><span class="s1">'width'</span><span class="p">],</span> <span class="n">icon_header</span><span class="p">[</span><span class="s1">'height'</span><span class="p">])</span>
<span class="n">icon_header</span><span class="p">[</span><span class="s1">'square'</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">icon_header</span><span class="p">[</span><span class="s1">'width'</span><span class="p">]</span> <span class="o">*</span>
<span class="n">icon_header</span><span class="p">[</span><span class="s1">'height'</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entry</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">icon_header</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entry</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">entry</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">[</span><span class="s1">'color_depth'</span><span class="p">])</span>
<span class="c1"># ICO images are usually squares</span>
<span class="c1"># self.entry = sorted(self.entry, key=lambda x: x['width'])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entry</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">entry</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">[</span><span class="s1">'square'</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entry</span><span class="o">.</span><span class="n">reverse</span><span class="p">()</span>
<div class="viewcode-block" id="IcoFile.sizes"><a class="viewcode-back" href="../../reference/plugins.html#PIL.IcoImagePlugin.IcoFile.sizes">[docs]</a> <span class="k">def</span> <span class="nf">sizes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Get a list of all available icon sizes and color depths.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="p">{(</span><span class="n">h</span><span class="p">[</span><span class="s1">'width'</span><span class="p">],</span> <span class="n">h</span><span class="p">[</span><span class="s1">'height'</span><span class="p">])</span> <span class="k">for</span> <span class="n">h</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">entry</span><span class="p">}</span></div>
<div class="viewcode-block" id="IcoFile.getimage"><a class="viewcode-back" href="../../reference/plugins.html#PIL.IcoImagePlugin.IcoFile.getimage">[docs]</a> <span class="k">def</span> <span class="nf">getimage</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">bpp</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Get an image from the icon</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">h</span><span class="p">)</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">entry</span><span class="p">):</span>
<span class="k">if</span> <span class="n">size</span> <span class="o">==</span> <span class="n">h</span><span class="p">[</span><span class="s1">'dim'</span><span class="p">]</span> <span class="ow">and</span> <span class="p">(</span><span class="n">bpp</span> <span class="ow">is</span> <span class="kc">False</span> <span class="ow">or</span> <span class="n">bpp</span> <span class="o">==</span> <span class="n">h</span><span class="p">[</span><span class="s1">'color_depth'</span><span class="p">]):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">frame</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">frame</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span></div>
<div class="viewcode-block" id="IcoFile.frame"><a class="viewcode-back" href="../../reference/plugins.html#PIL.IcoImagePlugin.IcoFile.frame">[docs]</a> <span class="k">def</span> <span class="nf">frame</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">idx</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Get an image from frame idx</span>
<span class="sd"> """</span>
<span class="n">header</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">entry</span><span class="p">[</span><span class="n">idx</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">buf</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="n">header</span><span class="p">[</span><span class="s1">'offset'</span><span class="p">])</span>
<span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">buf</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">8</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">buf</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="n">header</span><span class="p">[</span><span class="s1">'offset'</span><span class="p">])</span>
<span class="k">if</span> <span class="n">data</span><span class="p">[:</span><span class="mi">8</span><span class="p">]</span> <span class="o">==</span> <span class="n">PngImagePlugin</span><span class="o">.</span><span class="n">_MAGIC</span><span class="p">:</span>
<span class="c1"># png frame</span>
<span class="n">im</span> <span class="o">=</span> <span class="n">PngImagePlugin</span><span class="o">.</span><span class="n">PngImageFile</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">buf</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># XOR + AND mask bmp frame</span>
<span class="n">im</span> <span class="o">=</span> <span class="n">BmpImagePlugin</span><span class="o">.</span><span class="n">DibImageFile</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">buf</span><span class="p">)</span>
<span class="n">Image</span><span class="o">.</span><span class="n">_decompression_bomb_check</span><span class="p">(</span><span class="n">im</span><span class="o">.</span><span class="n">size</span><span class="p">)</span>
<span class="c1"># change tile dimension to only encompass XOR image</span>
<span class="n">im</span><span class="o">.</span><span class="n">_size</span> <span class="o">=</span> <span class="p">(</span><span class="n">im</span><span class="o">.</span><span class="n">size</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="nb">int</span><span class="p">(</span><span class="n">im</span><span class="o">.</span><span class="n">size</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">/</span> <span class="mi">2</span><span class="p">))</span>
<span class="n">d</span><span class="p">,</span> <span class="n">e</span><span class="p">,</span> <span class="n">o</span><span class="p">,</span> <span class="n">a</span> <span class="o">=</span> <span class="n">im</span><span class="o">.</span><span class="n">tile</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">im</span><span class="o">.</span><span class="n">tile</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">d</span><span class="p">,</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="o">+</span> <span class="n">im</span><span class="o">.</span><span class="n">size</span><span class="p">,</span> <span class="n">o</span><span class="p">,</span> <span class="n">a</span>
<span class="c1"># figure out where AND mask image starts</span>
<span class="n">mode</span> <span class="o">=</span> <span class="n">a</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">bpp</span> <span class="o">=</span> <span class="mi">8</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="n">BmpImagePlugin</span><span class="o">.</span><span class="n">BIT2MODE</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="n">mode</span> <span class="o">==</span> <span class="n">v</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
<span class="n">bpp</span> <span class="o">=</span> <span class="n">k</span>
<span class="k">break</span>
<span class="k">if</span> <span class="mi">32</span> <span class="o">==</span> <span class="n">bpp</span><span class="p">:</span>
<span class="c1"># 32-bit color depth icon image allows semitransparent areas</span>
<span class="c1"># PIL's DIB format ignores transparency bits, recover them.</span>
<span class="c1"># The DIB is packed in BGRX byte order where X is the alpha</span>
<span class="c1"># channel.</span>
<span class="c1"># Back up to start of bmp data</span>
<span class="bp">self</span><span class="o">.</span><span class="n">buf</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="n">o</span><span class="p">)</span>
<span class="c1"># extract every 4th byte (eg. 3,7,11,15,...)</span>
<span class="n">alpha_bytes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">buf</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">im</span><span class="o">.</span><span class="n">size</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">*</span> <span class="n">im</span><span class="o">.</span><span class="n">size</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">*</span> <span class="mi">4</span><span class="p">)[</span><span class="mi">3</span><span class="p">::</span><span class="mi">4</span><span class="p">]</span>
<span class="c1"># convert to an 8bpp grayscale image</span>
<span class="n">mask</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">frombuffer</span><span class="p">(</span>
<span class="s1">'L'</span><span class="p">,</span> <span class="c1"># 8bpp</span>
<span class="n">im</span><span class="o">.</span><span class="n">size</span><span class="p">,</span> <span class="c1"># (w, h)</span>
<span class="n">alpha_bytes</span><span class="p">,</span> <span class="c1"># source chars</span>
<span class="s1">'raw'</span><span class="p">,</span> <span class="c1"># raw decoder</span>
<span class="p">(</span><span class="s1">'L'</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span> <span class="c1"># 8bpp inverted, unpadded, reversed</span>
<span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># get AND image from end of bitmap</span>
<span class="n">w</span> <span class="o">=</span> <span class="n">im</span><span class="o">.</span><span class="n">size</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="p">(</span><span class="n">w</span> <span class="o">%</span> <span class="mi">32</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="c1"># bitmap row data is aligned to word boundaries</span>
<span class="n">w</span> <span class="o">+=</span> <span class="mi">32</span> <span class="o">-</span> <span class="p">(</span><span class="n">im</span><span class="o">.</span><span class="n">size</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">%</span> <span class="mi">32</span><span class="p">)</span>
<span class="c1"># the total mask data is</span>
<span class="c1"># padded row size * height / bits per char</span>
<span class="n">and_mask_offset</span> <span class="o">=</span> <span class="n">o</span> <span class="o">+</span> <span class="nb">int</span><span class="p">(</span><span class="n">im</span><span class="o">.</span><span class="n">size</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">*</span> <span class="n">im</span><span class="o">.</span><span class="n">size</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">*</span>
<span class="p">(</span><span class="n">bpp</span> <span class="o">/</span> <span class="mf">8.0</span><span class="p">))</span>
<span class="n">total_bytes</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">im</span><span class="o">.</span><span class="n">size</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="o">/</span> <span class="mi">8</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">buf</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="n">and_mask_offset</span><span class="p">)</span>
<span class="n">mask_data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">buf</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">total_bytes</span><span class="p">)</span>
<span class="c1"># convert raw data to image</span>
<span class="n">mask</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">frombuffer</span><span class="p">(</span>
<span class="s1">'1'</span><span class="p">,</span> <span class="c1"># 1 bpp</span>
<span class="n">im</span><span class="o">.</span><span class="n">size</span><span class="p">,</span> <span class="c1"># (w, h)</span>
<span class="n">mask_data</span><span class="p">,</span> <span class="c1"># source chars</span>
<span class="s1">'raw'</span><span class="p">,</span> <span class="c1"># raw decoder</span>
<span class="p">(</span><span class="s1">'1;I'</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">w</span><span class="o">/</span><span class="mi">8</span><span class="p">),</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span> <span class="c1"># 1bpp inverted, padded, reversed</span>
<span class="p">)</span>
<span class="c1"># now we have two images, im is XOR image and mask is AND image</span>
<span class="c1"># apply mask image as alpha channel</span>
<span class="n">im</span> <span class="o">=</span> <span class="n">im</span><span class="o">.</span><span class="n">convert</span><span class="p">(</span><span class="s1">'RGBA'</span><span class="p">)</span>
<span class="n">im</span><span class="o">.</span><span class="n">putalpha</span><span class="p">(</span><span class="n">mask</span><span class="p">)</span>
<span class="k">return</span> <span class="n">im</span></div></div>
<span class="c1">##</span>
<span class="c1"># Image plugin for Windows Icon files.</span>
<div class="viewcode-block" id="IcoImageFile"><a class="viewcode-back" href="../../reference/plugins.html#PIL.IcoImagePlugin.IcoImageFile">[docs]</a><span class="k">class</span> <span class="nc">IcoImageFile</span><span class="p">(</span><span class="n">ImageFile</span><span class="o">.</span><span class="n">ImageFile</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> PIL read-only image support for Microsoft Windows .ico files.</span>
<span class="sd"> By default the largest resolution image in the file will be loaded. This</span>
<span class="sd"> can be changed by altering the 'size' attribute before calling 'load'.</span>
<span class="sd"> The info dictionary has a key 'sizes' that is a list of the sizes available</span>
<span class="sd"> in the icon file.</span>
<span class="sd"> Handles classic, XP and Vista icon formats.</span>
<span class="sd"> This plugin is a refactored version of Win32IconImagePlugin by Bryan Davis</span>
<span class="sd"> <casadebender@gmail.com>.</span>
<span class="sd"> https://code.google.com/archive/p/casadebender/wikis/Win32IconImagePlugin.wiki</span>
<span class="sd"> """</span>
<span class="nb">format</span> <span class="o">=</span> <span class="s2">"ICO"</span>
<span class="n">format_description</span> <span class="o">=</span> <span class="s2">"Windows Icon"</span>
<span class="k">def</span> <span class="nf">_open</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">ico</span> <span class="o">=</span> <span class="n">IcoFile</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fp</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">[</span><span class="s1">'sizes'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ico</span><span class="o">.</span><span class="n">sizes</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">size</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ico</span><span class="o">.</span><span class="n">entry</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="s1">'dim'</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">size</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_size</span>
<span class="nd">@size</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">size</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">if</span> <span class="n">value</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">[</span><span class="s1">'sizes'</span><span class="p">]:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s2">"This is not one of the allowed sizes of this image"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_size</span> <span class="o">=</span> <span class="n">value</span>
<div class="viewcode-block" id="IcoImageFile.load"><a class="viewcode-back" href="../../reference/plugins.html#PIL.IcoImagePlugin.IcoImageFile.load">[docs]</a> <span class="k">def</span> <span class="nf">load</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">im</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ico</span><span class="o">.</span><span class="n">getimage</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">size</span><span class="p">)</span>
<span class="c1"># if tile is PNG, it won't really be loaded yet</span>
<span class="n">im</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">im</span> <span class="o">=</span> <span class="n">im</span><span class="o">.</span><span class="n">im</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mode</span> <span class="o">=</span> <span class="n">im</span><span class="o">.</span><span class="n">mode</span>
<span class="bp">self</span><span class="o">.</span><span class="n">size</span> <span class="o">=</span> <span class="n">im</span><span class="o">.</span><span class="n">size</span></div>
<div class="viewcode-block" id="IcoImageFile.load_seek"><a class="viewcode-back" href="../../reference/plugins.html#PIL.IcoImagePlugin.IcoImageFile.load_seek">[docs]</a> <span class="k">def</span> <span class="nf">load_seek</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Flag the ImageFile.Parser so that it</span>
<span class="c1"># just does all the decode at the end.</span>
<span class="k">pass</span></div></div>
<span class="c1">#</span>
<span class="c1"># --------------------------------------------------------------------</span>
<span class="n">Image</span><span class="o">.</span><span class="n">register_open</span><span class="p">(</span><span class="n">IcoImageFile</span><span class="o">.</span><span class="n">format</span><span class="p">,</span> <span class="n">IcoImageFile</span><span class="p">,</span> <span class="n">_accept</span><span class="p">)</span>
<span class="n">Image</span><span class="o">.</span><span class="n">register_save</span><span class="p">(</span><span class="n">IcoImageFile</span><span class="o">.</span><span class="n">format</span><span class="p">,</span> <span class="n">_save</span><span class="p">)</span>
<span class="n">Image</span><span class="o">.</span><span class="n">register_extension</span><span class="p">(</span><span class="n">IcoImageFile</span><span class="o">.</span><span class="n">format</span><span class="p">,</span> <span class="s2">".ico"</span><span class="p">)</span>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 1995-2011 Fredrik Lundh, 2010-2018 Alex Clark and Contributors
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
0ef4ecbd01ec307dcbe15809d095d7c7
>
files
>
24
