Add experimental DynamicTextureModule.ReuseTextures flag, currently only configurable on compile.

Disabled (status quo) by default.
This flag makes the dynamic texture module reuse cache previously dynamically generated textures given the same input commands and extra params for 24 hours.
This occurs as long as those commands would always generate the same texture (e.g. they do not contain commands to fetch data from the web).
This makes texture changing faster as a viewer-cached texture uuid is sent and may reduce simulator load in regions with generation of lots of dynamic textures.
A downside is that this stops expiry of old temporary dynamic textures from the cache,
Another downside is that a jpeg2000 generation that partially failed is currently not regenerated until restart or after 24 hours.

1 files changed, 125 insertions, 44 deletions

diff --git a/OpenSim/Region/CoreModules/Scripting/DynamicTexture/DynamicTextureModule.cs b/OpenSim/Region/CoreModules/Scripting/DynamicTexture/DynamicTextureModule.cs
index 18bd018..13b7498 100644
--- a/OpenSim/Region/CoreModules/Scripting/DynamicTexture/DynamicTextureModule.cs
+++ b/OpenSim/Region/CoreModules/Scripting/DynamicTexture/DynamicTextureModule.cs
@@ -49,6 +49,11 @@ namespace OpenSim.Region.CoreModules.Scripting.DynamicTexture
         public const int DISP_EXPIRE = 1;
         public const int DISP_TEMP   = 2;
 
+        /// <summary>
+        /// If true then where possible dynamic textures are reused.
+        /// </summary>
+        public bool ReuseTextures { get; set; }
+
         private Dictionary<UUID, Scene> RegisteredScenes = new Dictionary<UUID, Scene>();
 
         private Dictionary<string, IDynamicTextureRender> RenderPlugins =
@@ -56,6 +61,15 @@ namespace OpenSim.Region.CoreModules.Scripting.DynamicTexture
 
         private Dictionary<UUID, DynamicTextureUpdater> Updaters = new Dictionary<UUID, DynamicTextureUpdater>();
 
+        /// <summary>
+        /// Record dynamic textures that we can reuse for a given data and parameter combination rather than
+        /// regenerate.
+        /// </summary>
+        /// <remarks>
+        /// Key is string.Format("{0}{1}", data
+        /// </remarks>
+        private Cache m_reuseableDynamicTextures;
+
         #region IDynamicTextureManager Members
 
         public void RegisterRender(string handleType, IDynamicTextureRender render)
@@ -71,7 +85,8 @@ namespace OpenSim.Region.CoreModules.Scripting.DynamicTexture
         /// </summary>
         /// <param name="id"></param>
         /// <param name="data"></param>
-        public void ReturnData(UUID id, byte[] data)
+        /// <param name="isReuseable">True if the data generated can be reused for subsequent identical requests</param>
+        public void ReturnData(UUID id, byte[] data, bool isReuseable)
         {
             DynamicTextureUpdater updater = null;
 
@@ -88,7 +103,11 @@ namespace OpenSim.Region.CoreModules.Scripting.DynamicTexture
                 if (RegisteredScenes.ContainsKey(updater.SimUUID))
                 {
                     Scene scene = RegisteredScenes[updater.SimUUID];
-                    updater.DataReceived(data, scene);
+                    UUID newTextureID = updater.DataReceived(data, scene);
+
+                    if (ReuseTextures && isReuseable && !updater.BlendWithOldTexture)
+                        m_reuseableDynamicTextures.Store(
+                            GenerateReusableTextureKey(updater.BodyData, updater.Params), newTextureID);
                 }
             }
 
@@ -169,6 +188,11 @@ namespace OpenSim.Region.CoreModules.Scripting.DynamicTexture
         {
             if (RenderPlugins.ContainsKey(contentType))
             {
+                // If we want to reuse dynamic textures then we have to ignore any request from the caller to expire
+                // them.
+                if (ReuseTextures)
+                    disp = disp & ~DISP_EXPIRE;
+
                 DynamicTextureUpdater updater = new DynamicTextureUpdater();
                 updater.SimUUID = simID;
                 updater.PrimID = primID;
@@ -183,21 +207,49 @@ namespace OpenSim.Region.CoreModules.Scripting.DynamicTexture
                 updater.Url = "Local image";
                 updater.Disp = disp;
 
-                lock (Updaters)
+                object reusableTextureUUID = null;
+
+                if (ReuseTextures)
+                    reusableTextureUUID
+                        = m_reuseableDynamicTextures.Get(GenerateReusableTextureKey(data, extraParams));
+
+                // We cannot reuse a dynamic texture if the data is going to be blended with something already there.
+                if (reusableTextureUUID == null || updater.BlendWithOldTexture)
                 {
-                    if (!Updaters.ContainsKey(updater.UpdaterID))
+                    lock (Updaters)
                     {
-                        Updaters.Add(updater.UpdaterID, updater);
+                        if (!Updaters.ContainsKey(updater.UpdaterID))
+                        {
+                            Updaters.Add(updater.UpdaterID, updater);
+                        }
+                    }
+
+                    RenderPlugins[contentType].AsyncConvertData(updater.UpdaterID, data, extraParams);
+                }
+                else
+                {
+                    // No need to add to updaters as the texture is always the same.  Not that this functionality
+                    // apppears to be implemented anyway.
+                    if (RegisteredScenes.ContainsKey(updater.SimUUID))
+                    {
+                        SceneObjectPart part = RegisteredScenes[updater.SimUUID].GetSceneObjectPart(updater.PrimID);
+
+                        if (part != null)
+                            updater.UpdatePart(part, (UUID)reusableTextureUUID);
                     }
                 }
 
-                RenderPlugins[contentType].AsyncConvertData(updater.UpdaterID, data, extraParams);
                 return updater.UpdaterID;
             }
             
             return UUID.Zero;
         }
 
+        private string GenerateReusableTextureKey(string data, string extraParams)
+        {
+            return string.Format("{0}{1}", data, extraParams);
+        }
+
         public void GetDrawStringSize(string contentType, string text, string fontName, int fontSize,
                                       out double xSize, out double ySize)
         {
@@ -224,6 +276,12 @@ namespace OpenSim.Region.CoreModules.Scripting.DynamicTexture
 
         public void PostInitialise()
         {
+//            ReuseTextures = true;
+            if (ReuseTextures)
+            {
+                m_reuseableDynamicTextures = new Cache(CacheMedium.Memory, CacheStrategy.Conservative);
+                m_reuseableDynamicTextures.DefaultTTL = new TimeSpan(24, 0, 0);
+            }
         }
 
         public void Close()
@@ -269,9 +327,60 @@ namespace OpenSim.Region.CoreModules.Scripting.DynamicTexture
             }
 
             /// <summary>
+            /// Update the given part with the new texture.
+            /// </summary>
+            /// <returns>
+            /// The old texture UUID.
+            /// </returns>
+            public UUID UpdatePart(SceneObjectPart part, UUID textureID)
+            {
+                UUID oldID;
+
+                lock (part)
+                {
+                    // mostly keep the values from before
+                    Primitive.TextureEntry tmptex = part.Shape.Textures;
+
+                    // FIXME: Need to return the appropriate ID if only a single face is replaced.
+                    oldID = tmptex.DefaultTexture.TextureID;
+
+                    if (Face == ALL_SIDES)
+                    {
+                        oldID = tmptex.DefaultTexture.TextureID;
+                        tmptex.DefaultTexture.TextureID = textureID;
+                    }
+                    else
+                    {
+                        try
+                        {
+                            Primitive.TextureEntryFace texface = tmptex.CreateFace((uint)Face);
+                            texface.TextureID = textureID;
+                            tmptex.FaceTextures[Face] = texface;
+                        }
+                        catch (Exception)
+                        {
+                            tmptex.DefaultTexture.TextureID = textureID;
+                        }
+                    }
+
+                    // I'm pretty sure we always want to force this to true
+                    // I'm pretty sure noone whats to set fullbright true if it wasn't true before.
+                    // tmptex.DefaultTexture.Fullbright = true;
+
+                    part.UpdateTextureEntry(tmptex.GetBytes());
+                }
+
+                return oldID;
+            }
+
+            /// <summary>
             /// Called once new texture data has been received for this updater.
             /// </summary>
-            public void DataReceived(byte[] data, Scene scene)
+            /// <param name="data"></param>
+            /// <param name="scene"></param>
+            /// <param name="isReuseable">True if the data given is reuseable.</param>
+            /// <returns>The asset UUID given to the incoming data.</returns>
+            public UUID DataReceived(byte[] data, Scene scene)
             {
                 SceneObjectPart part = scene.GetSceneObjectPart(PrimID);
 
@@ -281,7 +390,8 @@ namespace OpenSim.Region.CoreModules.Scripting.DynamicTexture
                         String.Format("DynamicTextureModule: Error preparing image using URL {0}", Url);
                     scene.SimChat(Utils.StringToBytes(msg), ChatTypeEnum.Say,
                                   0, part.ParentGroup.RootPart.AbsolutePosition, part.Name, part.UUID, false);
-                    return;
+                    
+                    return UUID.Zero;
                 }
 
                 byte[] assetData = null;
@@ -323,52 +433,23 @@ namespace OpenSim.Region.CoreModules.Scripting.DynamicTexture
                     cacheLayerDecode = null;
                 }
 
-                UUID oldID = UUID.Zero;
-
-                lock (part)
-                {
-                    // mostly keep the values from before
-                    Primitive.TextureEntry tmptex = part.Shape.Textures;
-
-                    // remove the old asset from the cache
-                    oldID = tmptex.DefaultTexture.TextureID;
-                    
-                    if (Face == ALL_SIDES)
-                    {
-                        tmptex.DefaultTexture.TextureID = asset.FullID;
-                    }
-                    else
-                    {
-                        try
-                        {
-                            Primitive.TextureEntryFace texface = tmptex.CreateFace((uint)Face);
-                            texface.TextureID = asset.FullID;
-                            tmptex.FaceTextures[Face] = texface;
-                        }
-                        catch (Exception)
-                        {
-                            tmptex.DefaultTexture.TextureID = asset.FullID;
-                        }
-                    }
-
-                    // I'm pretty sure we always want to force this to true
-                    // I'm pretty sure noone whats to set fullbright true if it wasn't true before.
-                    // tmptex.DefaultTexture.Fullbright = true;
-
-                    part.UpdateTextureEntry(tmptex.GetBytes());
-                }
+                UUID oldID = UpdatePart(part, asset.FullID);
 
                 if (oldID != UUID.Zero && ((Disp & DISP_EXPIRE) != 0))
                 {
-                    if (oldAsset == null) oldAsset = scene.AssetService.Get(oldID.ToString());
+                    if (oldAsset == null)
+                        oldAsset = scene.AssetService.Get(oldID.ToString());
+
                     if (oldAsset != null)
                     {
-                        if (oldAsset.Temporary == true)
+                        if (oldAsset.Temporary)
                         {
                             scene.AssetService.Delete(oldID.ToString());
                         }
                     }
                 }
+
+                return asset.FullID;
             }
 
             private byte[] BlendTextures(byte[] frontImage, byte[] backImage, bool setNewAlpha, byte newAlpha)