Distorted Android

///////////////////////////////////////////////////////////////////////////////////////////////////

// Copyright 2016 Leszek Koltunski                                                               //

//                                                                                               //

// This file is part of Distorted.                                                               //

//                                                                                               //

// Distorted is free software: you can redistribute it and/or modify                             //

// it under the terms of the GNU General Public License as published by                          //

// the Free Software Foundation, either version 2 of the License, or                             //

// (at your option) any later version.                                                           //

//                                                                                               //

// Distorted is distributed in the hope that it will be useful,                                  //

// but WITHOUT ANY WARRANTY; without even the implied warranty of                                //

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                                 //

// GNU General Public License for more details.                                                  //

//                                                                                               //

// You should have received a copy of the GNU General Public License                             //

// along with Distorted.  If not, see <http://www.gnu.org/licenses/>.                            //

///////////////////////////////////////////////////////////////////////////////////////////////////

package org.distorted.library;

import java.util.ArrayList;

import java.util.HashMap;

import android.opengl.GLES20;

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Class which represents a Node in a Tree of DistortedObjects.

 *  

 * Having organized a set of DistortedObjects into a Tree, we can then render any Node to any Framebuffer.

 * That recursively renders the Object held in the Node and all its children, along with whatever effects

 * each one of them has. 

 */

public class DistortedObjectTree

  {

  private static HashMap<ArrayList<Long>,NodeData> mMapNodeID = new HashMap<>();

  private static long mNextNodeID =0;

  private GridObject mGrid;

  private DistortedEffectQueues mQueues;

  private DistortedTexture mTexture;

  private NodeData mData;

  private DistortedObjectTree mParent;

  private ArrayList<DistortedObjectTree> mChildren;

  private int[] mNumChildren;  // ==mChildren.length(), but we only create mChildren if the first one gets added

  private class NodeData

    {

    long ID;

    int numPointingNodes;

    DistortedFramebuffer mDF;

    boolean mRendered;

    NodeData(long id)

      {

      ID              = id;

      numPointingNodes= 1;

      mDF             = null;

      mRendered       = false;

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  static void release()

    {

    mNextNodeID = 0;

    mMapNodeID.clear();

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void markRecursive()

    {

    mData.mRendered = false;

    synchronized(this)

      {

      for(int i=0; i<mNumChildren[0]; i++) mChildren.get(i).markRecursive();

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void drawRecursive(long currTime, DistortedFramebuffer df)

    {

    if( mNumChildren[0]<=0 )

      {

      GLES20.glBindTexture(GLES20.GL_TEXTURE_2D, mTexture.mTextureDataH[0]);

      }

    else

      {

      if( !mData.mRendered )

        {

        mData.mRendered = true;

        mData.mDF.setAsOutput();

        GLES20.glClearColor(0.0f, 0.0f, 0.0f, 0.0f);

        GLES20.glClear( GLES20.GL_DEPTH_BUFFER_BIT | GLES20.GL_COLOR_BUFFER_BIT);

        if( mTexture.mBitmapSet[0] )

          {

          GLES20.glBindTexture(GLES20.GL_TEXTURE_2D, mTexture.mTextureDataH[0]);

          mQueues.drawNoEffectsPriv(mTexture, mGrid, mData.mDF);

          }

        synchronized(this)

          {

          for(int i=0; i<mNumChildren[0]; i++)

            {

            mChildren.get(i).drawRecursive(currTime, mData.mDF);

            }

          }

        }

      df.setAsOutput();

      mData.mDF.setAsInput();

      }

    mQueues.drawPriv(currTime, mTexture, mGrid, df);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

// tree isomorphism

  private void RecomputeNodeID(ArrayList<Long> prev)

    {

    ArrayList<Long> curr = generateIDList();

    if( mParent==null )

      {

      adjustNodeData(prev,curr);

      }

    else

      {

      ArrayList<Long> parentPrev = mParent.generateIDList();

      adjustNodeData(prev,curr);

      mParent.RecomputeNodeID(parentPrev);

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private ArrayList<Long> generateIDList()

    {

    ArrayList<Long> ret = new ArrayList<>();

    ret.add( mNumChildren[0]>0 ? mTexture.getBitmapID() : mTexture.getID() );

    DistortedObjectTree node;

    for(int i=0; i<mNumChildren[0]; i++)

      {

      node = mChildren.get(i);

      ret.add(node.mData.ID);

      }

    return ret;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void adjustNodeData(ArrayList<Long> oldList, ArrayList<Long> newList)

    {

    boolean otherNodesPoint = (mData.numPointingNodes>1);

    if( otherNodesPoint ) mData.numPointingNodes--;

    else                  mMapNodeID.remove(oldList);

    NodeData newData = mMapNodeID.get(newList);

    if( newData==null )

      {

      if( otherNodesPoint )  mData = new NodeData(++mNextNodeID);

      else                   mData.ID = ++mNextNodeID;  // numPointingNodes must be 1 already

      if( newList.size()>1 )

        {

        if( mData.mDF==null )

          mData.mDF = new DistortedFramebuffer(mTexture.getWidth(), mTexture.getHeight());

        }

      else

        {

        if( mData.mDF!=null )

          {

          mData.mDF.markForDeletion();

          mData.mDF = null;

          }

        else

          {

          android.util.Log.e("DistortedObjectTree", "adjustNodeData: impossible situation??");

          }

        }

      mMapNodeID.put(newList, mData);

      }

    else

      {

      newData.numPointingNodes++;

      mData = newData;

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////  

// this will be called on startup and every time OpenGL context has been lost

// also call this from the constructor if the OpenGL context has been created already.

  static void reset()

    {

    NodeData tmp;   

    for(ArrayList<Long> key: mMapNodeID.keySet())

      {

      tmp = mMapNodeID.get(key);

      if( tmp.mDF != null )

        {

    	  tmp.mDF.reset();

        tmp.mRendered  = false;

        }

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

// Debug - print all the Node IDs

/*

  void debug(int depth)

    {

    String tmp="";

    int i;

    for(i=0; i<depth; i++) tmp +="   ";

    tmp += (""+mData.ID);

    android.util.Log.e("node", tmp);

    for(i=0; i<mNumChildren[0]; i++)

      mChildren.get(i).debug(depth+1);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

// Debug - print contents of the HashMap

  static void debugMap()

    {

    NodeData tmp;

    for(ArrayList<Long> key: mMapNodeID.keySet())

      {

      tmp = mMapNodeID.get(key);

      android.util.Log.e("NODE", "key="+key+" NodeID: "+tmp.ID);

      }

    }

*/

///////////////////////////////////////////////////////////////////////////////////////////////////

// PUBLIC API

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Constructs new Node of the Tree.

 *     

 * @param texture DistortedTexture to put into the new Node.

 * @param queues  DistortedEffectQueues to put into the new Node.

 * @param grid GridObject to put into the new Node.

 */

  public DistortedObjectTree(DistortedTexture texture, DistortedEffectQueues queues, GridObject grid)

    {

    mTexture= texture;

    mQueues = queues;

    mGrid   = grid;

    mParent = null;

    mChildren = null;

    mNumChildren = new int[1];

    mNumChildren[0] = 0;

    ArrayList<Long> list = new ArrayList<>();

    list.add(queues.getID());   // TODO: this should depend on both texture and queues! Maybe even on grid as well

    mData = mMapNodeID.get(list);

    if( mData!=null )

      {

      mData.numPointingNodes++;

      }

    else

      {

      mData = new NodeData(++mNextNodeID);   

      mMapNodeID.put(list, mData);  

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////  

/**

 * Copy-constructs new Node of the Tree from another Node.

 *     

 * @param node The DistortedObjectTree to copy data from.

 * @param flags bit field composed of a subset of the following:

 *        {@link Distorted#CLONE_BITMAP},  {@link Distorted#CLONE_MATRIX}, {@link Distorted#CLONE_VERTEX},

 *        {@link Distorted#CLONE_FRAGMENT} and {@link Distorted#CLONE_CHILDREN}.

 *        For example flags = CLONE_BITMAP | CLONE_CHILDREN.

 */

  public DistortedObjectTree(DistortedObjectTree node, int flags)

    {

    mParent = null;

    mTexture= new DistortedTexture(node.mTexture,flags);

    mQueues = new DistortedEffectQueues(node.mQueues, flags);

    mGrid   = node.mGrid;

    if( (flags & Distorted.CLONE_CHILDREN) != 0 )

      {

      mChildren = node.mChildren;

      mNumChildren = node.mNumChildren;

      }

    else

      {

      mChildren = null;

      mNumChildren = new int[1];

      mNumChildren[0] = 0;

      }

    ArrayList<Long> list = generateIDList();

    mData = mMapNodeID.get(list);

    if( mData!=null )

      {

      mData.numPointingNodes++;

      }

    else

      {

      mData = new NodeData(++mNextNodeID);   

      mMapNodeID.put(list, mData);

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Adds a new child to the last position in the list of our Node's children.

 * 

 * @param node The new Node to add.

 */

  public synchronized void attach(DistortedObjectTree node)

    {

    ArrayList<Long> prev = generateIDList(); 

    if( mChildren==null ) mChildren = new ArrayList<>(2);

    node.mParent = this;

    mChildren.add(node);

    mNumChildren[0]++;

    RecomputeNodeID(prev);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Adds a new child to the last position in the list of our Node's children.

 * 

 * @param texture DistortedTexture to initialize our child Node with.

 * @param queues DistortedEffectQueues to initialize our child Node with.

 * @param grid GridObject to initialize our child Node with.

 * @return the newly constructed child Node, or null if we couldn't allocate resources.

 */

  public synchronized DistortedObjectTree attach(DistortedTexture texture, DistortedEffectQueues queues, GridObject grid)

    {

    ArrayList<Long> prev = generateIDList(); 

    if( mChildren==null ) mChildren = new ArrayList<>(2);

    DistortedObjectTree node = new DistortedObjectTree(texture,queues,grid);

    node.mParent = this;

    mChildren.add(node);

    mNumChildren[0]++;

    RecomputeNodeID(prev);

    return node;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Removes the first occurrence of a specified child from the list of children of our Node.

 * 

 * @param node The Node to remove.

 * @return <code>true</code> if the child was successfully removed.

 */

  public synchronized boolean detach(DistortedObjectTree node)

    {

    if( mNumChildren[0]>0 )

      {

      ArrayList<Long> prev = generateIDList();  

      if( mChildren.remove(node) )

        {

        node.mParent = null;  

        mNumChildren[0]--;

        RecomputeNodeID(prev);

        return true;

        }

      }

    return false;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Removes the first occurrence of a specified child from the list of children of our Node.

 * 

 * @param queues DistortedEffectQueues to remove.

 * @return <code>true</code> if the child was successfully removed.

 */

  public synchronized boolean detach(DistortedEffectQueues queues)

    {

    long id = queues.getID();

    DistortedObjectTree node;

    for(int i=0; i<mNumChildren[0]; i++)

      {

      node = mChildren.get(i);

      if( node.mQueues.getID()==id )

        {

        ArrayList<Long> prev = generateIDList();   

        node.mParent = null;  

        mChildren.remove(i);

        mNumChildren[0]--;

        RecomputeNodeID(prev);

        return true;

        }

      }

    return false;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Removes all children Nodes.

 */

  public synchronized void detachAll()

    {

    for(int i=0; i<mNumChildren[0]; i++)

      {

      mChildren.get(i).mParent = null;

      }

    if( mNumChildren[0]>0 )

      {

      ArrayList<Long> prev = generateIDList();  

      mNumChildren[0] = 0;

      mChildren.clear();

      RecomputeNodeID(prev);

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Draws the Node, and all its children, to the default framebuffer 0 (i.e. the screen).

 *   

 * @param currTime Current time, in milliseconds.

 */

  public void draw(long currTime)

    {  

    GLES20.glBindFramebuffer(GLES20.GL_FRAMEBUFFER, 0);

    markRecursive();

    drawRecursive(currTime,Distorted.mFramebuffer);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Draws the Node, and all its children, to the Framebuffer passed.

 *

 * @param currTime Current time, in milliseconds.

 * @param df       Framebuffer to render this to.

 */

  public void draw(long currTime, DistortedFramebuffer df)

    {

    df.setAsOutput();

    markRecursive();

    drawRecursive(currTime,df);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Returns the DistortedEffectQueues object that's in the Node.

 * 

 * @return The DistortedEffectQueues contained in the Node.

 */

  public DistortedEffectQueues getQueues()

    {

    return mQueues;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Returns the DistortedTexture object that's in the Node.

 *

 * @return The DistortedTexture contained in the Node.

 */

  public DistortedTexture getTexture()

    {

    return mTexture;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  }