settings.hpp

Go to the documentation of this file.

#ifndef SETTINGS_HPP
#define SETTINGS_HPP
 
#include "backend.hpp"
 
/**
 * @file settings.hpp
 * @brief Main capture/playback settings dialog for ACMX2 execution.
 */
 
#include <QCheckBox>
#include <QComboBox>
#include <QDialog>
#include <QDoubleSpinBox>
#include <QFileDialog>
#include <QGroupBox>
#include <QHBoxLayout>
#include <QLabel>
#include <QLineEdit>
#include <QMap>
#include <QPushButton>
#include <QRadioButton>
#include <QSet>
#include <QSpinBox>
#include <QVBoxLayout>
 
class QScrollArea;
 
/**
 * @brief Dialog that collects camera, input source, output, and runtime options.
 */
class SettingsWindow : public QDialog {
    Q_OBJECT
  public:
    /// @brief Construct the settings dialog.
    /// @param execPath Path to the selected backend used for capability discovery.
    /// @param backend Active rendering backend, used to expose compatible options.
    /// @param parent Parent widget.
    explicit SettingsWindow(const QString &execPath, acmx2::Backend backend, QWidget *parent = nullptr);
    /// @brief Show or hide CUDA-specific controls based on availability.
    /// @param available True when CUDA runtime/device support is available.
    void setCudaAvailable(bool available);
    /// @brief Enable or disable ONNX controls based on OpenCV DNN support.
    /// @param available True when OpenCV DNN support is compiled in.
    void setDnnAvailable(bool available);
    /// @return Selected camera device index.
    int getSelectedCameraIndex() const;
    /// @return Selected input camera resolution.
    QSize getSelectedCameraResolution() const;
    /// @return Selected output screen resolution.
    QSize getSelectedScreenResolution() const;
    /// @return Selected camera capture FPS.
    int getCameraFPS() const;
    /// @return Input video file path.
    QString getInputVideoFile() const;
    /// @return Output video file path.
    QString getOutputVideoFile() const;
    /// @return Graphics/video overlay file path.
    QString getGraphicsFile() const;
    /// @return True if input-video mode is selected.
    bool isUsingInputVideoFile() const;
    /// @return True if graphics-file mode is selected.
    bool isUsingGraphicsFile() const;
    /// @return True if save-to-file is enabled.
    bool isSavingToOutputVideoFile() const;
    /// @return True when the video render log should be saved beside its output file.
    bool isSavingOutputLog() const;
    /// @return True if HDR was detected in the currently selected input video.
    bool isInputHdrDetected() const;
    /// @return True if the user enabled the post-process HDR10 conversion.
    bool isConvertToHdr10Enabled() const;
    /// @return True if texture cache is enabled.
    bool isTextureCacheEnabled() const;
    /// @return Frame delay used by texture cache.
    int getCacheDelay() const;
    /// @return Ring buffer size for texture cache.
    int getCacheSize() const;
    /// @return True if fullscreen mode is enabled.
    bool isFullscreen() const;
    /// @return True if ACMXVK should render camera input at the selected FPS.
    bool isMaximizeFpsEnabled() const;
    /// @return True if ACMXVK should pace video using its reported frame rate.
    bool isUseSourceFpsEnabled() const;
    /// @return True if ACMXVK should use video audio for shader reactivity.
    bool isUseSourceAudioEnabled() const;
    /// @return True if input audio should be copied to output.
    bool isCopyAudioEnabled() const;
    /// @brief Return whether Write PNG mode is enabled.
    bool isPngOutputEnabled() const;
    /// @brief Return the directory used for ACMXVK PNG-sequence output.
    QString getPngOutputDirectory() const;
    /// @brief Return the selected ACMXVK PNG compression level.
    int getPngLevel() const;
    /// @return True if --generate &lt;N&gt; mode is enabled.
    bool isGenerateEnabled() const;
    /// @return Frame interval to pass with --generate.
    int getGenerateInterval() const;
    /// @return True if 3D rendering mode is enabled.
    bool is3dEnabled() const;
    /// @return True if YUV mode is enabled for selected resolution.
    bool isUseYuvEnabled() const;
    /// @return Selected 3D model file path.
    QString getModelFile() const;
    /// @return True if the ONNX model pass is enabled.
    bool isOnnxModelEnabled() const;
    /// @return Selected ONNX model YAML config path.
    QString getOnnxModelFile() const;
    /// @return Selected CUDA device index.
    int getSelectedCudaDevice() const;
    /// @return Time speed multiplier applied at runtime.
    float getTimeSpeed() const;
    /// @brief Return whether maximum duration limiting is enabled.
    bool isDurationLimitEnabled() const;
    /// @brief Return configured max run duration in seconds.
    double getDurationLimit() const;
    /// @brief Return whether maximum output-size limiting is enabled.
    bool isMaxSizeLimitEnabled() const;
    /// @brief Return configured maximum output size in MB.
    double getMaxSizeLimit() const;
    /// @brief Return crossfade duration between shader transitions.
    float getCrossFadeDuration() const;
    /// @brief Return whether flip mode is enabled.
    bool isFlipEnabled() const;
    /// @brief Return whether input-frame rotation is enabled.
    bool is_rotate_enabled() const;
    /// @brief Return the selected rotation token for --rotate.
    QString get_rotation_mode() const;
    /// @brief Resolve display name for a camera device index.
    /// @param device_index Camera device index.
    /// @return Human-readable camera name.
    QString getCameraName(int device_index);
 
    /// @return Selected software or NVENC encoder preset name.
    QString getEncodePreset() const;
    /// @return Selected encoder tune (empty for "none").
    QString getEncodeTune() const;
    /// @return Selected encoder CRF value (0..51).
    int getEncodeCrf() const;
    /// @return Encoding rate-control mode: quality or bitrate.
    QString getEncodeRateControl() const;
    /// @return Target video bitrate text, such as 10M.
    QString getEncodeBitrate() const;
    /// @return Selected encoder codec preference (auto/software/nvenc).
    QString getEncodeCodec() const;
    /// @return Additional FFmpeg-style video encoder parameters.
    QString getEncodeParameters() const;
    /// @return True if realtime low-latency encoding is enabled.
    bool isEncodeRealtime() const;
    /// @return True if no-drop encoder backpressure mode is enabled.
    bool isEncodeNoDrop() const;
    /// @return True if sequential constant-frame-rate encoding is enabled.
    bool isEncodeConstantFrameRate() const;
    /// @return True if source PTS gaps should be filled with held frames.
    bool isEncodeFillPtsGaps() const;
  private slots:
    void acceptSettings();
    void rejectSettings();
    void browseInputVideoFile();
    void browseOutputVideoFile();
    void browsePngOutputDirectory();
    void browseGraphicsFile();
    void browseModelFile();
    void browseOnnxModelFile();
    /// @brief Display the AVOptions reported by the selected FFmpeg encoder.
    void showEncoderOptions();
    /// @brief Probe the currently selected input video file with ffprobe and
    ///        update HDR-related UI state (status label, HDR10 checkbox).
    void detectInputHdr();
    /// @brief React to camera-device combo selection changes.
    /// @param comboIndex Selected combo-box index.
    void onCameraDeviceChanged(int comboIndex);
    /// @brief React to camera-resolution selection changes.
    /// @param comboIndex Selected combo-box index.
    void onCameraResolutionChanged(int comboIndex);
 
  private:
    void init();
    void loadUiState();
    void saveUiState();
    void populateCameraDevices();
    void populateCudaDevices();
    /// @brief Populate exact encoder names by querying the selected backend executable.
    void populateVideoEncoders(const QString &savedEncoder);
    /// @brief Refresh the selected encoder description and option-button state.
    void updateEncoderDetails();
    /// @brief Query resolutions and FPS capabilities for one camera device.
    /// @param deviceIndex Camera device index to inspect.
    void enumerateDevice(int deviceIndex);
    void populateResolutions();
    void populateFPS();
 
    QString executablePath;
    acmx2::Backend activeBackend = acmx2::Backend::Acmx2;
    QComboBox *cameraFPSComboBox;
    // resolution -> list of FPS values
    QMap<QString, QList<double>> deviceCapabilities;
    QSet<QString> yuvResolutions;
 
    QComboBox *cameraIndexComboBox;
    QComboBox *cameraResolutionComboBox;
    QComboBox *screenResolutionComboBox;
    QPushButton *okButton;
    QPushButton *cancelButton;
    QLineEdit *inputVideoFileLineEdit;
    QPushButton *browseInputVideoButton;
    QLabel *hdrStatusLabel = nullptr;
    QCheckBox *convertHdr10CheckBox = nullptr;
    QLineEdit *outputVideoFileLineEdit;
    QPushButton *browseOutputVideoButton;
    QLineEdit *pngOutputDirectoryLineEdit = nullptr;
    QPushButton *browsePngOutputDirectoryButton = nullptr;
    QLineEdit *graphicsFileLineEdit;
    QPushButton *browseGraphicsButton;
    QRadioButton *cameraOptionRadioButton;
    QRadioButton *inputVideoOptionRadioButton;
    QRadioButton *graphicsFileOptionRadioButton;
    QCheckBox *saveOutputVideoCheckBox;
    QCheckBox *saveOutputLogCheckBox = nullptr;
    QCheckBox *textureCacheCheckBox;
    QSpinBox *cacheDelaySpinBox;
    QSpinBox *cacheSizeSpinBox;
    QCheckBox *fullscreenCheckBox;
    QCheckBox *maximizeFpsCheckBox = nullptr;
    QCheckBox *useSourceFpsCheckBox = nullptr;
    QCheckBox *useSourceAudioCheckBox = nullptr;
    QCheckBox *copyAudioCheckBox;
    QCheckBox *enable3dCheckBox;
    QCheckBox *useYuvCheckBox;
    QLineEdit *modelFileLineEdit;
    QPushButton *browseModelButton;
    QLabel *onnxModelLabel = nullptr;
    QCheckBox *useOnnxModelCheckBox;
    QLineEdit *onnxModelFileLineEdit;
    QPushButton *browseOnnxModelButton;
    QComboBox *cudaDeviceComboBox;
    QLabel *cudaDeviceLabel = nullptr;
    QDoubleSpinBox *timeSpeedSpinBox;
    QCheckBox *durationLimitCheckBox;
    QDoubleSpinBox *durationLimitSpinBox;
    QCheckBox *maxSizeLimitCheckBox;
    QDoubleSpinBox *maxSizeLimitSpinBox;
    QDoubleSpinBox *crossFadeSpinBox;
    QCheckBox *flipCheckBox;
    QCheckBox *rotate_check_box;
    QComboBox *rotate_combo_box;
 
    QComboBox *encodePresetComboBox = nullptr;
    QComboBox *encodeTuneComboBox = nullptr;
    QSpinBox *encodeCrfSpinBox = nullptr;
    QComboBox *encodeRateControlComboBox = nullptr;
    QLineEdit *encodeBitrateLineEdit = nullptr;
    QComboBox *encodeCodecComboBox = nullptr;
    QLabel *encodeCodecDetailsLabel = nullptr;
    QPushButton *encodeOptionsButton = nullptr;
    QLineEdit *encodeParametersLineEdit = nullptr;
    QCheckBox *encodeRealtimeCheckBox = nullptr;
    QCheckBox *encodeNoDropCheckBox = nullptr;
    QCheckBox *encodeConstantFrameRateCheckBox = nullptr;
    QCheckBox *encodeFillPtsGapsCheckBox = nullptr;
    QCheckBox *writePngCheckBox = nullptr;
    QComboBox *pngLevelComboBox = nullptr;
    QCheckBox *generateCheckBox = nullptr;
    QSpinBox *generateIntervalSpinBox = nullptr;
    QScrollArea *settingsScrollArea = nullptr;
    QWidget *settingsContent = nullptr;
 
    // Responsive layout: groups are reflowed between 1 and 2 columns
    // depending on the dialog width when the user resizes the window.
    QHBoxLayout *groupsRow = nullptr;
    QVBoxLayout *leftColumn = nullptr;
    QVBoxLayout *rightColumn = nullptr;
    QList<QGroupBox *> reflowGroups;
    int currentColumnCount = 0;
    void reflowGroupColumns(int columns);
 
  protected:
    void resizeEvent(QResizeEvent *event) override;
 
  private:
    int selectedCameraIndex;
    QSize selectedCameraResolution;
    QSize selectedScreenResolution;
    int cameraFPS;
    QString inputVideoFile;
    QString outputVideoFile;
    QString pngOutputDirectory;
    bool useInputVideoFile;
    bool useGraphicsFile;
    bool saveOutputVideoFile;
    bool saveOutputLog = false;
    QString graphicsFile;
    int graphicsDuration;
    QString modelFile;
    QString onnxModelFile;
    bool dnnAvailable = true;
    int selectedCudaDevice;
    double maxDuration;
    double maxSizeLimit;
    bool inputHdrDetected = false;
    QString preferredFpsText = "30";
};
 
#endif