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
|
/*
libheif example application.
MIT License
Copyright (c) 2025 Dirk Farin <dirk.farin@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#include <cstring>
#include <getopt.h>
#include "libheif/heif_experimental.h"
#include "libheif/heif_sequences.h"
#include <libheif/heif_tai_timestamps.h>
#if defined(HAVE_UNISTD_H)
#include <unistd.h>
#endif
#include <fstream>
#include <iostream>
#include <iomanip>
#include <sstream>
#include <cassert>
#include <algorithm>
#include <vector>
#include <array>
#include <cctype>
#include <memory>
#include <libheif/heif.h>
#include "common.h"
#include "sdl.hh"
#if defined(_MSC_VER)
#include "getopt.h"
#endif
#if !SDL_VERSION_ATLEAST(2, 0, 18)
#define SDL_GetTicks64 SDL_GetTicks
#endif
#define UNUSED(x) (void)x
static void show_help(const char* argv0)
{
std::cerr << " " << argv0 << " libheif version: " << heif_get_version() << "\n"
<< "---------------------------------------\n"
"Usage: " << argv0 << " [options] <input-file>\n"
<< "\n"
"Options:\n"
" -h, --help show help\n"
" -v, --version show version\n"
" --list-decoders list all available decoders (built-in and plugins)\n"
" -d, --decoder ID use a specific decoder (see --list-decoders)\n"
" --speedup FACTOR increase playback speed by FACTOR\n"
" --show-sai show sample auxiliary information\n"
" --show-frame-duration show each frame duration in milliseconds\n"
" --show-track-metadata show metadata attached to the track (e.g. TAI config)\n"
" --show-metadata-text show data in metadata track as text\n"
" --show-metadata-hex show data in metadata track as hex bytes\n"
" --show-all show all extra information\n"
" --ignore-editlist show the raw media timeline without repetitions\n";
}
class ContextReleaser {
public:
ContextReleaser(struct heif_context* ctx) : ctx_(ctx) {}
~ContextReleaser()
{
heif_context_free(ctx_);
}
private:
struct heif_context* ctx_;
};
int option_list_decoders = 0;
double option_speedup = 1.0;
bool option_show_sai = false;
bool option_show_frame_duration = false;
bool option_show_track_metadata = false;
bool option_ignore_editlist = false;
enum {
metadata_output_none,
metadata_output_text,
metadata_output_hex
} option_metadata_output = metadata_output_none;
const int OPTION_SPEEDUP = 1000;
const int OPTION_SHOW_SAI = 1001;
const int OPTION_SHOW_FRAME_DURATION = 1002;
const int OPTION_SHOW_TRACK_METADATA = 1003;
const int OPTION_SHOW_ALL = 1004;
const int OPTION_SHOW_METADATA_TEXT = 1005;
const int OPTION_SHOW_METADATA_HEX = 1006;
const int OPTION_IGNORE_EDITLIST = 1007;
static struct option long_options[] = {
{(char* const) "decoder", required_argument, 0, 'd'},
{(char* const) "list-decoders", no_argument, &option_list_decoders, 1},
{(char* const) "help", no_argument, 0, 'h'},
{(char* const) "version", no_argument, 0, 'v'},
{(char* const) "speedup", required_argument, 0, OPTION_SPEEDUP},
{(char* const) "show-sai", no_argument, 0, OPTION_SHOW_SAI},
{(char* const) "show-frame-duration", no_argument, 0, OPTION_SHOW_FRAME_DURATION},
{(char* const) "show-track-metadata", no_argument, 0, OPTION_SHOW_TRACK_METADATA},
{(char* const) "show-metadata-text", no_argument, 0, OPTION_SHOW_METADATA_TEXT},
{(char* const) "show-metadata-hex", no_argument, 0, OPTION_SHOW_METADATA_HEX},
{(char* const) "show-all", no_argument, 0, OPTION_SHOW_ALL},
{(char* const) "ignore-editlist", no_argument, 0, OPTION_IGNORE_EDITLIST},
{nullptr, no_argument, nullptr, 0}
};
void output_hex(const uint8_t* data, size_t size)
{
std::cout << std::hex << std::setfill('0');
for (size_t i=0;i<size;i++) {
if (i%16==0) {
std::cout << std::setw(4) << i << " : ";
}
std::cout << std::setw(2) << (uint16_t)data[i];
if (i%16==7)
std::cout << " ";
else if (i%16==15)
std::cout << '\n';
else
std::cout << ' ';
}
if (size%16 != 15) {
std::cout << '\n';
}
std::cout << std::dec << std::setfill(' ');
}
class LibHeifInitializer {
public:
LibHeifInitializer() { heif_init(nullptr); }
~LibHeifInitializer() { heif_deinit(); }
};
int main(int argc, char** argv)
{
// This takes care of initializing libheif and also deinitializing it at the end to free all resources.
LibHeifInitializer initializer;
const char* decoder_id = nullptr;
bool show_frame_number = false;
while (true) {
int option_index = 0;
int c = getopt_long(argc, argv, "hvd:", long_options, &option_index);
if (c == -1) {
break;
}
switch (c) {
case 'd':
decoder_id = optarg;
break;
case 'h':
show_help(argv[0]);
return 0;
case 'v':
heif_examples::show_version();
return 0;
case OPTION_SPEEDUP:
option_speedup = atof(optarg);
if (option_speedup <= 0) {
std::cerr << "Speedup must be positive.\n";
return 5;
}
break;
case OPTION_SHOW_SAI:
option_show_sai = true;
show_frame_number = true;
break;
case OPTION_SHOW_FRAME_DURATION:
option_show_frame_duration = true;
show_frame_number = true;
break;
case OPTION_SHOW_TRACK_METADATA:
option_show_track_metadata = true;
show_frame_number = true;
break;
case OPTION_SHOW_ALL:
option_show_sai = true;
option_show_frame_duration = true;
option_show_track_metadata = true;
show_frame_number = true;
break;
case OPTION_SHOW_METADATA_TEXT:
option_metadata_output = metadata_output_text;
break;
case OPTION_SHOW_METADATA_HEX:
option_metadata_output = metadata_output_hex;
break;
case OPTION_IGNORE_EDITLIST:
option_ignore_editlist = true;
break;
}
}
if (option_list_decoders) {
heif_examples::list_all_decoders();
return 0;
}
if (optind + 1 != argc) {
// Need exactly one input filename as additional argument.
show_help(argv[0]);
return 5;
}
std::string input_filename(argv[optind++]);
// --- check whether input is a supported HEIF file
if (int ret = heif_examples::check_for_valid_input_HEIF_file(input_filename)) {
return ret;
}
// --- open the HEIF file
struct heif_context* ctx = heif_context_alloc();
if (!ctx) {
fprintf(stderr, "Could not create context object\n");
return 1;
}
ContextReleaser cr(ctx);
struct heif_error err;
err = heif_context_read_from_file(ctx, input_filename.c_str(), nullptr);
if (err.code != 0) {
std::cerr << "Could not read HEIF/AVIF file: " << err.message << "\n";
return 1;
}
// --- error if file contains no image sequence
if (!heif_context_has_sequence(ctx)) {
std::cerr << "File contains no image sequence\n";
return 1;
}
// --- get visual track
struct heif_track* track = heif_context_get_track(ctx, 0);
uint16_t w, h;
heif_track_get_image_resolution(track, &w, &h);
// --- show track properties
if (option_show_track_metadata) {
const char* track_contentId = heif_track_get_gimi_track_content_id(track);
if (track_contentId) {
std::cout << "track content ID: " << track_contentId << "\n";
heif_string_release(track_contentId);
}
const heif_tai_clock_info* taic = heif_track_get_tai_clock_info_of_first_cluster(track);
if (taic) {
std::cout << "track taic: " << taic->time_uncertainty << " / " << taic->clock_resolution << " / "
<< taic->clock_drift_rate << " / " << int(taic->clock_type) << "\n";
}
}
// --- find metadata track
heif_track* metadata_track = nullptr;
if (option_metadata_output != metadata_output_none) {
uint32_t metadata_track_id;
size_t nMetadataTracks = heif_track_find_referring_tracks(track, heif_track_reference_type_description, &metadata_track_id, 1);
if (nMetadataTracks == 1) {
metadata_track = heif_context_get_track(ctx, metadata_track_id);
}
}
// --- open output window
SDL_YUV_Display sdlWindow;
std::optional<std::string> sdlError = sdlWindow.init(w, h, SDL_YUV_Display::SDL_CHROMA_420, "heif-view");
if (sdlError) {
std::cerr << "Cannot open output window. " << *sdlError << "\n";
return 10;
}
std::unique_ptr<heif_decoding_options, void (*)(heif_decoding_options*)> decode_options(heif_decoding_options_alloc(), heif_decoding_options_free);
decode_options->convert_hdr_to_8bit = true;
decode_options->decoder_id = decoder_id;
decode_options->ignore_sequence_editlist = option_ignore_editlist;
// --- decoding loop
for (int frameNr = 1;; frameNr++) {
heif_image* out_image = nullptr;
// --- decode next sequence image
err = heif_track_decode_next_image(track, &out_image,
heif_colorspace_YCbCr, // TODO: find best format
heif_chroma_420,
decode_options.get());
if (err.code == heif_error_End_of_sequence) {
break;
}
else if (err.code) {
std::cerr << err.message << "\n";
return 1;
}
// --- wait for image presentation time
uint32_t duration = heif_image_get_duration(out_image);
uint64_t timescale = heif_track_get_timescale(track);
uint64_t duration_ms = duration * 1000 / timescale;
if (option_show_frame_duration) {
std::cout << "sample duration " << heif_image_get_duration(out_image) << " = " << duration_ms << " ms\n";
}
static const uint64_t start_time = SDL_GetTicks64();
static uint64_t next_frame_pts = 0;
uint64_t now_time = SDL_GetTicks64();
uint64_t elapsed_time = (now_time - start_time);
if (elapsed_time < next_frame_pts) {
SDL_Delay((Uint32)(next_frame_pts - elapsed_time));
}
next_frame_pts += static_cast<uint64_t>(static_cast<double>(duration_ms) / option_speedup);
// --- display image
size_t stride_Y, stride_Cb, stride_Cr;
const uint8_t* p_Y = heif_image_get_plane_readonly2(out_image, heif_channel_Y, &stride_Y);
const uint8_t* p_Cb = heif_image_get_plane_readonly2(out_image, heif_channel_Cb, &stride_Cb);
const uint8_t* p_Cr = heif_image_get_plane_readonly2(out_image, heif_channel_Cr, &stride_Cr);
sdlWindow.display(p_Y, p_Cb, p_Cr, static_cast<int>(stride_Y), static_cast<int>(stride_Cb));
if (show_frame_number) {
std::cout << "--- frame " << frameNr << "\n";
}
if (option_show_sai) {
const char* contentID = heif_image_get_gimi_sample_content_id(out_image);
if (contentID) {
std::cout << "GIMI content id: " << contentID << "\n";
heif_string_release(contentID);
}
heif_tai_timestamp_packet* timestamp;
err = heif_image_get_tai_timestamp(out_image, ×tamp);
if (err.code) {
std::cerr << err.message << "\n";
return 10;
}
else if (timestamp) {
std::cout << "TAI timestamp: " << timestamp->tai_timestamp << "\n";
heif_tai_timestamp_packet_release(timestamp);
}
}
// --- get metadata sample
static heif_raw_sequence_sample* metadata_sample = nullptr;
static uint64_t metadata_sample_display_time = 0;
if (metadata_track && metadata_sample == nullptr) {
err = heif_track_get_next_raw_sequence_sample(metadata_track, &metadata_sample);
if (err.code != heif_error_Ok && err.code != heif_error_End_of_sequence) {
std::cerr << err.message << "\n";
return 10;
}
}
// --- show metadata
while (metadata_sample && static_cast<uint64_t>((double)metadata_sample_display_time / option_speedup) <= elapsed_time) {
size_t size;
const uint8_t* data = heif_raw_sequence_sample_get_data(metadata_sample, &size);
std::cout << "timestamp: " << ((double)metadata_sample_display_time)/1000.0f << "sec\n";
if (option_metadata_output == metadata_output_text) {
std::cout << ((const char*) data) << "\n";
}
else if (option_metadata_output == metadata_output_hex) {
output_hex(data, size);
std::cout << '\n';
}
uint64_t metadata_timescale = heif_track_get_timescale(metadata_track);
uint32_t metadata_duration = heif_raw_sequence_sample_get_duration(metadata_sample);
metadata_sample_display_time += metadata_duration * 1000 / metadata_timescale;
heif_raw_sequence_sample_release(metadata_sample);
metadata_sample = nullptr;
// get next metadata sample
err = heif_track_get_next_raw_sequence_sample(metadata_track, &metadata_sample);
if (err.code != heif_error_Ok && err.code != heif_error_End_of_sequence) {
std::cerr << err.message << "\n";
return 10;
}
}
heif_image_release(out_image);
if (sdlWindow.doQuit()) {
break;
}
}
sdlWindow.close();
heif_track_release(track);
heif_track_release(metadata_track);
return 0;
}
|