getargs.c

Go to the documentation of this file.

/*
 * getargs.c - Tachyon command line argument parsing 
 *
 * (C) Copyright 1994-2022 John E. Stone
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * $Id: getargs.c,v 1.60 2022/02/18 18:18:36 johns Exp $
 *
 */

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "tachyon.h"
#include "getargs.h"
#include "ctype.h"

static int strupncmp(const char *a, const char *b, int n) {
   while (n-- > 0) {
      if (toupper(*a) != toupper(*b)) {
         return toupper(*b) - toupper(*a);
      }
      if (*a == 0) return 0;
      a++; b++;
   }
   return 0;
}

static int compare(const char *a, const char *b) {
  if (strlen(a) != strlen(b)) 
    return -1;

  return strupncmp(a, b, strlen(a));
}

static void printusage(char **argv) {
  printf("Usage: \n");
  printf("  %s modelfile [options] \n", argv[0]);
  printf("\n");
  printf("Model file formats supported:\n");
  printf("  filename.dat -- The model files originated with this package.\n");
  printf("  filaname.ac  -- AC3D model files.\n");
#ifdef USELIBMGF
  printf("  filaname.mgf -- MGF model files.\n");
#endif
  printf("  filename.nff -- The NFF scene format used by Eric Haines' SPD.\n");
  printf("\n");
  printf("Valid options:  (** denotes default behaviour)\n");
  printf("----------------------------------------------\n");
  printf("Message Options:\n");
  printf("  +V verbose messages on \n");
  printf("  -V verbose messages off **\n");
  printf("\n");
  printf("Speed Tuning Options:\n");
  printf("  -raydepth xxx     (maximum ray recursion depth\n");
  printf("  -numthreads xxx   (** default is auto-determined)\n");
  printf("  -nobounding\n");
  printf("  -boundthresh xxx  (** default threshold is 16)\n");
  printf("\n");
  printf("Shading Options:\n");
  printf("  -fullshade    best quality rendering (and slowest) **\n");
  printf("  -mediumshade  good quality rendering, but no shadows\n");
  printf("  -lowshade     low quality rendering, preview (and fast)\n");
  printf("  -lowestshade  worst quality rendering, preview (and fastest)\n");
  printf("\n");
  printf("Lighting Options:\n");
  printf("  -rescale_lights xxx rescale light intensity values by\n");
  printf("                      specified factor (performed before other\n");
  printf("                      lighting overrides take effect)\n");
  printf("  -auto_skylight xxx  force use of ambient occlusion lighting,\n");
  printf("                      auto-rescaling direct light sources to  \n");
  printf("                      compensate for ambient occlusion factor.\n");
  printf("                      (use value 0.7 as a good starting point)\n");
  printf("  -add_skylight xxx   force use of ambient occlusion lighting,\n");
  printf("                      manually-rescaling direct light sources to\n");
  printf("                      compensate for ambient occlusion factor.\n");
  printf("  -skylight_maxdist xxx AO maximum occlusion distance cutoff.\n");
  printf("  -skylight_samples xxx number of sample rays to shoot.\n");
  printf("\n");
  printf("Specular Highlight Shading Options:\n");
  printf("  -shade_phong       Phong specular highlights\n");
  printf("  -shade_blinn       Blinn's specular highlights**\n");
  printf("  -shade_blinn_fast  fast approximation to Blinn's highlights\n");
  printf("  -shade_nullphong   disable specular highlights\n");
  printf("\n");
  printf("Transparency Shading Options:\n");
  printf("  -trans_max_surfaces xxx  Limit the number of transparent\n");
  printf("                           surfaces shown to the number specified\n");
  printf("  -trans_orig        Original implementation**\n");
  printf("  -trans_raster3d    Raster3D angle-based opacity modulation\n");
  printf("  -trans_vmd         Opacity post-multiply used by VMD\n");
  printf("\n");
  printf("Transparent Surface Shadowing Options:\n");
  printf("  -shadow_filter_on  Transparent objects cast shadows**\n");  
  printf("  -shadow_filter_off Transparent objects do not cast shadows\n");
  printf("\n");
  printf("Fog Shading Options:\n");
  printf("  -fog_radial        Radial fog implementation**\n");
  printf("  -fog_vmd           Planar OpenGL-like fog used by VMD\n");
  printf("\n");
  printf("Surface Normal/Winding Order Fixup Mode:\n");
  printf("  -normalfixup [off | flip | guess]  (**off is default)\n");
  printf("\n");
  printf("Antialiasing Options:\n");
  printf("  -aasamples xxx  (maximum supersamples taken per pixel)\n");
  printf("                  (** default is 0, or scene file determined)\n");
  printf("\n");
  printf("Output Options:\n");
  printf("  -res Xres Yres  override scene-defined output image size\n");
  printf("  -o outfile.tga  set output file name\n");
  printf("  -clamp          clamp pixel values to [0 to 1) (** default)\n");
  printf("  -normalize      normalize pixel values to [0 to 1)\n");
  printf("  -gamma val      normalize apply gamma correction\n");
  printf("  -format BMP     24-bit Windows BMP  (uncompressed)\n");
#if defined(USEJPEG)
  printf("  -format JPEG    24-bit JPEG         (compressed, but lossy)\n");
#else
  printf("  -format JPEG    XXX Not compiled into this binary XXX\n");
#endif
#if defined(USEPNG)
  printf("  -format PNG     24-bit PNG          (compressed, lossless)\n");
#else
  printf("  -format PNG     XXX Not compiled into this binary XXX\n");
#endif
  printf("  -format PPM     24-bit PPM          (uncompressed)\n");
  printf("  -format PPM48   48-bit PPM          (uncompressed)\n");
  printf("  -format PSD48   48-bit PSD          (uncompressed)\n");
  printf("  -format RGB     24-bit SGI RGB      (uncompressed)\n");
  printf("  -format TARGA   24-bit Targa        (uncompressed) **\n");
  printf("\n");
  printf("Animation Related Options:\n");
  printf("  -camfile filename.cam  Animate using file of camera positions.\n");
  printf("  -nosave                Disable writing of output frames to disk\n");
  printf("                        (only used for doing real-time rendering)\n");
  printf("\n");
  printf("Interactive Spaceball/SpaceNavigator Control:\n");
  printf("  -spaceball       Enable Spaceball/SpaceNavigator camera flight\n");
  printf("  -spaceballport serialportdevicename (only for serial devices)\n");
  printf("\n");
}

static void initoptions(argoptions * opt) {
  memset(opt, 0, sizeof(argoptions));
  opt->filenames = (char **) malloc(sizeof(char *) * 10);
  opt->numfiles = 0;
  opt->useoutfilename = -1;
  opt->outimageformat = -1;
  opt->xsize = 0;
  opt->ysize = 0;
  opt->verbosemode = -1;
  opt->ray_maxdepth = -1;
  opt->aa_maxsamples = -1;
  opt->boundmode = -1; 
  opt->boundthresh = -1; 
  opt->usecamfile = -1;
  opt->shadermode = -1;
  opt->phongfunc = -1;
  opt->transcount = -1;
  opt->transmode = -1;
  opt->shadow_filtering = -1;
  opt->fogmode = -1;
  opt->normalfixupmode = -1;
  opt->imgprocess = -1;
  opt->imggamma = 1.0;
  opt->numthreads = -1;
  opt->nosave = -1;
  opt->rescale_lights = 1.0;
  opt->auto_skylight = 0.0;
  opt->add_skylight = 0.0;
  opt->skylight_maxdist = RT_AO_MAXDIST_UNLIMITED;
  opt->skylight_samples = 128;
  opt->cropmode = 0;     /* SPECMPI image cropping */
  opt->cropxres = 0;
  opt->cropyres = 0;
  opt->cropxstart = 0;
  opt->cropystart = 0;
}

/* process options that affect scene generation */
int presceneoptions(argoptions * opt, SceneHandle scene) {
  if (opt->normalfixupmode != -1) {
    rt_normal_fixup_mode(scene, opt->normalfixupmode);
  }

  return 0;
}

/* process options that affect scene rendering */
int postsceneoptions(argoptions * opt, SceneHandle scene) {
  if (opt->outimageformat == -1) {
    opt->outimageformat = RT_FORMAT_TARGA;
  }
  if (opt->xsize > 0 && opt->ysize > 0) {
    rt_resolution(scene, opt->xsize, opt->ysize);
  }

  if (opt->cropmode != 0) {
    if (opt->cropmode == 1) {
      rt_crop_output(scene, opt->cropxres, opt->cropyres,
                     opt->cropxstart, opt->cropystart);
    } else {
      int xs, ys;
      rt_get_resolution(scene, &xs, &ys);
      rt_crop_output(scene, 100, 100, xs/2 - 50, ys/2 - 50);
    }
  }

  if (opt->useoutfilename == -1) {
    if (opt->usecamfile != -1) {
      strcpy(opt->outfilename, "cam.%04d");
    } else if (opt->numfiles > 1) {
      strcpy(opt->outfilename, "outfile.%04d");
    } else {
      strcpy(opt->outfilename, "outfile");
    }

    switch (opt->outimageformat) {
      case RT_FORMAT_PPM:
        strcat(opt->outfilename, ".ppm");
        break;  
  
      case RT_FORMAT_WINBMP:
        strcat(opt->outfilename, ".bmp");
        break;  

      case RT_FORMAT_SGIRGB:
        strcat(opt->outfilename, ".rgb");
        break;  

      case RT_FORMAT_JPEG:
        strcat(opt->outfilename, ".jpg");
        break;  

      case RT_FORMAT_PNG:
        strcat(opt->outfilename, ".png");
        break;  

      case RT_FORMAT_PSD48:
        strcat(opt->outfilename, ".psd");
        break;  

      case RT_FORMAT_PPM48:
        strcat(opt->outfilename, ".ppm");
        break;  

      case RT_FORMAT_TARGA:
                   default:
        strcat(opt->outfilename, ".tga");
        break;  
    }
  }

  if (opt->nosave == 1) {
    strcpy(opt->outfilename, "\0");
  }

  if (opt->rescale_lights < 1.0) {
    /* rescale all lights by supplied scaling factor */
    rt_rescale_lights(scene, opt->rescale_lights);
  }  

  if (opt->auto_skylight > 0.0) {
    /* enable ambient occlusion lighting, and rescale direct lights */
    /* to compensate. */
    apicolor col;
    float lightscale = 1.0f - opt->auto_skylight;
    if (lightscale < 0.0f)
      lightscale = 0.0f;
    rt_rescale_lights(scene, lightscale);
 
    col.r = opt->auto_skylight;    
    col.g = opt->auto_skylight;    
    col.b = opt->auto_skylight;    
    rt_ambient_occlusion(scene, opt->skylight_samples, opt->skylight_maxdist, col);
  } else if (opt->add_skylight > 0.0) {
    /* enable ambient occlusion lighting, with no automatic compensation */
    apicolor col;
    col.r = opt->add_skylight;    
    col.g = opt->add_skylight;    
    col.b = opt->add_skylight;    
    rt_ambient_occlusion(scene, opt->skylight_samples, opt->skylight_maxdist, col);
  }

  rt_outputformat(scene, opt->outimageformat);
  rt_outputfile(scene, opt->outfilename);

  if (opt->imgprocess != -1) {
    switch(opt->imgprocess) {
      case 0:
        rt_image_clamp(scene);
        break;

      case 1:
        rt_image_normalize(scene);
        break;

      case 2:
        rt_image_gamma(scene, opt->imggamma);
        break;
    }
  }

  if (opt->verbosemode == 1) {
    rt_verbose(scene, 1);
  }

  if (opt->verbosemode == 0) {
    rt_verbose(scene, 0);
  }  

  if (opt->ray_maxdepth != -1) {
    rt_camera_raydepth(scene, opt->ray_maxdepth);
  } 

  if (opt->aa_maxsamples != -1) {
    rt_aa_maxsamples(scene, opt->aa_maxsamples);
  } 

  if (opt->boundmode != -1) {
    rt_boundmode(scene, opt->boundmode);
  }

  if (opt->boundthresh != -1) {
    rt_boundthresh(scene, opt->boundthresh);
  }

  if (opt->shadermode != -1) {
    rt_shadermode(scene, opt->shadermode);
  }

  if (opt->phongfunc != -1) {
    rt_phong_shader(scene, opt->phongfunc);
  }

  if (opt->transcount != -1) {
    rt_trans_max_surfaces(scene, opt->transcount);
  }

  if (opt->transmode != -1) {
    rt_trans_mode(scene, opt->transmode);
  }

  if (opt->shadow_filtering != -1) {
    rt_shadow_filtering(scene, opt->shadow_filtering);
  }

  if (opt->fogmode != -1) {
    rt_fog_rendering_mode(scene, opt->fogmode);
  }

  if (opt->numthreads != -1) {
    rt_set_numthreads(scene, opt->numthreads);
  }

  return 0;
}    

static int getparm(int argc, char **argv, int num, argoptions * opt, int node) {
  if (!strcmp(argv[num], "-o")) {
    opt->useoutfilename = 1;
    sscanf(argv[num + 1], "%s", (char *) &opt->outfilename);
    return 2;
  }
  if (!strcmp(argv[num], "-numthreads")) {
    sscanf(argv[num + 1], "%d", &opt->numthreads);
    return 2;
  }
  if (!strcmp(argv[num], "-camfile")) {
    opt->usecamfile = 1;
    sscanf(argv[num + 1], "%s", &opt->camfilename[0]);
    return 2;
  }
  if (!strcmp(argv[num], "-nosave")) {
    /* disable writing of images to disk files */
    opt->nosave = 1;
    return 1;
  }
  if (!strcmp(argv[num], "-normalfixup")) {
    char tmp[1024];
    sscanf(argv[num + 1], "%s", tmp);
    if (!strcmp(tmp, "off")) {
      opt->normalfixupmode = RT_NORMAL_FIXUP_OFF;
    } else if (!strcmp(tmp, "flip")) {
      opt->normalfixupmode = RT_NORMAL_FIXUP_FLIP;
    } else if (!strcmp(tmp, "guess")) {
      opt->normalfixupmode = RT_NORMAL_FIXUP_GUESS;
    }
    return 2;
  }
  if (!strcmp(argv[num], "-raydepth")) {
    sscanf(argv[num + 1], "%d", &opt->ray_maxdepth);
    return 2;
  }
  if (!strcmp(argv[num], "-aasamples")) {
    sscanf(argv[num + 1], "%d", &opt->aa_maxsamples);
    return 2;
  }
  if (!strcmp(argv[num], "-V")) {
    /* turn verbose messages off */
    opt->verbosemode = 0;
    return 1;
  }
  if (!strcmp(argv[num], "+V")) {
    /* turn verbose messages on */
    opt->verbosemode = 1;
    return 1;
  }
  if (!strcmp(argv[num], "-nobounding")) {
    /* disable automatic spatial subdivision optimizations */
    opt->boundmode = RT_BOUNDING_DISABLED;
    return 1;
  }
  if (!strcmp(argv[num], "-boundthresh")) {
    /* set automatic bounding threshold control value */
    sscanf(argv[num + 1], "%d", &opt->boundthresh);
    return 2;
  }
  if (!strcmp(argv[num], "-fullshade")) {
    opt->shadermode = RT_SHADER_FULL;
    return 1;
  }
  if (!strcmp(argv[num], "-mediumshade")) {
    opt->shadermode = RT_SHADER_MEDIUM;
    return 1;
  }
  if (!strcmp(argv[num], "-lowshade")) {
    opt->shadermode = RT_SHADER_LOW;
    return 1;
  }
  if (!strcmp(argv[num], "-lowestshade")) {
    opt->shadermode = RT_SHADER_LOWEST;
    return 1;
  }
  if (!strcmp(argv[num], "-rescale_lights")) {
    sscanf(argv[num + 1], "%f", &opt->rescale_lights);
    return 2;
  }
  if (!strcmp(argv[num], "-auto_skylight")) {
    sscanf(argv[num + 1], "%f", &opt->auto_skylight);
    return 2;
  }
  if (!strcmp(argv[num], "-add_skylight")) {
    sscanf(argv[num + 1], "%f", &opt->add_skylight);
    return 2;
  }
  if (!strcmp(argv[num], "-skylight_maxdist")) {
    sscanf(argv[num + 1], "%f", &opt->skylight_maxdist);
    return 2;
  }
  if (!strcmp(argv[num], "-skylight_samples")) {
    sscanf(argv[num + 1], "%d", &opt->skylight_samples);
    return 2;
  }
  if (!strcmp(argv[num], "-shade_phong")) {
    opt->phongfunc  = RT_SHADER_PHONG;
    return 1;
  }
  if (!strcmp(argv[num], "-shade_blinn")) {
    opt->phongfunc  = RT_SHADER_BLINN;
    return 1;
  }
  if (!strcmp(argv[num], "-shade_blinn_fast")) {
    opt->phongfunc  = RT_SHADER_BLINN_FAST;
    return 1;
  }
  if (!strcmp(argv[num], "-shade_nullphong")) {
    opt->phongfunc  = RT_SHADER_NULL_PHONG;
    return 1;
  }
  if (!strcmp(argv[num], "-trans_max_surfaces")) {
    sscanf(argv[num + 1], "%d", &opt->transcount);
    return 2;
  }
  if (!strcmp(argv[num], "-trans_orig")) {
    opt->transmode  = RT_TRANS_ORIG; /* reset all flags to default */
    return 1;
  }
  if (!strcmp(argv[num], "-trans_raster3d")) {
    if (opt->transmode == -1)
      opt->transmode  = RT_TRANS_RASTER3D; /* combine with other flags */
    else
      opt->transmode  |= RT_TRANS_RASTER3D; /* combine with other flags */
    return 1;
  }
  if (!strcmp(argv[num], "-trans_vmd")) {
    if (opt->transmode == -1)
      opt->transmode  = RT_TRANS_VMD; /* combine with other flags */
    else
      opt->transmode  |= RT_TRANS_VMD; /* combine with other flags */
    return 1;
  }
  if (!strcmp(argv[num], "-shadow_filter_on")) {
    opt->shadow_filtering = 1;
    return 1;
  }
  if (!strcmp(argv[num], "-shadow_filter_off")) {
    opt->shadow_filtering = 0;
    return 1;
  }
  if (!strcmp(argv[num], "-fog_normal")) {
    opt->fogmode  = RT_FOG_NORMAL;
    return 1;
  }
  if (!strcmp(argv[num], "-fog_vmd")) {
    opt->fogmode  = RT_FOG_VMD;
    return 1;
  }
  if (!strcmp(argv[num], "-res")) {
    sscanf(argv[num + 1], "%d", &opt->xsize);
    sscanf(argv[num + 2], "%d", &opt->ysize);
    return 3;
  }
  if (!strcmp(argv[num], "-cropoutputauto")) {
    opt->cropmode = 2; /* SPECMPI automatic mode */
    return 1;
  }
  if (!strcmp(argv[num], "-cropoutput")) {
    opt->cropmode = 1;
    sscanf(argv[num + 1], "%d", &opt->cropxres);
    sscanf(argv[num + 2], "%d", &opt->cropyres);
    sscanf(argv[num + 3], "%d", &opt->cropxstart);
    sscanf(argv[num + 4], "%d", &opt->cropystart);
    return 5;
  }
  if (!strcmp(argv[num], "-clamp")) {
    opt->imgprocess = 0; /* clamp pixel values */
    return 1;
  }
  if (!strcmp(argv[num], "-normalize")) {
    opt->imgprocess = 1; /* normalize pixel values */
    return 1;
  }
  if (!strcmp(argv[num], "-gamma")) {
    opt->imgprocess = 2; /* normalize pixel values */
    sscanf(argv[num + 1], "%f", &opt->imggamma);
    return 2;
  } 
  if (!strcmp(argv[num], "-format")) {
    char str[80];
    sscanf(argv[num + 1], "%s", &str[0]);

    if (!compare(str, "TARGA")) {
      opt->outimageformat = RT_FORMAT_TARGA;
    } else if (!compare(str, "BMP")) {
      opt->outimageformat = RT_FORMAT_WINBMP;
    } else if (!compare(str, "PPM48")) {
      opt->outimageformat = RT_FORMAT_PPM48;
    } else if (!compare(str, "PPM")) {
      opt->outimageformat = RT_FORMAT_PPM;
    } else if (!compare(str, "PSD48")) {
      opt->outimageformat = RT_FORMAT_PSD48;
    } else if (!compare(str, "RGB")) {
      opt->outimageformat = RT_FORMAT_SGIRGB;
#if defined(USEJPEG)
    } else if (!compare(str, "JPEG")) {
      opt->outimageformat = RT_FORMAT_JPEG;
#endif
#if defined(USEPNG)
    } else if (!compare(str, "PNG")) {
      opt->outimageformat = RT_FORMAT_PNG;
#endif
    } else {
      if (node == 0) 
        printf("Unknown/Unsupported Image Format: %s, defaulting to Targa...\n", str);
    }
    return 2;
  }

  if (!strcmp(argv[num], "-spaceball")) {
    opt->spaceballon=1;
    return 1;
  }
  if (!strcmp(argv[num], "-spaceballport")) {
    sscanf(argv[num + 1], "%s", &opt->spaceballport[0]);
    return 2;
  }

  /* unknown parameter setting */
  if (node == 0) 
    printf("Unrecognized parameter/option flag: %s\n", argv[num]);

  return -1;
}

int getargs(int argc, char **argv, argoptions * opt, int node) {
  int i, rc;

  if (opt == NULL)
    return -1;

  if (argc < 2) {
    if (node == 0)
      printusage(argv);

    return -1;
  }

  initoptions(opt);  

  i = 1;
  while (i < argc) {
    if (argv[i][0] == '-' || argv[i][0] == '+') {
      rc = getparm(argc, argv, i, opt, node);
      if (rc != -1) {
        i += rc;
      } else {
        if (node == 0)
          printusage(argv);

        return -1;
      }
    }
    else {
      opt->filenames = (char **) realloc(opt->filenames, sizeof(char *) * (opt->numfiles + 10));
      opt->filenames[opt->numfiles] = 
        (char *) malloc(sizeof(char) * strlen(argv[i]) + 1);
      strcpy(opt->filenames[opt->numfiles], argv[i]);        

#if 0
{ int i; 
  for (i=0; i<opt->numfiles; i++) {
    printf("parsefile[%d]: %s\n", i, opt->filenames[i]);
  }
}
#endif

      opt->numfiles++;
      i++;
    }
  }

  if (opt->numfiles == 0) {
    if (node == 0) {
      printf("Missing model file name!\n");
      printusage(argv);
    } 
    return -1;
  }

  return 0;
}

void freeoptions(argoptions * opt) {
  if (opt->filenames != NULL) {
    int i;

    for (i=0; i<opt->numfiles; i++) {
      if (opt->filenames[i] != NULL)
        free(opt->filenames[i]);
    }

    free(opt->filenames);
  }
}