Translation
===========

This example shows how to translate Pure Data files.
For example, from the `.pd` format to other formats such as

* `JSON <https://www.json.org/json-en.html>`_
* `Pickle <https://docs.python.org/3/library/pickle.html#module-pickle>`_
* `XML <https://www.w3.org/standards/xml>`_


.. note::
 
  There is a convenience script for this purpose, see ``scripts/translate.py``

  The code to run is::
    
    python translate.py -t json -f pd -i tests/hello-world.pd -o tests/hello-world.json


The Pd file
-----------

The original Pure Data file looks like this::

  #N canvas 47 51 450 300 12;
  #X obj 37 37 loadbang;
  #X msg 37 61 hello world;
  #X obj 37 85 print;
  #X connect 0 0 1 0;
  #X connect 1 0 2 0;


JSON output
-----------

The result is something like this in JSON


.. code-block:: json

  {
      "patchname": "hello-world.pd",
      "encoding": "utf-8",
      "__pdpy__": "PdPy",
      "root": {
          "__pdpy__": "Canvas",
          "isroot": true,
          "name": "hello-world.pd",
          "vis": 1,
          "screen": {
              "__pdpy__": "Point",
              "x": 47,
              "y": 51
          },
          "dimension": {
              "__pdpy__": "Size",
              "width": 450,
              "height": 300
          },
          "font": 12,
          "nodes": [
              {
                  "__pdpy__": "Object",
                  "id": 0,
                  "position": {
                      "__pdpy__": "Point",
                      "x": 37,
                      "y": 37
                  },
                  "className": "loadbang"
              },
              {
                  "__pdpy__": "Msg",
                  "id": 1,
                  "position": {
                      "__pdpy__": "Point",
                      "x": 37,
                      "y": 61
                  },
                  "className": "msg",
                  "targets": [
                      {
                          "__pdpy__": "Message",
                          "address": "outlet",
                          "message": [
                              "hello world"
                          ]
                      }
                  ]
              },
              {
                  "__pdpy__": "Object",
                  "id": 2,
                  "position": {
                      "__pdpy__": "Point",
                      "x": 37,
                      "y": 85
                  },
                  "className": "print"
              }
          ],
          "edges": [
              {
                  "__pdpy__": "Edge",
                  "source": {
                      "__pdpy__": "Iolet",
                      "id": "0",
                      "port": "0"
                  },
                  "sink": {
                      "__pdpy__": "Iolet",
                      "id": "1",
                      "port": "0"
                  }
              },
              {
                  "__pdpy__": "Edge",
                  "source": {
                      "__pdpy__": "Iolet",
                      "id": "1",
                      "port": "0"
                  },
                  "sink": {
                      "__pdpy__": "Iolet",
                      "id": "2",
                      "port": "0"
                  }
              }
          ]
      }
  }


XML output
----------


.. note::

  Run this to get XML::
  
    python translate.py -t xml -f pd -i tests/hello-world.pd -o tests/hello-world.xml 


The result is something like this


.. code-block:: xml

  <pdpy encoding="utf-8">
      <root pdpy="Canvas">
          <font>12</font>
          <name>hello-world.pd</name>
          <vis>1</vis>
          <isroot>True</isroot>
          <screen pdpy="Point">
              <x>47</x>
              <y>51</y>
          </screen>
          <dimension pdpy="Size">
              <width>450</width>
              <height>300</height>
          </dimension>
          <nodes>
              <loadbang pdpy="Object">
                  <id>0</id>
                  <position pdpy="Point">
                      <x>37</x>
                      <y>37</y>
                  </position>
                  <className>loadbang</className>
              </loadbang>
              <pdmessage>
                  <id>1</id>
                  <position pdpy="Point">
                      <x>37</x>
                      <y>61</y>
                  </position>
                  <pdmsg>
                      <address>outlet</address>
                      <message>hello world</message>
                  </pdmsg>
              </pdmessage>
              <print pdpy="Object">
                  <id>2</id>
                  <position pdpy="Point">
                      <x>37</x>
                      <y>85</y>
                  </position>
                  <className>print</className>
              </print>
          </nodes>
          <edges>
              <edge>
                  <source pdpy="Iolet">
                      <id>0</id>
                      <port>0</port>
                  </source>
                  <sink pdpy="Iolet">
                      <id>1</id>
                      <port>0</port>
                  </sink>
              </edge>
              <edge>
                  <source pdpy="Iolet">
                      <id>1</id>
                      <port>0</port>
                  </source>
                  <sink pdpy="Iolet">
                      <id>2</id>
                      <port>0</port>
                  </sink>
              </edge>
          </edges>
      </root>
  </pdpy>