Moved parameter init to the library

README.md

@@ -8,7 +8,7 @@ Binaries not available yet. Please refer to the compilation section below.
 
 ## Basic usage
 
-Libcaesium exposes one single function, auto-detecting the input file type:
+Libcaesium exposes one single function to compress, auto-detecting the input file type:
 ```C
 bool cs_compress(const char *input,
                  const char *output,
@@ -24,6 +24,8 @@ bool cs_compress(const char *input,
 
 ## Compression options
 Libcaesium supports a few compression parameters for each JPEG and PNG.
+You need to initialize the default values before compressing by calling `initialize_parameters()`.  
+
 They are defined into a top level struct containing each supported file parameters, as follows:
 ```C
 typedef struct cs_image_pars
@@ -39,14 +41,6 @@ typedef struct cs_jpeg_pars
 	int quality;
 	bool exif_copy;
 	int dct_method;
-	/*
-	 * Parameters you have no reason to set as they will be
-	 * overwritten during the process
-	 */
-	int color_space;
-	enum TJSAMP subsample;
-	int width;
-	int height;
 } cs_jpeg_pars;
 ```
 The first 3 parameters matters, in term of compression, while the others will be set by the compressor/decompressor

caesium/caesium.c

@@ -36,4 +36,31 @@ bool cs_compress(const char *input_path, const char *output_path, cs_image_pars
 	}
 
 	return result;
+}
+
+void initialize_jpeg_parameters(cs_image_pars *options)
+{
+	options->jpeg.quality = 0;
+	options->jpeg.exif_copy = false;
+	options->jpeg.dct_method = 2048;
+}
+
+void initialize_png_parameters(cs_image_pars *par)
+{
+	par->png.iterations = 10;
+	par->png.iterations_large = 5;
+	par->png.block_split_strategy = 4;
+	par->png.lossy_8 = true;
+	par->png.transparent = true;
+	par->png.auto_filter_strategy = 1;
+}
+
+cs_image_pars initialize_parameters()
+{
+	cs_image_pars options;
+
+	initialize_jpeg_parameters(&options);
+	initialize_png_parameters(&options);
+
+	return options;
 }

caesium/caesium.h

@@ -52,6 +52,7 @@ typedef enum error_level
 } error_level;
 
 bool cs_compress(const char *input_path, const char *output_path, cs_image_pars *options);
+cs_image_pars initialize_parameters();
 
 #ifdef __cplusplus
 }

demo/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_executable(caesiumd main.c helper.c)
+add_executable(caesiumd main.c)
 
 target_link_libraries(caesiumd LINK_PUBLIC caesium)
 

demo/helper.c

@@ -1,33 +0,0 @@
-#include <stdbool.h>
-#include <turbojpeg.h>
-
-#include "helper.h"
-
-void initialize_jpeg_parameters(cs_image_pars *options)
-{
-	options->jpeg.quality = 0;
-	options->jpeg.exif_copy = false;
-	options->jpeg.dct_method = TJFLAG_FASTDCT;
-	options->jpeg.width = 0;
-	options->jpeg.height = 0;
-}
-
-void initialize_png_parameters(cs_image_pars *par)
-{
-	par->png.iterations = 10;
-	par->png.iterations_large = 5;
-	par->png.block_split_strategy = 4;
-	par->png.lossy_8 = true;
-	par->png.transparent = true;
-	par->png.auto_filter_strategy = 1;
-}
-
-cs_image_pars initialize_parameters()
-{
-	cs_image_pars options;
-
-	initialize_jpeg_parameters(&options);
-	initialize_png_parameters(&options);
-
-	return options;
-}

demo/helper.h

@@ -1,12 +0,0 @@
-#ifndef LIBCAESIUM_HELPER_H
-#define LIBCAESIUM_HELPER_H
-
-#include "caesium.h"
-
-void initialize_jpeg_parameters(cs_image_pars *options);
-
-void initialize_png_parameters(cs_image_pars *options);
-
-cs_image_pars initialize_parameters();
-
-#endif

demo/main.c

@@ -1,6 +1,5 @@
 #include <stdio.h>
 #include "caesium.h"
-#include "helper.h"
 
 int main(int argc, char *argv[])
 {