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 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
|
/*
* JPEG XL encoding support via libjxl
* Copyright (c) 2021 Leo Izen <leo.izen@gmail.com>
*
* This file is part of FFmpeg.
*
* FFmpeg is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* FFmpeg is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with FFmpeg; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* @file
* JPEG XL encoder using libjxl
*/
#include <string.h>
#include "libavutil/avutil.h"
#include "libavutil/csp.h"
#include "libavutil/display.h"
#include "libavutil/error.h"
#include "libavutil/frame.h"
#include "libavutil/libm.h"
#include "libavutil/mem.h"
#include "libavutil/opt.h"
#include "libavutil/pixdesc.h"
#include "libavutil/pixfmt.h"
#include "libavutil/version.h"
#include "avcodec.h"
#include "encode.h"
#include "codec_internal.h"
#include "exif_internal.h"
#include <jxl/encode.h>
#include <jxl/thread_parallel_runner.h>
#include "libjxl.h"
typedef struct LibJxlEncodeContext {
AVClass *class;
void *runner;
JxlEncoder *encoder;
JxlEncoderFrameSettings *options;
int effort;
float distance;
int modular;
int xyb;
uint8_t *buffer;
size_t buffer_size;
JxlPixelFormat jxl_fmt;
AVBufferRef *exif_buffer;
/* animation stuff */
AVFrame *frame;
AVFrame *prev;
int64_t duration;
} LibJxlEncodeContext;
/**
* Map a quality setting for -qscale roughly from libjpeg
* quality numbers to libjxl's butteraugli distance for
* photographic content.
*
* Setting distance explicitly is preferred, but this will
* allow qscale to be used as a fallback.
*
* This function is continuous and injective on [0, 100] which
* makes it monotonic.
*
* @param quality 0.0 to 100.0 quality setting, libjpeg quality
* @return Butteraugli distance between 0.0 and 15.0
*/
static float quality_to_distance(float quality)
{
if (quality >= 100.0)
return 0.0;
else if (quality >= 90.0)
return (100.0 - quality) * 0.10;
else if (quality >= 30.0)
return 0.1 + (100.0 - quality) * 0.09;
else if (quality > 0.0)
return 15.0 + (59.0 * quality - 4350.0) * quality / 9000.0;
else
return 15.0;
}
/**
* Initialize the encoder on a per-file basis. All of these need to be set
* once each time the encoder is reset, which is each frame for still
* images, to make the image2 muxer work. For animation this is run once.
*
* @return 0 upon success, negative on failure.
*/
static int libjxl_init_jxl_encoder(AVCodecContext *avctx)
{
LibJxlEncodeContext *ctx = avctx->priv_data;
/* reset the encoder every frame for image2 muxer */
JxlEncoderReset(ctx->encoder);
/* This needs to be set each time the encoder is reset */
if (JxlEncoderSetParallelRunner(ctx->encoder, JxlThreadParallelRunner, ctx->runner)
!= JXL_ENC_SUCCESS) {
av_log(avctx, AV_LOG_ERROR, "Failed to set JxlThreadParallelRunner\n");
return AVERROR_EXTERNAL;
}
ctx->options = JxlEncoderFrameSettingsCreate(ctx->encoder, NULL);
if (!ctx->options) {
av_log(avctx, AV_LOG_ERROR, "Failed to create JxlEncoderOptions\n");
return AVERROR_EXTERNAL;
}
return 0;
}
/**
* Global encoder initialization. This only needs to be run once,
* not every frame.
*/
static av_cold int libjxl_encode_init(AVCodecContext *avctx)
{
LibJxlEncodeContext *ctx = avctx->priv_data;
JxlMemoryManager manager;
ff_libjxl_init_memory_manager(&manager);
ctx->encoder = JxlEncoderCreate(&manager);
if (!ctx->encoder) {
av_log(avctx, AV_LOG_ERROR, "Failed to create JxlEncoder\n");
return AVERROR_EXTERNAL;
}
ctx->runner = JxlThreadParallelRunnerCreate(&manager, ff_libjxl_get_threadcount(avctx->thread_count));
if (!ctx->runner) {
av_log(avctx, AV_LOG_ERROR, "Failed to create JxlThreadParallelRunner\n");
return AVERROR_EXTERNAL;
}
ctx->buffer_size = 4096;
ctx->buffer = av_realloc(NULL, ctx->buffer_size);
if (!ctx->buffer) {
av_log(avctx, AV_LOG_ERROR, "Could not allocate encoding buffer\n");
return AVERROR(ENOMEM);
}
/* check for negative, our default */
if (ctx->distance < 0.0) {
/* use ffmpeg.c -q option if passed */
if (avctx->flags & AV_CODEC_FLAG_QSCALE)
ctx->distance = quality_to_distance((float)avctx->global_quality / FF_QP2LAMBDA);
else
/* default 1.0 matches cjxl */
ctx->distance = 1.0;
}
/*
* 0.01 is the minimum distance accepted for lossy
* interpreting any positive value less than this as minimum
*/
if (ctx->distance > 0.0 && ctx->distance < 0.01)
ctx->distance = 0.01;
return 0;
}
/**
* Initializer for the animation encoder. This calls the other initializers
* to prevent code duplication and also allocates the prev-frame used in the
* encoder.
*/
static av_cold int libjxl_anim_encode_init(AVCodecContext *avctx)
{
int ret;
LibJxlEncodeContext *ctx = avctx->priv_data;
ret = libjxl_encode_init(avctx);
if (ret < 0)
return ret;
ret = libjxl_init_jxl_encoder(avctx);
if (ret < 0)
return ret;
ctx->frame = av_frame_alloc();
if (!ctx->frame)
return AVERROR(ENOMEM);
return 0;
}
/**
* Populate a JxlColorEncoding with the given enum AVColorPrimaries.
* @return < 0 upon failure, >= 0 upon success
*/
static int libjxl_populate_primaries(void *avctx, JxlColorEncoding *jxl_color, enum AVColorPrimaries prm)
{
const AVColorPrimariesDesc *desc;
switch (prm) {
case AVCOL_PRI_BT709:
jxl_color->primaries = JXL_PRIMARIES_SRGB;
jxl_color->white_point = JXL_WHITE_POINT_D65;
return 0;
case AVCOL_PRI_BT2020:
jxl_color->primaries = JXL_PRIMARIES_2100;
jxl_color->white_point = JXL_WHITE_POINT_D65;
return 0;
case AVCOL_PRI_SMPTE431:
jxl_color->primaries = JXL_PRIMARIES_P3;
jxl_color->white_point = JXL_WHITE_POINT_DCI;
return 0;
case AVCOL_PRI_SMPTE432:
jxl_color->primaries = JXL_PRIMARIES_P3;
jxl_color->white_point = JXL_WHITE_POINT_D65;
return 0;
case AVCOL_PRI_UNSPECIFIED:
av_log(avctx, AV_LOG_WARNING, "Unknown primaries, assuming BT.709/sRGB. Colors may be wrong.\n");
jxl_color->primaries = JXL_PRIMARIES_SRGB;
jxl_color->white_point = JXL_WHITE_POINT_D65;
return 0;
}
desc = av_csp_primaries_desc_from_id(prm);
if (!desc)
return AVERROR(EINVAL);
jxl_color->primaries = JXL_PRIMARIES_CUSTOM;
jxl_color->white_point = JXL_WHITE_POINT_CUSTOM;
jxl_color->primaries_red_xy[0] = av_q2d(desc->prim.r.x);
jxl_color->primaries_red_xy[1] = av_q2d(desc->prim.r.y);
jxl_color->primaries_green_xy[0] = av_q2d(desc->prim.g.x);
jxl_color->primaries_green_xy[1] = av_q2d(desc->prim.g.y);
jxl_color->primaries_blue_xy[0] = av_q2d(desc->prim.b.x);
jxl_color->primaries_blue_xy[1] = av_q2d(desc->prim.b.y);
jxl_color->white_point_xy[0] = av_q2d(desc->wp.x);
jxl_color->white_point_xy[1] = av_q2d(desc->wp.y);
return 0;
}
static int libjxl_populate_colorspace(AVCodecContext *avctx, const AVFrame *frame,
const AVPixFmtDescriptor *pix_desc, const JxlBasicInfo *info)
{
JxlColorEncoding jxl_color;
LibJxlEncodeContext *ctx = avctx->priv_data;
int ret;
switch (frame->color_trc && frame->color_trc != AVCOL_TRC_UNSPECIFIED
? frame->color_trc : avctx->color_trc) {
case AVCOL_TRC_BT709:
jxl_color.transfer_function = JXL_TRANSFER_FUNCTION_709;
break;
case AVCOL_TRC_LINEAR:
jxl_color.transfer_function = JXL_TRANSFER_FUNCTION_LINEAR;
break;
case AVCOL_TRC_IEC61966_2_1:
jxl_color.transfer_function = JXL_TRANSFER_FUNCTION_SRGB;
break;
case AVCOL_TRC_SMPTE428:
jxl_color.transfer_function = JXL_TRANSFER_FUNCTION_DCI;
break;
case AVCOL_TRC_SMPTE2084:
jxl_color.transfer_function = JXL_TRANSFER_FUNCTION_PQ;
break;
case AVCOL_TRC_ARIB_STD_B67:
jxl_color.transfer_function = JXL_TRANSFER_FUNCTION_HLG;
break;
case AVCOL_TRC_GAMMA22:
jxl_color.transfer_function = JXL_TRANSFER_FUNCTION_GAMMA;
jxl_color.gamma = 1/2.2f;
break;
case AVCOL_TRC_GAMMA28:
jxl_color.transfer_function = JXL_TRANSFER_FUNCTION_GAMMA;
jxl_color.gamma = 1/2.8f;
break;
default:
if (pix_desc->flags & AV_PIX_FMT_FLAG_FLOAT) {
av_log(avctx, AV_LOG_WARNING,
"Unknown transfer function, assuming Linear Light. Colors may be wrong.\n");
jxl_color.transfer_function = JXL_TRANSFER_FUNCTION_LINEAR;
} else {
av_log(avctx, AV_LOG_WARNING,
"Unknown transfer function, assuming IEC61966-2-1/sRGB. Colors may be wrong.\n");
jxl_color.transfer_function = JXL_TRANSFER_FUNCTION_SRGB;
}
}
jxl_color.rendering_intent = JXL_RENDERING_INTENT_RELATIVE;
if (info->num_color_channels == 1)
jxl_color.color_space = JXL_COLOR_SPACE_GRAY;
else
jxl_color.color_space = JXL_COLOR_SPACE_RGB;
ret = libjxl_populate_primaries(avctx, &jxl_color,
frame->color_primaries && frame->color_primaries != AVCOL_PRI_UNSPECIFIED
? frame->color_primaries : avctx->color_primaries);
if (ret < 0)
return ret;
if (JxlEncoderSetColorEncoding(ctx->encoder, &jxl_color) != JXL_ENC_SUCCESS) {
av_log(avctx, AV_LOG_WARNING, "Failed to set JxlColorEncoding\n");
return AVERROR_EXTERNAL;
}
return 0;
}
static int libjxl_add_boxes(AVCodecContext *avctx)
{
LibJxlEncodeContext *ctx = avctx->priv_data;
JxlEncoderStatus jret = JXL_ENC_SUCCESS;
int ret = 0, opened = 0;
/* no boxes need to be added */
if (!ctx->exif_buffer)
goto end;
jret = JxlEncoderUseBoxes(ctx->encoder);
if (jret != JXL_ENC_SUCCESS) {
av_log(avctx, AV_LOG_WARNING, "Could not enable UseBoxes\n");
ret = AVERROR_EXTERNAL;
goto end;
}
opened = 1;
jret = JxlEncoderAddBox(ctx->encoder, "Exif", ctx->exif_buffer->data, ctx->exif_buffer->size, JXL_TRUE);
if (jret != JXL_ENC_SUCCESS)
jret = JxlEncoderAddBox(ctx->encoder, "Exif", ctx->exif_buffer->data, ctx->exif_buffer->size, JXL_FALSE);
if (jret != JXL_ENC_SUCCESS) {
av_log(avctx, AV_LOG_WARNING, "Failed to add Exif box\n");
ret = AVERROR_EXTERNAL;
goto end;
}
end:
if (opened)
JxlEncoderCloseBoxes(ctx->encoder);
return ret;
}
/**
* Sends metadata to libjxl based on the first frame of the stream, such as pixel format,
* orientation, bit depth, and that sort of thing.
*/
static int libjxl_preprocess_stream(AVCodecContext *avctx, const AVFrame *frame, int animated)
{
LibJxlEncodeContext *ctx = avctx->priv_data;
AVFrameSideData *sd;
int32_t *matrix = (int32_t[9]){ 0 };
int ret = 0, have_matrix = 0;
JxlEncoderStatus jret = JXL_ENC_SUCCESS;
const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(frame->format);
JxlBasicInfo info;
JxlPixelFormat *jxl_fmt = &ctx->jxl_fmt;
int bits_per_sample;
int orientation;
#if JPEGXL_NUMERIC_VERSION >= JPEGXL_COMPUTE_NUMERIC_VERSION(0, 8, 0)
JxlBitDepth jxl_bit_depth;
#endif
/* populate the basic info settings */
JxlEncoderInitBasicInfo(&info);
jxl_fmt->num_channels = pix_desc->nb_components;
info.xsize = frame->width;
info.ysize = frame->height;
info.num_extra_channels = (jxl_fmt->num_channels + 1) & 0x1;
info.num_color_channels = jxl_fmt->num_channels - info.num_extra_channels;
bits_per_sample = av_get_bits_per_pixel(pix_desc) / jxl_fmt->num_channels;
info.bits_per_sample = avctx->bits_per_raw_sample > 0 && !(pix_desc->flags & AV_PIX_FMT_FLAG_FLOAT)
? avctx->bits_per_raw_sample : bits_per_sample;
info.alpha_bits = (info.num_extra_channels > 0) * info.bits_per_sample;
if (pix_desc->flags & AV_PIX_FMT_FLAG_FLOAT) {
info.exponent_bits_per_sample = info.bits_per_sample > 16 ? 8 : 5;
info.alpha_exponent_bits = info.alpha_bits ? info.exponent_bits_per_sample : 0;
jxl_fmt->data_type = info.bits_per_sample > 16 ? JXL_TYPE_FLOAT : JXL_TYPE_FLOAT16;
} else {
info.exponent_bits_per_sample = 0;
info.alpha_exponent_bits = 0;
jxl_fmt->data_type = info.bits_per_sample <= 8 ? JXL_TYPE_UINT8 : JXL_TYPE_UINT16;
}
if (info.alpha_bits) {
if (avctx->alpha_mode == AVALPHA_MODE_PREMULTIPLIED ||
avctx->alpha_mode == AVALPHA_MODE_UNSPECIFIED && frame->alpha_mode == AVALPHA_MODE_PREMULTIPLIED) {
info.alpha_premultiplied = 1;
} else if (avctx->alpha_mode != AVALPHA_MODE_STRAIGHT && frame->alpha_mode != AVALPHA_MODE_STRAIGHT) {
av_log(avctx, AV_LOG_WARNING, "Unknown alpha mode, assuming straight (independent)\n");
}
}
#if JPEGXL_NUMERIC_VERSION >= JPEGXL_COMPUTE_NUMERIC_VERSION(0, 8, 0)
jxl_bit_depth.bits_per_sample = bits_per_sample;
jxl_bit_depth.type = JXL_BIT_DEPTH_FROM_PIXEL_FORMAT;
jxl_bit_depth.exponent_bits_per_sample = pix_desc->flags & AV_PIX_FMT_FLAG_FLOAT ?
info.exponent_bits_per_sample : 0;
#endif
/* JPEG XL format itself does not support limited range */
if (avctx->color_range == AVCOL_RANGE_MPEG ||
avctx->color_range == AVCOL_RANGE_UNSPECIFIED && frame->color_range == AVCOL_RANGE_MPEG)
av_log(avctx, AV_LOG_WARNING, "This encoder does not support limited (tv) range, colors will be wrong!\n");
else if (avctx->color_range != AVCOL_RANGE_JPEG && frame->color_range != AVCOL_RANGE_JPEG)
av_log(avctx, AV_LOG_WARNING, "Unknown color range, assuming full (pc)\n");
/* bitexact lossless requires there to be no XYB transform */
info.uses_original_profile = ctx->distance == 0.0 || !ctx->xyb;
sd = av_frame_get_side_data(frame, AV_FRAME_DATA_DISPLAYMATRIX);
if (sd) {
matrix = (int32_t *) sd->data;
have_matrix = 1;
}
sd = av_frame_get_side_data(frame, AV_FRAME_DATA_EXIF);
if (sd) {
AVExifMetadata ifd = { 0 };
AVExifEntry *orient = NULL;
uint16_t tag = av_exif_get_tag_id("Orientation");
ret = av_exif_parse_buffer(avctx, sd->data, sd->size, &ifd, AV_EXIF_TIFF_HEADER);
if (ret >= 0)
ret = ff_exif_sanitize_ifd(avctx, frame, &ifd);
if (ret >= 0)
ret = av_exif_get_entry(avctx, &ifd, tag, 0, &orient);
if (ret >= 0 && orient) {
if (!have_matrix && orient->value.uint[0] >= 1 && orient->value.uint[0] <= 8) {
av_exif_orientation_to_matrix(matrix, orient->value.uint[0]);
have_matrix = 1;
}
/* pop the orientation tag anyway, because it only creates */
/* ambiguity with the codestream orientation taking precdence */
ret = av_exif_remove_entry(avctx, &ifd, tag, 0);
}
if (ret >= 0)
ret = av_exif_write(avctx, &ifd, &ctx->exif_buffer, AV_EXIF_T_OFF);
if (ret < 0)
av_log(avctx, AV_LOG_WARNING, "unable to process EXIF frame data\n");
av_exif_free(&ifd);
}
/* use identity matrix as default */
if (!have_matrix)
av_exif_orientation_to_matrix(matrix, 1);
/* av_display_matrix_flip is a right-multipilcation */
/* i.e. flip is applied before the previous matrix */
if (frame->linesize < 0)
av_display_matrix_flip(matrix, 0, 1);
orientation = av_exif_matrix_to_orientation(matrix);
/* JPEG XL orientation flag agrees with EXIF for values 1-8 */
if (orientation) {
info.orientation = orientation;
} else {
av_log(avctx, AV_LOG_WARNING, "singular displaymatrix data\n");
info.orientation = frame->linesize[0] >= 0 ? JXL_ORIENT_IDENTITY : JXL_ORIENT_FLIP_VERTICAL;
}
/* restore the previous value */
if (frame->linesize < 0)
av_display_matrix_flip(matrix, 0, 1);
if (animated) {
info.have_animation = 1;
info.animation.have_timecodes = 0;
info.animation.num_loops = 0;
/* avctx->timebase is in seconds per tick, so we take the reciprocol */
info.animation.tps_numerator = avctx->time_base.den;
info.animation.tps_denominator = avctx->time_base.num;
}
jret = JxlEncoderSetBasicInfo(ctx->encoder, &info);
if (jret != JXL_ENC_SUCCESS) {
av_log(avctx, AV_LOG_ERROR, "Failed to set JxlBasicInfo\n");
ret = AVERROR_EXTERNAL;
goto end;
}
if (info.alpha_bits) {
JxlExtraChannelInfo extra_info;
JxlEncoderInitExtraChannelInfo(JXL_CHANNEL_ALPHA, &extra_info);
extra_info.bits_per_sample = info.alpha_bits;
extra_info.exponent_bits_per_sample = info.alpha_exponent_bits;
extra_info.alpha_premultiplied = info.alpha_premultiplied;
jret = JxlEncoderSetExtraChannelInfo(ctx->encoder, 0, &extra_info);
if (jret != JXL_ENC_SUCCESS) {
av_log(avctx, AV_LOG_ERROR, "Failed to set JxlExtraChannelInfo for alpha!\n");
ret = AVERROR_EXTERNAL;
goto end;
}
}
sd = av_frame_get_side_data(frame, AV_FRAME_DATA_ICC_PROFILE);
if (sd && sd->size) {
jret = JxlEncoderSetICCProfile(ctx->encoder, sd->data, sd->size);
if (jret != JXL_ENC_SUCCESS)
av_log(avctx, AV_LOG_WARNING, "Could not set ICC Profile\n");
}
/* jret != JXL_ENC_SUCCESS means fallthrough from above */
if (!sd || !sd->size || jret != JXL_ENC_SUCCESS)
libjxl_populate_colorspace(avctx, frame, pix_desc, &info);
#if JPEGXL_NUMERIC_VERSION >= JPEGXL_COMPUTE_NUMERIC_VERSION(0, 8, 0)
jret = JxlEncoderSetFrameBitDepth(ctx->options, &jxl_bit_depth);
if (jret != JXL_ENC_SUCCESS)
av_log(avctx, AV_LOG_WARNING, "Failed to set JxlBitDepth\n");
#endif
/* depending on basic info, level 10 might
* be required instead of level 5 */
if (JxlEncoderGetRequiredCodestreamLevel(ctx->encoder) > 5) {
jret = JxlEncoderSetCodestreamLevel(ctx->encoder, 10);
if (jret != JXL_ENC_SUCCESS)
av_log(avctx, AV_LOG_WARNING, "Could not increase codestream level\n");
}
libjxl_add_boxes(avctx);
end:
av_buffer_unref(&ctx->exif_buffer);
return ret;
}
/**
* Sends frame information to libjxl on a per-frame basis. If this is a still image,
* this is evaluated once per output file. If this is an animated JPEG XL encode, it
* is called once per frame.
*
* This returns a buffer to the data that should be passed to libjxl (via the
* argument **data). If the linesize is nonnegative, this will be frame->data[0],
* although if the linesize is negative, it will be the start of the buffer
* instead. *data is just a pointer to a location in frame->data so it should not be
* freed directly.
*/
static int libjxl_preprocess_frame(AVCodecContext *avctx, const AVFrame *frame, const uint8_t **data)
{
LibJxlEncodeContext *ctx = avctx->priv_data;
JxlPixelFormat *jxl_fmt = &ctx->jxl_fmt;
/* these shouldn't fail, libjxl bug notwithstanding */
if (JxlEncoderFrameSettingsSetOption(ctx->options, JXL_ENC_FRAME_SETTING_EFFORT, ctx->effort)
!= JXL_ENC_SUCCESS) {
av_log(avctx, AV_LOG_ERROR, "Failed to set effort to: %d\n", ctx->effort);
return AVERROR_EXTERNAL;
}
if (JxlEncoderSetFrameDistance(ctx->options, ctx->distance) != JXL_ENC_SUCCESS) {
av_log(avctx, AV_LOG_ERROR, "Failed to set distance: %f\n", ctx->distance);
return AVERROR_EXTERNAL;
}
/*
* In theory the library should automatically enable modular if necessary,
* but it appears it won't at the moment due to a bug. This will still
* work even if that is patched.
*/
if (JxlEncoderFrameSettingsSetOption(ctx->options, JXL_ENC_FRAME_SETTING_MODULAR,
ctx->modular || ctx->distance <= 0.0 ? 1 : -1) != JXL_ENC_SUCCESS) {
av_log(avctx, AV_LOG_ERROR, "Failed to set modular\n");
return AVERROR_EXTERNAL;
}
jxl_fmt->endianness = JXL_NATIVE_ENDIAN;
if (frame->linesize[0] >= 0) {
jxl_fmt->align = frame->linesize[0];
*data = frame->data[0];
} else {
jxl_fmt->align = -frame->linesize[0];
*data = frame->data[0] + frame->linesize[0] * (frame->height - 1);
}
return 0;
}
/**
* Run libjxl's output processing loop, reallocating the packet as necessary
* if libjxl needs more space to work with.
*/
static int libjxl_process_output(AVCodecContext *avctx, size_t *bytes_written)
{
LibJxlEncodeContext *ctx = avctx->priv_data;
JxlEncoderStatus jret;
size_t available = ctx->buffer_size;
uint8_t *next_out = ctx->buffer;
while (1) {
jret = JxlEncoderProcessOutput(ctx->encoder, &next_out, &available);
if (jret == JXL_ENC_ERROR) {
av_log(avctx, AV_LOG_ERROR, "Unspecified libjxl error occurred\n");
return AVERROR_EXTERNAL;
}
*bytes_written = ctx->buffer_size - available;
/* all data passed has been encoded */
if (jret == JXL_ENC_SUCCESS)
break;
if (jret == JXL_ENC_NEED_MORE_OUTPUT) {
/*
* at the moment, libjxl has no way to
* tell us how much space it actually needs
* so we need to malloc loop
*/
uint8_t *temp;
size_t new_size = ctx->buffer_size * 2;
temp = av_realloc(ctx->buffer, new_size);
if (!temp)
return AVERROR(ENOMEM);
ctx->buffer = temp;
ctx->buffer_size = new_size;
next_out = ctx->buffer + *bytes_written;
available = new_size - *bytes_written;
continue;
}
av_log(avctx, AV_LOG_ERROR, "Bad libjxl event: %d\n", jret);
return AVERROR_EXTERNAL;
}
return 0;
}
/**
* Encode an entire frame. This will always reinitialize a new still image
* and encode a one-frame image (for image2 and image2pipe).
*/
static int libjxl_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet)
{
LibJxlEncodeContext *ctx = avctx->priv_data;
int ret;
size_t bytes_written = 0;
const uint8_t *data;
ret = libjxl_init_jxl_encoder(avctx);
if (ret < 0) {
av_log(avctx, AV_LOG_ERROR, "Error frame-initializing JxlEncoder\n");
return ret;
}
ret = libjxl_preprocess_stream(avctx, frame, 0);
if (ret < 0)
return ret;
ret = libjxl_preprocess_frame(avctx, frame, &data);
if (ret < 0)
return ret;
if (JxlEncoderAddImageFrame(ctx->options, &ctx->jxl_fmt, data, ctx->jxl_fmt.align * frame->height)
!= JXL_ENC_SUCCESS) {
av_log(avctx, AV_LOG_ERROR, "Failed to add Image Frame\n");
return AVERROR_EXTERNAL;
}
/*
* Run this after the last frame in the image has been passed.
*/
JxlEncoderCloseInput(ctx->encoder);
ret = libjxl_process_output(avctx, &bytes_written);
if (ret < 0)
return ret;
ret = ff_get_encode_buffer(avctx, pkt, bytes_written, 0);
if (ret < 0)
return ret;
memcpy(pkt->data, ctx->buffer, bytes_written);
*got_packet = 1;
return 0;
}
/**
* Encode one frame of the animation. libjxl requires us to set duration of the frame
* but we're only promised the PTS, not the duration. As a result we have to buffer
* a frame and subtract the PTS from the last PTS. The last frame uses the previous
* frame's calculated duration as a fallback if its duration field is unset.
*
* We also need to tell libjxl if our frame is the last one, which we won't know upon
* receiving a single frame, so we have to buffer a frame as well and send the "last frame"
* upon receiving the special EOF frame.
*/
static int libjxl_anim_encode_frame(AVCodecContext *avctx, AVPacket *pkt)
{
LibJxlEncodeContext *ctx = avctx->priv_data;
int ret = 0;
JxlFrameHeader frame_header;
size_t bytes_written = 0;
const uint8_t *data;
if (!ctx->prev) {
ctx->prev = av_frame_alloc();
if (!ctx->prev)
return AVERROR(ENOMEM);
ret = ff_encode_get_frame(avctx, ctx->prev);
if (ret == AVERROR(EAGAIN) || ret == AVERROR_EOF)
return ret;
ret = libjxl_preprocess_stream(avctx, ctx->prev, 1);
if (ret < 0)
return ret;
}
ret = ff_encode_get_frame(avctx, ctx->frame);
if (ret == AVERROR_EOF) {
av_frame_free(&ctx->frame);
ret = 0;
}
if (ret == AVERROR(EAGAIN))
return ret;
JxlEncoderInitFrameHeader(&frame_header);
ctx->duration = ctx->prev->duration ? ctx->prev->duration :
ctx->frame ? ctx->frame->pts - ctx->prev->pts :
ctx->duration ? ctx->duration :
1;
frame_header.duration = ctx->duration;
pkt->duration = ctx->duration;
pkt->pts = ctx->prev->pts;
pkt->dts = pkt->pts;
if (JxlEncoderSetFrameHeader(ctx->options, &frame_header) != JXL_ENC_SUCCESS) {
av_log(avctx, AV_LOG_ERROR, "Failed to set JxlFrameHeader\n");
return AVERROR_EXTERNAL;
}
ret = libjxl_preprocess_frame(avctx, ctx->prev, &data);
if (ret < 0)
return ret;
if (JxlEncoderAddImageFrame(ctx->options, &ctx->jxl_fmt, data, ctx->jxl_fmt.align * ctx->prev->height)
!= JXL_ENC_SUCCESS) {
av_log(avctx, AV_LOG_ERROR, "Failed to add Image Frame\n");
return AVERROR_EXTERNAL;
}
if (!ctx->frame)
JxlEncoderCloseInput(ctx->encoder);
ret = libjxl_process_output(avctx, &bytes_written);
if (ret < 0)
return ret;
ret = ff_get_encode_buffer(avctx, pkt, bytes_written, 0);
if (ret < 0)
return ret;
memcpy(pkt->data, ctx->buffer, bytes_written);
if (ctx->frame) {
av_frame_unref(ctx->prev);
av_frame_move_ref(ctx->prev, ctx->frame);
} else {
av_frame_free(&ctx->prev);
}
return ret;
}
static av_cold int libjxl_encode_close(AVCodecContext *avctx)
{
LibJxlEncodeContext *ctx = avctx->priv_data;
if (ctx->runner)
JxlThreadParallelRunnerDestroy(ctx->runner);
ctx->runner = NULL;
/*
* destroying the encoder also frees
* ctx->options so we don't need to
*/
if (ctx->encoder)
JxlEncoderDestroy(ctx->encoder);
ctx->encoder = NULL;
av_freep(&ctx->buffer);
av_frame_free(&ctx->prev);
av_frame_free(&ctx->frame);
return 0;
}
#define OFFSET(x) offsetof(LibJxlEncodeContext, x)
#define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
static const AVOption libjxl_encode_options[] = {
{ "effort", "Encoding effort", OFFSET(effort), AV_OPT_TYPE_INT, { .i64 = 7 }, 1, 9, VE },
{ "distance", "Maximum Butteraugli distance (quality setting, "
"lower = better, zero = lossless, default 1.0)", OFFSET(distance), AV_OPT_TYPE_FLOAT, { .dbl = -1.0 }, -1.0, 15.0, VE },
{ "modular", "Force modular mode", OFFSET(modular), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
{ "xyb", "Use XYB-encoding for lossy images", OFFSET(xyb),
AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, VE },
{ NULL },
};
static const AVClass libjxl_encode_class = {
.class_name = "libjxl",
.item_name = av_default_item_name,
.option = libjxl_encode_options,
.version = LIBAVUTIL_VERSION_INT,
};
static const enum AVPixelFormat libjxl_supported_pixfmts[] = {
AV_PIX_FMT_RGB24, AV_PIX_FMT_RGBA,
AV_PIX_FMT_RGB48, AV_PIX_FMT_RGBA64,
AV_PIX_FMT_RGBF32, AV_PIX_FMT_RGBAF32,
AV_PIX_FMT_GRAY8, AV_PIX_FMT_YA8,
AV_PIX_FMT_GRAY16, AV_PIX_FMT_YA16,
AV_PIX_FMT_GRAYF32,
AV_PIX_FMT_NONE,
};
const FFCodec ff_libjxl_encoder = {
.p.name = "libjxl",
CODEC_LONG_NAME("libjxl JPEG XL"),
.p.type = AVMEDIA_TYPE_VIDEO,
.p.id = AV_CODEC_ID_JPEGXL,
.priv_data_size = sizeof(LibJxlEncodeContext),
.init = libjxl_encode_init,
FF_CODEC_ENCODE_CB(libjxl_encode_frame),
.close = libjxl_encode_close,
.p.capabilities = AV_CODEC_CAP_OTHER_THREADS |
AV_CODEC_CAP_DR1 |
AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE,
.caps_internal = FF_CODEC_CAP_NOT_INIT_THREADSAFE |
FF_CODEC_CAP_AUTO_THREADS | FF_CODEC_CAP_INIT_CLEANUP |
FF_CODEC_CAP_ICC_PROFILES,
CODEC_PIXFMTS_ARRAY(libjxl_supported_pixfmts),
.alpha_modes = AVALPHA_MODE_STRAIGHT | AVALPHA_MODE_PREMULTIPLIED,
.p.priv_class = &libjxl_encode_class,
.p.wrapper_name = "libjxl",
};
const FFCodec ff_libjxl_anim_encoder = {
.p.name = "libjxl_anim",
CODEC_LONG_NAME("libjxl JPEG XL animated"),
.p.type = AVMEDIA_TYPE_VIDEO,
.p.id = AV_CODEC_ID_JPEGXL_ANIM,
.priv_data_size = sizeof(LibJxlEncodeContext),
.init = libjxl_anim_encode_init,
FF_CODEC_RECEIVE_PACKET_CB(libjxl_anim_encode_frame),
.close = libjxl_encode_close,
.p.capabilities = AV_CODEC_CAP_OTHER_THREADS |
AV_CODEC_CAP_DR1 |
AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE,
.caps_internal = FF_CODEC_CAP_NOT_INIT_THREADSAFE |
FF_CODEC_CAP_AUTO_THREADS | FF_CODEC_CAP_INIT_CLEANUP |
FF_CODEC_CAP_ICC_PROFILES,
CODEC_PIXFMTS_ARRAY(libjxl_supported_pixfmts),
.alpha_modes = AVALPHA_MODE_STRAIGHT | AVALPHA_MODE_PREMULTIPLIED,
.p.priv_class = &libjxl_encode_class,
.p.wrapper_name = "libjxl",
};
|