Distorted Android

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

// Copyright 2016 Leszek Koltunski  leszek@koltunski.pl                                          //

//                                                                                               //

// This file is part of Distorted.                                                               //

//                                                                                               //

// This library is free software; you can redistribute it and/or                                 //

// modify it under the terms of the GNU Lesser General Public                                    //

// License as published by the Free Software Foundation; either                                  //

// version 2.1 of the License, or (at your option) any later version.                            //

//                                                                                               //

// This library 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                             //

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

//                                                                                               //

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

// License along with this library; if not, write to the Free Software                           //

// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA                //

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

package org.distorted.library.main;

import android.opengl.GLES30;

import android.util.Log;

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

/**

 * Class which represents a OpenGL Framebuffer object.

 * <p>

 * User is able to create offscreen FBOs and both a) render to them b) use their COLOR0 attachment as

 * an input texture. Attaching Depths and/or Stencils is also possible.

 */

public class DistortedFramebuffer extends InternalOutputSurface

  {

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

// Must be called from a thread holding OpenGL Context

  void create()

    {

    if( mNumFBOs==DistortedLibrary.WAIT_FOR_FBO_QUEUE_SIZE )

      {

      // only now we know how many FBOs there should be

      mNumFBOs = DistortedLibrary.getQueueSize();

      allocateColor();

      allocateStuffDependantOnNumFBOS();

      }

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

    // COLOR

    if( mColorCreated==NOT_CREATED_YET )

      {

      GLES30.glGenTextures( mNumFBOs*mNumColors, mColorH, 0);

      GLES30.glGenFramebuffers(mNumFBOs, mFBOH, 0);

      for(int i=0; i<mNumFBOs; i++)

        {

        GLES30.glBindFramebuffer(GLES30.GL_FRAMEBUFFER, mFBOH[i]);

        for(int j=0; j<mNumColors; j++)

          {

          GLES30.glBindTexture(GLES30.GL_TEXTURE_2D, mColorH[i*mNumColors+j]);

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

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

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

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

          GLES30.glTexImage2D(GLES30.GL_TEXTURE_2D, 0, GLES30.GL_RGBA, mRealWidth, mRealHeight, 0, GLES30.GL_RGBA, GLES30.GL_UNSIGNED_BYTE, null);

          }

        GLES30.glFramebufferTexture2D(GLES30.GL_FRAMEBUFFER, GLES30.GL_COLOR_ATTACHMENT0, GLES30.GL_TEXTURE_2D, mColorH[i*mNumColors], 0);

        GLES30.glBindTexture(GLES30.GL_TEXTURE_2D, 0);

        }

      // TODO

      mColorCreated = checkStatus("color");

      GLES30.glBindFramebuffer(GLES30.GL_FRAMEBUFFER, 0);

      }

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

    // DEPTH / STENCIL

    if( mDepthStencilCreated==NOT_CREATED_YET ) // we need to create a new DEPTH or STENCIL attachment

      {

      GLES30.glGenTextures(mNumFBOs, mDepthStencilH, 0);

      for(int i=0; i<mNumFBOs; i++)

        {

        GLES30.glBindTexture(GLES30.GL_TEXTURE_2D, mDepthStencilH[i]);

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

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

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

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

        if (mDepthStencil == DEPTH_NO_STENCIL)

          {

          GLES30.glTexImage2D(GLES30.GL_TEXTURE_2D, 0, GLES30.GL_DEPTH_COMPONENT, mRealWidth, mRealHeight, 0, GLES30.GL_DEPTH_COMPONENT, GLES30.GL_UNSIGNED_INT, null);

          }

        else if (mDepthStencil == BOTH_DEPTH_STENCIL)

          {

          GLES30.glTexImage2D(GLES30.GL_TEXTURE_2D, 0, GLES30.GL_DEPTH24_STENCIL8, mRealWidth, mRealHeight, 0, GLES30.GL_DEPTH_STENCIL, GLES30.GL_UNSIGNED_INT_24_8, null);

          }

        }

      GLES30.glBindTexture(GLES30.GL_TEXTURE_2D, 0);

      for(int i=0; i<mNumFBOs; i++)

        {

        GLES30.glBindFramebuffer(GLES30.GL_FRAMEBUFFER, mFBOH[i]);

        if (mDepthStencil == DEPTH_NO_STENCIL)

          {

          GLES30.glFramebufferTexture2D(GLES30.GL_FRAMEBUFFER, GLES30.GL_DEPTH_ATTACHMENT, GLES30.GL_TEXTURE_2D, mDepthStencilH[i], 0);

          }

        else if (mDepthStencil == BOTH_DEPTH_STENCIL)

          {

          GLES30.glFramebufferTexture2D(GLES30.GL_FRAMEBUFFER, GLES30.GL_DEPTH_STENCIL_ATTACHMENT, GLES30.GL_TEXTURE_2D, mDepthStencilH[i], 0);

          }

        }

      // TODO

      mDepthStencilCreated = checkStatus("depth");

      GLES30.glBindFramebuffer(GLES30.GL_FRAMEBUFFER, 0);

      }

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

    // DETACH

    // TODO

    if( mDepthStencilCreated==DONT_CREATE && mDepthStencilH[0]>0 ) // we need to detach and recreate the DEPTH attachment.

      {

      // OpenGL ES 3.0.5 spec, chapter 4.4.2.4 :

      // "Note that the texture image is specifically not detached from any other framebuffer objects.

      //  Detaching the texture image from any other framebuffer objects is the responsibility of the application."

      for(int i=0; i<mNumFBOs; i++)

        {

        GLES30.glBindFramebuffer(GLES30.GL_FRAMEBUFFER, mFBOH[i]);

        GLES30.glFramebufferTexture2D(GLES30.GL_FRAMEBUFFER, GLES30.GL_DEPTH_ATTACHMENT, GLES30.GL_TEXTURE_2D, 0, 0);

        GLES30.glFramebufferTexture2D(GLES30.GL_FRAMEBUFFER, GLES30.GL_DEPTH_STENCIL_ATTACHMENT, GLES30.GL_TEXTURE_2D, 0, 0);

        mDepthStencilH[i]=0;

        }

      GLES30.glDeleteTextures(mNumFBOs, mDepthStencilH, 0);

      GLES30.glBindFramebuffer(GLES30.GL_FRAMEBUFFER, 0);

      }

    }

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

// TODO

  private int checkStatus(String message)

    {

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

    if(status != GLES30.GL_FRAMEBUFFER_COMPLETE)

      {

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

      GLES30.glDeleteTextures(1, mColorH, 0);

      GLES30.glDeleteTextures(1, mDepthStencilH, 0);

      GLES30.glDeleteFramebuffers(1, mFBOH, 0);

      mFBOH[0]= 0;

      return FAILED_TO_CREATE;

      }

    return CREATED;

    }

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

// Must be called from a thread holding OpenGL Context

  void delete()

    {

    if( mColorH[0]>0 )

      {

      GLES30.glDeleteTextures(mNumFBOs*mNumColors, mColorH, 0);

      mColorCreated = NOT_CREATED_YET;

      for(int i=0; i<mNumFBOs*mNumColors; i++) mColorH[i] = 0;

      }

    if( mDepthStencilH[0]>0 )

      {

      GLES30.glDeleteTextures(mNumFBOs, mDepthStencilH, 0);

      mDepthStencilCreated = NOT_CREATED_YET;

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

      }

    if( mNumFBOs>0 && mFBOH[0]>0 )

      {

      GLES30.glDeleteFramebuffers(mNumFBOs, mFBOH, 0);

      }

    for(int i=0; i<mNumFBOs; i++)

      {

      mFBOH[i] = 0;

      }

    }

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

// called from onDestroy(); mark OpenGL assets as 'not created'

  void recreate()

    {

    if( mColorCreated!=DONT_CREATE )

      {

      mColorCreated = NOT_CREATED_YET;

      mColorH[0] = 0;

      }

    if( mDepthStencilCreated!=DONT_CREATE )

      {

      mDepthStencilCreated = NOT_CREATED_YET;

      mDepthStencilH[0] = 0;

      }

    for(int i=0; i<mNumFBOs; i++)

      {

      mFBOH[i] = 0;

      }

    }

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

  boolean setAsInput(int fbo, int texture)

    {

    if( texture>=0 && texture<mNumColors && fbo>=0 && fbo<mNumFBOs && mColorH[mNumColors*fbo + texture]>0 )

      {

      GLES30.glActiveTexture(GLES30.GL_TEXTURE0);

      GLES30.glBindTexture(GLES30.GL_TEXTURE_2D, mColorH[mNumColors*fbo + texture]);

      return true;

      }

    return false;

    }

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

// create a multi-framebuffer (1 object containing multiple FBOs)

  DistortedFramebuffer(int numfbos, int numcolors, int depthStencil, int type, int storage, int width, int height)

    {

    super(width,height,NOT_CREATED_YET,numfbos,numcolors,depthStencil,NOT_CREATED_YET, type, storage);

    markForCreation();

    }

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

// create SYSTEM or TREE framebuffers (those are just like normal FBOs, just hold information

// that they were autocreated only for the Library's internal purposes (SYSTEM) or for using

// inside a Tree of DistortedNodes (TREE)

// SYSTEM surfaces do not get removed in onDestroy().

  DistortedFramebuffer(int numcolors, int depthStencil, int type, int width, int height)

    {

    this(1,numcolors,depthStencil,type,STORAGE_PRIVATE,width,height);

    }

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

// PUBLIC API

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

/**

 * Create new offscreen Framebuffer with configurable number of COLOR, DEPTH and STENCIL attachments.

 *

 * @param width        Width of all the COLOR attachments.

 * @param height       Height of all the COLOR attachments.

 * @param numcolors    How many COLOR attachments to create?

 * @param depthStencil Add DEPTH or STENCIL attachment?

 *                     Valid values: NO_DEPTH_NO_STENCIL, DEPTH_NO_STENCIL, BOTH_DEPTH_STENCIL.

 */

  @SuppressWarnings("unused")

  public DistortedFramebuffer(int width, int height, int numcolors, int depthStencil)

    {

    this(1,numcolors,depthStencil,TYPE_USER,STORAGE_PRIVATE,width,height);

    }

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

/**

 * Bind the underlying rectangle of pixels as a OpenGL Texture.

 *

 * @param texture The Texture number to bind (and thus read from).

 * @return <code>true</code> if successful.

 */

  public boolean setAsInput(int texture)

    {

    if( texture>=0 && texture<mNumColors && mColorH[texture]>0 )

      {

      GLES30.glActiveTexture(GLES30.GL_TEXTURE0);

      GLES30.glBindTexture(GLES30.GL_TEXTURE_2D, mColorH[2*mCurrFBO+texture]);

      return true;

      }

    return false;

    }

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

  /**

   * Attach the texture'th Texture to COLOR0 attachment.

   *

   * @param texture The Texture number to attach (and subsequently use to render to)

   */

  public void bindForOutput(int texture)

    {

    if( texture>=0 && texture<mNumColors && mColorH[texture]>0 )

      {

      GLES30.glFramebufferTexture2D(GLES30.GL_FRAMEBUFFER, GLES30.GL_COLOR_ATTACHMENT0, GLES30.GL_TEXTURE_2D, mColorH[2*mCurrFBO+texture], 0);

      }

    }

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

/**

 * Enable.disable DEPTH and STENCIL buffers.

 *

 * @param depthStencil Valid values: NO_DEPTH_NO_STENCIL, DEPTH_NO_STENCIL, BOTH_DEPTH_STENCIL.

 */

  public void enableDepthStencil(int depthStencil)

    {

    if( depthStencil != mDepthStencil )

      {

      mDepthStencil = depthStencil;

      if( depthStencil!= NO_DEPTH_NO_STENCIL && mDepthStencilCreated==DONT_CREATE )

        {

        mDepthStencilCreated = NOT_CREATED_YET;

        markForCreation();

        }

      if( depthStencil== NO_DEPTH_NO_STENCIL && mDepthStencilCreated!=DONT_CREATE )

        {

        mDepthStencilCreated = DONT_CREATE;

        markForCreation();

        }

      }

    }

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

/**

 * 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 mColorH[0];

    }

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

/**

 * Bind one of the underlying FBOs to GL_READ_FRAMEBUFFER.

 * Useful for a subsequent glReadBuffer / glReadPixels.

 *

 * @param fbo which of the underlying FBOs to bind.

 * @return <code>true</code> if successful.

 */

  public boolean setAsReadFramebuffer(int fbo)

    {

    if( fbo>=0 && fbo<mNumFBOs )

      {

      GLES30.glBindFramebuffer(GLES30.GL_READ_FRAMEBUFFER, mFBOH[fbo]);

      return true;

      }

    return false;

    }

  }