git.sesse.net Git - nageru/blob - nageru/flags.cpp

   1 #include "flags.h"
   2
   3 #include <getopt.h>
   4 #include <stdio.h>
   5 #include <stdlib.h>
   6 #include <string.h>
   7
   8 #include <utility>
   9
  10 using namespace std;
  11
  12 Flags global_flags;
  13
  14 // Long options that have no corresponding short option.
  15 enum LongOption {
  16         OPTION_HELP = 1000,
  17         OPTION_FULLSCREEN,
  18         OPTION_MAX_NUM_CARDS,
  19         OPTION_MULTICHANNEL,
  20         OPTION_MIDI_MAPPING,
  21         OPTION_DEFAULT_HDMI_INPUT,
  22         OPTION_FAKE_CARDS_AUDIO,
  23         OPTION_V4L_OUTPUT,
  24         OPTION_HTTP_UNCOMPRESSED_VIDEO,
  25         OPTION_HTTP_X264_VIDEO,
  26         OPTION_HTTP_AV1_VIDEO,
  27         OPTION_RECORD_X264_VIDEO,
  28         OPTION_SEPARATE_X264_DISK_ENCODE,
  29         OPTION_X264_PRESET,
  30         OPTION_X264_TUNE,
  31         OPTION_X264_SPEEDCONTROL,
  32         OPTION_X264_SPEEDCONTROL_VERBOSE,
  33         OPTION_X264_BITRATE,
  34         OPTION_X264_CRF,
  35         OPTION_X264_VBV_BUFSIZE,
  36         OPTION_X264_VBV_MAX_BITRATE,
  37         OPTION_X264_PARAM,
  38         OPTION_X264_SEPARATE_DISK_PRESET,
  39         OPTION_X264_SEPARATE_DISK_TUNE,
  40         OPTION_X264_SEPARATE_DISK_BITRATE,
  41         OPTION_X264_SEPARATE_DISK_CRF,
  42         OPTION_X264_SEPARATE_DISK_PARAM,
  43         OPTION_AV1_PRESET,
  44         OPTION_AV1_BITRATE,
  45         OPTION_AV1_FPS,
  46         OPTION_AV1_PARAM,
  47         OPTION_HTTP_MUX,
  48         OPTION_HTTP_COARSE_TIMEBASE,
  49         OPTION_HTTP_AUDIO_CODEC,
  50         OPTION_HTTP_AUDIO_BITRATE,
  51         OPTION_HTTP_PORT,
  52         OPTION_SRT_PORT,
  53         OPTION_NO_SRT,
  54         OPTION_NO_TRANSCODE_VIDEO,
  55         OPTION_NO_TRANSCODE_AUDIO,
  56         OPTION_DISABLE_AUDIO,
  57         OPTION_FLAT_AUDIO,
  58         OPTION_GAIN_STAGING,
  59         OPTION_DISABLE_LOCUT,
  60         OPTION_ENABLE_LOCUT,
  61         OPTION_DISABLE_GAIN_STAGING_AUTO,
  62         OPTION_ENABLE_GAIN_STAGING_AUTO,
  63         OPTION_DISABLE_COMPRESSOR,
  64         OPTION_ENABLE_COMPRESSOR,
  65         OPTION_DISABLE_LIMITER,
  66         OPTION_ENABLE_LIMITER,
  67         OPTION_DISABLE_MAKEUP_GAIN_AUTO,
  68         OPTION_ENABLE_MAKEUP_GAIN_AUTO,
  69         OPTION_DISABLE_ALSA_OUTPUT,
  70         OPTION_NO_FLUSH_PBOS,
  71         OPTION_PRINT_VIDEO_LATENCY,
  72         OPTION_MAX_INPUT_QUEUE_FRAMES,
  73         OPTION_AUDIO_QUEUE_LENGTH_MS,
  74         OPTION_OUTPUT_YCBCR_COEFFICIENTS,
  75         OPTION_OUTPUT_BUFFER_FRAMES,
  76         OPTION_OUTPUT_SLOP_FRAMES,
  77         OPTION_OUTPUT_CARD_UNSYNCHRONIZED,
  78         OPTION_TIMECODE_STREAM,
  79         OPTION_TIMECODE_STDOUT,
  80         OPTION_QUICK_CUT_KEYS,
  81         OPTION_10_BIT,
  82         OPTION_10_BIT_INPUT,
  83         OPTION_10_BIT_OUTPUT,
  84         OPTION_INPUT_YCBCR_INTERPRETATION,
  85         OPTION_MJPEG_EXPORT_CARDS,
  86 };
  87
  88 map<unsigned, unsigned> parse_mjpeg_export_cards(char *optarg)
  89 {
  90         map<unsigned, unsigned> ret;
  91         if (optarg[0] == '\0') {
  92                 return ret;
  93         }
  94
  95         unsigned stream_idx = 0;
  96         char *start = optarg;
  97         for ( ;; ) {
  98                 char *end = strchr(start, ',');
  99                 if (end != nullptr) {
 100                         *end = '\0';
 101                 }
 102
 103                 unsigned range_begin, range_end;
 104                 if (sscanf(start, "%u-%u", &range_begin, &range_end) != 2) {
 105                         range_begin = range_end = atoi(start);
 106                 }
 107                 if (range_end < range_begin) {
 108                         fprintf(stderr, "ERROR: Invalid range %u-%u in --mjpeg-export-cards=\n", range_begin, range_end);
 109                         exit(1);
 110                 }
 111                 if (range_end >= unsigned(global_flags.max_num_cards)) {
 112                         // There are situations where we could possibly want to
 113                         // include FFmpeg inputs (CEF inputs are unlikely),
 114                         // but they're not necessarily in 4:2:2 Y'CbCr, so it would
 115                         // require more functionality the the JPEG encoder.
 116                         fprintf(stderr, "ERROR: Asked for (zero-indexed) card %u in --mjpeg-export-cards=, but there are only %u cards\n",
 117                                 range_end, global_flags.max_num_cards);
 118                         exit(1);
 119                 }
 120                 for (unsigned card_idx = range_begin; card_idx <= range_end; ++card_idx) {
 121                         if (ret.count(card_idx)) {
 122                                 fprintf(stderr, "ERROR: Card %u was given twice in --mjpeg-export-cards=\n", card_idx);
 123                                 exit(1);
 124                         }
 125                         ret[card_idx] = stream_idx++;
 126                 }
 127                 if (end == nullptr) {
 128                         break;
 129                 } else {
 130                         start = end + 1;
 131                 }
 132         }
 133         return ret;
 134 }
 135
 136 void usage(Program program)
 137 {
 138         if (program == PROGRAM_KAERU) {
 139                 fprintf(stderr, "Usage: kaeru [OPTION]... SOURCE_URL\n");
 140         } else {
 141                 fprintf(stderr, "Usage: nageru [OPTION]...\n");
 142         }
 143         fprintf(stderr, "\n");
 144         fprintf(stderr, "      --help                      print usage information\n");
 145         if (program == PROGRAM_NAGERU) {
 146                 fprintf(stderr, "      --fullscreen                run in full screen, with no decorations\n");
 147         }
 148         fprintf(stderr, "  -w, --width                     output width in pixels (default 1280)\n");
 149         fprintf(stderr, "  -h, --height                    output height in pixels (default 720)\n");
 150         if (program == PROGRAM_NAGERU) {
 151                 fprintf(stderr, "  -c, --num-cards                 set minimum number of input cards (default 2)\n");
 152                 fprintf(stderr, "      --max-num-cards             set maximum number of input cards (default %d)\n", MAX_VIDEO_CARDS);
 153                 fprintf(stderr, "  -o, --output-card=CARD          also output signal to the given card (default none)\n");
 154                 fprintf(stderr, "  -t, --theme=FILE                choose theme (default theme.lua)\n");
 155                 fprintf(stderr, "  -I, --theme-dir=DIR             search for theme in this directory (can be given multiple times)\n");
 156                 fprintf(stderr, "  -r, --recording-dir=DIR         where to store disk recording\n");
 157                 fprintf(stderr, "  -v, --va-display=SPEC           VA-API device for H.264 encoding\n");
 158                 fprintf(stderr, "                                    ($DISPLAY spec or /dev/dri/render* path)\n");
 159                 fprintf(stderr, "  -m, --map-signal=SIGNAL,CARD    set a default card mapping (can be given multiple times)\n");
 160                 fprintf(stderr, "  -M, --input-mapping=FILE        start with the given audio input mapping (implies --multichannel)\n");
 161                 fprintf(stderr, "      --multichannel              start in multichannel audio mapping mode\n");
 162                 fprintf(stderr, "      --midi-mapping=FILE         start with the given MIDI controller mapping (implies --multichannel)\n");
 163                 fprintf(stderr, "      --default-hdmi-input        default to HDMI over SDI inputs for cards that have both\n");
 164                 fprintf(stderr, "      --fake-cards-audio          make fake (disconnected) cards output a simple tone\n");
 165                 fprintf(stderr, "      --v4l-output=DEVICE         send video (no audio) to V4L2 output/loopback\n");
 166                 fprintf(stderr, "      --http-x264-video           send x264-compressed video to HTTP clients\n");
 167                 fprintf(stderr, "      --record-x264-video         store x264-compressed video to disk (implies --http-x264-video,\n");
 168                 fprintf(stderr, "                                    removes the need for working VA-API encoding)\n");
 169                 fprintf(stderr, "      --separate-x264-disk-encode run a different x264 encoder for disk recording\n");
 170                 fprintf(stderr, "                                    (implies --record-x264-video)\n");
 171         }
 172         fprintf(stderr, "      --x264-preset               x264 quality preset (default " X264_DEFAULT_PRESET ")\n");
 173         fprintf(stderr, "      --x264-tune                 x264 tuning (default " X264_DEFAULT_TUNE ", can be blank)\n");
 174         fprintf(stderr, "      --x264-speedcontrol         try to match x264 preset to available CPU speed\n");
 175         fprintf(stderr, "      --x264-bitrate              x264 bitrate (in kilobit/sec, default %d)\n",
 176                 DEFAULT_X264_OUTPUT_BIT_RATE);
 177         fprintf(stderr, "      --x264-crf=VALUE            quality-based VBR (-12 to 51), incompatible with --x264-bitrate\n");
 178         fprintf(stderr, "      --x264-param=NAME[,VALUE]   set any x264 parameter, for fine tuning\n");
 179         if (program == PROGRAM_NAGERU) {
 180                 fprintf(stderr, "      --x264-separate-disk-preset x264 quality preset (default " X264_DEFAULT_PRESET ")\n");
 181                 fprintf(stderr, "      --x264-separate-disk-tune   x264 tuning (default " X264_DEFAULT_TUNE ", can be blank)\n");
 182                 fprintf(stderr, "      --x264-separate-disk-bitrate  x264 bitrate (in kilobit/sec, default %d)\n",
 183                         DEFAULT_X264_OUTPUT_BIT_RATE);
 184                 fprintf(stderr, "      --x264-separate-disk-crf=VALUE  quality-based VBR (-12 to 51), \n");
 185                 fprintf(stderr, "                                  incompatible with --x264-separate-disk-bitrate\n");
 186                 fprintf(stderr, "      --x264-separate-disk-param=NAME[,VALUE] set any x264 parameter, for fine tuning\n");
 187         }
 188 #ifdef HAVE_AV1
 189         fprintf(stderr, "      --http-av1-video            send AV1-compressed video to HTTP clients\n");
 190         fprintf(stderr, "      --av1-preset                SVT-AV1 quality preset (default %d, from -2 to 13)\n",
 191                 DEFAULT_AV1_PRESET);
 192         fprintf(stderr, "      --av1-bitrate               AV1 bitrate (in kilobit/sec, default %d)\n",
 193                 DEFAULT_AV1_OUTPUT_BIT_RATE);
 194         fprintf(stderr, "      --av1-fps=NUM[/DEN]         AV1 encoded frame rate (default %d/%d)\n",
 195                 DEFAULT_AV1_FPS_NUM, DEFAULT_AV1_FPS_DEN);
 196         fprintf(stderr, "      --av1-param=NAME[,VALUE]    set any SVT-AV1 parameter, for fine tuning\n");
 197 #endif
 198         fprintf(stderr, "      --http-mux=NAME             mux to use for HTTP streams (default " DEFAULT_STREAM_MUX_NAME ")\n");
 199         fprintf(stderr, "      --http-audio-codec=NAME     audio codec to use for HTTP streams\n");
 200         fprintf(stderr, "                                  (default is to use the same as for the recording)\n");
 201         fprintf(stderr, "      --http-audio-bitrate=KBITS  audio codec bit rate to use for HTTP streams\n");
 202         fprintf(stderr, "                                  (default is %d, ignored unless --http-audio-codec is set)\n",
 203                 DEFAULT_AUDIO_OUTPUT_BIT_RATE / 1000);
 204         fprintf(stderr, "      --http-port=PORT            which port to use for the built-in HTTP server\n");
 205         fprintf(stderr, "                                  (default is %d)\n", DEFAULT_HTTPD_PORT);
 206 #ifdef HAVE_SRT
 207         fprintf(stderr, "      --srt-port=PORT             which port to use for receiving SRT streams\n");
 208         fprintf(stderr, "                                  (default is %d)\n", DEFAULT_SRT_PORT);
 209         fprintf(stderr, "      --no-srt                    disable receiving SRT streams\n");
 210 #endif
 211         if (program == PROGRAM_KAERU) {
 212                 fprintf(stderr, "      --no-transcode-video        copy encoded video raw from the source stream\n");
 213                 fprintf(stderr, "                                    (experimental, must be H.264)\n");
 214                 fprintf(stderr, "      --no-transcode-audio        copy encoded audio raw from the source stream\n");
 215                 fprintf(stderr, "                                    (requires --http-audio-codec= to be set)\n");
 216                 fprintf(stderr, "      --disable-audio             do not include any audio in the stream\n");
 217         }
 218         if (program == PROGRAM_NAGERU) {
 219                 fprintf(stderr, "      --flat-audio                start with most audio processing turned off\n");
 220                 fprintf(stderr, "                                    (can be overridden by e.g. --enable-limiter)\n");
 221                 fprintf(stderr, "      --gain-staging=DB           set initial gain staging to the given value\n");
 222                 fprintf(stderr, "                                    (--disable-gain-staging-auto)\n");
 223                 fprintf(stderr, "      --disable-locut             turn off locut filter (also --enable)\n");
 224                 fprintf(stderr, "      --disable-gain-staging-auto  turn off automatic gain staging (also --enable)\n");
 225                 fprintf(stderr, "      --disable-compressor        turn off regular compressor (also --enable)\n");
 226                 fprintf(stderr, "      --disable-limiter           turn off limiter (also --enable)\n");
 227                 fprintf(stderr, "      --disable-makeup-gain-auto  turn off auto-adjustment of final makeup gain (also --enable)\n");
 228                 fprintf(stderr, "      --disable-alsa-output       disable audio monitoring via ALSA\n");
 229                 fprintf(stderr, "      --print-video-latency       print out measurements of video latency on stdout\n");
 230                 fprintf(stderr, "      --max-input-queue-frames=FRAMES  never keep more than FRAMES frames for each card\n");
 231                 fprintf(stderr, "                                    (default 6, minimum 1)\n");
 232                 fprintf(stderr, "      --audio-queue-length-ms=MS  length of audio resampling queue (default 100.0)\n");
 233                 fprintf(stderr, "      --output-ycbcr-coefficients={rec601,rec709,auto}\n");
 234                 fprintf(stderr, "                                  Y'CbCr coefficient standard of output (default auto)\n");
 235                 fprintf(stderr, "                                    auto is rec601, unless --output-card is used\n");
 236                 fprintf(stderr, "                                    and a Rec. 709 mode (typically HD modes) is in use\n");
 237                 fprintf(stderr, "      --output-buffer-frames=NUM  number of frames in output buffer for --output-card,\n");
 238                 fprintf(stderr, "                                    can be fractional (default 6.0); note also\n");
 239                 fprintf(stderr, "                                    the audio queue can't be much longer than this\n");
 240                 fprintf(stderr, "      --output-slop-frames=NUM    if more less than this number of frames behind for\n");
 241                 fprintf(stderr, "                                    --output-card, try to submit anyway instead of\n");
 242                 fprintf(stderr, "                                    dropping the frame (default 0.5)\n");
 243                 fprintf(stderr, "      --output-card-unsynchronized  if --output-card is in use, do _not_ use it as\n");
 244                 fprintf(stderr, "                                  master clock (may give jittery output and audio breakups)\n");
 245                 fprintf(stderr, "      --timecode-stream           show timestamp and timecode in stream\n");
 246                 fprintf(stderr, "      --timecode-stdout           show timestamp and timecode on standard output\n");
 247                 fprintf(stderr, "      --quick-cut-keys            enable direct cutting by Q, W, E, ... keys\n");
 248                 fprintf(stderr, "      --10-bit                    use 10-bit color depth\n");
 249                 fprintf(stderr, "      --input-ycbcr-interpretation=CARD,{rec601,rec709,auto}[,{limited,full}]\n");
 250                 fprintf(stderr, "                                  Y'CbCr coefficient standard of card CARD (default auto)\n");
 251                 fprintf(stderr, "                                    auto is rec601 for SD, rec709 for HD, always limited\n");
 252                 fprintf(stderr, "                                    limited means standard 0-240/0-235 input range (for 8-bit)\n");
 253                 fprintf(stderr, "      --mjpeg-export-cards=RANGE[,RANGE...]\n");
 254                 fprintf(stderr, "                                  export the given cards in MJPEG format to /multicam.mp4,\n");
 255                 fprintf(stderr, "                                    in the given order (ranges can be either single card indexes\n");
 256                 fprintf(stderr, "                                    or pairs like 1-3 for camera 1,2,3; default is all cards)\n");
 257         }
 258 }
 259
 260 void parse_flags(Program program, int argc, char * const argv[])
 261 {
 262         static const option long_options[] = {
 263                 { "help", no_argument, 0, OPTION_HELP },
 264                 { "fullscreen", no_argument, 0, OPTION_FULLSCREEN },
 265                 { "width", required_argument, 0, 'w' },
 266                 { "height", required_argument, 0, 'h' },
 267                 { "num-cards", required_argument, 0, 'c' },
 268                 { "max-num-cards", required_argument, 0, OPTION_MAX_NUM_CARDS },
 269                 { "output-card", required_argument, 0, 'o' },
 270                 { "theme", required_argument, 0, 't' },
 271                 { "theme-dir", required_argument, 0, 'I' },
 272                 { "recording-dir", required_argument, 0, 'r' },
 273                 { "map-signal", required_argument, 0, 'm' },
 274                 { "input-mapping", required_argument, 0, 'M' },
 275                 { "va-display", required_argument, 0, 'v' },
 276                 { "multichannel", no_argument, 0, OPTION_MULTICHANNEL },
 277                 { "midi-mapping", required_argument, 0, OPTION_MIDI_MAPPING },
 278                 { "default-hdmi-input", no_argument, 0, OPTION_DEFAULT_HDMI_INPUT },
 279                 { "fake-cards-audio", no_argument, 0, OPTION_FAKE_CARDS_AUDIO },
 280                 { "v4l-output", required_argument, 0, OPTION_V4L_OUTPUT },
 281                 { "http-x264-video", no_argument, 0, OPTION_HTTP_X264_VIDEO },
 282                 { "record-x264-video", no_argument, 0, OPTION_RECORD_X264_VIDEO },
 283                 { "separate-x264-disk-encode", no_argument, 0, OPTION_SEPARATE_X264_DISK_ENCODE },
 284                 { "x264-preset", required_argument, 0, OPTION_X264_PRESET },
 285                 { "x264-tune", required_argument, 0, OPTION_X264_TUNE },
 286                 { "x264-speedcontrol", no_argument, 0, OPTION_X264_SPEEDCONTROL },
 287                 { "x264-crf", required_argument, 0, OPTION_X264_CRF },
 288                 { "x264-param", required_argument, 0, OPTION_X264_PARAM },
 289                 { "x264-separate-disk-preset", required_argument, 0, OPTION_X264_SEPARATE_DISK_PRESET },
 290                 { "x264-separate-disk-tune", required_argument, 0, OPTION_X264_SEPARATE_DISK_TUNE },
 291                 { "x264-separate-disk-bitrate", required_argument, 0, OPTION_X264_SEPARATE_DISK_BITRATE },
 292                 { "x264-separate-disk-crf", required_argument, 0, OPTION_X264_SEPARATE_DISK_CRF },
 293                 { "x264-separate-disk-param", required_argument, 0, OPTION_X264_SEPARATE_DISK_PARAM },
 294 #ifdef HAVE_AV1
 295                 { "http-av1-video", no_argument, 0, OPTION_HTTP_AV1_VIDEO },
 296                 { "av1-preset", required_argument, 0, OPTION_AV1_PRESET },
 297                 { "av1-bitrate", required_argument, 0, OPTION_AV1_BITRATE },
 298                 { "av1-fps", required_argument, 0, OPTION_AV1_FPS },
 299                 { "av1-param", required_argument, 0, OPTION_AV1_PARAM },
 300 #endif
 301                 { "http-mux", required_argument, 0, OPTION_HTTP_MUX },
 302                 { "http-audio-codec", required_argument, 0, OPTION_HTTP_AUDIO_CODEC },
 303                 { "http-audio-bitrate", required_argument, 0, OPTION_HTTP_AUDIO_BITRATE },
 304                 { "http-port", required_argument, 0, OPTION_HTTP_PORT },
 305 #ifdef HAVE_SRT
 306                 { "srt-port", required_argument, 0, OPTION_SRT_PORT },
 307 #endif
 308                 { "no-srt", no_argument, 0, OPTION_NO_SRT },  // We silently allow this even without HAVE_SRT.
 309                 { "no-transcode-video", no_argument, 0, OPTION_NO_TRANSCODE_VIDEO },
 310                 { "no-transcode-audio", no_argument, 0, OPTION_NO_TRANSCODE_AUDIO },
 311                 { "disable-audio", no_argument, 0, OPTION_DISABLE_AUDIO },
 312                 { "flat-audio", no_argument, 0, OPTION_FLAT_AUDIO },
 313                 { "gain-staging", required_argument, 0, OPTION_GAIN_STAGING },
 314                 { "disable-locut", no_argument, 0, OPTION_DISABLE_LOCUT },
 315                 { "enable-locut", no_argument, 0, OPTION_ENABLE_LOCUT },
 316                 { "disable-gain-staging-auto", no_argument, 0, OPTION_DISABLE_GAIN_STAGING_AUTO },
 317                 { "enable-gain-staging-auto", no_argument, 0, OPTION_ENABLE_GAIN_STAGING_AUTO },
 318                 { "disable-compressor", no_argument, 0, OPTION_DISABLE_COMPRESSOR },
 319                 { "enable-compressor", no_argument, 0, OPTION_ENABLE_COMPRESSOR },
 320                 { "disable-limiter", no_argument, 0, OPTION_DISABLE_LIMITER },
 321                 { "enable-limiter", no_argument, 0, OPTION_ENABLE_LIMITER },
 322                 { "disable-makeup-gain-auto", no_argument, 0, OPTION_DISABLE_MAKEUP_GAIN_AUTO },
 323                 { "enable-makeup-gain-auto", no_argument, 0, OPTION_ENABLE_MAKEUP_GAIN_AUTO },
 324                 { "disable-alsa-output", no_argument, 0, OPTION_DISABLE_ALSA_OUTPUT },
 325                 { "print-video-latency", no_argument, 0, OPTION_PRINT_VIDEO_LATENCY },
 326                 { "max-input-queue-frames", required_argument, 0, OPTION_MAX_INPUT_QUEUE_FRAMES },
 327                 { "audio-queue-length-ms", required_argument, 0, OPTION_AUDIO_QUEUE_LENGTH_MS },
 328                 { "output-ycbcr-coefficients", required_argument, 0, OPTION_OUTPUT_YCBCR_COEFFICIENTS },
 329                 { "output-buffer-frames", required_argument, 0, OPTION_OUTPUT_BUFFER_FRAMES },
 330                 { "output-slop-frames", required_argument, 0, OPTION_OUTPUT_SLOP_FRAMES },
 331                 { "output-card-unsynchronized", no_argument, 0, OPTION_OUTPUT_CARD_UNSYNCHRONIZED },
 332                 { "timecode-stream", no_argument, 0, OPTION_TIMECODE_STREAM },
 333                 { "timecode-stdout", no_argument, 0, OPTION_TIMECODE_STDOUT },
 334                 { "quick-cut-keys", no_argument, 0, OPTION_QUICK_CUT_KEYS },
 335                 { "10-bit", no_argument, 0, OPTION_10_BIT },
 336                 { "input-ycbcr-interpretation", required_argument, 0, OPTION_INPUT_YCBCR_INTERPRETATION },
 337                 { "mjpeg-export-cards", required_argument, 0, OPTION_MJPEG_EXPORT_CARDS },
 338
 339                 // Do not explicitly signal texture data uploads (will give
 340                 // display corruption, but makes it possible to run with
 341                 // apitrace in real time). For developers only, so undocumented.
 342                 { "no-flush-pbos", no_argument, 0, OPTION_NO_FLUSH_PBOS },
 343
 344                 // Output speedcontrol debugging statistics. For developers only,
 345                 // so undocumented (users can get this information from Prometheus
 346                 // statistics, too).
 347                 { "x264-speedcontrol-verbose", no_argument, 0, OPTION_X264_SPEEDCONTROL_VERBOSE },
 348
 349                 // Deprecated variants.
 350                 { "10-bit-input", no_argument, 0, OPTION_10_BIT_INPUT },
 351                 { "10-bit-output", no_argument, 0, OPTION_10_BIT_OUTPUT },
 352
 353                 { 0, 0, 0, 0 }
 354         };
 355         vector<string> theme_dirs;
 356         string output_ycbcr_coefficients = "auto";
 357         bool card_to_mjpeg_stream_export_set = false;
 358         for ( ;; ) {
 359                 int option_index = 0;
 360                 int c = getopt_long(argc, argv, "c:o:t:I:r:v:m:M:w:h:", long_options, &option_index);
 361
 362                 if (c == -1) {
 363                         break;
 364                 }
 365                 switch (c) {
 366                 case 'w':
 367                         global_flags.width = atoi(optarg);
 368                         break;
 369                 case 'h':
 370                         global_flags.height = atoi(optarg);
 371                         break;
 372                 case 'c':
 373                         global_flags.min_num_cards = atoi(optarg);
 374                         break;
 375                 case OPTION_MAX_NUM_CARDS:
 376                         global_flags.max_num_cards = atoi(optarg);
 377                         break;
 378                 case 'o':
 379                         global_flags.output_card = atoi(optarg);
 380                         break;
 381                 case 't':
 382                         global_flags.theme_filename = optarg;
 383                         break;
 384                 case 'I':
 385                         theme_dirs.push_back(optarg);
 386                         break;
 387                 case 'r':
 388                         global_flags.recording_dir = optarg;
 389                         break;
 390                 case 'm': {
 391                         char *ptr = strchr(optarg, ',');
 392                         if (ptr == nullptr) {
 393                                 fprintf(stderr, "ERROR: Invalid argument '%s' to --map-signal (needs a signal and a card number, separated by comma)\n", optarg);
 394                                 exit(1);
 395                         }
 396                         *ptr = '\0';
 397                         const int signal_num = atoi(optarg);
 398                         const int card_num = atoi(ptr + 1);
 399                         if (global_flags.default_stream_mapping.count(signal_num)) {
 400                                 fprintf(stderr, "ERROR: Signal %d already mapped to card %d\n",
 401                                         signal_num, global_flags.default_stream_mapping[signal_num]);
 402                                 exit(1);
 403                         }
 404                         global_flags.default_stream_mapping[signal_num] = card_num;
 405                         break;
 406                 }
 407                 case 'M':
 408                         global_flags.input_mapping_filename = optarg;
 409                         break;
 410                 case OPTION_MULTICHANNEL:
 411                         global_flags.multichannel_mapping_mode = true;
 412                         break;
 413                 case 'v':
 414                         global_flags.va_display = optarg;
 415                         break;
 416                 case OPTION_MIDI_MAPPING:
 417                         global_flags.midi_mapping_filename = optarg;
 418                         global_flags.multichannel_mapping_mode = true;
 419                         break;
 420                 case OPTION_DEFAULT_HDMI_INPUT:
 421                         global_flags.default_hdmi_input = true;
 422                         break;
 423                 case OPTION_FAKE_CARDS_AUDIO:
 424                         global_flags.fake_cards_audio = true;
 425                         break;
 426                 case OPTION_V4L_OUTPUT:
 427                         global_flags.v4l_output_device = optarg;
 428                         break;
 429                 case OPTION_HTTP_MUX:
 430                         global_flags.stream_mux_name = optarg;
 431                         break;
 432                 case OPTION_HTTP_AUDIO_CODEC:
 433                         global_flags.stream_audio_codec_name = optarg;
 434                         break;
 435                 case OPTION_HTTP_AUDIO_BITRATE:
 436                         global_flags.stream_audio_codec_bitrate = atoi(optarg) * 1000;
 437                         break;
 438                 case OPTION_HTTP_PORT:
 439                         global_flags.http_port = atoi(optarg);
 440                         break;
 441 #ifdef HAVE_SRT
 442                 case OPTION_SRT_PORT:
 443                         global_flags.srt_port = atoi(optarg);
 444                         break;
 445 #endif
 446                 case OPTION_NO_SRT:
 447                         global_flags.srt_port = -1;
 448                         break;
 449                 case OPTION_NO_TRANSCODE_VIDEO:
 450                         global_flags.transcode_video = false;
 451                         break;
 452                 case OPTION_NO_TRANSCODE_AUDIO:
 453                         global_flags.transcode_audio = false;
 454                         break;
 455                 case OPTION_DISABLE_AUDIO:
 456                         global_flags.transcode_audio = false;
 457                         global_flags.enable_audio = false;
 458                         break;
 459                 case OPTION_HTTP_X264_VIDEO:
 460                         global_flags.x264_video_to_http = true;
 461                         break;
 462                 case OPTION_RECORD_X264_VIDEO:
 463                         global_flags.x264_video_to_disk = true;
 464                         break;
 465                 case OPTION_SEPARATE_X264_DISK_ENCODE:
 466                         global_flags.x264_video_to_disk = true;
 467                         global_flags.x264_video_to_http = true;
 468                         global_flags.x264_separate_disk_encode = true;
 469                         break;
 470                 case OPTION_HTTP_AV1_VIDEO:
 471                         global_flags.av1_video_to_http = true;
 472                         break;
 473                 case OPTION_X264_PRESET:
 474                         global_flags.x264_preset = optarg;
 475                         break;
 476                 case OPTION_X264_TUNE:
 477                         global_flags.x264_tune = optarg;
 478                         break;
 479                 case OPTION_X264_SPEEDCONTROL:
 480                         global_flags.x264_speedcontrol = true;
 481                         break;
 482                 case OPTION_X264_SPEEDCONTROL_VERBOSE:
 483                         global_flags.x264_speedcontrol_verbose = true;
 484                         break;
 485                 case OPTION_X264_BITRATE:
 486                         global_flags.x264_bitrate = atoi(optarg);
 487                         break;
 488                 case OPTION_X264_CRF:
 489                         global_flags.x264_crf = atof(optarg);
 490                         break;
 491                 case OPTION_X264_PARAM:
 492                         global_flags.x264_extra_param.push_back(optarg);
 493                         break;
 494                 case OPTION_X264_SEPARATE_DISK_PRESET:
 495                         global_flags.x264_separate_disk_preset = optarg;
 496                         break;
 497                 case OPTION_X264_SEPARATE_DISK_TUNE:
 498                         global_flags.x264_separate_disk_tune = optarg;
 499                         break;
 500                 case OPTION_X264_SEPARATE_DISK_BITRATE:
 501                         global_flags.x264_separate_disk_bitrate = atoi(optarg);
 502                         break;
 503                 case OPTION_X264_SEPARATE_DISK_CRF:
 504                         global_flags.x264_separate_disk_crf = atof(optarg);
 505                         break;
 506                 case OPTION_X264_SEPARATE_DISK_PARAM:
 507                         global_flags.x264_separate_disk_extra_param.push_back(optarg);
 508                         break;
 509                 case OPTION_AV1_PRESET:
 510                         global_flags.av1_preset = atoi(optarg);
 511                         break;
 512                 case OPTION_AV1_BITRATE:
 513                         global_flags.av1_bitrate = atoi(optarg);
 514                         break;
 515                 case OPTION_AV1_FPS: {
 516                         string str = optarg;
 517                         const size_t pos = str.find('/');
 518                         if (pos == string::npos) {
 519                                 global_flags.av1_fps_num = stoi(str);
 520                                 global_flags.av1_fps_den = 1;
 521                         } else {
 522                                 const string num = str.substr(0, pos);
 523                                 const string den = str.substr(pos + 1);
 524                                 global_flags.av1_fps_num = stoi(num);
 525                                 global_flags.av1_fps_den = stoi(den);
 526                         }
 527                         break;
 528                 }
 529                 case OPTION_AV1_PARAM:
 530                         global_flags.av1_extra_param.push_back(optarg);
 531                         break;
 532                 case OPTION_FLAT_AUDIO:
 533                         // If --flat-audio is given, turn off everything that messes with the sound,
 534                         // except the final makeup gain.
 535                         global_flags.locut_enabled = false;
 536                         global_flags.gain_staging_auto = false;
 537                         global_flags.compressor_enabled = false;
 538                         global_flags.limiter_enabled = false;
 539                         break;
 540                 case OPTION_GAIN_STAGING:
 541                         global_flags.initial_gain_staging_db = atof(optarg);
 542                         global_flags.gain_staging_auto = false;
 543                         break;
 544                 case OPTION_DISABLE_LOCUT:
 545                         global_flags.locut_enabled = false;
 546                         break;
 547                 case OPTION_ENABLE_LOCUT:
 548                         global_flags.locut_enabled = true;
 549                         break;
 550                 case OPTION_DISABLE_GAIN_STAGING_AUTO:
 551                         global_flags.gain_staging_auto = false;
 552                         break;
 553                 case OPTION_ENABLE_GAIN_STAGING_AUTO:
 554                         global_flags.gain_staging_auto = true;
 555                         break;
 556                 case OPTION_DISABLE_COMPRESSOR:
 557                         global_flags.compressor_enabled = false;
 558                         break;
 559                 case OPTION_ENABLE_COMPRESSOR:
 560                         global_flags.compressor_enabled = true;
 561                         break;
 562                 case OPTION_DISABLE_LIMITER:
 563                         global_flags.limiter_enabled = false;
 564                         break;
 565                 case OPTION_ENABLE_LIMITER:
 566                         global_flags.limiter_enabled = true;
 567                         break;
 568                 case OPTION_DISABLE_MAKEUP_GAIN_AUTO:
 569                         global_flags.final_makeup_gain_auto = false;
 570                         break;
 571                 case OPTION_ENABLE_MAKEUP_GAIN_AUTO:
 572                         global_flags.final_makeup_gain_auto = true;
 573                         break;
 574                 case OPTION_DISABLE_ALSA_OUTPUT:
 575                         global_flags.enable_alsa_output = false;
 576                         break;
 577                 case OPTION_NO_FLUSH_PBOS:
 578                         global_flags.flush_pbos = false;
 579                         break;
 580                 case OPTION_PRINT_VIDEO_LATENCY:
 581                         global_flags.print_video_latency = true;
 582                         break;
 583                 case OPTION_MAX_INPUT_QUEUE_FRAMES:
 584                         global_flags.max_input_queue_frames = atoi(optarg);
 585                         break;
 586                 case OPTION_AUDIO_QUEUE_LENGTH_MS:
 587                         global_flags.audio_queue_length_ms = atof(optarg);
 588                         break;
 589                 case OPTION_OUTPUT_YCBCR_COEFFICIENTS:
 590                         output_ycbcr_coefficients = optarg;
 591                         break;
 592                 case OPTION_OUTPUT_BUFFER_FRAMES:
 593                         global_flags.output_buffer_frames = atof(optarg);
 594                         break;
 595                 case OPTION_OUTPUT_SLOP_FRAMES:
 596                         global_flags.output_slop_frames = atof(optarg);
 597                         break;
 598                 case OPTION_OUTPUT_CARD_UNSYNCHRONIZED:
 599                         global_flags.output_card_is_master = false;
 600                         break;
 601                 case OPTION_TIMECODE_STREAM:
 602                         global_flags.display_timecode_in_stream = true;
 603                         break;
 604                 case OPTION_TIMECODE_STDOUT:
 605                         global_flags.display_timecode_on_stdout = true;
 606                         break;
 607                 case OPTION_QUICK_CUT_KEYS:
 608                         global_flags.enable_quick_cut_keys = true;
 609                         break;
 610                 case OPTION_10_BIT_INPUT:
 611                         fprintf(stderr, "NOTE: --10-bit-input is a deprecated alias for --10-bit.\n");
 612                         global_flags.bit_depth = 10;
 613                         break;
 614                 case OPTION_10_BIT_OUTPUT:
 615                         fprintf(stderr, "NOTE: --10-bit-output is a deprecated alias for --10-bit.\n");
 616                         global_flags.bit_depth = 10;
 617                         break;
 618                 case OPTION_10_BIT:
 619                         global_flags.bit_depth = 10;
 620                         break;
 621                 case OPTION_INPUT_YCBCR_INTERPRETATION: {
 622                         char *ptr = strchr(optarg, ',');
 623                         if (ptr == nullptr) {
 624                                 fprintf(stderr, "ERROR: Invalid argument '%s' to --input-ycbcr-interpretation (needs a card and an interpretation, separated by comma)\n", optarg);
 625                                 exit(1);
 626                         }
 627                         *ptr = '\0';
 628                         const int card_num = atoi(optarg);
 629                         if (card_num < 0 || card_num >= MAX_VIDEO_CARDS) {
 630                                 fprintf(stderr, "ERROR: Invalid card number %d\n", card_num);
 631                                 exit(1);
 632                         }
 633
 634                         YCbCrInterpretation interpretation;
 635                         char *interpretation_str = ptr + 1;
 636                         ptr = strchr(interpretation_str, ',');
 637                         if (ptr != nullptr) {
 638                                 *ptr = '\0';
 639                                 const char *range = ptr + 1;
 640                                 if (strcmp(range, "full") == 0) {
 641                                         interpretation.full_range = true;
 642                                 } else if (strcmp(range, "limited") == 0) {
 643                                         interpretation.full_range = false;
 644                                 } else {
 645                                         fprintf(stderr, "ERROR: Invalid Y'CbCr range '%s' (must be “full” or “limited”)\n", range);
 646                                         exit(1);
 647                                 }
 648                         }
 649
 650                         if (strcmp(interpretation_str, "rec601") == 0) {
 651                                 interpretation.ycbcr_coefficients_auto = false;
 652                                 interpretation.ycbcr_coefficients = movit::YCBCR_REC_601;
 653                         } else if (strcmp(interpretation_str, "rec709") == 0) {
 654                                 interpretation.ycbcr_coefficients_auto = false;
 655                                 interpretation.ycbcr_coefficients = movit::YCBCR_REC_709;
 656                         } else if (strcmp(interpretation_str, "auto") == 0) {
 657                                 interpretation.ycbcr_coefficients_auto = true;
 658                                 if (interpretation.full_range) {
 659                                         fprintf(stderr, "ERROR: Cannot use “auto” Y'CbCr coefficients with full range\n");
 660                                         exit(1);
 661                                 }
 662                         } else {
 663                                 fprintf(stderr, "ERROR: Invalid Y'CbCr coefficients '%s' (must be “rec601”, “rec709” or “auto”)\n", interpretation_str);
 664                                 exit(1);
 665                         }
 666                         global_flags.ycbcr_interpretation[card_num] = interpretation;
 667                         break;
 668                 }
 669                 case OPTION_FULLSCREEN:
 670                         global_flags.fullscreen = true;
 671                         break;
 672                 case OPTION_MJPEG_EXPORT_CARDS: {
 673                         if (card_to_mjpeg_stream_export_set) {
 674                                 fprintf(stderr, "ERROR: --mjpeg-export-cards given twice\n");
 675                                 exit(1);
 676                         }
 677                         global_flags.card_to_mjpeg_stream_export = parse_mjpeg_export_cards(optarg);
 678                         card_to_mjpeg_stream_export_set = true;
 679                         break;
 680                 }
 681                 case OPTION_HELP:
 682                         usage(program);
 683                         exit(0);
 684                 default:
 685                         fprintf(stderr, "Unknown option '%s'\n", argv[option_index]);
 686                         fprintf(stderr, "\n");
 687                         usage(program);
 688                         exit(1);
 689                 }
 690         }
 691
 692         if (global_flags.x264_video_to_http +
 693             global_flags.av1_video_to_http > 1) {
 694                 fprintf(stderr, "ERROR: --http-{x264,av1}-video are mutually incompatible\n");
 695                 exit(1);
 696         }
 697         if (global_flags.bit_depth == 10) {
 698                 global_flags.x264_video_to_disk = true;  // No 10-bit Quick Sync support.
 699                 if (!global_flags.av1_video_to_http) {
 700                         global_flags.x264_video_to_http = true;
 701                 }
 702         }
 703         if (global_flags.x264_video_to_disk && !global_flags.av1_video_to_http) {
 704                 global_flags.x264_video_to_http = true;  // Quick Sync to HTTP but x264 to disk doesn't make sense.
 705         }
 706         if (global_flags.min_num_cards <= 0) {
 707                 fprintf(stderr, "ERROR: --num-cards must be at least 1\n");
 708                 exit(1);
 709         }
 710         if (global_flags.max_num_cards <= 0) {
 711                 fprintf(stderr, "ERROR: --max-num-cards must be at least 1\n");
 712                 exit(1);
 713         }
 714         if (global_flags.max_num_cards < global_flags.min_num_cards) {
 715                 fprintf(stderr, "ERROR: --max-num-cards can not be lower than --num-cards\n");
 716                 exit(1);
 717         }
 718         if (global_flags.output_card < -1 ||
 719             global_flags.output_card >= global_flags.max_num_cards) {
 720                 fprintf(stderr, "ERROR: --output-card points to a nonexistant card\n");
 721                 exit(1);
 722         }
 723         if (global_flags.enable_audio && !global_flags.transcode_audio && global_flags.stream_audio_codec_name.empty()) {
 724                 fprintf(stderr, "ERROR: If not transcoding audio, you must specify ahead-of-time what audio codec is in use\n");
 725                 fprintf(stderr, "       (using --http-audio-codec).\n");
 726                 exit(1);
 727         }
 728         if (global_flags.x264_speedcontrol) {
 729                 if (!global_flags.x264_preset.empty() && global_flags.x264_preset != "faster") {
 730                         fprintf(stderr, "WARNING: --x264-preset is overridden by --x264-speedcontrol (implicitly uses \"faster\" as base preset)\n");
 731                 }
 732                 global_flags.x264_preset = "faster";
 733         } else if (global_flags.x264_preset.empty()) {
 734                 global_flags.x264_preset = X264_DEFAULT_PRESET;
 735         }
 736         if (global_flags.x264_separate_disk_preset.empty()) {
 737                 global_flags.x264_separate_disk_preset = X264_DEFAULT_PRESET;
 738         }
 739         if (!theme_dirs.empty()) {
 740                 global_flags.theme_dirs = theme_dirs;
 741         }
 742
 743         // In reality, we could probably do with any even value (we subsample
 744         // by two in some places), but it's better to be on the safe side
 745         // wrt. video codecs and such. (I'd set 16 if I could, but 1080 isn't
 746         // divisible by 16.)
 747         if (global_flags.width <= 0 || (global_flags.width % 8) != 0 ||
 748             global_flags.height <= 0 || (global_flags.height % 8) != 0) {
 749                 fprintf(stderr, "ERROR: --width and --height must be positive integers divisible by 8\n");
 750                 exit(1);
 751         }
 752
 753         for (pair<int, int> mapping : global_flags.default_stream_mapping) {
 754                 if (mapping.second >= global_flags.max_num_cards) {
 755                         fprintf(stderr, "ERROR: Signal %d mapped to card %d, which doesn't exist (try adjusting --max-num-cards)\n",
 756                                 mapping.first, mapping.second);
 757                         exit(1);
 758                 }
 759         }
 760
 761         // Rec. 709 would be the sane thing to do, but it seems many players
 762         // just default to BT.601 coefficients no matter what. We _do_ set
 763         // the right flags, so that a player that works properly doesn't have
 764         // to guess, but it's frequently ignored. See discussions
 765         // in e.g. https://trac.ffmpeg.org/ticket/4978; the situation with
 766         // browsers is complicated and depends on things like hardware acceleration
 767         // (https://bugs.chromium.org/p/chromium/issues/detail?id=333619 for
 768         // extensive discussion). VLC generally fixed this as part of 3.0.0
 769         // (see e.g. https://github.com/videolan/vlc/commit/bc71288b2e38c07d6921472824b92eef1aa85f7e
 770         // and https://github.com/videolan/vlc/commit/c3fc2683a9cde1d42674ebf9935dced05733a215),
 771         // but earlier versions were pretty random.
 772         //
 773         // On the other hand, HDMI/SDI output typically requires Rec. 709 for
 774         // HD resolutions (with no way of signaling anything else), which is
 775         // a conflicting demand. In this case, we typically let the HDMI/SDI
 776         // output win if it is active, but the user can override this.
 777         if (output_ycbcr_coefficients == "auto") {
 778                 // Essentially: BT.709 if HDMI/SDI output is on, otherwise BT.601.
 779                 global_flags.ycbcr_rec709_coefficients = false;
 780                 global_flags.ycbcr_auto_coefficients = true;
 781         } else if (output_ycbcr_coefficients == "rec709") {
 782                 global_flags.ycbcr_rec709_coefficients = true;
 783                 global_flags.ycbcr_auto_coefficients = false;
 784         } else if (output_ycbcr_coefficients == "rec601") {
 785                 global_flags.ycbcr_rec709_coefficients = false;
 786                 global_flags.ycbcr_auto_coefficients = false;
 787         } else {
 788                 fprintf(stderr, "ERROR: --output-ycbcr-coefficients must be “rec601”, “rec709” or “auto”\n");
 789                 exit(1);
 790         }
 791
 792         if (global_flags.output_buffer_frames < 0.0f) {
 793                 // Actually, even zero probably won't make sense; there is some internal
 794                 // delay to the card.
 795                 fprintf(stderr, "ERROR: --output-buffer-frames can't be negative.\n");
 796                 exit(1);
 797         }
 798         if (global_flags.output_slop_frames < 0.0f) {
 799                 fprintf(stderr, "ERROR: --output-slop-frames can't be negative.\n");
 800                 exit(1);
 801         }
 802         if (global_flags.max_input_queue_frames < 1) {
 803                 fprintf(stderr, "ERROR: --max-input-queue-frames must be at least 1.\n");
 804                 exit(1);
 805         }
 806         if (global_flags.max_input_queue_frames > 10) {
 807                 fprintf(stderr, "WARNING: --max-input-queue-frames has little effect over 10.\n");
 808         }
 809
 810         if (!isinf(global_flags.x264_crf)) {  // CRF mode is selected.
 811                 if (global_flags.x264_bitrate != -1) {
 812                         fprintf(stderr, "ERROR: --x264-bitrate and --x264-crf are mutually incompatible.\n");
 813                         exit(1);
 814                 }
 815         } else if (global_flags.x264_bitrate == -1) {
 816                 global_flags.x264_bitrate = DEFAULT_X264_OUTPUT_BIT_RATE;
 817         }
 818
 819         if (!isinf(global_flags.x264_separate_disk_crf)) {  // CRF mode is selected.
 820                 if (global_flags.x264_separate_disk_bitrate != -1) {
 821                         fprintf(stderr, "ERROR: --x264-separate-disk-bitrate and --x264-separate-disk-crf are mutually incompatible.\n");
 822                         exit(1);
 823                 }
 824         } else if (global_flags.x264_separate_disk_bitrate == -1) {
 825                 global_flags.x264_separate_disk_bitrate = DEFAULT_X264_OUTPUT_BIT_RATE;
 826         }
 827
 828         if (!card_to_mjpeg_stream_export_set) {
 829                 // Fill in the default mapping (export all cards, in order).
 830                 for (unsigned card_idx = 0; card_idx < unsigned(global_flags.max_num_cards); ++card_idx) {
 831                         global_flags.card_to_mjpeg_stream_export[card_idx] = card_idx;
 832                 }
 833         }
 834 }