├── .github
├── ISSUE_TEMPLATE
│ └── bug_report.md
└── workflows
│ ├── pylint.yml
│ ├── pytest.yml
│ └── python-publish.yml
├── .gitignore
├── LICENSE
├── README.md
├── manifests
├── aws-media-tailor-vod-personalized-response-manifest.mpd
├── bigBuckBunny-onDemend.mpd
├── bigBuckBunny-simple.mpd
├── bitmovin-sample.mpd
├── chunked-single-bitrate.mpd
├── client_manifest-720p-stereo-events.mpd
├── client_manifest-audio.mpd
├── client_manifest-ctv-events.mpd
├── client_manifest-events-multilang.mpd
├── client_manifest-events-nodvb.mpd
├── client_manifest-events.mpd
├── client_manifest-nointerlace-events.mpd
├── client_manifest-nosurround-ctv-multilang.mpd
├── client_manifest-pto_both-events.mpd
├── client_manifest.mpd
└── multirate.mpd
├── pylintrc
├── pyproject.toml
├── pytest.ini
├── requirements.txt
├── setup.cfg
├── src
└── mpd_parser
│ ├── __init__.py
│ ├── attribute_parsers.py
│ ├── constants.py
│ ├── exceptions.py
│ ├── models
│ ├── __init__.py
│ ├── base_tags.py
│ ├── composite_tags.py
│ └── segment_tags.py
│ ├── parser.py
│ └── timeline_utils.py
└── tests
├── __init__.py
├── conftest.py
├── test_assignment.py
├── test_attribute_parsers.py
├── test_base_tags.py
├── test_composite_tags.py
└── test_manifets.py
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Bug report
3 | about: Create a report to help us improve
4 | title: "[BUG] bug oneliner here"
5 | labels: bug
6 | assignees: avishaycohen
7 |
8 | ---
9 |
10 | **Describe the bug**
11 | A clear and concise description of what the bug is.
12 |
13 | **Setup**
14 | 1. Python version
15 | 2. mpd-parser version
16 | 3. any other system info you think is relevent
17 |
18 | **Expected behavior**
19 | A clear and concise description of what you expected to happen.
20 |
21 | **Actual behavior**
22 | what happend instead of the expected behavior.
23 |
24 | **Stacktrace of the error**
25 | if applicable
26 | ```bash
27 | please add the python traceback here
28 | ```
29 |
30 | **Screenshots**
31 | If applicable, add screenshots to help explain your problem.
32 |
33 | **Additional context**
34 | Add any other context about the problem here.
35 |
--------------------------------------------------------------------------------
/.github/workflows/pylint.yml:
--------------------------------------------------------------------------------
1 | name: Pylint
2 |
3 | on: [push]
4 |
5 | jobs:
6 | build:
7 | runs-on: ubuntu-latest
8 | strategy:
9 | matrix:
10 | python-version: ["3.8", "3.9", "3.10", "3.11"]
11 | steps:
12 | - uses: actions/checkout@v3
13 | - name: Set up Python ${{ matrix.python-version }}
14 | uses: actions/setup-python@v3
15 | with:
16 | python-version: ${{ matrix.python-version }}
17 | - name: Install dependencies
18 | run: |
19 | python -m pip install --upgrade pip
20 | pip install -r ./requirements.txt
21 | - name: Analysing the code with pylint
22 | run: |
23 | pylint $(git ls-files -- '*.py') --fail-under 9
24 |
--------------------------------------------------------------------------------
/.github/workflows/pytest.yml:
--------------------------------------------------------------------------------
1 | name: Pytest
2 |
3 | on: [push]
4 |
5 | jobs:
6 | test:
7 | runs-on: ubuntu-latest
8 | strategy:
9 | matrix:
10 | python-version: ["3.8", "3.9", "3.10", "3.11"]
11 | steps:
12 | - uses: actions/checkout@v3
13 | - name: Set up Python ${{ matrix.python-version }}
14 | uses: actions/setup-python@v3
15 | with:
16 | python-version: ${{ matrix.python-version }}
17 | - name: Install dependencies
18 | run: |
19 | python -m pip install --upgrade pip
20 | pip install -r ./requirements.txt
21 | - name: Testing the code with pytest
22 | run: |
23 | cd tests
24 | pytest $(git ls-files -- '*.py')
--------------------------------------------------------------------------------
/.github/workflows/python-publish.yml:
--------------------------------------------------------------------------------
1 | # This workflow will upload a Python Package using Twine when a release is created
2 | # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
3 |
4 | # This workflow uses actions that are not certified by GitHub.
5 | # They are provided by a third-party and are governed by
6 | # separate terms of service, privacy policy, and support
7 | # documentation.
8 |
9 | name: Upload Python Package
10 |
11 | on:
12 | release:
13 | types: [published]
14 |
15 | permissions:
16 | contents: read
17 |
18 | jobs:
19 | deploy:
20 |
21 | runs-on: ubuntu-latest
22 |
23 | steps:
24 | - uses: actions/checkout@v3
25 | - name: Setup Python
26 | uses: actions/setup-python@v4.3.0
27 | with:
28 | python-version: '3.11'
29 | - name: Install dependencies
30 | run: |
31 | python -m pip install --upgrade pip
32 | pip install build
33 | - name: Build package
34 | run: python -m build
35 | - name: Publish package
36 | uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
37 | with:
38 | user: __token__
39 | password: ${{ secrets.PYPI_API_TOKEN }}
40 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | build/
12 | develop-eggs/
13 | dist/
14 | downloads/
15 | eggs/
16 | .eggs/
17 | lib/
18 | lib64/
19 | parts/
20 | sdist/
21 | var/
22 | wheels/
23 | pip-wheel-metadata/
24 | share/python-wheels/
25 | *.egg-info/
26 | .installed.cfg
27 | *.egg
28 | MANIFEST
29 |
30 | # PyInstaller
31 | # Usually these files are written by a python script from a template
32 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
33 | *.manifest
34 | *.spec
35 |
36 | # Installer logs
37 | pip-log.txt
38 | pip-delete-this-directory.txt
39 |
40 | # Unit test / coverage reports
41 | htmlcov/
42 | .tox/
43 | .nox/
44 | .coverage
45 | .coverage.*
46 | .cache
47 | nosetests.xml
48 | coverage.xml
49 | *.cover
50 | *.py,cover
51 | .hypothesis/
52 | .pytest_cache/
53 |
54 | # Translations
55 | *.mo
56 | *.pot
57 |
58 | # Django stuff:
59 | *.log
60 | local_settings.py
61 | db.sqlite3
62 | db.sqlite3-journal
63 |
64 | # Flask stuff:
65 | instance/
66 | .webassets-cache
67 |
68 | # Scrapy stuff:
69 | .scrapy
70 |
71 | # Sphinx documentation
72 | docs/_build/
73 |
74 | # PyBuilder
75 | target/
76 |
77 | # Jupyter Notebook
78 | .ipynb_checkpoints
79 |
80 | # IPython
81 | profile_default/
82 | ipython_config.py
83 |
84 | # pyenv
85 | .python-version
86 |
87 | # pipenv
88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies
90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not
91 | # install all needed dependencies.
92 | #Pipfile.lock
93 |
94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow
95 | __pypackages__/
96 |
97 | # Celery stuff
98 | celerybeat-schedule
99 | celerybeat.pid
100 |
101 | # SageMath parsed files
102 | *.sage.py
103 |
104 | # Environments
105 | .env
106 | .venv
107 | env/
108 | venv/
109 | ENV/
110 | env.bak/
111 | venv.bak/
112 |
113 | # Spyder project settings
114 | .spyderproject
115 | .spyproject
116 |
117 | # Rope project settings
118 | .ropeproject
119 |
120 | # mkdocs documentation
121 | /site
122 |
123 | # mypy
124 | .mypy_cache/
125 | .dmypy.json
126 | dmypy.json
127 |
128 | # Pyre type checker
129 | .pyre/
130 |
131 | # visual studio code
132 | .vscode
133 |
134 | # Pycharm
135 | .idea
136 |
137 | # Windows python venv
138 | /Scripts/
139 | pyvenv.cfg
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2022 avishaycohen
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # mpd-parser
2 |
3 | ## Installation
4 | ```shell
5 | $ python -m pip install mpd-parser
6 | ```
7 |
8 | ## Usage
9 | ### Importing
10 |
11 | ```python
12 | from mpd_parser.parser import Parser
13 | ```
14 | ### parse from string
15 | ```python
16 | with open("path/to/file.mpd", mode="r") as manifest_file:
17 | mpd_string = manifest_file.read()
18 | parsed_mpd = Parser.from_string(mpd_string)
19 | ```
20 |
21 | ### parse from file
22 | ```python
23 | input_file = "path/to/file.mpd"
24 | mpd = Parser.from_file(input_file)
25 | ```
26 |
27 | ### convert back to string
28 | ```python
29 | mpd_as_xml_string = Parser.to_string(parsed_mpd)
30 | ```
31 |
32 | ## Overview
33 | A utility to parse mpeg dash mpd files quickly
34 | This package is heavily inspired by [mpegdash package](https://github.com/sangwonl/python-mpegdash) the main difference is that I choose to relay on lxml for parsing, and not the standard xml library.
35 |
36 | The decision to implement it with lxml is for two reasons:
37 | 1. lxml is faster then minidom
38 | 2. lxml mimics the ElementTree API which is a more pythonic approach to XMLs
39 |
40 | mpegdash package has two distinct advantages over this package:
41 | 1. it does not require third party libraries.
42 | 2. it uses the classic DOM approach to parsing XML files. it is a well known standard.
43 |
44 | ## Benchmarks
45 | TBA
46 |
47 | ## Example manifests
48 | Taken from https://ottverse.com/free-mpeg-dash-mpd-manifest-example-test-urls/
49 | These are what I used to test and benchmark the package.
50 |
51 | ## Missing unit-tests
52 | 1. tags
53 | 2. attribute parsers
54 | 3. full manifest testing
55 |
56 | ## Contributing
57 | TBA
58 |
59 | ### Build locally
60 | ```shell
61 | python -m build
62 | ```
63 | ### Run pylint locally
64 | I try to keep the pylint score above 9.
65 | ```shell
66 | python -m pylint ./mpd_parser/
67 | ```
68 |
69 | ## TODO
70 | 1. ~~finish working on periods and sub tags~~
71 | 1. ~~periods~~
72 | 2. ~~adapt-sets~~
73 | 3. ~~segment bases~~
74 | 4. ~~segment lists~~
75 | 5. ~~segment templates~~
76 | 6. ~~asset ids~~
77 | 7. ~~event streams~~
78 | 8. ~~subsets~~
79 | 2. ~~create package locally~~
80 | 3. ~~test it~~
81 | 4. complete readme
82 | 1. ~~installation~~
83 | 2. ~~usage~~
84 | 3. Benchmarks
85 | 4. contributing
86 | 5. ~~push to github~~
87 | 6. ~~push package to pypi~~
88 | 7. add github actions
89 | 1. ~~pylint~~
90 | 2. ~~pytest~~
91 | 3. ~~build package~~
92 | 4. ~~push package~~
93 | 8. complete unit-tests
94 | 9. refactor tags to multiple files
95 | 10. Parsing:
96 | 1. ~~parsing from string~~
97 | 2. ~~parsing from file~~
98 | 3. parsing from URL
99 | 11. save mpd object:
100 | 1. ~~object to string~~
101 | 2. object to file
102 |
--------------------------------------------------------------------------------
/manifests/aws-media-tailor-vod-personalized-response-manifest.mpd:
--------------------------------------------------------------------------------
1 |
2 | https://10380e91fda5e303.mediapackage.us-west-2.amazonaws.com/out/v1/5f6a2197815e444a967f0c12f8325a11/
3 | https://12345.mediatailor.us-west-2.amazonaws.com/v1/dashsegment/0d598fad40f42c4644d1c5b7674438772ee23b12/dash-vod-insertion/a5a7cf24-ee56-40e9-a0a2-82b483cf8650/8778696_PT0S/8778696_PT0S_0/
4 |
5 |
6 |
7 |
8 |
9 |