Merge pull request #471 from naveen521kk/pango-text

Add Pango Renderer

Author: leotrs

.github/manimdependency.json

@@ -1,5 +1,6 @@
 {
     "windows": {
-        "ffmpeg": "https://www.gyan.dev/ffmpeg/builds/packages/ffmpeg-4.3.1-2020-09-21-full_build.zip"
+        "ffmpeg": "https://www.gyan.dev/ffmpeg/builds/packages/ffmpeg-4.3.1-2020-09-21-full_build.zip",
+        "pango": "v0.1.0"
     }
-}
+}

.github/workflows/ci.yml

@@ -60,6 +60,10 @@ jobs:
           brew cask install basictex
           eval "$(/usr/libexec/path_helper -s)"
           sudo tlmgr update --self
+          brew install pkg-config
+          brew install libffi
+          brew install pango
+          brew install glib
           sudo tlmgr install standalone preview doublestroke relsize fundus-calligra wasysym physics dvisvgm.x86_64-darwin dvisvgm rsfs wasy cm-super
           echo "::add-path::$HOME/.poetry/bin"
           echo "::set-env name=PATH::$PATH"
@@ -76,6 +80,7 @@ jobs:
         if: runner.os == 'Windows' && steps.cache-windows.outputs.cache-hit != 'true'
         run: |
           $ffmpegUrl = python -c "import json;print(json.load(open('.github/manimdependency.json'))['windows']['ffmpeg'])"
+          $pangoVersion = python -c "import json;print(json.load(open('.github/manimdependency.json'))['windows']['pango'])"
           $OriPath = $env:PATH
           echo "Install Tinytex"
           Invoke-WebRequest "https://ci.appveyor.com/api/projects/yihui/tinytex/artifacts/TinyTeX.zip?job=image:%20Visual%20Studio%202019" -O "$($env:TMP)\TinyTex.zip"
@@ -88,12 +93,16 @@ jobs:
           Invoke-WebRequest "$ffmpegUrl" -O "$($env:TMP)\ffmpeg.zip"
           7z x "$($env:TMP)\ffmpeg.zip" -o"$($PWD)\ManimCache"
           Move-Item "ManimCache\ffmpeg-*" "ManimCache\FFmpeg"
+          Invoke-WebRequest "https://github.com/ManimCommunity/manim-windows/releases/download/$($pangoVersion)/pango-windows-binaires-x64.zip" -O "$($env:TMP)\Pango.zip"
+          mkdir "$($PWD)\ManimCache\Pango"
+          7z x "$($env:TMP)\Pango.zip" -o"$($PWD)\ManimCache\Pango"
 
       - name: Add Windows dependecies to path
         if: runner.os == 'Windows'
         run: |
           $env:Path += ";" + "$($PWD)\ManimCache\FFmpeg\bin"
           $env:Path += ";" + "$($PWD)\ManimCache\LatexWindows\TinyTeX\bin\win32"
+          $env:Path += ";" + "$($PWD)\ManimCache\Pango\pango"          
           $env:Path = "$env:USERPROFILE\.poetry\bin;$($env:PATH)"
           echo "::set-env name=Path::$env:Path"
 

docs/source/changelog.rst

@@ -66,6 +66,7 @@ Mobjects, Scenes, and Animations
 #. :code:`VGroup` now supports printing the class names of contained mobjects and :code:`VDict` supports printing the internal dict of mobjects
 #. :code:`Scene` now renders when :code:`Scene.render()` is called rather than upon instantiation.
 #. :code:`ValueTracker` now supports increment using the `+=` operator (in addition to the already existing `increment_value` method)
+#. Add :class:`PangoText` for rendering texts using Pango.
 
 
 Documentation

docs/source/conf.py

@@ -11,6 +11,7 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
 import os
+import subprocess
 import sys
 from distutils.sysconfig import get_python_lib
 
@@ -19,8 +20,12 @@
 
 
 if os.environ.get("READTHEDOCS") == "True":
-    # we need to add ffmpeg to the path
     site_path = get_python_lib()
+    # bindings for pangocffi, cairocffi, pangocairocffi need to be generated
+    subprocess.run(["python", "pangocffi/ffi_build.py"], cwd=site_path)
+    subprocess.run(["python", "cairocffi/ffi_build.py"], cwd=site_path)
+    subprocess.run(["python", "pangocairocffi/ffi_build.py"], cwd=site_path)
+    # we need to add ffmpeg to the path
     ffmpeg_path = os.path.join(site_path, "imageio_ffmpeg", "binaries")
     # the included binary is named ffmpeg-linux..., create a symlink
     [ffmpeg_bin] = [

docs/source/installation/mac.rst

@@ -15,6 +15,16 @@ To install cairo:
 
    brew install cairo
 
+To install Pango and it dependencies:
+
+.. code-block:: bash
+
+   brew install pkg-config
+   brew install libffi
+   brew install pango
+   brew install glib
+
+
 To install ffmpeg:
 
 .. code-block:: bash

docs/source/installation/win.rst

@@ -18,6 +18,32 @@ You can install manim very easily using chocolatey, by typing the following comm
 
 And then you can skip all the other steps and move to installing :ref:`latex-installation`.
 
+Pango Installation
+******************
+
+These steps would get you `libpango-1.0-0.dll` to your ``PATH`` along 
+with other dependencies. You may probably have them before itself if 
+you have installed `GTK <https://www.gtk.org/>`_ or any ``GTK`` 
+based app like emacs. If you have it you can just add it to your 
+path and skip these steps.
+
+1. Go to `Release Page
+   <https://github.com/ManimCommunity/manim-windows/releases/latest>`_ 
+   and download the one according to your PC architechture.
+
+   .. important:: Please download the ``zip`` file for architechture of python installed.
+                  It is possible to have installed ``x86`` python installed on ``x64`` PC.
+
+2. Extract the zip file using File Explorer or 7z to the loaction you want to install.
+
+   .. code-block:: bash
+      
+      7z x pango-windows-binaires-x64.zip -oC:\Pango
+
+3. Finally, add it `PATH variable
+   <https://www.computerhope.com/issues/ch000549.htm>`_.
+
+
 FFmpeg installation
 *******************
 

example_scenes/pangoText.py

@@ -0,0 +1,41 @@
+from manim import *
+
+
+class PangoRendering(Scene):
+    CONFIG = {"font": "sans-serif"}
+
+    def construct(self):
+        morning = PangoText("வணக்கம்", font="sans-serif")
+        self.play(Write(morning))
+        self.wait(3)
+        self.clear()
+        chin = PangoText(
+            "見 角 言 谷  辛 辰 辵 邑 酉 釆 里!", t2c={"見 角 言": BLUE}
+        )  # works same as ``Text``.
+        self.play(Write(chin))
+        self.wait(2)
+        mess = PangoText("Multi-Language", style=BOLD)
+        self.play(Transform(chin, mess))
+        self.wait(2)
+        self.clear()
+        russ = PangoText("Здравствуйте मस नम म ", font="sans-serif")
+        self.play(Write(russ))
+        self.wait(2)
+        self.clear()
+        hin = PangoText("नमस्ते", font="sans-serif")
+        self.play(Write(hin))
+        self.wait(2)
+        self.clear()
+        arb = PangoText("صباح الخير  ", font="sans-serif")
+        self.play(Write(arb))
+        self.wait(3)
+        self.clear()
+        arb = PangoText(
+            "صباح الخير \n تشرفت بمقابلتك", font="sans-serif"
+        )  # don't mix RTL and LTR languages nothing shows up then ;-)
+        self.play(Write(arb))
+        self.wait(3)
+        self.clear()
+        jap = PangoText("臂猿「黛比」帶著孩子", font="sans-serif")
+        self.play(Write(jap))
+        self.wait(3)

manim/constants.py

@@ -29,11 +29,23 @@ class MyText(Text):
    There are no scenes inside that module
 """
 
-# Cairo stuff
+# Cairo and Pango stuff
 NORMAL = "NORMAL"
 ITALIC = "ITALIC"
 OBLIQUE = "OBLIQUE"
 BOLD = "BOLD"
+# Only for Pango from below
+THIN = "THIN"
+ULTRALIGHT = "ULTRALIGHT"
+LIGHT = "LIGHT"
+SEMILIGHT = "SEMILIGHT"
+BOOK = "BOOK"
+MEDIUM = "MEDIUM"
+SEMIBOLD = "SEMIBOLD"
+ULTRABOLD = "ULTRABOLD"
+HEAVY = "HEAVY"
+ULTRAHEAVY = "ULTRAHEAVY"
+
 
 # Geometry: directions
 ORIGIN = np.array((0.0, 0.0, 0.0))