/src/libjxl/lib/jxl/frame_header.cc

Source (jump to first uncovered line)
// 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/jxl/frame_header.h"

#if JXL_DEBUG_V_LEVEL >= 1
#include <sstream>
#include <string>
#endif

#include "lib/jxl/base/printf_macros.h"
#include "lib/jxl/base/status.h"
#include "lib/jxl/common.h"  // kMaxNumPasses
#include "lib/jxl/fields.h"
#include "lib/jxl/pack_signed.h"

namespace jxl {

constexpr uint8_t YCbCrChromaSubsampling::kHShift[] = {0, 1, 1, 0};
constexpr uint8_t YCbCrChromaSubsampling::kVShift[] = {0, 1, 0, 1};

static Status VisitBlendMode(Visitor* JXL_RESTRICT visitor,
                             BlendMode default_value, BlendMode* blend_mode) {
  uint32_t encoded = static_cast<uint32_t>(*blend_mode);

  JXL_QUIET_RETURN_IF_ERROR(visitor->U32(
      Val(static_cast<uint32_t>(BlendMode::kReplace)),
      Val(static_cast<uint32_t>(BlendMode::kAdd)),
      Val(static_cast<uint32_t>(BlendMode::kBlend)), BitsOffset(2, 3),
      static_cast<uint32_t>(default_value), &encoded));
  if (encoded > static_cast<uint32_t>(BlendMode::kMul)) {
    return JXL_FAILURE("Invalid blend_mode");
  }
  *blend_mode = static_cast<BlendMode>(encoded);
  return true;
}

static Status VisitFrameType(Visitor* JXL_RESTRICT visitor,
                             FrameType default_value, FrameType* frame_type) {
  uint32_t encoded = static_cast<uint32_t>(*frame_type);

  JXL_QUIET_RETURN_IF_ERROR(
      visitor->U32(Val(static_cast<uint32_t>(FrameType::kRegularFrame)),
                   Val(static_cast<uint32_t>(FrameType::kDCFrame)),
                   Val(static_cast<uint32_t>(FrameType::kReferenceOnly)),
                   Val(static_cast<uint32_t>(FrameType::kSkipProgressive)),
                   static_cast<uint32_t>(default_value), &encoded));
  *frame_type = static_cast<FrameType>(encoded);
  return true;
}

BlendingInfo::BlendingInfo() { Bundle::Init(this); }

Status BlendingInfo::VisitFields(Visitor* JXL_RESTRICT visitor) {
  JXL_QUIET_RETURN_IF_ERROR(
      VisitBlendMode(visitor, BlendMode::kReplace, &mode));
  if (visitor->Conditional(nonserialized_num_extra_channels > 0 &&
                           (mode == BlendMode::kBlend ||
                            mode == BlendMode::kAlphaWeightedAdd))) {
    // Up to 11 alpha channels for blending.
    JXL_QUIET_RETURN_IF_ERROR(visitor->U32(
        Val(0), Val(1), Val(2), BitsOffset(3, 3), 0, &alpha_channel));
    if (visitor->IsReading() &&
        alpha_channel >= nonserialized_num_extra_channels) {
      return JXL_FAILURE("Invalid alpha channel for blending");
    }
  }
  if (visitor->Conditional((nonserialized_num_extra_channels > 0 &&
                            (mode == BlendMode::kBlend ||
                             mode == BlendMode::kAlphaWeightedAdd)) ||
                           mode == BlendMode::kMul)) {
    JXL_QUIET_RETURN_IF_ERROR(visitor->Bool(false, &clamp));
  }
  // 'old' frame for blending. Only necessary if this is not a full frame, or
  // blending is not kReplace.
  if (visitor->Conditional(mode != BlendMode::kReplace ||
                           nonserialized_is_partial_frame)) {
    JXL_QUIET_RETURN_IF_ERROR(
        visitor->U32(Val(0), Val(1), Val(2), Val(3), 0, &source));
  }
  return true;
}

#if JXL_DEBUG_V_LEVEL >= 1
std::string BlendingInfo::DebugString() const {
  std::ostringstream os;
  os << (mode == BlendMode::kReplace            ? "Replace"
         : mode == BlendMode::kAdd              ? "Add"
         : mode == BlendMode::kBlend            ? "Blend"
         : mode == BlendMode::kAlphaWeightedAdd ? "AlphaWeightedAdd"
                                                : "Mul");
  if (nonserialized_num_extra_channels > 0 &&
      (mode == BlendMode::kBlend || mode == BlendMode::kAlphaWeightedAdd)) {
    os << ",alpha=" << alpha_channel << ",clamp=" << clamp;
  } else if (mode == BlendMode::kMul) {
    os << ",clamp=" << clamp;
  }
  if (mode != BlendMode::kReplace || nonserialized_is_partial_frame) {
    os << ",source=" << source;
  }
  return os.str();
}
#endif

AnimationFrame::AnimationFrame(const CodecMetadata* metadata)
    : nonserialized_metadata(metadata) {
  Bundle::Init(this);
}
Status AnimationFrame::VisitFields(Visitor* JXL_RESTRICT visitor) {
  if (visitor->Conditional(nonserialized_metadata != nullptr &&
                           nonserialized_metadata->m.have_animation)) {
    JXL_QUIET_RETURN_IF_ERROR(
        visitor->U32(Val(0), Val(1), Bits(8), Bits(32), 0, &duration));
  }

  if (visitor->Conditional(
          nonserialized_metadata != nullptr &&
          nonserialized_metadata->m.animation.have_timecodes)) {
    JXL_QUIET_RETURN_IF_ERROR(visitor->Bits(32, 0, &timecode));
  }
  return true;
}

YCbCrChromaSubsampling::YCbCrChromaSubsampling() { Bundle::Init(this); }
Passes::Passes() { Bundle::Init(this); }
Status Passes::VisitFields(Visitor* JXL_RESTRICT visitor) {
  JXL_QUIET_RETURN_IF_ERROR(
      visitor->U32(Val(1), Val(2), Val(3), BitsOffset(3, 4), 1, &num_passes));
  JXL_ENSURE(num_passes <= kMaxNumPasses);  // Cannot happen when reading

  if (visitor->Conditional(num_passes != 1)) {
    JXL_QUIET_RETURN_IF_ERROR(visitor->U32(
        Val(0), Val(1), Val(2), BitsOffset(1, 3), 0, &num_downsample));
    JXL_ENSURE(num_downsample <= 4);  // 1,2,4,8
    if (num_downsample > num_passes) {
      return JXL_FAILURE("num_downsample %u > num_passes %u", num_downsample,
                         num_passes);
    }

    for (uint32_t i = 0; i < num_passes - 1; i++) {
      JXL_QUIET_RETURN_IF_ERROR(visitor->Bits(2, 0, &shift[i]));
    }
    shift[num_passes - 1] = 0;

    for (uint32_t i = 0; i < num_downsample; ++i) {
      JXL_QUIET_RETURN_IF_ERROR(
          visitor->U32(Val(1), Val(2), Val(4), Val(8), 1, &downsample[i]));
      if (i > 0 && downsample[i] >= downsample[i - 1]) {
        return JXL_FAILURE("downsample sequence should be decreasing");
      }
    }
    for (uint32_t i = 0; i < num_downsample; ++i) {
      JXL_QUIET_RETURN_IF_ERROR(
          visitor->U32(Val(0), Val(1), Val(2), Bits(3), 0, &last_pass[i]));
      if (i > 0 && last_pass[i] <= last_pass[i - 1]) {
        return JXL_FAILURE("last_pass sequence should be increasing");
      }
      if (last_pass[i] >= num_passes) {
        return JXL_FAILURE("last_pass %u >= num_passes %u", last_pass[i],
                           num_passes);
      }
    }
  }

  return true;
}

#if JXL_DEBUG_V_LEVEL >= 1
std::string Passes::DebugString() const {
  std::ostringstream os;
  os << "p=" << num_passes;
  if (num_downsample) {
    os << ",ds=";
    for (uint32_t i = 0; i < num_downsample; ++i) {
      os << last_pass[i] << ":" << downsample[i];
      if (i + 1 < num_downsample) os << ";";
    }
  }
  bool have_shifts = false;
  for (uint32_t i = 0; i < num_passes; ++i) {
    if (shift[i]) have_shifts = true;
  }
  if (have_shifts) {
    os << ",shifts=";
    for (uint32_t i = 0; i < num_passes; ++i) {
      os << shift[i];
      if (i + 1 < num_passes) os << ";";
    }
  }
  return os.str();
}
#endif

FrameHeader::FrameHeader(const CodecMetadata* metadata)
    : animation_frame(metadata), nonserialized_metadata(metadata) {
  Bundle::Init(this);
}

Status ReadFrameHeader(BitReader* JXL_RESTRICT reader,
                       FrameHeader* JXL_RESTRICT frame) {
  return Bundle::Read(reader, frame);
}

Status FrameHeader::VisitFields(Visitor* JXL_RESTRICT visitor) {
  if (visitor->AllDefault(*this, &all_default)) {
    // Overwrite all serialized fields, but not any nonserialized_*.
    visitor->SetDefault(this);
    return true;
  }

  JXL_QUIET_RETURN_IF_ERROR(
      VisitFrameType(visitor, FrameType::kRegularFrame, &frame_type));
  if (visitor->IsReading() && nonserialized_is_preview &&
      frame_type != kRegularFrame) {
    return JXL_FAILURE("Only regular frame could be a preview");
  }

  // FrameEncoding.
  bool is_modular = (encoding == FrameEncoding::kModular);
  JXL_QUIET_RETURN_IF_ERROR(visitor->Bool(false, &is_modular));
  encoding = (is_modular ? FrameEncoding::kModular : FrameEncoding::kVarDCT);

  // Flags
  JXL_QUIET_RETURN_IF_ERROR(visitor->U64(0, &flags));

  // Color transform
  bool xyb_encoded = nonserialized_metadata == nullptr ||
                     nonserialized_metadata->m.xyb_encoded;

  if (xyb_encoded) {
    color_transform = ColorTransform::kXYB;
  } else {
    // Alternate if kYCbCr.
    bool alternate = color_transform == ColorTransform::kYCbCr;
    JXL_QUIET_RETURN_IF_ERROR(visitor->Bool(false, &alternate));
    color_transform =
        (alternate ? ColorTransform::kYCbCr : ColorTransform::kNone);
  }

  // Chroma subsampling for YCbCr, if no DC frame is used.
  if (visitor->Conditional(color_transform == ColorTransform::kYCbCr &&
                           ((flags & kUseDcFrame) == 0))) {
    JXL_QUIET_RETURN_IF_ERROR(visitor->VisitNested(&chroma_subsampling));
  }

  size_t num_extra_channels =
      nonserialized_metadata != nullptr
          ? nonserialized_metadata->m.extra_channel_info.size()
          : 0;

  // Upsampling
  if (visitor->Conditional((flags & kUseDcFrame) == 0)) {
    JXL_QUIET_RETURN_IF_ERROR(
        visitor->U32(Val(1), Val(2), Val(4), Val(8), 1, &upsampling));
    if (nonserialized_metadata != nullptr &&
        visitor->Conditional(num_extra_channels != 0)) {
      const std::vector<ExtraChannelInfo>& extra_channels =
          nonserialized_metadata->m.extra_channel_info;
      extra_channel_upsampling.resize(extra_channels.size(), 1);
      for (size_t i = 0; i < extra_channels.size(); ++i) {
        uint32_t dim_shift =
            nonserialized_metadata->m.extra_channel_info[i].dim_shift;
        uint32_t& ec_upsampling = extra_channel_upsampling[i];
        ec_upsampling >>= dim_shift;
        JXL_QUIET_RETURN_IF_ERROR(
            visitor->U32(Val(1), Val(2), Val(4), Val(8), 1, &ec_upsampling));
        ec_upsampling <<= dim_shift;
        if (ec_upsampling < upsampling) {
          return JXL_FAILURE(
              "EC upsampling (%u) < color upsampling (%u), which is invalid.",
              ec_upsampling, upsampling);
        }
        if (ec_upsampling > 8) {
          return JXL_FAILURE("EC upsampling too large (%u)", ec_upsampling);
        }
      }
    } else {
      extra_channel_upsampling.clear();
    }
  }

  // Modular- or VarDCT-specific data.
  if (visitor->Conditional(encoding == FrameEncoding::kModular)) {
    JXL_QUIET_RETURN_IF_ERROR(visitor->Bits(2, 1, &group_size_shift));
  }
  if (visitor->Conditional(encoding == FrameEncoding::kVarDCT &&
                           color_transform == ColorTransform::kXYB)) {
    JXL_QUIET_RETURN_IF_ERROR(visitor->Bits(3, 3, &x_qm_scale));
    JXL_QUIET_RETURN_IF_ERROR(visitor->Bits(3, 2, &b_qm_scale));
  } else {
    x_qm_scale = b_qm_scale = 2;  // noop
  }

  // Not useful for kPatchSource
  if (visitor->Conditional(frame_type != FrameType::kReferenceOnly)) {
    JXL_QUIET_RETURN_IF_ERROR(visitor->VisitNested(&passes));
  }

  if (visitor->Conditional(frame_type == FrameType::kDCFrame)) {
    // Up to 4 pyramid levels - for up to 16384x downsampling.
    JXL_QUIET_RETURN_IF_ERROR(
        visitor->U32(Val(1), Val(2), Val(3), Val(4), 1, &dc_level));
  }
  if (frame_type != FrameType::kDCFrame) {
    dc_level = 0;
  }

  bool is_partial_frame = false;
  if (visitor->Conditional(frame_type != FrameType::kDCFrame)) {
    JXL_QUIET_RETURN_IF_ERROR(visitor->Bool(false, &custom_size_or_origin));
    if (visitor->Conditional(custom_size_or_origin)) {
      const U32Enc enc(Bits(8), BitsOffset(11, 256), BitsOffset(14, 2304),
                       BitsOffset(30, 18688));
      // Frame offset, only if kRegularFrame or kSkipProgressive.
      if (visitor->Conditional(frame_type == FrameType::kRegularFrame ||
                               frame_type == FrameType::kSkipProgressive)) {
        uint32_t ux0 = PackSigned(frame_origin.x0);
        uint32_t uy0 = PackSigned(frame_origin.y0);
        JXL_QUIET_RETURN_IF_ERROR(visitor->U32(enc, 0, &ux0));
        JXL_QUIET_RETURN_IF_ERROR(visitor->U32(enc, 0, &uy0));
        frame_origin.x0 = UnpackSigned(ux0);
        frame_origin.y0 = UnpackSigned(uy0);
      }
      // Frame size
      JXL_QUIET_RETURN_IF_ERROR(visitor->U32(enc, 0, &frame_size.xsize));
      JXL_QUIET_RETURN_IF_ERROR(visitor->U32(enc, 0, &frame_size.ysize));
      if (custom_size_or_origin &&
          (frame_size.xsize == 0 || frame_size.ysize == 0)) {
        return JXL_FAILURE(
            "Invalid crop dimensions for frame: zero width or height");
      }
      int32_t image_xsize = default_xsize();
      int32_t image_ysize = default_ysize();
      if (frame_type == FrameType::kRegularFrame ||
          frame_type == FrameType::kSkipProgressive) {
        is_partial_frame |= frame_origin.x0 > 0;
        is_partial_frame |= frame_origin.y0 > 0;
        is_partial_frame |= (static_cast<int32_t>(frame_size.xsize) +
                             frame_origin.x0) < image_xsize;
        is_partial_frame |= (static_cast<int32_t>(frame_size.ysize) +
                             frame_origin.y0) < image_ysize;
      }
    }
  }

  // Blending info, animation info and whether this is the last frame or not.
  if (visitor->Conditional(frame_type == FrameType::kRegularFrame ||
                           frame_type == FrameType::kSkipProgressive)) {
    blending_info.nonserialized_num_extra_channels = num_extra_channels;
    blending_info.nonserialized_is_partial_frame = is_partial_frame;
    JXL_QUIET_RETURN_IF_ERROR(visitor->VisitNested(&blending_info));
    bool replace_all = (blending_info.mode == BlendMode::kReplace);
    extra_channel_blending_info.resize(num_extra_channels);
    for (size_t i = 0; i < num_extra_channels; i++) {
      auto& ec_blending_info = extra_channel_blending_info[i];
      ec_blending_info.nonserialized_is_partial_frame = is_partial_frame;
      ec_blending_info.nonserialized_num_extra_channels = num_extra_channels;
      JXL_QUIET_RETURN_IF_ERROR(visitor->VisitNested(&ec_blending_info));
      replace_all &= (ec_blending_info.mode == BlendMode::kReplace);
    }
    if (visitor->IsReading() && nonserialized_is_preview) {
      if (!replace_all || custom_size_or_origin) {
        return JXL_FAILURE("Preview is not compatible with blending");
      }
    }
    if (visitor->Conditional(nonserialized_metadata != nullptr &&
                             nonserialized_metadata->m.have_animation)) {
      animation_frame.nonserialized_metadata = nonserialized_metadata;
      JXL_QUIET_RETURN_IF_ERROR(visitor->VisitNested(&animation_frame));
    }
    JXL_QUIET_RETURN_IF_ERROR(visitor->Bool(true, &is_last));
  } else {
    is_last = false;
  }

  // ID of that can be used to refer to this frame. 0 for a non-zero-duration
  // frame means that it will not be referenced. Not necessary for the last
  // frame.
  if (visitor->Conditional(frame_type != kDCFrame && !is_last)) {
    JXL_QUIET_RETURN_IF_ERROR(
        visitor->U32(Val(0), Val(1), Val(2), Val(3), 0, &save_as_reference));
  }

  // If this frame is not blended on another frame post-color-transform, it may
  // be stored for being referenced either before or after the color transform.
  // If it is blended post-color-transform, it must be blended after. It must
  // also be blended after if this is a kRegular frame that does not cover the
  // full frame, as samples outside the partial region are from a
  // post-color-transform frame.
  if (frame_type != FrameType::kDCFrame) {
    if (visitor->Conditional(CanBeReferenced() &&
                             blending_info.mode == BlendMode::kReplace &&
                             !is_partial_frame &&
                             (frame_type == FrameType::kRegularFrame ||
                              frame_type == FrameType::kSkipProgressive))) {
      JXL_QUIET_RETURN_IF_ERROR(
          visitor->Bool(false, &save_before_color_transform));
    } else if (visitor->Conditional(frame_type == FrameType::kReferenceOnly)) {
      JXL_QUIET_RETURN_IF_ERROR(
          visitor->Bool(true, &save_before_color_transform));
      size_t xsize = custom_size_or_origin ? frame_size.xsize
                                           : nonserialized_metadata->xsize();
      size_t ysize = custom_size_or_origin ? frame_size.ysize
                                           : nonserialized_metadata->ysize();
      if (!save_before_color_transform &&
          (xsize < nonserialized_metadata->xsize() ||
           ysize < nonserialized_metadata->ysize() || frame_origin.x0 != 0 ||
           frame_origin.y0 != 0)) {
        return JXL_FAILURE(
            "non-patch reference frame with invalid crop: %" PRIuS "x%" PRIuS
            "%+d%+d",
            xsize, ysize, static_cast<int>(frame_origin.x0),
            static_cast<int>(frame_origin.y0));
      }
    }
  } else {
    save_before_color_transform = true;
  }

  JXL_QUIET_RETURN_IF_ERROR(VisitNameString(visitor, &name));

  loop_filter.nonserialized_is_modular = is_modular;
  JXL_RETURN_IF_ERROR(visitor->VisitNested(&loop_filter));

  JXL_QUIET_RETURN_IF_ERROR(visitor->BeginExtensions(&extensions));
  // Extensions: in chronological order of being added to the format.
  return visitor->EndExtensions();
}

#if JXL_DEBUG_V_LEVEL >= 1
std::string FrameHeader::DebugString() const {
  std::ostringstream os;
  os << (encoding == FrameEncoding::kVarDCT ? "VarDCT" : "Modular");
  os << ",";
  os << (frame_type == FrameType::kRegularFrame    ? "Regular"
         : frame_type == FrameType::kDCFrame       ? "DC"
         : frame_type == FrameType::kReferenceOnly ? "Reference"
                                                   : "SkipProgressive");
  if (frame_type == FrameType::kDCFrame) {
    os << "(lv" << dc_level << ")";
  }

  if (flags) {
    os << ",";
    uint32_t remaining = flags;

#define TEST_FLAG(name)           \
  if (flags & Flags::k##name) {   \
    remaining &= ~Flags::k##name; \
    os << #name;                  \
    if (remaining) os << "|";     \
  }
    TEST_FLAG(Noise);
    TEST_FLAG(Patches);
    TEST_FLAG(Splines);
    TEST_FLAG(UseDcFrame);
    TEST_FLAG(SkipAdaptiveDCSmoothing);
#undef TEST_FLAG
  }

  os << ",";
  os << (color_transform == ColorTransform::kXYB     ? "XYB"
         : color_transform == ColorTransform::kYCbCr ? "YCbCr"
                                                     : "None");

  if (encoding == FrameEncoding::kModular) {
    os << ",shift=" << group_size_shift;
  } else if (color_transform == ColorTransform::kXYB) {
    os << ",qm=" << x_qm_scale << ";" << b_qm_scale;
  }
  if (frame_type != FrameType::kReferenceOnly) {
    os << "," << passes.DebugString();
  }
  if (custom_size_or_origin) {
    os << ",xs=" << frame_size.xsize;
    os << ",ys=" << frame_size.ysize;
    if (frame_type == FrameType::kRegularFrame ||
        frame_type == FrameType::kSkipProgressive) {
      os << ",x0=" << frame_origin.x0;
      os << ",y0=" << frame_origin.y0;
    }
  }
  if (upsampling > 1) os << ",up=" << upsampling;
  if (loop_filter.gab) os << ",Gaborish";
  if (loop_filter.epf_iters > 0) os << ",epf=" << loop_filter.epf_iters;
  if (animation_frame.duration > 0) os << ",dur=" << animation_frame.duration;
  if (frame_type == FrameType::kRegularFrame ||
      frame_type == FrameType::kSkipProgressive) {
    os << ",";
    os << blending_info.DebugString();
    for (size_t i = 0; i < extra_channel_blending_info.size(); ++i) {
      os << (i == 0 ? "[" : ";");
      os << extra_channel_blending_info[i].DebugString();
      if (i + 1 == extra_channel_blending_info.size()) os << "]";
    }
  }
  if (save_as_reference > 0) os << ",ref=" << save_as_reference;
  os << "," << (save_before_color_transform ? "before" : "after") << "_ct";
  if (is_last) os << ",last";
  return os.str();
}
#endif

}  // namespace jxl

Coverage Report

Created: 2025-07-16 07:53

Line	Count	Source (jump to first uncovered line)
1		// Copyright (c) the JPEG XL Project Authors. All rights reserved.
2		//
3		// Use of this source code is governed by a BSD-style
4		// license that can be found in the LICENSE file.
5
6		#include "lib/jxl/frame_header.h"
7
8		#if JXL_DEBUG_V_LEVEL >= 1
9		#include <sstream>
10		#include <string>
11		#endif
12
13		#include "lib/jxl/base/printf_macros.h"
14		#include "lib/jxl/base/status.h"
15		#include "lib/jxl/common.h" // kMaxNumPasses
16		#include "lib/jxl/fields.h"
17		#include "lib/jxl/pack_signed.h"
18
19		namespace jxl {
20
21		constexpr uint8_t YCbCrChromaSubsampling::kHShift[] = {0, 1, 1, 0};
22		constexpr uint8_t YCbCrChromaSubsampling::kVShift[] = {0, 1, 0, 1};
23
24		static Status VisitBlendMode(Visitor* JXL_RESTRICT visitor,
25	201k	BlendMode default_value, BlendMode* blend_mode) {
26	201k	uint32_t encoded = static_cast<uint32_t>(*blend_mode);
27
28	201k	JXL_QUIET_RETURN_IF_ERROR(visitor->U32(
29	201k	Val(static_cast<uint32_t>(BlendMode::kReplace)),
30	201k	Val(static_cast<uint32_t>(BlendMode::kAdd)),
31	201k	Val(static_cast<uint32_t>(BlendMode::kBlend)), BitsOffset(2, 3),
32	201k	static_cast<uint32_t>(default_value), &encoded));
33	201k	if (encoded > static_cast<uint32_t>(BlendMode::kMul)) {
34	0	return JXL_FAILURE("Invalid blend_mode");
35	0	}
36	201k	*blend_mode = static_cast<BlendMode>(encoded);
37	201k	return true;
38	201k	}
39
40		static Status VisitFrameType(Visitor* JXL_RESTRICT visitor,
41	196k	FrameType default_value, FrameType* frame_type) {
42	196k	uint32_t encoded = static_cast<uint32_t>(*frame_type);
43
44	196k	JXL_QUIET_RETURN_IF_ERROR(
45	196k	visitor->U32(Val(static_cast<uint32_t>(FrameType::kRegularFrame)),
46	196k	Val(static_cast<uint32_t>(FrameType::kDCFrame)),
47	196k	Val(static_cast<uint32_t>(FrameType::kReferenceOnly)),
48	196k	Val(static_cast<uint32_t>(FrameType::kSkipProgressive)),
49	196k	static_cast<uint32_t>(default_value), &encoded));
50	196k	*frame_type = static_cast<FrameType>(encoded);
51	196k	return true;
52	196k	}
53
54	138k	BlendingInfo::BlendingInfo() { Bundle::Init(this); }
55
56	201k	Status BlendingInfo::VisitFields(Visitor* JXL_RESTRICT visitor) {
57	201k	JXL_QUIET_RETURN_IF_ERROR(
58	201k	VisitBlendMode(visitor, BlendMode::kReplace, &mode));
59	201k	if (visitor->Conditional(nonserialized_num_extra_channels > 0 &&
60	201k	(mode == BlendMode::kBlend \|\|
61	140k	mode == BlendMode::kAlphaWeightedAdd))) {
62		// Up to 11 alpha channels for blending.
63	140k	JXL_QUIET_RETURN_IF_ERROR(visitor->U32(
64	140k	Val(0), Val(1), Val(2), BitsOffset(3, 3), 0, &alpha_channel));
65	140k	if (visitor->IsReading() &&
66	140k	alpha_channel >= nonserialized_num_extra_channels) {
67	0	return JXL_FAILURE("Invalid alpha channel for blending");
68	0	}
69	140k	}
70	201k	if (visitor->Conditional((nonserialized_num_extra_channels > 0 &&
71	201k	(mode == BlendMode::kBlend \|\|
72	3.03k	mode == BlendMode::kAlphaWeightedAdd)) \|\|
73	201k	mode == BlendMode::kMul)) {
74	140k	JXL_QUIET_RETURN_IF_ERROR(visitor->Bool(false, &clamp));
75	140k	}
76		// 'old' frame for blending. Only necessary if this is not a full frame, or
77		// blending is not kReplace.
78	201k	if (visitor->Conditional(mode != BlendMode::kReplace \|\|
79	201k	nonserialized_is_partial_frame)) {
80	142k	JXL_QUIET_RETURN_IF_ERROR(
81	142k	visitor->U32(Val(0), Val(1), Val(2), Val(3), 0, &source));
82	142k	}
83	201k	return true;
84	201k	}
85
86		#if JXL_DEBUG_V_LEVEL >= 1
87		std::string BlendingInfo::DebugString() const {
88		std::ostringstream os;
89		os << (mode == BlendMode::kReplace ? "Replace"
90		: mode == BlendMode::kAdd ? "Add"
91		: mode == BlendMode::kBlend ? "Blend"
92		: mode == BlendMode::kAlphaWeightedAdd ? "AlphaWeightedAdd"
93		: "Mul");
94		if (nonserialized_num_extra_channels > 0 &&
95		(mode == BlendMode::kBlend \|\| mode == BlendMode::kAlphaWeightedAdd)) {
96		os << ",alpha=" << alpha_channel << ",clamp=" << clamp;
97		} else if (mode == BlendMode::kMul) {
98		os << ",clamp=" << clamp;
99		}
100		if (mode != BlendMode::kReplace \|\| nonserialized_is_partial_frame) {
101		os << ",source=" << source;
102		}
103		return os.str();
104		}
105		#endif
106
107		AnimationFrame::AnimationFrame(const CodecMetadata* metadata)
108	131k	: nonserialized_metadata(metadata) {
109	131k	Bundle::Init(this);
110	131k	}
111	182k	Status AnimationFrame::VisitFields(Visitor* JXL_RESTRICT visitor) {
112	182k	if (visitor->Conditional(nonserialized_metadata != nullptr &&
113	182k	nonserialized_metadata->m.have_animation)) {
114	182k	JXL_QUIET_RETURN_IF_ERROR(
115	182k	visitor->U32(Val(0), Val(1), Bits(8), Bits(32), 0, &duration));
116	182k	}
117
118	182k	if (visitor->Conditional(
119	182k	nonserialized_metadata != nullptr &&
120	182k	nonserialized_metadata->m.animation.have_timecodes)) {
121	132k	JXL_QUIET_RETURN_IF_ERROR(visitor->Bits(32, 0, &timecode));
122	132k	}
123	182k	return true;
124	182k	}
125
126	166k	YCbCrChromaSubsampling::YCbCrChromaSubsampling() { Bundle::Init(this); }
127	131k	Passes::Passes() { Bundle::Init(this); }
128	195k	Status Passes::VisitFields(Visitor* JXL_RESTRICT visitor) {
129	195k	JXL_QUIET_RETURN_IF_ERROR(
130	195k	visitor->U32(Val(1), Val(2), Val(3), BitsOffset(3, 4), 1, &num_passes));
131	195k	JXL_ENSURE(num_passes <= kMaxNumPasses); // Cannot happen when reading
132
133	195k	if (visitor->Conditional(num_passes != 1)) {
134	133k	JXL_QUIET_RETURN_IF_ERROR(visitor->U32(
135	133k	Val(0), Val(1), Val(2), BitsOffset(1, 3), 0, &num_downsample));
136	133k	JXL_ENSURE(num_downsample <= 4); // 1,2,4,8
137	133k	if (num_downsample > num_passes) {
138	0	return JXL_FAILURE("num_downsample %u > num_passes %u", num_downsample,
139	0	num_passes);
140	0	}
141
142	136k	for (uint32_t i = 0; i < num_passes - 1; i++) {
143	2.33k	JXL_QUIET_RETURN_IF_ERROR(visitor->Bits(2, 0, &shift[i]));
144	2.33k	}
145	133k	shift[num_passes - 1] = 0;
146
147	134k	for (uint32_t i = 0; i < num_downsample; ++i) {
148	1.13k	JXL_QUIET_RETURN_IF_ERROR(
149	1.13k	visitor->U32(Val(1), Val(2), Val(4), Val(8), 1, &downsample[i]));
150	1.13k	if (i > 0 && downsample[i] >= downsample[i - 1]) {
151	0	return JXL_FAILURE("downsample sequence should be decreasing");
152	0	}
153	1.13k	}
154	134k	for (uint32_t i = 0; i < num_downsample; ++i) {
155	1.13k	JXL_QUIET_RETURN_IF_ERROR(
156	1.13k	visitor->U32(Val(0), Val(1), Val(2), Bits(3), 0, &last_pass[i]));
157	1.13k	if (i > 0 && last_pass[i] <= last_pass[i - 1]) {
158	0	return JXL_FAILURE("last_pass sequence should be increasing");
159	0	}
160	1.13k	if (last_pass[i] >= num_passes) {
161	0	return JXL_FAILURE("last_pass %u >= num_passes %u", last_pass[i],
162	0	num_passes);
163	0	}
164	1.13k	}
165	133k	}
166
167	195k	return true;
168	195k	}
169
170		#if JXL_DEBUG_V_LEVEL >= 1
171		std::string Passes::DebugString() const {
172		std::ostringstream os;
173		os << "p=" << num_passes;
174		if (num_downsample) {
175		os << ",ds=";
176		for (uint32_t i = 0; i < num_downsample; ++i) {
177		os << last_pass[i] << ":" << downsample[i];
178		if (i + 1 < num_downsample) os << ";";
179		}
180		}
181		bool have_shifts = false;
182		for (uint32_t i = 0; i < num_passes; ++i) {
183		if (shift[i]) have_shifts = true;
184		}
185		if (have_shifts) {
186		os << ",shifts=";
187		for (uint32_t i = 0; i < num_passes; ++i) {
188		os << shift[i];
189		if (i + 1 < num_passes) os << ";";
190		}
191		}
192		return os.str();
193		}
194		#endif
195
196		FrameHeader::FrameHeader(const CodecMetadata* metadata)
197	131k	: animation_frame(metadata), nonserialized_metadata(metadata) {
198	131k	Bundle::Init(this);
199	131k	}
200
201		Status ReadFrameHeader(BitReader* JXL_RESTRICT reader,
202	64.4k	FrameHeader* JXL_RESTRICT frame) {
203	64.4k	return Bundle::Read(reader, frame);
204	64.4k	}
205
206	196k	Status FrameHeader::VisitFields(Visitor* JXL_RESTRICT visitor) {
207	196k	if (visitor->AllDefault(*this, &all_default)) {
208		// Overwrite all serialized fields, but not any nonserialized_*.
209	954	visitor->SetDefault(this);
210	954	return true;
211	954	}
212
213	196k	JXL_QUIET_RETURN_IF_ERROR(
214	196k	VisitFrameType(visitor, FrameType::kRegularFrame, &frame_type));
215	196k	if (visitor->IsReading() && nonserialized_is_preview &&
216	196k	frame_type != kRegularFrame) {
217	0	return JXL_FAILURE("Only regular frame could be a preview");
218	0	}
219
220		// FrameEncoding.
221	196k	bool is_modular = (encoding == FrameEncoding::kModular);
222	196k	JXL_QUIET_RETURN_IF_ERROR(visitor->Bool(false, &is_modular));
223	196k	encoding = (is_modular ? FrameEncoding::kModular : FrameEncoding::kVarDCT);
224
225		// Flags
226	196k	JXL_QUIET_RETURN_IF_ERROR(visitor->U64(0, &flags));
227
228		// Color transform
229	196k	bool xyb_encoded = nonserialized_metadata == nullptr \|\|
230	196k	nonserialized_metadata->m.xyb_encoded;
231
232	196k	if (xyb_encoded) {
233	10.9k	color_transform = ColorTransform::kXYB;
234	185k	} else {
235		// Alternate if kYCbCr.
236	185k	bool alternate = color_transform == ColorTransform::kYCbCr;
237	185k	JXL_QUIET_RETURN_IF_ERROR(visitor->Bool(false, &alternate));
238	185k	color_transform =
239	185k	(alternate ? ColorTransform::kYCbCr : ColorTransform::kNone);
240	185k	}
241
242		// Chroma subsampling for YCbCr, if no DC frame is used.
243	196k	if (visitor->Conditional(color_transform == ColorTransform::kYCbCr &&
244	196k	((flags & kUseDcFrame) == 0))) {
245	134k	JXL_QUIET_RETURN_IF_ERROR(visitor->VisitNested(&chroma_subsampling));
246	134k	}
247
248	196k	size_t num_extra_channels =
249	196k	nonserialized_metadata != nullptr
250	196k	? nonserialized_metadata->m.extra_channel_info.size()
251	196k	: 0;
252
253		// Upsampling
254	196k	if (visitor->Conditional((flags & kUseDcFrame) == 0)) {
255	196k	JXL_QUIET_RETURN_IF_ERROR(
256	196k	visitor->U32(Val(1), Val(2), Val(4), Val(8), 1, &upsampling));
257	195k	if (nonserialized_metadata != nullptr &&
258	195k	visitor->Conditional(num_extra_channels != 0)) {
259	133k	const std::vector<ExtraChannelInfo>& extra_channels =
260	133k	nonserialized_metadata->m.extra_channel_info;
261	133k	extra_channel_upsampling.resize(extra_channels.size(), 1);
262	142k	for (size_t i = 0; i < extra_channels.size(); ++i) {
263	8.53k	uint32_t dim_shift =
264	8.53k	nonserialized_metadata->m.extra_channel_info[i].dim_shift;
265	8.53k	uint32_t& ec_upsampling = extra_channel_upsampling[i];
266	8.53k	ec_upsampling >>= dim_shift;
267	8.53k	JXL_QUIET_RETURN_IF_ERROR(
268	8.53k	visitor->U32(Val(1), Val(2), Val(4), Val(8), 1, &ec_upsampling));
269	8.53k	ec_upsampling <<= dim_shift;
270	8.53k	if (ec_upsampling < upsampling) {
271	0	return JXL_FAILURE(
272	0	"EC upsampling (%u) < color upsampling (%u), which is invalid.",
273	0	ec_upsampling, upsampling);
274	0	}
275	8.53k	if (ec_upsampling > 8) {
276	0	return JXL_FAILURE("EC upsampling too large (%u)", ec_upsampling);
277	0	}
278	8.53k	}
279	133k	} else {
280	62.2k	extra_channel_upsampling.clear();
281	62.2k	}
282	195k	}
283
284		// Modular- or VarDCT-specific data.
285	195k	if (visitor->Conditional(encoding == FrameEncoding::kModular)) {
286	139k	JXL_QUIET_RETURN_IF_ERROR(visitor->Bits(2, 1, &group_size_shift));
287	139k	}
288	195k	if (visitor->Conditional(encoding == FrameEncoding::kVarDCT &&
289	195k	color_transform == ColorTransform::kXYB)) {
290	132k	JXL_QUIET_RETURN_IF_ERROR(visitor->Bits(3, 3, &x_qm_scale));
291	132k	JXL_QUIET_RETURN_IF_ERROR(visitor->Bits(3, 2, &b_qm_scale));
292	132k	} else {
293	63.3k	x_qm_scale = b_qm_scale = 2; // noop
294	63.3k	}
295
296		// Not useful for kPatchSource
297	195k	if (visitor->Conditional(frame_type != FrameType::kReferenceOnly)) {
298	195k	JXL_QUIET_RETURN_IF_ERROR(visitor->VisitNested(&passes));
299	195k	}
300
301	195k	if (visitor->Conditional(frame_type == FrameType::kDCFrame)) {
302		// Up to 4 pyramid levels - for up to 16384x downsampling.
303	135k	JXL_QUIET_RETURN_IF_ERROR(
304	135k	visitor->U32(Val(1), Val(2), Val(3), Val(4), 1, &dc_level));
305	135k	}
306	195k	if (frame_type != FrameType::kDCFrame) {
307	193k	dc_level = 0;
308	193k	}
309
310	195k	bool is_partial_frame = false;
311	195k	if (visitor->Conditional(frame_type != FrameType::kDCFrame)) {
312	193k	JXL_QUIET_RETURN_IF_ERROR(visitor->Bool(false, &custom_size_or_origin));
313	193k	if (visitor->Conditional(custom_size_or_origin)) {
314	133k	const U32Enc enc(Bits(8), BitsOffset(11, 256), BitsOffset(14, 2304),
315	133k	BitsOffset(30, 18688));
316		// Frame offset, only if kRegularFrame or kSkipProgressive.
317	133k	if (visitor->Conditional(frame_type == FrameType::kRegularFrame \|\|
318	133k	frame_type == FrameType::kSkipProgressive)) {
319	132k	uint32_t ux0 = PackSigned(frame_origin.x0);
320	132k	uint32_t uy0 = PackSigned(frame_origin.y0);
321	132k	JXL_QUIET_RETURN_IF_ERROR(visitor->U32(enc, 0, &ux0));
322	132k	JXL_QUIET_RETURN_IF_ERROR(visitor->U32(enc, 0, &uy0));
323	132k	frame_origin.x0 = UnpackSigned(ux0);
324	132k	frame_origin.y0 = UnpackSigned(uy0);
325	132k	}
326		// Frame size
327	133k	JXL_QUIET_RETURN_IF_ERROR(visitor->U32(enc, 0, &frame_size.xsize));
328	133k	JXL_QUIET_RETURN_IF_ERROR(visitor->U32(enc, 0, &frame_size.ysize));
329	133k	if (custom_size_or_origin &&
330	133k	(frame_size.xsize == 0 \|\| frame_size.ysize == 0)) {
331	2	return JXL_FAILURE(
332	2	"Invalid crop dimensions for frame: zero width or height");
333	2	}
334	133k	int32_t image_xsize = default_xsize();
335	133k	int32_t image_ysize = default_ysize();
336	133k	if (frame_type == FrameType::kRegularFrame \|\|
337	133k	frame_type == FrameType::kSkipProgressive) {
338	132k	is_partial_frame \|= frame_origin.x0 > 0;
339	132k	is_partial_frame \|= frame_origin.y0 > 0;
340	132k	is_partial_frame \|= (static_cast<int32_t>(frame_size.xsize) +
341	132k	frame_origin.x0) < image_xsize;
342	132k	is_partial_frame \|= (static_cast<int32_t>(frame_size.ysize) +
343	132k	frame_origin.y0) < image_ysize;
344	132k	}
345	133k	}
346	193k	}
347
348		// Blending info, animation info and whether this is the last frame or not.
349	195k	if (visitor->Conditional(frame_type == FrameType::kRegularFrame \|\|
350	195k	frame_type == FrameType::kSkipProgressive)) {
351	192k	blending_info.nonserialized_num_extra_channels = num_extra_channels;
352	192k	blending_info.nonserialized_is_partial_frame = is_partial_frame;
353	192k	JXL_QUIET_RETURN_IF_ERROR(visitor->VisitNested(&blending_info));
354	192k	bool replace_all = (blending_info.mode == BlendMode::kReplace);
355	192k	extra_channel_blending_info.resize(num_extra_channels);
356	199k	for (size_t i = 0; i < num_extra_channels; i++) {
357	7.22k	auto& ec_blending_info = extra_channel_blending_info[i];
358	7.22k	ec_blending_info.nonserialized_is_partial_frame = is_partial_frame;
359	7.22k	ec_blending_info.nonserialized_num_extra_channels = num_extra_channels;
360	7.22k	JXL_QUIET_RETURN_IF_ERROR(visitor->VisitNested(&ec_blending_info));
361	7.22k	replace_all &= (ec_blending_info.mode == BlendMode::kReplace);
362	7.22k	}
363	192k	if (visitor->IsReading() && nonserialized_is_preview) {
364	37	if (!replace_all \|\| custom_size_or_origin) {
365	0	return JXL_FAILURE("Preview is not compatible with blending");
366	0	}
367	37	}
368	192k	if (visitor->Conditional(nonserialized_metadata != nullptr &&
369	192k	nonserialized_metadata->m.have_animation)) {
370	182k	animation_frame.nonserialized_metadata = nonserialized_metadata;
371	182k	JXL_QUIET_RETURN_IF_ERROR(visitor->VisitNested(&animation_frame));
372	182k	}
373	192k	JXL_QUIET_RETURN_IF_ERROR(visitor->Bool(true, &is_last));
374	192k	} else {
375	3.30k	is_last = false;
376	3.30k	}
377
378		// ID of that can be used to refer to this frame. 0 for a non-zero-duration
379		// frame means that it will not be referenced. Not necessary for the last
380		// frame.
381	195k	if (visitor->Conditional(frame_type != kDCFrame && !is_last)) {
382	192k	JXL_QUIET_RETURN_IF_ERROR(
383	192k	visitor->U32(Val(0), Val(1), Val(2), Val(3), 0, &save_as_reference));
384	192k	}
385
386		// If this frame is not blended on another frame post-color-transform, it may
387		// be stored for being referenced either before or after the color transform.
388		// If it is blended post-color-transform, it must be blended after. It must
389		// also be blended after if this is a kRegular frame that does not cover the
390		// full frame, as samples outside the partial region are from a
391		// post-color-transform frame.
392	195k	if (frame_type != FrameType::kDCFrame) {
393	193k	if (visitor->Conditional(CanBeReferenced() &&
394	193k	blending_info.mode == BlendMode::kReplace &&
395	193k	!is_partial_frame &&
396	193k	(frame_type == FrameType::kRegularFrame \|\|
397	189k	frame_type == FrameType::kSkipProgressive))) {
398	189k	JXL_QUIET_RETURN_IF_ERROR(
399	189k	visitor->Bool(false, &save_before_color_transform));
400	189k	} else if (visitor->Conditional(frame_type == FrameType::kReferenceOnly)) {
401	582	JXL_QUIET_RETURN_IF_ERROR(
402	582	visitor->Bool(true, &save_before_color_transform));
403	582	size_t xsize = custom_size_or_origin ? frame_size.xsize
404	582	: nonserialized_metadata->xsize();
405	582	size_t ysize = custom_size_or_origin ? frame_size.ysize
406	582	: nonserialized_metadata->ysize();
407	582	if (!save_before_color_transform &&
408	582	(xsize < nonserialized_metadata->xsize() \|\|
409	7	ysize < nonserialized_metadata->ysize() \|\| frame_origin.x0 != 0 \|\|
410	7	frame_origin.y0 != 0)) {
411	0	return JXL_FAILURE(
412	0	"non-patch reference frame with invalid crop: %" PRIuS "x%" PRIuS
413	0	"%+d%+d",
414	0	xsize, ysize, static_cast<int>(frame_origin.x0),
415	0	static_cast<int>(frame_origin.y0));
416	0	}
417	582	}
418	193k	} else {
419	2.72k	save_before_color_transform = true;
420	2.72k	}
421
422	195k	JXL_QUIET_RETURN_IF_ERROR(VisitNameString(visitor, &name));
423
424	195k	loop_filter.nonserialized_is_modular = is_modular;
425	195k	JXL_RETURN_IF_ERROR(visitor->VisitNested(&loop_filter));
426
427	194k	JXL_QUIET_RETURN_IF_ERROR(visitor->BeginExtensions(&extensions));
428		// Extensions: in chronological order of being added to the format.
429	194k	return visitor->EndExtensions();
430	194k	}
431
432		#if JXL_DEBUG_V_LEVEL >= 1
433		std::string FrameHeader::DebugString() const {
434		std::ostringstream os;
435		os << (encoding == FrameEncoding::kVarDCT ? "VarDCT" : "Modular");
436		os << ",";
437		os << (frame_type == FrameType::kRegularFrame ? "Regular"
438		: frame_type == FrameType::kDCFrame ? "DC"
439		: frame_type == FrameType::kReferenceOnly ? "Reference"
440		: "SkipProgressive");
441		if (frame_type == FrameType::kDCFrame) {
442		os << "(lv" << dc_level << ")";
443		}
444
445		if (flags) {
446		os << ",";
447		uint32_t remaining = flags;
448
449		#define TEST_FLAG(name) \
450		if (flags & Flags::k##name) { \
451		remaining &= ~Flags::k##name; \
452		os << #name; \
453		if (remaining) os << "\|"; \
454		}
455		TEST_FLAG(Noise);
456		TEST_FLAG(Patches);
457		TEST_FLAG(Splines);
458		TEST_FLAG(UseDcFrame);
459		TEST_FLAG(SkipAdaptiveDCSmoothing);
460		#undef TEST_FLAG
461		}
462
463		os << ",";
464		os << (color_transform == ColorTransform::kXYB ? "XYB"
465		: color_transform == ColorTransform::kYCbCr ? "YCbCr"
466		: "None");
467
468		if (encoding == FrameEncoding::kModular) {
469		os << ",shift=" << group_size_shift;
470		} else if (color_transform == ColorTransform::kXYB) {
471		os << ",qm=" << x_qm_scale << ";" << b_qm_scale;
472		}
473		if (frame_type != FrameType::kReferenceOnly) {
474		os << "," << passes.DebugString();
475		}
476		if (custom_size_or_origin) {
477		os << ",xs=" << frame_size.xsize;
478		os << ",ys=" << frame_size.ysize;
479		if (frame_type == FrameType::kRegularFrame \|\|
480		frame_type == FrameType::kSkipProgressive) {
481		os << ",x0=" << frame_origin.x0;
482		os << ",y0=" << frame_origin.y0;
483		}
484		}
485		if (upsampling > 1) os << ",up=" << upsampling;
486		if (loop_filter.gab) os << ",Gaborish";
487		if (loop_filter.epf_iters > 0) os << ",epf=" << loop_filter.epf_iters;
488		if (animation_frame.duration > 0) os << ",dur=" << animation_frame.duration;
489		if (frame_type == FrameType::kRegularFrame \|\|
490		frame_type == FrameType::kSkipProgressive) {
491		os << ",";
492		os << blending_info.DebugString();
493		for (size_t i = 0; i < extra_channel_blending_info.size(); ++i) {
494		os << (i == 0 ? "[" : ";");
495		os << extra_channel_blending_info[i].DebugString();
496		if (i + 1 == extra_channel_blending_info.size()) os << "]";
497		}
498		}
499		if (save_as_reference > 0) os << ",ref=" << save_as_reference;
500		os << "," << (save_before_color_transform ? "before" : "after") << "_ct";
501		if (is_last) os << ",last";
502		return os.str();
503		}
504		#endif
505
506		} // namespace jxl