init commit

include/mupdf/fitz/compress.h

@@ -1,7 +1,31 @@
+// Copyright (C) 2004-2021 Artifex Software, Inc.
+//
+// This file is part of MuPDF.
+//
+// MuPDF is free software: you can redistribute it and/or modify it under the
+// terms of the GNU Affero General Public License as published by the Free
+// Software Foundation, either version 3 of the License, or (at your option)
+// any later version.
+//
+// MuPDF 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 Affero General Public License for more
+// details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with MuPDF. If not, see <https://www.gnu.org/licenses/agpl-3.0.en.html>
+//
+// Alternative licensing terms are available from the licensor.
+// For commercial licensing, see <https://www.artifex.com/> or contact
+// Artifex Software, Inc., 39 Mesa Street, Suite 108A, San Francisco,
+// CA 94129, USA, for further information.
+
 #ifndef MUPDF_FITZ_COMPRESS_H
 #define MUPDF_FITZ_COMPRESS_H
 
 #include "mupdf/fitz/system.h"
+#include "mupdf/fitz/buffer.h"
+#include "mupdf/fitz/pixmap.h"
 
 typedef enum
 {
@@ -11,22 +35,22 @@ typedef enum
 	FZ_DEFLATE_DEFAULT = -1
 } fz_deflate_level;
 
-/*
-	fz_deflate_bound: Returns the upper bound on the
+/**
+	Returns the upper bound on the
 	size of flated data of length size.
  */
 size_t fz_deflate_bound(fz_context *ctx, size_t size);
 
-/*
-	fz_deflate: Compress source_length bytes of data starting
+/**
+	Compress source_length bytes of data starting
 	at source, into a buffer of length *destLen, starting at dest.
 	*compressed_length will be updated on exit to contain the size
 	actually used.
  */
 void fz_deflate(fz_context *ctx, unsigned char *dest, size_t *compressed_length, const unsigned char *source, size_t source_length, fz_deflate_level level);
 
-/*
-	fz_new_deflated_data: Compress source_length bytes of data starting
+/**
+	Compress source_length bytes of data starting
 	at source, into a new memory block malloced for that purpose.
 	*compressed_length is updated on exit to contain the size used.
 	Ownership of the block is returned from this function, and the
@@ -36,15 +60,29 @@ void fz_deflate(fz_context *ctx, unsigned char *dest, size_t *compressed_length,
 */
 unsigned char *fz_new_deflated_data(fz_context *ctx, size_t *compressed_length, const unsigned char *source, size_t source_length, fz_deflate_level level);
 
-/*
-	fz_new_deflated_data_from_buffer: Compress the contents of a fz_buffer into a
-	new block malloced for that purpose. *compressed_length is updated
-	on exit to contain the size used. Ownership of the block is
-	returned from this function, and the caller is therefore responsible
-	for freeing it. The block may be considerably larger than is
-	actually required. The caller is free to fz_realloc it down if it
-	wants to.
+/**
+	Compress the contents of a fz_buffer into a
+	new block malloced for that purpose. *compressed_length is
+	updated on exit to contain the size used. Ownership of the block
+	is returned from this function, and the caller is therefore
+	responsible for freeing it. The block may be considerably larger
+	than is actually required. The caller is free to fz_realloc it
+	down if it wants to.
 */
 unsigned char *fz_new_deflated_data_from_buffer(fz_context *ctx, size_t *compressed_length, fz_buffer *buffer, fz_deflate_level level);
 
+/**
+	Compress bitmap data as CCITT Group 3 1D fax image.
+	Creates a stream assuming the default PDF parameters,
+	except the number of columns.
+*/
+fz_buffer *fz_compress_ccitt_fax_g3(fz_context *ctx, const unsigned char *data, int columns, int rows, ptrdiff_t stride);
+
+/**
+	Compress bitmap data as CCITT Group 4 2D fax image.
+	Creates a stream assuming the default PDF parameters, except
+	K=-1 and the number of columns.
+*/
+fz_buffer *fz_compress_ccitt_fax_g4(fz_context *ctx, const unsigned char *data, int columns, int rows, ptrdiff_t stride);
+
 #endif