| Name | ffmpeg-media-type JSON |
| Version |
1.0.5
JSON |
| download |
| home_page | None |
| Summary | ffmpeg-media-type is a Python library that utilizes FFmpeg to extract crucial details from media files, such as duration, width, and height. With seamless integration of 100% typehint support, it offers a user-friendly interface for easy access to media file information. |
| upload_time | 2024-06-27 14:34:12 |
| maintainer | None |
| docs_url | None |
| author | lucemia |
| requires_python | <4.0,>=3.10 |
| license | None |
| keywords |
ffmpeg
ffprobe
video
image
audio
media
mimetype
mp4
mp3
mov
webm
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ffmpeg-media-type
`ffmpeg-media-type` is a Python library that utilizes FFmpeg to detect various media file information, such as duration, width, and height. This library provides an easy-to-use interface for extracting essential details from media files by leveraging the powerful capabilities of FFmpeg.
[](https://github.com/livingbio/ffmpeg-media-type/actions?query=workflow%3Apython-unittest++branch%3Amain++)
[](https://codecov.io/gh/livingbio/ffmpeg-media-type)
[](https://pypi.python.org/pypi/ffmpeg-media-type)
[](https://pepy.tech/project/ffmpeg-media-type)
[](https://github.com/livingbio/ffmpeg-media-type)
[](https://github.com/livingbio/ffmpeg-media-type/blob/main/LICENSE)
[](https://mypy-lang.org/)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
### Table of Contents
- [Documentation](https://livingbio.github.io/ffmpeg-media-type/)
## Installation
You can install `ffmpeg-media-type` via pip:
```bash
pip install ffmpeg-media-type
```
Note: FFmpeg must be installed on your system for this library to function correctly. Make sure you have FFmpeg installed and added to your system's PATH.
## Usage
To use `ffmpeg-media-type`, first import the library:
```python
import ffmpeg_media_type
```
### Detecting Media File Information
To detect media file information, use the `detect` function, providing the path to the media file as a parameter:
```python
media_info = ffmpeg_media_type.detect('https://raw.githubusercontent.com/livingbio/ffmpeg-media-type/main/docs/media/overlay.png')
media_info
```
MediaInfo(type='image', width=163, height=117, duration=None, format='png_pipe', size=2212, suggest_ext='png')
The `detect` function returns a model containing the following information:
- `type`: The type of media file (e.g. `video`, `audio`, `image`, etc.).
- `duration`: The duration of the media file in seconds.
- `width`: The width of the media file in pixels.
- `height`: The height of the media file in pixels.
- `format`: The format of the media file (e.g. `mp4`, `mp3`, `png`, etc.).
- `size`: The size of the media file in bytes.
- `suggest_ext`: The suggested file extension for the media file (e.g. `mp4`, `mp3`, `png`, etc.).
Here's an example of how to access these details:
```python
duration = media_info.duration
width = media_info.width
height = media_info.height
```
### Example
```python
import ffmpeg_media_type
# Specify the path to the media file
file_path = 'https://raw.githubusercontent.com/livingbio/ffmpeg-media-type/main/docs/media/SampleVideo_1280x720_1mb.mp4'
# Detect media file information
media_info = ffmpeg_media_type.detect(file_path)
# Extract information from the media_info dictionary
duration = media_info.duration
width = media_info.width
height = media_info.height
# Print the extracted information
print(f"Duration: {duration} seconds")
print(f"Width: {width} pixels")
print(f"Height: {height} pixels")
```
Duration: 5.312 seconds
Width: 1280 pixels
Height: 720 pixels
### Enhancing Accuracy in Guessing Media File Extensions with FFmpeg
- Typically, the media file's extension is utilized to determine its file type. Nevertheless, this approach may not always yield accurate results. For instance, a file bearing the `.mp4` extension could, in reality, be an audio file.
- The `ffmpeg-media-type` tool enhances the precision of media file extension guessing by leveraging the built-in format functionality of FFmpeg through the command `ffmpeg -formats`.
check [cache](https://github.com/livingbio/ffmpeg-media-type/tree/main/src/ffmpeg_media_type/cache) for details.
### Access ffprobe output
If you need to access the raw ffprobe output, you can use the `ffprobe` function:
```python
ffprobe_output = ffmpeg_media_type.ffprobe('https://raw.githubusercontent.com/livingbio/ffmpeg-media-type/main/docs/media/SampleVideo_1280x720_1mb.mp4')
ffprobe_output
```
FFProbeInfo(format=FFProbeFormat(filename='https://raw.githubusercontent.com/livingbio/ffmpeg-media-type/main/docs/media/SampleVideo_1280x720_1mb.mp4', duration='5.312000', format_name='mov,mp4,m4a,3gp,3g2,mj2', format_long_name='QuickTime / MOV', start_time='0.000000', size='1055736', probe_score=100), streams=(FFProbeStream(index=0, width=1280, height=720, codec_type='video', codec_name='h264', codec_long_name='H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', profile='Main', pix_fmt='yuv420p', r_frame_rate='25/1', tags=FFProbeStreamTags(rotate=0)), FFProbeStream(index=1, width=None, height=None, codec_type='audio', codec_name='aac', codec_long_name='AAC (Advanced Audio Coding)', profile='LC', pix_fmt=None, r_frame_rate='0/0', tags=FFProbeStreamTags(rotate=0))))
## Contributing
Contributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue on the [GitHub repository](https://github.com/livingbio/ffmpeg-media-type/issues). If you would like to contribute code, please fork the repository and submit a pull request.
Before submitting a pull request, make sure to run the tests using the following command:
```bash
poetry install --with dev
py.test src
```
Please ensure that your code follows the established coding style and passes all tests.
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/livingbio/ffmpeg-media-type/blob/main/LICENSE) file for more information.
Raw data
{
"_id": null,
"home_page": null,
"name": "ffmpeg-media-type",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "ffmpeg, ffprobe, video, image, audio, media, mimetype, mp4, mp3, mov, webm",
"author": "lucemia",
"author_email": "lucemia@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/29/da/b30e691ec67b6b2414da8c736295882a9f1c9cd85b2f617a7c3597adbde5/ffmpeg_media_type-1.0.5.tar.gz",
"platform": null,
"description": "# ffmpeg-media-type\n\n`ffmpeg-media-type` is a Python library that utilizes FFmpeg to detect various media file information, such as duration, width, and height. This library provides an easy-to-use interface for extracting essential details from media files by leveraging the powerful capabilities of FFmpeg.\n\n[](https://github.com/livingbio/ffmpeg-media-type/actions?query=workflow%3Apython-unittest++branch%3Amain++)\n[](https://codecov.io/gh/livingbio/ffmpeg-media-type)\n[](https://pypi.python.org/pypi/ffmpeg-media-type)\n[](https://pepy.tech/project/ffmpeg-media-type)\n[](https://github.com/livingbio/ffmpeg-media-type)\n[](https://github.com/livingbio/ffmpeg-media-type/blob/main/LICENSE)\n[](https://mypy-lang.org/)\n[](https://github.com/psf/black)\n[](https://pycqa.github.io/isort/)\n\n\n\n### Table of Contents\n\n- [Documentation](https://livingbio.github.io/ffmpeg-media-type/)\n\n\n\n\n## Installation\n\nYou can install `ffmpeg-media-type` via pip:\n\n```bash\npip install ffmpeg-media-type\n```\n\nNote: FFmpeg must be installed on your system for this library to function correctly. Make sure you have FFmpeg installed and added to your system's PATH.\n\n\n\n## Usage\n\nTo use `ffmpeg-media-type`, first import the library:\n\n\n\n```python\nimport ffmpeg_media_type\n```\n\n\n### Detecting Media File Information\n\nTo detect media file information, use the `detect` function, providing the path to the media file as a parameter:\n\n\n\n```python\n\nmedia_info = ffmpeg_media_type.detect('https://raw.githubusercontent.com/livingbio/ffmpeg-media-type/main/docs/media/overlay.png')\nmedia_info\n```\n\n\n\n\n MediaInfo(type='image', width=163, height=117, duration=None, format='png_pipe', size=2212, suggest_ext='png')\n\n\n\n\nThe `detect` function returns a model containing the following information:\n\n- `type`: The type of media file (e.g. `video`, `audio`, `image`, etc.).\n- `duration`: The duration of the media file in seconds.\n- `width`: The width of the media file in pixels.\n- `height`: The height of the media file in pixels.\n- `format`: The format of the media file (e.g. `mp4`, `mp3`, `png`, etc.).\n- `size`: The size of the media file in bytes.\n- `suggest_ext`: The suggested file extension for the media file (e.g. `mp4`, `mp3`, `png`, etc.).\n\nHere's an example of how to access these details:\n\n\n\n```python\nduration = media_info.duration\nwidth = media_info.width\nheight = media_info.height\n```\n\n### Example\n\n\n\n```python\nimport ffmpeg_media_type\n\n# Specify the path to the media file\nfile_path = 'https://raw.githubusercontent.com/livingbio/ffmpeg-media-type/main/docs/media/SampleVideo_1280x720_1mb.mp4'\n\n# Detect media file information\nmedia_info = ffmpeg_media_type.detect(file_path)\n\n# Extract information from the media_info dictionary\nduration = media_info.duration\nwidth = media_info.width\nheight = media_info.height\n\n# Print the extracted information\nprint(f\"Duration: {duration} seconds\")\nprint(f\"Width: {width} pixels\")\nprint(f\"Height: {height} pixels\")\n```\n\n Duration: 5.312 seconds\n Width: 1280 pixels\n Height: 720 pixels\n\n\n\n### Enhancing Accuracy in Guessing Media File Extensions with FFmpeg\n\n- Typically, the media file's extension is utilized to determine its file type. Nevertheless, this approach may not always yield accurate results. For instance, a file bearing the `.mp4` extension could, in reality, be an audio file.\n- The `ffmpeg-media-type` tool enhances the precision of media file extension guessing by leveraging the built-in format functionality of FFmpeg through the command `ffmpeg -formats`.\n\ncheck [cache](https://github.com/livingbio/ffmpeg-media-type/tree/main/src/ffmpeg_media_type/cache) for details.\n\n### Access ffprobe output\n\nIf you need to access the raw ffprobe output, you can use the `ffprobe` function:\n\n\n\n```python\nffprobe_output = ffmpeg_media_type.ffprobe('https://raw.githubusercontent.com/livingbio/ffmpeg-media-type/main/docs/media/SampleVideo_1280x720_1mb.mp4')\n\nffprobe_output\n```\n\n\n\n\n FFProbeInfo(format=FFProbeFormat(filename='https://raw.githubusercontent.com/livingbio/ffmpeg-media-type/main/docs/media/SampleVideo_1280x720_1mb.mp4', duration='5.312000', format_name='mov,mp4,m4a,3gp,3g2,mj2', format_long_name='QuickTime / MOV', start_time='0.000000', size='1055736', probe_score=100), streams=(FFProbeStream(index=0, width=1280, height=720, codec_type='video', codec_name='h264', codec_long_name='H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', profile='Main', pix_fmt='yuv420p', r_frame_rate='25/1', tags=FFProbeStreamTags(rotate=0)), FFProbeStream(index=1, width=None, height=None, codec_type='audio', codec_name='aac', codec_long_name='AAC (Advanced Audio Coding)', profile='LC', pix_fmt=None, r_frame_rate='0/0', tags=FFProbeStreamTags(rotate=0))))\n\n\n\n## Contributing\n\nContributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue on the [GitHub repository](https://github.com/livingbio/ffmpeg-media-type/issues). If you would like to contribute code, please fork the repository and submit a pull request.\n\nBefore submitting a pull request, make sure to run the tests using the following command:\n\n```bash\npoetry install --with dev\npy.test src\n```\n\nPlease ensure that your code follows the established coding style and passes all tests.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](https://github.com/livingbio/ffmpeg-media-type/blob/main/LICENSE) file for more information.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "ffmpeg-media-type is a Python library that utilizes FFmpeg to extract crucial details from media files, such as duration, width, and height. With seamless integration of 100% typehint support, it offers a user-friendly interface for easy access to media file information.",
"version": "1.0.5",
"project_urls": null,
"split_keywords": [
"ffmpeg",
" ffprobe",
" video",
" image",
" audio",
" media",
" mimetype",
" mp4",
" mp3",
" mov",
" webm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0cb103dfb7831483d3ea00f55bf05aa894a05d5321085321c0f9387aa5838d21",
"md5": "88f4d24809c1e807ed334f22ee3038d3",
"sha256": "4cdd23ae205b0e7d82466d7db66819709a83cdeed1a244606f5b7f58e1c5314e"
},
"downloads": -1,
"filename": "ffmpeg_media_type-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "88f4d24809c1e807ed334f22ee3038d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 142683,
"upload_time": "2024-06-27T14:34:11",
"upload_time_iso_8601": "2024-06-27T14:34:11.292569Z",
"url": "https://files.pythonhosted.org/packages/0c/b1/03dfb7831483d3ea00f55bf05aa894a05d5321085321c0f9387aa5838d21/ffmpeg_media_type-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "29dab30e691ec67b6b2414da8c736295882a9f1c9cd85b2f617a7c3597adbde5",
"md5": "1410f5fda9f2e76840cdcf1689bac9cb",
"sha256": "6796d4105d375766382e0dc0aedeaba66713c97c60fb7cb5b8394baac3a82435"
},
"downloads": -1,
"filename": "ffmpeg_media_type-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "1410f5fda9f2e76840cdcf1689bac9cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 31827,
"upload_time": "2024-06-27T14:34:12",
"upload_time_iso_8601": "2024-06-27T14:34:12.923760Z",
"url": "https://files.pythonhosted.org/packages/29/da/b30e691ec67b6b2414da8c736295882a9f1c9cd85b2f617a7c3597adbde5/ffmpeg_media_type-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-27 14:34:12",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ffmpeg-media-type"
}
