/* ScummVM Tools * * ScummVM Tools is the legal property of its developers, whose names * are too numerous to list here. Please refer to the COPYRIGHT * file distributed with this source distribution. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * */ /* All the pages in the wizard */ #include "wx/wxprec.h" #ifdef __BORLANDC__ #pragma hdrstop #endif #ifndef WX_PRECOMP #include "wx/wx.h" #endif #include #include #include #include #include #include "main.h" #include "pages.h" #include "gui_tools.h" BEGIN_EVENT_TABLE(WizardPage, wxEvtHandler) END_EVENT_TABLE() WizardPage::WizardPage(Configuration &config) : _configuration(config), _topframe(NULL) { } void WizardPage::SetScummFrame(ScummToolsFrame *topframe) { _topframe = topframe; } wxWindow *WizardPage::CreatePanel(wxWindow *parent) { return new wxPanel(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxBORDER_NONE, wxT("Wizard Page")); } void WizardPage::switchPage(WizardPage *next) { _topframe->switchPage(next); } void WizardPage::updateButtons(wxWindow *panel, WizardButtons *buttons) { // Do nothing, keep default button state } void WizardPage::SetAlignedSizer(wxWindow *panel, wxSizer *sizer) { wxSizer *topsizer = new wxBoxSizer(wxHORIZONTAL); topsizer->AddSpacer(100); topsizer->Add(sizer, wxSizerFlags(1).Expand().Border()); panel->SetSizer(topsizer); } // Our default handler for next/prev/cancel void WizardPage::onNext(wxWindow *panel) { wxASSERT_MSG(_topframe != NULL, wxT("Can not call onNext without topframe set.")); } void WizardPage::onPrevious(wxWindow *panel) { wxASSERT_MSG(_topframe != NULL, wxT("Can not call onPrevious without topframe set.")); _topframe->switchToPreviousPage(); } bool WizardPage::onCancel(wxWindow *panel) { wxASSERT_MSG(_topframe != NULL, wxT("Can not call onCancel without topframe set.")); wxMessageDialog dlg(panel, wxT("Are you sure you want to abort the wizard?"), wxT("Abort"), wxYES | wxNO); wxWindowID ret = dlg.ShowModal(); if (ret == wxID_YES) { _topframe->Close(true); return true; } return false; } // Load/Save settings void WizardPage::save(wxWindow *panel) { } bool WizardPage::onIdle(wxPanel *panel) { return false; } // Get the help text wxString WizardPage::getHelp() { return wxT("Sorry.\nThere is no additional help for this page."); } // Introduction page BEGIN_EVENT_TABLE(IntroPage, WizardPage) EVT_BUTTON(ID_COMPRESS, IntroPage::onClickCompress) EVT_BUTTON(ID_EXTRACT, IntroPage::onClickExtract) EVT_BUTTON(ID_ADVANCED, IntroPage::onClickAdvanced) END_EVENT_TABLE() IntroPage::IntroPage(Configuration &config) : WizardPage(config) { } wxWindow *IntroPage::CreatePanel(wxWindow *parent) { wxWindow *panel = WizardPage::CreatePanel(parent); wxSizer *sizer = new wxBoxSizer(wxVERTICAL); sizer->AddSpacer(15); sizer->Add(new wxStaticText(panel, wxID_ANY, wxT("Welcome to the ScummVM extraction and compression utility.\nWhat do you want to do?"))); sizer->AddSpacer(15); wxFlexGridSizer *buttonSizer = new wxFlexGridSizer(2, 3, 10, 25); buttonSizer->SetFlexibleDirection(wxVERTICAL); // Compress button wxButton *compressButton = new wxButton(panel, ID_COMPRESS, wxT("Compress")); buttonSizer->Add(compressButton, wxSizerFlags().Expand()); compressButton->Connect(wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler(IntroPage::onClickCompress), NULL, this); // Extract button wxButton *extractButton = new wxButton(panel, ID_EXTRACT, wxT("Extract")); buttonSizer->Add(extractButton, wxSizerFlags().Expand()); extractButton->Connect(wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler(IntroPage::onClickExtract), NULL, this); // Advanced button wxButton *advancedButton = new wxButton(panel, ID_ADVANCED, wxT("Advanced")); buttonSizer->Add(advancedButton, wxSizerFlags().Expand()); advancedButton->Connect(wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler(IntroPage::onClickAdvanced), NULL, this); // Compress Label wxStaticText *compressLabel = new wxStaticText( panel, wxID_ANY, wxT("Compress game audio files into archives."), wxDefaultPosition, wxDefaultSize, wxALIGN_CENTER ); compressLabel->Wrap(110); buttonSizer->Add(compressLabel, wxSizerFlags().Align(wxALIGN_CENTER_HORIZONTAL)); // Extract Label wxStaticText *extractLabel = new wxStaticText( panel, wxID_ANY, wxT("Extract the contents of archive files."), wxDefaultPosition, wxDefaultSize, wxALIGN_CENTER ); extractLabel->Wrap(110); buttonSizer->Add(extractLabel, wxSizerFlags().Align(wxALIGN_CENTER_HORIZONTAL)); // Advanced Label wxStaticText *advancedLabel = new wxStaticText( panel, wxID_ANY, wxT("Choose the precise tool you want to use."), wxDefaultPosition, wxDefaultSize, wxALIGN_CENTER ); advancedLabel->Wrap(110); buttonSizer->Add(advancedLabel, wxSizerFlags().Align(wxALIGN_CENTER_HORIZONTAL)); sizer->Add(buttonSizer); SetAlignedSizer(panel, sizer); return panel; } wxString IntroPage::getHelp() { return wxT("Select the activity you would like to do. In order to play your game.\nMost common usage is compression of game files."); } void IntroPage::updateButtons(wxWindow *panel, WizardButtons *buttons) { buttons->setLineLabel(wxT("ScummVM Tools")); buttons->showNavigation(false); WizardPage::updateButtons(panel, buttons); } void IntroPage::onClickCompress(wxCommandEvent &e) { _configuration.compressing = true; _configuration.advanced = false; switchPage(new ChooseInPage(_configuration)); } void IntroPage::onClickExtract(wxCommandEvent &e) { _configuration.compressing = false; _configuration.advanced = false; switchPage(new ChooseInPage(_configuration)); } void IntroPage::onClickAdvanced(wxCommandEvent &e) { _configuration.advanced = true; switchPage(new ChooseToolPage(_configuration)); } // Page to choose the tool to use ChooseToolPage::ChooseToolPage(Configuration &config, const wxArrayString &options) : WizardPage(config), _options(options) { } wxWindow *ChooseToolPage::CreatePanel(wxWindow *parent) { wxWindow *panel = WizardPage::CreatePanel(parent); wxSizer *sizer = new wxBoxSizer(wxVERTICAL); sizer->AddSpacer(15); wxArrayString choices; if (!_options.empty()) { sizer->Add(new wxStaticText(panel, wxID_ANY, wxT("There are multiple possible tools for this input, please select the correct one.\n\n") wxT("If none of the tools appear to match, you probably supplied the wrong file."))); choices = _options; } else { sizer->Add(new wxStaticText(panel, wxID_ANY, wxT("Select what tool you'd like to use."))); choices = g_tools.getToolList(TOOLTYPE_ALL); } wxString toolname = choices.front(); sizer->AddSpacer(20); wxChoice *tool = new wxChoice(panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, choices, 0, wxDefaultValidator, wxT("ToolSelection")); tool->Connect(wxEVT_COMMAND_CHOICE_SELECTED, wxCommandEventHandler(ChooseToolPage::onChangeTool), NULL, this); tool->SetClientData(tool); tool->SetSelection(0); wxSizer *toolsizer = new wxBoxSizer(wxHORIZONTAL); toolsizer->Add(tool, wxSizerFlags(2).Expand()); toolsizer->Add(20, 20, 1, wxEXPAND); sizer->Add(toolsizer, wxSizerFlags().Expand()); sizer->AddSpacer(20); wxStaticText *text = new wxStaticText(panel, wxID_ANY, wxT(""), wxDefaultPosition, wxDefaultSize, wxST_NO_AUTORESIZE, wxT("ToolText")); sizer->Add(text, wxFIXED_MINSIZE); SetAlignedSizer(panel, sizer); // Load configuration const ToolGUI *selected = _configuration.selectedTool; if (selected == NULL) selected = g_tools.get(tool->GetStringSelection()); tool->SetStringSelection(selected->getName()); text->SetLabel(selected->getShortHelp()); return panel; } void ChooseToolPage::save(wxWindow *panel) { _configuration.selectedTool = g_tools.get(static_cast(panel->FindWindowByName(wxT("ToolSelection")))->GetStringSelection()); // Check if we should strip the input file names. if (_configuration.selectedTool != NULL) { wxArrayString filelist = _configuration.inputFilePaths; for (unsigned int i = 0 ; i < filelist.size() ; ++i) { Common::Filename filename = (const char *)filelist[i].mb_str(); Common::Filename dirname = filename.getPath(); if (_configuration.selectedTool->_backend->inspectInput(filename) == IMATCH_AWFUL && _configuration.selectedTool->_backend->inspectInput(dirname) != IMATCH_AWFUL) _configuration.inputFilePaths[i] = wxString(dirname.getFullPath().c_str(), wxConvFile); } } } wxString ChooseToolPage::getHelp() { return wxT("Select the tool you want to use.\nRead the short description below the dropdown box for a short hint on what the tool does."); } void ChooseToolPage::onNext(wxWindow *panel) { const ToolGUI *tool = g_tools.get(static_cast(panel->FindWindowByName(wxT("ToolSelection")))->GetStringSelection()); if (_configuration.advanced || (tool && tool->getInputList().size() > _configuration.inputFilePaths.size())) switchPage(new ChooseExtraInPage(_configuration)); else switchPage(new ChooseOutPage(_configuration)); } void ChooseToolPage::onPrevious(wxWindow *panel) { _configuration.selectedTool = NULL; WizardPage::onPrevious(panel); } void ChooseToolPage::onChangeTool(wxCommandEvent &evt) { wxChoice *tool = dynamic_cast(evt.GetEventObject()); wxStaticText *text = dynamic_cast(tool->GetParent()->FindWindowByName(wxT("ToolText"))); text->SetLabel(g_tools[tool->GetStringSelection()].getShortHelp()); } void ChooseToolPage::updateButtons(wxWindow *panel, WizardButtons *buttons) { buttons->setLineLabel(wxT("ScummVM Tools")); WizardPage::updateButtons(panel, buttons); } // Common base class for the IO pages ChooseIOPage::ChooseIOPage(Configuration &config) : WizardPage(config) { } void ChooseIOPage::onSelectFile(wxFileDirPickerEvent &evt) { wxASSERT_MSG(_topframe != NULL, wxT("Can not call onSelectFile without topframe set.")); wxWindow *win = dynamic_cast(evt.GetEventObject()); wxPanel *panel = dynamic_cast(win->GetParent()); updateButtons(panel, _topframe->_buttons); } void ChooseIOPage::updateButtons(wxWindow *panel, WizardButtons *buttons) { wxWindow *picker = NULL; if (!picker) picker = panel->FindWindowByName(wxT("InputPicker")); const ToolGUI *tool = _configuration.selectedTool; if (tool && !picker) { for (size_t i = 0; i < tool->getInputList().size(); ++i) { wxString name(wxT("InputPicker")); name << i; picker = panel->FindWindowByName(name); if (picker) break; } } if (!picker) picker = panel->FindWindowByName(wxT("OutputPicker")); wxDirPickerCtrl *inDirWindow = dynamic_cast(picker); wxFilePickerCtrl *inFileWindow = dynamic_cast(picker); buttons->enableNext( (inDirWindow && inDirWindow->GetPath().size() > 0) || (inFileWindow && inFileWindow->GetPath().size() > 0)); WizardPage::updateButtons(panel, buttons); } // Page to choose input directory or file ChooseInPage::ChooseInPage(Configuration &config) : ChooseIOPage(config) { } wxWindow *ChooseInPage::CreatePanel(wxWindow *parent) { wxWindow *panel = WizardPage::CreatePanel(parent); wxSizer *sizer = new wxBoxSizer(wxVERTICAL); sizer->AddSpacer(15); // some help perhaps? sizer->Add(new wxStaticText(panel, wxID_ANY, wxT("Select an input file, if you have two input files (CD1 and CD2), ") wxT("you will be queried for the other file later.") wxT("You can also drag && drop a file on this window.") ), wxSizerFlags(1).Expand()); sizer->AddSpacer(10); // Always ask for a file here. When checking the input it will also check the // directory for tools that expect a directory as input. wxSizer *pickersizer = new wxBoxSizer(wxHORIZONTAL); wxFilePickerCtrl *picker = new wxFilePickerCtrl( panel, wxID_ANY, wxEmptyString, wxT("Select a file"), wxT("*.*"), wxDefaultPosition, wxSize(300, -1), wxFLP_USE_TEXTCTRL | wxFLP_OPEN, wxDefaultValidator, wxT("InputPicker")); panel->Connect(wxEVT_COMMAND_FILEPICKER_CHANGED, wxFileDirPickerEventHandler(ChooseIOPage::onSelectFile), NULL, this); if (_configuration.inputFilePaths.size() > 0) picker->SetPath(_configuration.inputFilePaths[0]); pickersizer->Add(picker, wxSizerFlags(2).Expand()); pickersizer->Add(20, 20, 1, wxEXPAND); sizer->Add(pickersizer, wxSizerFlags().Expand()); wxCheckBox *multiRun = new wxCheckBox(panel, wxID_ANY, wxT("Run on all files with the same extension"), wxDefaultPosition, wxDefaultSize, 0, wxDefaultValidator, wxT("MultipleRuns")); sizer->Add(multiRun); sizer->AddSpacer(30); SetAlignedSizer(panel, sizer); return panel; } void ChooseInPage::save(wxWindow *panel) { _configuration.inputFilePaths.clear(); wxFilePickerCtrl *inFileWindow = dynamic_cast(panel->FindWindowByName(wxT("InputPicker"))); Common::Filename filename = (const char *)inFileWindow ->GetPath().mb_str(); // Check if we should strip the file name. // We do it only if the tools is known and it expects a directory as input. if (_configuration.selectedTool != NULL) { Common::Filename dirname = filename.getPath(); if (_configuration.selectedTool->_backend->inspectInput(filename) == IMATCH_AWFUL && _configuration.selectedTool->_backend->inspectInput(dirname) != IMATCH_AWFUL) filename = dirname; } _configuration.inputFilePaths.Add(wxString(filename.getFullPath().c_str(), wxConvFile)); wxCheckBox *multiRun = dynamic_cast(panel->FindWindowByName(wxT("MultipleRuns"))); _configuration.multipleRuns = multiRun->GetValue(); } void ChooseInPage::onNext(wxWindow *panel) { wxFilePickerCtrl *inFileWindow = dynamic_cast(panel->FindWindowByName(wxT("InputPicker"))); Common::Filename filename = (const char *)inFileWindow ->GetPath().mb_str(); if (_configuration.advanced) { if (_configuration.selectedTool->getInputList().size() > 1) switchPage(new ChooseExtraInPage(_configuration)); else switchPage(new ChooseOutPage(_configuration)); } else { wxArrayString ls = g_tools.getToolList(filename, _configuration.compressing ? TOOLTYPE_COMPRESSION : TOOLTYPE_EXTRACTION); if (ls.size() == 1) { _configuration.selectedTool = g_tools.get(ls[0]); if (_configuration.selectedTool->getInputList().size() == 1) switchPage(new ChooseOutPage(_configuration)); else switchPage(new ChooseExtraInPage(_configuration)); } else { switchPage(new ChooseToolPage(_configuration, ls)); } } } void ChooseInPage::onPrevious(wxWindow *panel) { _configuration.inputFilePaths.clear(); _configuration.multipleRuns = false; ChooseIOPage::onPrevious(panel); } wxString ChooseInPage::getHelp() { return wxT("Choose the input file.\n\nIf you are unsure, a general hint ") wxT("is to select the file with an extension that is different from ") wxT("all other files in the selected directory."); } void ChooseInPage::updateButtons(wxWindow *panel, WizardButtons *buttons) { if (!_configuration.advanced) buttons->setLineLabel(wxT("ScummVM Tools")); ChooseIOPage::updateButtons(panel, buttons); } // Page to choose input and output directory or file ChooseExtraInPage::ChooseExtraInPage(Configuration &config) : ChooseIOPage(config) { } wxWindow *ChooseExtraInPage::CreatePanel(wxWindow *parent) { wxWindow *panel = WizardPage::CreatePanel(parent); wxSizer *sizer = new wxBoxSizer(wxVERTICAL); sizer->AddSpacer(15); const ToolGUI &tool = *_configuration.selectedTool; // some help perhaps? sizer->Add(new wxStaticText(panel, wxID_ANY, tool.getHelp())); sizer->AddSpacer(10); // Work out which files are already set tool._backend->clearInputPaths(); wxArrayString filelist = _configuration.inputFilePaths; for (unsigned int i = 0 ; i < filelist.size() ; ++i) tool._backend->addInputPath((const char *)filelist[i].mb_str()); // Create input selection wxSizer *inputbox = new wxBoxSizer(wxHORIZONTAL); wxStaticBoxSizer *inputsizer = new wxStaticBoxSizer(wxVERTICAL, panel, wxT("Input files")); const ToolInputs &inputs = tool.getInputList(); int i = 0; for (ToolInputs::const_iterator iter = inputs.begin(); iter != inputs.end(); ++iter, ++i) { const ToolInput &input = *iter; wxString windowName = wxT("InputPicker"); windowName << i; wxString inputFile; if (!input.path.empty()) inputFile = wxString(input.path.c_str(), wxConvFile); if (input.file) { inputsizer->Add(new wxFilePickerCtrl( panel, wxID_ANY, inputFile, wxT("Select a file"), wxString(input.format.c_str(), wxConvUTF8), wxDefaultPosition, wxDefaultSize, wxFLP_USE_TEXTCTRL | wxDIRP_DIR_MUST_EXIST, wxDefaultValidator, windowName), wxSizerFlags().Expand()); panel->Connect(wxEVT_COMMAND_FILEPICKER_CHANGED, wxFileDirPickerEventHandler(ChooseIOPage::onSelectFile), NULL, this); } else { inputsizer->Add(new wxDirPickerCtrl( panel, wxID_ANY, inputFile, wxT("Select a folder"), wxDefaultPosition, wxDefaultSize, wxFLP_USE_TEXTCTRL | wxFLP_OPEN, wxDefaultValidator, windowName), wxSizerFlags().Expand()); panel->Connect(wxEVT_COMMAND_DIRPICKER_CHANGED, wxFileDirPickerEventHandler(ChooseIOPage::onSelectFile), NULL, this); } } inputbox->Add(inputsizer, wxSizerFlags(2).Expand()); inputbox->Add(20, 20, 1, wxEXPAND); sizer->Add(inputbox, wxSizerFlags().Expand()); SetAlignedSizer(panel, sizer); return panel; } void ChooseExtraInPage::save(wxWindow *panel) { wxWindow *outputWindow = panel->FindWindowByName(wxT("OutputPicker")); wxDirPickerCtrl *outDirWindow = dynamic_cast(outputWindow); wxFilePickerCtrl *outFileWindow = dynamic_cast(outputWindow); if (outDirWindow) _configuration.outputPath = outDirWindow->GetPath(); if (outFileWindow) _configuration.outputPath = outFileWindow->GetPath(); const ToolGUI &tool = *_configuration.selectedTool; // Remove all inputs _configuration.inputFilePaths.clear(); int i = 0; ToolInputs inputs = tool.getInputList(); for (ToolInputs::const_iterator iter = inputs.begin(); iter != inputs.end(); ++iter, ++i) { wxString windowName = wxT("InputPicker"); windowName << i; wxDirPickerCtrl *inDirWindow = dynamic_cast(panel->FindWindowByName(windowName)); wxFilePickerCtrl *inFileWindow = dynamic_cast(panel->FindWindowByName(windowName)); if (inDirWindow) _configuration.inputFilePaths.Add(inDirWindow ->GetPath()); if (inFileWindow) _configuration.inputFilePaths.Add(inFileWindow->GetPath()); } } wxString ChooseExtraInPage::getHelp() { return wxT("Select all input files or directories for this tool."); } void ChooseExtraInPage::onNext(wxWindow *panel) { switchPage(new ChooseOutPage(_configuration)); } // Page to choose input and output directory or file ChooseOutPage::ChooseOutPage(Configuration &config) : ChooseIOPage(config) { } wxWindow *ChooseOutPage::CreatePanel(wxWindow *parent) { wxWindow *panel = WizardPage::CreatePanel(parent); wxSizer *sizer = new wxBoxSizer(wxVERTICAL); sizer->AddSpacer(15); const ToolGUI &tool = *_configuration.selectedTool; // some help perhaps? sizer->Add(new wxStaticText(panel, wxID_ANY, wxT("Select an output directory (using tool ") + _configuration.selectedTool->getName() + wxT(").\n\n") + // FIXME: The following should *NOT* be shown to the user, but rather addressed by // us developers! // Indeed, either always ask for an output dir; or if that is not possible, then at least // show an appropriate hint text depending on whether the user has to select a directory // or something else. // FIXME: Be consistent "directories" vs "folders", pick one. wxT("Note: Some tools display file picker here, this should perhaps be changed to always ") + wxT("be directory output, since often don't want to name the output file.)") ), wxSizerFlags(1).Expand()); // Create input selection sizer->AddSpacer(10); // Create output selection wxSizer *colsizer = new wxBoxSizer(wxHORIZONTAL); if (tool.outputToDirectory()) { wxStaticBoxSizer *box = new wxStaticBoxSizer(wxHORIZONTAL, panel, wxT("Destination folder")); wxDirPickerCtrl *picker = new wxDirPickerCtrl( panel, wxID_ANY, _configuration.outputPath, wxT("Select a folder"), wxDefaultPosition, wxSize(300, -1), wxFLP_USE_TEXTCTRL | wxDIRP_DIR_MUST_EXIST, wxDefaultValidator, wxT("OutputPicker")); box->Add(picker, wxSizerFlags(1).Expand()); panel->Connect(wxEVT_COMMAND_DIRPICKER_CHANGED, wxFileDirPickerEventHandler(ChooseIOPage::onSelectFile), NULL, this); picker->SetPath(_configuration.outputPath); colsizer->Add(box, wxSizerFlags(2).Expand()); } else { wxStaticBoxSizer *box = new wxStaticBoxSizer(wxHORIZONTAL, panel, wxT("Destination file")); wxFilePickerCtrl *picker = new wxFilePickerCtrl( panel, wxID_ANY, _configuration.outputPath, wxT("Select a file"), wxT("*.*"), wxDefaultPosition, wxSize(300, -1), wxFLP_USE_TEXTCTRL | wxFLP_OVERWRITE_PROMPT | wxFLP_SAVE, wxDefaultValidator, wxT("OutputPicker")); box->Add(picker, wxSizerFlags(1).Expand()); panel->Connect(wxEVT_COMMAND_FILEPICKER_CHANGED, wxFileDirPickerEventHandler(ChooseIOPage::onSelectFile), NULL, this); picker->SetPath(_configuration.outputPath); colsizer->Add(box, wxSizerFlags(2).Expand()); } colsizer->Add(20, 20, 1, wxEXPAND); sizer->Add(colsizer, wxSizerFlags(0).Expand()); SetAlignedSizer(panel, sizer); return panel; } void ChooseOutPage::save(wxWindow *panel) { wxWindow *outputWindow = panel->FindWindowByName(wxT("OutputPicker")); wxDirPickerCtrl *outDirWindow = dynamic_cast(outputWindow); wxFilePickerCtrl *outFileWindow = dynamic_cast(outputWindow); if (outDirWindow) _configuration.outputPath = outDirWindow->GetPath(); if (outFileWindow) _configuration.outputPath = outFileWindow->GetPath(); } wxString ChooseOutPage::getHelp() { return wxT("Select the output path.\t\nIn most cases it's enough to select an output ") wxT("directory, and the tool will fill it with files.\nIf you must supply a file, ") wxT("the filename is not important.\nOther files in the directory will be overwritten ") wxT("without warnings."); } void ChooseOutPage::onNext(wxWindow *panel) { if (_configuration.selectedTool->getType() == TOOLTYPE_COMPRESSION) switchPage(new ChooseTargetPlatformPage(_configuration)); else switchPage(new ProcessPage(_configuration)); } // Page to choose input and output directory or file ChooseTargetPlatformPage::ChooseTargetPlatformPage(Configuration &config) : WizardPage(config) { } wxWindow *ChooseTargetPlatformPage::CreatePanel(wxWindow *parent) { wxWindow *panel = WizardPage::CreatePanel(parent); wxSizer *sizer = new wxBoxSizer(wxVERTICAL); sizer->AddSpacer(15); sizer->Add(new wxStaticText(panel, wxID_ANY, wxT("Select target platform (The platform ScummVM will run on)"))); sizer->AddSpacer(20); wxArrayString choices = _configuration.getTargetPlatforms(); wxChoice *platform = new wxChoice(panel, wxID_ANY, wxDefaultPosition, wxSize(80, -1), choices, 0, wxDefaultValidator, wxT("PlatformSelection")); sizer->Add(platform, wxSizerFlags().Expand().Border(wxRIGHT, 100)); SetAlignedSizer(panel, sizer); // Load already set values // We call with (0) first to set a default if the platform ain't in the list platform->SetSelection(0); platform->SetStringSelection(_configuration.selectedPlatform); return panel; } void ChooseTargetPlatformPage::save(wxWindow *panel) { wxChoice *platform = static_cast(panel->FindWindowByName(wxT("PlatformSelection"))); _configuration.selectedPlatform = platform->GetStringSelection(); _configuration.setPlatformDefaults(); } wxString ChooseTargetPlatformPage::getHelp() { return wxT("Choose the target platform.\n\nIf you do not know the target platform, ") wxT("simply select PC.\nThis only effects the audio settings (optimized defaults)."); } void ChooseTargetPlatformPage::onNext(wxWindow *panel) { switchPage(new ChooseAudioFormatPage(_configuration)); } // Page to choose input and output directory or file ChooseAudioFormatPage::ChooseAudioFormatPage(Configuration &config) : WizardPage(config) { } wxWindow *ChooseAudioFormatPage::CreatePanel(wxWindow *parent) { wxWindow *panel = WizardPage::CreatePanel(parent); wxSizer *sizer = new wxBoxSizer(wxVERTICAL); sizer->AddSpacer(15); sizer->Add(new wxStaticText(panel, wxID_ANY, wxT("Select audio format you want to compress to."))); sizer->AddSpacer(20); wxArrayString choices; const ToolGUI *tool = _configuration.selectedTool; if (tool->supportsAudioFormat(AUDIO_VORBIS)) choices.Add(wxT("Vorbis")); if (tool->supportsAudioFormat(AUDIO_FLAC)) choices.Add(wxT("FLAC")); if (tool->supportsAudioFormat(AUDIO_MP3)) choices.Add(wxT("MP3")); wxChoice *format = new wxChoice(panel, wxID_ANY, wxDefaultPosition, wxSize(80, -1), choices, 0, wxDefaultValidator, wxT("AudioSelection")); sizer->Add(format); sizer->AddSpacer(10); wxCheckBox *advanced = new wxCheckBox(panel, wxID_ANY, wxT("Select advanced audio settings"), wxDefaultPosition, wxDefaultSize, 0, wxDefaultValidator, wxT("AdvancedAudio")); sizer->Add(advanced); SetAlignedSizer(panel, sizer); // Load already set values if (_configuration.selectedAudioFormat == AUDIO_VORBIS) format->SetSelection(0); else if (_configuration.selectedAudioFormat == AUDIO_FLAC) format->SetSelection(1); else if (_configuration.selectedAudioFormat == AUDIO_MP3) format->SetSelection(2); advanced->SetValue(_configuration.advancedAudioSettings); return panel; } wxString ChooseAudioFormatPage::getHelp() { return wxT("Select audio format, for most platforms, Ogg Vorbis is preferred, as it's license free ") wxT("and GPL based will still offer great quality.\nNintendo DS and Dreamcast platforms only work with MP3 compression."); } void ChooseAudioFormatPage::save(wxWindow *panel) { wxChoice *format = static_cast(panel->FindWindowByName(wxT("AudioSelection"))); wxCheckBox *advanced = static_cast(panel->FindWindowByName(wxT("AdvancedAudio"))); if (format->GetStringSelection() == wxT("Vorbis")) _configuration.selectedAudioFormat = AUDIO_VORBIS; else if (format->GetStringSelection() == wxT("FLAC")) _configuration.selectedAudioFormat = AUDIO_FLAC; else if (format->GetStringSelection() == wxT("MP3")) _configuration.selectedAudioFormat = AUDIO_MP3; _configuration.advancedAudioSettings = advanced->GetValue(); } void ChooseAudioFormatPage::onNext(wxWindow *panel) { wxChoice *format = static_cast(panel->FindWindowByName(wxT("AudioSelection"))); wxCheckBox *advanced = static_cast(panel->FindWindowByName(wxT("AdvancedAudio"))); if (advanced->GetValue()) { if (format->GetStringSelection() == wxT("Vorbis")) switchPage(new ChooseAudioOptionsVorbisPage(_configuration)); else if (format->GetStringSelection() == wxT("FLAC")) switchPage(new ChooseAudioOptionsFlacPage(_configuration)); else if (format->GetStringSelection() == wxT("MP3")) switchPage(new ChooseAudioOptionsMp3Page(_configuration)); } else { // For MP3 we check if the lame path is valid otherwise we let the choice // to the user to either change the audio format or to go to the MP3 // options page (to set the lame path). if ( format->GetStringSelection() == wxT("MP3") && !Configuration::isLamePathValid(_configuration.mp3LamePath) ) { wxMessageDialog *msgDialog = new wxMessageDialog( NULL, wxT("The lame executable could not be found. It is needed to compress files to MP3. ") wxT("You can either proceed to the advanced audio settings page and give the path to lame ") wxT("or you can select another audio format to compress to.\n\n") wxT("Do you want to proceed to the advanced audio settings page?"), wxT("lame not found"), wxYES_NO | wxNO_DEFAULT | wxICON_EXCLAMATION ); int retval = msgDialog->ShowModal(); if (retval == wxID_YES) switchPage(new ChooseAudioOptionsMp3Page(_configuration)); return; } switchPage(new ProcessPage(_configuration)); } } // Page to choose Mp3 compression options ChooseAudioOptionsMp3Page::ChooseAudioOptionsMp3Page(Configuration &config) : WizardPage(config) { } wxWindow *ChooseAudioOptionsMp3Page::CreatePanel(wxWindow *parent) { wxWindow *panel = WizardPage::CreatePanel(parent); wxSizer *sizer = new wxBoxSizer(wxVERTICAL); /* "\nMP3 mode params:\n" " --lame-path Path to the lame executable to use (default: lame)\n" " -b is the target bitrate(ABR)/minimal bitrate(VBR) (default:" minBitrDef_str "%d)\n" " -B is the maximum VBR/ABR bitrate (default:%" maxBitrDef_str ")\n" " --vbr LAME uses the VBR mode (default)\n" " --abr LAME uses the ABR mode\n" \ " -V specifies the value (0 - 9) of VBR quality (0=best) (default:" vbrqualDef_str "%d)\n" " -q specifies the MPEG algorithm quality (0-9; 0=best) (default:" algqualDef_str ")\n" " --silent the output of LAME is hidden (default:disabled)\n" */ // Grid _gridSizer = new wxFlexGridSizer(7, 2, 10, 25); _gridSizer->AddGrowableCol(1); // Create output selection _gridSizer->Add(new wxStaticText(panel, wxID_ANY, wxT("Lame executable:"))); wxFilePickerCtrl *lamePicker = new wxFilePickerCtrl( panel, wxID_ANY, _configuration.outputPath, wxT("Select lame executable"), wxT("lame"), wxDefaultPosition, wxSize(250, -1), wxFLP_USE_TEXTCTRL | wxFLP_OPEN, wxDefaultValidator, wxT("LamePath") ); _gridSizer->Add(lamePicker, wxSizerFlags().Expand()); // Type of compression _gridSizer->Add(new wxStaticText(panel, wxID_ANY, wxT("Compression Type:"))); wxRadioButton *abrButton = new wxRadioButton(panel, wxID_ANY, wxT("ABR"), wxDefaultPosition, wxDefaultSize, 0, wxDefaultValidator, wxT("ABR")); wxSizer *radioSizer = new wxBoxSizer(wxHORIZONTAL); radioSizer->Add(abrButton); wxRadioButton *vbrButton = new wxRadioButton(panel, wxID_ANY, wxT("VBR"), wxDefaultPosition, wxDefaultSize, 0, wxDefaultValidator, wxT("VBR")); radioSizer->Add(vbrButton); _gridSizer->Add(radioSizer, wxSizerFlags().Expand()); // Bitrates const int possibleBitrateCount = 160 / 8; wxString possibleBitrates[possibleBitrateCount + 1]; for (int i = 0; i <= possibleBitrateCount; ++i) { possibleBitrates[i] << (i+1)*8; } _vbrMinBitrateLabel = new wxStaticText(panel, wxID_ANY, wxT("Minimum Bitrate:")); _gridSizer->Add(_vbrMinBitrateLabel); _vbrMinBitrate = new wxChoice( panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, possibleBitrateCount, possibleBitrates, 0, wxDefaultValidator, wxT("MinimumBitrate")); _gridSizer->Add(_vbrMinBitrate, wxSizerFlags().Expand().Border(wxRIGHT, 100)); _vbrMaxBitrateLabel = new wxStaticText(panel, wxID_ANY, wxT("Maximum Bitrate:")); _gridSizer->Add(_vbrMaxBitrateLabel); _vbrMaxBitrate = new wxChoice( panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, possibleBitrateCount, possibleBitrates, 0, wxDefaultValidator, wxT("MaximumBitrate")); _gridSizer->Add(_vbrMaxBitrate, wxSizerFlags().Expand().Border(wxRIGHT, 100)); _abrAvgBitrateLabel = new wxStaticText(panel, wxID_ANY, wxT("Average Bitrate:")); _gridSizer->Add(_abrAvgBitrateLabel); _abrAvgBitrate = new wxChoice( panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, possibleBitrateCount, possibleBitrates, 0, wxDefaultValidator, wxT("AverageBitrate")); _gridSizer->Add(_abrAvgBitrate, wxSizerFlags().Expand().Border(wxRIGHT, 100)); abrButton->Connect(wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEventHandler(ChooseAudioOptionsMp3Page::onChangeCompressionType), NULL, this); vbrButton->Connect(wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEventHandler(ChooseAudioOptionsMp3Page::onChangeCompressionType), NULL, this); // Quality const int possibleQualityCount = 9; wxString possibleQualities[possibleQualityCount + 1]; for (int i = 0; i <= possibleQualityCount; ++i) { possibleQualities[i] << i; } _vbrQualityLabel = new wxStaticText(panel, wxID_ANY, wxT("VBR Quality:")); _gridSizer->Add(_vbrQualityLabel); _vbrQuality = new wxChoice( panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, possibleQualityCount, possibleQualities, 0, wxDefaultValidator, wxT("VBRQuality")); _gridSizer->Add(_vbrQuality, wxSizerFlags().Expand().Border(wxRIGHT, 100)); _gridSizer->Add(new wxStaticText(panel, wxID_ANY, wxT("MPEG Quality:"))); wxChoice *mpegQuality = new wxChoice( panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, possibleQualityCount, possibleQualities, 0, wxDefaultValidator, wxT("MpegQuality")); _gridSizer->Add(mpegQuality, wxSizerFlags().Expand().Border(wxRIGHT, 100)); // Finish the window sizer->Add(_gridSizer, wxSizerFlags().Expand()); SetAlignedSizer(panel, sizer); // Load settings lamePicker->SetPath(_configuration.mp3LamePath); if (_configuration.mp3CompressionType == wxT("ABR")) abrButton->SetValue(true); else vbrButton->SetValue(true); _vbrMinBitrate->SetStringSelection(_configuration.mp3VBRMinBitrate); _vbrMaxBitrate->SetStringSelection(_configuration.mp3VBRMaxBitrate); _abrAvgBitrate->SetStringSelection(_configuration.mp3ABRBitrate); _vbrQuality ->SetStringSelection(_configuration.mp3VBRQuality); mpegQuality ->SetStringSelection(_configuration.mp3MpegQuality); updateFields(panel); return panel; } void ChooseAudioOptionsMp3Page::save(wxWindow *panel) { wxFilePickerCtrl *lamePath = static_cast(panel->FindWindowByName(wxT("LamePath"))); wxRadioButton *abr = static_cast(panel->FindWindowByName(wxT("ABR"))); wxChoice *mpegQuality = static_cast(panel->FindWindowByName(wxT("MpegQuality"))); _configuration.mp3LamePath = lamePath->GetPath(); _configuration.mp3VBRMinBitrate = _vbrMinBitrate->GetStringSelection(); _configuration.mp3VBRMaxBitrate = _vbrMaxBitrate->GetStringSelection(); _configuration.mp3ABRBitrate = _abrAvgBitrate->GetStringSelection(); _configuration.mp3VBRQuality = _vbrQuality ->GetStringSelection(); _configuration.mp3MpegQuality = mpegQuality ->GetStringSelection(); if (abr->GetValue()) _configuration.mp3CompressionType = wxT("ABR"); else _configuration.mp3CompressionType = wxT("VBR"); } void ChooseAudioOptionsMp3Page::updateFields(wxWindow *panel) { wxRadioButton *abr = static_cast(panel->FindWindowByName(wxT("ABR"))); bool isAbrSelected = abr->GetValue(); _gridSizer->Show(_abrAvgBitrate, isAbrSelected); _gridSizer->Show(_abrAvgBitrateLabel, isAbrSelected); _gridSizer->Show(_vbrMinBitrate, !isAbrSelected); _gridSizer->Show(_vbrMinBitrateLabel, !isAbrSelected); _gridSizer->Show(_vbrMaxBitrate, !isAbrSelected); _gridSizer->Show(_vbrMaxBitrateLabel, !isAbrSelected); _gridSizer->Show(_vbrQuality, !isAbrSelected); _gridSizer->Show(_vbrQualityLabel, !isAbrSelected); _gridSizer->Layout(); } void ChooseAudioOptionsMp3Page::onChangeCompressionType(wxCommandEvent &evt) { wxRadioButton *btn = static_cast(evt.GetEventObject()); wxWindow *parent = btn->GetParent(); updateFields(parent); } void ChooseAudioOptionsMp3Page::onNext(wxWindow *panel) { // Check if the lame path is valid. // The configuration is updated when calling switchPage() and therefore // is not yet up to date. So we get the path from the wxFilePickerCtrl wxFilePickerCtrl *lamePath = static_cast(panel->FindWindowByName(wxT("LamePath"))); if (!Configuration::isLamePathValid(lamePath->GetPath())) { wxMessageDialog *msgDialog = new wxMessageDialog( NULL, wxT("The lame executable could not be found. It is needed to compress files to MP3. ") wxT("If you want to use MP3 compression you need to select a valid lame executable. ") wxT("Otherwise you can go back to the audio format selection and select another format."), wxT("lame not found"), wxOK | wxICON_EXCLAMATION ); msgDialog->ShowModal(); return; } switchPage(new ProcessPage(_configuration)); } // Page to choose Flac compression options ChooseAudioOptionsFlacPage::ChooseAudioOptionsFlacPage(Configuration &config) : WizardPage(config) { } wxWindow *ChooseAudioOptionsFlacPage::CreatePanel(wxWindow *parent) { wxWindow *panel = WizardPage::CreatePanel(parent); wxSizer *topsizer = new wxBoxSizer(wxVERTICAL); topsizer->AddSpacer(15); topsizer->Add(new wxStaticText(panel, wxID_ANY, wxT("Choose advanced audio options, high compression levels means better quality,\nlower faster runtime."))); topsizer->AddSpacer(10); /* "\nFlac mode params:\n" \ " --fast FLAC uses compression level 0\n" \ " --best FLAC uses compression level 8\n" \ " - specifies the value (0 - 8) of compression (8=best)(default:" flacCompressDef_str ")\n" \ " -b specifies a blocksize of samples (default:" flacBlocksizeDef_str ")\n" \ " --verify files are encoded and then decoded to check accuracy\n" \ " --silent the output of FLAC is hidden (default:disabled)\n" \ */ wxFlexGridSizer *sizer = new wxFlexGridSizer(2, 2, 10, 25); sizer->AddGrowableCol(1); // // Compression Level const int possibleLevelCount = 9; wxString possibleLevels[possibleLevelCount + 1]; for (int i = 0; i <= possibleLevelCount; ++i) { possibleLevels[i] << i; } sizer->Add(new wxStaticText(panel, wxID_ANY, wxT("Compression Level:"))); wxChoice *compressionLevel = new wxChoice( panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, possibleLevelCount, possibleLevels, 0, wxDefaultValidator, wxT("CompressionLevel")); sizer->Add(compressionLevel, wxSizerFlags().Expand().Border(wxRIGHT, 100)); // Block Size wxString blockSizes[] = { wxT("576"), wxT("1152"), wxT("2304"), wxT("4608") }; sizer->Add(new wxStaticText(panel, wxID_ANY, wxT("Block Size:"))); wxChoice *blockSize = new wxChoice( panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, sizeof blockSizes / sizeof *blockSizes, blockSizes, 0, wxDefaultValidator, wxT("BlockSize")); sizer->Add(blockSize, wxSizerFlags().Expand().Border(wxRIGHT, 100)); // Finish the window topsizer->Add(sizer); SetAlignedSizer(panel, topsizer); // Load settings compressionLevel->SetStringSelection(_configuration.flacCompressionLevel); blockSize->SetStringSelection(_configuration.flacBlockSize); return panel; } void ChooseAudioOptionsFlacPage::save(wxWindow *panel) { wxChoice *compressionLevel = static_cast(panel->FindWindowByName(wxT("CompressionLevel"))); wxChoice *blockSize = static_cast(panel->FindWindowByName(wxT("BlockSize"))); _configuration.flacCompressionLevel = compressionLevel->GetStringSelection(); _configuration.flacBlockSize = blockSize->GetStringSelection(); } void ChooseAudioOptionsFlacPage::onNext(wxWindow *panel) { switchPage(new ProcessPage(_configuration)); } // Page to choose Vorbis compression options ChooseAudioOptionsVorbisPage::ChooseAudioOptionsVorbisPage(Configuration &config) : WizardPage(config) { } wxWindow *ChooseAudioOptionsVorbisPage::CreatePanel(wxWindow *parent) { wxWindow *panel = WizardPage::CreatePanel(parent); wxSizer *sizer = new wxBoxSizer(wxVERTICAL); /* Vorbis mode params " -b is the nominal bitrate (default:unset)\n" \ " -m is the minimum bitrate (default:unset)\n" \ " -M is the maximum bitrate (default:unset)\n" \ " -q specifies the value (0 - 10) of VBR quality (10=best) (default:" oggqualDef_str ")\n" \ " --silent the output of oggenc is hidden (default:disabled)\n" \ */ // Grid _gridSizer = new wxFlexGridSizer(5, 2, 10, 25); _gridSizer->AddGrowableCol(1); // Compression target type _gridSizer->Add(new wxStaticText(panel, wxID_ANY, wxT("Target Type:"))); wxRadioButton *qualityButton = new wxRadioButton( panel, wxID_ANY, wxT("Quality Factor"), wxDefaultPosition, wxDefaultSize, 0, wxDefaultValidator, wxT("Quality")); wxSizer *radioSizer = new wxBoxSizer(wxHORIZONTAL); radioSizer->Add(qualityButton); wxRadioButton *bitrateButton = new wxRadioButton( panel, wxID_ANY, wxT("Nominal Bitrate"), wxDefaultPosition, wxDefaultSize, 0, wxDefaultValidator, wxT("Bitrate")); radioSizer->Add(bitrateButton); _gridSizer->Add(radioSizer, wxSizerFlags().Expand()); // Quality const int possibleQualityCount = 11; wxString possibleQualities[possibleQualityCount + 1]; for (int i = 0; i <= possibleQualityCount; ++i) { possibleQualities[i] << i; } _qualityFactorLabel = new wxStaticText(panel, wxID_ANY, wxT("Quality:")); _gridSizer->Add(_qualityFactorLabel); _qualityFactor = new wxChoice( panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, possibleQualityCount, possibleQualities, 0, wxDefaultValidator, wxT("QualityFactor")); _gridSizer->Add(_qualityFactor, wxSizerFlags().Expand().Border(wxRIGHT, 100)); // Bitrates const int possibleBitrateCount = 160 / 8; wxString possibleBitrates[possibleBitrateCount]; wxString possibleMinMaxBitrates[possibleBitrateCount + 1]; possibleMinMaxBitrates[0] = wxT("None"); for (int i = 0; i < possibleBitrateCount; ++i) { possibleBitrates[i] << (i+1)*8; possibleMinMaxBitrates[i+1] << (i+1)*8; } _nominalBitrateLabel = new wxStaticText(panel, wxID_ANY, wxT("Nominal Bitrate:")); _gridSizer->Add(_nominalBitrateLabel); _nominalBitrate = new wxChoice( panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, possibleBitrateCount, possibleBitrates, 0, wxDefaultValidator, wxT("NominalBitrate")); _gridSizer->Add(_nominalBitrate, wxSizerFlags().Expand().Border(wxRIGHT, 100)); _gridSizer->Add(new wxStaticText(panel, wxID_ANY, wxT("Minimum Bitrate:"))); wxChoice *MinBitrate = new wxChoice( panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, possibleBitrateCount+1, possibleMinMaxBitrates, 0, wxDefaultValidator, wxT("MinimumBitrate")); _gridSizer->Add(MinBitrate, wxSizerFlags().Expand().Border(wxRIGHT, 100)); _gridSizer->Add(new wxStaticText(panel, wxID_ANY, wxT("Maximum Bitrate:"))); wxChoice *MaxBitrate = new wxChoice( panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, possibleBitrateCount+1, possibleMinMaxBitrates, 0, wxDefaultValidator, wxT("MaximumBitrate")); _gridSizer->Add(MaxBitrate, wxSizerFlags().Expand().Border(wxRIGHT, 100)); qualityButton->Connect(wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEventHandler(ChooseAudioOptionsVorbisPage::onChangeTargetType), NULL, this); bitrateButton->Connect(wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEventHandler(ChooseAudioOptionsVorbisPage::onChangeTargetType), NULL, this); // Finish the window sizer->Add(_gridSizer, wxSizerFlags().Expand()); SetAlignedSizer(panel, sizer); // Load settings MinBitrate->SetStringSelection(_configuration.oggMinBitrate); MaxBitrate->SetStringSelection(_configuration.oggMaxBitrate); _qualityFactor->SetStringSelection(_configuration.oggQuality); _nominalBitrate->SetStringSelection(_configuration.oggAvgBitrate); if (_configuration.useOggQuality) qualityButton->SetValue(true); else bitrateButton->SetValue(true); updateFields(panel); return panel; } void ChooseAudioOptionsVorbisPage::save(wxWindow *panel) { wxRadioButton *quality = static_cast(panel->FindWindowByName(wxT("Quality"))); wxChoice *minBitrate = static_cast(panel->FindWindowByName(wxT("MinimumBitrate"))); wxChoice *maxBitrate = static_cast(panel->FindWindowByName(wxT("MaximumBitrate"))); _configuration.useOggQuality = quality->GetValue(); _configuration.oggMinBitrate = minBitrate->GetStringSelection(); _configuration.oggAvgBitrate = _nominalBitrate->GetStringSelection(); _configuration.oggMaxBitrate = maxBitrate->GetStringSelection(); _configuration.oggQuality = _qualityFactor->GetStringSelection(); } void ChooseAudioOptionsVorbisPage::updateFields(wxWindow *panel) { wxRadioButton *quality = static_cast(panel->FindWindowByName(wxT("Quality"))); bool isQualitySelected = quality->GetValue(); _gridSizer->Show(_qualityFactor, isQualitySelected); _gridSizer->Show(_qualityFactorLabel, isQualitySelected); _gridSizer->Show(_nominalBitrate, !isQualitySelected); _gridSizer->Show(_nominalBitrateLabel, !isQualitySelected); _gridSizer->Layout(); } void ChooseAudioOptionsVorbisPage::onChangeTargetType(wxCommandEvent &evt) { wxRadioButton *btn = static_cast(evt.GetEventObject()); wxWindow *parent = btn->GetParent(); updateFields(parent); } void ChooseAudioOptionsVorbisPage::onNext(wxWindow *panel) { switchPage(new ProcessPage(_configuration)); } // Page to choose ANY tool to use ProcessPage::ProcessPage(Configuration &config) : WizardPage(config), _finished(false), _success(false) { _gauge = NULL; _outwin = NULL; _output.done = 0; _output.total = 100; _output.cmd = NULL; _output.retval = 0; _output.subprocessFinished = NULL; } wxWindow *ProcessPage::CreatePanel(wxWindow *parent) { wxWindow *panel = WizardPage::CreatePanel(parent); wxSizer *sizer = new wxBoxSizer(wxVERTICAL); sizer->AddSpacer(15); _processingText = new wxStaticText(panel, wxID_ANY, wxT("Processing data...")); sizer->Add(_processingText, wxSizerFlags().Expand().Border(wxLEFT, 20)); _outwin = new wxTextCtrl(panel, wxID_ANY, wxT(""), wxDefaultPosition, wxDefaultSize, wxTE_MULTILINE | wxTE_READONLY, wxDefaultValidator, wxT("OutputWindow")); sizer->Add(_outwin, wxSizerFlags(1).Expand().Border(wxTOP | wxLEFT | wxRIGHT, 10)); _gauge = new wxGauge(panel, wxID_ANY, _output.total, wxDefaultPosition, wxDefaultSize, wxGA_HORIZONTAL, wxDefaultValidator, wxT("ProgressBar")); sizer->Add(_gauge, wxSizerFlags(0).Expand().Border(wxBOTTOM | wxLEFT | wxRIGHT, 10)); _finishText = new wxStaticText(panel, wxID_ANY, wxString()); sizer->Add(_finishText, wxSizerFlags().Expand().Border(wxLEFT, 20)); panel->SetSizer(sizer); // Run the tool runTool(); return panel; } void ProcessPage::runTool() { const ToolGUI *tool = _configuration.selectedTool; // Write some text that we've started... _outwin->WriteText(wxT("Running ") + tool->getName() + wxT("\n\n")); // Child thread to run the tool _thread = new ProcessToolThread(tool, _configuration, _output); // We should check return value of this _thread->Create(); _thread->Run(); } wxString ProcessPage::getHelp() { return wxT("The tool is running, wait for the progress to finish then click the next button.\n") wxT("If you did an error with your input, or want to abort execution, press the abort button."); } bool ProcessPage::onIdle(wxPanel *panel) { const ToolGUI *tool = _configuration.selectedTool; if (!_thread) return false; // This function can be called recursively, by checking if lock is available, we avoid it if (_output.mutex.TryLock() == wxMUTEX_BUSY) return false; else // Immedietly unlock _output.mutex.Unlock(); // Check if our subthread has something for us to do { wxMutexLocker lock(_output.mutex); // Write text _outwin->WriteText(wxString(_output.buffer.c_str(), wxConvUTF8)); _output.buffer = ""; if (tool->supportsProgressBar()) { // Update gauge _gauge->SetRange(_output.total); _gauge->SetValue(_output.done); } if (_output.cmd) { // We have a waiting subprocess to run, the other thread is sleeping since we could lock the mutex #ifdef __WINDOWS__ // Only windows needs this // It hides the process window, on unix it doesn't appear to work very well wxProcess proc(wxPROCESS_REDIRECT); _output.retval = wxExecute(wxString(_output.cmd, wxConvUTF8), wxEXEC_SYNC, &proc); #else // Process windows are hidden by default under other OSes, so we don't need any special code _output.retval = system(_output.cmd); #endif _output.cmd = NULL; // Signal the other thread that we have run the subprocess _output.subprocessFinished->Signal(); } } // Check if thread finished if (_thread && _thread->_finished) { // Tool has finished _success = _thread->_success; // Wait deallocates thread resources _thread->Wait(); delete _thread; _thread = NULL; _finished = true; // Update UI if (_topframe) updateButtons(panel, _topframe->_buttons); _processingText->SetLabel(wxString()); if (_success) { _finishText->SetOwnForegroundColour(wxColour(0, 200, 0)); _finishText->SetLabel(wxT("Tool completed successfully")); } else { _finishText->SetOwnForegroundColour(wxColour(200, 0, 0)); _finishText->SetLabel(wxT("Tool ended with errors")); } return false; } if (!tool->supportsProgressBar()) { // Just move the bar back & forth _gauge->Pulse(); } return true; } void ProcessPage::onNext(wxWindow *panel) { if (_success) switchPage(new FinishPage(_configuration)); else switchPage(new FailurePage(_configuration)); } bool ProcessPage::onCancel(wxWindow *panel) { if (_finished) return WizardPage::onCancel(panel); else { _thread->abort(); return false; } } void ProcessPage::updateButtons(wxWindow *panel, WizardButtons *buttons) { if (_success) { buttons->enablePrevious(false); buttons->enableNext(true); buttons->showAbort(false); _gauge->SetRange(100); _gauge->SetValue(100); } else if (_finished) { buttons->enablePrevious(true); buttons->enableNext(true); buttons->showAbort(false); // It's not possible to disable them, leave it empty instead _gauge->SetRange(0); _gauge->SetValue(100); } else { buttons->enablePrevious(false); buttons->enableNext(false); buttons->showAbort(true); } WizardPage::updateButtons(panel, buttons); } // The thread a tool is run in ProcessToolThread::ProcessToolThread(const ToolGUI *tool, Configuration &configuration, ThreadCommunicationBuffer &output) : wxThread(wxTHREAD_JOINABLE), _configuration(configuration), _output(output) { _tool = tool; _finished = false; _success = false; _tool->_backend->setPrintFunction(writeToOutput, reinterpret_cast(this)); _tool->_backend->setProgressFunction(gaugeProgress, reinterpret_cast(this)); _tool->_backend->setSubprocessFunction(spawnSubprocess, reinterpret_cast(this)); } wxThread::ExitCode ProcessToolThread::Entry() { try { _tool->run(_configuration); _output.buffer += "\nTool finished without errors!\n"; _success = true; } catch (ToolException &err) { wxMutexLocker lock(_output.mutex); _output.buffer = _output.buffer + "\nFatal Error Occurred: " + err.what() + "\n"; } _finished = true; return NULL; } void ProcessToolThread::abort() { // Notify the tool of the abort _tool->_backend->abort(); } void ProcessToolThread::writeToOutput(void *udata, const char *text) { ProcessToolThread *self = reinterpret_cast(udata); wxMutexLocker lock(self->_output.mutex); self->_output.buffer += text; } void ProcessToolThread::gaugeProgress(void *udata, int done, int total) { ProcessToolThread *self = reinterpret_cast(udata); wxMutexLocker lock(self->_output.mutex); self->_output.done = done; self->_output.total = total; } int ProcessToolThread::spawnSubprocess(void *udata, const char *cmd) { ProcessToolThread *self = reinterpret_cast(udata); wxASSERT_MSG(self->_output.subprocessFinished == NULL, wxT("You can only spawn one subprocess.")); wxMutexLocker mutex(self->_output.mutex); self->_output.subprocessFinished = new wxCondition(self->_output.mutex); self->_output.cmd = cmd; // Wait for the other thread, this unlocks the mutex self->_output.subprocessFinished->Wait(); // Mutex is locked again after wait, so we can clear safely // Cleanup the condition delete self->_output.subprocessFinished; self->_output.subprocessFinished = NULL; return self->_output.retval; } // Last page of the wizard, offers the option to open the output directory FinishPage::FinishPage(Configuration &config) : WizardPage(config) { } wxWindow *FinishPage::CreatePanel(wxWindow *parent) { wxWindow *panel = WizardPage::CreatePanel(parent); wxSizer *sizer = new wxBoxSizer(wxVERTICAL); sizer->AddSpacer(15); wxString text; if (_configuration.selectedTool->getType() == TOOLTYPE_COMPRESSION) text = wxT("You have finished the wizard! Your files should now be compressed."); else text = wxT("You have finished the wizard! Your files should now be extracted."); sizer->Add(new wxStaticText(panel, wxID_ANY, text)); sizer->AddSpacer(10); wxCheckBox *displayOut = new wxCheckBox(panel, wxID_ANY, wxT("Open output folder"), wxDefaultPosition, wxDefaultSize, 0, wxDefaultValidator, wxT("DisplayOutput")); displayOut->SetValue(true); sizer->Add(displayOut); sizer->AddSpacer(10); wxCheckBox *processOther = new wxCheckBox(panel, wxID_ANY, wxT("Process another file"), wxDefaultPosition, wxDefaultSize, 0, wxDefaultValidator, wxT("ProcessOther")); processOther->SetValue(false); sizer->Add(processOther); SetAlignedSizer(panel, sizer); return panel; } bool FinishPage::onCancel(wxWindow *panel) { // On that page, that's the Finish button wxCheckBox *display = static_cast(panel->FindWindowByName(wxT("DisplayOutput"))); if (display->GetValue()) { // There is no standard way to do this // On windows we can simply spawn an explorer instance #ifdef __WINDOWS__ wxExecute(wxT("explorer.exe \"") + _configuration.outputPath + wxT("\"")); #elif defined __WXMAC__ wxExecute(wxT("open \"") + _configuration.outputPath + wxT("\"")); #else #endif } wxCheckBox *restart = static_cast(panel->FindWindowByName(wxT("ProcessOther"))); if (restart->GetValue()) { _configuration.selectedTool = NULL; _configuration.inputFilePaths.clear(); _configuration.multipleRuns = false; _topframe->switchToFirstPage(); return false; } else { _topframe->Close(true); return true; } } wxString FinishPage::getHelp() { return wxT("You have finished the wizard!\n\nJust click the finish button and enjoy your outputted files, if you compressed, you can now import the compressed file into ScummVM to get access to your data."); } void FinishPage::updateButtons(wxWindow *panel, WizardButtons *buttons) { buttons->showNavigation(false); buttons->showFinish(true); WizardPage::updateButtons(panel, buttons); } // If the tool fails, this page is shown instead of the last page FailurePage::FailurePage(Configuration &config) : WizardPage(config) { } wxWindow *FailurePage::CreatePanel(wxWindow *parent) { wxWindow *panel = WizardPage::CreatePanel(parent); wxSizer *sizer = new wxBoxSizer(wxVERTICAL); sizer->AddSpacer(15); sizer->Add(new wxStaticText(panel, wxID_ANY, wxT("The execution of the tool failed. You can try running the wizard again and ensure that the file paths are accurate.")), wxSizerFlags(1).Expand()); wxCheckBox *processOther = new wxCheckBox(panel, wxID_ANY, wxT("Restart the wizard"), wxDefaultPosition, wxDefaultSize, 0, wxDefaultValidator, wxT("ProcessOther")); processOther->SetValue(false); sizer->Add(processOther); SetAlignedSizer(panel, sizer); return panel; } bool FailurePage::onCancel(wxWindow *panel) { // On that page, that's the Finish button wxCheckBox *restart = static_cast(panel->FindWindowByName(wxT("ProcessOther"))); if (restart->GetValue()) { _configuration.selectedTool = NULL; _configuration.inputFilePaths.clear(); _configuration.multipleRuns = false; _topframe->switchToFirstPage(); return false; } else { _topframe->Close(true); return true; } } void FailurePage::updateButtons(wxWindow *panel, WizardButtons *buttons) { buttons->showNavigation(false); buttons->showFinish(true); WizardPage::updateButtons(panel, buttons); }