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 android.opengl.GLES20;

import android.opengl.Matrix;

import java.util.Iterator;

import java.util.LinkedList;

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

/**

 * Class which represents a OpenGL Framebuffer object.

 * <p>

 * User is able to create either Framebuffers from objects already constructed outside

 * of the library (the first constructor; primary use case: the screen) or an offscreen

 * FBOs.

 * <p>

 * Keep all objects created in a static LinkedList. The point: we need to be able to mark

 * Framebuffers for deletion, and delete all marked objects later at a convenient time (that's

 * because we can only delete from a thread that holds the OpenGL context so here we provide a

 * framework where one is able to mark for deletion at any time and actual deletion takes place

 * on the next render).

 */

public class DistortedFramebuffer

  {

  private static final int FAILED_TO_CREATE = -1;

  private static final int NOT_CREATED_YET  = -2;

  private static final int DONT_CREATE      = -3;

  private static boolean mListMarked = false;

  private static LinkedList<DistortedFramebuffer> mList = new LinkedList<>();

  private int[] colorIds = new int[1];

  private int[] depthIds = new int[1];

  private int[] fboIds   = new int[1];

  private boolean mMarked;

  private boolean mDepthWanted;

  // Projection stuff

  private float mX, mY, mFOV;

  int mWidth,mHeight,mDepth;

  float mDistance;

  float[] mProjectionMatrix;

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

// Must be called from a thread holding OpenGL Context

  void createFBO()

    {

    if( colorIds[0]==NOT_CREATED_YET )

      {

      GLES20.glGenTextures(1, colorIds, 0);

      GLES20.glBindTexture(GLES20.GL_TEXTURE_2D, colorIds[0]);

      GLES20.glTexParameteri(GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_WRAP_S, GLES20.GL_REPEAT);

      GLES20.glTexParameteri(GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_WRAP_T, GLES20.GL_REPEAT);

      GLES20.glTexParameterf(GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_MIN_FILTER, GLES20.GL_NEAREST);

      GLES20.glTexParameterf(GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_MAG_FILTER, GLES20.GL_LINEAR);

      GLES20.glTexImage2D(GLES20.GL_TEXTURE_2D, 0, GLES20.GL_RGBA, mWidth, mHeight, 0, GLES20.GL_RGBA, GLES20.GL_UNSIGNED_BYTE, null);

      GLES20.glGenFramebuffers(1, fboIds, 0);

      GLES20.glBindFramebuffer(GLES20.GL_FRAMEBUFFER, fboIds[0]);

      GLES20.glFramebufferTexture2D(GLES20.GL_FRAMEBUFFER, GLES20.GL_COLOR_ATTACHMENT0, GLES20.GL_TEXTURE_2D, colorIds[0], 0);

      checkStatus("color");

      mList.add(this);

      }

    if(  mDepthWanted && depthIds[0]==NOT_CREATED_YET ) // we need to create a new DEPTH attachment

      {

      GLES20.glGenTextures(1, depthIds, 0);

      GLES20.glBindTexture(GLES20.GL_TEXTURE_2D, depthIds[0]);

      GLES20.glTexParameteri(GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_WRAP_S, GLES20.GL_REPEAT);

      GLES20.glTexParameteri(GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_WRAP_T, GLES20.GL_REPEAT);

      GLES20.glTexParameteri(GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_MIN_FILTER, GLES20.GL_NEAREST);

      GLES20.glTexParameteri(GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_MAG_FILTER, GLES20.GL_NEAREST);

      GLES20.glTexImage2D(GLES20.GL_TEXTURE_2D, 0, GLES20.GL_DEPTH_COMPONENT, mWidth, mHeight, 0, GLES20.GL_DEPTH_COMPONENT, GLES20.GL_UNSIGNED_SHORT, null);

      GLES20.glBindFramebuffer(GLES20.GL_FRAMEBUFFER, fboIds[0]);

      GLES20.glFramebufferTexture2D(GLES20.GL_FRAMEBUFFER, GLES20.GL_DEPTH_ATTACHMENT, GLES20.GL_TEXTURE_2D, depthIds[0], 0);

      checkStatus("depth");

      }

    if( !mDepthWanted && depthIds[0]!=NOT_CREATED_YET ) // we need to detach and destroy the DEPTH attachment.

      {

      GLES20.glDeleteTextures(1, depthIds, 0);

      depthIds[0]=NOT_CREATED_YET;

      }

    }

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

  private boolean checkStatus(String message)

    {

    int status = GLES20.glCheckFramebufferStatus(GLES20.GL_FRAMEBUFFER);

    if(status != GLES20.GL_FRAMEBUFFER_COMPLETE)

      {

      android.util.Log.e("DistortedFramebuffer", "FRAMEBUFFER INCOMPLETE, "+message+" error="+status);

      GLES20.glDeleteTextures(1, colorIds, 0);

      GLES20.glDeleteTextures(1, depthIds, 0);

      GLES20.glDeleteFramebuffers(1, fboIds, 0);

      fboIds[0]   = 0;

      colorIds[0] = FAILED_TO_CREATE;

      depthIds[0] = FAILED_TO_CREATE;

      return false;

      }

    return true;

    }

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

// Must be called from a thread holding OpenGL Context

  private void deleteFBO()

    {

    if( colorIds[0]>=0 )

      {

      //android.util.Log.e("FBO", "deleting ("+mWidth+","+mHeight+") "+fboIds[0]);

      if( depthIds[0]>=0 )

        {

        GLES20.glDeleteTextures(1, depthIds, 0);

        depthIds[0]=NOT_CREATED_YET;

        }

      GLES20.glDeleteTextures(1, colorIds, 0);

      colorIds[0] = NOT_CREATED_YET;

      GLES20.glDeleteFramebuffers(1, fboIds, 0);

      fboIds[0] = 0;

      }

    mMarked = false;

    }

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

  void reset()

    {

    if( colorIds[0]!=DONT_CREATE )

      colorIds[0] = NOT_CREATED_YET;

    if( mDepthWanted ) depthIds[0] = NOT_CREATED_YET;

    }

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

  void setAsOutput()

    {

    GLES20.glBindFramebuffer(GLES20.GL_FRAMEBUFFER, fboIds[0]);

    if( depthIds[0]!=NOT_CREATED_YET )

      {

      GLES20.glEnable(GLES20.GL_DEPTH_TEST);

      GLES20.glDepthMask(true);

      }

    else

      {

      GLES20.glDisable(GLES20.GL_DEPTH_TEST);

      GLES20.glDepthMask(false);

      }

    }

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

  void setAsInput()

    {

    GLES20.glBindTexture(GLES20.GL_TEXTURE_2D, colorIds[0]);

    }

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

  private void createProjection()

    {

    if( mWidth>0 && mHeight>1 )

      {

      if( mFOV>0.0f )  // perspective projection

        {

        float left   = (-mX-mWidth /2.0f)/mHeight;

        float right  = (-mX+mWidth /2.0f)/mHeight;

        float bottom = (-mY-mHeight/2.0f)/mHeight;

        float top    = (-mY+mHeight/2.0f)/mHeight;

        float near   = (top-bottom) / (2.0f*(float)Math.tan(mFOV*Math.PI/360));

        mDistance    = mHeight*near/(top-bottom);

        float far    = 2*mDistance-near;

        mDepth       = (int)((far-near)/2);

        Matrix.frustumM(mProjectionMatrix, 0, left, right, bottom, top, near, far);

        }

      else             // parallel projection

        {

        float left   = -mX-mWidth /2.0f;

        float right  = -mX+mWidth /2.0f;

        float bottom = -mY-mHeight/2.0f;

        float top    = -mY+mHeight/2.0f;

        float near   = (mWidth+mHeight)/2;

        mDistance    = 2*near;

        float far    = 3*near;

        mDepth       = (int)near;

        Matrix.orthoM(mProjectionMatrix, 0, left, right, bottom, top, near, far);

        }

      }

    }

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

  static synchronized void onDestroy()

    {

    // There are issues with this. Namely, if one

    // 1. creates a DObjectTree (somewhere else than onSurfaceCreated of constructor so it does not get re-created on re-launch)

    // 2. exits the app (here mList would be cleared)

    // 3. re-launches the app

    // 4. deletes some nodes

    // then the underlying Framebuffers will never be deleted!

    mListMarked = false;

    mList.clear();

    }

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

// must be called form a thread holding OpenGL Context

  static synchronized void deleteAllMarked()

    {

    if( mListMarked )

      {

      DistortedFramebuffer tmp;

      Iterator<DistortedFramebuffer> iterator = mList.iterator();

      while(iterator.hasNext())

        {

        tmp = iterator.next();

        if( tmp.mMarked )

          {

          tmp.deleteFBO();

          iterator.remove();

          }

        }

      mListMarked = false;

      }

    }

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

// PUBLIC API

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

/**

 * Create a new offscreen Framebuffer.

 *

 * @param width Width of the COLOR attachment.

 * @param height Height of the COLOR attachment.

 */

  @SuppressWarnings("unused")

  public DistortedFramebuffer(int width, int height)

    {

    mProjectionMatrix = new float[16];

    mHeight     = height;

    mWidth      = width;

    mFOV        = 60.0f;

    mX          = 0.0f;

    mY          = 0.0f;

    mMarked     = false;

    mDepthWanted= false;

    fboIds[0]  =-1;

    colorIds[0]= NOT_CREATED_YET;

    depthIds[0]= NOT_CREATED_YET;

    createProjection();

    }

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

/**

 * Create a new Framebuffer from an already created OpenGL Framebuffer.

 * <p>

 * Has to be followed by a 'resize()' to set the size.

 *

 * @param fbo the ID of a OpenGL Framebuffer object. Typically 0 (the screen)

 */

  public DistortedFramebuffer(int fbo)

    {

    mProjectionMatrix = new float[16];

    mFOV        = 60.0f;

    mX          = 0.0f;

    mY          = 0.0f;

    mMarked     = false;

    mDepthWanted= true;

    fboIds[0]  = fbo;

    colorIds[0]= DONT_CREATE;

    depthIds[0]= DONT_CREATE;

    }

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

/**

 * Create a new DEPTH buffer and attach it or (param=false) detach an existing DEPTh attachment and destroy it.

 *

 * @param hasDepthAttachment <bold>true</bold> if we want to attach a new DEPTH buffer to the FBO.<br>

 *                           <bold>false</bold> if we want to detach the DEPTH attachment.

 */

  public void setDepthAttachment(boolean hasDepthAttachment)

    {

    mDepthWanted = hasDepthAttachment;

    }

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

/**

 * Draw the (texture,mesh,effects) object to the Framebuffer.

 * <p>

 * Must be called from a thread holding OpenGL Context.

 *

 * @param tex input Texture to use.

 * @param mesh Class descendant from MeshObject

 * @param effects The DistortedEffects to use when rendering

 * @param time Current time, in milliseconds.

 */

  public void renderTo(DistortedTexture tex, MeshObject mesh, DistortedEffects effects, long time)

    {

    tex.createTexture();

    tex.setAsInput();

    createFBO();

    setAsOutput();

    effects.drawPriv(tex.mHalfX, tex.mHalfY, mesh, this, time);

    DistortedFramebuffer.deleteAllMarked();

    DistortedTexture.deleteAllMarked();

    }

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

/**

 * Draw the (framebuffer,mesh,effects) object to the Framebuffer.

 * <p>

 * Must be called from a thread holding OpenGL Context.

 *

 * @param fbo The Framebuffer (previously created with the first constructor, drawing FROM the screen

 *            is unsupported!) whose COLOR attachment 0 will be used as input texture.

 *            Please note that rendering from an FBO to itself is unsupported by OpenGL!

 * @param mesh Class descendant from MeshObject

 * @param effects The DistortedEffects to use when rendering

 * @param time Current time, in milliseconds.

 */

  public void renderTo(DistortedFramebuffer fbo, MeshObject mesh, DistortedEffects effects, long time)

    {

    fbo.createFBO();

    if( fbo.colorIds[0]>0 )    // fbo created with the first constructor

      {

      createFBO();

      setAsOutput();

      GLES20.glBindTexture(GLES20.GL_TEXTURE_2D, fbo.colorIds[0]);

      effects.drawPriv(fbo.mWidth/2, fbo.mHeight/2, mesh, this, time);

      DistortedFramebuffer.deleteAllMarked();

      DistortedTexture.deleteAllMarked();

      }

    }

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

/**

 * Draws the Tree, and all its children, to the Framebuffer.

 * <p>

 * Must be called from a thread holding OpenGL Context.

 *

 * @param dt DistortedTree to render.

 * @param time Current time, in milliseconds. This will be passed to all the Effects stored in the Tree.

 */

  public void renderTo(DistortedTree dt, long time)

    {

    createFBO();

    setAsOutput();

    dt.drawRecursive(time,this);

    DistortedFramebuffer.deleteAllMarked();

    DistortedTexture.deleteAllMarked();

    }

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

/**

 * Mark the underlying OpenGL object for deletion. Actual deletion will take place on the next render.

 */

  public void markForDeletion()

    {

    //android.util.Log.e("FBO", "marking for deletion ("+mWidth+","+mHeight+") "+fboIds[0]);

    mListMarked = true;

    mMarked     = true;

    }

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

/**

 * Create new Projection matrix.

 *

 * @param fov Vertical 'field of view' of the Projection frustrum (in degrees).

 * @param x X-coordinate of the point at which our camera looks at. 0 is the center.

 * @param y Y-coordinate of the point at which our camera looks at. 0 is the center.

 */

  public void setProjection(float fov, float x, float y)

    {

    mFOV = fov;

    mX   = x;

    mY   = y;

    createProjection();

    }

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

/**

 * Resize the underlying Framebuffer.

 *

 * As the Framebuffer is not created until the first render, typical usage of this API is actually

 * to set the size of an not-yet-created Framebuffer of an object that has been created with the

 * second constructor.

 * <p>

 * Fully creating an object, rendering to it, then resizing mid-render is also possible. Actual

 * resize takes place on the next render.

 *

 * @param width The new width.

 * @param height The new height.

 */

  public void resize(int width, int height)

    {

    if( mWidth!=width || mHeight!=height )

      {

      mWidth = width;

      mHeight= height;

      createProjection();

      if( colorIds[0]>0 ) markForDeletion();

      }

    }

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

/**

 * Return the ID of the Texture (COLOR attachment 0) that's backing this FBO.

 * <p>

 * Catch: this will only work if the library has had time to actually create the texture. Remember

 * that the texture gets created only on first render, thus creating a Texture object and immediately

 * calling this method will return an invalid (negative) result.

 *

 * @return If there was not a single render between creation of the Object and calling this method on

 *         it, return a negative value. Otherwise, return ID of COLOR attachment 0.

 */

  public int getTextureID()

    {

    return colorIds[0];

    }

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

/**

 * Return true if the FBO contains a DEPTH attachment.

 *

 * @return <bold>true</bold> if the FBO contains a DEPTH attachment.

 */

  public boolean hasDepth()

    {

    return mDepthWanted;

    }

  }