1 package nom.tam.fits.compression.algorithm.api;
2
3 /*
4 * #%L
5 * nom.tam FITS library
6 * %%
7 * Copyright (C) 1996 - 2024 nom-tam-fits
8 * %%
9 * This is free and unencumbered software released into the public domain.
10 *
11 * Anyone is free to copy, modify, publish, use, compile, sell, or
12 * distribute this software, either in source code form or as a compiled
13 * binary, for any purpose, commercial or non-commercial, and by any
14 * means.
15 *
16 * In jurisdictions that recognize copyright laws, the author or authors
17 * of this software dedicate any and all copyright interest in the
18 * software to the public domain. We make this dedication for the benefit
19 * of the public at large and to the detriment of our heirs and
20 * successors. We intend this dedication to be an overt act of
21 * relinquishment in perpetuity of all present and future rights to this
22 * software under copyright law.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
27 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
28 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
29 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
30 * OTHER DEALINGS IN THE SOFTWARE.
31 * #L%
32 */
33
34 import java.nio.Buffer;
35 import java.nio.ByteBuffer;
36
37 /**
38 * (<i>for internal use</i>) The interface to a provided compression algorithm.
39 */
40 public interface ICompressorControl {
41
42 /**
43 * Compress the buffer into the byte buffer using the specified options.
44 *
45 * @param in
46 * the buffer to compress.
47 * @param out
48 * the compressed data to fill (must already be allocated with
49 * enough space)
50 * @param option
51 * the options to use for the compression
52 * @return true if the compression succeded.
53 */
54 boolean compress(Buffer in, ByteBuffer out, ICompressOption option);
55
56 /**
57 * decompress the byte buffer back into the buffer using the specified
58 * options.
59 *
60 * @param in
61 * the bytes to decompress.
62 * @param out
63 * the buffer to fill with the decompressed data (must already be
64 * allocated with enough space)
65 * @param option
66 * the options to use for decompressing.
67 */
68 void decompress(ByteBuffer in, Buffer out, ICompressOption option);
69
70 /**
71 * @return a option instance that can be used to control the compression
72 * meganism.
73 */
74 ICompressOption option();
75 }