DeflateStream Class
.NET Framework Class Library
DeflateStream Class

Updated: August 2009

Provides methods and properties for compressing and decompressing streams using the Deflate algorithm.

Namespace:  System.IO.Compression
Assembly:  System (in System.dll)
Visual Basic (Declaration)
Public Class DeflateStream _
    Inherits Stream
Visual Basic (Usage)
Dim instance As DeflateStream
C#
public class DeflateStream : Stream
Visual C++
public ref class DeflateStream : public Stream
JScript
public class DeflateStream extends Stream

This class represents the Deflate algorithm, an industry standard algorithm for lossless file compression and decompression. It uses a combination of the LZ77 algorithm and Huffman coding. Data can be produced or consumed, even for an arbitrarily long, sequentially presented input data stream, using only previously bound amount of intermediate storage. The format can be implemented readily in a manner not covered by patents. For more information, see RFC 1951. "DEFLATE Compressed Data Format Specification version 1.3." This class cannot be used to compress files larger than 4 GB.

This class does not inherently provide functionality for adding files to or extracting files from .zip archives.

The GZipStream class uses the gzip data format, which includes a cyclic redundancy check value for detecting data corruption. The gzip data format uses the same compression algorithm as the DeflateStream class.

The compression functionality in DeflateStream and GZipStream is exposed as a stream. Data is read in on a byte-by-byte basis, so it is not possible to perform multiple passes to determine the best method for compressing entire files or large blocks of data. The DeflateStream and GZipStream classes are best used on uncompressed sources of data. If the source data is already compressed, using these classes may actually increase the size of the stream.

The following example shows how to use the GZipStream class to compress and decompress a directory of files.

Visual Basic
Imports System.IO
Imports System.IO.Compression
Module Module1

    Sub Main()
        ' Path to directory of files to compress.
        Dim dirpath As String = "c:\users\public\reports"

        Dim di As DirectoryInfo = New DirectoryInfo(dirpath)

        ' Compress the directory's files.
        For Each fi As FileInfo In di.GetFiles()
            Compress(fi)
        Next

        ' Decompress all *.cmp files in the directory.
        For Each fi As FileInfo In di.GetFiles("*.cmp")
            Decompress(fi)
        Next

    End Sub

    ' Method to compress.
    Private Sub Compress(ByVal fi As FileInfo)
        ' Get the stream of the source file.
        Using inFile As FileStream = fi.OpenRead()
            ' Compressing:
            ' Prevent compressing hidden and already compressed files.

            If (File.GetAttributes(fi.FullName) And FileAttributes.Hidden) _
                <> FileAttributes.Hidden And fi.Extension <> ".cmp" Then
                ' Create the compressed file.
                Using outFile As FileStream = File.Create(fi.FullName + ".cmp")
                    Using Compress As DeflateStream = New DeflateStream(outFile, _
                                                        CompressionMode.Compress)
                        ' Copy the source file into the compression stream.
                        Dim buffer As Byte() = New Byte(4096) {}
                        Dim numRead As Integer
                        numRead = inFile.Read(buffer, 0, buffer.Length)
                        Do While numRead <> 0
                            Compress.Write(buffer, 0, numRead)
                            numRead = inFile.Read(buffer, 0, buffer.Length)
                        Loop

                        Console.WriteLine("Compressed {0} from {1} to {2} bytes.", _
                          fi.Name, fi.Length.ToString(), outFile.Length.ToString())

                    End Using
                End Using
            End If
        End Using
    End Sub

    ' Method to decompress.
    Private Sub Decompress(ByVal fi As FileInfo)
        ' Get the stream of the source file.
        Using inFile As FileStream = fi.OpenRead()
            ' Get orignial file extension, for example "doc" from report.doc.cmp.
            Dim curFile As String = fi.FullName
            Dim origName = curFile.Remove(curFile.Length - fi.Extension.Length)

            ' Create the decompressed file.
            Using outFile As FileStream = File.Create(origName)
                Using Decompress As DeflateStream = New DeflateStream(inFile, _
                                                        CompressionMode.Decompress)
                    ' Copy the compressed file into the decompression stream.
                    Dim buffer As Byte() = New Byte(4096) {}
                    Dim numRead As Integer
                    numRead = Decompress.Read(buffer, 0, buffer.Length)
                    Do While numRead <> 0
                        outFile.Write(buffer, 0, numRead)
                        numRead = Decompress.Read(buffer, 0, buffer.Length)
                    Loop
                    Console.WriteLine("Decompressed: {0}", fi.Name)

                End Using
            End Using
        End Using
    End Sub
End Module
C#
using System;
using System.IO;
using System.IO.Compression;

public class Program
{

    public static void Main()
    {
        // Path to directory of files to compress and decompress.
        string dirpath = @"c:\users\public\reports";

        DirectoryInfo di = new DirectoryInfo(dirpath);

        // Compress the directory's files.
        foreach (FileInfo fi in di.GetFiles())
        {
            Compress(fi);
        }

        // Decompress all *.cmp files in the directory.
        foreach (FileInfo fi in di.GetFiles("*.cmp"))
        {
            Decompress(fi);
        }


    }

    public static void Compress(FileInfo fi)
    {
        // Get the stream of the source file.
        using (FileStream inFile = fi.OpenRead())
        {
            // Prevent compressing hidden and already compressed files.
            if ((File.GetAttributes(fi.FullName) & FileAttributes.Hidden)
                != FileAttributes.Hidden & fi.Extension != ".cmp")
            {
                // Create the compressed file.
                using (FileStream outFile = 
                        File.Create(fi.FullName + ".cmp"))
                {
                    using (DeflateStream Compress = 
                        new DeflateStream(outFile, 
                        CompressionMode.Compress))
                    {
                        // Copy the source file into 
                        // the compression stream.
                        byte[] buffer = new byte[4096];
                        int numRead;
                        while ((numRead = inFile.Read(buffer, 
                                0, buffer.Length)) != 0)
                        {
                            Compress.Write(buffer, 0, numRead);
                        }
                        Console.WriteLine("Compressed {0} from {1} to {2} bytes.",
                        fi.Name, fi.Length.ToString(), outFile.Length.ToString());
                    }
                }
            }
        }
    }

    public static void Decompress(FileInfo fi)
    {
        // Get the stream of the source file.
        using (FileStream inFile = fi.OpenRead())
        {
            // Get original file extension, 
            // for example "doc" from report.doc.cmp.
            string curFile = fi.FullName;
            string origName = curFile.Remove(curFile.Length 
                    - fi.Extension.Length);

            //Create the decompressed file.
            using (FileStream outFile = File.Create(origName))
            {
                using (DeflateStream Decompress = new DeflateStream(inFile,
                    CompressionMode.Decompress))
                {
                    //Copy the decompression stream into the output file.
                    byte[] buffer = new byte[4096];
                    int numRead;
                    while ((numRead = 
                        Decompress.Read(buffer, 0, buffer.Length)) != 0)
                    {
                        outFile.Write(buffer, 0, numRead);
                    }
                    Console.WriteLine("Decompressed: {0}", fi.Name);
                }
            }
        }
    }
}
System..::.Object
  System..::.MarshalByRefObject
    System.IO..::.Stream
      System.IO.Compression..::.DeflateStream
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5

XNA Framework

Supported in: 3.0

Date

History

Reason

August 2009

Improved code example.

Information enhancement.

Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Library to handle .ZIP files      cheeso   |   Edit   |   Show History

The Deflate compression algorithm is what is used to compress data in .zip files. But the DeflateStream class doesn't handle full zip files.

Also, this DeflateStream class does not support different compression levels, and its compression capability is not very good. Some previously compressed data streams can actually inflate in size, some by as much as 60%. This is a known problem, and has been reported to Microsoft, though the company has not acknowledged the need to fix it. https://connect.microsoft.com/VisualStudio/feedback/ViewFeedback.aspx?FeedbackID=93636

There is a 3rd party library, though, that provides a more effective DeflateStream, and can also read and write .zip files: DotNetZip.

Find DotNetZip at:
http://www.codeplex.com/DotNetZip

DotNetZip is written in C#, but you can use it from any language. The DeflateStream class in DotNetZip is a good replacement for the built-in one. It never inflates the size of a compressed stream. As well, DotNetZip includes classes for directly manipulating ZIP files, which the .NET BCL lacks. DotNetZip works in Winforms apps, console apps, ASP.NET apps, anything you write in .NET. It is open source, and free to use in any application.

Tags What's this?: zip (x) Add a tag
Flag as ContentBug
GZIP and ZLIB Streams      cheeso   |   Edit   |   Show History
Addendum: DotNetZip v1.8 handles RFC 1950, 1951 and 1952 streams. That's ZLIB, DEFLATE, and GZIP.
If you have a zlib stream (let's say, from an Adobe PDF document), you can use the ZlibStream in DotNetZip to decompress it.

(there are also workarounds to allow the use of System.IO.Compression.DeflateStream with ZLIB streams: see http://connect.microsoft.com/VisualStudio/feedback/ViewFeedback.aspx?FeedbackID=97064)
Tags What's this?: Add a tag
Flag as ContentBug
Poor example      glenn_at_infinityinfo ... Thomas Lee   |   Edit   |   Show History
This doesn't give a good example for how to deflate when you do not know the original size of the content. Also it doesn't seem to dispose any of the streams.
objCompressedStream.Length not supported      oops.uvj ... Thomas Lee   |   Edit   |   Show History

Hi,
I am doing like this:
GZipStream objCompressedStream = new GZipStream(objmod, CompressionMode.Compress, true);
objCompressedStream.Write(btReadArray, 0, aiNo_of_bytes_read);

Now when I am trying to get length of objCompressedStream using objCompressedStream.Length property it throws exception that operation is not supported.

Can anyone suggest the alternatives or some way to get the length of compressed stream

Thanks

ZipStorer: A Pure C# Class to Store Files in Zip      jaime_olivares   |   Edit   |   Show History
Notice DeflateStream cannot read/write a .zip file directly (neither GZipStream)
ZipStorer library provides support for Zip files for .net and .net compact frameworks in a simple and monolithic class: http://zipstorer.codeplex.com
Also non-compressed storage support for Silverlight.
Processing
Page view tracker