14 // Long options that have no corresponding short option.
19 OPTION_FAKE_CARDS_AUDIO,
20 OPTION_HTTP_UNCOMPRESSED_VIDEO,
21 OPTION_HTTP_X264_VIDEO,
22 OPTION_RECORD_X264_VIDEO,
25 OPTION_X264_SPEEDCONTROL,
26 OPTION_X264_SPEEDCONTROL_VERBOSE,
28 OPTION_X264_VBV_BUFSIZE,
29 OPTION_X264_VBV_MAX_BITRATE,
33 OPTION_HTTP_COARSE_TIMEBASE,
34 OPTION_HTTP_AUDIO_CODEC,
35 OPTION_HTTP_AUDIO_BITRATE,
40 OPTION_DISABLE_GAIN_STAGING_AUTO,
41 OPTION_ENABLE_GAIN_STAGING_AUTO,
42 OPTION_DISABLE_COMPRESSOR,
43 OPTION_ENABLE_COMPRESSOR,
44 OPTION_DISABLE_LIMITER,
45 OPTION_ENABLE_LIMITER,
46 OPTION_DISABLE_MAKEUP_GAIN_AUTO,
47 OPTION_ENABLE_MAKEUP_GAIN_AUTO,
48 OPTION_DISABLE_ALSA_OUTPUT,
50 OPTION_PRINT_VIDEO_LATENCY,
51 OPTION_MAX_INPUT_QUEUE_FRAMES,
52 OPTION_AUDIO_QUEUE_LENGTH_MS,
53 OPTION_OUTPUT_YCBCR_COEFFICIENTS,
54 OPTION_OUTPUT_BUFFER_FRAMES,
55 OPTION_OUTPUT_SLOP_FRAMES,
56 OPTION_TIMECODE_STREAM,
57 OPTION_TIMECODE_STDOUT,
63 fprintf(stderr, "Usage: nageru [OPTION]...\n");
64 fprintf(stderr, "\n");
65 fprintf(stderr, " --help print usage information\n");
66 fprintf(stderr, " -w, --width output width in pixels (default 1280)\n");
67 fprintf(stderr, " -h, --height output height in pixels (default 720)\n");
68 fprintf(stderr, " -c, --num-cards set number of input cards (default 2)\n");
69 fprintf(stderr, " -o, --output-card=CARD also output signal to the given card (default none)\n");
70 fprintf(stderr, " -t, --theme=FILE choose theme (default theme.lua)\n");
71 fprintf(stderr, " -I, --theme-dir=DIR search for theme in this directory (can be given multiple times)\n");
72 fprintf(stderr, " -v, --va-display=SPEC VA-API device for H.264 encoding\n");
73 fprintf(stderr, " ($DISPLAY spec or /dev/dri/render* path)\n");
74 fprintf(stderr, " -m, --map-signal=SIGNAL,CARD set a default card mapping (can be given multiple times)\n");
75 fprintf(stderr, " -M, --input-mapping=FILE start with the given audio input mapping (implies --multichannel)\n");
76 fprintf(stderr, " --multichannel start in multichannel audio mapping mode\n");
77 fprintf(stderr, " --midi-mapping=FILE start with the given MIDI controller mapping (implies --multichannel)\n");
78 fprintf(stderr, " --fake-cards-audio make fake (disconnected) cards output a simple tone\n");
79 fprintf(stderr, " --http-uncompressed-video send uncompressed NV12 video to HTTP clients\n");
80 fprintf(stderr, " --http-x264-video send x264-compressed video to HTTP clients\n");
81 fprintf(stderr, " --record-x264-video store x264-compressed video to disk (implies --http-x264-video,\n");
82 fprintf(stderr, " removes the need for working VA-API encoding)\n");
83 fprintf(stderr, " --x264-preset x264 quality preset (default " X264_DEFAULT_PRESET ")\n");
84 fprintf(stderr, " --x264-tune x264 tuning (default " X264_DEFAULT_TUNE ", can be blank)\n");
85 fprintf(stderr, " --x264-speedcontrol try to match x264 preset to available CPU speed\n");
86 fprintf(stderr, " --x264-speedcontrol-verbose output speedcontrol debugging statistics\n");
87 fprintf(stderr, " --x264-bitrate x264 bitrate (in kilobit/sec, default %d)\n",
88 DEFAULT_X264_OUTPUT_BIT_RATE);
89 fprintf(stderr, " --x264-vbv-bufsize x264 VBV size (in kilobits, 0 = one-frame VBV,\n");
90 fprintf(stderr, " default: same as --x264-bitrate, that is, one-second VBV)\n");
91 fprintf(stderr, " --x264-vbv-max-bitrate x264 local max bitrate (in kilobit/sec per --vbv-bufsize,\n");
92 fprintf(stderr, " 0 = no limit, default: same as --x264-bitrate, i.e., CBR)\n");
93 fprintf(stderr, " --x264-10-bit enable 10-bit x264 encoding\n");
94 fprintf(stderr, " --x264-param=NAME[,VALUE] set any x264 parameter, for fine tuning\n");
95 fprintf(stderr, " --http-mux=NAME mux to use for HTTP streams (default " DEFAULT_STREAM_MUX_NAME ")\n");
96 fprintf(stderr, " --http-audio-codec=NAME audio codec to use for HTTP streams\n");
97 fprintf(stderr, " (default is to use the same as for the recording)\n");
98 fprintf(stderr, " --http-audio-bitrate=KBITS audio codec bit rate to use for HTTP streams\n");
99 fprintf(stderr, " (default is %d, ignored unless --http-audio-codec is set)\n",
100 DEFAULT_AUDIO_OUTPUT_BIT_RATE / 1000);
101 fprintf(stderr, " --http-coarse-timebase use less timebase for HTTP (recommended for muxers\n");
102 fprintf(stderr, " that handle large pts poorly, like e.g. MP4)\n");
103 fprintf(stderr, " --flat-audio start with most audio processing turned off\n");
104 fprintf(stderr, " (can be overridden by e.g. --enable-limiter)\n");
105 fprintf(stderr, " --gain-staging=DB set initial gain staging to the given value\n");
106 fprintf(stderr, " (--disable-gain-staging-auto)\n");
107 fprintf(stderr, " --disable-locut turn off locut filter (also --enable)\n");
108 fprintf(stderr, " --disable-gain-staging-auto turn off automatic gain staging (also --enable)\n");
109 fprintf(stderr, " --disable-compressor turn off regular compressor (also --enable)\n");
110 fprintf(stderr, " --disable-limiter turn off limiter (also --enable)\n");
111 fprintf(stderr, " --disable-makeup-gain-auto turn off auto-adjustment of final makeup gain (also --enable)\n");
112 fprintf(stderr, " --disable-alsa-output disable audio monitoring via ALSA\n");
113 fprintf(stderr, " --no-flush-pbos do not explicitly signal texture data uploads\n");
114 fprintf(stderr, " (will give display corruption, but makes it\n");
115 fprintf(stderr, " possible to run with apitrace in real time)\n");
116 fprintf(stderr, " --print-video-latency print out measurements of video latency on stdout\n");
117 fprintf(stderr, " --max-input-queue-frames=FRAMES never keep more than FRAMES frames for each card\n");
118 fprintf(stderr, " (default 6, minimum 1)\n");
119 fprintf(stderr, " --audio-queue-length-ms=MS length of audio resampling queue (default 100.0)\n");
120 fprintf(stderr, " --output-ycbcr-coefficients={rec601,rec709,auto}\n");
121 fprintf(stderr, " Y'CbCr coefficient standard of output (default auto)\n");
122 fprintf(stderr, " auto is rec601, unless --output-card is used\n");
123 fprintf(stderr, " and a Rec. 709 mode (typically HD modes) is in use\n");
124 fprintf(stderr, " --output-buffer-frames=NUM number of frames in output buffer for --output-card,\n");
125 fprintf(stderr, " can be fractional (default 6.0); note also\n");
126 fprintf(stderr, " the audio queue can't be much longer than this\n");
127 fprintf(stderr, " --output-slop-frames=NUM if more less than this number of frames behind for\n");
128 fprintf(stderr, " --output-card, try to submit anyway instead of\n");
129 fprintf(stderr, " dropping the frame (default 0.5)\n");
130 fprintf(stderr, " --timecode-stream show timestamp and timecode in stream\n");
131 fprintf(stderr, " --timecode-stdout show timestamp and timecode on standard output\n");
132 fprintf(stderr, " --10-bit-input use 10-bit video input (requires compute shaders)\n");
135 void parse_flags(int argc, char * const argv[])
137 static const option long_options[] = {
138 { "help", no_argument, 0, OPTION_HELP },
139 { "width", required_argument, 0, 'w' },
140 { "height", required_argument, 0, 'h' },
141 { "num-cards", required_argument, 0, 'c' },
142 { "output-card", required_argument, 0, 'o' },
143 { "theme", required_argument, 0, 't' },
144 { "theme-dir", required_argument, 0, 'I' },
145 { "map-signal", required_argument, 0, 'm' },
146 { "input-mapping", required_argument, 0, 'M' },
147 { "va-display", required_argument, 0, 'v' },
148 { "multichannel", no_argument, 0, OPTION_MULTICHANNEL },
149 { "midi-mapping", required_argument, 0, OPTION_MIDI_MAPPING },
150 { "fake-cards-audio", no_argument, 0, OPTION_FAKE_CARDS_AUDIO },
151 { "http-uncompressed-video", no_argument, 0, OPTION_HTTP_UNCOMPRESSED_VIDEO },
152 { "http-x264-video", no_argument, 0, OPTION_HTTP_X264_VIDEO },
153 { "record-x264-video", no_argument, 0, OPTION_RECORD_X264_VIDEO },
154 { "x264-preset", required_argument, 0, OPTION_X264_PRESET },
155 { "x264-tune", required_argument, 0, OPTION_X264_TUNE },
156 { "x264-speedcontrol", no_argument, 0, OPTION_X264_SPEEDCONTROL },
157 { "x264-speedcontrol-verbose", no_argument, 0, OPTION_X264_SPEEDCONTROL_VERBOSE },
158 { "x264-bitrate", required_argument, 0, OPTION_X264_BITRATE },
159 { "x264-vbv-bufsize", required_argument, 0, OPTION_X264_VBV_BUFSIZE },
160 { "x264-vbv-max-bitrate", required_argument, 0, OPTION_X264_VBV_MAX_BITRATE },
161 { "x264-10-bit", no_argument, 0, OPTION_X264_10_BIT },
162 { "x264-param", required_argument, 0, OPTION_X264_PARAM },
163 { "http-mux", required_argument, 0, OPTION_HTTP_MUX },
164 { "http-coarse-timebase", no_argument, 0, OPTION_HTTP_COARSE_TIMEBASE },
165 { "http-audio-codec", required_argument, 0, OPTION_HTTP_AUDIO_CODEC },
166 { "http-audio-bitrate", required_argument, 0, OPTION_HTTP_AUDIO_BITRATE },
167 { "flat-audio", no_argument, 0, OPTION_FLAT_AUDIO },
168 { "gain-staging", required_argument, 0, OPTION_GAIN_STAGING },
169 { "disable-locut", no_argument, 0, OPTION_DISABLE_LOCUT },
170 { "enable-locut", no_argument, 0, OPTION_ENABLE_LOCUT },
171 { "disable-gain-staging-auto", no_argument, 0, OPTION_DISABLE_GAIN_STAGING_AUTO },
172 { "enable-gain-staging-auto", no_argument, 0, OPTION_ENABLE_GAIN_STAGING_AUTO },
173 { "disable-compressor", no_argument, 0, OPTION_DISABLE_COMPRESSOR },
174 { "enable-compressor", no_argument, 0, OPTION_ENABLE_COMPRESSOR },
175 { "disable-limiter", no_argument, 0, OPTION_DISABLE_LIMITER },
176 { "enable-limiter", no_argument, 0, OPTION_ENABLE_LIMITER },
177 { "disable-makeup-gain-auto", no_argument, 0, OPTION_DISABLE_MAKEUP_GAIN_AUTO },
178 { "enable-makeup-gain-auto", no_argument, 0, OPTION_ENABLE_MAKEUP_GAIN_AUTO },
179 { "disable-alsa-output", no_argument, 0, OPTION_DISABLE_ALSA_OUTPUT },
180 { "no-flush-pbos", no_argument, 0, OPTION_NO_FLUSH_PBOS },
181 { "print-video-latency", no_argument, 0, OPTION_PRINT_VIDEO_LATENCY },
182 { "max-input-queue-frames", required_argument, 0, OPTION_MAX_INPUT_QUEUE_FRAMES },
183 { "audio-queue-length-ms", required_argument, 0, OPTION_AUDIO_QUEUE_LENGTH_MS },
184 { "output-ycbcr-coefficients", required_argument, 0, OPTION_OUTPUT_YCBCR_COEFFICIENTS },
185 { "output-buffer-frames", required_argument, 0, OPTION_OUTPUT_BUFFER_FRAMES },
186 { "output-slop-frames", required_argument, 0, OPTION_OUTPUT_SLOP_FRAMES },
187 { "timecode-stream", no_argument, 0, OPTION_TIMECODE_STREAM },
188 { "timecode-stdout", no_argument, 0, OPTION_TIMECODE_STDOUT },
189 { "10-bit-input", no_argument, 0, OPTION_10_BIT_INPUT },
192 vector<string> theme_dirs;
193 string output_ycbcr_coefficients = "auto";
195 int option_index = 0;
196 int c = getopt_long(argc, argv, "c:t:I:v:m:M:w:h:", long_options, &option_index);
203 global_flags.width = atoi(optarg);
206 global_flags.height = atoi(optarg);
209 global_flags.num_cards = atoi(optarg);
212 global_flags.output_card = atoi(optarg);
215 global_flags.theme_filename = optarg;
218 theme_dirs.push_back(optarg);
221 char *ptr = strchr(optarg, ',');
222 if (ptr == nullptr) {
223 fprintf(stderr, "ERROR: Invalid argument '%s' to --map-signal (needs a signal and a card number, separated by comma)\n", optarg);
227 const int signal_num = atoi(optarg);
228 const int card_num = atoi(ptr + 1);
229 if (global_flags.default_stream_mapping.count(signal_num)) {
230 fprintf(stderr, "ERROR: Signal %d already mapped to card %d\n",
231 signal_num, global_flags.default_stream_mapping[signal_num]);
234 global_flags.default_stream_mapping[signal_num] = card_num;
238 global_flags.input_mapping_filename = optarg;
240 case OPTION_MULTICHANNEL:
241 global_flags.multichannel_mapping_mode = true;
244 global_flags.va_display = optarg;
246 case OPTION_MIDI_MAPPING:
247 global_flags.midi_mapping_filename = optarg;
248 global_flags.multichannel_mapping_mode = true;
250 case OPTION_FAKE_CARDS_AUDIO:
251 global_flags.fake_cards_audio = true;
253 case OPTION_HTTP_UNCOMPRESSED_VIDEO:
254 global_flags.uncompressed_video_to_http = true;
256 case OPTION_HTTP_MUX:
257 global_flags.stream_mux_name = optarg;
259 case OPTION_HTTP_COARSE_TIMEBASE:
260 global_flags.stream_coarse_timebase = true;
262 case OPTION_HTTP_AUDIO_CODEC:
263 global_flags.stream_audio_codec_name = optarg;
265 case OPTION_HTTP_AUDIO_BITRATE:
266 global_flags.stream_audio_codec_bitrate = atoi(optarg) * 1000;
268 case OPTION_HTTP_X264_VIDEO:
269 global_flags.x264_video_to_http = true;
271 case OPTION_RECORD_X264_VIDEO:
272 global_flags.x264_video_to_disk = true;
273 global_flags.x264_video_to_http = true;
275 case OPTION_X264_PRESET:
276 global_flags.x264_preset = optarg;
278 case OPTION_X264_TUNE:
279 global_flags.x264_tune = optarg;
281 case OPTION_X264_SPEEDCONTROL:
282 global_flags.x264_speedcontrol = true;
284 case OPTION_X264_SPEEDCONTROL_VERBOSE:
285 global_flags.x264_speedcontrol_verbose = true;
287 case OPTION_X264_BITRATE:
288 global_flags.x264_bitrate = atoi(optarg);
290 case OPTION_X264_VBV_BUFSIZE:
291 global_flags.x264_vbv_buffer_size = atoi(optarg);
293 case OPTION_X264_10_BIT:
294 global_flags.x264_bit_depth = 10;
296 case OPTION_X264_VBV_MAX_BITRATE:
297 global_flags.x264_vbv_max_bitrate = atoi(optarg);
299 case OPTION_X264_PARAM:
300 global_flags.x264_extra_param.push_back(optarg);
302 case OPTION_FLAT_AUDIO:
303 // If --flat-audio is given, turn off everything that messes with the sound,
304 // except the final makeup gain.
305 global_flags.locut_enabled = false;
306 global_flags.gain_staging_auto = false;
307 global_flags.compressor_enabled = false;
308 global_flags.limiter_enabled = false;
310 case OPTION_GAIN_STAGING:
311 global_flags.initial_gain_staging_db = atof(optarg);
312 global_flags.gain_staging_auto = false;
314 case OPTION_DISABLE_LOCUT:
315 global_flags.locut_enabled = false;
317 case OPTION_ENABLE_LOCUT:
318 global_flags.locut_enabled = true;
320 case OPTION_DISABLE_GAIN_STAGING_AUTO:
321 global_flags.gain_staging_auto = false;
323 case OPTION_ENABLE_GAIN_STAGING_AUTO:
324 global_flags.gain_staging_auto = true;
326 case OPTION_DISABLE_COMPRESSOR:
327 global_flags.compressor_enabled = false;
329 case OPTION_ENABLE_COMPRESSOR:
330 global_flags.compressor_enabled = true;
332 case OPTION_DISABLE_LIMITER:
333 global_flags.limiter_enabled = false;
335 case OPTION_ENABLE_LIMITER:
336 global_flags.limiter_enabled = true;
338 case OPTION_DISABLE_MAKEUP_GAIN_AUTO:
339 global_flags.final_makeup_gain_auto = false;
341 case OPTION_ENABLE_MAKEUP_GAIN_AUTO:
342 global_flags.final_makeup_gain_auto = true;
344 case OPTION_DISABLE_ALSA_OUTPUT:
345 global_flags.enable_alsa_output = false;
347 case OPTION_NO_FLUSH_PBOS:
348 global_flags.flush_pbos = false;
350 case OPTION_PRINT_VIDEO_LATENCY:
351 global_flags.print_video_latency = true;
353 case OPTION_MAX_INPUT_QUEUE_FRAMES:
354 global_flags.max_input_queue_frames = atoi(optarg);
356 case OPTION_AUDIO_QUEUE_LENGTH_MS:
357 global_flags.audio_queue_length_ms = atof(optarg);
359 case OPTION_OUTPUT_YCBCR_COEFFICIENTS:
360 output_ycbcr_coefficients = optarg;
362 case OPTION_OUTPUT_BUFFER_FRAMES:
363 global_flags.output_buffer_frames = atof(optarg);
365 case OPTION_OUTPUT_SLOP_FRAMES:
366 global_flags.output_slop_frames = atof(optarg);
368 case OPTION_TIMECODE_STREAM:
369 global_flags.display_timecode_in_stream = true;
371 case OPTION_TIMECODE_STDOUT:
372 global_flags.display_timecode_on_stdout = true;
374 case OPTION_10_BIT_INPUT:
375 global_flags.ten_bit_input = true;
381 fprintf(stderr, "Unknown option '%s'\n", argv[option_index]);
382 fprintf(stderr, "\n");
388 if (global_flags.uncompressed_video_to_http &&
389 global_flags.x264_video_to_http) {
390 fprintf(stderr, "ERROR: --http-uncompressed-video and --http-x264-video are mutually incompatible\n");
393 if (global_flags.num_cards <= 0) {
394 fprintf(stderr, "ERROR: --num-cards must be at least 1\n");
397 if (global_flags.output_card < -1 ||
398 global_flags.output_card >= global_flags.num_cards) {
399 fprintf(stderr, "ERROR: --output-card points to a nonexistant card\n");
402 if (global_flags.x264_speedcontrol) {
403 if (!global_flags.x264_preset.empty() && global_flags.x264_preset != "faster") {
404 fprintf(stderr, "WARNING: --x264-preset is overridden by --x264-speedcontrol (implicitly uses \"faster\" as base preset)\n");
406 global_flags.x264_preset = "faster";
407 } else if (global_flags.x264_preset.empty()) {
408 global_flags.x264_preset = X264_DEFAULT_PRESET;
410 if (!theme_dirs.empty()) {
411 global_flags.theme_dirs = theme_dirs;
414 // In reality, we could probably do with any even value (we subsample
415 // by two in some places), but it's better to be on the safe side
416 // wrt. video codecs and such. (I'd set 16 if I could, but 1080 isn't
418 if (global_flags.width <= 0 || (global_flags.width % 8) != 0 ||
419 global_flags.height <= 0 || (global_flags.height % 8) != 0) {
420 fprintf(stderr, "ERROR: --width and --height must be positive integers divisible by 8\n");
424 for (pair<int, int> mapping : global_flags.default_stream_mapping) {
425 if (mapping.second >= global_flags.num_cards) {
426 fprintf(stderr, "ERROR: Signal %d mapped to card %d, which doesn't exist (try adjusting --num-cards)\n",
427 mapping.first, mapping.second);
432 // Rec. 709 would be the sane thing to do, but it seems many players
433 // just default to BT.601 coefficients no matter what. We _do_ set
434 // the right flags, so that a player that works properly doesn't have
435 // to guess, but it's frequently ignored. See discussions
436 // in e.g. https://trac.ffmpeg.org/ticket/4978; the situation with
437 // browsers is complicated and depends on things like hardware acceleration
438 // (https://bugs.chromium.org/p/chromium/issues/detail?id=333619 for
439 // extensive discussion). VLC generally fixed this as part of 3.0.0
440 // (see e.g. https://github.com/videolan/vlc/commit/bc71288b2e38c07d6921472824b92eef1aa85f7e
441 // and https://github.com/videolan/vlc/commit/c3fc2683a9cde1d42674ebf9935dced05733a215),
442 // but earlier versions were pretty random.
444 // On the other hand, HDMI/SDI output typically requires Rec. 709 for
445 // HD resolutions (with no way of signaling anything else), which is
446 // a conflicting demand. In this case, we typically let the HDMI/SDI
447 // output win if it is active, but the user can override this.
448 if (output_ycbcr_coefficients == "auto") {
449 // Essentially: BT.709 if HDMI/SDI output is on, otherwise BT.601.
450 global_flags.ycbcr_rec709_coefficients = false;
451 global_flags.ycbcr_auto_coefficients = true;
452 } else if (output_ycbcr_coefficients == "rec709") {
453 global_flags.ycbcr_rec709_coefficients = true;
454 global_flags.ycbcr_auto_coefficients = false;
455 } else if (output_ycbcr_coefficients == "rec601") {
456 global_flags.ycbcr_rec709_coefficients = false;
457 global_flags.ycbcr_auto_coefficients = false;
459 fprintf(stderr, "ERROR: --output-ycbcr-coefficients must be “rec601”, “rec709” or “auto”\n");
463 if (global_flags.output_buffer_frames < 0.0f) {
464 // Actually, even zero probably won't make sense; there is some internal
465 // delay to the card.
466 fprintf(stderr, "ERROR: --output-buffer-frames can't be negative.\n");
469 if (global_flags.output_slop_frames < 0.0f) {
470 fprintf(stderr, "ERROR: --output-slop-frames can't be negative.\n");
473 if (global_flags.max_input_queue_frames < 1) {
474 fprintf(stderr, "ERROR: --max-input-queue-frames must be at least 1.\n");
477 if (global_flags.max_input_queue_frames > 10) {
478 fprintf(stderr, "WARNING: --max-input-queue-frames has little effect over 10.\n");