1b33c96954667ba382fa595baf7b31290bfdd517vboxsync//
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync// � Copyright Henrik Ravn 2004
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync//
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync// Use, modification and distribution are subject to the Boost Software License, Version 1.0.
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync// (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync//
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsyncusing System;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsyncusing System.Runtime.InteropServices;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsyncnamespace DotZLib
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync{
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// Implements the common functionality needed for all <see cref="Codec"/>s
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync public abstract class CodecBase : Codec, IDisposable
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync {
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync #region Data members
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// Instance of the internal zlib buffer structure that is
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// passed to all functions in the zlib dll
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync internal ZStream _ztream = new ZStream();
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// True if the object instance has been disposed, false otherwise
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync protected bool _isDisposed = false;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// The size of the internal buffers
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync protected const int kBufferSize = 16384;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync private byte[] _outBuffer = new byte[kBufferSize];
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync private byte[] _inBuffer = new byte[kBufferSize];
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync private GCHandle _hInput;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync private GCHandle _hOutput;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync private uint _checksum = 0;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync #endregion
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// Initializes a new instance of the <c>CodeBase</c> class.
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync public CodecBase()
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync {
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync try
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync {
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync _hInput = GCHandle.Alloc(_inBuffer, GCHandleType.Pinned);
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync _hOutput = GCHandle.Alloc(_outBuffer, GCHandleType.Pinned);
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync }
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync catch (Exception)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync {
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync CleanUp(false);
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync throw;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync }
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync }
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync #region Codec Members
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// Occurs when more processed data are available.
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync public event DataAvailableHandler DataAvailable;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// Fires the <see cref="DataAvailable"/> event
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync protected void OnDataAvailable()
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync {
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync if (_ztream.total_out > 0)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync {
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync if (DataAvailable != null)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync DataAvailable( _outBuffer, 0, (int)_ztream.total_out);
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync resetOutput();
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync }
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync }
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// Adds more data to the codec to be processed.
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <param name="data">Byte array containing the data to be added to the codec</param>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <remarks>Adding data may, or may not, raise the <c>DataAvailable</c> event</remarks>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync public void Add(byte[] data)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync {
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync Add(data,0,data.Length);
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync }
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// Adds more data to the codec to be processed.
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <param name="data">Byte array containing the data to be added to the codec</param>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <param name="offset">The index of the first byte to add from <c>data</c></param>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <param name="count">The number of bytes to add</param>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <remarks>Adding data may, or may not, raise the <c>DataAvailable</c> event</remarks>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <remarks>This must be implemented by a derived class</remarks>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync public abstract void Add(byte[] data, int offset, int count);
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// Finishes up any pending data that needs to be processed and handled.
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <remarks>This must be implemented by a derived class</remarks>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync public abstract void Finish();
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// Gets the checksum of the data that has been added so far
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync public uint Checksum { get { return _checksum; } }
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync #endregion
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync #region Destructor & IDisposable stuff
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// Destroys this instance
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync ~CodecBase()
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync {
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync CleanUp(false);
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync }
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// Releases any unmanaged resources and calls the <see cref="CleanUp()"/> method of the derived class
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync public void Dispose()
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync {
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync CleanUp(true);
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync }
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// Performs any codec specific cleanup
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <remarks>This must be implemented by a derived class</remarks>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync protected abstract void CleanUp();
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync // performs the release of the handles and calls the dereived CleanUp()
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync private void CleanUp(bool isDisposing)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync {
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync if (!_isDisposed)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync {
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync CleanUp();
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync if (_hInput.IsAllocated)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync _hInput.Free();
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync if (_hOutput.IsAllocated)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync _hOutput.Free();
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync _isDisposed = true;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync }
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync }
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync #endregion
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync #region Helper methods
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// Copies a number of bytes to the internal codec buffer - ready for proccesing
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <param name="data">The byte array that contains the data to copy</param>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <param name="startIndex">The index of the first byte to copy</param>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <param name="count">The number of bytes to copy from <c>data</c></param>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync protected void copyInput(byte[] data, int startIndex, int count)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync {
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync Array.Copy(data, startIndex, _inBuffer,0, count);
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync _ztream.next_in = _hInput.AddrOfPinnedObject();
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync _ztream.total_in = 0;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync _ztream.avail_in = (uint)count;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync }
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// Resets the internal output buffers to a known state - ready for processing
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync protected void resetOutput()
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync {
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync _ztream.total_out = 0;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync _ztream.avail_out = kBufferSize;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync _ztream.next_out = _hOutput.AddrOfPinnedObject();
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync }
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// Updates the running checksum property
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// </summary>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /// <param name="newSum">The new checksum value</param>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync protected void setChecksum(uint newSum)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync {
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync _checksum = newSum;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync }
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync #endregion
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync }
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync}