├── index.md ├── _config.yml ├── .github ├── PULL_REQUEST_TEMPLATE.md └── ISSUE_TEMPLATE │ ├── mkpl-enhancement.md │ └── mkpl-issue.md ├── img └── mkpl_logo.svg ├── pyproject.toml ├── CODE_OF_CONDUCT.md ├── CHANGES.md ├── .gitignore ├── CONTRIBUTING.md ├── README.md ├── mkpl.py └── LICENSE.md /index.md: -------------------------------------------------------------------------------- 1 | README.md -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-leap-day 2 | name: Matteo Guadrini 3 | show_downloads: true 4 | description: "Make M3U format playlist from command line." -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | # Title of Pull Request 2 | 3 | ## List of changes 4 | 5 | - This pull request has a changes in the format: `changes is...`. 6 | - ✅ `Add function on pynosql` 7 | - ✅ `Add parameter -p/--parameter` 8 | - ✅ `Update readme.md` 9 | - ❌ `Delete part of documentation` 10 | 11 | ### Description of the proposed features 12 | 13 | Descriptive text of the features. 14 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/mkpl-enhancement.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: mkpl enhancement 3 | about: mkpl enhancement template 4 | title: mkpl enhancement 5 | labels: enhancement 6 | assignees: MatteoGuadrini 7 | --- 8 | 9 | ## Description 10 | 11 | Description of the proposal 12 | 13 | 14 | ## Proposed names of the parameters (short and long) 15 | 16 | * name parameter 17 | * possible argument(s) 18 | 19 | Additional context 20 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/mkpl-issue.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: mkpl bug 3 | about: mkpl bug template 4 | title: mkpl bug 5 | labels: bug 6 | assignees: MatteoGuadrini 7 | --- 8 | 9 | ## Description 10 | 11 | Description of problem 12 | 13 | ## Steps to Reproduce 14 | 15 | Line of code 16 | 17 | ## Expected Behaviour 18 | 19 | Description of what is expected 20 | 21 | ## Your Environment 22 | 23 | * mkpl version used: 24 | * Operating System and version: 25 | 26 | Additional context 27 | -------------------------------------------------------------------------------- /img/mkpl_logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["setuptools", "wheel"] 3 | build-backend = "setuptools.build_meta" 4 | 5 | [tool.setuptools] 6 | py-modules = ["mkpl"] 7 | 8 | [project] 9 | name = "make_playlist" 10 | version = "1.18.1" 11 | readme = "README.md" 12 | keywords = ["playlist", "multimedia", "file", "maker", "make", "m3u", "m3u8"] 13 | 14 | authors = [{ name = "Matteo Guadrini", email = "matteo.guadrini@hotmail.it" }] 15 | maintainers = [ 16 | { name = "Matteo Guadrini", email = "matteo.guadrini@hotmail.it" }, 17 | ] 18 | 19 | description = "Make M3U format playlist from command line." 20 | requires-python = ">=3.8" 21 | classifiers = [ 22 | "Programming Language :: Python :: 3", 23 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 24 | "Operating System :: OS Independent", 25 | ] 26 | dependencies = ["mutagen==1.47.0", "tempcache==0.0.11"] 27 | 28 | [project.scripts] 29 | mkpl = "mkpl:main" 30 | make_playlist = "mkpl:main" 31 | 32 | [project.urls] 33 | homepage = "https://github.com/MatteoGuadrini/mkpl" 34 | documentation = "https://matteoguadrini.github.io/mkpl/" 35 | changelog = "https://github.com/MatteoGuadrini/mkpl/blob/master/CHANGES.md" 36 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Code of Conduct 2 | 3 | As contributors and maintainers of this project, and in the interest of 4 | fostering an open and welcoming community, we pledge to respect all people who 5 | contribute through reporting issues, posting feature requests, updating 6 | documentation, submitting pull requests or patches, and other activities. 7 | 8 | We are committed to making participation in this project a harassment-free 9 | experience for everyone, regardless of level of experience, gender, gender 10 | identity and expression, sexual orientation, disability, personal appearance, 11 | body size, race, ethnicity, age, religion, or nationality. 12 | 13 | Examples of unacceptable behavior by participants include: 14 | 15 | * The use of sexualized language or imagery 16 | * Personal attacks 17 | * Trolling or insulting/derogatory comments 18 | * Public or private harassment 19 | * Publishing other's private information, such as physical or electronic 20 | addresses, without explicit permission 21 | * Other unethical or unprofessional conduct 22 | 23 | Project maintainers have the right and responsibility to remove, edit, or 24 | reject comments, commits, code, wiki edits, issues, and other contributions 25 | that are not aligned to this Code of Conduct, or to ban temporarily or 26 | permanently any contributor for other behaviors that they deem inappropriate, 27 | threatening, offensive, or harmful. 28 | 29 | By adopting this Code of Conduct, project maintainers commit themselves to 30 | fairly and consistently applying these principles to every aspect of managing 31 | this project. Project maintainers who do not follow or enforce the Code of 32 | Conduct may be permanently removed from the project team. 33 | 34 | This Code of Conduct applies both within project spaces and in public spaces 35 | when an individual is representing the project or its community. 36 | 37 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 38 | reported by contacting the project maintainers at msfdev@metasploit.com. If 39 | the incident involves a committer, you may report directly to 40 | egypt@metasploit.com or todb@metasploit.com. 41 | 42 | All complaints will be reviewed and investigated and will result in a 43 | response that is deemed necessary and appropriate to the circumstances. 44 | Maintainers are obligated to maintain confidentiality with regard to the 45 | reporter of an incident. 46 | 47 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 48 | version 1.3.0, available at 49 | [http://contributor-covenant.org/version/1/3/0/][version] 50 | 51 | [homepage]: http://contributor-covenant.org 52 | [version]: http://contributor-covenant.org/version/1/3/0/ -------------------------------------------------------------------------------- /CHANGES.md: -------------------------------------------------------------------------------- 1 | # Release notes 2 | 3 | ## 1.18.0 4 | Oct 05, 2025 5 | 6 | - Some fixes, refs #19 7 | - Add Playslist and PlaylistEntry objects 8 | - Refactor some code for improvement 9 | 10 | ## 1.17.0 11 | Sep 14, 2025 12 | 13 | - Add `add-info` argument, to add file information to playlist files, refs #19 14 | 15 | ## 1.16.0 16 | Aug 24, 2025 17 | 18 | - Add `unix` argument, to force Unix like separator char folder 19 | 20 | ## 1.15.0 21 | Jun 13, 2025 22 | 23 | - Add default for `playlist` positional argument with current directory name, refs# 16 24 | - Fix issue #17 25 | 26 | ## 1.14.0 27 | May 16, 2025 28 | 29 | - Add `max-length` cli argument 30 | - Add `max-size` cli argument 31 | 32 | ## 1.13.0 33 | May 03, 2025 34 | 35 | - Add `explain-error` cli argument 36 | - Add _mp4_ tag support 37 | 38 | ## 1.12.0 39 | Mar 31, 2025 40 | 41 | - Add `length` cli argument 42 | 43 | ## 1.11.0 44 | Nov 22, 2024 45 | 46 | - Add `exclude-pattern` cli argument 47 | - Add `file` cli argument 48 | - Add **human_size_to_byte** function 49 | - Fix `link` argument if it is a valid http link 50 | 51 | ## 1.10.0 52 | Jul 25, 2024 53 | 54 | - Add `url-chars` cli argument 55 | - Add `cache` cli argument, refs #10 56 | - Add **url_chars** function, refs #12 57 | - Fix _mkv_ extension, refs #13 58 | - Fix **orderby-track** return function, refs #14 59 | 60 | ## 1.9.0 61 | May 09, 2024 62 | 63 | - Add `orderby-size` cli argument 64 | - Add `orderby-length` cli argument 65 | - Add `interactive` cli argument 66 | - Add `count` cli argument 67 | - Add **confirm** function for _interactive_ mode 68 | 69 | ## 1.8.0 70 | Aug 03, 2023 71 | 72 | - Refactor _make_playlist_ function for better performance 73 | - Add standard path on unique argument 74 | - Add _open_multimedia_file_ function 75 | - Add `orderby-year` cli argument 76 | - Add `join` cli argument 77 | - Add mkpl logo 78 | - Migrate to pyproject.toml installation 79 | - Fix absolute name into _make_playlist_ function, refs #8 80 | - Fix check if playlist is not empty before writes it to file 81 | - Fix check extension of file before open tags 82 | 83 | ## 1.7.0 84 | Jun 12, 2023 85 | 86 | - Add _find_pattern_ function 87 | - Add find pattern for _ID3 tags_ 88 | - Add `orderby-track` cli argument: see issue #6 89 | - Add _encoding_ and _ignore error handling_ to `write_playlist` function: see issue #7 90 | - Fix reset _enabled_extensions_ with split argument 91 | 92 | ## 1.6.0 93 | Mar 07, 2023 94 | 95 | - Add `-o` or `--orderby-name` cli argument: see issue #4 96 | - Add `-O` or `--orderby-date` cli argument: see issue #4 97 | - Add support for _'opus'_ file format: see issue #5 98 | - Fix check playlist extension for _m3u8_ format 99 | - Fix asterisk and dot char into include argument 100 | 101 | ## 1.5.0 102 | Jan 13, 2023 103 | 104 | - _Refactor module_; all business logic into functions: **make_playlist**, **write_playlist** and **add_extension** 105 | - Add `-S` or `--split` cli argument: see issue #2 106 | - Fix check image and append mode 107 | - Fix _enabled_encoding_ when is just enabled 108 | 109 | ## 1.4.0 110 | Nov 10, 2022 111 | 112 | - Add _capwords_ function for title of playlist 113 | - Add checks for extension attribute in append mode 114 | - Add warnings for extensions enabled 115 | - Add checks for image file 116 | 117 | ## 1.3.0 118 | Oct 24, 2022 119 | 120 | - Add _verbose_ argument 121 | - Add _vprint_ function 122 | - Fix shuffle and extension issue #1 123 | - Fix new line in the append mode 124 | - Fix epilog message 125 | - Fix join with extension tags 126 | 127 | ## 1.2.0 128 | Sep 28, 2022 129 | 130 | - Add _windows_ argument 131 | - Fix file extension with UNICODE encode 132 | 133 | ## 1.1.0 134 | Sep 19, 2022 135 | 136 | - Add _title_ argument 137 | - Add _encoding_ argument 138 | - Add _image_ argument 139 | - Add _link_ argument 140 | 141 | ## 1.0.1 142 | Sep 9, 2022 143 | 144 | - Add _file_ formats 145 | - Add _get_args_ function 146 | - Add _file_in_playlist_ function 147 | - Add _main_ function 148 | - Add _playlist_ maker -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### PyCharm+all ### 2 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm 3 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 4 | 5 | # User-specific stuff 6 | .idea/**/workspace.xml 7 | .idea/**/tasks.xml 8 | .idea/**/usage.statistics.xml 9 | .idea/**/dictionaries 10 | .idea/**/shelf 11 | 12 | # Sensitive or high-churn files 13 | .idea/**/dataSources/ 14 | .idea/**/dataSources.ids 15 | .idea/**/dataSources.local.xml 16 | .idea/**/sqlDataSources.xml 17 | .idea/**/dynamic.xml 18 | .idea/**/uiDesigner.xml 19 | .idea/**/dbnavigator.xml 20 | 21 | # Gradle 22 | .idea/**/gradle.xml 23 | .idea/**/libraries 24 | 25 | # Gradle and Maven with auto-import 26 | # When using Gradle or Maven with auto-import, you should exclude module files, 27 | # since they will be recreated, and may cause churn. Uncomment if using 28 | # auto-import. 29 | # .idea/modules.xml 30 | # .idea/*.iml 31 | # .idea/modules 32 | 33 | # CMake 34 | cmake-build-*/ 35 | 36 | # Mongo Explorer plugin 37 | .idea/**/mongoSettings.xml 38 | 39 | # File-based project format 40 | *.iws 41 | 42 | # IntelliJ 43 | out/ 44 | 45 | # mpeltonen/sbt-idea plugin 46 | .idea_modules/ 47 | 48 | # JIRA plugin 49 | atlassian-ide-plugin.xml 50 | 51 | # Cursive Clojure plugin 52 | .idea/replstate.xml 53 | 54 | # Crashlytics plugin (for Android Studio and IntelliJ) 55 | com_crashlytics_export_strings.xml 56 | crashlytics.properties 57 | crashlytics-build.properties 58 | fabric.properties 59 | 60 | # Editor-based Rest Client 61 | .idea/httpRequests 62 | 63 | ### PyCharm+all Patch ### 64 | # Ignores the whole .idea folder and all .iml files 65 | # See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360 66 | 67 | .idea/ 68 | 69 | # Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023 70 | 71 | *.iml 72 | modules.xml 73 | .idea/misc.xml 74 | *.ipr 75 | 76 | ### Python ### 77 | # Byte-compiled / optimized / DLL files 78 | __pycache__/ 79 | *.py[cod] 80 | *$py.class 81 | 82 | # C extensions 83 | *.so 84 | 85 | # Distribution / packaging 86 | .Python 87 | build/ 88 | develop-eggs/ 89 | dist/ 90 | downloads/ 91 | eggs/ 92 | .eggs/ 93 | lib/ 94 | lib64/ 95 | parts/ 96 | sdist/ 97 | var/ 98 | wheels/ 99 | *.egg-info/ 100 | .installed.cfg 101 | *.egg 102 | MANIFEST 103 | 104 | # PyInstaller 105 | # Usually these files are written by a python script from a template 106 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 107 | *.manifest 108 | *.spec 109 | 110 | # Installer logs 111 | pip-log.txt 112 | pip-delete-this-directory.txt 113 | 114 | # Unit test / coverage pyreports 115 | htmlcov/ 116 | .tox/ 117 | .coverage 118 | .coverage.* 119 | .cache 120 | nosetests.xml 121 | coverage.xml 122 | *.cover 123 | .hypothesis/ 124 | .pytest_cache/ 125 | 126 | # Translations 127 | *.mo 128 | *.pot 129 | 130 | # Django stuff: 131 | *.log 132 | local_settings.py 133 | db.sqlite3 134 | 135 | # Flask stuff: 136 | instance/ 137 | .webassets-cache 138 | 139 | # Scrapy stuff: 140 | .scrapy 141 | 142 | # Sphinx documentation 143 | docs/_build/ 144 | 145 | # PyBuilder 146 | target/ 147 | 148 | # Jupyter Notebook 149 | .ipynb_checkpoints 150 | 151 | # pyenv 152 | .python-version 153 | 154 | # celery beat schedule file 155 | celerybeat-schedule 156 | 157 | # SageMath parsed files 158 | *.sage.py 159 | 160 | # Environments 161 | .env 162 | .venv 163 | env/ 164 | venv/ 165 | ENV/ 166 | env.bak/ 167 | venv.bak/ 168 | 169 | # Spyder project settings 170 | .spyderproject 171 | .spyproject 172 | 173 | # Rope project settings 174 | .ropeproject 175 | 176 | # mkdocs documentation 177 | /site 178 | 179 | # mypy 180 | .mypy_cache/ 181 | 182 | ### Python Patch ### 183 | .venv/ 184 | 185 | ### Python.VirtualEnv Stack ### 186 | # Virtualenv 187 | # http://iamzed.com/2009/05/07/a-primer-on-virtualenv/ 188 | [Ii]nclude 189 | [Ll]ib 190 | [Ll]ib64 191 | [Ll]ocal 192 | [Ss]cripts 193 | pyvenv.cfg 194 | pip-selfcheck.json 195 | 196 | ### VisualStudioCode ### 197 | .vscode/* 198 | 199 | 200 | # End of https://www.gitignore.io/api/python,pycharm+all,visualstudiocode 201 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | When contributing to this repository, please first discuss the change you wish to make via issue, 4 | email, or any other method with the owners of this repository before making a change. 5 | 6 | Please note we have a code of conduct, please follow it in all your interactions with the project. 7 | 8 | ## Pull Request Process 9 | 10 | 1. Be sure to use the Pull Request templates and its guidelines contained therein. 11 | 2. Update the README.md with details of changes. 12 | 3. Increase the version numbers in variable and manual to the new version that this 13 | Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). 14 | 4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 15 | do not have permission to do that, you may request the second reviewer to merge it for you. 16 | 17 | ## Code of Conduct 18 | 19 | ### Our Pledge 20 | 21 | In the interest of fostering an open and welcoming environment, we as 22 | contributors and maintainers pledge to making participation in our project and 23 | our community a harassment-free experience for everyone, regardless of age, body 24 | size, disability, ethnicity, gender identity and expression, level of experience, 25 | nationality, personal appearance, race, religion, or sexual identity and 26 | orientation. 27 | 28 | ### Our Standards 29 | 30 | Examples of behavior that contributes to creating a positive environment 31 | include: 32 | 33 | * Using welcoming and inclusive language 34 | * Being respectful of differing viewpoints and experiences 35 | * Gracefully accepting constructive criticism 36 | * Focusing on what is best for the community 37 | * Showing empathy towards other community members 38 | 39 | Examples of unacceptable behavior by participants include: 40 | 41 | * The use of sexualized language or imagery and unwelcome sexual attention or 42 | advances 43 | * Trolling, insulting/derogatory comments, and personal or political attacks 44 | * Public or private harassment 45 | * Publishing others' private information, such as a physical or electronic 46 | address, without explicit permission 47 | * Other conduct which could reasonably be considered inappropriate in a 48 | professional setting 49 | 50 | ### Our Responsibilities 51 | 52 | Project maintainers are responsible for clarifying the standards of acceptable 53 | behavior and are expected to take appropriate and fair corrective action in 54 | response to any instances of unacceptable behavior. 55 | 56 | Project maintainers have the right and responsibility to remove, edit, or 57 | reject comments, commits, code, wiki edits, issues, and other contributions 58 | that are not aligned to this Code of Conduct, or to ban temporarily or 59 | permanently any contributor for other behaviors that they deem inappropriate, 60 | threatening, offensive, or harmful. 61 | 62 | ### Scope 63 | 64 | This Code of Conduct applies both within project spaces and in public spaces 65 | when an individual is representing the project or its community. Examples of 66 | representing a project or community include using an official project e-mail 67 | address, posting via an official social media account, or acting as an appointed 68 | representative at an online or offline event. Representation of a project may be 69 | further defined and clarified by project maintainers. 70 | 71 | ### Enforcement 72 | 73 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 74 | reported by contacting the project team at [INSERT EMAIL ADDRESS]. All 75 | complaints will be reviewed and investigated and will result in a response that 76 | is deemed necessary and appropriate to the circumstances. The project team is 77 | obligated to maintain confidentiality with regard to the reporter of an incident. 78 | Further details of specific enforcement policies may be posted separately. 79 | 80 | Project maintainers who do not follow or enforce the Code of Conduct in good 81 | faith may face temporary or permanent repercussions as determined by other 82 | members of the project's leadership. 83 | 84 | ### Attribution 85 | 86 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 87 | available at [http://contributor-covenant.org/version/1/4][version] 88 | 89 | [homepage]: http://contributor-covenant.org 90 | [version]: http://contributor-covenant.org/version/1/4/ -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | mkpl **make_playlist**: Playlist maker 2 | ====== 3 | 4 | ``mkpl`` is a _command line tool_ to create playlist files (**[M3U](https://en.wikipedia.org/wiki/M3U) format**), automatically. 5 | 6 | ## Installation 7 | 8 | To install ``mkpl``, see here: 9 | 10 | ```console 11 | $ pip install make_playlist # for python enviroment 12 | 13 | $ git clone https://github.com/MatteoGuadrini/mkpl.git && cd mkpl 14 | $ pip install . # for others 15 | ``` 16 | 17 | ## Command arguments 18 | 19 | ``mkpl`` have many command line arguments. They are explained in this table: 20 | 21 | | short | long | description | args | 22 | |-------|-------------------|-----------------------------------------------|---------------------------| 23 | | -d | --directories | Directories that contains multimedia file | Path of directories | 24 | | -e | --exclude-dirs | Exclude directory paths | Path of directories | 25 | | -i | --include | Include other file format | Format of file. ex. mp3 | 26 | | -p | --pattern | Regular expression inclusion pattern | Regular expression string | 27 | | -P | --exclude-pattern | Regular expression exclusion pattern | Regular expression string | 28 | | -f | --format | Select only a file format | Format of file. ex. mp3 | 29 | | -s | --size | Minimum size (bytes, kb, mb, ...) | Bytes (kb, mb, gb, ...) | 30 | | -A | --max-size | Maximum size (bytes, kb, mb, ...) | Bytes (kb, mb, gb, ...) | 31 | | -M | --length | Minimum length | Seconds | 32 | | -X | --max-length | Maximum length | Seconds | 33 | | -m | --max-tracks | Maximum number of tracks | Number | 34 | | -t | --title | Playlist title | Title string | 35 | | -g | --encoding | Text encoding | UTF-8,ASCII,UNICODE | 36 | | -I | --image | Playlist image | Image path | 37 | | -l | --link | Add remote file links | Http links | 38 | | -F | --file | Add files | Files | 39 | | -j | --join | Join one or more other playlist files | Playlist files | 40 | | -n | --cache | Cache playlist results | Seconds | 41 | | -U | --url-chars | Substitute some chars with URL Encoding | | 42 | | -r | --recursive | Recursive search | | 43 | | -a | --absolute | Absolute file name | | 44 | | -s | --shuffle | Casual order | | 45 | | -u | --unique | The same files are not placed in the playlist | | 46 | | -c | --append | Continue playlist instead of override it | | 47 | | -w | --windows | Windows style folder separator | | 48 | | -x | --unix | Unix style folder separator | | 49 | | -v | --verbose | Enable verbosity (debug mode) | | 50 | | -S | --split | Split playlist by directories | | 51 | | -R | --interactive | Asks each file for confirmation | | 52 | | -C | --count | Count elements into playlist | | 53 | | -E | --explain-error | Explain error with traceback | | 54 | | -o | --orderby-name | Order playlist files by name | | 55 | | -O | --orderby-date | Order playlist files by creation date | | 56 | | -T | --orderby-track | Order playlist files by track | | 57 | | -y | --orderby-year | Order playlist files by year | | 58 | | -Z | --orderby-size | Order playlist files by size | | 59 | | -L | --orderby-length | Order playlist files by length | | 60 | | -N | --add-info | Add file information to playlist | | 61 | 62 | ## Examples 63 | 64 | 1. Create a playlist for one music album: 65 | 66 | ```bash 67 | cd myalbum 68 | mkpl myalbum.m3u 69 | # or 70 | mkpl 71 | ``` 72 | 73 | 2. Create a playlist for one music album and add other multimedia files (`-F` option): 74 | 75 | ```bash 76 | cd myalbum_special 77 | mkpl myalbum_special.m3u -F music_video.mp4 other_stuff/song1.mp3 other_stuff/song2.mp3 78 | ``` 79 | 80 | 3. Create a playlist of a film saga 81 | 82 | ```bash 83 | mkpl -d HarryPotter -f mkv HP_saga.m3u 84 | ``` 85 | 86 | 4. Create a shuffled playlist with my music collection; include only files with minimum size of 2 Megabyte...and with range 87 | 88 | ```bash 89 | mkpl -d "my_mp3_collection" "my_mp4_collection" -rs -z 2mb "my music.m3u" 90 | # Range between 2 and 4 Megabytes 91 | mkpl -d "my_mp3_collection" "my_mp4_collection" -rs -z 2mb -A 4Mb "my music.m3u" 92 | ``` 93 | 94 | 5. Create a shuffled playlist with my music collection and exclude dirs 95 | 96 | ```bash 97 | mkpl -d "my_mp3_collection" "my_mp4_collection" -r -s -e "my_mp3_collection/metallica" "my_mp3_collection/dk" -- "my music.m3u" 98 | ``` 99 | 100 | 6. Create a TV series playlist with max 15 tracks 101 | 102 | ```bash 103 | mkpl -d "my_series/GOT" -m 15 "got_first_15.m3u" 104 | ``` 105 | 106 | 7. Add into _my music_ playlist new songs and don't add same file 107 | 108 | ```bash 109 | mkpl -d "new_collection" -rsu "my music.m3u" -a 110 | ``` 111 | 112 | 8. Create playlist with music and video files if files is greater then 10MB 113 | 114 | ```bash 115 | mkpl -d "my_files" -r -z 10485760 "multimedia.m3u" 116 | ``` 117 | 118 | 9. Create playlist with only number one and two tracks with regular expression 119 | 120 | ```bash 121 | mkpl -d "my_mp3_collection" -r -p "^[12]|[012]{2}" "my music.m3u" 122 | ``` 123 | 124 | 10. Create a playlist for one music album and set the title: 125 | 126 | ```bash 127 | cd myalbum 128 | mkpl myalbum.m3u -t "My Album" 129 | ``` 130 | 131 | 11. Create a playlist and add _UTF-8_ encoding 132 | 133 | ```bash 134 | mkpl -d "new_collection" -r "my music.m3u" -g "UTF-8" 135 | ``` 136 | 137 | 12. Create a playlist and set image 138 | 139 | ```bash 140 | mkpl -d "new_collection" -r "my music.m3u" -I "new_collection/playlist_cover.jpg" 141 | ``` 142 | 143 | 13. Create a playlist and add remote file links 144 | 145 | ```bash 146 | mkpl -d "new_collection" -r "my music.m3u" -l http://192.168.1.123/mp3/song1.mp3, http://192.168.1.123/mp3/song2.mp4 147 | ``` 148 | 149 | 14. Create a playlist and set Windows backslash (\\) folder separator (for Windows OS) 150 | 151 | ```bash 152 | mkpl -d "new_collection" -r "my music.m3u" -w 153 | ``` 154 | 155 | 15. Split playlist into _N_ playlists fon _N_ directories 156 | 157 | ```bash 158 | mkpl -d "folder1" "folder2" "folder3" -r "my_music.m3u" -S 159 | ``` 160 | Result: 161 | ```console 162 | $> ls 163 | my_music.m3u 164 | folder1.m3u 165 | folder2.m3u 166 | folder3.m3u 167 | ... 168 | ``` 169 | 170 | 16. Sort playlist files by name (`-o`), by creation date (`-O`), by track number (`-T`), by year (`-y`), by size (`-Z`) or by length (`-L`): 171 | 172 | ```bash 173 | mkpl -d "new_collection" -r "my music.m3u" -o 174 | mkpl -d "new_collection" -r "my music.m3u" -O 175 | mkpl -d "new_collection" -r "my music.m3u" -T 176 | mkpl -d "new_collection" -r "my music.m3u" -y 177 | mkpl -d "new_collection" -r "my music.m3u" -Z 178 | mkpl -d "new_collection" -r "my music.m3u" -L 179 | ``` 180 | 181 | 17. Join the _"First playlist.m3u"_ and _"Second playlist.m3u8"_ with new **"Third playlist.m3u"**: 182 | 183 | ```bash 184 | mkpl -d "new_collection" -r "Third playlist" -j "First playlist.m3u" "Second playlist.m3u8" 185 | ``` 186 | 187 | 18. Counts the multimedia files: 188 | 189 | ```console 190 | mkpl -d "new_collection" -r "My new collection" -C 191 | 4023 192 | ``` 193 | 194 | 19. Asks confirmation for every file into folders: 195 | 196 | ```console 197 | mkpl -d "new_collection" -r "My new collection" -R 198 | Add file new_collection/sample1.mp3 to playlist? [Y/n]:y 199 | Add file new_collection/sample2.mp3 to playlist? [Y/n]:Y 200 | Add file new_collection/sample3.mp3 to playlist? [Y/n]:n 201 | Add file new_collection/sample4.mp3 to playlist? [Y/n]:N 202 | ``` 203 | 204 | 20. Includes mp3 files with minimum length of 42 seconds...and range: 205 | 206 | ```bash 207 | mkpl -d "music_collection" -M 42 "My new collection" 208 | # Range of minimum of 42 seconds and maximum of 300 seonds 209 | mkpl -d "music_collection" -M 42 -X 300 "My new collection" 210 | ``` 211 | 212 | 21. Add file infos to playlist with [#EXTINF](https://en.wikipedia.org/wiki/M3U#Extended_M3U) tag: 213 | 214 | ```bash 215 | mkpl -d "HeavyMetal/Master of Puppets" -N "master" 216 | cat "master.m3u" 217 | #EXTM3U 218 | #EXTINF:516,Metallica - Master of Puppets 219 | HeavyMetal/Master Of Puppets/02 - Master Of Puppets.mp3 220 | #EXTINF:312,Metallica - Battery 221 | HeavyMetal/Master Of Puppets/01 - Battery.mp3 222 | #EXTINF:397,Metallica - The Thing That Should Not Be 223 | HeavyMetal/Master Of Puppets/03 - The Thing That Should Not Be.mp3 224 | #EXTINF:508,Metallica - Orion 225 | HeavyMetal/Master Of Puppets/07 - Orion (Instrumental).mp3 226 | #EXTINF:497,Metallica - Disposable Heroes 227 | HeavyMetal/Master Of Puppets/05 - Disposable Heroes.mp3 228 | #EXTINF:330,Metallica - Damage, Inc. 229 | HeavyMetal/Master Of Puppets/08 - Damage, Inc..mp3 230 | #EXTINF:340,Metallica - Leper Messiah 231 | HeavyMetal/Master Of Puppets/06 - Leper Messiah.mp3 232 | #EXTINF:387,Metallica - Welcome Home (Sanitarium) 233 | HeavyMetal/Master Of Puppets/04 - Welcome Home (Sanitarium).mp3 234 | ``` 235 | 236 | ## Use it like Python module 237 | 238 | `mkpl` can also be used as a Python module to customize your scripts. 239 | 240 | ```python 241 | from make_playlist import * 242 | 243 | # Prepare playlist list: find multimedia files with name starts between a and f 244 | playlist = make_playlist('/Music/collections', 245 | ('mp3', 'mp4', 'aac'), 246 | '^[a-f].*', 247 | recursive=True, 248 | unique=True) 249 | 250 | # Write playlist to file 251 | write_playlist('/Music/AtoF.m3u', 'wt', playlist) 252 | ``` 253 | 254 | ## Open source 255 | _mkpl_ is an open source project. Any contribute, It's welcome. 256 | 257 | **A great thanks**. 258 | 259 | For donations, press this 260 | 261 | For me 262 | 263 | [![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.me/guos) 264 | 265 | For [Telethon](http://www.telethon.it/) 266 | 267 | The Telethon Foundation is a non-profit organization recognized by the Ministry of University and Scientific and Technological Research. 268 | They were born in 1990 to respond to the appeal of patients suffering from rare diseases. 269 | Come today, we are organized to dare to listen to them and answers, every day of the year. 270 | 271 | [Adopt the future](https://www.ioadottoilfuturo.it/) 272 | 273 | 274 | ## Treeware 275 | 276 | This package is [Treeware](https://treeware.earth). If you use it in production, 277 | then we ask that you [**buy the world a tree**](https://plant.treeware.earth/matteoguadrini/mkpl) to thank us for our work. 278 | By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats. 279 | 280 | [![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen?style=for-the-badge)](https://plant.treeware.earth/MatteoGuadrini/mkpl) 281 | 282 | 283 | ## Acknowledgments 284 | 285 | Thanks to Mark Lutz for writing the _Learning Python_ and _Programming Python_ books that make up my python foundation. 286 | 287 | Thanks to Kenneth Reitz and Tanya Schlusser for writing the _The Hitchhiker’s Guide to Python_ books. 288 | 289 | Thanks to Dane Hillard for writing the _Practices of the Python Pro_ books. 290 | 291 | Special thanks go to my wife, who understood the hours of absence for this development. 292 | Thanks to my children, for the daily inspiration they give me and to make me realize, that life must be simple. 293 | 294 | Thanks, Python! -------------------------------------------------------------------------------- /mkpl.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- encoding: utf-8 -*- 3 | # vim: se ts=4 et syn=python: 4 | 5 | # created by: matteo.guadrini 6 | # mkpl -- mkpl 7 | # 8 | # Copyright (C) 2025 Matteo Guadrini 9 | # 10 | # This program is free software: you can redistribute it and/or modify 11 | # it under the terms of the GNU General Public License as published by 12 | # the Free Software Foundation, either version 3 of the License, or 13 | # (at your option) any later version. 14 | # 15 | # This program is distributed in the hope that it will be useful, 16 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 17 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 | # GNU General Public License for more details. 19 | # 20 | # You should have received a copy of the GNU General Public License 21 | # along with this program. If not, see . 22 | 23 | """mkpl module. This is command line utility for playlist creation.""" 24 | 25 | # region imports 26 | import argparse 27 | import os.path 28 | import re 29 | import traceback 30 | from collections import namedtuple 31 | from filecmp import cmp 32 | from itertools import islice 33 | from os.path import abspath, basename, exists, getctime, getsize, isdir, join, normpath 34 | from pathlib import Path 35 | from random import shuffle 36 | from re import sub 37 | from string import capwords 38 | from urllib import parse 39 | 40 | from mutagen import File, MutagenError, id3, mp4 41 | from tempcache import TempCache 42 | 43 | # endregion 44 | 45 | # region globals 46 | AUDIO_FORMAT = { 47 | "mp1", 48 | "mp2", 49 | "mp3", 50 | "aac", 51 | "ogg", 52 | "wav", 53 | "wma", 54 | "m4a", 55 | "aiff", 56 | "flac", 57 | "alac", 58 | "opus", 59 | "ape", 60 | "webm", 61 | } 62 | VIDEO_FORMAT = { 63 | "mp4", 64 | "avi", 65 | "xvid", 66 | "divx", 67 | "mkv", 68 | "mpeg", 69 | "mpg", 70 | "mov", 71 | "wmv", 72 | "flv", 73 | "vob", 74 | "asf", 75 | "m4v", 76 | "3gp", 77 | "f4a", 78 | } 79 | FILE_FORMAT = AUDIO_FORMAT.union(VIDEO_FORMAT) 80 | EXPLAIN_ERROR = False 81 | CACHE = TempCache("mkpl", max_age=30) 82 | __version__ = "1.18.1" 83 | 84 | Playlist = namedtuple( 85 | "Playlist", ("files", "ext", "name", "encoding"), defaults=([], False, False, False) 86 | ) 87 | 88 | PlaylistEntry = namedtuple( 89 | "PlaylistEntry", ("file", "image", "extinf"), defaults=(None, False, False) 90 | ) 91 | 92 | # endregion 93 | 94 | 95 | # region functions 96 | def get_args(): 97 | """Get command-line arguments""" 98 | 99 | global FILE_FORMAT, EXPLAIN_ERROR, CACHE 100 | 101 | parser = argparse.ArgumentParser( 102 | description="Command line tool to create playlist files in M3U format.", 103 | epilog="See latest release from https://github.com/MatteoGuadrini/mkpl", 104 | ) 105 | orderby_group = parser.add_mutually_exclusive_group() 106 | separator_group = parser.add_mutually_exclusive_group() 107 | 108 | parser.add_argument( 109 | "playlist", 110 | help="Playlist file", 111 | type=str, 112 | default=os.path.join(os.getcwd(), os.path.split(os.getcwd())[1]), 113 | nargs=argparse.OPTIONAL, 114 | ) 115 | parser.add_argument("-v", "--verbose", help="Enable verbosity", action="store_true") 116 | parser.add_argument( 117 | "-V", "--version", help="Print version", action="version", version=__version__ 118 | ) 119 | parser.add_argument( 120 | "-d", 121 | "--directories", 122 | help="Directories that contains multimedia file", 123 | nargs=argparse.ONE_OR_MORE, 124 | default=[Path(".")], 125 | ) 126 | parser.add_argument( 127 | "-e", 128 | "--exclude-dirs", 129 | help="Exclude directory paths", 130 | nargs=argparse.ONE_OR_MORE, 131 | default=[], 132 | ) 133 | parser.add_argument( 134 | "-i", 135 | "--include", 136 | help="Include other file format", 137 | nargs=argparse.ONE_OR_MORE, 138 | metavar="FORMAT", 139 | ) 140 | parser.add_argument( 141 | "-p", "--pattern", help="Regular expression inclusion pattern", default=None 142 | ) 143 | parser.add_argument( 144 | "-P", 145 | "--exclude-pattern", 146 | help="Regular expression exclusion pattern", 147 | default=None, 148 | ) 149 | parser.add_argument( 150 | "-f", 151 | "--format", 152 | help="Select only a file format", 153 | type=str, 154 | choices=FILE_FORMAT, 155 | ) 156 | parser.add_argument( 157 | "-z", 158 | "--size", 159 | help="Minimum size (bytes, kb, mb, ...)", 160 | default="0", 161 | metavar="BYTES", 162 | ) 163 | parser.add_argument( 164 | "-A", 165 | "--max-size", 166 | help="Maximum size (bytes, kb, mb, ...)", 167 | default="0", 168 | metavar="BYTES", 169 | ) 170 | parser.add_argument( 171 | "-m", 172 | "--max-tracks", 173 | help="Maximum number of tracks", 174 | type=int, 175 | default=None, 176 | metavar="NUMBER", 177 | ) 178 | parser.add_argument("-t", "--title", help="Playlist title", default=None) 179 | parser.add_argument( 180 | "-g", 181 | "--encoding", 182 | help="Text encoding", 183 | choices=("UTF-8", "ASCII", "UNICODE"), 184 | default=None, 185 | ) 186 | parser.add_argument("-I", "--image", help="Playlist image", default=None) 187 | parser.add_argument( 188 | "-l", 189 | "--link", 190 | help="Add remote file links", 191 | nargs=argparse.ONE_OR_MORE, 192 | metavar="HTTP_LINK", 193 | default=[], 194 | ) 195 | parser.add_argument( 196 | "-F", 197 | "--file", 198 | help="Add file", 199 | nargs=argparse.ONE_OR_MORE, 200 | default=[], 201 | ) 202 | parser.add_argument( 203 | "-j", 204 | "--join", 205 | help="Join one or more other playlist files", 206 | nargs=argparse.ONE_OR_MORE, 207 | metavar="PLAYLISTS", 208 | default=[], 209 | ) 210 | parser.add_argument( 211 | "-M", "--length", help="Minimum length", default=0, metavar="SECONDS", type=int 212 | ) 213 | parser.add_argument( 214 | "-X", 215 | "--max-length", 216 | help="Maximum length", 217 | default=0, 218 | metavar="SECONDS", 219 | type=int, 220 | ) 221 | parser.add_argument( 222 | "-r", "--recursive", help="Recursive search", action="store_true" 223 | ) 224 | parser.add_argument( 225 | "-a", "--absolute", help="Absolute file name", action="store_true" 226 | ) 227 | parser.add_argument( 228 | "-u", 229 | "--unique", 230 | help="The same files are not placed in the playlist", 231 | action="store_true", 232 | ) 233 | parser.add_argument( 234 | "-c", 235 | "--append", 236 | help="Continue playlist instead of override it", 237 | action="store_true", 238 | ) 239 | separator_group.add_argument( 240 | "-w", "--windows", help="Windows style folder separator", action="store_true" 241 | ) 242 | separator_group.add_argument( 243 | "-x", "--unix", help="Unix style folder separator", action="store_true" 244 | ) 245 | parser.add_argument( 246 | "-S", "--split", help="Split playlist by directories", action="store_true" 247 | ) 248 | parser.add_argument( 249 | "-R", 250 | "--interactive", 251 | help="Asks each file for confirmation", 252 | action="store_true", 253 | ) 254 | parser.add_argument( 255 | "-N", 256 | "--add-info", 257 | help="Add file information to playlist. See EXTINF attribute", 258 | action="store_true", 259 | ) 260 | parser.add_argument( 261 | "-C", "--count", help="Count elements into playlist", action="store_true" 262 | ) 263 | parser.add_argument( 264 | "-E", 265 | "--explain-error", 266 | help="Explain error with traceback", 267 | action="store_true", 268 | ) 269 | orderby_group.add_argument( 270 | "-s", "--shuffle", help="Casual order", action="store_true" 271 | ) 272 | orderby_group.add_argument( 273 | "-o", "--orderby-name", help="Order playlist files by name", action="store_true" 274 | ) 275 | orderby_group.add_argument( 276 | "-O", "--orderby-date", help="Order playlist files by date", action="store_true" 277 | ) 278 | orderby_group.add_argument( 279 | "-T", 280 | "--orderby-track", 281 | help="Order playlist files by track", 282 | action="store_true", 283 | ) 284 | orderby_group.add_argument( 285 | "-y", 286 | "--orderby-year", 287 | help="Order playlist files by year", 288 | action="store_true", 289 | ) 290 | orderby_group.add_argument( 291 | "-Z", 292 | "--orderby-size", 293 | help="Order playlist files by size", 294 | action="store_true", 295 | ) 296 | orderby_group.add_argument( 297 | "-L", 298 | "--orderby-length", 299 | help="Order playlist files by length", 300 | action="store_true", 301 | ) 302 | orderby_group.add_argument( 303 | "-U", 304 | "--url-chars", 305 | help="Substitute some chars with URL Encoding (Percent Encoding)", 306 | action="store_true", 307 | ) 308 | orderby_group.add_argument( 309 | "-n", 310 | "--cache", 311 | help="Cache playlist results", 312 | type=int, 313 | metavar="SECONDS", 314 | ) 315 | 316 | arguments = parser.parse_args() 317 | 318 | # Check explain error 319 | if arguments.explain_error: 320 | EXPLAIN_ERROR = True 321 | 322 | # Check extension of playlist file 323 | if not arguments.playlist.endswith(".m3u"): 324 | if arguments.encoding == "UNICODE": 325 | if not arguments.playlist.endswith(".m3u8"): 326 | arguments.playlist += ".m3u8" 327 | else: 328 | arguments.playlist += ".m3u" 329 | 330 | # Check if playlist is not a directory 331 | if isdir(arguments.playlist): 332 | parser.error(f"{arguments.playlist} is a directory") 333 | 334 | # Open playlist file 335 | arguments.open_mode = "at+" if arguments.append else "wt" 336 | arguments.enabled_extensions = ( 337 | True 338 | if any( 339 | (arguments.title, arguments.encoding, arguments.image, arguments.add_info) 340 | ) 341 | else False 342 | ) 343 | arguments.enabled_title = True if arguments.title else False 344 | arguments.enabled_encoding = True if arguments.encoding else False 345 | # Verify extension attribute in append mode 346 | if arguments.append: 347 | with open(arguments.playlist, mode=arguments.open_mode) as opened_playlist: 348 | opened_playlist.seek(0) 349 | first_three_lines = list(islice(opened_playlist, 3)) 350 | for line in first_three_lines: 351 | if "#EXTM3U" in line: 352 | arguments.enabled_extensions = True 353 | if "#PLAYLIST" in line: 354 | arguments.enabled_title = True 355 | if "#EXTENC" in line: 356 | arguments.enabled_encoding = True 357 | # Check if extensions are disabled and image is specified 358 | if getsize(arguments.playlist) > 0: 359 | if not arguments.enabled_extensions and arguments.image: 360 | print( 361 | f"warning: image {arguments.image} has not " 362 | "been set because the extension flag" 363 | " is not present in the playlist" 364 | ) 365 | arguments.image = None 366 | 367 | # Check if image file exists 368 | if arguments.image: 369 | if not exists(arguments.image): 370 | parser.error(f"image file {arguments.image} does not exist") 371 | 372 | # Extend files format 373 | if arguments.include: 374 | FILE_FORMAT.update( 375 | set([fmt.strip("*").strip(".") for fmt in arguments.include]) 376 | ) 377 | 378 | # Select only one format 379 | if arguments.format: 380 | FILE_FORMAT = {arguments.format.strip("*").strip(".")} 381 | 382 | # Convert size string into number 383 | arguments.size = human_size_to_byte(arguments.size) 384 | arguments.max_size = human_size_to_byte(arguments.max_size) 385 | 386 | # Check link argument if it is a valid link 387 | if arguments.link: 388 | arguments.link = [ 389 | link for link in arguments.link if re.match("https?://", link) 390 | ] 391 | 392 | # Check if other files exists 393 | if arguments.file: 394 | arguments.file = [f for f in arguments.file if os.path.exists(f)] 395 | 396 | # Check min-max length 397 | if arguments.length and arguments.length == arguments.max_length: 398 | parser.error("minimum and maximum length must not has the same values") 399 | elif arguments.max_length and arguments.length >= arguments.max_length: 400 | parser.error("minimum length is upper of maximum length") 401 | 402 | # Define cache 403 | if arguments.cache: 404 | CACHE = TempCache("mkpl", max_age=arguments.cache) 405 | vprint(arguments.verbose, f"use cache {CACHE.path}") 406 | # Clean the cache 407 | CACHE.clear_items() 408 | 409 | return arguments 410 | 411 | 412 | def human_size_to_byte(size): 413 | """Convert human size into bytes 414 | 415 | :param size: size string 416 | :return: int 417 | """ 418 | size_name = ("b", "kb", "mb", "gb", "tb", "pb", "eb", "zb", "yb") 419 | size_parts = re.search("([0-9]+) ?([a-zA-Z]+)?", size) 420 | num, unit = int(size_parts[1]), size_parts[2] 421 | if unit: 422 | unit = unit.lower() 423 | unit = unit if "b" in unit else unit + "b" 424 | idx = size_name.index(unit) 425 | factor = 1024**idx 426 | size_bytes = num * factor 427 | else: 428 | size_bytes = num 429 | return size_bytes 430 | 431 | 432 | def confirm(file, default="y"): 433 | """Ask user to enter Y or N (case-insensitive) 434 | 435 | :file: file to add into playlist 436 | :default: default answer 437 | :return: True if the answer is Y. 438 | :rtype: bool 439 | """ 440 | while ( 441 | answer := input( 442 | "Add file {0} to playlist? {1}:".format( 443 | file, "[Y/n]" if default == "y" else "[y/N]" 444 | ) 445 | ).lower() 446 | ) not in ("y", "n"): 447 | # Check if default 448 | if not answer: 449 | answer = default 450 | break 451 | return answer == "y" 452 | 453 | 454 | def file_in_playlist(playlist: Playlist, file, root=None): 455 | """Check if file is in the playlist""" 456 | for f in playlist.files: 457 | # Get string path 458 | f = f.file 459 | # Skip extended tags 460 | if f.startswith("#"): 461 | continue 462 | # Check if absolute path in playlist 463 | if root: 464 | f = join(root, f) 465 | # Make standard the path 466 | f = unix_to_dos(f, viceversa=True) 467 | # Compare two files 468 | if cmp(f, file): 469 | return True 470 | return False 471 | 472 | 473 | def join_playlist(playlist: Playlist, *others): 474 | """Join current playlist with others""" 475 | for file in others: 476 | try: 477 | # open playlist, remove extensions and extend current playlist file 478 | lines = open(file).readlines() 479 | playlist.files.extend( 480 | [ 481 | PlaylistEntry(line.rstrip()) 482 | for line in lines 483 | if not line.startswith("#") 484 | ] 485 | ) 486 | except FileNotFoundError: 487 | print(f"warning: {file} file not found") 488 | except OSError as error: 489 | print(f"warning: {file} generated error: {error}") 490 | 491 | 492 | def url_chars(file): 493 | """URL encoding converts characters into a format that can be transmitted over the Internet.""" 494 | return parse.quote(file, safe="/") 495 | 496 | 497 | def report_issue(exc, tb=False): 498 | """Report issue""" 499 | print( 500 | "error: {0} on line {1}, with error {2}".format( 501 | type(exc).__name__, exc.__traceback__.tb_lineno, str(exc) 502 | ) 503 | ) 504 | if tb: 505 | traceback.print_exc() 506 | exit(1) 507 | 508 | 509 | def open_multimedia_file(path): 510 | """Open multimedia file 511 | 512 | :param path: multimedia file to open 513 | """ 514 | try: 515 | file = File(path) 516 | except MutagenError: 517 | print(f"warning: file '{path}' loading failed") 518 | return False 519 | return file 520 | 521 | 522 | def get_track(file: PlaylistEntry): 523 | """Get file by track for sort""" 524 | file = open_multimedia_file(file.file) 525 | if file and hasattr(file, "tags"): 526 | if isinstance(file.tags, id3.ID3Tags): 527 | default = id3.TRCK(text="0") 528 | ret = file.tags.get("TRCK", default)[0] 529 | elif isinstance(file.tags, mp4.MP4Tags): 530 | ret = file.tags.get("trkn", [(0, 0)])[0][0] 531 | if isinstance(ret, str) and ret.isdecimal(): 532 | return int(ret) 533 | return 0 534 | 535 | 536 | def get_year(file: PlaylistEntry): 537 | """Get file by year for sort""" 538 | file = open_multimedia_file(file.file) 539 | if file and hasattr(file, "tags"): 540 | if isinstance(file.tags, id3.ID3Tags): 541 | default = id3.TDOR(text=["0000"]) 542 | tags = file.tags.get("TDOR", default) 543 | if isinstance(tags, str): 544 | return tags 545 | elif isinstance(tags, (tuple, list)): 546 | return tags[0] 547 | elif isinstance(file.tags, mp4.MP4Tags): 548 | tags = file.tags.get("\xa9day", ["0000"]) 549 | if isinstance(tags, str): 550 | return tags 551 | elif isinstance(tags, (tuple, list)): 552 | return tags[0] 553 | return "0000" 554 | 555 | 556 | def get_length(file): 557 | """Get file by length for sort""" 558 | if isinstance(file, PlaylistEntry): 559 | file = open_multimedia_file(file.file) 560 | else: 561 | file = open_multimedia_file(file) 562 | if file and hasattr(file, "info"): 563 | return file.info.length if hasattr(file.info, "length") else 0.1 564 | return 0.1 565 | 566 | 567 | def get_ctime(file: PlaylistEntry): 568 | """Get file by creation time for sort""" 569 | return getctime(file.file) 570 | 571 | 572 | def get_size(file: PlaylistEntry): 573 | """Get file by size for sort""" 574 | return os.path.getsize(file.file) 575 | 576 | 577 | def find_pattern(pattern, path): 578 | """Find patter in a file and tags""" 579 | global AUDIO_FORMAT 580 | 581 | # Create compiled pattern 582 | if not isinstance(pattern, re.Pattern): 583 | pattern = re.compile(pattern) 584 | # Check pattern into filename 585 | if pattern.findall(path): 586 | return True 587 | # Check type of file 588 | ext = os.path.splitext(path)[1].replace(".", "").lower() 589 | if ext in AUDIO_FORMAT: 590 | file = open_multimedia_file(path) 591 | # Check supports of ID3 tags add compiled pattern 592 | if file and hasattr(file, "ID3"): 593 | # Check pattern into title 594 | if file.tags.get("TIT2"): 595 | if pattern.findall(file.tags.get("TIT2")[0]): 596 | return True 597 | # Check pattern into album 598 | if file.tags.get("TALB"): 599 | if pattern.findall(file.tags.get("TALB")[0]): 600 | return True 601 | return False 602 | 603 | 604 | def vprint(verbose, *messages): 605 | """Verbose print""" 606 | if verbose: 607 | print("debug:", *messages) 608 | 609 | 610 | def unix_to_dos(path, viceversa=False): 611 | """Substitute folder separator with windows separator 612 | 613 | :param path: path to substitute folder separator 614 | :param viceversa: dos to unix 615 | """ 616 | if viceversa: 617 | old_sep = r"\\" 618 | new_sep = "/" 619 | else: 620 | old_sep = "/" 621 | new_sep = r"\\" 622 | return sub(old_sep, new_sep, path) 623 | 624 | 625 | def escape_newlines(string: str): 626 | """Escape newline character""" 627 | return string.replace("\n", "\\n") 628 | 629 | 630 | def make_extinf(file): 631 | """Compose EXTINF attribute""" 632 | global AUDIO_FORMAT 633 | 634 | # String format EXTINF attribute: %seconds%,"%artist% - %title%" 635 | extinf_str = "{},{} - {}" 636 | # Check type of file 637 | ext = os.path.splitext(file)[1].replace(".", "").lower() 638 | if ext in AUDIO_FORMAT: 639 | file = open_multimedia_file(file) 640 | length = int(file.info.length) if hasattr(file.info, "length") else -1 641 | if isinstance(file.tags, id3.ID3Tags): 642 | artist = file.tags.get("TPE1", "") 643 | title = file.tags.get("TIT2", "") 644 | elif isinstance(file.tags, mp4.MP4Tags): 645 | artist = file.tags.get("\xa9ART", [""])[0] 646 | title = file.tags.get("\xa9nam", [""])[0] 647 | return extinf_str.format(length, artist, title).replace("\n", " ") 648 | return "Unknown extra infos" 649 | 650 | 651 | def write_playlist( 652 | playlist_file: str, 653 | open_mode: str, 654 | playlist: Playlist, 655 | max_tracks: int = None, 656 | ): 657 | """Write playlist into file""" 658 | encoding = playlist.encoding if playlist.encoding else None 659 | with open( 660 | playlist_file, 661 | mode=open_mode, 662 | encoding="UTF-8" if encoding == "UNICODE" else encoding, 663 | errors="ignore", 664 | ) as pl: 665 | # Enable playlist extension 666 | if playlist.ext: 667 | pl.write("#EXTM3U\n") 668 | if playlist.name: 669 | pl.write(f"#PLAYLIST:{capwords(playlist.name)}\n") 670 | if playlist.encoding: 671 | pl.write(f"#EXTENC:{playlist.encoding}\n") 672 | for file in playlist.files[:max_tracks]: 673 | if file.image: 674 | pl.write(f"#EXTIMG:{file.image}\n") 675 | if file.extinf: 676 | pl.write(f"#EXTINF:{file.extinf}\n") 677 | pl.write(file.file + "\n") 678 | 679 | 680 | @CACHE 681 | def make_playlist( 682 | directories, 683 | file_formats, 684 | extension=False, 685 | title=False, 686 | encoding=False, 687 | pattern=False, 688 | image=False, 689 | infos=False, 690 | exclude_pattern=None, 691 | sortby_name=False, 692 | sortby_date=False, 693 | sortby_track=False, 694 | sortby_year=False, 695 | sortby_size=False, 696 | sortby_length=False, 697 | sortby_shuffle=False, 698 | recursive=False, 699 | exclude_dirs=None, 700 | unique=False, 701 | absolute=False, 702 | min_size=0, 703 | max_size=0, 704 | min_length=0, 705 | max_length=0, 706 | url_char=False, 707 | windows=False, 708 | unix=False, 709 | interactive=False, 710 | links=None, 711 | other_files=None, 712 | verbose=False, 713 | ): 714 | """Make playlist list""" 715 | filelist = Playlist([], extension, title, encoding) 716 | exclude_dirs = [] if exclude_dirs is None else exclude_dirs 717 | for directory in directories: 718 | # Check if directory exists 719 | if not exists(directory): 720 | print(f"warning: {directory} does not exists") 721 | return filelist 722 | # Check if is a directory 723 | if not isdir(directory): 724 | print(f"warning: {directory} is not a directory") 725 | return filelist 726 | # Build a Path object 727 | path = Path(directory) 728 | root = path.parent 729 | vprint(verbose, f"current directory={path}, root={root}") 730 | for fmt in file_formats: 731 | # Check recursive 732 | folder = "**/*" if recursive else "*" 733 | files = path.glob(folder + f".{fmt}") 734 | # Process found files 735 | for file in files: 736 | # Get size of file 737 | size = file.stat().st_size 738 | # Check absolute file names 739 | file = str(file.resolve()) if absolute else str(file) 740 | # Check file match pattern 741 | if pattern: 742 | # Check re pattern 743 | compiled_pattern = re.compile(pattern) 744 | if not find_pattern(compiled_pattern, file): 745 | continue 746 | if exclude_pattern: 747 | # Check re pattern 748 | compiled_pattern = re.compile(exclude_pattern) 749 | if find_pattern(compiled_pattern, file): 750 | continue 751 | # Check if in exclude dirs 752 | if any([e_path in file for e_path in exclude_dirs]): 753 | continue 754 | # Check if file is in playlist 755 | if unique: 756 | if file_in_playlist( 757 | filelist, file, root=root if not absolute else None 758 | ): 759 | continue 760 | # Check minimum file size 761 | if min_size and size <= min_size: 762 | continue 763 | # Check maximum file size 764 | if max_size and size >= max_size: 765 | continue 766 | # Check minimum length 767 | if min_length and get_length(file) <= min_length: 768 | continue 769 | # Check maximum length 770 | if max_length and get_length(file) >= max_length: 771 | continue 772 | if interactive: 773 | if not confirm(file): 774 | continue 775 | vprint(verbose, f"add multimedia file {file}") 776 | # Substitute with Windows separator 777 | if windows: 778 | file = unix_to_dos(file) 779 | # Substitute with Unix separator 780 | elif unix: 781 | file = unix_to_dos(file, viceversa=True) 782 | # URL chars 783 | if url_char: 784 | file = url_chars(file) 785 | # Normalize file path 786 | file = escape_newlines(file) 787 | # Append entry file into playlist 788 | entry = PlaylistEntry( 789 | file, 790 | image, 791 | make_extinf(file) if infos else infos, 792 | ) 793 | filelist.files.append(entry) 794 | # Add link 795 | if links: 796 | filelist.files.extend( 797 | [ 798 | PlaylistEntry( 799 | link, 800 | image, 801 | False, 802 | ) 803 | for link in links 804 | ] 805 | ) 806 | # Add other files 807 | if other_files: 808 | filelist.files.extend( 809 | [ 810 | PlaylistEntry( 811 | other_file, 812 | image, 813 | make_extinf(other_file) if infos else infos, 814 | ) 815 | for other_file in other_files 816 | ] 817 | ) 818 | # Check sort 819 | if sortby_name: 820 | filelist.files.sort() 821 | elif sortby_date: 822 | filelist.files.sort(key=get_ctime) 823 | elif sortby_track: 824 | filelist.files.sort(key=get_track) 825 | elif sortby_year: 826 | filelist.files.sort(key=get_year) 827 | elif sortby_size: 828 | filelist.files.sort(key=get_size) 829 | elif sortby_length: 830 | filelist.files.sort(key=get_length) 831 | elif sortby_shuffle: 832 | shuffle(filelist.files) 833 | return filelist 834 | 835 | 836 | def main_cli(): 837 | """Make a playlist file""" 838 | 839 | args = get_args() 840 | vprint( 841 | args.verbose, 842 | f"formats={FILE_FORMAT}, recursive={args.recursive}, " 843 | f"pattern={args.pattern}, split={args.split}", 844 | ) 845 | if args.split: 846 | for directory in args.directories: 847 | playlist_name = basename(normpath(directory)) 848 | # Make multimedia list 849 | playlist = make_playlist( 850 | [directory], 851 | FILE_FORMAT, 852 | pattern=args.pattern, 853 | exclude_pattern=args.exclude_pattern, 854 | extension=args.enabled_extensions, 855 | title=capwords(directory), 856 | encoding=args.encoding, 857 | image=args.image, 858 | infos=args.add_info, 859 | sortby_name=args.orderby_name, 860 | sortby_date=args.orderby_date, 861 | sortby_track=args.orderby_track, 862 | sortby_year=args.orderby_year, 863 | sortby_size=args.orderby_size, 864 | sortby_length=args.orderby_length, 865 | sortby_shuffle=args.shuffle, 866 | recursive=args.recursive, 867 | exclude_dirs=args.exclude_dirs, 868 | unique=args.unique, 869 | absolute=args.absolute, 870 | min_size=args.size, 871 | max_size=args.max_size, 872 | min_length=args.length, 873 | max_length=args.max_length, 874 | url_char=args.url_chars, 875 | windows=args.windows, 876 | unix=args.unix, 877 | interactive=args.interactive, 878 | links=args.link, 879 | other_files=args.file, 880 | verbose=args.verbose, 881 | ) 882 | if playlist.files: 883 | vprint(args.verbose, f"write playlist {playlist_name}") 884 | # Write playlist to file 885 | extension = ".m3u" if args.encoding != "UNICODE" else ".m3u8" 886 | write_playlist(playlist_name + extension, args.open_mode, playlist) 887 | # Make multimedia list 888 | playlist = make_playlist( 889 | args.directories, 890 | FILE_FORMAT, 891 | pattern=args.pattern, 892 | exclude_pattern=args.exclude_pattern, 893 | extension=args.enabled_extensions, 894 | title=args.title, 895 | encoding=args.encoding, 896 | image=args.image, 897 | infos=args.add_info, 898 | sortby_name=args.orderby_name, 899 | sortby_date=args.orderby_date, 900 | sortby_track=args.orderby_track, 901 | sortby_year=args.orderby_year, 902 | sortby_size=args.orderby_size, 903 | sortby_length=args.orderby_length, 904 | sortby_shuffle=args.shuffle, 905 | recursive=args.recursive, 906 | exclude_dirs=args.exclude_dirs, 907 | unique=args.unique, 908 | absolute=args.absolute, 909 | min_size=args.size, 910 | max_size=args.max_size, 911 | min_length=args.length, 912 | max_length=args.max_length, 913 | url_char=args.url_chars, 914 | windows=args.windows, 915 | unix=args.unix, 916 | interactive=args.interactive, 917 | links=args.link, 918 | other_files=args.file, 919 | verbose=args.verbose, 920 | ) 921 | 922 | # Join other playlist files 923 | if args.join: 924 | join_playlist(playlist, *args.join) 925 | 926 | if playlist.files: 927 | vprint(args.verbose, f"write playlist {args.playlist}") 928 | # Write playlist to file 929 | write_playlist(args.playlist, args.open_mode, playlist, args.max_tracks) 930 | else: 931 | print( 932 | f"warning: no multimedia files are found here: {','.join([abspath(dir) for dir in args.directories])}" 933 | ) 934 | 935 | # Count files into playlist 936 | if args.count: 937 | print(len(playlist.files)) 938 | 939 | 940 | def main(): 941 | """Main function of make playlist""" 942 | try: 943 | main_cli() 944 | except Exception as err: 945 | report_issue(err, tb=EXPLAIN_ERROR) 946 | 947 | 948 | # endregion 949 | 950 | # region main 951 | if __name__ == "__main__": 952 | main() 953 | 954 | # endregion 955 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | ### GNU GENERAL PUBLIC LICENSE 2 | 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this 9 | license document, but changing it is not allowed. 10 | 11 | ### Preamble 12 | 13 | The GNU General Public License is a free, copyleft license for 14 | software and other kinds of works. 15 | 16 | The licenses for most software and other practical works are designed 17 | to take away your freedom to share and change the works. By contrast, 18 | the GNU General Public License is intended to guarantee your freedom 19 | to share and change all versions of a program--to make sure it remains 20 | free software for all its users. We, the Free Software Foundation, use 21 | the GNU General Public License for most of our software; it applies 22 | also to any other work released this way by its authors. You can apply 23 | it to your programs, too. 24 | 25 | When we speak of free software, we are referring to freedom, not 26 | price. Our General Public Licenses are designed to make sure that you 27 | have the freedom to distribute copies of free software (and charge for 28 | them if you wish), that you receive source code or can get it if you 29 | want it, that you can change the software or use pieces of it in new 30 | free programs, and that you know you can do these things. 31 | 32 | To protect your rights, we need to prevent others from denying you 33 | these rights or asking you to surrender the rights. Therefore, you 34 | have certain responsibilities if you distribute copies of the 35 | software, or if you modify it: responsibilities to respect the freedom 36 | of others. 37 | 38 | For example, if you distribute copies of such a program, whether 39 | gratis or for a fee, you must pass on to the recipients the same 40 | freedoms that you received. You must make sure that they, too, receive 41 | or can get the source code. And you must show them these terms so they 42 | know their rights. 43 | 44 | Developers that use the GNU GPL protect your rights with two steps: 45 | (1) assert copyright on the software, and (2) offer you this License 46 | giving you legal permission to copy, distribute and/or modify it. 47 | 48 | For the developers' and authors' protection, the GPL clearly explains 49 | that there is no warranty for this free software. For both users' and 50 | authors' sake, the GPL requires that modified versions be marked as 51 | changed, so that their problems will not be attributed erroneously to 52 | authors of previous versions. 53 | 54 | Some devices are designed to deny users access to install or run 55 | modified versions of the software inside them, although the 56 | manufacturer can do so. This is fundamentally incompatible with the 57 | aim of protecting users' freedom to change the software. The 58 | systematic pattern of such abuse occurs in the area of products for 59 | individuals to use, which is precisely where it is most unacceptable. 60 | Therefore, we have designed this version of the GPL to prohibit the 61 | practice for those products. If such problems arise substantially in 62 | other domains, we stand ready to extend this provision to those 63 | domains in future versions of the GPL, as needed to protect the 64 | freedom of users. 65 | 66 | Finally, every program is threatened constantly by software patents. 67 | States should not allow patents to restrict development and use of 68 | software on general-purpose computers, but in those that do, we wish 69 | to avoid the special danger that patents applied to a free program 70 | could make it effectively proprietary. To prevent this, the GPL 71 | assures that patents cannot be used to render the program non-free. 72 | 73 | The precise terms and conditions for copying, distribution and 74 | modification follow. 75 | 76 | ### TERMS AND CONDITIONS 77 | 78 | #### 0. Definitions. 79 | 80 | "This License" refers to version 3 of the GNU General Public License. 81 | 82 | "Copyright" also means copyright-like laws that apply to other kinds 83 | of works, such as semiconductor masks. 84 | 85 | "The Program" refers to any copyrightable work licensed under this 86 | License. Each licensee is addressed as "you". "Licensees" and 87 | "recipients" may be individuals or organizations. 88 | 89 | To "modify" a work means to copy from or adapt all or part of the work 90 | in a fashion requiring copyright permission, other than the making of 91 | an exact copy. The resulting work is called a "modified version" of 92 | the earlier work or a work "based on" the earlier work. 93 | 94 | A "covered work" means either the unmodified Program or a work based 95 | on the Program. 96 | 97 | To "propagate" a work means to do anything with it that, without 98 | permission, would make you directly or secondarily liable for 99 | infringement under applicable copyright law, except executing it on a 100 | computer or modifying a private copy. Propagation includes copying, 101 | distribution (with or without modification), making available to the 102 | public, and in some countries other activities as well. 103 | 104 | To "convey" a work means any kind of propagation that enables other 105 | parties to make or receive copies. Mere interaction with a user 106 | through a computer network, with no transfer of a copy, is not 107 | conveying. 108 | 109 | An interactive user interface displays "Appropriate Legal Notices" to 110 | the extent that it includes a convenient and prominently visible 111 | feature that (1) displays an appropriate copyright notice, and (2) 112 | tells the user that there is no warranty for the work (except to the 113 | extent that warranties are provided), that licensees may convey the 114 | work under this License, and how to view a copy of this License. If 115 | the interface presents a list of user commands or options, such as a 116 | menu, a prominent item in the list meets this criterion. 117 | 118 | #### 1. Source Code. 119 | 120 | The "source code" for a work means the preferred form of the work for 121 | making modifications to it. "Object code" means any non-source form of 122 | a work. 123 | 124 | A "Standard Interface" means an interface that either is an official 125 | standard defined by a recognized standards body, or, in the case of 126 | interfaces specified for a particular programming language, one that 127 | is widely used among developers working in that language. 128 | 129 | The "System Libraries" of an executable work include anything, other 130 | than the work as a whole, that (a) is included in the normal form of 131 | packaging a Major Component, but which is not part of that Major 132 | Component, and (b) serves only to enable use of the work with that 133 | Major Component, or to implement a Standard Interface for which an 134 | implementation is available to the public in source code form. A 135 | "Major Component", in this context, means a major essential component 136 | (kernel, window system, and so on) of the specific operating system 137 | (if any) on which the executable work runs, or a compiler used to 138 | produce the work, or an object code interpreter used to run it. 139 | 140 | The "Corresponding Source" for a work in object code form means all 141 | the source code needed to generate, install, and (for an executable 142 | work) run the object code and to modify the work, including scripts to 143 | control those activities. However, it does not include the work's 144 | System Libraries, or general-purpose tools or generally available free 145 | programs which are used unmodified in performing those activities but 146 | which are not part of the work. For example, Corresponding Source 147 | includes interface definition files associated with source files for 148 | the work, and the source code for shared libraries and dynamically 149 | linked subprograms that the work is specifically designed to require, 150 | such as by intimate data communication or control flow between those 151 | subprograms and other parts of the work. 152 | 153 | The Corresponding Source need not include anything that users can 154 | regenerate automatically from other parts of the Corresponding Source. 155 | 156 | The Corresponding Source for a work in source code form is that same 157 | work. 158 | 159 | #### 2. Basic Permissions. 160 | 161 | All rights granted under this License are granted for the term of 162 | copyright on the Program, and are irrevocable provided the stated 163 | conditions are met. This License explicitly affirms your unlimited 164 | permission to run the unmodified Program. The output from running a 165 | covered work is covered by this License only if the output, given its 166 | content, constitutes a covered work. This License acknowledges your 167 | rights of fair use or other equivalent, as provided by copyright law. 168 | 169 | You may make, run and propagate covered works that you do not convey, 170 | without conditions so long as your license otherwise remains in force. 171 | You may convey covered works to others for the sole purpose of having 172 | them make modifications exclusively for you, or provide you with 173 | facilities for running those works, provided that you comply with the 174 | terms of this License in conveying all material for which you do not 175 | control copyright. Those thus making or running the covered works for 176 | you must do so exclusively on your behalf, under your direction and 177 | control, on terms that prohibit them from making any copies of your 178 | copyrighted material outside their relationship with you. 179 | 180 | Conveying under any other circumstances is permitted solely under the 181 | conditions stated below. Sublicensing is not allowed; section 10 makes 182 | it unnecessary. 183 | 184 | #### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 185 | 186 | No covered work shall be deemed part of an effective technological 187 | measure under any applicable law fulfilling obligations under article 188 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 189 | similar laws prohibiting or restricting circumvention of such 190 | measures. 191 | 192 | When you convey a covered work, you waive any legal power to forbid 193 | circumvention of technological measures to the extent such 194 | circumvention is effected by exercising rights under this License with 195 | respect to the covered work, and you disclaim any intention to limit 196 | operation or modification of the work as a means of enforcing, against 197 | the work's users, your or third parties' legal rights to forbid 198 | circumvention of technological measures. 199 | 200 | #### 4. Conveying Verbatim Copies. 201 | 202 | You may convey verbatim copies of the Program's source code as you 203 | receive it, in any medium, provided that you conspicuously and 204 | appropriately publish on each copy an appropriate copyright notice; 205 | keep intact all notices stating that this License and any 206 | non-permissive terms added in accord with section 7 apply to the code; 207 | keep intact all notices of the absence of any warranty; and give all 208 | recipients a copy of this License along with the Program. 209 | 210 | You may charge any price or no price for each copy that you convey, 211 | and you may offer support or warranty protection for a fee. 212 | 213 | #### 5. Conveying Modified Source Versions. 214 | 215 | You may convey a work based on the Program, or the modifications to 216 | produce it from the Program, in the form of source code under the 217 | terms of section 4, provided that you also meet all of these 218 | conditions: 219 | 220 | - a) The work must carry prominent notices stating that you modified 221 | it, and giving a relevant date. 222 | - b) The work must carry prominent notices stating that it is 223 | released under this License and any conditions added under 224 | section 7. This requirement modifies the requirement in section 4 225 | to "keep intact all notices". 226 | - c) You must license the entire work, as a whole, under this 227 | License to anyone who comes into possession of a copy. This 228 | License will therefore apply, along with any applicable section 7 229 | additional terms, to the whole of the work, and all its parts, 230 | regardless of how they are packaged. This License gives no 231 | permission to license the work in any other way, but it does not 232 | invalidate such permission if you have separately received it. 233 | - d) If the work has interactive user interfaces, each must display 234 | Appropriate Legal Notices; however, if the Program has interactive 235 | interfaces that do not display Appropriate Legal Notices, your 236 | work need not make them do so. 237 | 238 | A compilation of a covered work with other separate and independent 239 | works, which are not by their nature extensions of the covered work, 240 | and which are not combined with it such as to form a larger program, 241 | in or on a volume of a storage or distribution medium, is called an 242 | "aggregate" if the compilation and its resulting copyright are not 243 | used to limit the access or legal rights of the compilation's users 244 | beyond what the individual works permit. Inclusion of a covered work 245 | in an aggregate does not cause this License to apply to the other 246 | parts of the aggregate. 247 | 248 | #### 6. Conveying Non-Source Forms. 249 | 250 | You may convey a covered work in object code form under the terms of 251 | sections 4 and 5, provided that you also convey the machine-readable 252 | Corresponding Source under the terms of this License, in one of these 253 | ways: 254 | 255 | - a) Convey the object code in, or embodied in, a physical product 256 | (including a physical distribution medium), accompanied by the 257 | Corresponding Source fixed on a durable physical medium 258 | customarily used for software interchange. 259 | - b) Convey the object code in, or embodied in, a physical product 260 | (including a physical distribution medium), accompanied by a 261 | written offer, valid for at least three years and valid for as 262 | long as you offer spare parts or customer support for that product 263 | model, to give anyone who possesses the object code either (1) a 264 | copy of the Corresponding Source for all the software in the 265 | product that is covered by this License, on a durable physical 266 | medium customarily used for software interchange, for a price no 267 | more than your reasonable cost of physically performing this 268 | conveying of source, or (2) access to copy the Corresponding 269 | Source from a network server at no charge. 270 | - c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 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 | - e) Convey the object code using peer-to-peer transmission, 288 | provided you inform other peers where the object code and 289 | Corresponding Source of the work are being offered to the general 290 | public at no charge under subsection 6d. 291 | 292 | A separable portion of the object code, whose source code is excluded 293 | from the Corresponding Source as a System Library, need not be 294 | included in conveying the object code work. 295 | 296 | A "User Product" is either (1) a "consumer product", which means any 297 | tangible personal property which is normally used for personal, 298 | family, or household purposes, or (2) anything designed or sold for 299 | incorporation into a dwelling. In determining whether a product is a 300 | consumer product, doubtful cases shall be resolved in favor of 301 | coverage. For a particular product received by a particular user, 302 | "normally used" refers to a typical or common use of that class of 303 | product, regardless of the status of the particular user or of the way 304 | in which the particular user actually uses, or expects or is expected 305 | to use, the product. A product is a consumer product regardless of 306 | whether the product has substantial commercial, industrial or 307 | non-consumer uses, unless such uses represent the only significant 308 | 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 312 | install and execute modified versions of a covered work in that User 313 | Product from a modified version of its Corresponding Source. The 314 | information must suffice to ensure that the continued functioning of 315 | the modified object code is in no case prevented or interfered with 316 | solely because 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 331 | updates for a work that has been modified or installed by the 332 | recipient, or for the User Product in which it has been modified or 333 | installed. Access to a network may be denied when the modification 334 | itself materially and adversely affects the operation of the network 335 | or violates the rules and protocols for communication across the 336 | network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | #### 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders 364 | of that material) supplement the terms of this License with terms: 365 | 366 | - a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 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 | - c) Prohibiting misrepresentation of the origin of that material, 372 | or requiring that modified versions of such material be marked in 373 | reasonable ways as different from the original version; or 374 | - d) Limiting the use for publicity purposes of names of licensors 375 | or authors of the material; or 376 | - e) Declining to grant rights under trademark law for use of some 377 | trade names, trademarks, or service marks; or 378 | - f) Requiring indemnification of licensors and authors of that 379 | material by anyone who conveys the material (or modified versions 380 | of it) with contractual assumptions of liability to the recipient, 381 | for any liability that these contractual assumptions directly 382 | impose on those licensors and authors. 383 | 384 | All other non-permissive additional terms are considered "further 385 | restrictions" within the meaning of section 10. If the Program as you 386 | received it, or any part of it, contains a notice stating that it is 387 | governed by this License along with a term that is a further 388 | restriction, you may remove that term. If a license document contains 389 | a further restriction but permits relicensing or conveying under this 390 | License, you may add to a covered work material governed by the terms 391 | of that license document, provided that the further restriction does 392 | not survive such relicensing or conveying. 393 | 394 | If you add terms to a covered work in accord with this section, you 395 | must place, in the relevant source files, a statement of the 396 | additional terms that apply to those files, or a notice indicating 397 | where to find the applicable terms. 398 | 399 | Additional terms, permissive or non-permissive, may be stated in the 400 | form of a separately written license, or stated as exceptions; the 401 | above requirements apply either way. 402 | 403 | #### 8. Termination. 404 | 405 | You may not propagate or modify a covered work except as expressly 406 | provided under this License. Any attempt otherwise to propagate or 407 | modify it is void, and will automatically terminate your rights under 408 | this License (including any patent licenses granted under the third 409 | paragraph of section 11). 410 | 411 | However, if you cease all violation of this License, then your license 412 | from a particular copyright holder is reinstated (a) provisionally, 413 | unless and until the copyright holder explicitly and finally 414 | terminates your license, and (b) permanently, if the copyright holder 415 | fails to notify you of the violation by some reasonable means prior to 416 | 60 days after the cessation. 417 | 418 | Moreover, your license from a particular copyright holder is 419 | reinstated permanently if the copyright holder notifies you of the 420 | violation by some reasonable means, this is the first time you have 421 | received notice of violation of this License (for any work) from that 422 | copyright holder, and you cure the violation prior to 30 days after 423 | your receipt of the notice. 424 | 425 | Termination of your rights under this section does not terminate the 426 | licenses of parties who have received copies or rights from you under 427 | this License. If your rights have been terminated and not permanently 428 | reinstated, you do not qualify to receive new licenses for the same 429 | material under section 10. 430 | 431 | #### 9. Acceptance Not Required for Having Copies. 432 | 433 | You are not required to accept this License in order to receive or run 434 | a copy of the Program. Ancillary propagation of a covered work 435 | occurring solely as a consequence of using peer-to-peer transmission 436 | to receive a copy likewise does not require acceptance. However, 437 | nothing other than this License grants you permission to propagate or 438 | modify any covered work. These actions infringe copyright if you do 439 | not accept this License. Therefore, by modifying or propagating a 440 | covered work, you indicate your acceptance of this License to do so. 441 | 442 | #### 10. Automatic Licensing of Downstream Recipients. 443 | 444 | Each time you convey a covered work, the recipient automatically 445 | receives a license from the original licensors, to run, modify and 446 | propagate that work, subject to this License. You are not responsible 447 | for enforcing compliance by third parties with this License. 448 | 449 | An "entity transaction" is a transaction transferring control of an 450 | organization, or substantially all assets of one, or subdividing an 451 | organization, or merging organizations. If propagation of a covered 452 | work results from an entity transaction, each party to that 453 | transaction who receives a copy of the work also receives whatever 454 | licenses to the work the party's predecessor in interest had or could 455 | give under the previous paragraph, plus a right to possession of the 456 | Corresponding Source of the work from the predecessor in interest, if 457 | the predecessor has it or can get it with reasonable efforts. 458 | 459 | You may not impose any further restrictions on the exercise of the 460 | rights granted or affirmed under this License. For example, you may 461 | not impose a license fee, royalty, or other charge for exercise of 462 | rights granted under this License, and you may not initiate litigation 463 | (including a cross-claim or counterclaim in a lawsuit) alleging that 464 | any patent claim is infringed by making, using, selling, offering for 465 | sale, or importing the Program or any portion of it. 466 | 467 | #### 11. Patents. 468 | 469 | A "contributor" is a copyright holder who authorizes use under this 470 | License of the Program or a work on which the Program is based. The 471 | work thus licensed is called the contributor's "contributor version". 472 | 473 | A contributor's "essential patent claims" are all patent claims owned 474 | or controlled by the contributor, whether already acquired or 475 | hereafter acquired, that would be infringed by some manner, permitted 476 | by this License, of making, using, or selling its contributor version, 477 | but do not include claims that would be infringed only as a 478 | consequence of further modification of the contributor version. For 479 | purposes of this definition, "control" includes the right to grant 480 | patent sublicenses in a manner consistent with the requirements of 481 | this License. 482 | 483 | Each contributor grants you a non-exclusive, worldwide, royalty-free 484 | patent license under the contributor's essential patent claims, to 485 | make, use, sell, offer for sale, import and otherwise run, modify and 486 | propagate the contents of its contributor version. 487 | 488 | In the following three paragraphs, a "patent license" is any express 489 | agreement or commitment, however denominated, not to enforce a patent 490 | (such as an express permission to practice a patent or covenant not to 491 | sue for patent infringement). To "grant" such a patent license to a 492 | party means to make such an agreement or commitment not to enforce a 493 | patent against the party. 494 | 495 | If you convey a covered work, knowingly relying on a patent license, 496 | and the Corresponding Source of the work is not available for anyone 497 | to copy, free of charge and under the terms of this License, through a 498 | publicly available network server or other readily accessible means, 499 | then you must either (1) cause the Corresponding Source to be so 500 | available, or (2) arrange to deprive yourself of the benefit of the 501 | patent license for this particular work, or (3) arrange, in a manner 502 | consistent with the requirements of this License, to extend the patent 503 | license to downstream recipients. "Knowingly relying" means you have 504 | actual knowledge that, but for the patent license, your conveying the 505 | covered work in a country, or your recipient's use of the covered work 506 | in a country, would infringe one or more identifiable patents in that 507 | country that you have reason to believe are valid. 508 | 509 | If, pursuant to or in connection with a single transaction or 510 | arrangement, you convey, or propagate by procuring conveyance of, a 511 | covered work, and grant a patent license to some of the parties 512 | receiving the covered work authorizing them to use, propagate, modify 513 | or convey a specific copy of the covered work, then the patent license 514 | you grant is automatically extended to all recipients of the covered 515 | work and works based on it. 516 | 517 | A patent license is "discriminatory" if it does not include within the 518 | scope of its coverage, prohibits the exercise of, or is conditioned on 519 | the non-exercise of one or more of the rights that are specifically 520 | granted under this License. You may not convey a covered work if you 521 | are a party to an arrangement with a third party that is in the 522 | business of distributing software, under which you make payment to the 523 | third party based on the extent of your activity of conveying the 524 | work, and under which the third party grants, to any of the parties 525 | who would receive the covered work from you, a discriminatory patent 526 | license (a) in connection with copies of the covered work conveyed by 527 | you (or copies made from those copies), or (b) primarily for and in 528 | connection with specific products or compilations that contain the 529 | covered work, unless you entered into that arrangement, or that patent 530 | license was granted, prior to 28 March 2007. 531 | 532 | Nothing in this License shall be construed as excluding or limiting 533 | any implied license or other defenses to infringement that may 534 | otherwise be available to you under applicable patent law. 535 | 536 | #### 12. No Surrender of Others' Freedom. 537 | 538 | If conditions are imposed on you (whether by court order, agreement or 539 | otherwise) that contradict the conditions of this License, they do not 540 | excuse you from the conditions of this License. If you cannot convey a 541 | covered work so as to satisfy simultaneously your obligations under 542 | this License and any other pertinent obligations, then as a 543 | consequence you may not convey it at all. For example, if you agree to 544 | terms that obligate you to collect a royalty for further conveying 545 | from those to whom you convey the Program, the only way you could 546 | satisfy both those terms and this License would be to refrain entirely 547 | from conveying the Program. 548 | 549 | #### 13. Use with the GNU Affero General Public License. 550 | 551 | Notwithstanding any other provision of this License, you have 552 | permission to link or combine any covered work with a work licensed 553 | under version 3 of the GNU Affero General Public License into a single 554 | combined work, and to convey the resulting work. The terms of this 555 | License will continue to apply to the part which is the covered work, 556 | but the special requirements of the GNU Affero General Public License, 557 | section 13, concerning interaction through a network will apply to the 558 | combination as such. 559 | 560 | #### 14. Revised Versions of this License. 561 | 562 | The Free Software Foundation may publish revised and/or new versions 563 | of the GNU General Public License from time to time. Such new versions 564 | will be similar in spirit to the present version, but may differ in 565 | detail to address new problems or concerns. 566 | 567 | Each version is given a distinguishing version number. If the Program 568 | specifies that a certain numbered version of the GNU General Public 569 | License "or any later version" applies to it, you have the option of 570 | following the terms and conditions either of that numbered version or 571 | of any later version published by the Free Software Foundation. If the 572 | Program does not specify a version number of the GNU General Public 573 | License, you may choose any version ever published by the Free 574 | Software Foundation. 575 | 576 | If the Program specifies that a proxy can decide which future versions 577 | of the GNU General Public License can be used, that proxy's public 578 | statement of acceptance of a version permanently authorizes you to 579 | choose that version for the Program. 580 | 581 | Later license versions may give you additional or different 582 | permissions. However, no additional obligations are imposed on any 583 | author or copyright holder as a result of your choosing to follow a 584 | later version. 585 | 586 | #### 15. Disclaimer of Warranty. 587 | 588 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 589 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 590 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT 591 | WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT 592 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 593 | A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND 594 | PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 595 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR 596 | CORRECTION. 597 | 598 | #### 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR 602 | CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 603 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES 604 | ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT 605 | NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR 606 | LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM 607 | TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER 608 | PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 609 | 610 | #### 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | ### How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these 626 | terms. 627 | 628 | To do so, attach the following notices to the program. It is safest to 629 | attach them to the start of each source file to most effectively state 630 | the exclusion of warranty; and each file should have at least the 631 | "copyright" line and a pointer to where the full notice is found. 632 | 633 | 634 | Copyright (C) 635 | 636 | This program is free software: you can redistribute it and/or modify 637 | it under the terms of the GNU General Public License as published by 638 | the Free Software Foundation, either version 3 of the License, or 639 | (at your option) any later version. 640 | 641 | This program is distributed in the hope that it will be useful, 642 | but WITHOUT ANY WARRANTY; without even the implied warranty of 643 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 644 | GNU General Public License for more details. 645 | 646 | You should have received a copy of the GNU General Public License 647 | along with this program. If not, see . 648 | 649 | Also add information on how to contact you by electronic and paper 650 | 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 661 | appropriate parts of the General Public License. Of course, your 662 | program's commands might be different; for a GUI interface, you would 663 | use an "about box". 664 | 665 | You should also get your employer (if you work as a programmer) or 666 | school, if any, to sign a "copyright disclaimer" for the program, if 667 | necessary. For more information on this, and how to apply and follow 668 | the GNU GPL, see . 669 | 670 | The GNU General Public License does not permit incorporating your 671 | program into proprietary programs. If your program is a subroutine 672 | library, you may consider it more useful to permit linking proprietary 673 | applications with the library. If this is what you want to do, use the 674 | GNU Lesser General Public License instead of this License. But first, 675 | please read . 676 | --------------------------------------------------------------------------------