1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
// 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.
#ifndef LIB_JXL_ENC_FRAME_H_
#define LIB_JXL_ENC_FRAME_H_
#include "lib/jxl/base/data_parallel.h"
#include "lib/jxl/base/status.h"
#include "lib/jxl/enc_bit_writer.h"
#include "lib/jxl/enc_cache.h"
#include "lib/jxl/enc_params.h"
#include "lib/jxl/frame_header.h"
#include "lib/jxl/image_bundle.h"
namespace jxl {
struct AuxOut;
// Information needed for encoding a frame that is not contained elsewhere and
// does not belong to `cparams`.
// TODO(lode): if possible, it might be better to replace FrameInfo and several
// fields from ImageBundle (such as frame name and duration) by direct usage of
// jxl::FrameHeader itself.
struct FrameInfo {
// TODO(veluca): consider adding more parameters, such as custom patches.
bool save_before_color_transform = false;
// Whether or not the input image bundle is already in the codestream
// colorspace (as deduced by cparams).
// TODO(veluca): this is a hack - ImageBundle doesn't have a simple way to say
// "this is already in XYB".
bool ib_needs_color_transform = true;
FrameType frame_type = FrameType::kRegularFrame;
size_t dc_level = 0;
// Only used for kRegularFrame.
bool is_last = true;
bool is_preview = false;
// Information for storing this frame for future use (only for non-DC frames).
size_t save_as_reference = 0;
// The source frame for blending of a next frame, matching the
// save_as_reference value of a previous frame. Animated frames can use
// save_as_reference values 1, 2 and 3, while composite still frames can use
// save_as_reference values 0, 1, 2 and 3. The current C++ encoder
// implementation is assuming and using 1 for all frames of animations, so
// using that as the default value here.
// Corresponds to BlendingInfo::source from the FrameHeader.
size_t source = 1;
// Corresponds to BlendingInfo::clamp from the FrameHeader.
size_t clamp = 1;
// Corresponds to BlendingInfo::alpha_channel from the FrameHeader, or set to
// -1 to automatically choose it as the index of the first extra channel of
// type alpha.
int alpha_channel = -1;
// If non-empty, uses this blending info for the extra channels, otherwise
// automatically chooses it. The encoder API will fill this vector with the
// extra channel info and allows more options. The non-API cjxl leaves it
// empty and relies on the default behavior.
std::vector<BlendingInfo> extra_channel_blending_info;
};
// Checks and adjusts CompressParams when they are all initialized.
Status ParamsPostInit(CompressParams* p);
// Encodes a single frame (including its header) into a byte stream. Groups may
// be processed in parallel by `pool`. metadata is the ImageMetadata encoded in
// the codestream, and must be used for the FrameHeaders, do not use
// ib.metadata.
Status EncodeFrame(const CompressParams& cparams_orig,
const FrameInfo& frame_info, const CodecMetadata* metadata,
const ImageBundle& ib, PassesEncoderState* passes_enc_state,
const JxlCmsInterface& cms, ThreadPool* pool,
BitWriter* writer, AuxOut* aux_out);
} // namespace jxl
#endif // LIB_JXL_ENC_FRAME_H_
|
