14 // Long options that have no corresponding short option.
19 OPTION_FAKE_CARDS_AUDIO,
20 OPTION_HTTP_UNCOMPRESSED_VIDEO,
21 OPTION_HTTP_X264_VIDEO,
24 OPTION_X264_SPEEDCONTROL,
25 OPTION_X264_SPEEDCONTROL_VERBOSE,
27 OPTION_X264_VBV_BUFSIZE,
28 OPTION_X264_VBV_MAX_BITRATE,
31 OPTION_HTTP_COARSE_TIMEBASE,
32 OPTION_HTTP_AUDIO_CODEC,
33 OPTION_HTTP_AUDIO_BITRATE,
38 OPTION_DISABLE_GAIN_STAGING_AUTO,
39 OPTION_ENABLE_GAIN_STAGING_AUTO,
40 OPTION_DISABLE_COMPRESSOR,
41 OPTION_ENABLE_COMPRESSOR,
42 OPTION_DISABLE_LIMITER,
43 OPTION_ENABLE_LIMITER,
44 OPTION_DISABLE_MAKEUP_GAIN_AUTO,
45 OPTION_ENABLE_MAKEUP_GAIN_AUTO,
46 OPTION_DISABLE_ALSA_OUTPUT,
48 OPTION_PRINT_VIDEO_LATENCY
53 fprintf(stderr, "Usage: nageru [OPTION]...\n");
54 fprintf(stderr, "\n");
55 fprintf(stderr, " --help print usage information\n");
56 fprintf(stderr, " -w, --width output width in pixels (default 1280)\n");
57 fprintf(stderr, " -h, --height output height in pixels (default 720)\n");
58 fprintf(stderr, " -c, --num-cards set number of input cards (default 2)\n");
59 fprintf(stderr, " -t, --theme=FILE choose theme (default theme.lua)\n");
60 fprintf(stderr, " -I, --theme-dir=DIR search for theme in this directory (can be given multiple times)\n");
61 fprintf(stderr, " -v, --va-display=SPEC VA-API device for H.264 encoding\n");
62 fprintf(stderr, " ($DISPLAY spec or /dev/dri/render* path)\n");
63 fprintf(stderr, " -m, --map-signal=SIGNAL,CARD set a default card mapping (can be given multiple times)\n");
64 fprintf(stderr, " -M, --input-mapping=FILE start with the given audio input mapping (implies --multichannel)\n");
65 fprintf(stderr, " --multichannel start in multichannel audio mapping mode\n");
66 fprintf(stderr, " --midi-mapping=FILE start with the given MIDI controller mapping (implies --multichannel)\n");
67 fprintf(stderr, " --fake-cards-audio make fake (disconnected) cards output a simple tone\n");
68 fprintf(stderr, " --http-uncompressed-video send uncompressed NV12 video to HTTP clients\n");
69 fprintf(stderr, " --http-x264-video send x264-compressed video to HTTP clients\n");
70 fprintf(stderr, " --x264-preset x264 quality preset (default " X264_DEFAULT_PRESET ")\n");
71 fprintf(stderr, " --x264-tune x264 tuning (default " X264_DEFAULT_TUNE ", can be blank)\n");
72 fprintf(stderr, " --x264-speedcontrol try to match x264 preset to available CPU speed\n");
73 fprintf(stderr, " --x264-speedcontrol-verbose output speedcontrol debugging statistics\n");
74 fprintf(stderr, " --x264-bitrate x264 bitrate (in kilobit/sec, default %d)\n",
75 DEFAULT_X264_OUTPUT_BIT_RATE);
76 fprintf(stderr, " --x264-vbv-bufsize x264 VBV size (in kilobits, 0 = one-frame VBV,\n");
77 fprintf(stderr, " default: same as --x264-bitrate, that is, one-second VBV)\n");
78 fprintf(stderr, " --x264-vbv-max-bitrate x264 local max bitrate (in kilobit/sec per --vbv-bufsize,\n");
79 fprintf(stderr, " 0 = no limit, default: same as --x264-bitrate, i.e., CBR)\n");
80 fprintf(stderr, " --x264-param=NAME[,VALUE] set any x264 parameter, for fine tuning\n");
81 fprintf(stderr, " --http-mux=NAME mux to use for HTTP streams (default " DEFAULT_STREAM_MUX_NAME ")\n");
82 fprintf(stderr, " --http-audio-codec=NAME audio codec to use for HTTP streams\n");
83 fprintf(stderr, " (default is to use the same as for the recording)\n");
84 fprintf(stderr, " --http-audio-bitrate=KBITS audio codec bit rate to use for HTTP streams\n");
85 fprintf(stderr, " (default is %d, ignored unless --http-audio-codec is set)\n",
86 DEFAULT_AUDIO_OUTPUT_BIT_RATE / 1000);
87 fprintf(stderr, " --http-coarse-timebase use less timebase for HTTP (recommended for muxers\n");
88 fprintf(stderr, " that handle large pts poorly, like e.g. MP4)\n");
89 fprintf(stderr, " --flat-audio start with most audio processing turned off\n");
90 fprintf(stderr, " (can be overridden by e.g. --enable-limiter)\n");
91 fprintf(stderr, " --gain-staging=DB set initial gain staging to the given value\n");
92 fprintf(stderr, " (--disable-gain-staging-auto)\n");
93 fprintf(stderr, " --disable-locut turn off locut filter (also --enable)\n");
94 fprintf(stderr, " --disable-gain-staging-auto turn off automatic gain staging (also --enable)\n");
95 fprintf(stderr, " --disable-compressor turn off regular compressor (also --enable)\n");
96 fprintf(stderr, " --disable-limiter turn off limiter (also --enable)\n");
97 fprintf(stderr, " --disable-makeup-gain-auto turn off auto-adjustment of final makeup gain (also --enable)\n");
98 fprintf(stderr, " --disable-alsa-output disable audio monitoring via ALSA\n");
99 fprintf(stderr, " --no-flush-pbos do not explicitly signal texture data uploads\n");
100 fprintf(stderr, " (will give display corruption, but makes it\n");
101 fprintf(stderr, " possible to run with apitrace in real time)\n");
102 fprintf(stderr, " --print-video-latency print out measurements of video latency on stdout\n");
105 void parse_flags(int argc, char * const argv[])
107 static const option long_options[] = {
108 { "help", no_argument, 0, OPTION_HELP },
109 { "width", required_argument, 0, 'w' },
110 { "height", required_argument, 0, 'h' },
111 { "num-cards", required_argument, 0, 'c' },
112 { "theme", required_argument, 0, 't' },
113 { "theme-dir", required_argument, 0, 'I' },
114 { "map-signal", required_argument, 0, 'm' },
115 { "input-mapping", required_argument, 0, 'M' },
116 { "va-display", required_argument, 0, 'v' },
117 { "multichannel", no_argument, 0, OPTION_MULTICHANNEL },
118 { "midi-mapping", required_argument, 0, OPTION_MIDI_MAPPING },
119 { "fake-cards-audio", no_argument, 0, OPTION_FAKE_CARDS_AUDIO },
120 { "http-uncompressed-video", no_argument, 0, OPTION_HTTP_UNCOMPRESSED_VIDEO },
121 { "http-x264-video", no_argument, 0, OPTION_HTTP_X264_VIDEO },
122 { "x264-preset", required_argument, 0, OPTION_X264_PRESET },
123 { "x264-tune", required_argument, 0, OPTION_X264_TUNE },
124 { "x264-speedcontrol", no_argument, 0, OPTION_X264_SPEEDCONTROL },
125 { "x264-speedcontrol-verbose", no_argument, 0, OPTION_X264_SPEEDCONTROL_VERBOSE },
126 { "x264-bitrate", required_argument, 0, OPTION_X264_BITRATE },
127 { "x264-vbv-bufsize", required_argument, 0, OPTION_X264_VBV_BUFSIZE },
128 { "x264-vbv-max-bitrate", required_argument, 0, OPTION_X264_VBV_MAX_BITRATE },
129 { "x264-param", required_argument, 0, OPTION_X264_PARAM },
130 { "http-mux", required_argument, 0, OPTION_HTTP_MUX },
131 { "http-coarse-timebase", no_argument, 0, OPTION_HTTP_COARSE_TIMEBASE },
132 { "http-audio-codec", required_argument, 0, OPTION_HTTP_AUDIO_CODEC },
133 { "http-audio-bitrate", required_argument, 0, OPTION_HTTP_AUDIO_BITRATE },
134 { "flat-audio", no_argument, 0, OPTION_FLAT_AUDIO },
135 { "gain-staging", required_argument, 0, OPTION_GAIN_STAGING },
136 { "disable-locut", no_argument, 0, OPTION_DISABLE_LOCUT },
137 { "enable-locut", no_argument, 0, OPTION_ENABLE_LOCUT },
138 { "disable-gain-staging-auto", no_argument, 0, OPTION_DISABLE_GAIN_STAGING_AUTO },
139 { "enable-gain-staging-auto", no_argument, 0, OPTION_ENABLE_GAIN_STAGING_AUTO },
140 { "disable-compressor", no_argument, 0, OPTION_DISABLE_COMPRESSOR },
141 { "enable-compressor", no_argument, 0, OPTION_ENABLE_COMPRESSOR },
142 { "disable-limiter", no_argument, 0, OPTION_DISABLE_LIMITER },
143 { "enable-limiter", no_argument, 0, OPTION_ENABLE_LIMITER },
144 { "disable-makeup-gain-auto", no_argument, 0, OPTION_DISABLE_MAKEUP_GAIN_AUTO },
145 { "enable-makeup-gain-auto", no_argument, 0, OPTION_ENABLE_MAKEUP_GAIN_AUTO },
146 { "disable-alsa-output", no_argument, 0, OPTION_DISABLE_ALSA_OUTPUT },
147 { "no-flush-pbos", no_argument, 0, OPTION_NO_FLUSH_PBOS },
148 { "print-video-latency", no_argument, 0, OPTION_PRINT_VIDEO_LATENCY },
151 vector<string> theme_dirs;
153 int option_index = 0;
154 int c = getopt_long(argc, argv, "c:t:I:v:m:M:w:h:", long_options, &option_index);
161 global_flags.width = atoi(optarg);
164 global_flags.height = atoi(optarg);
167 global_flags.num_cards = atoi(optarg);
170 global_flags.theme_filename = optarg;
173 theme_dirs.push_back(optarg);
176 char *ptr = strchr(optarg, ',');
177 if (ptr == nullptr) {
178 fprintf(stderr, "ERROR: Invalid argument '%s' to --map-signal (needs a signal and a card number, separated by comma)\n", optarg);
182 const int signal_num = atoi(optarg);
183 const int card_num = atoi(ptr + 1);
184 if (global_flags.default_stream_mapping.count(signal_num)) {
185 fprintf(stderr, "ERROR: Signal %d already mapped to card %d\n",
186 signal_num, global_flags.default_stream_mapping[signal_num]);
189 global_flags.default_stream_mapping[signal_num] = card_num;
193 global_flags.input_mapping_filename = optarg;
195 case OPTION_MULTICHANNEL:
196 global_flags.multichannel_mapping_mode = true;
199 global_flags.va_display = optarg;
201 case OPTION_MIDI_MAPPING:
202 global_flags.midi_mapping_filename = optarg;
203 global_flags.multichannel_mapping_mode = true;
205 case OPTION_FAKE_CARDS_AUDIO:
206 global_flags.fake_cards_audio = true;
208 case OPTION_HTTP_UNCOMPRESSED_VIDEO:
209 global_flags.uncompressed_video_to_http = true;
211 case OPTION_HTTP_MUX:
212 global_flags.stream_mux_name = optarg;
214 case OPTION_HTTP_COARSE_TIMEBASE:
215 global_flags.stream_coarse_timebase = true;
217 case OPTION_HTTP_AUDIO_CODEC:
218 global_flags.stream_audio_codec_name = optarg;
220 case OPTION_HTTP_AUDIO_BITRATE:
221 global_flags.stream_audio_codec_bitrate = atoi(optarg) * 1000;
223 case OPTION_HTTP_X264_VIDEO:
224 global_flags.x264_video_to_http = true;
226 case OPTION_X264_PRESET:
227 global_flags.x264_preset = optarg;
229 case OPTION_X264_TUNE:
230 global_flags.x264_tune = optarg;
232 case OPTION_X264_SPEEDCONTROL:
233 global_flags.x264_speedcontrol = true;
235 case OPTION_X264_SPEEDCONTROL_VERBOSE:
236 global_flags.x264_speedcontrol_verbose = true;
238 case OPTION_X264_BITRATE:
239 global_flags.x264_bitrate = atoi(optarg);
241 case OPTION_X264_VBV_BUFSIZE:
242 global_flags.x264_vbv_buffer_size = atoi(optarg);
244 case OPTION_X264_VBV_MAX_BITRATE:
245 global_flags.x264_vbv_max_bitrate = atoi(optarg);
247 case OPTION_X264_PARAM:
248 global_flags.x264_extra_param.push_back(optarg);
250 case OPTION_FLAT_AUDIO:
251 // If --flat-audio is given, turn off everything that messes with the sound,
252 // except the final makeup gain.
253 global_flags.locut_enabled = false;
254 global_flags.gain_staging_auto = false;
255 global_flags.compressor_enabled = false;
256 global_flags.limiter_enabled = false;
258 case OPTION_GAIN_STAGING:
259 global_flags.initial_gain_staging_db = atof(optarg);
260 global_flags.gain_staging_auto = false;
262 case OPTION_DISABLE_LOCUT:
263 global_flags.locut_enabled = false;
265 case OPTION_ENABLE_LOCUT:
266 global_flags.locut_enabled = true;
268 case OPTION_DISABLE_GAIN_STAGING_AUTO:
269 global_flags.gain_staging_auto = false;
271 case OPTION_ENABLE_GAIN_STAGING_AUTO:
272 global_flags.gain_staging_auto = true;
274 case OPTION_DISABLE_COMPRESSOR:
275 global_flags.compressor_enabled = false;
277 case OPTION_ENABLE_COMPRESSOR:
278 global_flags.compressor_enabled = true;
280 case OPTION_DISABLE_LIMITER:
281 global_flags.limiter_enabled = false;
283 case OPTION_ENABLE_LIMITER:
284 global_flags.limiter_enabled = true;
286 case OPTION_DISABLE_MAKEUP_GAIN_AUTO:
287 global_flags.final_makeup_gain_auto = false;
289 case OPTION_ENABLE_MAKEUP_GAIN_AUTO:
290 global_flags.final_makeup_gain_auto = true;
292 case OPTION_DISABLE_ALSA_OUTPUT:
293 global_flags.enable_alsa_output = false;
295 case OPTION_NO_FLUSH_PBOS:
296 global_flags.flush_pbos = false;
298 case OPTION_PRINT_VIDEO_LATENCY:
299 global_flags.print_video_latency = true;
305 fprintf(stderr, "Unknown option '%s'\n", argv[option_index]);
306 fprintf(stderr, "\n");
312 if (global_flags.uncompressed_video_to_http &&
313 global_flags.x264_video_to_http) {
314 fprintf(stderr, "ERROR: --http-uncompressed-video and --http-x264-video are mutually incompatible\n");
317 if (global_flags.num_cards <= 0) {
318 fprintf(stderr, "ERROR: --num-cards must be at least 1\n");
321 if (global_flags.x264_speedcontrol) {
322 if (!global_flags.x264_preset.empty() && global_flags.x264_preset != "faster") {
323 fprintf(stderr, "WARNING: --x264-preset is overridden by --x264-speedcontrol (implicitly uses \"faster\" as base preset)\n");
325 global_flags.x264_preset = "faster";
326 } else if (global_flags.x264_preset.empty()) {
327 global_flags.x264_preset = X264_DEFAULT_PRESET;
329 if (!theme_dirs.empty()) {
330 global_flags.theme_dirs = theme_dirs;
333 // In reality, we could probably do with any even value (we subsample
334 // by two in some places), but it's better to be on the safe side
335 // wrt. video codecs and such. (I'd set 16 if I could, but 1080 isn't
337 if (global_flags.width <= 0 || (global_flags.width % 8) != 0 ||
338 global_flags.height <= 0 || (global_flags.height % 8) != 0) {
339 fprintf(stderr, "ERROR: --width and --height must be positive integers divisible by 8\n");
343 for (pair<int, int> mapping : global_flags.default_stream_mapping) {
344 if (mapping.second >= global_flags.num_cards) {
345 fprintf(stderr, "ERROR: Signal %d mapped to card %d, which doesn't exist (try adjusting --num-cards)\n",
346 mapping.first, mapping.second);