123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353 |
- /*
- * Copyright (c) Contributors, http://opensimulator.org/
- * See CONTRIBUTORS.TXT for a full list of copyright holders.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- * * Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- * * Neither the name of the OpenSimulator Project nor the
- * names of its contributors may be used to endorse or promote products
- * derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
- using System;
- using System.Threading;
- using System.Collections;
- using System.Collections.Generic;
- using System.Reflection;
- using OpenMetaverse;
- using OpenMetaverse.Imaging;
- using OpenSim.Framework;
- using OpenSim.Region.Framework.Interfaces;
- using OpenSim.Services.Interfaces;
- using log4net;
- namespace OpenSim.Region.ClientStack.LindenUDP
- {
- /// <summary>
- /// This class handles UDP texture requests.
- /// </summary>
- public class LLImageManager
- {
- private sealed class J2KImageComparer : IComparer<J2KImage>
- {
- public int Compare(J2KImage x, J2KImage y)
- {
- return x.Priority.CompareTo(y.Priority);
- }
- }
- private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
- private bool m_shuttingdown;
- private AssetBase m_missingImage;
- private IAssetService m_assetCache;
- private IJ2KDecoder m_j2kDecodeModule;
- /// <summary>
- /// Priority queue for determining which image to send first.
- /// </summary>
- private C5.IntervalHeap<J2KImage> m_priorityQueue = new C5.IntervalHeap<J2KImage>(10, new J2KImageComparer());
- /// <summary>
- /// Used to control thread access to the priority queue.
- /// </summary>
- private object m_syncRoot = new object();
- /// <summary>
- /// Client served by this image manager
- /// </summary>
- public IClientAPI Client { get; private set; }
- public AssetBase MissingImage { get { return m_missingImage; } }
- public LLImageManager(IClientAPI client, IAssetService pAssetCache, IJ2KDecoder pJ2kDecodeModule)
- {
- Client = client;
- m_assetCache = pAssetCache;
- if (pAssetCache != null)
- m_missingImage = pAssetCache.Get("5748decc-f629-461c-9a36-a35a221fe21f");
-
- if (m_missingImage == null)
- m_log.Error("[ClientView] - Couldn't set missing image asset, falling back to missing image packet. This is known to crash the client");
- m_j2kDecodeModule = pJ2kDecodeModule;
- }
- /// <summary>
- /// Handles an incoming texture request or update to an existing texture request
- /// </summary>
- /// <param name="newRequest"></param>
- public void EnqueueReq(TextureRequestArgs newRequest)
- {
- if (!m_shuttingdown)
- {
- J2KImage imgrequest;
- // Do a linear search for this texture download
- lock (m_syncRoot)
- m_priorityQueue.Find(delegate(J2KImage img) { return img.TextureID == newRequest.RequestedAssetID; }, out imgrequest);
- if (imgrequest != null)
- {
- if (newRequest.DiscardLevel == -1 && newRequest.Priority == 0f)
- {
- //m_log.Debug("[TEX]: (CAN) ID=" + newRequest.RequestedAssetID);
- try
- {
- lock (m_syncRoot)
- m_priorityQueue.Delete(imgrequest.PriorityQueueHandle);
- }
- catch (Exception) { }
- }
- else
- {
- // m_log.DebugFormat(
- // "[LL IMAGE MANAGER]: Received duplicate of existing request for {0}, start packet {1} from {2}",
- // newRequest.RequestedAssetID, newRequest.PacketNumber, m_client.Name);
- // m_log.DebugFormat("[TEX]: (UPD) ID={0}: D={1}, S={2}, P={3}",
- // newRequest.RequestedAssetID, newRequest.DiscardLevel, newRequest.PacketNumber, newRequest.Priority);
- //Check the packet sequence to make sure this isn't older than
- //one we've already received
- if (newRequest.requestSequence > imgrequest.LastSequence)
- {
- //Update the sequence number of the last RequestImage packet
- imgrequest.LastSequence = newRequest.requestSequence;
- //Update the requested discard level
- imgrequest.DiscardLevel = newRequest.DiscardLevel;
- //Update the requested packet number
- imgrequest.StartPacket = Math.Max(1, newRequest.PacketNumber);
- //Update the requested priority
- imgrequest.Priority = newRequest.Priority;
- UpdateImageInQueue(imgrequest);
- imgrequest.RunUpdate();
- // J2KImage imgrequest2 = new J2KImage(this);
- // imgrequest2.J2KDecoder = m_j2kDecodeModule;
- // imgrequest2.AssetService = m_assetCache;
- // imgrequest2.AgentID = m_client.AgentId;
- // imgrequest2.InventoryAccessModule = m_client.Scene.RequestModuleInterface<IInventoryAccessModule>();
- // imgrequest2.DiscardLevel = newRequest.DiscardLevel;
- // imgrequest2.StartPacket = Math.Max(1, newRequest.PacketNumber);
- // imgrequest2.Priority = newRequest.Priority;
- // imgrequest2.TextureID = newRequest.RequestedAssetID;
- // imgrequest2.Priority = newRequest.Priority;
- //
- // //Add this download to the priority queue
- // AddImageToQueue(imgrequest2);
- //
- // imgrequest2.RunUpdate();
- }
- // else
- // {
- // m_log.DebugFormat(
- // "[LL IMAGE MANAGER]: Ignoring duplicate of existing request for {0} (sequence {1}) from {2} as its request sequence {3} is not greater",
- // newRequest.RequestedAssetID, imgrequest.LastSequence, m_client.Name, newRequest.requestSequence);
- // }
- }
- }
- else
- {
- if (newRequest.DiscardLevel == -1 && newRequest.Priority == 0f)
- {
- //m_log.DebugFormat("[TEX]: (IGN) ID={0}: D={1}, S={2}, P={3}",
- // newRequest.RequestedAssetID, newRequest.DiscardLevel, newRequest.PacketNumber, newRequest.Priority);
- }
- else
- {
- // m_log.DebugFormat(
- // "[LL IMAGE MANAGER]: Received request for {0}, start packet {1} from {2}",
- // newRequest.RequestedAssetID, newRequest.PacketNumber, m_client.Name);
- //m_log.DebugFormat("[TEX]: (NEW) ID={0}: D={1}, S={2}, P={3}",
- // newRequest.RequestedAssetID, newRequest.DiscardLevel, newRequest.PacketNumber, newRequest.Priority);
- imgrequest = new J2KImage(this);
- imgrequest.J2KDecoder = m_j2kDecodeModule;
- imgrequest.AssetService = m_assetCache;
- imgrequest.AgentID = Client.AgentId;
- imgrequest.InventoryAccessModule = Client.Scene.RequestModuleInterface<IInventoryAccessModule>();
- imgrequest.DiscardLevel = newRequest.DiscardLevel;
- imgrequest.StartPacket = Math.Max(1, newRequest.PacketNumber);
- imgrequest.Priority = newRequest.Priority;
- imgrequest.TextureID = newRequest.RequestedAssetID;
- imgrequest.Priority = newRequest.Priority;
- //Add this download to the priority queue
- AddImageToQueue(imgrequest);
- imgrequest.RunUpdate();
- }
- }
- }
- }
- public bool ProcessImageQueue(int packetsToSend)
- {
- int packetsSent = 0;
- while (packetsSent < packetsToSend)
- {
- J2KImage image = GetHighestPriorityImage();
- // If null was returned, the texture priority queue is currently empty
- if (image == null)
- break;
- if (image.IsDecoded)
- {
- int sent;
- bool imageDone = image.SendPackets(Client, packetsToSend - packetsSent, out sent);
- packetsSent += sent;
- // If the send is complete, destroy any knowledge of this transfer
- if (imageDone)
- RemoveImageFromQueue(image);
- }
- else
- {
- // TODO: This is a limitation of how LLImageManager is currently
- // written. Undecoded textures should not be going into the priority
- // queue, because a high priority undecoded texture will clog up the
- // pipeline for a client
- // m_log.DebugFormat(
- // "[LL IMAGE MANAGER]: Exiting image queue processing early on encountering undecoded image {0}",
- // image.TextureID);
- break;
- }
- }
- // if (packetsSent != 0)
- // m_log.DebugFormat("[LL IMAGE MANAGER]: Processed {0} packets from image queue", packetsSent);
- return m_priorityQueue.Count > 0;
- }
- /// <summary>
- /// Faux destructor
- /// </summary>
- public void Close()
- {
- m_shuttingdown = true;
- }
- /// <summary>
- /// Clear the image queue.
- /// </summary>
- /// <returns>The number of requests cleared.</returns>
- public int ClearImageQueue()
- {
- int requestsDeleted;
- lock (m_priorityQueue)
- {
- requestsDeleted = m_priorityQueue.Count;
- // Surprisingly, there doesn't seem to be a clear method at this time.
- while (!m_priorityQueue.IsEmpty)
- m_priorityQueue.DeleteMax();
- }
- return requestsDeleted;
- }
- /// <summary>
- /// Returns an array containing all the images in the queue.
- /// </summary>
- /// <returns></returns>
- public J2KImage[] GetImages()
- {
- lock (m_priorityQueue)
- return m_priorityQueue.ToArray();
- }
- #region Priority Queue Helpers
- private J2KImage GetHighestPriorityImage()
- {
- J2KImage image = null;
- lock (m_syncRoot)
- {
- if (m_priorityQueue.Count > 0)
- {
- try
- {
- image = m_priorityQueue.FindMax();
- }
- catch (Exception) { }
- }
- }
- return image;
- }
- private void AddImageToQueue(J2KImage image)
- {
- image.PriorityQueueHandle = null;
- lock (m_syncRoot)
- {
- try
- {
- m_priorityQueue.Add(ref image.PriorityQueueHandle, image);
- }
- catch (Exception) { }
- }
- }
- private void RemoveImageFromQueue(J2KImage image)
- {
- lock (m_syncRoot)
- {
- try
- {
- m_priorityQueue.Delete(image.PriorityQueueHandle);
- }
- catch (Exception) { }
- }
- }
- private void UpdateImageInQueue(J2KImage image)
- {
- lock (m_syncRoot)
- {
- try
- {
- m_priorityQueue.Replace(image.PriorityQueueHandle, image);
- }
- catch (Exception)
- {
- image.PriorityQueueHandle = null;
- m_priorityQueue.Add(ref image.PriorityQueueHandle, image);
- }
- }
- }
- #endregion Priority Queue Helpers
- }
- }
|