aboutsummaryrefslogtreecommitdiff
path: root/lib/Net.Compression/VNLib.Net.Compression/NativeCompressionLib.cs
blob: 438f777c04d3bb96d324452fc80570303e7f6f65 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/*
* Copyright (c) 2023 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Net.Compression
* File: NativeCompressionLib.cs 
*
* NativeCompressionLib.cs is part of VNLib.Net.Compression which is part of 
* the larger VNLib collection of libraries and utilities.
*
* VNLib.Net.Compression is free software: you can redistribute it and/or modify 
* it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 2 of the License,
* or (at your option) any later version.
*
* VNLib.Net.Compression is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License 
* along with VNLib.Net.Compression. If not, see http://www.gnu.org/licenses/.
*/

using System;
using System.IO.Compression;
using System.Runtime.InteropServices;

using VNLib.Net.Http;
using VNLib.Utils;
using VNLib.Utils.Extensions;

namespace VNLib.Net.Compression
{
    /// <summary>
    /// A referrence native compression library implementation. Allows for creating compressor instances
    /// from a native dll.
    /// </summary>
    public sealed class NativeCompressionLib : VnDisposeable, INativeCompressionLib
    {
        private readonly LibraryWrapper _library;

        private NativeCompressionLib(LibraryWrapper nativeLib) => _library = nativeLib;

        ///<inheritdoc/>
        protected override void Free() => _library.Dispose();

        /// <summary>
        /// Loads the native compression DLL at the specified file path and search pattern
        /// </summary>
        /// <param name="libPath">The path (relative or absolute) path to the native dll to load</param>
        /// <param name="searchPath">The dll search pattern</param>
        /// <returns>A new <see cref="NativeCompressionLib"/> library handle</returns>
        public static NativeCompressionLib LoadLibrary(string libPath, DllImportSearchPath searchPath)
        {
            LibraryWrapper wrapper = LibraryWrapper.LoadLibrary(libPath, searchPath);
            return new NativeCompressionLib(wrapper);
        }

        ///<inheritdoc/>
        ///<exception cref="NativeCompressionException"></exception>
        public CompressionMethod GetSupportedMethods()
        {
            Check();
            return _library.GetSupportedMethods();
        }

        ///<inheritdoc/>
        ///<exception cref="NativeCompressionException"></exception>
        public INativeCompressor AllocCompressor(CompressionMethod method, CompressionLevel level)
        {
#pragma warning disable CA2000 // Dispose objects before losing scope

            SafeHandle libHandle = AllocSafeCompressorHandle(method, level);
            return new Compressor(_library, libHandle);

#pragma warning restore CA2000 // Dispose objects before losing scope
        }

        ///<inheritdoc/>
        ///<exception cref="NativeCompressionException"></exception>
        public SafeHandle AllocSafeCompressorHandle(CompressionMethod method, CompressionLevel level)
        {
            Check();
            //Alloc compressor then craete a safe handle
            IntPtr comp = _library.AllocateCompressor(method, level);
            return new SafeCompressorHandle(_library, comp);
        }

        internal sealed record class Compressor(LibraryWrapper LibComp, SafeHandle CompressorHandle) : INativeCompressor
        {

            ///<inheritdoc/>
            public CompressionResult Compress(ReadOnlyMemory<byte> input, Memory<byte> output)
            {
                CompressorHandle.ThrowIfClosed();
                IntPtr compressor = CompressorHandle.DangerousGetHandle();
                return LibComp.CompressBlock(compressor, output, input, false);
            }

            ///<inheritdoc/>
            public CompressionResult Compress(ReadOnlySpan<byte> input, Span<byte> output)
            {
                CompressorHandle.ThrowIfClosed();
                IntPtr compressor = CompressorHandle.DangerousGetHandle();
                return LibComp.CompressBlock(compressor, output, input, false);
            }

            ///<inheritdoc/>
            public void Dispose() => CompressorHandle.Dispose();

            ///<inheritdoc/>
            public int Flush(Memory<byte> buffer)
            {
                CompressorHandle.ThrowIfClosed();
                IntPtr compressor = CompressorHandle.DangerousGetHandle();
                CompressionResult result = LibComp.CompressBlock(compressor, buffer, default, true);
                return result.BytesWritten;
            }

            ///<inheritdoc/>
            public int Flush(Span<byte> buffer)
            {
                CompressorHandle.ThrowIfClosed();
                IntPtr compressor = CompressorHandle.DangerousGetHandle();
                CompressionResult result = LibComp.CompressBlock(compressor, buffer, default, true);
                return result.BytesWritten;
            }

            ///<inheritdoc/>
            public uint GetBlockSize()
            {
                CompressorHandle.ThrowIfClosed();
                IntPtr compressor = CompressorHandle.DangerousGetHandle();
                return LibComp.GetBlockSize(compressor);
            }

            ///<inheritdoc/>
            public uint GetCompressedSize(uint size)
            {
                CompressorHandle.ThrowIfClosed();
                IntPtr compressor = CompressorHandle.DangerousGetHandle();
                return (uint)LibComp.GetOutputSize(compressor, size, 1);
            }

            ///<inheritdoc/>
            public CompressionLevel GetCompressionLevel()
            {
                CompressorHandle.ThrowIfClosed();
                IntPtr compressor = CompressorHandle.DangerousGetHandle();
                return LibComp.GetCompressorLevel(compressor);
            }

            ///<inheritdoc/>
            public CompressionMethod GetCompressionMethod()
            {
                CompressorHandle.ThrowIfClosed();
                IntPtr compressor = CompressorHandle.DangerousGetHandle();
                return LibComp.GetCompressorType(compressor);
            }
        }
    }
}