{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Image Format vs Fossil Repository Size\n",
    "\n",
    "## Prerequisites\n",
    "\n",
    "`pip install jupyter matplotlib pandas wand`\n",
    "\n",
    "\n",
    "## Running\n",
    "\n",
    "The next cell generates the test repositories. This takes about half a minute due to the time needed for all the file I/O.\n",
    "\n",
    "The one after that produces the bar chart from the collected data.\n",
    "\n",
    "\n",
    "## Discussion\n",
    "\n",
    "That is kept in [a separate document](image-format-vs-repo-size.md) so we can share that document with Fossil's Markdown renderer."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [],
   "source": [
    "import os\n",
    "import random\n",
    "import time\n",
    "\n",
    "from wand.color import Color\n",
    "from wand.drawing import Drawing\n",
    "from wand.image import Image\n",
    "\n",
    "import pandas as pd\n",
    "\n",
    "size = 256\n",
    "iterations = 10\n",
    "\n",
    "repo_sizes = []\n",
    "\n",
    "formats = ['JPEG', 'BMP', 'TIFF', 'PNG']\n",
    "for f in formats:\n",
    "    ext = f.lower()\n",
    "    tdir = 'test' + '-' + ext\n",
    "    repo = tdir + '.fossil'\n",
    "    ifn = 'test.' + ext\n",
    "    ipath = os.path.join(tdir, ifn)\n",
    "    rs = []\n",
    "    \n",
    "    def add_repo_size():\n",
    "        rs.append(os.path.getsize(repo) / 1024.0 / 1024.0)\n",
    "\n",
    "    try:\n",
    "        # Create test repo\n",
    "        if not os.path.exists(tdir): os.mkdir(tdir, 0700)\n",
    "        cmd = 'cd {0} ; fossil init ../{1} && fossil open ../{1} && fossil set binary-glob \"*.{2}\"'.format(\n",
    "            tdir, repo, ext\n",
    "        )\n",
    "        if os.system(cmd) != 0:\n",
    "            raise RuntimeError('Failed to create test repo ' + repo)\n",
    "        add_repo_size()\n",
    "\n",
    "        # Create test image and add it to the repo\n",
    "        img = Image(width = size, height = size, depth = 8,\n",
    "                    background = 'white')\n",
    "        img.alpha_channel = 'remove'\n",
    "        img.evaluate('gaussiannoise', 1.0)\n",
    "        img.save(filename = ipath)\n",
    "        cmd = 'cd {0} ; fossil add {1} && fossil ci -m \"initial\"'.format(\n",
    "            tdir, ifn\n",
    "        )\n",
    "        if os.system(cmd) != 0:\n",
    "            raise RuntimeError('Failed to add ' + ifn + ' to test repo')\n",
    "        #print \"Created test repo \" + repo + \" for format \" + f + \".\"\n",
    "        add_repo_size()\n",
    "\n",
    "        # Change a random pixel to a random RGB value and check it in\n",
    "        # $iterations times.\n",
    "        for i in range(iterations):\n",
    "            with Drawing() as draw:\n",
    "                x = random.randint(0, size - 1)\n",
    "                y = random.randint(0, size - 1)\n",
    "\n",
    "                r = random.randint(0, 255)\n",
    "                g = random.randint(0, 255)\n",
    "                b = random.randint(0, 255)\n",
    "                \n",
    "                draw.fill_color = Color('rgb({0},{1},{2})'.format(\n",
    "                    r, g, b\n",
    "                ))\n",
    "                draw.color(x, y, 'point')\n",
    "                draw(img)\n",
    "                img.save(filename = ipath)\n",
    "                \n",
    "                # ImageMagick appears to use some kind of asynchronous\n",
    "                # file saving mechanism, so we have to give it time to\n",
    "                # complete.\n",
    "                time.sleep(1.0)\n",
    "  \n",
    "                cmd = 'cd {0} ; fossil ci -m \"change {1} step {2}\"'.format(\n",
    "                    tdir, f, i\n",
    "                )\n",
    "                if os.system(cmd) != 0:\n",
    "                    raise RuntimeError('Failed to change ' + f + ' image, step ' + str(i))\n",
    "                add_repo_size()\n",
    "                \n",
    "        # Repo complete for this format\n",
    "        repo_sizes.append(pd.Series(rs, name=f))\n",
    "\n",
    "    finally:\n",
    "        if os.path.exists(ipath): os.remove(ipath)\n",
    "        if os.path.exists(tdir):\n",
    "            os.system('cd ' + tdir + ' ; fossil close -f')\n",
    "            os.rmdir(tdir)\n",
    "        if os.path.exists(repo): os.remove(repo)    "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "%config InlineBackend.figure_formats = ['svg']\n",
    "\n",
    "import matplotlib as mpl\n",
    "import matplotlib.pyplot as plt\n",
    "\n",
    "data = pd.concat(repo_sizes, axis=1)\n",
    "mpl.rcParams['figure.figsize'] = (7, 4)\n",
    "plt.rcParams['axes.facecolor'] = 'white'\n",
    "data.plot(kind = 'bar', colormap = 'coolwarm',\n",
    "          grid = False, width = 0.8,\n",
    "          edgecolor = 'white', linewidth = 2)\n",
    "plt.savefig('image-format-vs-repo-size.svg')\n",
    "plt.show()"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 2",
   "language": "python",
   "name": "python2"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 2
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython2",
   "version": "2.7.15"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}
