{"id":26458135,"url":"https://github.com/devsnd/tinytag","last_synced_at":"2025-03-19T00:01:38.165Z","repository":{"id":13590187,"uuid":"16282952","full_name":"tinytag/tinytag","owner":"tinytag","description":"Python library for reading audio file metadata","archived":false,"fork":false,"pushed_at":"2025-03-13T15:10:48.000Z","size":3243,"stargazers_count":729,"open_issues_count":7,"forks_count":102,"subscribers_count":23,"default_branch":"master","last_synced_at":"2025-03-13T16:25:13.608Z","etag":null,"topics":["aiff","audio","flac","id3","m4a","metadata","mp3","music","ogg","opus","python","reader","tag","tags","wav","wma"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tinytag.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-01-27T15:27:01.000Z","updated_at":"2025-03-13T15:10:52.000Z","dependencies_parsed_at":"2023-01-16T20:00:52.934Z","dependency_job_id":"0f705077-d179-464f-aa5c-83f840cb02d6","html_url":"https://github.com/tinytag/tinytag","commit_stats":{"total_commits":497,"total_committers":27,"mean_commits":18.40740740740741,"dds":"0.46881287726358145","last_synced_commit":"69cc78ce28e8386f74ce337fa6b767a5c39d7312"},"previous_names":["tinytag/tinytag","devsnd/tinytag"],"tags_count":47,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinytag%2Ftinytag","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinytag%2Ftinytag/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinytag%2Ftinytag/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinytag%2Ftinytag/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tinytag","download_url":"https://codeload.github.com/tinytag/tinytag/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244326199,"owners_count":20435122,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aiff","audio","flac","id3","m4a","metadata","mp3","music","ogg","opus","python","reader","tag","tags","wav","wma"],"created_at":"2025-03-19T00:01:10.802Z","updated_at":"2025-03-19T00:01:38.129Z","avatar_url":"https://github.com/tinytag.png","language":"Python","readme":"\u003c!--\n  SPDX-FileCopyrightText: 2014-2024 tinytag Contributors\n  SPDX-License-Identifier: MIT\n--\u003e\n\n# tinytag \n\ntinytag is a Python library for reading audio file metadata\n\n[![Build Status](https://img.shields.io/github/actions/workflow/status/tinytag/tinytag/tests.yml\n)](https://github.com/tinytag/tinytag/actions?query=workflow:%22Tests%22)\n[![Coverage Status](https://img.shields.io/coverallsCoverage/github/tinytag/tinytag\n)](https://coveralls.io/r/tinytag/tinytag)\n[![PyPI Version](https://img.shields.io/pypi/v/tinytag\n)](https://pypi.org/project/tinytag/)\n[![PyPI Downloads](https://img.shields.io/pypi/dm/tinytag\n)](https://pypistats.org/packages/tinytag)\n\n\n## Install\n\n```\npython3 -m pip install tinytag\n```\n\n\n## Features\n\n  * Read tags, images and properties of audio files\n  * Supported formats:\n    * MP3 / MP2 / MP1 (ID3 v1, v1.1, v2.2, v2.3+)\n    * M4A (AAC / ALAC)\n    * WAVE / WAV\n    * OGG (FLAC / Opus / Speex / Vorbis)\n    * FLAC\n    * WMA\n    * AIFF / AIFF-C\n  * Same API for all formats\n  * Small, portable library\n  * High code coverage\n  * Pure Python, no dependencies\n  * Supports Python 3.7 or higher\n\n\u003e [!IMPORTANT]  \n\u003e Support for changing/writing metadata will not be added. Use another library\n\u003e such as [Mutagen](https://mutagen.readthedocs.io/) for this.\n\n\n## Usage\n\ntinytag only provides the minimum needed for _reading_ metadata, and presents\nit in a simple format. It can determine track number, total tracks, title,\nartist, album, year, duration and more.\n\n```python\nfrom tinytag import TinyTag\ntag: TinyTag = TinyTag.get('/some/music.mp3')\n\nprint(f'This track is by {tag.artist}.')\nprint(f'It is {tag.duration:.2f} seconds long.')\n```\n\n\u003e [!WARNING]  \n\u003e The `ignore_errors` parameter of `TinyTag.get()` is obsolete as of tinytag\n\u003e 2.0.0, and will be removed in the future.\n\nAlternatively you can use tinytag directly on the command line:\n\n    $ python3 -m tinytag /some/music.mp3\n    {\n      \"filename\": \"/some/music.mp3\",\n      \"filesize\": 3243226,\n      \"duration\": 173.52,\n      \"channels\": 2,\n      \"bitrate\": 128,\n      \"samplerate\": 44100,\n      \"artist\": [\n        \"artist name\"\n      ],\n      \"album\": [\n        \"album name\"\n      ],\n      \"title\": [\n        \"track name\"\n      ],\n      \"track\": 4,\n      \"genre\": [\n        \"Jazz\"\n      ],\n      \"year\": [\n        \"2010\"\n      ],\n      \"comment\": [\n        \"Some comment here\"\n      ]\n    }\n\nCheck `python3 -m tinytag --help` for all CLI options, for example other\noutput formats.\n\n### Supported Files\n\nTo receive a tuple of file extensions tinytag supports, use the\n`SUPPORTED_FILE_EXTENSIONS` constant:\n\n```python\nTinyTag.SUPPORTED_FILE_EXTENSIONS\n```\n\nAlternatively, check if a file is supported by providing its path:\n\n```python\nis_supported = TinyTag.is_supported('/some/music.mp3')\n```\n\n### Common Metadata\n\ntinytag provides some common attributes, which always contain a single value.\nThese are helpful when you need quick access to common metadata.\n\n#### File/Audio Properties\n\n    tag.bitdepth      # bit depth as integer (for lossless audio)\n    tag.bitrate       # bitrate in kBits/s as float\n    tag.duration      # audio duration in seconds as float\n    tag.filename      # filename as string\n    tag.filesize      # file size in bytes as integer\n    tag.samplerate    # samples per second as integer\n\n\u003e [!WARNING]  \n\u003e The `tag.audio_offset` attribute is obsolete as of tinytag 2.0.0, and will\n\u003e be removed in the future.\n\n#### Metadata Fields\n\n    tag.album         # album as string\n    tag.albumartist   # album artist as string\n    tag.artist        # artist name as string\n    tag.comment       # file comment as string\n    tag.composer      # composer as string\n    tag.disc          # disc number as integer\n    tag.disc_total    # total number of discs as integer\n    tag.genre         # genre as string\n    tag.title         # title of the song as string\n    tag.track         # track number as integer\n    tag.track_total   # total number of tracks as integer\n    tag.year          # year or date as string\n\n### Additional Metadata\n\nFor additional values of the same field type, non-common metadata fields, or\nmetadata specific to certain file formats, use `other`:\n\n    tag.other         # a dictionary of additional fields\n\n\u003e [!WARNING]  \n\u003e The `other` dictionary has replaced the `extra` dictionary in tinytag 2.0.0.\n\u003e The latter will be removed in a future release.\n\nThe following `other` field names are standardized in tinytag, and optionally\npresent when files provide such metadata:\n\n    barcode\n    bpm\n    catalog_number\n    conductor\n    copyright\n    director\n    encoded_by\n    encoder_settings\n    initial_key\n    isrc\n    language\n    license\n    lyricist\n    lyrics\n    media\n    publisher\n    set_subtitle\n    url\n\nAdditional `other` field names not documented above may be present, but are\nformat-specific and may change or disappear in future tinytag releases. If\ntinytag does not expose metadata you need, or you wish to standardize more\nfield names, open a feature request on GitHub for discussion.\n\n`other` values are always provided as strings, and are not guaranteed to be\nvalid. Should e.g. the `bpm` value in the file contain non-numeric characters,\ntinytag will provide the string as-is. It is your responsibility to handle\npossible exceptions, e.g. when converting the value to an integer.\n\nMultiple values of the same field type are provided if a file contains them.\nValues are always provided as a list, even when only a single value exists.\n\nExample:\n\n```python\nfrom tinytag import OtherFields, TinyTag\n\ntag: TinyTag = TinyTag.get('/some/music.mp3')\nother_fields: OtherFields = tag.other\ncatalog_numbers: list[str] | None = other_fields.get('catalog_number')\n\nif catalog_numbers:\n    catalog_number: str = catalog_numbers[0]\n    print(catalog_number)\n\nprint(catalog_numbers)\n```\n\nOutput:\n\n    \u003e 10\n    \u003e ['10']\n\nWhen a file contains multiple values for a [common metadata field](#common-metadata)\n(e.g. `artist`), the primary value is accessed through the common attribute\n(`tag.artist`), and any additional values through the `other` dictionary\n(`tag.other['artist']`).\n\nExample:\n\n```python\nfrom tinytag import TinyTag\n\ntag: TinyTag = TinyTag.get('/some/music.mp3')\nartist: str | None = tag.artist\nadditional_artists: list[str] | None = tag.other.get('artist')\n\nprint(artist)\nprint(additional_artists)\n```\n\nOutput:\n\n    \u003e main artist\n    \u003e ['another artist', 'yet another artist']\n\n### All Metadata\n\nIf you need to receive all available metadata as key-value pairs in a flat\ndictionary, use the `as_dict()` method. This combines the common attributes\nand `other` dictionary, which can be more convenient in some cases.\n\n    from tinytag import TinyTag\n\n    tag: TinyTag = TinyTag.get('/some/music.mp3')\n    metadata: dict = tag.as_dict()\n\n### Images\n\nAdditionally, you can also read embedded images by passing a `image=True`\nkeyword argument to `TinyTag.get()`.\n\nIf you need to receive an image of a specific kind, including its description,\nuse `images`:\n\n    tag.images        # available embedded images\n\nThe following common image attributes are available, providing the first\nlocated image of each kind:\n\n    tag.images.front_cover  # front cover as 'Image' object\n    tag.images.back_cover   # back cover as 'Image' object\n    tag.images.media        # media (e.g. CD label) as 'Image' object\n\nWhen present, any additional images are available in an `images.other`\ndictionary, using the following standardized key names:\n\n    generic\n    icon\n    alt_icon\n    front_cover\n    back_cover\n    media\n    leaflet\n    lead_artist\n    artist\n    conductor\n    band\n    composer\n    lyricist\n    recording_location\n    during_recording\n    during_performance\n    screen_capture\n    bright_colored_fish\n    illustration\n    band_logo\n    publisher_logo\n    unknown\n\nProvided values are always lists containing at least one `Image` object.\n\nThe `Image` object provides the following attributes:\n\n    data           # image data as bytes\n    name           # image name/kind as string\n    mime_type      # image MIME type as string\n    description    # image description as string\n\nTo receive any available image, prioritizing the front cover, use `images.any`:\n\n```python\nfrom tinytag import Image, TinyTag\n\ntag: TinyTag = TinyTag.get('/some/music.ogg', image=True)\nimage: Image | None = tag.images.any\n\nif image is not None:\n    data: bytes = image.data\n    name: str = image.name\n    mime_type: str = image.mime_type\n    description: str = image.description\n\n    print(len(data))\n    print(name)\n    print(mime_type)\n    print(description)\n```\n\nOutput:\n\n    \u003e 74452\n    \u003e front_cover\n    \u003e image/jpeg\n    \u003e some image description\n\n\u003e [!WARNING]  \n\u003e `tag.images.any` has replaced `tag.get_image()` in tinytag 2.0.0.\n\u003e `tag.get_image()` will be removed in the future.\n\nTo receive a common image, e.g. `front_cover`:\n\n```python\nfrom tinytag import Image, Images, TinyTag\n\ntag: TinyTag = TinyTag.get('/some/music.ogg', image=True)\nimages: Images = tag.images\ncover_image: Image = images.front_cover\n\nif cover_image is not None:\n    data: bytes = cover_image.data\n    description: str = cover_image.description\n```\n\nTo receive an additional image, e.g. `bright_colored_fish`:\n\n```python\nfrom tinytag import Image, OtherImages, TinyTag\n\ntag: TinyTag = TinyTag.get('/some/music.ogg', image=True)\nother_images: OtherImages = tag.images.other\nfish_images: list[Image] | None = other_images.get('bright_colored_fish')\n\nif fish_images:\n    image = fish_images[0]  # Use first image\n    data = image.data\n    description = image.description\n```\n\n### Encoding\n\nTo open files using a specific encoding, you can use the `encoding` parameter.\nThis parameter is however only used for formats where the encoding is not\nexplicitly specified.\n\n```python\nTinyTag.get('a_file_with_gbk_encoding.mp3', encoding='gbk')\n```\n\n### File-like Objects\n\nTo use a file-like object (e.g. BytesIO) instead of a file path, pass a\n`file_obj` keyword argument:\n\n```python\nTinyTag.get(file_obj=your_file_obj)\n```\n\n### Exceptions\n\n    TinyTagException        # Base class for exceptions\n    ParseError              # Parsing an audio file failed\n    UnsupportedFormatError  # File format is not supported\n\n\n## Changelog\n\n### 2.1.0  (2025-02-23)\n\n- Opus: Calculate audio bitrate\n- Opus: Take pre-skip into account when calculating the duration\n\n### 2.0.0  (2024-11-03)\n\n- **BREAKING:** Store 'disc', 'disc_total', 'track' and 'track_total' values as int instead of str\n- **BREAKING:** 'as_dict()' method (previously undocumented) returns tag field values in list form\n- **BREAKING:** TinyTagException no longer inherits LookupError\n- **BREAKING:** TinyTag subclasses are now private\n- **BREAKING:** Remove function to use custom audio file samples in tests\n- **BREAKING:** Remove support for Python 2\n- **DEPRECATION:** Mark 'ignore_errors' parameter for TinyTag.get() as obsolete\n- **DEPRECATION:** Mark 'audio_offset' attribute as obsolete\n- **DEPRECATION:** Deprecate 'extra' dict in favor of 'other' dict with values in list form\n- **DEPRECATION:** Deprecate 'get_image()' method in favor of 'images.any' property\n- Add type hints to codebase\n- Provide access to custom metadata fields through the 'other' dict\n- Provide access to all available images\n- Add more standard 'other' fields\n- Use Flit as Python build backend instead of Setuptools\n- ID3: Fix invalid sample rate/duration in some cases\n- ID3: Fix reading of UTF-16 strings without BOM\n- FLAC: Apply ID3 tags after Vorbis\n- OGG/WMA: Set missing 'channels' field\n- WMA: Set missing 'other.copyright' field\n- WMA: Raise exception if file is invalid\n- Various optimizations\n\n### 1.10.1  (2023-10-26)\n\n- Update 'extra' fields with data from other tags #188\n- ID3: Add missing 'extra.copyright' field\n\n### 1.10.0  (2023-10-18)\n\n- Add support for OGG FLAC format #182\n- Add support for OGG Speex format #181\n- Wave: support image loading\n- Add support for file-like objects (BytesIO) #178\n- Add list of supported file extensions #177\n- Fix deprecations related to setuptools #176\n- Fix pathlib support in TinyTag.is_supported()\n- Only remove zero bytes at the end of strings\n- Stricter conditions in while loops\n- OGG: Add stricter magic byte matching for OGG files\n- Compatibility with Python 3.4 and 3.5 is no longer tested\n\n### 1.9.0  (2023-04-23)\n\n- Add bitdepth attribute for lossless audio #157\n- Add recognition of Audible formats #163 (thanks to snowskeleton)\n- Add .m4v to list of supported file extensions #142\n- Aiff: Implement replacement for Python's aifc module #164\n- ID3: Only check for language in COMM and USLT frames #147\n- ID3: Read the correct number of bytes from Xing header #154\n- ID3: Add support for ID3v2.4 TDRC frame #156 (thanks to Uninen)\n- M4A: Add description fields #168 (thanks to snowskeleton)\n- RIFF: Handle tags containing extra zero-byte #141\n- Vorbis: Parse OGG cover art #144 (thanks to Pseurae)\n- Vorbis: Support standard disctotal/tracktotal comments #171\n- Wave: Add proper support for padded IFF chunks\n\n### 1.8.1  (2022-03-12) [still mathiascode-edition]\n\n- MP3 ID3: Set correct file position if tag reading is disabled #119 (thanks to mathiascode)\n- MP3: Fix incorrect calculation of duration for VBR encoded MP3s #128 (thanks to mathiascode)\n\n### 1.8.0  (2022-03-05) [mathiascode-edition]\n\n- Add support for ALAC audio files #130 (thanks to mathiascode)\n- AIFF: Fixed bitrate calculation for certain files #129 (thanks to mathiascode)\n- MP3: Do not round MP3 bitrates #131 (thanks to mathiascode)\n- MP3 ID3: Support any language in COMM and USLT frames #135 (thanks to mathiascode)\n- Performance: Don't use regex when parsing genre #136 (thanks to mathiascode)\n- Disable tag parsing for all formats when requested #137 (thanks to mathiascode)\n- M4A: Fix invalid bitrates in certain files #132 (thanks to mathiascode)\n- WAV: Fix metadata parsing for certain files #133 (thanks to mathiascode)\n\n### 1.7.0. (2021-12-14)\n\n- fixed rare occasion of ID3v2 tags missing their first character, #106\n- allow overriding the default encoding of ID3 tags (e.g. `TinyTag.get(..., encoding='gbk'))`)\n- fixed calculation of bitrate for very short mp3 files, #99\n- utf-8 support for AIFF files, #123\n- fixed image parsing for id3v2 with images containing utf-16LE descriptions, #117\n- fixed ID3v1 tags overwriting ID3v2 tags, #121\n- Set correct file position if tag reading is disabled for ID3 (thanks to mathiascode)\n\n### 1.6.0  (2021-08-28) [aw-edition]\n\n- fixed handling of non-latin encoding types for images (thanks to aw-was-here)\n- added support for ISRC data, available in `extra['isrc']` field (thanks to aw-was-here)\n- added support for AIFF/AIFF-C (thanks to aw-was-here)\n- fixed import deprecation warnings (thanks to idotobi)\n- fixed exception for TinyTag misuse being different in different python versions (thanks to idotobi)\n- added support for ID3 initial key tonality hint, available in `extra['initial_key']`\n- added support for ID3 unsynchronized lyrics, available in `extra['lyrics']`\n- added `extra` field, which may contain additional metadata not available in all file formats\n\n### 1.5.0  (2020-11-05)\n\n- fixed data type to always return str for disc, disc_total, track, track_total #97 (thanks to kostalski)\n- fixed package install being reported as UNKNOWN for some python/pip variations #90 (thanks to russpoutine)\n- Added automatic detection for certain MP4 file headers\n\n### 1.4.0  (2020-04-23)\n\n- detecting file types based on their magic header bytes, #85\n- fixed opus duration being wrong for files with lower sample rate #81\n- implemented support for binary paths #72\n- always cast mp3 bitrates to int, so that CBR and VBR output behaves the sam\n- made __str__ deterministic and use json as output format\n\n### 1.3.0  (2020-03-09)\n\n- added option to ignore encoding errors `ignore_errors` #73\n- Improved text decoding for many malformed files\n\n### 1.2.2  (2019-04-13)\n\n- Improved stability when reading corrupted mp3 files\n\n### 1.2.1  (2019-04-13)\n\n- fixed wav files not correctly reporting the number of channels #61\n\n### 1.2.0  (2019-04-13)\n\n- using setup.cfg instead of setup.py (thanks to scivision)\n- added support for calling TinyTag.get with pathlib.Path (thanks to scivision)\n- added appveyor windows test CI (thanks to scivision)\n- using pytest instead of nosetest (thanks to scivision)\n\n### 1.1.0  (2019-04-13)\n\n- added new field \"composer\" (Thanks to Phil Borman)\n\n### 1.0.1  (2019-04-13)\n\n- fixed ID3 loading for files with corrupt header (thanks to Ian Homer)\n- fixed parsing of duration in wav file (thanks to Ian Homer)\n\n### 1.0.0  (2018-12-12)\n\n- added comment field\n- added wav-riff format support\n- use MP4 parser for m4b files\n- added simple cli tool\n- fix parsing of FLAC files with ID3 header (thanks to minus7)\n- added method `TinyTag.is_supported(filename)`\n\n### 0.19.0 (2018-02-11)\n\n- fixed corrupted images for some mp3s (#45)\n\n### 0.18.0 (2017-04-29)\n\n- fixed wrong bitrate and crash when parsing xing header\n\n### 0.17.0 (2016-10-02)\n\n- supporting ID3v2.2 images\n\n### 0.16.0 (2016-08-06)\n\n- MP4 cover image support\n\n### 0.15.2 (2016-08-06)\n\n- fixed crash for malformed MP4 files (#34)\n\n### 0.15.0 (2016-08-06)\n\n- fixed decoding of UTF-16LE ID3v2 Tags, improved overall stability\n\n### 0.14.0 (2016-06-05):\n\n- MP4/M4A and Opus support\n","funding_links":[],"categories":["Audio","资源列表","音频","Python","音频处理","Audio Related Packages","Audio [🔝](#readme)","Awesome Python"],"sub_categories":["音频","Audio","Drone Frames"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevsnd%2Ftinytag","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevsnd%2Ftinytag","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevsnd%2Ftinytag/lists"}