OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
J2KDecoderCommandModule.cs
Go to the documentation of this file.
1 /*
2  * Copyright (c) Contributors, http://opensimulator.org/
3  * See CONTRIBUTORS.TXT for a full list of copyright holders.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  * * Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * * Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * * Neither the name of the OpenSimulator Project nor the
13  * names of its contributors may be used to endorse or promote products
14  * derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 using System;
29 using System.Collections.Generic;
30 using System.IO;
31 using System.Reflection;
32 using System.Text;
33 using log4net;
34 using Mono.Addins;
35 using Nini.Config;
36 using OpenMetaverse;
37 using OpenMetaverse.Imaging;
38 using OpenSim.Framework;
39 using OpenSim.Framework.Console;
40 using OpenSim.Region.Framework.Interfaces;
41 using OpenSim.Region.Framework.Scenes;
42 
43 namespace OpenSim.Region.OptionalModules.Agent.TextureSender
44 {
51  [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "J2KDecoderCommandModule")]
53  {
54 // private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
55 
56  private Scene m_scene;
57 
58  public string Name { get { return "Asset Information Module"; } }
59 
60  public Type ReplaceableInterface { get { return null; } }
61 
62  public void Initialise(IConfigSource source)
63  {
64 // m_log.DebugFormat("[J2K DECODER COMMAND MODULE]: INITIALIZED MODULE");
65  }
66 
67  public void PostInitialise()
68  {
69 // m_log.DebugFormat("[J2K DECODER COMMAND MODULE]: POST INITIALIZED MODULE");
70  }
71 
72  public void Close()
73  {
74 // m_log.DebugFormat("[J2K DECODER COMMAND MODULE]: CLOSED MODULE");
75  }
76 
77  public void AddRegion(Scene scene)
78  {
79 // m_log.DebugFormat("[J2K DECODER COMMAND MODULE]: REGION {0} ADDED", scene.RegionInfo.RegionName);
80  }
81 
82  public void RemoveRegion(Scene scene)
83  {
84 // m_log.DebugFormat("[J2K DECODER COMMAND MODULE]: REGION {0} REMOVED", scene.RegionInfo.RegionName);
85  }
86 
87  public void RegionLoaded(Scene scene)
88  {
89 // m_log.DebugFormat("[J2K DECODER COMMAND MODULE]: REGION {0} LOADED", scene.RegionInfo.RegionName);
90 
91  if (m_scene == null)
92  m_scene = scene;
93 
94  MainConsole.Instance.Commands.AddCommand(
95  "Assets",
96  false,
97  "j2k decode",
98  "j2k decode <ID>",
99  "Do JPEG2000 decoding of an asset.",
100  "This is for debugging purposes. The asset id given must contain JPEG2000 data.",
101  HandleDecode);
102  }
103 
104  void HandleDecode(string module, string[] args)
105  {
106  if (args.Length < 3)
107  {
108  MainConsole.Instance.Output("Usage is j2k decode <ID>");
109  return;
110  }
111 
112  UUID assetId;
113  string rawAssetId = args[2];
114 
115  if (!UUID.TryParse(rawAssetId, out assetId))
116  {
117  MainConsole.Instance.OutputFormat("ERROR: {0} is not a valid ID format", rawAssetId);
118  return;
119  }
120 
121  AssetBase asset = m_scene.AssetService.Get(assetId.ToString());
122  if (asset == null)
123  {
124  MainConsole.Instance.OutputFormat("ERROR: No asset found with ID {0}", assetId);
125  return;
126  }
127 
128  if (asset.Type != (sbyte)AssetType.Texture)
129  {
130  MainConsole.Instance.OutputFormat("ERROR: Asset {0} is not a texture type", assetId);
131  return;
132  }
133 
134  IJ2KDecoder decoder = m_scene.RequestModuleInterface<IJ2KDecoder>();
135  if (decoder == null)
136  {
137  MainConsole.Instance.OutputFormat("ERROR: No IJ2KDecoder module available");
138  return;
139  }
140 
141  OpenJPEG.J2KLayerInfo[] layers;
142  int components;
143  if (decoder.Decode(assetId, asset.Data, out layers, out components))
144  {
145  MainConsole.Instance.OutputFormat(
146  "Successfully decoded asset {0} with {1} layers and {2} components",
147  assetId, layers.Length, components);
148  }
149  else
150  {
151  MainConsole.Instance.OutputFormat("Decode of asset {0} failed", assetId);
152  }
153  }
154  }
155 }
void Close()
This is the inverse to Initialise. After a Close(), this instance won't be usable anymore...
void PostInitialise()
This is called exactly once after all the shared region-modules have been instanciated and IRegionMod...
bool Decode(UUID assetID, byte[] j2kData)
Provides a synchronous decode so that caller can be assured that this executes before the next line ...
Commands for the J2KDecoder module. For debugging purposes.
void RegionLoaded(Scene scene)
This will be called once for every scene loaded. In a shared module this will be multiple times in on...
Asset class. All Assets are reference by this class or a class derived from this class ...
Definition: AssetBase.cs:49
void RemoveRegion(Scene scene)
This is called whenever a Scene is removed. For shared modules, this can happen several times...
void Initialise(IConfigSource source)
This is called to initialize the region module. For shared modules, this is called exactly once...
void AddRegion(Scene scene)
This is called whenever a Scene is added. For shared modules, this can happen several times...
Interactive OpenSim region server
Definition: OpenSim.cs:55