Repository files navigation

tinytag is a Python library for reading audio file metadata

python3 -m pip install tinytag

• Read tags, images and properties of audio files
• Supported formats:
  • MP3 / MP2 / MP1 (ID3 v1, v1.1, v2.2, v2.3+)
  • M4A (AAC / ALAC)
  • WAVE / WAV
  • OGG (FLAC / Opus / Speex / Vorbis)
  • FLAC
  • WMA
  • AIFF / AIFF-C
• Same API for all formats
• Small, portable library
• High code coverage
• Pure Python, no dependencies
• Supports Python 3.7 or higher

tinytag only provides the minimum needed forreading metadata, and presentsit in a simple format. It can determine track number, total tracks, title,artist, album, year, duration and more.

fromtinytagimportTinyTagtag:TinyTag=TinyTag.get('/some/music.mp3')print(f'This track is by{tag.artist}.')print(f'It is{tag.duration:.2f} seconds long.')

Alternatively you can use tinytag directly on the command line:

$ python3 -m tinytag /some/music.mp3{  "filename": "/some/music.mp3",  "filesize": 3243226,  "duration": 173.52,  "channels": 2,  "bitrate": 128,  "samplerate": 44100,  "artist": [    "artist name"  ],  "album": [    "album name"  ],  "title": [    "track name"  ],  "track": 4,  "genre": [    "Jazz"  ],  "year": [    "2010"  ],  "comment": [    "Some comment here"  ]}

Checkpython3 -m tinytag --help for all CLI options, for example otheroutput formats.

To receive a tuple of file extensions tinytag supports, use theSUPPORTED_FILE_EXTENSIONS constant:

TinyTag.SUPPORTED_FILE_EXTENSIONS

Alternatively, check if a file is supported by providing its path:

is_supported=TinyTag.is_supported('/some/music.mp3')

tinytag provides some common attributes, which always contain a single value.These are helpful when you need quick access to common metadata.

tag.bitdepth      # bit depth as integer (for lossless audio)tag.bitrate       # bitrate in kBits/s as floattag.duration      # audio duration in seconds as floattag.filename      # filename as stringtag.filesize      # file size in bytes as integertag.samplerate    # samples per second as integer

tag.album         # album as stringtag.albumartist   # album artist as stringtag.artist        # artist name as stringtag.comment       # file comment as stringtag.composer      # composer as stringtag.disc          # disc number as integertag.disc_total    # total number of discs as integertag.genre         # genre as stringtag.title         # title of the song as stringtag.track         # track number as integertag.track_total   # total number of tracks as integertag.year          # year or date as string

For additional values of the same field type, non-common metadata fields, ormetadata specific to certain file formats, useother:

tag.other         # a dictionary of additional fields

The followingother field names are standardized in tinytag, and optionallypresent when files provide such metadata:

barcodebpmcatalog_numberconductorcopyrightdirectorencoded_byencoder_settingsinitial_keyisrclanguagelicenselyricistlyricsmediapublisherset_subtitleurl

Additionalother field names not documented above may be present, but areformat-specific and may change or disappear in future tinytag releases. Iftinytag does not expose metadata you need, or you wish to standardize morefield names, open a feature request on GitHub for discussion.

other values are always provided as strings, and are not guaranteed to bevalid. Should e.g. thebpm value in the file contain non-numeric characters,tinytag will provide the string as-is. It is your responsibility to handlepossible exceptions, e.g. when converting the value to an integer.

Multiple values of the same field type are provided if a file contains them.Values are always provided as a list, even when only a single value exists.

Example:

fromtinytagimportOtherFields,TinyTagtag:TinyTag=TinyTag.get('/some/music.mp3')other_fields:OtherFields=tag.othercatalog_numbers:list[str]|None=other_fields.get('catalog_number')ifcatalog_numbers:catalog_number:str=catalog_numbers[0]print(catalog_number)print(catalog_numbers)

Output:

> 10> ['10']

When a file contains multiple values for acommon metadata field(e.g.artist), the primary value is accessed through the common attribute(tag.artist), and any additional values through theother dictionary(tag.other['artist']).

Example:

fromtinytagimportTinyTagtag:TinyTag=TinyTag.get('/some/music.mp3')artist:str|None=tag.artistadditional_artists:list[str]|None=tag.other.get('artist')print(artist)print(additional_artists)

Output:

> main artist> ['another artist', 'yet another artist']

If you need to receive all available metadata as key-value pairs in a flatdictionary, use theas_dict() method. This combines the common attributesandother dictionary, which can be more convenient in some cases.

from tinytag import TinyTagtag: TinyTag = TinyTag.get('/some/music.mp3')metadata: dict = tag.as_dict()

Additionally, you can also read embedded images by passing aimage=Truekeyword argument toTinyTag.get().

If you need to receive an image of a specific kind, including its description,useimages:

tag.images        # available embedded images

The following common image attributes are available, providing the firstlocated image of each kind:

tag.images.front_cover  # front cover as 'Image' objecttag.images.back_cover   # back cover as 'Image' objecttag.images.media        # media (e.g. CD label) as 'Image' object

When present, any additional images are available in animages.otherdictionary, using the following standardized key names:

genericiconalt_iconfront_coverback_covermedialeafletlead_artistartistconductorbandcomposerlyricistrecording_locationduring_recordingduring_performancescreen_capturebright_colored_fishillustrationband_logopublisher_logounknown

Provided values are always lists containing at least oneImage object.

TheImage object provides the following attributes:

data           # image data as bytesname           # image name/kind as stringmime_type      # image MIME type as stringdescription    # image description as string

To receive any available image, prioritizing the front cover, useimages.any:

fromtinytagimportImage,TinyTagtag:TinyTag=TinyTag.get('/some/music.ogg',image=True)image:Image|None=tag.images.anyifimageisnotNone:data:bytes=image.dataname:str=image.namemime_type:str=image.mime_typedescription:str=image.descriptionprint(len(data))print(name)print(mime_type)print(description)

Output:

> 74452> front_cover> image/jpeg> some image description

To receive a common image, e.g.front_cover:

fromtinytagimportImage,Images,TinyTagtag:TinyTag=TinyTag.get('/some/music.ogg',image=True)images:Images=tag.imagescover_image:Image=images.front_coverifcover_imageisnotNone:data:bytes=cover_image.datadescription:str=cover_image.description

To receive an additional image, e.g.bright_colored_fish:

fromtinytagimportImage,OtherImages,TinyTagtag:TinyTag=TinyTag.get('/some/music.ogg',image=True)other_images:OtherImages=tag.images.otherfish_images:list[Image]|None=other_images.get('bright_colored_fish')iffish_images:image=fish_images[0]# Use first imagedata=image.datadescription=image.description

To open files using a specific encoding, you can use theencoding parameter.This parameter is however only used for formats where the encoding is notexplicitly specified.

TinyTag.get('a_file_with_gbk_encoding.mp3',encoding='gbk')

To use a file-like object (e.g. BytesIO) instead of a file path, pass afile_obj keyword argument:

TinyTag.get(file_obj=your_file_obj)

TinyTagException        # Base class for exceptionsParseError              # Parsing an audio file failedUnsupportedFormatError  # File format is not supported

• Opus: Calculate audio bitrate
• Opus: Take pre-skip into account when calculating the duration

• BREAKING: Store 'disc', 'disc_total', 'track' and 'track_total' values as int instead of str
• BREAKING: 'as_dict()' method (previously undocumented) returns tag field values in list form
• BREAKING: TinyTagException no longer inherits LookupError
• BREAKING: TinyTag subclasses are now private
• BREAKING: Remove function to use custom audio file samples in tests
• BREAKING: Remove support for Python 2
• DEPRECATION: Mark 'ignore_errors' parameter for TinyTag.get() as obsolete
• DEPRECATION: Mark 'audio_offset' attribute as obsolete
• DEPRECATION: Deprecate 'extra' dict in favor of 'other' dict with values in list form
• DEPRECATION: Deprecate 'get_image()' method in favor of 'images.any' property
• Add type hints to codebase
• Provide access to custom metadata fields through the 'other' dict
• Provide access to all available images
• Add more standard 'other' fields
• Use Flit as Python build backend instead of Setuptools
• ID3: Fix invalid sample rate/duration in some cases
• ID3: Fix reading of UTF-16 strings without BOM
• FLAC: Apply ID3 tags after Vorbis
• OGG/WMA: Set missing 'channels' field
• WMA: Set missing 'other.copyright' field
• WMA: Raise exception if file is invalid
• Various optimizations

• Update 'extra' fields with data from other tags #188
• ID3: Add missing 'extra.copyright' field

• Add support for OGG FLAC format #182
• Add support for OGG Speex format #181
• Wave: support image loading
• Add support for file-like objects (BytesIO) #178
• Add list of supported file extensions #177
• Fix deprecations related to setuptools #176
• Fix pathlib support in TinyTag.is_supported()
• Only remove zero bytes at the end of strings
• Stricter conditions in while loops
• OGG: Add stricter magic byte matching for OGG files
• Compatibility with Python 3.4 and 3.5 is no longer tested

• Add bitdepth attribute for lossless audio #157
• Add recognition of Audible formats #163 (thanks to snowskeleton)
• Add .m4v to list of supported file extensions #142
• Aiff: Implement replacement for Python's aifc module #164
• ID3: Only check for language in COMM and USLT frames #147
• ID3: Read the correct number of bytes from Xing header #154
• ID3: Add support for ID3v2.4 TDRC frame #156 (thanks to Uninen)
• M4A: Add description fields #168 (thanks to snowskeleton)
• RIFF: Handle tags containing extra zero-byte #141
• Vorbis: Parse OGG cover art #144 (thanks to Pseurae)
• Vorbis: Support standard disctotal/tracktotal comments #171
• Wave: Add proper support for padded IFF chunks

• MP3 ID3: Set correct file position if tag reading is disabled #119 (thanks to mathiascode)
• MP3: Fix incorrect calculation of duration for VBR encoded MP3s #128 (thanks to mathiascode)

• Add support for ALAC audio files #130 (thanks to mathiascode)
• AIFF: Fixed bitrate calculation for certain files #129 (thanks to mathiascode)
• MP3: Do not round MP3 bitrates #131 (thanks to mathiascode)
• MP3 ID3: Support any language in COMM and USLT frames #135 (thanks to mathiascode)
• Performance: Don't use regex when parsing genre #136 (thanks to mathiascode)
• Disable tag parsing for all formats when requested #137 (thanks to mathiascode)
• M4A: Fix invalid bitrates in certain files #132 (thanks to mathiascode)
• WAV: Fix metadata parsing for certain files #133 (thanks to mathiascode)

• fixed rare occasion of ID3v2 tags missing their first character, #106
• allow overriding the default encoding of ID3 tags (e.g.TinyTag.get(..., encoding='gbk')))
• fixed calculation of bitrate for very short mp3 files, #99
• utf-8 support for AIFF files, #123
• fixed image parsing for id3v2 with images containing utf-16LE descriptions, #117
• fixed ID3v1 tags overwriting ID3v2 tags, #121
• Set correct file position if tag reading is disabled for ID3 (thanks to mathiascode)

• fixed handling of non-latin encoding types for images (thanks to aw-was-here)
• added support for ISRC data, available inextra['isrc'] field (thanks to aw-was-here)
• added support for AIFF/AIFF-C (thanks to aw-was-here)
• fixed import deprecation warnings (thanks to idotobi)
• fixed exception for TinyTag misuse being different in different python versions (thanks to idotobi)
• added support for ID3 initial key tonality hint, available inextra['initial_key']
• added support for ID3 unsynchronized lyrics, available inextra['lyrics']
• addedextra field, which may contain additional metadata not available in all file formats

• fixed data type to always return str for disc, disc_total, track, track_total #97 (thanks to kostalski)
• fixed package install being reported as UNKNOWN for some python/pip variations #90 (thanks to russpoutine)
• Added automatic detection for certain MP4 file headers

• detecting file types based on their magic header bytes, #85
• fixed opus duration being wrong for files with lower sample rate #81
• implemented support for binary paths #72
• always cast mp3 bitrates to int, so that CBR and VBR output behaves the sam
• madestr deterministic and use json as output format

• added option to ignore encoding errorsignore_errors #73
• Improved text decoding for many malformed files

• Improved stability when reading corrupted mp3 files

• fixed wav files not correctly reporting the number of channels #61

• using setup.cfg instead of setup.py (thanks to scivision)
• added support for calling TinyTag.get with pathlib.Path (thanks to scivision)
• added appveyor windows test CI (thanks to scivision)
• using pytest instead of nosetest (thanks to scivision)

• added new field "composer" (Thanks to Phil Borman)

• fixed ID3 loading for files with corrupt header (thanks to Ian Homer)
• fixed parsing of duration in wav file (thanks to Ian Homer)

• added comment field
• added wav-riff format support
• use MP4 parser for m4b files
• added simple cli tool
• fix parsing of FLAC files with ID3 header (thanks to minus7)
• added methodTinyTag.is_supported(filename)

• fixed corrupted images for some mp3s (#45)

• fixed wrong bitrate and crash when parsing xing header

• supporting ID3v2.2 images

• MP4 cover image support

• fixed crash for malformed MP4 files (#34)

• fixed decoding of UTF-16LE ID3v2 Tags, improved overall stability

• MP4/M4A and Opus support