ccextractor.c

/* CCExtractor, originally by carlos at ccextractor.org, now a lot of people.
Credits: See AUTHORS.TXT
License: GPL 2.0

CI verification run: 2025-12-19T08:30 - Testing merged fixes from PRs #1847 and #1848
*/
#include "ccextractor.h"
#include <stdio.h>
#include <locale.h>

volatile int terminate_asap = 0;

struct ccx_s_options ccx_options;
struct lib_ccx_ctx *signal_ctx;

void sigusr1_handler(int sig)
{
	mprint("Caught SIGUSR1. Filename Change Requested\n");
	change_filename_requested = 1;
}

void sigterm_handler(int sig)
{
	printf("Received SIGTERM, terminating as soon as possible.\n");
	terminate_asap = 1;
}

void sigint_handler(int sig)
{
	if (ccx_options.print_file_reports)
		print_file_report(signal_ctx);

	exit(EXIT_SUCCESS);
}

void print_end_msg(void)
{
	mprint("Issues? Open a ticket here\n");
	mprint("https://github.com/CCExtractor/ccextractor/issues\n");
}

int start_ccx()
{
	struct lib_ccx_ctx *ctx = NULL;	      // Context for libs
	struct lib_cc_decode *dec_ctx = NULL; // Context for decoder
	int ret = 0, tmp = 0;
	enum ccx_stream_mode_enum stream_mode = CCX_SM_ELEMENTARY_OR_NOT_FOUND;

#if defined(ENABLE_OCR) && defined(_WIN32)
	setMsgSeverity(LEPT_MSG_SEVERITY);
#endif
	// Initialize CCExtractor libraries
	ctx = init_libraries(&ccx_options);

	if (!ctx)
	{
		if (errno == ENOMEM)
			fatal(EXIT_NOT_ENOUGH_MEMORY, "Not enough memory, could not initialize libraries\n");
		else if (errno == EINVAL)
			fatal(CCX_COMMON_EXIT_BUG_BUG, "Invalid option to CCextractor Library\n");
		else if (errno == EPERM)
			fatal(CCX_COMMON_EXIT_FILE_CREATION_FAILED, "Unable to create output file: Operation not permitted.\n");
		else if (errno == EACCES)
			fatal(CCX_COMMON_EXIT_FILE_CREATION_FAILED, "Unable to create output file: Permission denied\n");
		else
			fatal(EXIT_NOT_CLASSIFIED, "Unable to create Library Context %d\n", errno);
	}

#ifdef ENABLE_HARDSUBX
	if (ccx_options.hardsubx)
	{
		// Perform burned in subtitle extraction
		hardsubx(&ccx_options, ctx);
		return 0;
	}
#endif

#ifdef WITH_LIBCURL
	curl_global_init(CURL_GLOBAL_ALL);

	/* get a curl handle */
	curl = curl_easy_init();
	if (!curl)
	{
		curl_global_cleanup(); // Must be done even on init fail
		fatal(EXIT_NOT_CLASSIFIED, "Unable to init curl.");
	}
#endif

	int show_myth_banner = 0;

	params_dump(ctx);

	// default teletext page
	if (tlt_config.page > 0)
	{
		// dec to BCD, magazine pages numbers are in BCD (ETSI 300 706)
		tlt_config.page = ((tlt_config.page / 100) << 8) | (((tlt_config.page / 10) % 10) << 4) | (tlt_config.page % 10);
	}

	if (ccx_options.transcript_settings.xds)
	{
		if (ccx_options.write_format != CCX_OF_TRANSCRIPT)
		{
			ccx_options.transcript_settings.xds = 0;
			mprint("Warning: -xds ignored, XDS can only be exported to transcripts at this time.\n");
		}
	}

	time_t start, final;
	time(&start);

	if (ccx_options.binary_concat)
	{
		ctx->total_inputsize = get_total_file_size(ctx);
		if (ctx->total_inputsize < 0)
		{
			switch (ctx->total_inputsize)
			{
				case -1 * ENOENT:
					fatal(EXIT_NO_INPUT_FILES, "Failed to open one of the input file(s): File does not exist.");
				case -1 * EACCES:
					fatal(EXIT_READ_ERROR, "Failed to open input file: Unable to access");
				case -1 * EINVAL:
					fatal(EXIT_READ_ERROR, "Failed to open input file: Invalid opening flag.");
				case -1 * EMFILE:
					fatal(EXIT_TOO_MANY_INPUT_FILES, "Failed to open input file: Too many files are open.");
				default:
					fatal(EXIT_READ_ERROR, "Failed to open input file: Reason unknown");
			}
		}
	}

#ifndef _WIN32
	signal_ctx = ctx;
	m_signal(SIGINT, sigint_handler);
	m_signal(SIGTERM, sigterm_handler);
	m_signal(SIGUSR1, sigusr1_handler);
#endif
	terminate_asap = 0;

	ret = 0;
	while (switch_to_next_file(ctx, 0))
	{
		prepare_for_new_file(ctx);

		stream_mode = ctx->demux_ctx->get_stream_mode(ctx->demux_ctx);
		// Disable sync check for raw formats - they have the right timeline.
		// Also true for bin formats, but -nosync might have created a
		// broken timeline for debug purposes.
		// Disable too in MP4, specs doesn't say that there can't be a jump
		switch (stream_mode)
		{
			case CCX_SM_MCPOODLESRAW:
			case CCX_SM_RCWT:
			case CCX_SM_MP4:
#ifdef WTV_DEBUG
			case CCX_SM_HEX_DUMP:
#endif
				ccx_common_timing_settings.disable_sync_check = 1;
				break;
			default:
				break;
		}
		/* -----------------------------------------------------------------
		MAIN LOOP
		----------------------------------------------------------------- */
		switch (stream_mode)
		{
			// Note: This case is meant to fall through
			case CCX_SM_ELEMENTARY_OR_NOT_FOUND:
				if (!ccx_options.use_gop_as_pts)	// If !0 then the user selected something
					ccx_options.use_gop_as_pts = 1; // Force GOP timing for ES
				ccx_common_timing_settings.is_elementary_stream = 1;
			case CCX_SM_TRANSPORT:
			case CCX_SM_PROGRAM:
			case CCX_SM_ASF:
			case CCX_SM_WTV:
			case CCX_SM_GXF:
			case CCX_SM_MXF:
#ifdef ENABLE_FFMPEG
			case CCX_SM_FFMPEG:
#endif
				if (!ccx_options.use_gop_as_pts) // If !0 then the user selected something
					ccx_options.use_gop_as_pts = 0;
				if (ccx_options.ignore_pts_jumps)
					ccx_common_timing_settings.disable_sync_check = 1;
				// When using GOP timing (--goptime), disable sync check because
				// GOP time (wall-clock) and PES PTS (stream-relative) are in
				// different time bases and will always appear as huge jumps.
				if (ccx_options.use_gop_as_pts == 1)
					ccx_common_timing_settings.disable_sync_check = 1;
				mprint("\rAnalyzing data in general mode\n");
				tmp = general_loop(ctx);
				if (!ret)
					ret = tmp;
				break;
			case CCX_SM_MCPOODLESRAW:
				mprint("\rAnalyzing data in McPoodle raw mode\n");
				tmp = raw_loop(ctx);
				if (!ret)
					ret = tmp;
				break;
			case CCX_SM_SCC:
				mprint("\rAnalyzing data in SCC (Scenarist Closed Caption) mode\n");
				tmp = raw_loop(ctx);
				if (!ret)
					ret = tmp;
				break;
			case CCX_SM_RCWT:
				mprint("\rAnalyzing data in CCExtractor's binary format\n");
				tmp = rcwt_loop(ctx);
				if (!ret)
					ret = tmp;
				break;
			case CCX_SM_MYTH:
				mprint("\rAnalyzing data in MythTV mode\n");
				show_myth_banner = 1;
				tmp = myth_loop(ctx);
				if (!ret)
					ret = tmp;
				break;
			case CCX_SM_MP4:
				mprint("\rAnalyzing data in MP4 mode\n");
				close_input_file(ctx);	     // No need to have it open. The MP4 library will reopen it
				if (ctx->current_file == -1) // We don't have a file to open, must be stdin, and GPAC is incompatible with stdin
				{
					fatal(EXIT_INCOMPATIBLE_PARAMETERS, "MP4 requires an actual file, it's not possible to read from a stream, including stdin.\n");
				}
				for (int mp4_i = 0; mp4_i < ccx_options.num_input_files; mp4_i++)
				{
					char *mp4_file = ccx_options.inputfile[mp4_i];
					if (!mp4_file)
						continue;
					if (ccx_options.extract_chapters)
					{
						tmp = dumpchapters(ctx, &ctx->mp4_cfg, mp4_file);
					}
					else
					{
						tmp = processmp4(ctx, &ctx->mp4_cfg, mp4_file);
					}
					if (ccx_options.print_file_reports)
						print_file_report(ctx);
					if (!ret)
						ret = tmp;
				}
				break;
			case CCX_SM_MKV:
				mprint("\rAnalyzing data in Matroska mode\n");
				tmp = matroska_loop(ctx);
				if (!ret)
					ret = tmp;
				break;
#ifdef WTV_DEBUG
			case CCX_SM_HEX_DUMP:
				close_input_file(ctx); // process_hex will open it in text mode
				process_hex(ctx, ctx->inputfile[0]);
				break;
#endif
			case CCX_SM_AUTODETECT:
				fatal(CCX_COMMON_EXIT_BUG_BUG, "Cannot be reached!");
				break;
		}
		list_for_each_entry(dec_ctx, &ctx->dec_ctx_head, list, struct lib_cc_decode)
		{
			mprint("\n");
			dbg_print(CCX_DMT_DECODER_608, "\nTime stamps after last caption block was written:\n");
			dbg_print(CCX_DMT_DECODER_608, "GOP: %s	  \n", print_mstime_static(gop_time.ms));

			dbg_print(CCX_DMT_DECODER_608, "GOP: %s (%+3dms incl.)\n",
				  print_mstime_static((LLONG)(gop_time.ms - first_gop_time.ms + get_fts_max(dec_ctx->timing) - fts_at_gop_start)),
				  (int)(get_fts_max(dec_ctx->timing) - fts_at_gop_start));
			// When padding is active the CC block time should be within
			// 1000/29.97 us of the differences.
			dbg_print(CCX_DMT_DECODER_608, "Max. FTS:	   %s  (without caption blocks since then)\n",
				  print_mstime_static(get_fts_max(dec_ctx->timing)));

			if (dec_ctx->codec == CCX_CODEC_ATSC_CC)
			{
				mprint("\nTotal frames time:	  %s  (%u frames at %.2ffps)\n",
				       print_mstime_static((LLONG)(total_frames_count * 1000 / current_fps)),
				       total_frames_count, current_fps);
			}

			if (dec_ctx->stat_hdtv)
			{
				mprint("\rCC type 0: %d (%s)\n", dec_ctx->cc_stats[0], cc_types[0]);
				mprint("CC type 1: %d (%s)\n", dec_ctx->cc_stats[1], cc_types[1]);
				mprint("CC type 2: %d (%s)\n", dec_ctx->cc_stats[2], cc_types[2]);
				mprint("CC type 3: %d (%s)\n", dec_ctx->cc_stats[3], cc_types[3]);
			}
			// Add one frame as fts_max marks the beginning of the last frame,
			// but we need the end.
			dec_ctx->timing->fts_global += dec_ctx->timing->fts_max + (LLONG)(1000.0 / current_fps);
			// CFS: At least in Hauppage mode, cb_field can be responsible for ALL the
			// timing (cb_fields having a huge number and fts_now and fts_global being 0 all
			// the time), so we need to take that into account in fts_global before resetting
			// counters.
			if (cb_field1 != 0)
				dec_ctx->timing->fts_global += cb_field1 * 1001 / 3;
			else if (cb_field2 != 0)
				dec_ctx->timing->fts_global += cb_field2 * 1001 / 3;
			else
				dec_ctx->timing->fts_global += cb_708 * 1001 / 3;
			// Reset counters - This is needed if some captions are still buffered
			// and need to be written after the last file is processed.
			cb_field1 = 0;
			cb_field2 = 0;
			cb_708 = 0;
			dec_ctx->timing->fts_now = 0;
			dec_ctx->timing->fts_max = 0;

			if (dec_ctx->total_pulldownframes)
				mprint("incl. pulldown frames:  %s  (%u frames at %.2ffps)\n",
				       print_mstime_static((LLONG)(dec_ctx->total_pulldownframes * 1000 / current_fps)),
				       dec_ctx->total_pulldownframes, current_fps);
			if (dec_ctx->timing->pts_set >= 1 && dec_ctx->timing->min_pts != 0x01FFFFFFFFLL)
			{
				LLONG postsyncms = (LLONG)(dec_ctx->frames_since_last_gop * 1000 / current_fps);
				mprint("\nMin PTS:				%s\n",
				       print_mstime_static(dec_ctx->timing->min_pts / (MPEG_CLOCK_FREQ / 1000) - dec_ctx->timing->fts_offset));
				if (pts_big_change)
					mprint("(Reference clock was reset at some point, Min PTS is approximated)\n");
				mprint("Max PTS:				%s\n",
				       print_mstime_static(dec_ctx->timing->sync_pts / (MPEG_CLOCK_FREQ / 1000) + postsyncms));

				mprint("Length:				 %s\n",
				       print_mstime_static(dec_ctx->timing->sync_pts / (MPEG_CLOCK_FREQ / 1000) + postsyncms - dec_ctx->timing->min_pts / (MPEG_CLOCK_FREQ / 1000) + dec_ctx->timing->fts_offset));
			}

			// dvr-ms files have invalid GOPs
			if (gop_time.inited && first_gop_time.inited && stream_mode != CCX_SM_ASF)
			{
				mprint("\nInitial GOP time:	   %s\n",
				       print_mstime_static(first_gop_time.ms));
				mprint("Final GOP time:		 %s%+3dF\n",
				       print_mstime_static(gop_time.ms),
				       dec_ctx->frames_since_last_gop);
				mprint("Diff. GOP length:	   %s%+3dF",
				       print_mstime_static(gop_time.ms - first_gop_time.ms),
				       dec_ctx->frames_since_last_gop);
				mprint("	(%s)\n\n",
				       print_mstime_static(gop_time.ms - first_gop_time.ms + (LLONG)((dec_ctx->frames_since_last_gop) * 1000 / 29.97)));
			}

			if (dec_ctx->false_pict_header)
				mprint("Number of likely false picture headers (discarded): %d\n", dec_ctx->false_pict_header);
			if (dec_ctx->num_key_frames)
				mprint("Number of key frames: %d\n", dec_ctx->num_key_frames);

			if (dec_ctx->stat_numuserheaders)
				mprint("Total user data fields: %d\n", dec_ctx->stat_numuserheaders);
			if (dec_ctx->stat_dvdccheaders)
				mprint("DVD-type user data fields: %d\n", dec_ctx->stat_dvdccheaders);
			if (dec_ctx->stat_scte20ccheaders)
				mprint("SCTE-20 type user data fields: %d\n", dec_ctx->stat_scte20ccheaders);
			if (dec_ctx->stat_replay4000headers)
				mprint("ReplayTV 4000 user data fields: %d\n", dec_ctx->stat_replay4000headers);
			if (dec_ctx->stat_replay5000headers)
				mprint("ReplayTV 5000 user data fields: %d\n", dec_ctx->stat_replay5000headers);
			if (dec_ctx->stat_hdtv)
				mprint("HDTV type user data fields: %d\n", dec_ctx->stat_hdtv);
			if (dec_ctx->stat_dishheaders)
				mprint("Dish Network user data fields: %d\n", dec_ctx->stat_dishheaders);
			if (dec_ctx->stat_divicom)
			{
				mprint("CEA608/Divicom user data fields: %d\n", dec_ctx->stat_divicom);

				mprint("\n\nNOTE! The CEA 608 / Divicom standard encoding for closed\n");
				mprint("caption is not well understood!\n\n");
				mprint("Please submit samples to the developers.\n\n\n");
			}
		}

		if (is_decoder_processed_enough(ctx) == CCX_TRUE)
			break;
	} // file loop
	close_input_file(ctx);

	prepare_for_new_file(ctx); // To reset counters used by handle_end_of_data()

	time(&final);

	long proc_time = (long)(final - start);
	mprint("\rDone, processing time = %ld seconds\n", proc_time);
#if 0
	if (proc_time > 0)
	{
		LLONG ratio = (get_fts_max() / 10) / proc_time;
		unsigned s1 = (unsigned)(ratio / 100);
		unsigned s2 = (unsigned)(ratio % 100);
		mprint("Performance (real length/process time) = %u.%02u\n",
			s1, s2);
	}
#endif

	if (is_decoder_processed_enough(ctx) == CCX_TRUE)
	{
		mprint("\rNote: Processing was canceled before all data was processed because\n");
		mprint("\rone or more user-defined limits were reached.\n");
	}

#ifdef CURL
	if (curl)
		curl_easy_cleanup(curl);
	curl_global_cleanup();
#endif
	dinit_libraries(&ctx);

	if (!ret)
		mprint("\nNo captions were found in input.\n");

	print_end_msg();

	if (show_myth_banner)
	{
		mprint("NOTICE: Due to the major rework in 0.49, we needed to change part of the timing\n");
		mprint("code in the MythTV's branch. Please report results to the address above. If\n");
		mprint("something is broken it will be fixed. Thanks\n");
	}

	return ret ? EXIT_OK : EXIT_NO_CAPTIONS;
}

int main(int argc, char *argv[])
{
	setlocale(LC_ALL, ""); // Supports non-English CCs
			       // Use POSIX locale for numbers so we get "." as decimal separator and no
			       // thousands' groupoing instead of what the locale might say
	setlocale(LC_NUMERIC, "POSIX");

	init_options(&ccx_options);

	// If "ccextractor.cnf" is present, takes options from it.
	// See docs/ccextractor.cnf.sample for more info.
	parse_configuration(&ccx_options);

	ccxr_init_basic_logger();

	int compile_ret = ccxr_parse_parameters(argc, argv);

	// Update the Rust logger target after parsing so --quiet is respected
	ccxr_update_logger_target();

	if (compile_ret == EXIT_NO_INPUT_FILES)
	{
		print_usage();
		fatal(EXIT_NO_INPUT_FILES, "(This help screen was shown because there were no input files)\n");
	}
	else if (compile_ret == EXIT_WITH_HELP)
	{
		return EXIT_OK;
	}
	else if (compile_ret != EXIT_OK)
	{
		exit(compile_ret);
	}

	int start_ret = start_ccx();
	return start_ret;
}