added comments; added Google formatting style

oss-internship-2020/openjpeg/examples/CMakeLists.txt

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# copy of one of the converting functions
+# put here to omit the library's complex 
 add_library(convert_helper STATIC
   convert_helper.h
   convert_helper.cc

oss-internship-2020/openjpeg/examples/convert_helper.cc

@@ -1,21 +1,53 @@
+/*
+ * The copyright in this software is being made available under the 2-clauses
+ * BSD License, included below. This software may be subject to other third
+ * party and contributor rights, including patent rights, and no such rights
+ * are granted under this license.
+ *
+ * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
+ * Copyright (c) 2002-2014, Professor Benoit Macq
+ * Copyright (c) 2001-2003, David Janssens
+ * Copyright (c) 2002-2003, Yannick Verschueren
+ * Copyright (c) 2003-2007, Francois-Olivier Devaux
+ * Copyright (c) 2003-2014, Antonin Descampe
+ * Copyright (c) 2005, Herve Drolon, FreeImage Team
+ * Copyright (c) 2006-2007, Parvatha Elangovan
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
 
 // copies of a few library tools
 
 #include "convert_helper.h"
 
-const char* opj_version(void)
+const char *opj_version(void) { return "2.3.1"; }
-{
-    return "2.3.1";
-}
 
-static int are_comps_similar(opj_image_t * image)
+static int are_comps_similar(opj_image_t *image) {
-{
   unsigned int i;
   for (i = 1; i < image->numcomps; i++) {
     if (image->comps[0].dx != image->comps[i].dx ||
         image->comps[0].dy != image->comps[i].dy ||
-                (i <= 2 &&
+        (i <= 2 && (image->comps[0].prec != image->comps[i].prec ||
-                 (image->comps[0].prec != image->comps[i].prec ||
                     image->comps[0].sgnd != image->comps[i].sgnd))) {
       return OPJ_FALSE;
     }
@@ -23,8 +55,7 @@ static int are_comps_similar(opj_image_t * image)
   return OPJ_TRUE;
 }
 
-int imagetopnm(opj_image_t * image, const char *outfile, int force_split)
+int imagetopnm(opj_image_t *image, const char *outfile, int force_split) {
-{
   int *red, *green, *blue, *alpha;
   int wr, hr, max;
   int i;
@@ -39,8 +70,10 @@ int imagetopnm(opj_image_t * image, const char *outfile, int force_split)
   alpha = NULL;
 
   if ((prec = (int)image->comps[0].prec) > 16) {
-        fprintf(stderr, "%s:%d:imagetopnm\n\tprecision %d is larger than 16"
+    fprintf(stderr,
-                "\n\t: refused.\n", __FILE__, __LINE__, prec);
+            "%s:%d:imagetopnm\n\tprecision %d is larger than 16"
+            "\n\t: refused.\n",
+            __FILE__, __LINE__, prec);
     return 1;
   }
 
@@ -59,8 +92,7 @@ int imagetopnm(opj_image_t * image, const char *outfile, int force_split)
     ncomp = 1;
   }
 
-    if ((force_split == 0) && ncomp >= 2 &&
+  if ((force_split == 0) && ncomp >= 2 && are_comps_similar(image)) {
-            are_comps_similar(image)) {
     fdest = fopen(outfile, "wb");
 
     if (!fdest) {
@@ -76,8 +108,7 @@ int imagetopnm(opj_image_t * image, const char *outfile, int force_split)
 
     red = image->comps[0].data;
     if (red == NULL) {
-            fprintf(stderr,
+      fprintf(stderr, "imagetopnm: planes[%d] == NULL.\n", 0);
-                    "imagetopnm: planes[%d] == NULL.\n", 0);
       fprintf(stderr, "\tAborting\n");
       fclose(fdest);
       return fails;
@@ -88,8 +119,7 @@ int imagetopnm(opj_image_t * image, const char *outfile, int force_split)
       blue = image->comps[2].data;
       for (i = 1; i <= 2; i++) {
         if (image->comps[i].data == NULL) {
-                    fprintf(stderr,
+          fprintf(stderr, "imagetopnm: planes[%d] == NULL.\n", i);
-                            "imagetopnm: planes[%d] == NULL.\n", i);
           fprintf(stderr, "\tAborting\n");
           fclose(fdest);
           return fails;
@@ -102,15 +132,17 @@ int imagetopnm(opj_image_t * image, const char *outfile, int force_split)
     if (has_alpha) {
       const char *tt = (triple ? "RGB_ALPHA" : "GRAYSCALE_ALPHA");
 
-            fprintf(fdest, "P7\n# OpenJPEG-%s\nWIDTH %d\nHEIGHT %d\nDEPTH %u\n"
+      fprintf(fdest,
-                    "MAXVAL %d\nTUPLTYPE %s\nENDHDR\n", opj_version(),
+              "P7\n# OpenJPEG-%s\nWIDTH %d\nHEIGHT %d\nDEPTH %u\n"
-                    wr, hr, ncomp, max, tt);
+              "MAXVAL %d\nTUPLTYPE %s\nENDHDR\n",
+              opj_version(), wr, hr, ncomp, max, tt);
       alpha = image->comps[ncomp - 1].data;
-            adjustA = (image->comps[ncomp - 1].sgnd ?
+      adjustA = (image->comps[ncomp - 1].sgnd
-                       1 << (image->comps[ncomp - 1].prec - 1) : 0);
+                     ? 1 << (image->comps[ncomp - 1].prec - 1)
+                     : 0);
     } else {
-            fprintf(fdest, "P6\n# OpenJPEG-%s\n%d %d\n%d\n",
+      fprintf(fdest, "P6\n# OpenJPEG-%s\n%d %d\n%d\n", opj_version(), wr, hr,
-                    opj_version(), wr, hr, max);
+              max);
       adjustA = 0;
     }
     adjustR = (image->comps[0].sgnd ? 1 << (image->comps[0].prec - 1) : 0);
@@ -253,8 +285,7 @@ int imagetopnm(opj_image_t * image, const char *outfile, int force_split)
     prec = (int)image->comps[compno].prec;
     max = (1 << prec) - 1;
 
-        fprintf(fdest, "P5\n#OpenJPEG-%s\n%d %d\n%d\n",
+    fprintf(fdest, "P5\n#OpenJPEG-%s\n%d %d\n%d\n", opj_version(), wr, hr, max);
-                opj_version(), wr, hr, max);
 
     red = image->comps[compno].data;
 

oss-internship-2020/openjpeg/examples/convert_helper.h

@@ -1,8 +1,11 @@
+// imagetopnm and the two functions it calls internaly are copied from the
+// library's tools; from openjpeg/src/bin/jp2/convert.c
+
 #include "openjp2_sapi.sapi.h"
 
 #define OPJ_TRUE 1
 #define OPJ_FALSE 0
 
 const char* opj_version(void);
-int imagetopnm(opj_image_t * image, const char *outfile, int force_split);
 static int are_comps_similar(opj_image_t* image);
+int imagetopnm(opj_image_t* image, const char* outfile, int force_split);

oss-internship-2020/openjpeg/examples/decompress_example.cc

@@ -12,19 +12,16 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-
 // Perform decompression from *.jp2 to *.pnm format
 
-
 #include <libgen.h>
 #include <syscall.h>
 
-#include <iostream>
-#include <cstdlib>
 #include <cassert>
+#include <cstdlib>
+#include <iostream>
 
 #include "convert_helper.h"
-
 #include "openjp2_sapi.sapi.h"
 #include "sandboxed_api/util/flag.h"
 
@@ -33,8 +30,7 @@ class Opj_image_t : public sapi::v::Struct<opj_image_t> {};
 
 class Openjp2SapiSandbox : public Openjp2Sandbox {
  public:
-  Openjp2SapiSandbox(const std::string& in_file)
+  Openjp2SapiSandbox(const std::string& in_file) : in_file_(in_file) {}
-      : in_file_(in_file) {}
 
   std::unique_ptr<sandbox2::Policy> ModifyPolicy(
       sandbox2::PolicyBuilder*) override {
@@ -59,20 +55,18 @@ class Openjp2SapiSandbox : public Openjp2Sandbox {
   std::string in_file_;
 };
 
-
 int main(int argc, char* argv[]) {
   gflags::ParseCommandLineFlags(&argc, &argv, true);
 
   if (argc != 3) {
-		std::cerr << "usage: " 
+    std::cerr << "usage: " << basename(argv[0]) << " absolute/path/to/INPUT.jp2"
-				  << basename(argv[0]) 
-				  << " absolute/path/to/INPUT.jp2"
               << " absolute/path/to/OUTPUT.pnm\n";
     return EXIT_FAILURE;
   }
 
   std::string in_file(argv[1]);
 
+  // initialize sandbox
   Openjp2SapiSandbox sandbox(in_file);
   absl::Status status = sandbox.Init();
   assert(status.ok());
@@ -80,14 +74,15 @@ int main(int argc, char* argv[]) {
   Openjp2Api api(&sandbox);
   sapi::v::ConstCStr in_file_v(in_file.c_str());
 
-	sapi::StatusOr<opj_stream_t*> stream_status 
+  // initialize library's main data-holders
-		= api.opj_stream_create_default_file_stream(in_file_v.PtrBefore(), 1);
+  sapi::StatusOr<opj_stream_t*> stream_status =
+      api.opj_stream_create_default_file_stream(in_file_v.PtrBefore(), 1);
   assert(stream_status.ok());
   void* stream_status_value = stream_status.value();
   sapi::v::RemotePtr stream_pointer(stream_status_value);
 
-	sapi::StatusOr<opj_codec_t*> codec_status 
+  sapi::StatusOr<opj_codec_t*> codec_status =
-		= api.opj_create_decompress(OPJ_CODEC_JP2);
+      api.opj_create_decompress(OPJ_CODEC_JP2);
   assert(codec_status.ok());
   void* codec_status_value = codec_status.value();
   sapi::v::RemotePtr codec_pointer(codec_status_value);
@@ -96,14 +91,14 @@ int main(int argc, char* argv[]) {
   status = api.opj_set_default_decoder_parameters(parameters.PtrBoth());
   assert(status.ok());
 
-	sapi::StatusOr<OPJ_BOOL> bool_status 
+  sapi::StatusOr<OPJ_BOOL> bool_status =
-		= api.opj_setup_decoder(&codec_pointer, parameters.PtrBefore());
+      api.opj_setup_decoder(&codec_pointer, parameters.PtrBefore());
   assert(bool_status.ok());
   assert(bool_status.value());
 
+  // start reading image from the input file
   sapi::v::GenericPtr image_pointer;
-	bool_status = api.opj_read_header(&stream_pointer,
+  bool_status = api.opj_read_header(&stream_pointer, &codec_pointer,
-									  &codec_pointer,
                                     image_pointer.PtrAfter());
   assert(bool_status.ok());
   assert(bool_status.value());
@@ -112,8 +107,7 @@ int main(int argc, char* argv[]) {
   image.SetRemote((void*)image_pointer.GetValue());
   assert(sandbox.TransferFromSandboxee(&image).ok());
 
-	bool_status = api.opj_decode(&codec_pointer,
+  bool_status = api.opj_decode(&codec_pointer, &stream_pointer,
-								 &stream_pointer,
                                (sapi::v::Ptr*)&image_pointer);
   assert(bool_status.ok());
   assert(bool_status.value());
@@ -122,23 +116,20 @@ int main(int argc, char* argv[]) {
   assert(bool_status.ok());
   assert(bool_status.value());
 
-	status = api.opj_stream_destroy(&stream_pointer);
-	assert(status.ok());
-
   int components = image.data().numcomps;
 
+  // transfer the read data to the main process
   sapi::v::Array<opj_image_comp_t> image_components(components);
   image_components.SetRemote(image.data().comps);
   assert(sandbox.TransferFromSandboxee(&image_components).ok());
 
-	image.mutable_data()->comps
+  image.mutable_data()->comps = (opj_image_comp_t*)image_components.GetLocal();
-		= (opj_image_comp_t*)image_components.GetLocal();
 
   int width = (int)image.data().comps[0].w;
   int height = (int)image.data().comps[0].h;
 
-	int data[components][width * height];
+  OPJ_INT32 data[components][width * height];
-	sapi::v::Array<int> image_components_data(width * height);
+  sapi::v::Array<OPJ_INT32> image_components_data(width * height);
 
   for (int i = 0; i < components; i++) {
     image_components_data.SetRemote(image.data().comps[i].data);
@@ -149,15 +140,20 @@ int main(int argc, char* argv[]) {
     image_components[i].data = data[i];
   }
 
+  // convert the image to the desired format and save it to the file
   int error = imagetopnm((opj_image_t*)image.GetLocal(), argv[2], 0);
   assert(error == 0);
 
-	status = api.opj_destroy_codec(&codec_pointer);
+  // cleanup
-	assert(status.ok());
-
   sapi::v::RemotePtr remote_image_pointer(image.GetRemote());
   status = api.opj_image_destroy(&remote_image_pointer);
   assert(status.ok());
 
+  status = api.opj_stream_destroy(&stream_pointer);
+  assert(status.ok());
+
+  status = api.opj_destroy_codec(&codec_pointer);
+  assert(status.ok());
+
   return EXIT_SUCCESS;
 }