blob: 9cc452d804eb3b11e90ba0e800094fc5e4b2a365 [file] [log] [blame]
/*
* Copyright 2015 Google Inc.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#include "include/codec/SkAndroidCodec.h"
#include "include/codec/SkCodec.h"
#include "include/codec/SkEncodedImageFormat.h"
#include "include/core/SkAlphaType.h"
#include "include/core/SkColorType.h"
#include "include/core/SkData.h"
#include "include/core/SkRect.h"
#include "include/core/SkStream.h"
#include "modules/skcms/skcms.h"
#include "src/codec/SkAndroidCodecAdapter.h"
#include "src/codec/SkCodecPriv.h"
#include "src/codec/SkSampledCodec.h"
#include <algorithm>
#include <cstdint>
#include <functional>
#include <utility>
class SkPngChunkReader;
static bool is_valid_sample_size(int sampleSize) {
// FIXME: As Leon has mentioned elsewhere, surely there is also a maximum sampleSize?
return sampleSize > 0;
}
static bool cicp_get_primaries(uint8_t primaries, skcms_Matrix3x3* sk_primaries) {
// Rec. ITU-T H.273, Table 2.
switch (primaries) {
case 0:
// Reserved.
break;
case 1:
*sk_primaries = SkNamedGamut::kSRGB;
return true;
case 2:
// Unspecified.
break;
case 3:
// Reserved.
break;
case 4:
return skcms_PrimariesToXYZD50(
0.67f, 0.33f, 0.21f, 0.71f, 0.14f, 0.08f, 0.31f, 0.316f, sk_primaries);
case 5:
return skcms_PrimariesToXYZD50(
0.64f, 0.33f, 0.29f, 0.60f, 0.15f, 0.06f, 0.3127f, 0.3290f, sk_primaries);
case 6:
return skcms_PrimariesToXYZD50(
0.630f, 0.340f, 0.310f, 0.595f, 0.155f, 0.070f, 0.3127f, 0.3290f, sk_primaries);
case 7:
return skcms_PrimariesToXYZD50(
0.630f, 0.340f, 0.310f, 0.595f, 0.155f, 0.070f, 0.3127f, 0.3290f, sk_primaries);
case 8:
return skcms_PrimariesToXYZD50(
0.681f, 0.319f, 0.243f, 0.692f, 0.145f, 0.049f, 0.310f, 0.316f, sk_primaries);
case 9:
*sk_primaries = SkNamedGamut::kRec2020;
return true;
case 10:
return skcms_PrimariesToXYZD50(
1.f, 0.f, 0.f, 1.f, 0.f, 0.f, 1.f / 3.f, 1.f / 3.f, sk_primaries);
case 11:
return skcms_PrimariesToXYZD50(
0.680f, 0.320f, 0.265f, 0.690f, 0.150f, 0.060f, 0.314f, 0.351f, sk_primaries);
case 12:
return skcms_PrimariesToXYZD50(
0.680f, 0.320f, 0.265f, 0.690f, 0.150f, 0.060f, 0.3127f, 0.3290f, sk_primaries);
case 22:
return skcms_PrimariesToXYZD50(
0.630f, 0.340f, 0.295f, 0.605f, 0.155f, 0.077f, 0.3127f, 0.3290f, sk_primaries);
default:
// Reserved.
break;
}
*sk_primaries = SkNamedGamut::kSRGB;
return false;
}
static bool cicp_get_transfer_fn(uint8_t transfer_characteristics, skcms_TransferFunction* trfn) {
// Rec. ITU-T H.273, Table 3.
switch (transfer_characteristics) {
case 0:
// Reserved.
break;
case 1:
*trfn = SkNamedTransferFn::kRec2020;
return true;
case 2:
// Unspecified.
break;
case 3:
// Reserved.
break;
case 4:
*trfn = {2.2f, 1.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f};
return true;
case 5:
*trfn = {2.8f, 1.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f};
return true;
case 6:
*trfn = SkNamedTransferFn::kRec2020;
return true;
case 7:
*trfn = {2.222222222222f,
0.899626676224f,
0.100373323776f,
0.25f,
0.091286342118f,
0.f,
0.f};
return true;
case 8:
*trfn = SkNamedTransferFn::kLinear;
return true;
case 9:
// Logarithmic transfer characteristic (100:1 range).
// Not supported by skcms
break;
case 10:
// Logarithmic transfer characteristic (100 * Sqrt( 10 ) : 1 range).
// Not supported by skcms
break;
case 11:
*trfn = SkNamedTransferFn::kSRGB;
break;
case 12:
// Rec. ITU-R BT.1361-0 extended colour gamut system (historical).
// Same as kRec709 on positive values, differs on negative values.
// Not supported by skcms
break;
case 13:
*trfn = SkNamedTransferFn::kSRGB;
return true;
case 14:
*trfn = SkNamedTransferFn::kRec2020;
return true;
case 15:
*trfn = SkNamedTransferFn::kRec2020;
return true;
case 16:
// Android expects PQ to match 203 nits to SDR white
*trfn = {-2.f,
-1.55522297832f,
1.86045365631f,
32 / 2523.0f,
2413 / 128.0f,
-2392 / 128.0f,
8192 / 1305.0f};
return true;
case 17:
*trfn = {2.6f, 1.034080527699f, 0.f, 0.f, 0.f, 0.f, 0.f};
return true;
case 18:
// Android expects HLG to match 203 nits to SDR white
if (skcms_TransferFunction_makeScaledHLGish(trfn,
0.314509843f,
2.f,
2.f,
1.f / 0.17883277f,
0.28466892f,
0.55991073f)) {
return true;
}
break;
default:
// 19-255 Reserved.
break;
}
*trfn = SkNamedTransferFn::kSRGB;
return false;
}
static sk_sp<SkColorSpace> cicp_get_sk_color_space(uint8_t color_primaries,
uint8_t transfer_characteristics,
uint8_t matrix_coefficients,
uint8_t full_range_flag) {
if (matrix_coefficients != 0) return nullptr;
if (full_range_flag != 1) return nullptr;
skcms_TransferFunction trfn;
if (!cicp_get_transfer_fn(transfer_characteristics, &trfn)) return nullptr;
skcms_Matrix3x3 primaries;
if (!cicp_get_primaries(color_primaries, &primaries)) return nullptr;
return SkColorSpace::MakeRGB(trfn, primaries);
}
SkAndroidCodec::SkAndroidCodec(SkCodec* codec)
: fInfo(codec->getInfo())
, fCodec(codec)
{}
SkAndroidCodec::~SkAndroidCodec() {}
std::unique_ptr<SkAndroidCodec> SkAndroidCodec::MakeFromStream(std::unique_ptr<SkStream> stream,
SkPngChunkReader* chunkReader) {
auto codec = SkCodec::MakeFromStream(std::move(stream), nullptr, chunkReader);
return MakeFromCodec(std::move(codec));
}
std::unique_ptr<SkAndroidCodec> SkAndroidCodec::MakeFromCodec(std::unique_ptr<SkCodec> codec) {
if (nullptr == codec) {
return nullptr;
}
const SkEncodedImageFormat format = codec->getEncodedFormat();
if (format == SkEncodedImageFormat::kAVIF) {
if (SkCodecs::HasDecoder("avif")) {
// If a dedicated AVIF decoder has been registered, SkAvifCodec can
// handle scaling internally.
return std::make_unique<SkAndroidCodecAdapter>(codec.release());
}
// This will fallback to SkHeifCodec, which needs sampling.
return std::make_unique<SkSampledCodec>(codec.release());
}
switch (format) {
case SkEncodedImageFormat::kPNG:
case SkEncodedImageFormat::kICO:
case SkEncodedImageFormat::kJPEG:
case SkEncodedImageFormat::kBMP:
case SkEncodedImageFormat::kWBMP:
case SkEncodedImageFormat::kHEIF:
return std::make_unique<SkSampledCodec>(codec.release());
case SkEncodedImageFormat::kGIF:
case SkEncodedImageFormat::kWEBP:
case SkEncodedImageFormat::kDNG:
return std::make_unique<SkAndroidCodecAdapter>(codec.release());
case SkEncodedImageFormat::kAVIF: // Handled above
case SkEncodedImageFormat::kPKM:
case SkEncodedImageFormat::kKTX:
case SkEncodedImageFormat::kASTC:
case SkEncodedImageFormat::kJPEGXL:
return nullptr;
}
SkUNREACHABLE;
}
std::unique_ptr<SkAndroidCodec> SkAndroidCodec::MakeFromData(sk_sp<SkData> data,
SkPngChunkReader* chunkReader) {
if (!data) {
return nullptr;
}
return MakeFromStream(SkMemoryStream::Make(std::move(data)), chunkReader);
}
SkColorType SkAndroidCodec::computeOutputColorType(SkColorType requestedColorType) {
bool highPrecision = fCodec->getEncodedInfo().bitsPerComponent() > 8;
uint8_t colorDepth = fCodec->getEncodedInfo().getColorDepth();
switch (requestedColorType) {
case kARGB_4444_SkColorType:
return kN32_SkColorType;
case kN32_SkColorType:
break;
case kAlpha_8_SkColorType:
// Fall through to kGray_8. Before kGray_8_SkColorType existed,
// we allowed clients to request kAlpha_8 when they wanted a
// grayscale decode.
case kGray_8_SkColorType:
if (kGray_8_SkColorType == this->getInfo().colorType()) {
return kGray_8_SkColorType;
}
break;
case kRGB_565_SkColorType:
if (kOpaque_SkAlphaType == this->getInfo().alphaType()) {
return kRGB_565_SkColorType;
}
break;
case kRGBA_1010102_SkColorType:
if (colorDepth == 10) {
return kRGBA_1010102_SkColorType;
}
break;
case kRGBA_F16_SkColorType:
return kRGBA_F16_SkColorType;
default:
break;
}
// F16 is the Android default for high precision images.
return highPrecision ? kRGBA_F16_SkColorType :
(colorDepth == 10 ? kRGBA_1010102_SkColorType : kN32_SkColorType);
}
SkAlphaType SkAndroidCodec::computeOutputAlphaType(bool requestedUnpremul) {
if (kOpaque_SkAlphaType == this->getInfo().alphaType()) {
return kOpaque_SkAlphaType;
}
return requestedUnpremul ? kUnpremul_SkAlphaType : kPremul_SkAlphaType;
}
sk_sp<SkColorSpace> SkAndroidCodec::computeOutputColorSpace(SkColorType outputColorType,
sk_sp<SkColorSpace> prefColorSpace) {
switch (outputColorType) {
case kRGBA_F16_SkColorType:
case kRGB_565_SkColorType:
case kRGBA_8888_SkColorType:
case kBGRA_8888_SkColorType:
case kRGBA_1010102_SkColorType: {
// If |prefColorSpace| is supplied, choose it.
if (prefColorSpace) {
return prefColorSpace;
}
const skcms_ICCProfile* encodedProfile = fCodec->getEncodedInfo().profile();
if (encodedProfile) {
// Prefer CICP information if it exists.
if (encodedProfile->has_CICP) {
const auto cicpColorSpace =
cicp_get_sk_color_space(encodedProfile->CICP.color_primaries,
encodedProfile->CICP.transfer_characteristics,
encodedProfile->CICP.matrix_coefficients,
encodedProfile->CICP.video_full_range_flag);
if (cicpColorSpace) {
return cicpColorSpace;
}
}
if (auto encodedSpace = SkColorSpace::Make(*encodedProfile)) {
// Leave the pixels in the encoded color space. Color space conversion
// will be handled after decode time.
return encodedSpace;
}
if (encodedProfile->has_toXYZD50) {
return SkColorSpace::MakeRGB(SkNamedTransferFn::kSRGB,
encodedProfile->toXYZD50);
}
}
return SkColorSpace::MakeSRGB();
}
default:
// Color correction not supported for kGray.
return nullptr;
}
}
static bool supports_any_down_scale(const SkCodec* codec) {
return codec->getEncodedFormat() == SkEncodedImageFormat::kWEBP;
}
// There are a variety of ways two SkISizes could be compared. This method
// returns true if either dimensions of a is < that of b.
// computeSampleSize also uses the opposite, which means that both
// dimensions of a >= b.
static inline bool smaller_than(const SkISize& a, const SkISize& b) {
return a.width() < b.width() || a.height() < b.height();
}
// Both dimensions of a > that of b.
static inline bool strictly_bigger_than(const SkISize& a, const SkISize& b) {
return a.width() > b.width() && a.height() > b.height();
}
int SkAndroidCodec::computeSampleSize(SkISize* desiredSize) const {
SkASSERT(desiredSize);
const auto origDims = fCodec->dimensions();
if (!desiredSize || *desiredSize == origDims) {
return 1;
}
if (smaller_than(origDims, *desiredSize)) {
*desiredSize = origDims;
return 1;
}
// Handle bad input:
if (desiredSize->width() < 1 || desiredSize->height() < 1) {
*desiredSize = SkISize::Make(std::max(1, desiredSize->width()),
std::max(1, desiredSize->height()));
}
if (supports_any_down_scale(fCodec.get())) {
return 1;
}
int sampleX = origDims.width() / desiredSize->width();
int sampleY = origDims.height() / desiredSize->height();
int sampleSize = std::min(sampleX, sampleY);
auto computedSize = this->getSampledDimensions(sampleSize);
if (computedSize == *desiredSize) {
return sampleSize;
}
if (computedSize == origDims || sampleSize == 1) {
// Cannot downscale
*desiredSize = computedSize;
return 1;
}
if (strictly_bigger_than(computedSize, *desiredSize)) {
// See if there is a tighter fit.
while (true) {
auto smaller = this->getSampledDimensions(sampleSize + 1);
if (smaller == *desiredSize) {
return sampleSize + 1;
}
if (smaller == computedSize || smaller_than(smaller, *desiredSize)) {
// Cannot get any smaller without being smaller than desired.
*desiredSize = computedSize;
return sampleSize;
}
sampleSize++;
computedSize = smaller;
}
SkASSERT(false);
}
if (!smaller_than(computedSize, *desiredSize)) {
// This means one of the computed dimensions is equal to desired, and
// the other is bigger. This is as close as we can get.
*desiredSize = computedSize;
return sampleSize;
}
// computedSize is too small. Make it larger.
while (sampleSize > 2) {
auto bigger = this->getSampledDimensions(sampleSize - 1);
if (bigger == *desiredSize || !smaller_than(bigger, *desiredSize)) {
*desiredSize = bigger;
return sampleSize - 1;
}
sampleSize--;
}
*desiredSize = origDims;
return 1;
}
SkISize SkAndroidCodec::getSampledDimensions(int sampleSize) const {
if (!is_valid_sample_size(sampleSize)) {
return {0, 0};
}
// Fast path for when we are not scaling.
if (1 == sampleSize) {
return fCodec->dimensions();
}
return this->onGetSampledDimensions(sampleSize);
}
bool SkAndroidCodec::getSupportedSubset(SkIRect* desiredSubset) const {
if (!desiredSubset || !is_valid_subset(*desiredSubset, fCodec->dimensions())) {
return false;
}
return this->onGetSupportedSubset(desiredSubset);
}
SkISize SkAndroidCodec::getSampledSubsetDimensions(int sampleSize, const SkIRect& subset) const {
if (!is_valid_sample_size(sampleSize)) {
return {0, 0};
}
// We require that the input subset is a subset that is supported by SkAndroidCodec.
// We test this by calling getSupportedSubset() and verifying that no modifications
// are made to the subset.
SkIRect copySubset = subset;
if (!this->getSupportedSubset(&copySubset) || copySubset != subset) {
return {0, 0};
}
// If the subset is the entire image, for consistency, use getSampledDimensions().
if (fCodec->dimensions() == subset.size()) {
return this->getSampledDimensions(sampleSize);
}
// This should perhaps call a virtual function, but currently both of our subclasses
// want the same implementation.
return {get_scaled_dimension(subset.width(), sampleSize),
get_scaled_dimension(subset.height(), sampleSize)};
}
SkCodec::Result SkAndroidCodec::getAndroidPixels(const SkImageInfo& requestInfo,
void* requestPixels, size_t requestRowBytes, const AndroidOptions* options) {
if (!requestPixels) {
return SkCodec::kInvalidParameters;
}
if (requestRowBytes < requestInfo.minRowBytes()) {
return SkCodec::kInvalidParameters;
}
AndroidOptions defaultOptions;
if (!options) {
options = &defaultOptions;
} else {
if (options->fSubset) {
if (!is_valid_subset(*options->fSubset, fCodec->dimensions())) {
return SkCodec::kInvalidParameters;
}
if (SkIRect::MakeSize(fCodec->dimensions()) == *options->fSubset) {
// The caller wants the whole thing, rather than a subset. Modify
// the AndroidOptions passed to onGetAndroidPixels to not specify
// a subset.
defaultOptions = *options;
defaultOptions.fSubset = nullptr;
options = &defaultOptions;
}
}
}
// We may need to have handleFrameIndex recursively call this method
// to resolve one frame depending on another. The recursion stops
// when we find a frame which does not require an earlier frame
// e.g. frame->getRequiredFrame() returns kNoFrame
auto getPixelsFn = [&](const SkImageInfo& info, void* pixels, size_t rowBytes,
const SkCodec::Options& opts, int requiredFrame
) -> SkCodec::Result {
SkAndroidCodec::AndroidOptions prevFrameOptions(
reinterpret_cast<const SkAndroidCodec::AndroidOptions&>(opts));
prevFrameOptions.fFrameIndex = requiredFrame;
return this->getAndroidPixels(info, pixels, rowBytes, &prevFrameOptions);
};
if (auto result = fCodec->handleFrameIndex(requestInfo, requestPixels, requestRowBytes,
*options, getPixelsFn); result != SkCodec::kSuccess) {
return result;
}
return this->onGetAndroidPixels(requestInfo, requestPixels, requestRowBytes, *options);
}
SkCodec::Result SkAndroidCodec::getAndroidPixels(const SkImageInfo& info, void* pixels,
size_t rowBytes) {
return this->getAndroidPixels(info, pixels, rowBytes, nullptr);
}
bool SkAndroidCodec::getAndroidGainmap(SkGainmapInfo* info,
std::unique_ptr<SkStream>* outGainmapImageStream) {
return fCodec->onGetGainmapInfo(info, outGainmapImageStream);
}