HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
fastCompression.h
Go to the documentation of this file.
1 //`
2 // Copyright 2017 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 
24 #ifndef PXR_BASE_TF_FAST_COMPRESSION_H
25 #define PXR_BASE_TF_FAST_COMPRESSION_H
26 
27 /// \file tf/fastCompression.h
28 /// Simple fast data compression/decompression routines.
29 
30 #include "pxr/pxr.h"
31 
32 #include "pxr/base/tf/api.h"
33 
34 #include <cstddef>
35 
37 
39 {
40 public:
41  /// Return the largest input buffer size that can be compressed with these
42  /// functions. Guaranteed to be at least 200 GB.
43  TF_API static size_t
45 
46  /// Return the largest possible compressed size for the given \p inputSize
47  /// in the worst case (input is not compressible). This is larger than
48  /// \p inputSize. If inputSize is larger than GetMaxInputSize(), return 0.
49  TF_API static size_t
50  GetCompressedBufferSize(size_t inputSize);
51 
52  /// Compress \p inputSize bytes in \p input and store the result in
53  /// \p compressed. The \p compressed buffer must point to at least
54  /// GetCompressedBufferSize(uncompressedSize) bytes. Return the number of
55  /// bytes written to the \p compressed buffer. Issue a runtime error and
56  /// return ~0 in case of an error.
57  TF_API static size_t
58  CompressToBuffer(char const *input, char *compressed, size_t inputSize);
59 
60  /// Decompress \p compressedSize bytes in \p compressed and store the
61  /// result in \p output. No more than \p maxOutputSize bytes will be
62  /// written to \p output.
63  TF_API static size_t
64  DecompressFromBuffer(char const *compressed, char *output,
65  size_t compressedSize, size_t maxOutputSize);
66 };
67 
68 
70 
71 #endif // PXR_BASE_TF_FAST_COMPRESSION_H
72 
73 
GLenum GLenum GLenum input
Definition: glew.h:13879
#define TF_API
Definition: api.h:40
static TF_API size_t CompressToBuffer(char const *input, char *compressed, size_t inputSize)
static TF_API size_t DecompressFromBuffer(char const *compressed, char *output, size_t compressedSize, size_t maxOutputSize)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
static TF_API size_t GetCompressedBufferSize(size_t inputSize)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
static TF_API size_t GetMaxInputSize()