/// <summary>
/// Function to load the image to be used a thumbnail.
/// </summary>
/// <param name="thumbnailCodec">The codec for the thumbnail images.</param>
/// <param name="thumbnailFile">The path to the thumbnail file.</param>
/// <param name="content">The content being thumbnailed.</param>
/// <param name="cancelToken">The token used to cancel the operation.</param>
/// <returns>The thumbnail image, and a flag to indicate whether the thumbnail needs conversion.</returns>
private (IGorgonImage thumbnailImage, bool needsConversion) LoadThumbNailImage(IGorgonImageCodec thumbnailCodec, FileInfo thumbnailFile, IContentFile content, CancellationToken cancelToken)
{
IGorgonImage result;
Stream inStream = null;
try
{
// If we've already got the file, then leave.
if (thumbnailFile.Exists)
{
inStream = thumbnailFile.Open(FileMode.Open, FileAccess.Read, FileShare.Read);
result = thumbnailCodec.LoadFromStream(inStream);
return(cancelToken.IsCancellationRequested ? (null, false) : (result, false));
}
inStream = content.OpenRead();
result = _ddsCodec.LoadFromStream(inStream);
return(result, true);
}
catch (Exception ex)
{
CommonServices.Log.Print($"[ERROR] Cannot create thumbnail for '{content.Path}'", LoggingLevel.Intermediate);
CommonServices.Log.LogException(ex);
return(null, false);
}
finally
{
inStream?.Dispose();
}
}
/// <summary>Function to provide initialization for the plugin.</summary>
/// <remarks>This method is only called when the plugin is loaded at startup.</remarks>
protected override void OnInitialize()
{
ViewFactory.Register <ISpriteContent>(() => new SpriteEditorView());
// Get built-in codec list.
_defaultCodec = new GorgonV3SpriteBinaryCodec(GraphicsContext.Renderer2D);
SpriteEditorSettings settings = ContentPlugInService.ReadContentSettings <SpriteEditorSettings>(typeof(SpriteEditorPlugIn).FullName, new JsonSharpDxRectConverter());
if (settings != null)
{
_settings = settings;
}
_ddsCodec = new GorgonCodecDds();
using (var noImageStream = new MemoryStream(Resources.NoImage_256x256))
{
_noImage = _ddsCodec.LoadFromStream(noImageStream);
}
_bgPattern = GorgonTexture2DView.CreateTexture(GraphicsContext.Graphics, new GorgonTexture2DInfo($"Sprite_Editor_Bg_Preview_{Guid.NewGuid():N}")
{
Width = EditorCommonResources.CheckerBoardPatternImage.Width,
Height = EditorCommonResources.CheckerBoardPatternImage.Height
}, EditorCommonResources.CheckerBoardPatternImage);
_rtv = GorgonRenderTarget2DView.CreateRenderTarget(GraphicsContext.Graphics, new GorgonTexture2DInfo($"SpriteEditor_Rtv_Preview_{Guid.NewGuid():N}")
{
Width = 256,
Height = 256,
Format = BufferFormat.R8G8B8A8_UNorm,
Binding = TextureBinding.ShaderResource
});
}
/// <summary>
/// Function to load the image to be used a thumbnail.
/// </summary>
/// <param name="thumbnailCodec">The codec for the thumbnail images.</param>
/// <param name="thumbnailFile">The path to the thumbnail file.</param>
/// <param name="content">The content being thumbnailed.</param>
/// <param name="fileManager">The file manager used to handle content files.</param>
/// <param name="cancelToken">The token used to cancel the operation.</param>
/// <returns>The image, image content file and sprite, or just the thumbnail image if it was cached (sprite will be null).</returns>
private (IGorgonImage image, IContentFile imageFile, GorgonSprite sprite) LoadThumbnailImage(IGorgonImageCodec thumbnailCodec, FileInfo thumbnailFile, IContentFile content, IContentFileManager fileManager, CancellationToken cancelToken)
{
IGorgonImage spriteImage;
Stream inStream = null;
Stream imgStream = null;
try
{
// If we've already got the file, then leave.
if (thumbnailFile.Exists)
{
inStream = thumbnailFile.Open(FileMode.Open, FileAccess.Read, FileShare.Read);
spriteImage = thumbnailCodec.LoadFromStream(inStream);
#pragma warning disable IDE0046 // Convert to conditional expression
if (cancelToken.IsCancellationRequested)
{
return(null, null, null);
}
#pragma warning restore IDE0046 // Convert to conditional expression
return(spriteImage, null, null);
}
IContentFile imageFile = FindImage(content, fileManager);
if (imageFile == null)
{
return(_noImage.Clone(), null, null);
}
imgStream = imageFile.OpenRead();
inStream = content.OpenRead();
if ((!_ddsCodec.IsReadable(imgStream)) ||
(!_defaultCodec.IsReadable(inStream)))
{
return(_noImage.Clone(), null, null);
}
spriteImage = _ddsCodec.LoadFromStream(imgStream);
GorgonSprite sprite = _defaultCodec.FromStream(inStream);
return(spriteImage, imageFile, sprite);
}
catch (Exception ex)
{
CommonServices.Log.Print($"[ERROR] Cannot create thumbnail for '{content.Path}'", LoggingLevel.Intermediate);
CommonServices.Log.LogException(ex);
return(null, null, null);
}
finally
{
imgStream?.Dispose();
inStream?.Dispose();
}
}
/// <summary>
/// Function to decompress a block compressed file into a standard pixel format.
/// </summary>
/// <param name="imageFile">The file to decompress</param>
/// <param name="metadata">The metadata for the file.</param>
/// <returns>The decompressed image.</returns>
public IGorgonImage Decompress(ref IGorgonVirtualFile imageFile, IGorgonImageInfo metadata)
{
string directory = Path.GetDirectoryName(imageFile.PhysicalFile.FullPath);
IGorgonImage result = null;
Process texConvProcess = null;
Stream inStream = null;
IGorgonVirtualFile decodedFile = null;
var info = new ProcessStartInfo
{
Arguments = $"-f {_d3dFormats[metadata.Format]} -y -m {metadata.MipCount} -fl 12.0 -ft DDS -o \"{directory}\" -nologo -px decoded {imageFile.PhysicalFile.FullPath}\"",
ErrorDialog = true,
FileName = _texConv.FullName,
WorkingDirectory = directory,
UseShellExecute = false,
#if DEBUG
CreateNoWindow = false,
#else
CreateNoWindow = true,
#endif
RedirectStandardError = true,
RedirectStandardOutput = true
};
try
{
texConvProcess = Process.Start(info);
if (texConvProcess == null)
{
return(null);
}
texConvProcess.WaitForExit();
_writer.FileSystem.Refresh();
imageFile = _writer.FileSystem.GetFile(imageFile.FullPath);
decodedFile = _writer.FileSystem.GetFile(imageFile.Directory.FullPath + "decoded" + imageFile.Name);
inStream = decodedFile.OpenStream();
result = _codec.LoadFromStream(inStream);
return(result);
}
finally
{
texConvProcess?.Dispose();
inStream?.Dispose();
if (decodedFile != null)
{
_writer.DeleteFile(decodedFile.FullPath);
}
}
}
/// <summary>
/// Function to load the images for the textures.
/// </summary>
/// <param name="path">The path to the textures.</param>
/// <returns>A list of loaded images.</returns>
private IReadOnlyDictionary <string, IGorgonImage> LoadImageData(string path)
{
var result = new Dictionary <string, IGorgonImage>(StringComparer.OrdinalIgnoreCase);
IReadOnlyList <IGorgonVirtualFile> textureFiles = _fileSystem.GetContentItems(path, CommonEditorContentTypes.ImageType);
foreach (IGorgonVirtualFile imagePath in textureFiles)
{
using (Stream stream = imagePath.OpenStream())
{
IGorgonImage image = _imageCodec.LoadFromStream(stream);
result[imagePath.FullPath] = image;
}
}
return(result);
}
/// <summary>
/// Function to load a texture from a <see cref="Stream"/>.
/// </summary>
/// <param name="graphics">The graphics interface that will own the texture.</param>
/// <param name="stream">The stream containing the texture image data.</param>
/// <param name="codec">The codec that is used to decode the the data in the stream.</param>
/// <param name="size">[Optional] The size of the image in the stream, in bytes.</param>
/// <param name="options">[Optional] Options used to further define the texture.</param>
/// <returns>A new <see cref="GorgonTexture3DReadWriteView"/></returns>
/// <exception cref="ArgumentNullException">Thrown when the <paramref name="graphics"/>, <paramref name="stream"/>, or the <paramref name="codec"/> parameter is <b>null</b>.</exception>
/// <exception cref="IOException">Thrown if the <paramref name="stream"/> is write only.</exception>
/// <exception cref="EndOfStreamException">Thrown if reading the image would move beyond the end of the <paramref name="stream"/>.</exception>
/// <remarks>
/// <para>
/// This will load an <see cref="IGorgonImage"/> from a <paramref name="stream"/> and put it into a <see cref="GorgonTexture3D"/> object and return a <see cref="GorgonTexture3DReadWriteView"/>.
/// </para>
/// <para>
/// If the <paramref name="size"/> option is specified, then the method will read from the stream up to that number of bytes, so it is up to the user to provide an accurate size. If it is omitted
/// then the <c>stream length - stream position</c> is used as the total size.
/// </para>
/// <para>
/// If specified, the <paramref name="options"/>parameter will define how Gorgon and shaders should handle the texture. The <see cref="GorgonTextureLoadOptions"/> type contains the following:
/// <list type="bullet">
/// <item>
/// <term>Binding</term>
/// <description>When defined, will indicate the <see cref="TextureBinding"/> that defines how the texture will be bound to the graphics pipeline. If it is omitted, then the binding will be
/// <see cref="TextureBinding.ShaderResource"/>.</description>
/// </item>
/// <item>
/// <term>Usage</term>
/// <description>When defined, will indicate the preferred usage for the texture. If it is omitted, then the usage will be set to <see cref="ResourceUsage.Default"/>.</description>
/// </item>
/// <item>
/// <term>Multisample info</term>
/// <description>When defined (i.e. not <b>null</b>), defines the multisampling to apply to the texture. If omitted, then the default is <see cref="GorgonMultisampleInfo.NoMultiSampling"/>.</description>
/// </item>
/// </list>
/// </para>
/// <para>
/// Since the <see cref="GorgonTexture3D"/> created by this method is linked to the <see cref="GorgonTexture3DReadWriteView"/> returned, disposal of either one will dispose of the other on your behalf. If
/// the user created a <see cref="GorgonTexture3DReadWriteView"/> from the <see cref="GorgonTexture3D.GetShaderResourceView"/> method on the <see cref="GorgonTexture3D"/>, then it's assumed the user knows
/// what they are doing and will handle the disposal of the texture and view on their own.
/// </para>
/// </remarks>
public static GorgonTexture3DReadWriteView FromStream(GorgonGraphics graphics,
Stream stream,
IGorgonImageCodec codec,
long?size = null,
GorgonTextureLoadOptions options = null)
{
if (graphics == null)
{
throw new ArgumentNullException(nameof(graphics));
}
if (stream == null)
{
throw new ArgumentNullException(nameof(stream));
}
if (codec == null)
{
throw new ArgumentNullException(nameof(codec));
}
if (!stream.CanRead)
{
throw new IOException(Resources.GORGFX_ERR_STREAM_WRITE_ONLY);
}
if (size == null)
{
size = stream.Length - stream.Position;
}
if ((stream.Length - stream.Position) < size)
{
throw new EndOfStreamException();
}
using (IGorgonImage image = codec.LoadFromStream(stream, size))
{
GorgonTexture3D texture = image.ToTexture3D(graphics, options);
GorgonTexture3DReadWriteView view = texture.GetReadWriteView();
view.OwnsResource = true;
return(view);
}
}
/// <summary>
/// Function to import an image file from the physical file system into the current image.
/// </summary>
/// <param name="codec">The codec used to open the file.</param>
/// <param name="filePath">The path to the file to import.</param>
/// <returns>The source file information, image data, the virtual file entry for the working file and the original pixel format of the file.</returns>
public (FileInfo file, IGorgonImage image, IGorgonVirtualFile workingFile, BufferFormat originalFormat) ImportImage(IGorgonImageCodec codec, string filePath)
{
var file = new FileInfo(filePath);
IGorgonImageCodec importCodec = codec;
IGorgonImageInfo metaData = null;
IGorgonVirtualFile workFile = null;
IGorgonImage importImage = null;
string workFilePath = $"{Path.GetFileNameWithoutExtension(filePath)}_import_{Guid.NewGuid().ToString("N")}";
// Try to determine if we can actually read the file using an installed codec, if we can't, then try to find a suitable codec.
using (FileStream stream = File.Open(filePath, FileMode.Open, FileAccess.Read, FileShare.Read))
{
if ((importCodec == null) || (!importCodec.IsReadable(stream)))
{
importCodec = null;
foreach (IGorgonImageCodec newCodec in InstalledCodecs.Codecs.Where(item => (item.CodecCommonExtensions.Count > 0) && (item.CanDecode)))
{
if (newCodec.IsReadable(stream))
{
importCodec = newCodec;
break;
}
}
}
if (importCodec == null)
{
throw new GorgonException(GorgonResult.CannotRead, string.Format(Resources.GORIMG_ERR_NO_CODEC, filePath));
}
metaData = importCodec.GetMetaData(stream);
// We absolutely need to have an extension, or else the texconv tool will not work.
var codecExtension = new GorgonFileExtension(importCodec.CodecCommonExtensions[0]);
_log.Print($"Adding {codecExtension.Extension} extension to working file or else external tools may not be able to read it.", LoggingLevel.Verbose);
workFilePath = $"{workFilePath}.{codecExtension.Extension}";
using (Stream outStream = ScratchArea.OpenStream(workFilePath, FileMode.Create))
{
stream.CopyTo(outStream);
}
}
workFile = ScratchArea.FileSystem.GetFile(workFilePath);
var formatInfo = new GorgonFormatInfo(metaData.Format);
// This is always in DDS format.
if (formatInfo.IsCompressed)
{
_log.Print($"Image is compressed using [{formatInfo.Format}] as its pixel format.", LoggingLevel.Intermediate);
if (_compressor == null)
{
throw new GorgonException(GorgonResult.CannotRead, string.Format(Resources.GORIMG_ERR_COMPRESSED_FILE, formatInfo.Format));
}
_log.Print($"Loading image '{workFile.FullPath}'...", LoggingLevel.Simple);
importImage = _compressor.Decompress(ref workFile, metaData);
if (importImage == null)
{
throw new GorgonException(GorgonResult.CannotRead, string.Format(Resources.GORIMG_ERR_COMPRESSED_FILE, formatInfo.Format));
}
_log.Print($"Loaded compressed ([{formatInfo.Format}]) image data as [{importImage.Format}]", LoggingLevel.Intermediate);
}
else
{
using (Stream workStream = workFile.OpenStream())
{
importImage = importCodec.LoadFromStream(workStream);
}
}
return(file, importImage, workFile, metaData.Format);
}
