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.main;

import org.distorted.library.effect.Effect;

import org.distorted.library.effect.EffectName;

import org.distorted.library.effect.EffectType;

import org.distorted.library.message.EffectListener;

import org.distorted.library.message.EffectMessage;

import java.util.ArrayList;

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

abstract class EffectQueue implements DistortedSlave

  {

  private static final int ATTACH = 0;

  private static final int DETACH = 1;

  private static final int DETALL = 2;

  protected int mNumEffects;      // 'ToBe' will be more than mNumEffects if doWork() hasn't

  protected int mNumEffectsToBe;  // added them yet (or less if it hasn't removed some yet)

  protected float[] mUniforms;

  protected long[] mCurrentDuration;

  protected Effect[] mEffects;

  protected int[] mName;

  protected long mTime=0;

  protected static int[] mMax = new int[EffectType.LENGTH];

  protected ArrayList<EffectListener> mListeners =null;

  protected int mNumListeners=0;  // ==mListeners.length(), but we only create mListeners if the first one gets added

  protected long mDistortedEffectsID;

  private ArrayList<DistortedNode> mNodes = null;

  private long mID;

  private static boolean mCreated;

  private int mIndex;

  private class Job

    {

    int type;

    boolean notify;

    Effect effect;

    Job(int t, boolean n, Effect e)

      {

      type  = t;

      notify= n;

      effect= e;

      }

    }

  private ArrayList<Job> mJobs = new ArrayList<>();

  static

    {

    onDestroy();

    }

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

  EffectQueue(long id, int numUniforms, int index)

    {

    mID                 = 0;

    mNumEffects         = 0;

    mNumEffectsToBe     = 0;

    mDistortedEffectsID = id;

    mIndex              = index;

    int max = mMax[mIndex];

    if( max>0 )

      {

      mUniforms        = new float[numUniforms*max];

      mCurrentDuration = new long[max];

      mEffects         = new Effect[max];

      mName            = new int[max];

      }

    mCreated = true;  

    }

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

// TODO: introduce a Map to return an ID dependant on all Effects in the Queue.

// For now this is good enough.

  private void regenerateID()

    {

    mID = mNumEffects>0 ? mEffects[0].getID() : 0;

    }

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

  void newNode(DistortedNode node)

    {

    if( mNodes==null ) mNodes = new ArrayList<>();

    mNodes.add(node);

    }

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

  @SuppressWarnings("unused")

  int getNumEffects()

    {

    return mNumEffects;  

    }

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

  long getID()

    {

    return mID;

    }

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

  static boolean setMax(int index, int m)

    {

    if( (!mCreated && !Distorted.isInitialized()) || m<=mMax[index] )

      {

      mMax[index] = m<0 ? 0:m;

      return true;

      }

    return false;

    }

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

  static int getMax(int index)

    {

    return mMax[index];

    }

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

  void registerForMessages(EffectListener el)

    {

    if( mListeners==null ) mListeners = new ArrayList<>();

    if( !mListeners.contains(el) )

      {

      mListeners.add(el);

      mNumListeners++;

      }

    }

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

  void deregisterForMessages(EffectListener el)

    {

    if( mListeners.remove(el) )

      {

      mNumListeners--;

      }

    }

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

  static void onDestroy()

    {

    EffectType.reset(mMax);

    mCreated = false;  

    }

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

// this assumes 0<=effect<mNumEffects

  protected void remove(int effect)

    {

    mNumEffects--;

    long removedID = mEffects[effect].getID();

    for(int j=effect; j<mNumEffects; j++ )

      {

      mEffects[j]         = mEffects[j+1];

      mCurrentDuration[j] = mCurrentDuration[j+1];

      mName[j]            = mName[j+1];

      }

    mEffects[mNumEffects] = null;

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

      EffectMessageSender.newMessage( mListeners.get(i), EffectMessage.EFFECT_REMOVED, removedID, mDistortedEffectsID);

    }

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

  synchronized int removeByName(EffectName name)

    {

    int ret = 0;

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

      {

      if( mEffects[i].getName() == name )

        {

        mJobs.add(new Job(DETACH,true,mEffects[i]));

        ret++;

        }

      }

    if( ret>0 )

      {

      DistortedMaster.newSlave(this);

      mNumEffectsToBe-=ret;

      }

    return ret;

    }

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

  synchronized int removeById(long id)

    {

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

      {

      if( mEffects[i].getID() == id )

        {

        mJobs.add(new Job(DETACH,true,mEffects[i]));

        DistortedMaster.newSlave(this);

        mNumEffectsToBe--;

        return 1;

        }

      }

    return 0;

    }

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

  synchronized int removeEffect(Effect effect)

    {

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

      {

      if( mEffects[i]==effect )

        {

        mJobs.add(new Job(DETACH,true,mEffects[i]));

        DistortedMaster.newSlave(this);

        mNumEffectsToBe--;

        return 1;

        }

      }

    return 0;

    }

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

// we do want to notify Listeners if they called 'abortAll' themselves but don't want to notify

// them if it is the library itself which is releasing resources.

  synchronized int abortAll(boolean notify)

    {

    mJobs.add(new Job(DETALL,notify,null));

    DistortedMaster.newSlave(this);

    mNumEffectsToBe = 0;

    return mNumEffects;

    }

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

  boolean add(Effect effect)

    {

    if( mMax[mIndex]>mNumEffectsToBe )

      {

      //android.util.Log.e("queue", "scheduling future add of "+effect.getName().name()+" to "+mNumEffectsToBe+" id="+effect.getID());

      //android.util.Log.e("queue", "queue id="+mDistortedEffectsID);

      mJobs.add(new Job(ATTACH,false,effect));

      DistortedMaster.newSlave(this);

      mNumEffectsToBe++;

      return true;

      }

    return false;

    }

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

/**

 * This is not really part of the public API. Has to be public only because it is a part of the

 * DistortedSlave interface, which should really be a class that we extend here instead but

 * Java has no multiple inheritance.

 *

 * @y.exclude

 */

  public void doWork()

    {

    int num = mJobs.size();

    Job job;

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

      {

      job = mJobs.remove(0);

      switch(job.type)

        {

        case ATTACH: //android.util.Log.e("queue", "DisEffects ID: "+mDistortedEffectsID+" bank:"+mNumEffects+

                     //                   " attaching effectID="+job.effect.getID()+" ("+job.effect.getName().name()+")");

                     mCurrentDuration[mNumEffects] = 0;

                     mEffects[mNumEffects] = job.effect;

                     mName[mNumEffects] = job.effect.getName().ordinal();

                     mNumEffects++;

                     //android.util.Log.d("queue", "DisEffects ID: "+mDistortedEffectsID+

                     //        " success attaching, num to be:"+mNumEffectsToBe+" num:"+mNumEffects);

                     break;

        case DETACH: //android.util.Log.e("queue", "DisEffects ID: "+mDistortedEffectsID+" detaching effect "+

                     //                             job.effect.getID());

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

                       {

                       if (mEffects[j] == job.effect)

                         {

                         remove(j);

                         //android.util.Log.d("queue", "DisEffects ID: "+mDistortedEffectsID+

                         //    " success detaching, num to be:"+mNumEffectsToBe+" num:"+mNumEffects);

                         break;

                         }

                       }

                     break;

        case DETALL: for(int j=0; j<mNumEffects; j++ )

                       {

                       if( job.notify )

                         {

                         for(int k=0; k<mNumListeners; k++)

                           EffectMessageSender.newMessage( mListeners.get(k), EffectMessage.EFFECT_REMOVED, mEffects[j].getID(), mDistortedEffectsID);

                         }

                       mEffects[j] = null;

                       }

                     mNumEffects= 0;

                     break;

        }

      }

    if( num>0 )

      {

      regenerateID();

      if( mIndex==EffectType.POSTPROCESS.ordinal() )

        {

        int numNodes = (mNodes==null ? 0: mNodes.size());

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

          {

          mNodes.get(i).sort();

          }

        }

      }

    }

  }