Missing install file.
[libdcp.git] / src / util.cc
index 2b3a6c8defac8567cb80593e180fc631924c670b..6bee0dc76d34ff62ad460719bf4b81811ae20c35 100644 (file)
@@ -26,6 +26,7 @@
 #include <iostream>
 #include <iomanip>
 #include <boost/filesystem.hpp>
+#include <boost/lexical_cast.hpp>
 #include <openssl/sha.h>
 #include "KM_util.h"
 #include "KM_fileio.h"
 #include "exceptions.h"
 #include "types.h"
 #include "argb_frame.h"
-#include "lut.h"
+#include "gamma_lut.h"
 
 using std::string;
 using std::stringstream;
 using std::min;
 using std::max;
 using boost::shared_ptr;
+using boost::lexical_cast;
 using namespace libdcp;
 
+/** Create a UUID.
+ *  @return UUID.
+ */
 string
 libdcp::make_uuid ()
 {
@@ -53,14 +58,17 @@ libdcp::make_uuid ()
        return string (buffer);
 }
 
+
+/** Create a digest for a file.
+ *  @param filename File name.
+ *  @return Digest.
+ */
 string
-libdcp::make_digest (string filename, boost::signals2::signal<void (float)>* progress)
+libdcp::make_digest (string filename)
 {
-       int const file_size = boost::filesystem::file_size (filename);
-       
        Kumu::FileReader reader;
        if (ASDCP_FAILURE (reader.OpenRead (filename.c_str ()))) {
-               throw FileError ("could not open file to compute digest", filename);
+               boost::throw_exception (FileError ("could not open file to compute digest", filename));
        }
        
        SHA_CTX sha;
@@ -75,15 +83,11 @@ libdcp::make_digest (string filename, boost::signals2::signal<void (float)>* pro
                if (r == Kumu::RESULT_ENDOFFILE) {
                        break;
                } else if (ASDCP_FAILURE (r)) {
-                       throw FileError ("could not read file to compute digest", filename);
+                       boost::throw_exception (FileError ("could not read file to compute digest", filename));
                }
                
                SHA1_Update (&sha, read_buffer.Data(), read);
                done += read;
-
-               if (progress) {
-                       (*progress) (0.5 + (0.5 * done / file_size));
-               }
        }
 
        byte_t byte_buffer[20];
@@ -94,6 +98,11 @@ libdcp::make_digest (string filename, boost::signals2::signal<void (float)>* pro
        return Kumu::base64encode (byte_buffer, 20, digest, 64);
 }
 
+/** Convert a content kind to a string which can be used in a
+ *  <ContentKind> node.
+ *  @param kind ContentKind.
+ *  @return string.
+ */
 string
 libdcp::content_kind_to_string (ContentKind kind)
 {
@@ -123,9 +132,16 @@ libdcp::content_kind_to_string (ContentKind kind)
        assert (false);
 }
 
+/** Convert a string from a <ContentKind> node to a libdcp ContentKind.
+ *  Reasonably tolerant about varying case.
+ *  @param type Content kind string.
+ *  @return libdcp ContentKind.
+ */
 libdcp::ContentKind
 libdcp::content_kind_from_string (string type)
 {
+       /* XXX: should probably just convert type to lower-case and have done with it */
+       
        if (type == "feature") {
                return FEATURE;
        } else if (type == "short") {
@@ -150,27 +166,16 @@ libdcp::content_kind_from_string (string type)
 
        assert (false);
 }
-               
-bool
-libdcp::starts_with (string big, string little)
-{
-       if (little.size() > big.size()) {
-               return false;
-       }
-
-       return big.substr (0, little.length()) == little;
-}
-
-bool
-libdcp::ends_with (string big, string little)
-{
-       if (little.size() > big.size()) {
-               return false;
-       }
-
-       return big.compare (big.length() - little.length(), little.length(), little) == 0;
-}
 
+/** Decompress a JPEG2000 image to a bitmap.
+ *  @param data JPEG2000 data.
+ *  @param size Size of data in bytes.
+ *  @param reduce A power of 2 by which to reduce the size of the decoded image;
+ *  e.g. 0 reduces by (2^0 == 1), ie keeping the same size.
+ *       1 reduces by (2^1 == 2), ie halving the size of the image.
+ *  This is useful for scaling 4K DCP images down to 2K.
+ *  @return openjpeg image, which the caller must call opj_image_destroy() on.
+ */
 opj_image_t *
 libdcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
 {
@@ -184,7 +189,7 @@ libdcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
        if (!image) {
                opj_destroy_decompress (decoder);
                opj_cio_close (cio);
-               throw DCPReadError ("could not decode JPEG2000 codestream");
+               boost::throw_exception (DCPReadError ("could not decode JPEG2000 codestream of " + lexical_cast<string> (size) + " bytes."));
        }
 
        opj_cio_close (cio);
@@ -194,9 +199,27 @@ libdcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
        return image;
 }
 
+/** Convert an openjpeg XYZ image to RGB.
+ *  @param xyz_frame Frame in XYZ.
+ *  @return RGB image.
+ */
 shared_ptr<ARGBFrame>
-libdcp::xyz_to_rgb (opj_image_t* xyz_frame)
+libdcp::xyz_to_rgb (opj_image_t* xyz_frame, shared_ptr<const GammaLUT> lut_in, shared_ptr<const GammaLUT> lut_out)
 {
+       float const dci_coefficient = 48.0 / 52.37;
+
+        /* sRGB color matrix for XYZ -> RGB.  This is the same as the one used by the Fraunhofer
+          EasyDCP player, I think.
+       */
+
+       float const colour_matrix[3][3] = {
+               {  3.24096989631653,   -1.5373831987381,  -0.498610764741898 },
+               { -0.96924364566803,    1.87596750259399,  0.0415550582110882 },
+               {  0.0556300804018974, -0.203976958990097, 1.05697154998779 }
+       };
+
+       int const max_colour = pow (2, lut_out->bit_depth()) - 1;
+
        struct {
                double x, y, z;
        } s;
@@ -209,7 +232,7 @@ libdcp::xyz_to_rgb (opj_image_t* xyz_frame)
        int* xyz_y = xyz_frame->comps[1].data;
        int* xyz_z = xyz_frame->comps[2].data;
 
-       shared_ptr<ARGBFrame> argb_frame (new ARGBFrame (xyz_frame->x1, xyz_frame->y1));
+       shared_ptr<ARGBFrame> argb_frame (new ARGBFrame (Size (xyz_frame->x1, xyz_frame->y1)));
 
        uint8_t* argb = argb_frame->data ();
        
@@ -220,19 +243,19 @@ libdcp::xyz_to_rgb (opj_image_t* xyz_frame)
                        assert (*xyz_x >= 0 && *xyz_y >= 0 && *xyz_z >= 0 && *xyz_x < 4096 && *xyz_x < 4096 && *xyz_z < 4096);
                        
                        /* In gamma LUT */
-                       s.x = lut_in[*xyz_x++];
-                       s.y = lut_in[*xyz_y++];
-                       s.z = lut_in[*xyz_z++];
-                       
+                       s.x = lut_in->lut()[*xyz_x++];
+                       s.y = lut_in->lut()[*xyz_y++];
+                       s.z = lut_in->lut()[*xyz_z++];
+
                        /* DCI companding */
-                       s.x /= DCI_COEFFICIENT;
-                       s.y /= DCI_COEFFICIENT;
-                       s.z /= DCI_COEFFICIENT;
+                       s.x /= dci_coefficient;
+                       s.y /= dci_coefficient;
+                       s.z /= dci_coefficient;
                        
                        /* XYZ to RGB */
-                       d.r = ((s.x * color_matrix[0][0]) + (s.y * color_matrix[0][1]) + (s.z * color_matrix[0][2]));
-                       d.g = ((s.x * color_matrix[1][0]) + (s.y * color_matrix[1][1]) + (s.z * color_matrix[1][2]));
-                       d.b = ((s.x * color_matrix[2][0]) + (s.y * color_matrix[2][1]) + (s.z * color_matrix[2][2]));
+                       d.r = ((s.x * colour_matrix[0][0]) + (s.y * colour_matrix[0][1]) + (s.z * colour_matrix[0][2]));
+                       d.g = ((s.x * colour_matrix[1][0]) + (s.y * colour_matrix[1][1]) + (s.z * colour_matrix[1][2]));
+                       d.b = ((s.x * colour_matrix[2][0]) + (s.y * colour_matrix[2][1]) + (s.z * colour_matrix[2][2]));
                        
                        d.r = min (d.r, 1.0);
                        d.r = max (d.r, 0.0);
@@ -244,9 +267,9 @@ libdcp::xyz_to_rgb (opj_image_t* xyz_frame)
                        d.b = max (d.b, 0.0);
                        
                        /* Out gamma LUT */
-                       *argb_line++ = lut_out[(int) (d.b * COLOR_DEPTH)];
-                       *argb_line++ = lut_out[(int) (d.g * COLOR_DEPTH)];
-                       *argb_line++ = lut_out[(int) (d.r * COLOR_DEPTH)];
+                       *argb_line++ = lut_out->lut()[(int) (d.b * max_colour)] * 0xff;
+                       *argb_line++ = lut_out->lut()[(int) (d.g * max_colour)] * 0xff;
+                       *argb_line++ = lut_out->lut()[(int) (d.r * max_colour)] * 0xff;
                        *argb_line++ = 0xff;
                }
                
@@ -256,6 +279,9 @@ libdcp::xyz_to_rgb (opj_image_t* xyz_frame)
        return argb_frame;
 }
 
+/** @param s A string.
+ *  @return true if the string contains only space, newline or tab characters, or is empty.
+ */
 bool
 libdcp::empty_or_white_space (string s)
 {
@@ -267,3 +293,14 @@ libdcp::empty_or_white_space (string s)
 
        return true;
 }
+
+bool libdcp::operator== (libdcp::Size const & a, libdcp::Size const & b)
+{
+       return (a.width == b.width && a.height == b.height);
+}
+
+bool libdcp::operator!= (libdcp::Size const & a, libdcp::Size const & b)
+{
+       return !(a == b);
+}
+