GARbro-mirror/GameRes/BinaryStream.cs
2024-09-15 02:32:24 +08:00

734 lines
22 KiB
C#

//! \file BinaryStream.cs
//! \date Sun Mar 13 00:37:07 2016
//! \brief Wrapper around IO.Stream to read binary streams.
//
// Copyright (C) 2016 by morkt
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Text;
using GameRes.Utility;
namespace GameRes
{
public interface IBinaryStream : IDisposable
{
/// <summary>
/// Name of the stream (could be name of the underlying file) or an empty string.
/// </summary>
string Name { get; set; }
/// <summary>
/// First 4 bytes of the stream as a little-endian integer.
/// </summary>
uint Signature { get; }
Stream AsStream { get; }
bool CanSeek { get; }
long Length { get; }
long Position { get; set; }
long Seek (long offset, SeekOrigin origin);
int Read (byte[] buffer, int offset, int count);
int ReadByte ();
/// <summary>
/// Read next byte from stream without advancing stream position.
/// </summary>
/// <returns>Next byte, or -1 if end of stream is reached.</returns>
int PeekByte ();
sbyte ReadInt8 ();
byte ReadUInt8 ();
short ReadInt16 ();
ushort ReadUInt16 ();
int ReadInt24 ();
int ReadInt32 ();
uint ReadUInt32 ();
long ReadInt64 ();
ulong ReadUInt64 ();
/// <summary>
/// Read first <paramref="size"/> bytes of stream and return them in a copy-on-write array.
/// </summary>
CowArray<byte> ReadHeader (int size);
/// <summary>
/// Read zero-terminated string at most of <paramref name="length"/> bytes length from stream in
/// specified encoding.
/// Advances stream position forward by <paramref name="length"/> bytes, regardless of where zero byte
/// was encountered.
/// </summary>
string ReadCString (int length, Encoding enc);
/// <summary>
/// Does ReadCString with CP932 encoding.
/// </summary>
string ReadCString (int length);
/// <summary>
/// Read zero-terminated string from stream in specefied encoding.
/// Stream is positioned after a zero byte that terminates a string, or at end of stream, whichever
/// comes first.
/// </summary>
string ReadCString (Encoding enc);
/// <summary>
/// Does ReadCString with CP932 encoding.
/// </summary>
string ReadCString ();
/// <summary>
/// Read <paramref name="count"/> bytes starting from the current position into array and return it.
/// If there's less than <paramref name="count"/> bytes left in the stream, array size will be
/// smaller than count.
/// </summary>
byte[] ReadBytes (int count);
}
public class BinaryStream : Stream, IBinaryStream
{
Stream m_source;
bool m_should_dispose;
byte[] m_buffer;
int m_buffer_pos;
int m_buffer_end;
Lazy<uint> m_signature;
byte[] m_header;
int m_header_size;
public string Name { get; set; }
public uint Signature { get { return m_signature.Value; } }
public Stream AsStream { get { return this; } }
public BinaryStream (Stream input, string name, bool leave_open = false)
{
m_buffer = new byte[0x10];
m_buffer_pos = 0;
m_buffer_end = 0;
m_header_size = 0;
Name = name ?? "";
m_source = input;
m_should_dispose = !leave_open;
if (!m_source.CanSeek)
{
m_buffer_end = m_source.Read (m_buffer, 0, 4);
uint signature = LittleEndian.ToUInt32 (m_buffer, 0);
m_signature = new Lazy<uint> (() => signature);
}
else
{
m_signature = new Lazy<uint> (ReadSignature);
}
}
public static IBinaryStream FromFile (string filename)
{
var stream = File.OpenRead (filename);
return new BinaryStream (stream, filename);
}
public static IBinaryStream FromArray (byte[] data, string filename)
{
return new BinMemoryStream (data, filename);
}
public static IBinaryStream FromStream (Stream input, string filename)
{
var bin = input as IBinaryStream;
if (null == bin)
{
var mem_stream = input as MemoryStream;
if (mem_stream != null)
{
bin = new BinMemoryStream (mem_stream, filename);
mem_stream.Dispose();
}
else
bin = new BinaryStream (input, filename);
}
else
bin.Name = filename;
return bin;
}
internal int FindEoS (int start, int length, Encoding enc)
{
int eos_pos = -1;
if (enc.IsUtf16())
{
for (int i = start+1; i < start+length; i += 2)
{
if (m_buffer[i-1] == 0 && m_buffer[i] == 0)
{
eos_pos = i - 1;
break;
}
}
}
else
{
eos_pos = Array.IndexOf<byte> (m_buffer, 0, start, length);
}
return eos_pos;
}
uint ReadSignature ()
{
if (m_header_size >= 4)
{
return LittleEndian.ToUInt32 (m_header, 0);
}
var pos = Position;
if (pos != 0)
Position = 0;
uint signature = ReadUInt32();
Position = pos;
return signature;
}
public CowArray<byte> ReadHeader (int size)
{
if (!CanSeek)
throw new NotSupportedException ("Unseekable stream");
if (m_header_size < size)
{
if (null == m_header || m_header.Length < size)
Array.Resize (ref m_header, (size + 0xF) & ~0xF);
Position = m_header_size;
m_header_size += Read (m_header, m_header_size, size - m_header_size);
}
if (size > m_header_size)
{
Position = m_header_size;
throw new EndOfStreamException();
}
Position = size;
return new CowArray<byte> (m_header, 0, size);
}
private int FillBuffer (int count)
{
int cached = m_buffer_end - m_buffer_pos;
if (count <= cached)
return count;
if (m_buffer_pos + count > m_buffer.Length)
{
if (count > m_buffer.Length)
{
var copy = new byte[(count + 0xF) & ~0xF];
if (cached > 0)
Buffer.BlockCopy (m_buffer, m_buffer_pos, copy, 0, cached);
m_buffer = copy;
}
else if (cached > 0)
{
Buffer.BlockCopy (m_buffer, m_buffer_pos, m_buffer, 0, cached);
}
m_buffer_pos = 0;
m_buffer_end = cached;
}
m_buffer_end += m_source.Read (m_buffer, m_buffer_end, count - cached);
return Math.Min (count, m_buffer_end - m_buffer_pos);
}
public int PeekByte ()
{
if (1 != FillBuffer (1))
return -1;
return m_buffer[m_buffer_pos];
}
public sbyte ReadInt8 ()
{
return (sbyte)ReadUInt8();
}
public byte ReadUInt8 ()
{
if (1 != FillBuffer (1))
throw new EndOfStreamException();
return m_buffer[m_buffer_pos++];
}
public short ReadInt16 ()
{
if (2 != FillBuffer (2))
throw new EndOfStreamException();
short v = LittleEndian.ToInt16 (m_buffer, m_buffer_pos);
m_buffer_pos += 2;
return v;
}
public ushort ReadUInt16 ()
{
return (ushort)ReadInt16();
}
public int ReadInt24 ()
{
if (3 != FillBuffer (3))
throw new EndOfStreamException();
int v = m_buffer.ToInt24 (m_buffer_pos);
m_buffer_pos += 3;
return v;
}
public int ReadInt32 ()
{
if (4 != FillBuffer (4))
throw new EndOfStreamException();
int v = LittleEndian.ToInt32 (m_buffer, m_buffer_pos);
m_buffer_pos += 4;
return v;
}
public uint ReadUInt32 ()
{
return (uint)ReadInt32();
}
public long ReadInt64 ()
{
if (8 != FillBuffer (8))
throw new EndOfStreamException();
long v = LittleEndian.ToInt64 (m_buffer, m_buffer_pos);
m_buffer_pos += 8;
return v;
}
public ulong ReadUInt64 ()
{
return (ulong)ReadInt64();
}
public string ReadCString (int length)
{
return ReadCString (length, Encodings.cp932);
}
public string ReadCString (int length, Encoding enc)
{
length = FillBuffer (length);
int i = FindEoS(m_buffer_pos, length, enc) - m_buffer_pos;
string s = enc.GetString (m_buffer, m_buffer_pos, i);
m_buffer_pos += length;
return s;
}
public string ReadCString ()
{
return ReadCString (Encodings.cp932);
}
public string ReadCString (Encoding enc)
{
int count = 0;
int cached;
for (;;)
{
cached = FillBuffer (count+1);
if (cached < count+1)
break;
if (0 == m_buffer[m_buffer_pos+count])
break;
++count;
}
var s = enc.GetString (m_buffer, m_buffer_pos, count);
m_buffer_pos += Math.Min (count+1, cached);
return s;
}
public byte[] ReadBytes (int count)
{
var buffer = new byte[count];
int pos = 0;
int cached = Math.Min (m_buffer_end - m_buffer_pos, count);
if (cached > 0)
{
Buffer.BlockCopy (m_buffer, m_buffer_pos, buffer, 0, cached);
pos = cached;
m_buffer_pos += cached;
count -= cached;
}
if (count > 0)
pos += m_source.Read (buffer, pos, count);
if (pos < buffer.Length)
{
var copy = new byte[pos];
Buffer.BlockCopy (buffer, 0, copy, 0, copy.Length);
buffer = copy;
}
return buffer;
}
#region IO.Stream Members
public override bool CanRead { get { return m_source.CanRead; } }
public override bool CanSeek { get { return m_source.CanSeek; } }
public override bool CanWrite { get { return false; } }
public override long Length { get { return m_source.Length; } }
public override long Position
{
get { return m_source.Position - (m_buffer_end - m_buffer_pos); }
set
{
m_buffer_end = m_buffer_pos = 0;
m_source.Position = value;
}
}
public override int Read (byte[] buffer, int offset, int count)
{
int read = 0;
int cached = Math.Min (m_buffer_end - m_buffer_pos, count);
if (cached > 0)
{
Buffer.BlockCopy (m_buffer, m_buffer_pos, buffer, offset, cached);
m_buffer_pos += cached;
offset += cached;
count -= cached;
read += cached;
}
if (count > 0)
{
read += m_source.Read (buffer, offset, count);
}
return read;
}
public override int ReadByte ()
{
int b;
if (m_buffer_pos < m_buffer_end)
b = m_buffer[m_buffer_pos++];
else
b = m_source.ReadByte();
return b;
}
public override void Flush()
{
m_source.Flush();
}
public override long Seek (long offset, SeekOrigin origin)
{
if (SeekOrigin.Current == origin)
offset -= m_buffer_end - m_buffer_pos;
m_buffer_end = m_buffer_pos = 0;
return m_source.Seek (offset, origin);
}
public override void SetLength (long length)
{
throw new NotSupportedException ("BinaryStream.SetLength method is not supported");
}
public override void Write (byte[] buffer, int offset, int count)
{
throw new NotSupportedException ("BinaryStream.Write method is not supported");
}
public override void WriteByte (byte value)
{
throw new NotSupportedException ("BinaryStream.WriteByte method is not supported");
}
#endregion
#region IDisposable Members
bool _disposed = false;
protected override void Dispose (bool disposing)
{
if (_disposed)
return;
if (disposing)
{
if (m_should_dispose)
m_source.Dispose();
}
_disposed = true;
base.Dispose (disposing);
}
#endregion
}
public class BinMemoryStream : Stream, IBinaryStream
{
byte[] m_source;
int m_start;
int m_length;
int m_position;
uint m_signature;
public string Name { get; set; }
public uint Signature { get { return m_signature; } }
public Stream AsStream { get { return this; } }
public BinMemoryStream (byte[] input, string name = "") : this (input, 0, input.Length, name)
{ }
public BinMemoryStream (byte[] input, int pos, int length, string name = "")
{
m_source = input;
m_start = pos;
m_length = length;
Init (name);
}
public BinMemoryStream (MemoryStream input, string name = "")
{
try
{
m_source = input.GetBuffer();
if (null == m_source)
m_source = Array.Empty<byte>();
}
catch (UnauthorizedAccessException)
{
m_source = input.ToArray();
}
m_start = 0;
m_length = (int)input.Length;
Init (name);
}
void Init (string name)
{
m_position = 0;
Name = name ?? "";
if (m_length >= 4)
m_signature = LittleEndian.ToUInt32 (m_source, m_start);
}
public CowArray<byte> ReadHeader (int size)
{
if (size > m_length)
{
m_position = m_length;
throw new EndOfStreamException();
}
m_position = size;
return new CowArray<byte> (m_source, m_start, size);
}
public int PeekByte ()
{
if (m_position >= m_length)
return -1;
return m_source[m_start+m_position];
}
public sbyte ReadInt8 ()
{
return (sbyte)ReadUInt8();
}
public byte ReadUInt8 ()
{
if (m_position >= m_length)
throw new EndOfStreamException();
return m_source[m_start+m_position++];
}
public short ReadInt16 ()
{
if (m_length - m_position < 2)
throw new EndOfStreamException();
short v = LittleEndian.ToInt16 (m_source, m_start+m_position);
m_position += 2;
return v;
}
public ushort ReadUInt16 ()
{
return (ushort)ReadInt16();
}
public int ReadInt24 ()
{
if (m_length - m_position < 3)
throw new EndOfStreamException();
int v = m_source.ToInt24 (m_start+m_position);
m_position += 3;
return v;
}
public int ReadInt32 ()
{
if (m_length - m_position < 4)
throw new EndOfStreamException();
int v = LittleEndian.ToInt32 (m_source, m_start+m_position);
m_position += 4;
return v;
}
public uint ReadUInt32 ()
{
return (uint)ReadInt32();
}
public long ReadInt64 ()
{
if (m_length - m_position < 8)
throw new EndOfStreamException();
long v = LittleEndian.ToInt64 (m_source, m_start+m_position);
m_position += 8;
return v;
}
public ulong ReadUInt64 ()
{
return (ulong)ReadInt64();
}
public string ReadCString (int length)
{
return ReadCString (length, Encodings.cp932);
}
public string ReadCString (int length, Encoding enc)
{
int start = m_start+m_position;
length = Math.Min (length, m_length - m_position);
int eos_pos = FindEoS (start, length, enc);
if (-1 == eos_pos)
eos_pos = start+length;
m_position += length;
return enc.GetString (m_source, start, eos_pos-start);
}
public string ReadCString ()
{
return ReadCString (Encodings.cp932);
}
public string ReadCString (Encoding enc)
{
int start = m_start+m_position;
int length = m_length-m_position;
int eos_pos = FindEoS (start, length, enc);
int count;
if (-1 == eos_pos)
{
count = length;
m_position = m_length;
}
else
{
count = eos_pos - start;
int eos_size = enc.IsUtf16() ? 2 : 1;
m_position += count + eos_size;
}
return enc.GetString (m_source, start, count);
}
public byte[] ReadBytes (int count)
{
count = Math.Min (count, m_length - m_position);
var buffer = new byte[count];
Buffer.BlockCopy (m_source, m_start+m_position, buffer, 0, count);
m_position += count;
return buffer;
}
internal int FindEoS (int start, int length, Encoding enc)
{
int eos_pos = -1;
if (enc.IsUtf16())
{
for (int i = start+1; i < start+length; i += 2)
{
if (m_source[i-1] == 0 && m_source[i] == 0)
{
eos_pos = i - 1;
break;
}
}
}
else
{
eos_pos = Array.IndexOf<byte> (m_source, 0, start, length);
}
return eos_pos;
}
#region IO.Stream Members
public override bool CanRead { get { return true; } }
public override bool CanSeek { get { return true; } }
public override bool CanWrite { get { return false; } }
public override long Length { get { return m_length; } }
public override long Position
{
get { return m_position; }
set { m_position = (int)Math.Max (Math.Min (m_length, value), 0); }
}
public override int Read (byte[] buffer, int offset, int count)
{
count = Math.Min (count, m_length - m_position);
Buffer.BlockCopy (m_source, m_start+m_position, buffer, offset, count);
m_position += count;
return count;
}
public override int ReadByte ()
{
if (m_position < m_length)
return m_source[m_start+m_position++];
else
return -1;
}
public override void Flush()
{
}
public override long Seek (long offset, SeekOrigin origin)
{
if (SeekOrigin.Begin == origin)
Position = offset;
else if (SeekOrigin.Current == origin)
Position = m_position + offset;
else
Position = Length + offset;
return m_position;
}
public override void SetLength (long length)
{
throw new NotSupportedException ("BinaryStream.SetLength method is not supported");
}
public override void Write (byte[] buffer, int offset, int count)
{
throw new NotSupportedException ("BinaryStream.Write method is not supported");
}
public override void WriteByte (byte value)
{
throw new NotSupportedException ("BinaryStream.WriteByte method is not supported");
}
#endregion
}
}