// Copyright (c) the JPEG XL Project Authors. All rights reserved. // // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. #include "lib/extras/enc/jpg.h" #include #include #include #include #include #include #include #include #include #include #include "lib/extras/exif.h" #include "lib/jxl/base/status.h" #include "lib/jxl/sanitizers.h" #if JPEGXL_ENABLE_SJPEG #include "sjpeg.h" #endif namespace jxl { namespace extras { namespace { constexpr unsigned char kICCSignature[12] = { 0x49, 0x43, 0x43, 0x5F, 0x50, 0x52, 0x4F, 0x46, 0x49, 0x4C, 0x45, 0x00}; constexpr int kICCMarker = JPEG_APP0 + 2; constexpr size_t kMaxBytesInMarker = 65533; constexpr unsigned char kExifSignature[6] = {0x45, 0x78, 0x69, 0x66, 0x00, 0x00}; constexpr int kExifMarker = JPEG_APP0 + 1; enum class JpegEncoder { kLibJpeg, kSJpeg, }; #define ARRAY_SIZE(X) (sizeof(X) / sizeof((X)[0])) // Popular jpeg scan scripts // The fields of the individual scans are: // comps_in_scan, component_index[], Ss, Se, Ah, Al static constexpr jpeg_scan_info kScanScript1[] = { {1, {0}, 0, 0, 0, 0}, // {1, {1}, 0, 0, 0, 0}, // {1, {2}, 0, 0, 0, 0}, // {1, {0}, 1, 8, 0, 0}, // {1, {0}, 9, 63, 0, 0}, // {1, {1}, 1, 63, 0, 0}, // {1, {2}, 1, 63, 0, 0}, // }; static constexpr size_t kNumScans1 = ARRAY_SIZE(kScanScript1); static constexpr jpeg_scan_info kScanScript2[] = { {1, {0}, 0, 0, 0, 0}, // {1, {1}, 0, 0, 0, 0}, // {1, {2}, 0, 0, 0, 0}, // {1, {0}, 1, 2, 0, 1}, // {1, {0}, 3, 63, 0, 1}, // {1, {0}, 1, 63, 1, 0}, // {1, {1}, 1, 63, 0, 0}, // {1, {2}, 1, 63, 0, 0}, // }; static constexpr size_t kNumScans2 = ARRAY_SIZE(kScanScript2); static constexpr jpeg_scan_info kScanScript3[] = { {1, {0}, 0, 0, 0, 0}, // {1, {1}, 0, 0, 0, 0}, // {1, {2}, 0, 0, 0, 0}, // {1, {0}, 1, 63, 0, 2}, // {1, {0}, 1, 63, 2, 1}, // {1, {0}, 1, 63, 1, 0}, // {1, {1}, 1, 63, 0, 0}, // {1, {2}, 1, 63, 0, 0}, // }; static constexpr size_t kNumScans3 = ARRAY_SIZE(kScanScript3); static constexpr jpeg_scan_info kScanScript4[] = { {3, {0, 1, 2}, 0, 0, 0, 1}, // {1, {0}, 1, 5, 0, 2}, // {1, {2}, 1, 63, 0, 1}, // {1, {1}, 1, 63, 0, 1}, // {1, {0}, 6, 63, 0, 2}, // {1, {0}, 1, 63, 2, 1}, // {3, {0, 1, 2}, 0, 0, 1, 0}, // {1, {2}, 1, 63, 1, 0}, // {1, {1}, 1, 63, 1, 0}, // {1, {0}, 1, 63, 1, 0}, // }; static constexpr size_t kNumScans4 = ARRAY_SIZE(kScanScript4); static constexpr jpeg_scan_info kScanScript5[] = { {3, {0, 1, 2}, 0, 0, 0, 1}, // {1, {0}, 1, 5, 0, 2}, // {1, {1}, 1, 5, 0, 2}, // {1, {2}, 1, 5, 0, 2}, // {1, {1}, 6, 63, 0, 2}, // {1, {2}, 6, 63, 0, 2}, // {1, {0}, 6, 63, 0, 2}, // {1, {0}, 1, 63, 2, 1}, // {1, {1}, 1, 63, 2, 1}, // {1, {2}, 1, 63, 2, 1}, // {3, {0, 1, 2}, 0, 0, 1, 0}, // {1, {0}, 1, 63, 1, 0}, // {1, {1}, 1, 63, 1, 0}, // {1, {2}, 1, 63, 1, 0}, // }; static constexpr size_t kNumScans5 = ARRAY_SIZE(kScanScript5); // Adapt RGB scan info to grayscale jpegs. void FilterScanComponents(const jpeg_compress_struct* cinfo, jpeg_scan_info* si) { const int all_comps_in_scan = si->comps_in_scan; si->comps_in_scan = 0; for (int j = 0; j < all_comps_in_scan; ++j) { const int component = si->component_index[j]; if (component < cinfo->input_components) { si->component_index[si->comps_in_scan++] = component; } } } Status SetJpegProgression(int progressive_id, std::vector* scan_infos, jpeg_compress_struct* cinfo) { if (progressive_id < 0) { return true; } if (progressive_id == 0) { jpeg_simple_progression(cinfo); return true; } constexpr const jpeg_scan_info* kScanScripts[] = { kScanScript1, kScanScript2, kScanScript3, kScanScript4, kScanScript5, }; constexpr size_t kNumScans[] = {kNumScans1, kNumScans2, kNumScans3, kNumScans4, kNumScans5}; if (progressive_id > static_cast(ARRAY_SIZE(kNumScans))) { return JXL_FAILURE("Unknown jpeg scan script id %d", progressive_id); } const jpeg_scan_info* scan_script = kScanScripts[progressive_id - 1]; const size_t num_scans = kNumScans[progressive_id - 1]; // filter scan script for number of components for (size_t i = 0; i < num_scans; ++i) { jpeg_scan_info scan_info = scan_script[i]; FilterScanComponents(cinfo, &scan_info); if (scan_info.comps_in_scan > 0) { scan_infos->emplace_back(std::move(scan_info)); } } cinfo->scan_info = scan_infos->data(); cinfo->num_scans = scan_infos->size(); return true; } bool IsSRGBEncoding(const JxlColorEncoding& c) { return ((c.color_space == JXL_COLOR_SPACE_RGB || c.color_space == JXL_COLOR_SPACE_GRAY) && c.primaries == JXL_PRIMARIES_SRGB && c.white_point == JXL_WHITE_POINT_D65 && c.transfer_function == JXL_TRANSFER_FUNCTION_SRGB); } void WriteICCProfile(jpeg_compress_struct* const cinfo, const std::vector& icc) { constexpr size_t kMaxIccBytesInMarker = kMaxBytesInMarker - sizeof kICCSignature - 2; const int num_markers = static_cast(DivCeil(icc.size(), kMaxIccBytesInMarker)); size_t begin = 0; for (int current_marker = 0; current_marker < num_markers; ++current_marker) { const size_t length = std::min(kMaxIccBytesInMarker, icc.size() - begin); jpeg_write_m_header( cinfo, kICCMarker, static_cast(length + sizeof kICCSignature + 2)); for (const unsigned char c : kICCSignature) { jpeg_write_m_byte(cinfo, c); } jpeg_write_m_byte(cinfo, current_marker + 1); jpeg_write_m_byte(cinfo, num_markers); for (size_t i = 0; i < length; ++i) { jpeg_write_m_byte(cinfo, icc[begin]); ++begin; } } } void WriteExif(jpeg_compress_struct* const cinfo, const std::vector& exif) { jpeg_write_m_header( cinfo, kExifMarker, static_cast(exif.size() + sizeof kExifSignature)); for (const unsigned char c : kExifSignature) { jpeg_write_m_byte(cinfo, c); } for (size_t i = 0; i < exif.size(); ++i) { jpeg_write_m_byte(cinfo, exif[i]); } } Status SetChromaSubsampling(const std::string& subsampling, jpeg_compress_struct* const cinfo) { const std::pair, std::array>> options[] = {{"444", {{{1, 1, 1}}, {{1, 1, 1}}}}, {"420", {{{2, 1, 1}}, {{2, 1, 1}}}}, {"422", {{{2, 1, 1}}, {{1, 1, 1}}}}, {"440", {{{1, 1, 1}}, {{2, 1, 1}}}}}; for (const auto& option : options) { if (subsampling == option.first) { for (size_t i = 0; i < 3; i++) { cinfo->comp_info[i].h_samp_factor = option.second.first[i]; cinfo->comp_info[i].v_samp_factor = option.second.second[i]; } return true; } } return false; } Status EncodeWithLibJpeg(const PackedImage& image, const JxlBasicInfo& info, const JxlColorEncoding& color_encoding, const std::vector& icc, std::vector exif, size_t quality, const std::string& chroma_subsampling, int progressive_id, bool optimize_coding, std::vector* bytes) { if (BITS_IN_JSAMPLE != 8 || sizeof(JSAMPLE) != 1) { return JXL_FAILURE("Only 8 bit JSAMPLE is supported."); } jpeg_compress_struct cinfo = {}; jpeg_error_mgr jerr; cinfo.err = jpeg_std_error(&jerr); jpeg_create_compress(&cinfo); unsigned char* buffer = nullptr; unsigned long size = 0; jpeg_mem_dest(&cinfo, &buffer, &size); cinfo.image_width = image.xsize; cinfo.image_height = image.ysize; cinfo.input_components = info.num_color_channels; cinfo.in_color_space = info.num_color_channels == 1 ? JCS_GRAYSCALE : JCS_RGB; jpeg_set_defaults(&cinfo); cinfo.optimize_coding = optimize_coding; if (cinfo.input_components == 3) { JXL_RETURN_IF_ERROR(SetChromaSubsampling(chroma_subsampling, &cinfo)); } if (color_encoding.color_space == JXL_COLOR_SPACE_XYB) { // Tell libjpeg not to convert XYB data to YCbCr. jpeg_set_colorspace(&cinfo, JCS_RGB); } jpeg_set_quality(&cinfo, quality, TRUE); std::vector scan_infos; JXL_RETURN_IF_ERROR(SetJpegProgression(progressive_id, &scan_infos, &cinfo)); jpeg_start_compress(&cinfo, TRUE); if (!icc.empty()) { WriteICCProfile(&cinfo, icc); } if (!exif.empty()) { ResetExifOrientation(exif); WriteExif(&cinfo, exif); } if (cinfo.input_components > 3 || cinfo.input_components < 0) return JXL_FAILURE("invalid numbers of components"); std::vector raw_bytes(image.pixels_size); memcpy(&raw_bytes[0], reinterpret_cast(image.pixels()), image.pixels_size); for (size_t y = 0; y < info.ysize; ++y) { JSAMPROW row[] = {raw_bytes.data() + y * image.stride}; jpeg_write_scanlines(&cinfo, row, 1); } jpeg_finish_compress(&cinfo); jpeg_destroy_compress(&cinfo); bytes->resize(size); // Compressed image data is initialized by libjpeg, which we are not // instrumenting with msan. msan::UnpoisonMemory(buffer, size); std::copy_n(buffer, size, bytes->data()); std::free(buffer); return true; } Status EncodeWithSJpeg(const PackedImage& image, const JxlBasicInfo& info, const std::vector& icc, std::vector exif, size_t quality, const std::string& chroma_subsampling, std::vector* bytes) { #if !JPEGXL_ENABLE_SJPEG return JXL_FAILURE("JPEG XL was built without sjpeg support"); #else sjpeg::EncoderParam param(quality); if (!icc.empty()) { param.iccp.assign(icc.begin(), icc.end()); } if (!exif.empty()) { ResetExifOrientation(exif); param.exif.assign(exif.begin(), exif.end()); } if (chroma_subsampling == "444") { param.yuv_mode = SJPEG_YUV_444; } else if (chroma_subsampling == "420") { param.yuv_mode = SJPEG_YUV_SHARP; } else { return JXL_FAILURE("sjpeg does not support this chroma subsampling mode"); } size_t stride = info.xsize * 3; const uint8_t* pixels = reinterpret_cast(image.pixels()); std::string output; JXL_RETURN_IF_ERROR( sjpeg::Encode(pixels, image.xsize, image.ysize, stride, param, &output)); bytes->assign( reinterpret_cast(output.data()), reinterpret_cast(output.data() + output.size())); return true; #endif } Status EncodeImageJPG(const PackedImage& image, const JxlBasicInfo& info, const JxlColorEncoding& color_encoding, const std::vector& icc, std::vector exif, JpegEncoder encoder, size_t quality, const std::string& chroma_subsampling, int progressive_id, bool optimize_coding, ThreadPool* pool, std::vector* bytes) { if (image.format.data_type != JXL_TYPE_UINT8) { return JXL_FAILURE("Unsupported pixel data type"); } if (info.alpha_bits > 0) { return JXL_FAILURE("alpha is not supported"); } if (quality > 100) { return JXL_FAILURE("please specify a 0-100 JPEG quality"); } switch (encoder) { case JpegEncoder::kLibJpeg: JXL_RETURN_IF_ERROR(EncodeWithLibJpeg( image, info, color_encoding, icc, std::move(exif), quality, chroma_subsampling, progressive_id, optimize_coding, bytes)); break; case JpegEncoder::kSJpeg: JXL_RETURN_IF_ERROR(EncodeWithSJpeg(image, info, icc, std::move(exif), quality, chroma_subsampling, bytes)); break; default: return JXL_FAILURE("tried to use an unknown JPEG encoder"); } return true; } class JPEGEncoder : public Encoder { std::vector AcceptedFormats() const override { std::vector formats; for (const uint32_t num_channels : {1, 3}) { for (JxlEndianness endianness : {JXL_BIG_ENDIAN, JXL_LITTLE_ENDIAN}) { formats.push_back(JxlPixelFormat{/*num_channels=*/num_channels, /*data_type=*/JXL_TYPE_UINT8, /*endianness=*/endianness, /*align=*/0}); } } return formats; } Status Encode(const PackedPixelFile& ppf, EncodedImage* encoded_image, ThreadPool* pool = nullptr) const override { JXL_RETURN_IF_ERROR(VerifyBasicInfo(ppf.info)); int quality = 100; std::string chroma_subsampling = "444"; JpegEncoder jpeg_encoder = JpegEncoder::kLibJpeg; int progressive_id = -1; bool optimize_coding = true; for (const auto& it : options()) { if (it.first == "q") { std::istringstream is(it.second); JXL_RETURN_IF_ERROR(static_cast(is >> quality)); } else if (it.first == "chroma_subsampling") { chroma_subsampling = it.second; } else if (it.first == "jpeg_encoder") { if (it.second == "libjpeg") { jpeg_encoder = JpegEncoder::kLibJpeg; } else if (it.second == "sjpeg") { jpeg_encoder = JpegEncoder::kSJpeg; } else { return JXL_FAILURE("unknown jpeg encoder \"%s\"", it.second.c_str()); } } else if (it.first == "progressive") { std::istringstream is(it.second); JXL_RETURN_IF_ERROR(static_cast(is >> progressive_id)); } else if (it.first == "optimize" && it.second == "OFF") { optimize_coding = false; } } std::vector icc; if (!IsSRGBEncoding(ppf.color_encoding)) { icc = ppf.icc; } encoded_image->bitstreams.clear(); encoded_image->bitstreams.reserve(ppf.frames.size()); for (const auto& frame : ppf.frames) { JXL_RETURN_IF_ERROR(VerifyPackedImage(frame.color, ppf.info)); encoded_image->bitstreams.emplace_back(); JXL_RETURN_IF_ERROR(EncodeImageJPG( frame.color, ppf.info, ppf.color_encoding, icc, ppf.metadata.exif, jpeg_encoder, quality, chroma_subsampling, progressive_id, optimize_coding, pool, &encoded_image->bitstreams.back())); } return true; } }; } // namespace std::unique_ptr GetJPEGEncoder() { return jxl::make_unique(); } } // namespace extras } // namespace jxl