path: root/ArcWelderConsole/ArcWelderConsole.cpp

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Arc Welder: Anti-Stutter Console Application
//
// Compresses many G0/G1 commands into G2/G3(arc) commands where possible, ensuring the tool paths stay within the specified resolution.
// This reduces file size and the number of gcodes per second.
//
// Built using the 'Arc Welder: Anti Stutter' library
//
// Copyright(C) 2020 - Brad Hochgesang
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// This program is free software : you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published
// by the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
// GNU Affero General Public License for more details.
//
//
// You can contact the author at the following email address: 
// FormerLurker@pm.me
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#if _MSC_VER > 1200
#define _CRT_SECURE_NO_DEPRECATE
#endif
#include "ArcWelderConsole.h"
#include <cstring>
#include <iostream>
#include <sstream>
#include <iomanip>
#include "gcode_position.h"
#include <tclap/CmdLine.h>
#define DEFAULT_ARG_DOUBLE_PRECISION 4

int main(int argc, char* argv[])
{
  std::string source_file_path;
  std::string target_file_path;
  double resolution_mm;
  double max_radius_mm;
  double path_tolerance_percent;
  bool g90_g91_influences_extruder;
  bool hide_progress;
  bool overwrite_source_file = false;
  std::string log_level_string;
  std::string log_level_string_default = "INFO";
  int log_level_value;
  std::string version = "0.1.0";
  std::string info = "Arc Welder: Anti-Stutter - Reduces the number of gcodes per second sent to a 3D printer that supports arc commands (G2 G3)\nCopyright(C) 2020 - Brad Hochgesang";
  std::stringstream arg_description_stream;
  arg_description_stream << std::fixed << std::setprecision(5);
  // Extract arguments
  try {
    // Define the command line object
    TCLAP::CmdLine cmd(info, '=', version);

    // Define Arguments

    // <SOURCE>
    TCLAP::UnlabeledValueArg<std::string> source_arg("source", "The source gcode file to convert.", true, "", "path to source gcode file");

    // <TARGET>
    TCLAP::UnlabeledValueArg<std::string> target_arg("target", "The target gcode file containing the converted code.  If this is not supplied, the source path will be used and the source file will be overwritten.", false, "", "path to target gcode file");

    // -r --resolution-mm
    arg_description_stream << "The resolution in mm of the of the output.  Determines the maximum tool path deviation allowed during conversion. Default Value: " << DEFAULT_RESOLUTION_MM;
    TCLAP::ValueArg<double> resolution_arg("r", "resolution-mm", arg_description_stream.str(), false, DEFAULT_RESOLUTION_MM, "float");

    // -t --path-tolerance-percent
    arg_description_stream << "This is the maximum allowable difference between the arc path and the original toolpath.  Expressed as a decimal percent, where 0.01 = 1%. Default Value: " << ARC_LENGTH_PERCENT_TOLERANCE_DEFAULT;
    TCLAP::ValueArg<double> path_tolerance_percent_arg("t", "path-tolerance-percent", arg_description_stream.str(), false, DEFAULT_RESOLUTION_MM, "float");

    // -m --max-radius-mm
    arg_description_stream.clear();
    arg_description_stream.str("");
    arg_description_stream << "The maximum radius of any arc in mm. Default Value: " << DEFAULT_MAX_RADIUS_MM;
    TCLAP::ValueArg<double> max_radius_arg("m", "max-radius-mm", arg_description_stream.str(), false, DEFAULT_MAX_RADIUS_MM, "float");
    
    // -g --g90-influences-extruder
    TCLAP::SwitchArg g90_arg("g", "g90-influences-extruder", "If supplied, G90/G91 influences the extruder axis.", false);

    // -g --hide-progress
    TCLAP::SwitchArg hide_progress_arg("p", "hide-progress", "If supplied, prevents progress updates from being displayed.", false);

    // -l --log-level
    std::vector<std::string> log_levels_vector;
    log_levels_vector.push_back("NOSET");
    log_levels_vector.push_back("VERBOSE");
    log_levels_vector.push_back("DEBUG");
    log_levels_vector.push_back("INFO");
    log_levels_vector.push_back("WARNING");
    log_levels_vector.push_back("ERROR");
    log_levels_vector.push_back("CRITICAL");
    log_levels_vector.push_back("");
    TCLAP::ValuesConstraint<std::string> log_levels_constraint(log_levels_vector);
    arg_description_stream.clear();
    arg_description_stream.str("");
    arg_description_stream << "Sets console log level. Default Value: " << log_level_string_default; 
    TCLAP::ValueArg<std::string> log_level_arg("l", "log-level", arg_description_stream.str(), false, log_level_string_default, &log_levels_constraint);

    // Add all arguments
    cmd.add(source_arg);
    cmd.add(target_arg);
    cmd.add(resolution_arg);
    cmd.add(path_tolerance_percent_arg);
    cmd.add(max_radius_arg);
    cmd.add(g90_arg);
    cmd.add(hide_progress_arg);
    cmd.add(log_level_arg);

    // Parse the argv array.
    cmd.parse(argc, argv);

    // Get the value parsed by each arg. 
    source_file_path = source_arg.getValue();
    target_file_path = target_arg.getValue();

    if (target_file_path.size() == 0)
    {
      target_file_path = source_file_path;
    }

    resolution_mm = resolution_arg.getValue();
    max_radius_mm = max_radius_arg.getValue();
    path_tolerance_percent = path_tolerance_percent_arg.getValue();
    g90_g91_influences_extruder = g90_arg.getValue();
    hide_progress = hide_progress_arg.getValue();
    log_level_string = log_level_arg.getValue();
    log_level_value = -1;

    // Check the entered values
    bool has_error = false;
    if (resolution_mm <= 0)
    {
      std::cerr << "error: The provided resolution of " << resolution_mm << " is negative, which is not allowed." <<std::endl;
      has_error = true;
    }
    
    if (path_tolerance_percent <= 0)
    {
      std::cerr << "error: The provided path tolerance percentage of " << path_tolerance_percent << " is negative, which is not allowed." << std::endl;
      has_error = true;
    }

    if (max_radius_mm > 1000000)
    {
      // warning
      std::cout << "warning: The provided path max radius of " << max_radius_mm << "mm is greater than 1000000 (1km), which is not recommended." << std::endl;
    }

    if (path_tolerance_percent > 0.05)
    {
      // warning
      std::cout << "warning: The provided path tolerance percent of " << path_tolerance_percent << " is greater than 0.05 (5%), which is not recommended." << std::endl;
    }
    else if (path_tolerance_percent < 0.0001 && path_tolerance_percent > 0)
    {
      // warning
      std::cout << "warning: The provided path tolerance percent of " << path_tolerance_percent << " is less than greater than 0.001 (0.1%), which is not recommended." << std::endl;
    }

    if (has_error)
    {
      return 1;
    }

    for (unsigned int log_name_index = 0; log_name_index < log_level_names_size; log_name_index++)
    {
      if (log_level_string == log_level_names[log_name_index])
      {
        log_level_value = log_level_values[log_name_index];
        break;
      }
    }
    if (log_level_value == -1)
    {
      // TODO:  Does this work?
      throw new TCLAP::ArgException("Unknown log level");
    }

  }
  // catch argument exceptions
  catch (TCLAP::ArgException& e)
  {
    std::cerr << "error: " << e.error() << " for arg " << e.argId() << std::endl;
    return 1;
  }
  
  // Ensure the log level name is valid
  
  std::vector<std::string> log_names;
  log_names.push_back("arc_welder.gcode_conversion");
  std::vector<int> log_levels;
  log_levels.push_back(log_levels::DEBUG);
  logger* p_logger = new logger(log_names, log_levels);
  p_logger->set_log_level_by_value(log_level_value);

  std::stringstream log_messages;
  std::string temp_file_path = "";
  log_messages << std::fixed << std::setprecision(DEFAULT_ARG_DOUBLE_PRECISION);
  if (source_file_path == target_file_path)
  {
    overwrite_source_file = true;
    if (!utilities::get_temp_file_path_for_file(source_file_path, temp_file_path))
    {
      log_messages << "The source and target path are the same, but a temporary file path could not be created.  Is the path empty?";
      p_logger->log(0, INFO, log_messages.str());
      log_messages.clear();
      log_messages.str("");
    }

    // create a uuid with a tmp extension for the temporary file

    log_messages << "Source and target path are the same.  The source file will be overwritten.  Temporary file path: " << target_file_path;
    p_logger->log(0, INFO, log_messages.str());
    log_messages.clear();
    log_messages.str("");
  }
  log_messages << "Processing Gcode\n";
  log_messages << "\tSource File Path             : " << source_file_path << "\n";
  if (overwrite_source_file)
  {
    log_messages << "\tTarget File Path (overwrite) : " << target_file_path << "\n";
    log_messages << "\tTemporary File Path          : " << temp_file_path << "\n";
  }
  else 
  {
    log_messages << "\tTarget File File             : " << target_file_path << "\n";
  }
  
  log_messages << "\tResolution                   : " << resolution_mm << "mm (+-" << std::setprecision(5) << resolution_mm/2.0 << "mm)\n";
  log_messages << "\tPath Tolerance               : " << std::setprecision(3) << path_tolerance_percent*100.0 << "%\n";
  log_messages << "\tMaximum Arc Radius in MM     : " << std::setprecision(0) << max_radius_mm << "\n";
  log_messages << "\tG90/G91 Influences Extruder  : " << (g90_g91_influences_extruder ? "True" : "False") << "\n";
  log_messages << "\tLog Level                    : " << log_level_string << "\n";
  log_messages << "\tHide Progress Updates        : " << (hide_progress ? "True" : "False");
  p_logger->log(0, INFO, log_messages.str());
  arc_welder* p_arc_welder = NULL;

  if (overwrite_source_file)
  {
    target_file_path = temp_file_path;
  }
  if (!hide_progress)
    p_arc_welder = new arc_welder(source_file_path, target_file_path, p_logger, resolution_mm, path_tolerance_percent, max_radius_mm, g90_g91_influences_extruder, 50, on_progress);
  else
    p_arc_welder = new arc_welder(source_file_path, target_file_path, p_logger, resolution_mm, path_tolerance_percent, max_radius_mm, g90_g91_influences_extruder, 50);

  arc_welder_results results = p_arc_welder->process();
  if (results.success)
  {
    log_messages.clear();
    log_messages.str("");
    log_messages << "Target file at '" << target_file_path << "' created.";

    if (overwrite_source_file)
    {
      log_messages.clear();
      log_messages.str("");
      log_messages << "Deleting the original source file at '" << source_file_path << "'.";
      p_logger->log(0, INFO, log_messages.str());
      log_messages.clear();
      log_messages.str("");
      std::remove(source_file_path.c_str());
      log_messages << "Renaming temporary file at '" << target_file_path << "' to '" << source_file_path <<"'.";
      p_logger->log(0, INFO, log_messages.str());
      std::rename(target_file_path.c_str(), source_file_path.c_str());
    }
    log_messages.clear();
    log_messages.str("");
    log_messages << std::endl << results.progress.segment_statistics.str();
    p_logger->log(0, INFO, log_messages.str() );
    
    log_messages.clear();
    log_messages.str("");
    log_messages << "Arc Welder process completed successfully.";
    p_logger->log(0, INFO, log_messages.str());
  }
  else
  {
    log_messages.clear();
    log_messages.str("");
    log_messages << "File processing failed.";
    p_logger->log(0, INFO, log_messages.str());
  }

  delete p_arc_welder;
  return 0;
}

static bool on_progress(arc_welder_progress progress, logger* p_logger, int logger_type)
{
  std::cout << "Progress: "<< progress.str() << std::endl;
  std::cout.flush();
  return true;
}