1/*
2 * Copyright 2008 The Android Open Source Project
3 *
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
6 */
7
8
9#ifndef SkPackBits_DEFINED
10#define SkPackBits_DEFINED
11
12#include "SkTypes.h"
13
14class SkPackBits {
15public:
16    /** Given the number of 8bit values that will be passed to Pack8,
17        returns the worst-case size needed for the dst[] buffer.
18    */
19    static size_t ComputeMaxSize8(size_t srcSize);
20
21    /** Write the src array into a packed format. The packing process may end
22        up writing more bytes than it read, so dst[] must be large enough.
23        @param src      Input array of 8bit values
24        @param srcSize  Number of entries in src[]
25        @param dst      Buffer (allocated by caller) to write the packed data
26                        into
27        @param dstSize  Number of bytes in the output buffer.
28        @return the number of bytes written to dst[]
29    */
30    static size_t Pack8(const uint8_t src[], size_t srcSize, uint8_t dst[],
31                        size_t dstSize);
32
33    /** Unpack the data in src[], and expand it into dst[]. The src[] data was
34        written by a previous call to Pack8.
35        @param src      Input data to unpack, previously created by Pack8.
36        @param srcSize  Number of bytes of src to unpack
37        @param dst      Buffer (allocated by caller) to expand the src[] into.
38        @param dstSize  Number of bytes in the output buffer.
39        @return the number of bytes written into dst.
40    */
41    static int Unpack8(const uint8_t src[], size_t srcSize, uint8_t dst[],
42                       size_t dstSize);
43};
44
45#endif
46