├── src ├── generation │ ├── __init__.py │ └── core.py ├── awcmaster_logo.ico ├── components │ ├── __init__.py │ ├── dir_dialog.py │ ├── menu_bar.py │ ├── sound_list_panel.py │ └── prop_panel.py ├── helpers.py └── main.py ├── gh_banner.png ├── requirements.txt ├── ACKNOWLEDGMENTS.md ├── README.md ├── .gitignore └── LICENSE /src/generation/__init__.py: -------------------------------------------------------------------------------- 1 | from .core import SimpleSound -------------------------------------------------------------------------------- /gh_banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/qyful/AWCMaster/HEAD/gh_banner.png -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | wxpython==4.2.1 2 | elementpath==4.4.0 3 | mutagen==1.47.0 -------------------------------------------------------------------------------- /src/awcmaster_logo.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/qyful/AWCMaster/HEAD/src/awcmaster_logo.ico -------------------------------------------------------------------------------- /ACKNOWLEDGMENTS.md: -------------------------------------------------------------------------------- 1 | ## Acknowledgments 2 | Thank you to **Monkeypolice188** for his efforts in [researching properties of Audio Wave Containers](https://github.com/Monkeypolice188/Monkys-Audio-Research) (AWCs). -------------------------------------------------------------------------------- /src/components/__init__.py: -------------------------------------------------------------------------------- 1 | from .menu_bar import menuBar # noqa: F401 2 | from .prop_panel import PropertiesPanel # noqa: F401 3 | from .sound_list_panel import SoundListPanel # noqa: F401 4 | from .dir_dialog import DirDialog # noqa: F401 -------------------------------------------------------------------------------- /src/components/dir_dialog.py: -------------------------------------------------------------------------------- 1 | import wx 2 | import os 3 | 4 | class DirDialog(wx.DirDialog): 5 | def __init__(self, parent): 6 | super().__init__(parent) 7 | self.create_dialog(parent) 8 | 9 | def create_dialog(self, parent): 10 | with wx.DirDialog(parent, "Choose output directory", os.getcwd(), 11 | wx.DD_DEFAULT_STYLE | wx.DD_DIR_MUST_EXIST) as dirDialog: 12 | return dirDialog -------------------------------------------------------------------------------- /src/components/menu_bar.py: -------------------------------------------------------------------------------- 1 | import wx 2 | 3 | class menuBar: 4 | def __init__(self, parent): 5 | self.parent = parent 6 | self.create_menu_bar() 7 | 8 | def create_menu_bar(self): 9 | self.frame_menubar = wx.MenuBar() 10 | 11 | self.file = wx.Menu() 12 | self.frame_menubar.newProj = self.file.Append(-1, "New Project\tCtrl+N", "Create a new project") 13 | self.frame_menubar.openProj = self.file.Append(-1, "Open Project\tCtrl+O", "Open an existing project") 14 | self.file.AppendSeparator() 15 | self.frame_menubar.saveProj = self.file.Append(-1, "Save Project...\tCtrl+S", "Save your current project") 16 | self.frame_menubar.saveProjAs = self.file.Append(-1, "Save Project As...\tCtrl+Shift+S", "Save your project using another filename") 17 | self.frame_menubar.Append(self.file, "File") 18 | 19 | self.options = wx.Menu() 20 | self.frame_menubar.genFx = self.options.Append(-1, "Generate fxmanifest.lua", "Generate an fxmanifest.lua file for FiveM", kind=wx.ITEM_CHECK) 21 | self.frame_menubar.Append(self.options, "Options") 22 | 23 | self.parent.SetMenuBar(self.frame_menubar) -------------------------------------------------------------------------------- /src/components/sound_list_panel.py: -------------------------------------------------------------------------------- 1 | import wx 2 | 3 | class SoundListPanel(wx.Panel): 4 | def __init__(self, parent): 5 | super().__init__(parent) 6 | self.create_list() 7 | 8 | def create_list(self): 9 | sizer = wx.BoxSizer(wx.VERTICAL) 10 | 11 | soundLabelContainer = wx.StaticBoxSizer(wx.StaticBox(self, wx.ID_ANY, "Sounds"), wx.HORIZONTAL) 12 | sizer.Add(soundLabelContainer, 1, wx.ALL | wx.EXPAND, 8) 13 | 14 | self.soundsList = wx.ListCtrl(self, wx.ID_ANY, style=wx.BORDER_NONE | wx.LC_REPORT | wx.LC_SINGLE_SEL) 15 | self.soundsList.AppendColumn("Name", format=wx.LIST_FORMAT_LEFT, width=-1) 16 | self.soundsList.AppendColumn("Type", format=wx.LIST_FORMAT_LEFT, width=-1) 17 | self.soundsList.AppendColumn("Length", format=wx.LIST_FORMAT_LEFT, width=-1) 18 | self.soundsList.AppendColumn("Size", format=wx.LIST_FORMAT_LEFT, width=-1) 19 | soundLabelContainer.Add(self.soundsList, 1, wx.ALL | wx.EXPAND, 4) 20 | 21 | button_sizer = wx.BoxSizer(wx.HORIZONTAL) 22 | sizer.Add(button_sizer, 0, wx.BOTTOM | wx.EXPAND | wx.LEFT, 8) 23 | 24 | self.addSoundBtn = wx.Button(self, wx.ID_ANY, "Add") 25 | button_sizer.Add(self.addSoundBtn, 0, 0, 0) 26 | 27 | self.delSoundBtn = wx.Button(self, wx.ID_ANY, "Remove selected") 28 | button_sizer.Add(self.delSoundBtn, 0, wx.EXPAND | wx.LEFT, 4) 29 | self.delSoundBtn.Disable() 30 | 31 | self.SetSizer(sizer) -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![alt text](gh_banner.png) 2 | 3 | # AWCMaster 4 | 5 | ![GitHub License](https://img.shields.io/github/license/qyful/AWCMaster) 6 | ![GitHub commit activity](https://img.shields.io/github/commit-activity/w/qyful/awcmaster) 7 | [![Version](https://img.shields.io/github/v/release/qyful/awcmaster)](https://github.com/qyful/awcmaster/releases) 8 | [![Issues](https://img.shields.io/github/issues/qyful/awcmaster)](https://github.com/qyful/awcmaster/issues) 9 | [![Forks](https://img.shields.io/github/forks/qyful/awcmaster)](https://github.com/qyful/awcmaster/network/members) 10 | [![Stars](https://img.shields.io/github/stars/qyful/awcmaster)](https://github.com/qyful/awcmaster/stargazers) 11 | [![Discord](https://dcbadge.limes.pink/api/server/https://discord.gg/pYSYtYWwbF?style=flat)](https://discord.gg/yefSA3uzDz) 12 | 13 | ## Overview 14 | 15 | **AWCMaster** is an open-source GUI-based tool designed to help you create and edit native audio files for Grand Theft Auto V and FiveM. With an easy-to-use interface and powerful features, this tool simplifies the process of customizing audio for your scripts and mods. 16 | 17 | ## Dependencies 18 | 19 | To use AWCMaster, you must first download [Codewalker](https://www.gta5-mods.com/tools/codewalker-gtav-interactive-3d-map) to import the XML files generated by the program. 20 | 21 | ## Usage 22 | 23 | **Install the latest Windows release** from [here](https://github.com/qyful/AWCMaster/releases/) or download the source files: 24 | 25 | ```console 26 | $ git clone https://github.com/qyful/AWCMaster.git 27 | ``` 28 | 29 | Then, navigate to the newly-created folder: 30 | 31 | ```console 32 | $ cd AWCMaster/src 33 | ``` 34 | 35 | and run the `main.py` file: 36 | 37 | ```console 38 | $ python main.py 39 | ``` 40 | 41 | **Then you're ready!** There are some more advanced features such as flags, however the defaults are more than enough to get started creating your own native sounds for GTA V. 42 | 43 | ## Contribution Guidelines 44 | 45 | We welcome contributions from the community! To ensure a smooth collaboration process, please follow these guidelines: 46 | 47 | 1. **Fork the repository** and create your branch from `main`. 48 | 49 | 2. **Open an issue** before working on significant changes to discuss your ideas. 50 | 51 | 3. **Commit messages** should be descriptive. Follow the convention of using the present tense, e.g., "Add feature" or "Fix bug." 52 | 53 | 4. **Submit a pull request** after making your changes. Make sure to reference any related issues in your PR. 54 | 55 | 5. **Ensure the code adheres to the [PEP 8 guidelines](https://peps.python.org/pep-0008/)** before submitting your PR. 56 | 57 | 6. **Respect the community** and the work of others. Collaboration is key! 58 | 59 | ## License 60 | 61 | This project is licensed under the GPLv3 License. See the [LICENSE](https://github.com/qyful/AWCMaster/blob/main/LICENSE) 62 | 63 | ## Contact 64 | 65 | For any questions or feedback, feel free to [open an issue](https://github.com/qyful/awcmaster/issues) or reach out directly via [this discord](https://discord.gg/pYSYtYWwbF). 66 | 67 | --- 68 | 69 | *This project is not affiliated with or endorsed by Rockstar Games, Grand Theft Auto V, FiveM, or CFX.re.* -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/latest/usage/project/#working-with-version-control 110 | .pdm.toml 111 | .pdm-python 112 | .pdm-build/ 113 | 114 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 115 | __pypackages__/ 116 | 117 | # Celery stuff 118 | celerybeat-schedule 119 | celerybeat.pid 120 | 121 | # SageMath parsed files 122 | *.sage.py 123 | 124 | # Environments 125 | .env 126 | .venv 127 | env/ 128 | venv/ 129 | ENV/ 130 | env.bak/ 131 | venv.bak/ 132 | 133 | # Spyder project settings 134 | .spyderproject 135 | .spyproject 136 | 137 | # Rope project settings 138 | .ropeproject 139 | 140 | # mkdocs documentation 141 | /site 142 | 143 | # mypy 144 | .mypy_cache/ 145 | .dmypy.json 146 | dmypy.json 147 | 148 | # Pyre type checker 149 | .pyre/ 150 | 151 | # pytype static type analyzer 152 | .pytype/ 153 | 154 | # Cython debug symbols 155 | cython_debug/ 156 | 157 | # PyCharm 158 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 159 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 160 | # and can be added to the global gitignore or merged into this file. For a more nuclear 161 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 162 | #.idea/ 163 | -------------------------------------------------------------------------------- /src/components/prop_panel.py: -------------------------------------------------------------------------------- 1 | import wx 2 | 3 | class PropertiesPanel(wx.Panel): 4 | def __init__(self, parent): 5 | super().__init__(parent) 6 | self.create_properties() 7 | 8 | def create_properties(self): 9 | sizer = wx.BoxSizer(wx.VERTICAL) 10 | 11 | selectedSLabelContainer = wx.StaticBoxSizer(wx.StaticBox(self, wx.ID_ANY, "Edit selected sound"), wx.VERTICAL) 12 | sizer.Add(selectedSLabelContainer, 1, wx.ALL | wx.EXPAND, 8) 13 | 14 | AWCContainer = wx.BoxSizer(wx.HORIZONTAL) 15 | selectedSLabelContainer.Add(AWCContainer, 0, wx.EXPAND, 0) 16 | 17 | leftAWCContainer = wx.BoxSizer(wx.VERTICAL) 18 | AWCContainer.Add(leftAWCContainer, 1, wx.EXPAND, 0) 19 | 20 | # Sound Type 21 | soundTypeLabel = wx.StaticBoxSizer(wx.StaticBox(self, wx.ID_ANY, "Type"), wx.HORIZONTAL) 22 | leftAWCContainer.Add(soundTypeLabel, 0, wx.ALL | wx.EXPAND, 4) 23 | self.soundType = wx.Choice(self, wx.ID_ANY, choices=["SimpleSound", "Siren"]) 24 | self.soundType.SetSelection(0) 25 | self.soundType.Disable() 26 | soundTypeLabel.Add(self.soundType, 1, wx.EXPAND, 0) 27 | 28 | # Sample Rate 29 | sampleRateLabel = wx.StaticBoxSizer(wx.StaticBox(self, wx.ID_ANY, "Sample rate"), wx.HORIZONTAL) 30 | leftAWCContainer.Add(sampleRateLabel, 0, wx.ALL | wx.EXPAND, 4) 31 | self.sampleRate = wx.Choice(self, wx.ID_ANY, choices=["8000", "11025", "16000", "22050", "32000", "44100", "48000"]) 32 | self.sampleRate.SetSelection(5) 33 | sampleRateLabel.Add(self.sampleRate, 1, wx.EXPAND, 0) 34 | 35 | # Sound Name 36 | soundNameLabel = wx.StaticBoxSizer(wx.StaticBox(self, wx.ID_ANY, "Name"), wx.HORIZONTAL) 37 | leftAWCContainer.Add(soundNameLabel, 0, wx.ALL | wx.EXPAND, 4) 38 | self.soundName = wx.TextCtrl(self, wx.ID_ANY, "", style=wx.BORDER_NONE | wx.TE_NO_VSCROLL) 39 | soundNameLabel.Add(self.soundName, 1, wx.EXPAND, 0) 40 | 41 | # Flags 42 | rightAWCContainer = wx.StaticBoxSizer(wx.StaticBox(self, wx.ID_ANY, "Flags"), wx.HORIZONTAL) 43 | AWCContainer.Add(rightAWCContainer, 1, wx.ALL, 4) 44 | self.flags = wx.CheckListBox(self, wx.ID_ANY, choices=["Flags2","Unk01","Volume","VolumeVariance","Pitch","PitchVariance","Pan","PanVariance","PreDelay","PreDelayVariance","StartOffset","StartOffsetVariance","AttackTime","ReleaseTime","DopplerFactor","Category","LPFCutOff","LPFCutOffVariance","HPFCutOff","HPFCutOffVariance","UnkHash3","DistanceAttentuation","Unk19","Unk20"], style=wx.LB_SINGLE) 45 | rightAWCContainer.Add(self.flags, 0, 0, 0) 46 | 47 | # Audiobank and Soundset Name 48 | AWCPropContainer = wx.BoxSizer(wx.HORIZONTAL) 49 | sizer.Add(AWCPropContainer, 1, wx.ALL | wx.EXPAND, 8) 50 | 51 | AWCLabelContainer = wx.StaticBoxSizer(wx.StaticBox(self, wx.ID_ANY, "Edit current container"), wx.VERTICAL) 52 | AWCPropContainer.Add(AWCLabelContainer, 1, wx.EXPAND, 0) 53 | 54 | # Audiobank Name 55 | sizer_12 = wx.StaticBoxSizer(wx.StaticBox(self, wx.ID_ANY, "Audiobank Name"), wx.HORIZONTAL) 56 | AWCLabelContainer.Add(sizer_12, 0, wx.ALL | wx.EXPAND, 4) 57 | self.audiobankName = wx.TextCtrl(self, wx.ID_ANY, "custom_sounds") 58 | sizer_12.Add(self.audiobankName, 1, wx.ALL, 4) 59 | 60 | # Soundset Name 61 | sizer_16 = wx.StaticBoxSizer(wx.StaticBox(self, wx.ID_ANY, "Soundset Name"), wx.HORIZONTAL) 62 | AWCLabelContainer.Add(sizer_16, 0, wx.ALL | wx.EXPAND, 4) 63 | self.soundsetName = wx.TextCtrl(self, wx.ID_ANY, "custom_sounds") 64 | sizer_16.Add(self.soundsetName, 1, wx.ALL, 4) 65 | 66 | # Generate Button 67 | generateBtnContainer = wx.BoxSizer(wx.HORIZONTAL) 68 | sizer.Add(generateBtnContainer, 0, wx.ALL | wx.EXPAND, 8) 69 | 70 | self.generateBtn = wx.Button(self, wx.ID_ANY, "Generate") 71 | generateBtnContainer.Add(self.generateBtn, 0, 0, 4) 72 | 73 | self.SetSizer(sizer) 74 | 75 | def EnableProperties(self): 76 | for item in [self.soundType, self.sampleRate, self.flags, self.soundName]: 77 | item.Enable() 78 | 79 | def SetDefaultProperties(self): 80 | for item in [self.soundType, self.sampleRate, self.flags, self.soundName]: 81 | item.Disable() 82 | 83 | self.soundName.SetValue("") 84 | self.sampleRate.SetSelection(5) 85 | 86 | checkedItems = self.flags.CheckedItems 87 | 88 | for checked in checkedItems: 89 | self.flags.Check(checked, False) 90 | 91 | def GetSizer(self): 92 | return super().GetSizer() -------------------------------------------------------------------------------- /src/helpers.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | import json 4 | import pickle 5 | import subprocess 6 | 7 | def save_project(path: str, data: dict) -> bool: 8 | with open(path, 'wb') as handle: 9 | pickle.dump(data, handle, protocol=pickle.HIGHEST_PROTOCOL) 10 | 11 | def open_project(path: str) -> dict: 12 | with open(path, 'rb') as handle: 13 | return pickle.load(handle) 14 | 15 | def get_path(file_name: str) -> str: 16 | """ 17 | Returns the system path for all files depending on whether it is cloned source files or a Pyinstaller build. 18 | """ 19 | 20 | if getattr(sys, 'frozen', False): 21 | temp_dir = getattr(sys, '_MEIPASS', None) 22 | 23 | if temp_dir: 24 | path = os.path.join(temp_dir, file_name) 25 | else: 26 | path = os.path.join(os.getcwd(), file_name) 27 | else: 28 | path = os.path.join(os.path.dirname(__file__), file_name) 29 | 30 | return path 31 | 32 | def format_file_size(file_size: int, suffix="B"): 33 | """ 34 | Returns the formatted, human-readable version of a file's size from bytes. 35 | """ 36 | for unit in ("", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei", "Zi"): 37 | if abs(file_size) < 1024.0: 38 | return f"{file_size:3.1f} {unit}{suffix}" 39 | 40 | file_size /= 1024.0 41 | 42 | return f"{file_size:.1f} Yi{suffix}" 43 | 44 | def convert_to_wav(data: dict, output_path: str = os.getcwd(), fxmanifest: bool = False): 45 | """ 46 | Converts each item from a list of file paths into the appropriate PCM format as a WAVE file. 47 | """ 48 | for value in data["sound_files"].values(): 49 | input_path = value["path"] 50 | output_file = value["file_name"] + '.wav' 51 | 52 | file_path = output_path + "\\audiodirectory\\{0}".format(data["audiobank_name"]) 53 | 54 | if not os.path.exists(file_path): 55 | os.makedirs(file_path) 56 | 57 | formatted_output_path = "{0}\\{1}".format(file_path, output_file) 58 | 59 | ffmpeg_path = get_path("ffmpeg.exe") 60 | 61 | if not os.path.isfile(ffmpeg_path): 62 | return { "error": "ffmpeg.exe was not found. Is it missing in the root directory?" } 63 | 64 | command = [ 65 | ffmpeg_path, 66 | '-i', input_path, 67 | '-ar', value["sample_rate"], 68 | '-f', 'wav', 69 | '-acodec', 'pcm_s16le', 70 | '-ac', '1', 71 | '-fflags', '+bitexact', 72 | '-flags', '+bitexact', 73 | '-map_metadata', '-1', 74 | '-map', '0:a', 75 | formatted_output_path 76 | ] 77 | 78 | subprocess.Popen(command, creationflags=subprocess.CREATE_NO_WINDOW) 79 | 80 | value["wav_path"] = formatted_output_path 81 | 82 | if fxmanifest: 83 | with open(output_path + "\\fxmanifest.lua", "w") as handler: 84 | data = f"""fx_version 'cerulean' 85 | game 'gta5' 86 | 87 | author 'AWCMaster' 88 | description 'Generated with AWCMaster, a FOSS project' 89 | 90 | files {{ 91 | 'audiodirectory/{data["audiobank_name"]}.awc', 92 | 'data/{data["audiobank_name"]}.dat54.rel', 93 | 'data/{data["audiobank_name"]}.dat54.nametable' 94 | }} 95 | 96 | data_file "AUDIO_WAVEPACK" "audiodirectory" 97 | data_file "AUDIO_SOUNDDATA" "data/{data["audiobank_name"]}.dat" 98 | """ 99 | 100 | handler.write(data) 101 | handler.close() 102 | 103 | return data 104 | 105 | def get_file_info(file_path: str) -> dict | tuple: 106 | audio_file_info = {} 107 | ffprobe_path = get_path("ffprobe.exe") 108 | 109 | if not os.path.isfile(ffprobe_path): 110 | return { "error": "ffprobe.exe was not found. Is it missing in the root directory?" } 111 | 112 | process = subprocess.Popen( 113 | [ffprobe_path, '-show_format', '-show_streams', '-of', 'json', file_path], 114 | creationflags=subprocess.CREATE_NO_WINDOW, 115 | stdout=subprocess.PIPE, 116 | stderr=subprocess.PIPE 117 | ) 118 | 119 | stdout, stderr = process.communicate() 120 | 121 | probe = json.loads(stdout.decode('utf-8')) 122 | 123 | audio_stream = next((stream for stream in probe['streams'] if stream['codec_type'] == 'audio'), None) 124 | 125 | if not audio_stream: 126 | return None 127 | 128 | path, file_extension = os.path.splitext(file_path) 129 | 130 | file_name = path.split('\\')[-1] 131 | path = path + file_extension 132 | 133 | duration = float(audio_stream['duration']) 134 | 135 | sample_rate = int(audio_stream['sample_rate']) 136 | num_samples = int(audio_stream['nb_frames']) if 'nb_frames' in audio_stream else int(sample_rate * duration) 137 | 138 | duration = f"{round(duration)}s" 139 | file_extension = file_extension.replace('.', '', 1) 140 | 141 | file_size = os.path.getsize(file_path) 142 | file_size = format_file_size(file_size) 143 | 144 | audio_file_info['file_name'] = file_name 145 | audio_file_info['file_extension'] = file_extension 146 | audio_file_info['path'] = path 147 | audio_file_info['duration'] = duration 148 | audio_file_info['file_size'] = file_size 149 | audio_file_info['samples'] = num_samples 150 | 151 | return audio_file_info -------------------------------------------------------------------------------- /src/generation/core.py: -------------------------------------------------------------------------------- 1 | import xml.etree.ElementTree as ET 2 | import os 3 | 4 | class SimpleSound: 5 | def __init__(self, track_data: dict, audio_bank_name: str, soundset_name: str, output_dir: str = './output'): 6 | """ 7 | SimpleSound setter function for file names and track data. 8 | """ 9 | 10 | self.track_data = track_data 11 | self.audio_bank_name = audio_bank_name 12 | self.soundset_name = soundset_name 13 | self.output_dir = output_dir 14 | self.data_dir = os.path.join(self.output_dir, 'data') 15 | self.audio_dir = os.path.join(self.output_dir, 'audiodirectory') 16 | 17 | os.makedirs(self.data_dir, exist_ok=True) 18 | os.makedirs(self.audio_dir, exist_ok=True) 19 | 20 | def construct(self): 21 | self._construct_awc() 22 | self._construct_dat54() 23 | self._construct_nametable() 24 | 25 | def _construct_nametable(self): 26 | filenames = [] 27 | 28 | for value in self.track_data.values(): 29 | filenames.append(value["track"] + '_s') 30 | 31 | filenames.append(self.audio_bank_name) 32 | 33 | with open(self.data_dir + f"\\{self.audio_bank_name}.dat54.nametable", "w") as handler: 34 | handler.write(" ".join(filenames)) 35 | handler.close() 36 | 37 | def _construct_awc(self): 38 | container_paths = {"Item": []} 39 | for value in self.track_data.values(): 40 | container_paths_track = f'{self.output_dir}\\{value["track"]}' 41 | container_paths["Item"].append(container_paths_track) 42 | 43 | track_info = [] 44 | for value in self.track_data.values(): 45 | simple_info = [ 46 | {"Item": {"Type": "peak"}}, 47 | {"Item": {"Type": "data"}}, 48 | { 49 | "Item": { 50 | "Type": "format", 51 | "Codec": "PCM", 52 | "Samples": {"@value": value["samples"]}, 53 | "SampleRate": {"@value": value["sample_rate"]}, 54 | "Headroom": {"@value": "-100"}, 55 | "PlayBegin": {"@value": "0"}, 56 | "PlayEnd": {"@value": "0"}, 57 | "LoopBegin": {"@value": "0"}, 58 | "LoopEnd": {"@value": "0"}, 59 | "LoopPoint": {"@value": "-1"}, 60 | "Peak": {"@unk": "0"}, 61 | } 62 | } 63 | ] 64 | streaming_sound = { 65 | "Item": { 66 | "Name": value["track"], 67 | "FileName": value["tracks"]["ss"], 68 | "Chunks": {"Item": [item["Item"] for item in simple_info]}, 69 | } 70 | } 71 | track_info.append(streaming_sound) 72 | 73 | obj = { 74 | "AudioWaveContainer": { 75 | "Version": {"@value": "1"}, 76 | "ChunkIndices": {"@value": "True"}, 77 | "Streams": {"Item": [item["Item"] for item in track_info]}, 78 | } 79 | } 80 | 81 | self.write_xml_file(obj, f'{self.audio_bank_name}.awc.xml') 82 | 83 | def _construct_dat54(self): 84 | container_paths = {"Item": []} 85 | for value in self.track_data.values(): 86 | container_paths_track = f'audiodirectory\\{value["track"]}' 87 | container_paths["Item"].append(container_paths_track) 88 | 89 | track_info = [] 90 | sound_set_info = [] 91 | for value in self.track_data.values(): 92 | simple_sound1 = { 93 | "Item": { 94 | "@type": "SimpleSound", 95 | "Name": f'{value["track"]}_sp', 96 | "Header": { 97 | "Flags": {"@value": self.merge_flags(value["flags"])}, 98 | "Volume": {"@value": "200"}, 99 | "Category": "scripted", 100 | }, 101 | "ContainerName": f'audiodirectory/{self.audio_bank_name}', 102 | "FileName": value["track"], 103 | "WaveSlotNum": {"@value": "0"}, 104 | } 105 | } 106 | track_info.append(simple_sound1) 107 | 108 | sound_sets = { 109 | "Item": { 110 | "ScriptName": value["track"], 111 | "ChildSound": f'{value["track"]}_sp', 112 | } 113 | } 114 | sound_set_info.append(sound_sets) 115 | 116 | simple_sound2 = { 117 | "Item": { 118 | "@type": "SoundSet", 119 | "Name": self.soundset_name, 120 | "Header": {"Flags": {"@value": "0xAAAAAAAA"}}, 121 | "SoundSets": {"Item": [item["Item"] for item in sound_set_info]}, 122 | } 123 | } 124 | track_info.append(simple_sound2) 125 | 126 | obj = { 127 | "Dat54": { 128 | "Version": {"@value": "7314721"}, 129 | "ContainerPaths": {"Item": f'audiodirectory\\{self.audio_bank_name}'}, 130 | "Items": {"Item": [item["Item"] for item in track_info]}, 131 | } 132 | } 133 | 134 | self.write_xml_file(obj, f'{self.audio_bank_name}.dat54.rel.xml') 135 | 136 | def merge_flags(self, flag_list: list): 137 | """ 138 | Small helper function for 16-bit hexadecimal addition for the `Flags` section of the Dat54 header. 139 | 140 | Raises: 141 | ------- 142 | ValueError 143 | In the case that a flag does not exist within the definition of the hex map below, a `ValueError` is thrown. 144 | """ 145 | 146 | hex_map = { 147 | 'Flags2': 0x00000001, 148 | 'Unk01': 0x00000002, 149 | 'Volume': 0x00000004, 150 | 'VolumeVariance': 0x00000008, 151 | 'Pitch': 0x00000010, 152 | 'PitchVariance': 0x00000020, 153 | 'Pan': 0x00000040, 154 | 'PanVariance': 0x00000080, 155 | 'PreDelay': 0x00000100, 156 | 'PreDelayVariance': 0x00000200, 157 | 'StartOffset': 0x00000400, 158 | 'StartOffsetVariance': 0x00000800, 159 | 'AttackTime': 0x00001000, 160 | 'ReleaseTime': 0x00002000, 161 | 'DopplerFactor': 0x00004000, 162 | 'Category': 0x00008000, 163 | 'LPFCutOff': 0x00010000, 164 | 'LPFCutOffVariance': 0x00020000, 165 | 'HPFCutOff': 0x00040000, 166 | 'HPFCutOffVariance': 0x00080000, 167 | 'UnkHash3': 0x00100000, 168 | 'DistanceAttentuation': 0x00200000, 169 | 'Unk19': 0x00400000, 170 | 'Unk20': 0x00800000 171 | } 172 | 173 | result = 0 174 | 175 | for field in flag_list: 176 | if field in hex_map: 177 | result += hex_map[field] 178 | else: 179 | raise ValueError(f"Unknown field name: {field}") 180 | 181 | return f"0x{result:08X}" 182 | 183 | def dict_to_element(self, tag, content): 184 | element = ET.Element(tag) 185 | 186 | for key, value in content.items(): 187 | if key.startswith('@'): 188 | element.set(key[1:], value) 189 | elif isinstance(value, dict): 190 | child = self.dict_to_element(key, value) 191 | element.append(child) 192 | elif isinstance(value, list): 193 | for item in value: 194 | child = self.dict_to_element(key, item) 195 | element.append(child) 196 | else: 197 | child = ET.SubElement(element, key) 198 | child.text = str(value) 199 | return element 200 | 201 | def write_xml_file(self, obj: dict, filename: str) -> bool: 202 | """ 203 | Write the XML output to the file based on the directory declared in `__init__()`. 204 | """ 205 | 206 | # Retrieve the first key from the dictionary `obj` and convert the key-value pair into an XML element 207 | root_element = self.dict_to_element(list(obj.keys())[0], obj[list(obj.keys())[0]]) 208 | tree = ET.ElementTree(root_element) 209 | 210 | ET.indent(tree, space=" ", level=0) 211 | 212 | if "dat54" in filename: 213 | output_file = os.path.join(self.data_dir, filename) 214 | elif "awc" in filename: 215 | output_file = os.path.join(self.audio_dir, filename) 216 | else: 217 | return False 218 | 219 | tree.write(output_file, encoding='utf-8', xml_declaration=True, method='xml') 220 | return True -------------------------------------------------------------------------------- /src/main.py: -------------------------------------------------------------------------------- 1 | import wx 2 | import sys 3 | import wave 4 | import time 5 | from helpers import get_file_info, save_project, open_project, convert_to_wav 6 | from components import menuBar, PropertiesPanel, SoundListPanel, DirDialog 7 | import generation 8 | 9 | # For Pyinstaller purposes 10 | # import pyi_splash 11 | # pyi_splash.close() 12 | 13 | current_project_path = "" 14 | current_project = {"sound_files": {}, "audiobank_name": "custom_sounds", "soundset_name": "custom_sounds", "fxmanifest": False} 15 | loaded_project = {"sound_files": {}, "audiobank_name": "custom_sounds", "soundset_name": "custom_sounds", "fxmanifest": False} 16 | 17 | class App(wx.Frame): 18 | def __init__(self, *args, **kwargs): 19 | kwargs["style"] = kwargs.get("style", 0) | wx.BORDER_SIMPLE | wx.DEFAULT_FRAME_STYLE 20 | wx.Frame.__init__(self, *args, **kwargs) 21 | 22 | self.SetSize((800, 600)) 23 | self.SetTitle("AWCMaster v2.2.2") 24 | self.SetBackgroundColour(wx.SystemSettings.GetColour(wx.SYS_COLOUR_WINDOW)) 25 | self.Bind(wx.EVT_CLOSE, self.onClose) 26 | 27 | icon = wx.IconLocation(sys.executable, 0) 28 | self.SetIcon(wx.Icon(icon)) 29 | 30 | self.frame_statusbar = self.CreateStatusBar(1, wx.STB_SIZEGRIP) 31 | self.frame_statusbar.SetStatusWidths([-1]) 32 | 33 | self.splitterParent = wx.SplitterWindow(self, wx.ID_ANY) 34 | self.splitterParent.SetMinimumPaneSize(20) 35 | 36 | self.leftSplitterPanel = wx.Panel(self.splitterParent, wx.ID_ANY) 37 | self.rightSplitterPanel = wx.Panel(self.splitterParent, wx.ID_ANY) 38 | 39 | left_sizer = wx.BoxSizer(wx.VERTICAL) 40 | right_sizer = wx.BoxSizer(wx.VERTICAL) 41 | self.leftSplitterPanel.SetSizer(left_sizer) 42 | self.rightSplitterPanel.SetSizer(right_sizer) 43 | 44 | self.properties_panel = PropertiesPanel(self.rightSplitterPanel) 45 | right_sizer.Add(self.properties_panel, 1, wx.EXPAND) 46 | 47 | self.sound_list_panel = SoundListPanel(self.leftSplitterPanel) 48 | left_sizer.Add(self.sound_list_panel, 1, wx.EXPAND) 49 | 50 | self.splitterParent.SplitVertically(self.leftSplitterPanel, self.rightSplitterPanel) 51 | 52 | self.sound_list_panel.addSoundBtn.Bind(wx.EVT_BUTTON, self.onAddSound) 53 | self.sound_list_panel.delSoundBtn.Bind(wx.EVT_BUTTON, self.onRemoveSound) 54 | self.sound_list_panel.Bind(wx.EVT_LIST_ITEM_SELECTED, self.onItemSelected) 55 | self.sound_list_panel.Bind(wx.EVT_LIST_ITEM_DESELECTED, self.onItemDeselected) 56 | self.properties_panel.generateBtn.Bind(wx.EVT_BUTTON, self.onGenerate) 57 | self.properties_panel.audiobankName.Bind(wx.EVT_TEXT, self.onAudiobankUpdate) 58 | self.properties_panel.soundsetName.Bind(wx.EVT_TEXT, self.onSoundsetUpdate) 59 | self.properties_panel.soundName.Bind(wx.EVT_TEXT, self.onSoundNameUpdate) 60 | self.properties_panel.sampleRate.Bind(wx.EVT_CHOICE, self.onSampleRateUpdate) 61 | self.properties_panel.flags.Bind(wx.EVT_CHECKLISTBOX, self.onFlagUpdate) 62 | 63 | self.properties_panel.SetDefaultProperties() 64 | self.Layout() 65 | 66 | def _get_current_sound(self) -> str: 67 | selected = self.sound_list_panel.soundsList.GetFirstSelected() 68 | 69 | if selected != -1: 70 | file_name = [file_name for file_name in current_project["sound_files"].keys()][selected] 71 | 72 | return file_name 73 | else: 74 | return False 75 | 76 | def onAudiobankUpdate(self, e): 77 | current_project["audiobank_name"] = self.properties_panel.audiobankName.GetValue() 78 | 79 | def onSoundsetUpdate(self, e): 80 | current_project["soundset_name"] = self.properties_panel.soundsetName.GetValue() 81 | 82 | def onSampleRateUpdate(self, e): 83 | selected = self._get_current_sound() 84 | 85 | if selected: 86 | index = self.properties_panel.sampleRate.GetSelection() 87 | 88 | current_item = current_project["sound_files"][selected] 89 | 90 | current_item["sample_rate"] = self.properties_panel.sampleRate.GetItems()[index] 91 | 92 | def onSoundNameUpdate(self, e): 93 | selected = self._get_current_sound() 94 | 95 | if selected: 96 | current_project["sound_files"][selected]["file_name"] = self.properties_panel.soundName.GetValue() 97 | 98 | # index = self.sound_list_panel.soundsList.GetFirstSelected() 99 | # self.sound_list_panel.soundsList.SetItem(index, 0, self.properties_panel.soundName.GetValue()) 100 | 101 | # The above bricks the selection code. Need to think of a better way to use the `current_project` dictionary 102 | 103 | def onFlagUpdate(self, e): 104 | selected = self._get_current_sound() 105 | 106 | if selected: 107 | current_project["sound_files"][selected]["flags"] = self.properties_panel.flags.GetCheckedStrings() 108 | 109 | def onGenerate(self, e): 110 | dirDialog = DirDialog(self) 111 | 112 | if dirDialog.ShowModal() == wx.ID_OK: 113 | path_name = dirDialog.GetPath() 114 | 115 | response = convert_to_wav(current_project, 116 | output_path=path_name + "\\output", 117 | fxmanifest = current_project["fxmanifest"] 118 | ) 119 | 120 | if "error" in response: 121 | wx.LogError(response["error"]) 122 | return 123 | 124 | current_project["sound_files"] = response["sound_files"] 125 | 126 | time.sleep(1) 127 | 128 | if self.properties_panel.soundType.GetStringSelection() == "SimpleSound": 129 | data = {} 130 | 131 | for key, item in current_project["sound_files"].items(): 132 | with wave.open(item["wav_path"], 'rb') as audio_file: 133 | sample_rate = audio_file.getframerate() 134 | num_frames = audio_file.getnframes() 135 | duration_seconds = num_frames / float(sample_rate) 136 | num_samples = int(sample_rate * duration_seconds) 137 | 138 | data[key] = { 139 | 'track': item["file_name"], 140 | 'flags': item["flags"], 141 | 'samples': str(num_samples), 142 | 'sample_rate': str(item["sample_rate"]), 143 | 'tracks': {'ss': f'{item["file_name"]}.wav'} 144 | } 145 | ss = generation.SimpleSound(data, 146 | self.properties_panel.audiobankName.GetValue(), 147 | self.properties_panel.soundsetName.GetValue(), 148 | path_name + "\\output" 149 | ) 150 | 151 | ss.construct() 152 | wx.MessageBox("Output was generated in " + path_name, "Success", 153 | wx.ICON_INFORMATION | wx.OK, self) 154 | 155 | def onItemDeselected(self, e): 156 | self.properties_panel.SetDefaultProperties() 157 | 158 | def onItemSelected(self, e): 159 | soundsList = self.sound_list_panel.soundsList 160 | 161 | index = soundsList.GetFirstSelected() 162 | 163 | if index >= 0: 164 | item = soundsList.GetItem(index, 0) 165 | file_name = item.GetText() 166 | current_file = current_project["sound_files"][file_name] 167 | 168 | self.properties_panel.soundName.ChangeValue(current_file["file_name"]) 169 | self.properties_panel.sampleRate.SetStringSelection(current_file["sample_rate"]) 170 | self.properties_panel.flags.SetCheckedStrings(current_file["flags"]) 171 | 172 | self.properties_panel.EnableProperties() 173 | 174 | def onRemoveSound(self, e): 175 | selected = self._get_current_sound() 176 | 177 | if selected: 178 | current_project["sound_files"].pop(selected) 179 | 180 | index = self.sound_list_panel.soundsList.GetFirstSelected() 181 | self.sound_list_panel.soundsList.DeleteItem(index) 182 | 183 | if self.sound_list_panel.soundsList.GetItemCount() < 1: 184 | self.properties_panel.SetDefaultProperties() 185 | self.sound_list_panel.delSoundBtn.Disable() 186 | else: 187 | self.sound_list_panel.soundsList.Select(0) 188 | else: 189 | wx.MessageBox("You need to select an item", "An error occurred", wx.ICON_ERROR | wx.OK) 190 | 191 | def onAddSound(self, e): 192 | with wx.FileDialog(self, "Open Audio File", wildcard="*.wav;*.mp3;*.ogg", 193 | style=wx.FD_OPEN | wx.FD_FILE_MUST_EXIST | wx.FD_MULTIPLE) as fileDialog: 194 | 195 | if fileDialog.ShowModal() == wx.ID_CANCEL: 196 | return 197 | 198 | paths = fileDialog.GetPaths() 199 | 200 | for path in paths: 201 | try: 202 | self.properties_panel.EnableProperties() 203 | 204 | info = get_file_info(path) 205 | 206 | if "error" in info: 207 | wx.LogError(info["error"]) 208 | return 209 | 210 | if info: 211 | current_project["sound_files"][info["file_name"]] = info 212 | 213 | current_file = current_project["sound_files"][info["file_name"]] 214 | current_file["flags"] = ["Volume", "Category"] 215 | current_file["sample_rate"] = "44100" 216 | 217 | data = [info["file_name"], info["file_extension"], info["duration"], info["file_size"]] 218 | 219 | if self.sound_list_panel.soundsList.FindItem(-1, info["file_name"]) == wx.NOT_FOUND: 220 | self.sound_list_panel.soundsList.Append(data) 221 | 222 | self.properties_panel.soundName.ChangeValue(info["file_name"]) 223 | self.sound_list_panel.delSoundBtn.Enable() 224 | 225 | except IOError: 226 | wx.LogError("Cannot open file '%s'." % path) 227 | 228 | def onClose(self, e): 229 | if e.CanVeto(): 230 | if loaded_project != current_project: 231 | if wx.MessageBox("Any unsaved changes will be lost", "Are you sure?", wx.ICON_QUESTION | wx.YES_NO) != wx.YES: 232 | e.Veto() 233 | return 234 | 235 | self.Destroy() 236 | 237 | class MyApp(wx.App): 238 | def OnInit(self): 239 | self.frame = App(None, wx.ID_ANY, "") 240 | self.SetTopWindow(self.frame) 241 | self.frame.Show() 242 | 243 | self.menu_bar = menuBar(self.frame) 244 | 245 | _menu_bar = self.menu_bar.frame_menubar 246 | 247 | _menu_bar.Bind(wx.EVT_MENU, self.newProj, _menu_bar.newProj) 248 | _menu_bar.Bind(wx.EVT_MENU, self.openProj, _menu_bar.openProj) 249 | _menu_bar.Bind(wx.EVT_MENU, self.saveProj, _menu_bar.saveProj) 250 | _menu_bar.Bind(wx.EVT_MENU, self.saveProjAs, _menu_bar.saveProjAs) 251 | _menu_bar.Bind(wx.EVT_MENU, self.fxManifest, _menu_bar.genFx) 252 | 253 | return True 254 | 255 | def fxManifest(self, e): 256 | if self.menu_bar.frame_menubar.genFx.IsChecked(): 257 | current_project["fxmanifest"] = True 258 | else: 259 | current_project["fxmanifest"] = False 260 | 261 | def newProj(self, e): 262 | if loaded_project != current_project: 263 | if wx.MessageBox("Any unsaved changes will be lost", "Are you sure?", 264 | wx.ICON_QUESTION | wx.YES_NO, self.frame) == wx.NO: 265 | return 266 | 267 | current_project["sound_files"] = {} 268 | 269 | self.frame.sound_list_panel.soundsList.DeleteAllItems() 270 | self.frame.properties_panel.SetDefaultProperties() 271 | 272 | def openProj(self, e): 273 | with wx.FileDialog(self.frame, "Open AWCMaster Project", wildcard="AWC Project (*.awcproj)|*.awcproj", 274 | style=wx.FD_OPEN | wx.FD_FILE_MUST_EXIST) as fileDialog: 275 | 276 | if fileDialog.ShowModal() == wx.ID_CANCEL: 277 | return 278 | 279 | if loaded_project != current_project: 280 | if wx.MessageBox("Any unsaved changes will be lost", "Are you sure?", 281 | wx.ICON_QUESTION | wx.YES_NO, self.frame) == wx.NO: 282 | return 283 | 284 | path_name = fileDialog.GetPath() 285 | 286 | global current_project_path 287 | current_project_path = path_name 288 | 289 | try: 290 | result = open_project(path_name) 291 | 292 | if result: 293 | self.frame.sound_list_panel.soundsList.DeleteAllItems() 294 | current_project["sound_files"] = result["sound_files"] 295 | for value in current_project["sound_files"].values(): 296 | self.frame.sound_list_panel.soundsList.Append( 297 | [ 298 | value["file_name"], 299 | value["file_extension"], 300 | value["duration"], 301 | value["file_size"] 302 | ] 303 | ) 304 | except IOError: 305 | wx.LogError("Cannot open file '%s'." % path_name) 306 | 307 | def saveProj(self, e): 308 | if current_project_path != "": 309 | save_project(current_project_path, current_project) 310 | else: 311 | self.saveProjAs(wx.EVT_BUTTON) 312 | 313 | def saveProjAs(self, e): 314 | with wx.FileDialog(self.frame, "Save AWCMaster Project", wildcard="AWC Project (*.awcproj)|*.awcproj", 315 | style=wx.FD_SAVE | wx.FD_OVERWRITE_PROMPT) as fileDialog: 316 | 317 | if fileDialog.ShowModal() == wx.ID_CANCEL: 318 | return 319 | 320 | path_name = fileDialog.GetPath() 321 | try: 322 | save_project(path_name, current_project) 323 | except IOError: 324 | wx.LogError("Cannot save current data in file '%s'." % path_name) 325 | 326 | def main(): 327 | app = MyApp(0) 328 | app.MainLoop() 329 | 330 | if __name__ == '__main__': 331 | main() -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------