HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ImfHuf.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (c) 2002, Industrial Light & Magic, a division of Lucas
4 // Digital Ltd. LLC
5 //
6 // All rights reserved.
7 //
8 // Redistribution and use in source and binary forms, with or without
9 // modification, are permitted provided that the following conditions are
10 // met:
11 // * Redistributions of source code must retain the above copyright
12 // notice, this list of conditions and the following disclaimer.
13 // * Redistributions in binary form must reproduce the above
14 // copyright notice, this list of conditions and the following disclaimer
15 // in the documentation and/or other materials provided with the
16 // distribution.
17 // * Neither the name of Industrial Light & Magic nor the names of
18 // its contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
33 ///////////////////////////////////////////////////////////////////////////
34 
35 
36 
37 #ifndef INCLUDED_IMF_HUF_H
38 #define INCLUDED_IMF_HUF_H
39 
40 #include "ImfExport.h"
41 #include "ImfNamespace.h"
42 
43 //-----------------------------------------------------------------------------
44 //
45 // 16-bit Huffman compression and decompression:
46 //
47 // hufCompress (r, nr, c)
48 //
49 // Compresses the contents of array r (of length nr),
50 // stores the compressed data in array c, and returns
51 // the size of the compressed data (in bytes).
52 //
53 // To avoid buffer overflows, the size of array c should
54 // be at least 2 * nr + 65536.
55 //
56 // hufUncompress (c, nc, r, nr)
57 //
58 // Uncompresses the data in array c (with length nc),
59 // and stores the results in array r (with length nr).
60 //
61 //-----------------------------------------------------------------------------
62 
64 
65 
67 int
68 hufCompress (const unsigned short raw[/*nRaw*/],
69  int nRaw,
70  char compressed[/*2 * nRaw + 65536*/]);
71 
73 void
74 hufUncompress (const char compressed[/*nCompressed*/],
75  int nCompressed,
76  unsigned short raw[/*nRaw*/],
77  int nRaw);
78 
79 
81 
82 #endif
OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_ENTER IMF_EXPORT int hufCompress(const unsigned short raw[], int nRaw, char compressed[])
#define OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_EXIT
Definition: ImfNamespace.h:109
IMF_EXPORT void hufUncompress(const char compressed[], int nCompressed, unsigned short raw[], int nRaw)
#define IMF_EXPORT
Definition: ImfExport.h:59
#define OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_ENTER
Definition: ImfNamespace.h:108