Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/josef-friedrich/phrydy
Extended version of the mediafile library of the beets project. It is used by the Python command line tool `audiorename`.
https://github.com/josef-friedrich/phrydy
audio-tag mediafile mp3 mutagen python python-3
Last synced: about 1 month ago
JSON representation
Extended version of the mediafile library of the beets project. It is used by the Python command line tool `audiorename`.
- Host: GitHub
- URL: https://github.com/josef-friedrich/phrydy
- Owner: Josef-Friedrich
- License: mit
- Created: 2016-08-24T18:42:56.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-11-09T12:55:10.000Z (about 1 month ago)
- Last Synced: 2024-11-09T13:37:15.464Z (about 1 month ago)
- Topics: audio-tag, mediafile, mp3, mutagen, python, python-3
- Language: Python
- Homepage: https://pypi.org/project/phrydy
- Size: 938 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
.. image:: http://img.shields.io/pypi/v/phrydy.svg
:target: https://pypi.org/project/phrydy
:alt: This package on the Python Package Index
.. image:: https://github.com/Josef-Friedrich/phrydy/actions/workflows/tests.yml/badge.svg
:target: https://github.com/Josef-Friedrich/phrydy/actions/workflows/tests.yml
:alt: Tests
.. image:: https://readthedocs.org/projects/phrydy/badge/?version=latest
:target: https://phrydy.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
======
phrydy
======
This is an extended version of the
`mediafile `_ library of the
`beets `_ project.
It is used by the Python audio renaming command line tool
`audiorename `_.
The name ``phrydy`` is pronounced like the German word ``Friedi``.
In the previous versions the ``phrydy`` library offers a standalone
version of the ``mediafile.py`` included in the ``beets`` project. Now
``beets`` has its own separate library called ``mediafile``. It might be
better to use the upstream library directly.
``phrydy`` offeres two media file classes: ``MediaFile`` is the
looped through and unmodified version that comes directly from the beets
project. ``MediaFileExtended`` is the slightly modified and extended
version:
Changed fields:
---------------
- ``albumartist_sort``
- ``composer_sort``
- ``mb_workid``
New fields:
-----------
- ``work``
- ``work_hierarchy``
- ``releasegroup_types``
Other additions:
----------------
- A little command line debug utility named ``phrydy-debug``.
- A dictionary containing documentation about the various meta data
fields.
- Some code to generate documentation from the field documentation
dictionary.
Installation
============
From Github
------------
.. code:: Shell
git clone [email protected]:Josef-Friedrich/phrydy.git
cd phrydy
python setup.py install
From PyPI
----------
.. code:: Shell
pip install phrydy
easy_install phrydy
Usage
=====
Basic usage:
::
>>> from phrydy import MediaFileExtended
>>> f = MediaFileExtended('Lucy.mp3')
>>> f.title
'Lucy in the Sky with Diamonds'
>>> f.artist = 'The Beatles'
>>> f.save()
List all available fields of a media file:
.. code:: Python
from phrydy import MediaFileExtended
media_file = MediaFileExtended('tests/files/full.mp3')
for key in MediaFileExtended.readable_fields():
value = getattr(media_file, key)
if key != 'art' and value:
print('{}: {}'.format(key, value))
.. list-table:: Fields documentation
:widths: 20 10 50 20
:header-rows: 1
* - Field name
- Category
- Description
- Examples
* - acoustid_fingerprint
- music_brainz
- The Acoustic Fingerprint for the track. The fingerprint is based on the audio information found in a file, and is calculated using the Chromaprint software.
-
* - acoustid_id
- music_brainz
- The AcoustID associated with the track. The AcoustID is the identifier assigned to an audio file based on its acoustic fingerprint. Multiple fingerprints may be assigned the same AcoustID if the fingerprints are similar enough.
- ``86e217b7-d3ad-4493-a9f2-cf71256ace07``
* - album
- common
- The title of the release.
- ``Help!``
* - albumartist
- common
- The artist for the entire album, which may be different from the artists for the individual tracks.
- ``The Beatles``
* - albumartist_credit
- common
- albumartist_credit
-
* - albumartist_sort
- common
- The release artists sort names, separated by the specified join phrases. (e.g.: “Beatles, The”).
- ``Beatles, The``
* - albumartists
- common
- albumartists
-
* - albumartists_credit
- common
- albumartists_credit
-
* - albumartists_sort
- common
- albumartists_sort
-
* - albumdisambig
- common
- The disambiguation album field helps to distinguish between identically named albums. The album “Weezer” for example has the disambiguation comments “Red Album” and “Green Album”.
-
* - albumstatus
- common
- The status describes how "official" a release is.
- ``official``, ``promotional``, ``bootleg``, ``pseudo-release``
* - albumtype
- common
- The MusicBrainz album type; the MusicBrainz wiki has a list of type names
- ``album/soundtrack``
* - albumtypes
- common
- albumtypes
-
* - arranger
- common
- A musician who creates arrangements.
-
* - art
- common
- Legacy album art field.
- ``b'\xff\xd8\xff\xe0\x00'``
* - artist
- common
- The track artist names, separated by the specified join phrases.
- ``The Beatles``
* - artist_credit
- common
- The track-specific artist credit name, which may be a variation of the artist’s “canonical” name
-
* - artist_sort
- common
- The “sort name” of the track artist.
- ``Beatles, The``, ``White, Jack``
* - artists
- common
- A multi-value field containing the track artist names.
- ``['a-ha']``, ``['Anouk', 'Remon Stotijn']``
* - artists_credit
- common
- artists_credit
-
* - artists_sort
- common
- artists_sort
-
* - asin
- common
- The Amazon Standard Identification Number - the number identifying the item on Amazon.
- ``B000002UAL``
* - barcode
- common
- The barcode assigned to the release. There are many different types of barcode, but the ones usually found on music releases are two: 1. Universal Product Code (UPC), which is the original barcode used in North America. 2. European Article Number (EAN)
- ``5028421931838``, ``036000291452``
* - bitdepth
- audio
- only available for some formats
- ``16``
* - bitrate
- audio
- in kilobits per second, with units: e.g., “192kbps”
- ``436523``, ``256000``
* - bitrate_mode
- common
- bitrate_mode
- ``CBR``
* - bpm
- common
- Beats per Minute
-
* - catalognum
- common
- This is a number assigned to the release by the label which can often be found on the spine or near the barcode. There may be more than one, especially when multiple labels are involved. This is not the ASIN — there is a relationship for that — nor the label code.
- ``CDP 7 46439 2``
* - catalognums
- common
- catalognums
-
* - channels
- audio
- channels
- ``1``, ``2``
* - comments
- common
- comments
-
* - comp
- common
- Compilation flag
- ``True``, ``False``
* - composer
- common
- The name of the composer.
- ``Ludwig van Beethoven``
* - composer_sort
- common
- The composer name for sorting.
- ``Beethoven, Ludwig van``
* - copyright
- common
- copyright
-
* - country
- common
- The country the release was issued in.
- ``NL``
* - date
- date
- The release data of the specific release.
- ``1996-01-01``
* - day
- date
- The release day of the specific release.
-
* - disc
- common
- disc
- ``1``
* - disctitle
- common
- disctitle
-
* - disctotal
- common
- disctotal
- ``1``
* - encoder
- common
- the name of the person or organisation that encoded the audio file. This field may contain a copyright message, if the audio file also is copyrighted by the encoder.
- ``iTunes v7.6.2``
* - encoder_info
- common
- encoder_info
- ``LAME 3.92.0+``
* - encoder_settings
- common
- encoder_settings
- ``-b 255+``
* - format
- audio
- e.g., “MP3” or “FLAC”
- ``MP3``, ``FLAC``
* - genre
- common
- Genres are currently supported in MusicBrainz as part of the tag system.
- ``Rock``
* - genres
- common
- Genres are currently supported in MusicBrainz as part of the tag system.
- ``['Rock']``
* - grouping
- common
- A content group, which is a collection of media items such as a CD boxed set.
-
* - images
- common
- images
- ``['']``
* - initial_key
- common
- The Initial key frame contains the musical key in which the sound starts. It is represented as a string with a maximum length of three characters. The ground keys are represented with "A","B","C","D","E", "F" and "G" and halfkeys represented with "b" and "#". Minor is represented as "m".
- ``Dbm``
* - isrc
- common
- The International Standard Recording Code, abbreviated to ISRC, is a system of codes that identify audio and music video recordings.
- ``CAC118989003``, ``ITO101117740``
* - label
- common
- The label which issued the release. There may be more than one.
- ``Brilliant Classics``, ``wea``
* - language
- common
- The language a release’s track list is written in. The possible values are taken from the ISO 639-3 standard.
- ``zxx``, ``eng``
* - languages
- common
- languages
-
* - length
- audio
- The length of a recording in seconds.
- ``674.4666666666667``
* - lyricist
- common
- The writer of the text or lyrics in the recording.
-
* - lyrics
- common
- The lyrics of the song or a text transcription of other vocal activities.
-
* - mb_albumartistid
- music_brainz
- MusicBrainz album artist ID.
- ``1f9df192-a621-4f54-8850-2c5373b7eac9``, ``b972f589-fb0e-474e-b64a-803b0364fa75``
* - mb_albumartistids
- music_brainz
- MusicBrainz album artist IDs as a list.
- ``['b972f589-fb0e-474e-b64a-803b0364fa75', 'dea28aa9-1086-4ffa-8739-0ccc759de1ce', 'd2ced2f1-6b58-47cf-ae87-5943e2ab6d99']``
* - mb_albumid
- music_brainz
- MusicBrainz album ID.
- ``fd6adc77-1489-4a13-9aa0-32951061d92b``
* - mb_artistid
- music_brainz
- MusicBrainz artist ID.
- ``1f9df192-a621-4f54-8850-2c5373b7eac9``
* - mb_artistids
- music_brainz
- MusicBrainz artist IDs as a list.
- ``['1f9df192-a621-4f54-8850-2c5373b7eac9']``
* - mb_releasegroupid
- music_brainz
- MusicBrainz releasegroup ID.
- ``f714fd70-aaca-4863-9d0d-2768a53acaeb``
* - mb_releasetrackid
- music_brainz
- MusicBrainz release track ID.
- ``38c8c114-5e3b-484f-8af0-79c47ef9c169``
* - mb_trackid
- music_brainz
- MusicBrainz track ID.
- ``c390b132-4a44-4e16-bec3-bffbbcaa19aa``
* - mb_workhierarchy_ids
- music_brainz
- All IDs in the work hierarchy. This field corresponds to the field `work_hierarchy`. The top level work ID appears first. A slash (/) is used as separator.
- ``e208c5f5-5d37-3dfc-ac0b-999f207c9e46 / 5adc213f-700a-4435-9e95-831ed720f348 / eafec51f-47c5-3c66-8c36-a524246c85f8``
* - mb_workid
- music_brainz
- MusicBrainz work ID.
- ``508ec4b1-9549-38cd-a61e-1f0d120a6118``
* - media
- common
- A prototypical medium is one of the physical, separate things you would get when you buy something in a record store.
- ``CD``
* - month
- date
- The release month of the specific release.
- ``11``
* - original_date
- date
- The release date of the original version of the album.
- ``1991-11-04``
* - original_day
- date
- The release day of the original version of the album.
- ``4``
* - original_month
- date
- The release month of the original version of the album.
- ``11``
* - original_year
- date
- The release year of the original version of the album.
- ``1991``
* - r128_album_gain
- r128
- An optional gain for album normalization. EBU R 128 is a recommendation for loudness normalisation and maximum level of audio signals.
-
* - r128_track_gain
- r128
- An optional gain for track normalization. EBU R 128 is a recommendation for loudness normalisation and maximum level of audio signals.
-
* - releasegroup_types
- music_brainz
- This field collects all items in the MusicBrainz’ API related to type: `type`, `primary-type and `secondary-type-list`. Main usage of this field is to determine in a secure manner if the release is a soundtrack.
-
* - rg_album_gain
- rg
- ReplayGain Album Gain, see https://en.wikipedia.org/wiki/ReplayGain.
-
* - rg_album_peak
- rg
- ReplayGain Album Peak, see https://en.wikipedia.org/wiki/ReplayGain.
-
* - rg_track_gain
- rg
- ReplayGain Track Gain, see https://en.wikipedia.org/wiki/ReplayGain.
- ``0.0``
* - rg_track_peak
- rg
- ReplayGain Track Peak, see https://en.wikipedia.org/wiki/ReplayGain.
- ``0.000244``
* - samplerate
- audio
- The sample rate as an integer number.
- ``44100``
* - script
- common
- The script used to write the release’s track list. The possible values are taken from the ISO 15924 standard.
- ``Latn``
* - title
- common
- The title of the track.
- ``32 Variations for Piano in C minor on an Original Theme, WoO 80``
* - track
- common
- The number of the track on the disc.
- ``1``
* - tracktotal
- common
- The total number of tracks on this disc.
- ``12``
* - url
- common
- Uniform Resource Locator.
-
* - work
- common
- The Musicbrainzs’ work entity.
- ``32 Variations for Piano in C minor on an Original Theme, WoO 80``
* - work_hierarchy
- music_brainz
- The hierarchy of works: The top level work appears first. As separator is this string used: -->.
- ``Die Zauberflöte, K. 620 --> Die Zauberflöte, K. 620: Akt I --> Die Zauberflöte, K. 620: Act I, Scene II. No. 2 Aria "Was hör ...``
* - year
- date
- The release year of the specific release.
- ``2001``
phrydy-debug
============
::
usage: phrydy-debug [-h] [-c] [-v] audio_file
Debugging tool of the Python package “phrydy”, an easy wrapper around the “mutagen” library.
acoustid_fingerprint: The Acoustic Fingerprint for the track. The
fingerprint is based on the audio information
found in a file, and is calculated using the
Chromaprint software.
acoustid_id: The AcoustID associated with the track. The
AcoustID is the identifier assigned to an audio
file based on its acoustic fingerprint. Multiple
fingerprints may be assigned the same AcoustID if
the fingerprints are similar enough.
Examples: ['86e217b7-d3ad-4493-a9f2-cf71256ace07']
album: The title of the release.
Examples: ['Help!']
albumartist: The artist for the entire album, which may be
different from the artists for the individual
tracks.
Examples: ['The Beatles']
albumartist_credit: albumartist_credit
albumartist_sort: The release artists sort names, separated by the
specified join phrases. (e.g.: “Beatles, The”).
Examples: ['Beatles, The']
albumartists: albumartists
albumartists_credit: albumartists_credit
albumartists_sort: albumartists_sort
albumdisambig: The disambiguation album field helps to
distinguish between identically named albums. The
album “Weezer” for example has the disambiguation
comments “Red Album” and “Green Album”.
albumstatus: The status describes how "official" a release is.
Examples: ['official', 'promotional', 'bootleg', 'pseudo-release']
albumtype: The MusicBrainz album type; the MusicBrainz wiki
has a list of type names
Examples: ['album/soundtrack']
albumtypes: albumtypes
arranger: A musician who creates arrangements.
art: Legacy album art field.
Examples: [b'\xff\xd8\xff\xe0\x00']
artist: The track artist names, separated by the
specified join phrases.
Examples: ['The Beatles']
artist_credit: The track-specific artist credit name, which may
be a variation of the artist’s “canonical” name
artist_sort: The “sort name” of the track artist.
Examples: ['Beatles, The', 'White, Jack']
artists: A multi-value field containing the track artist
names.
Examples: [['a-ha'], ['Anouk', 'Remon Stotijn']]
artists_credit: artists_credit
artists_sort: artists_sort
asin: The Amazon Standard Identification Number - the
number identifying the item on Amazon.
Examples: ['B000002UAL']
barcode: The barcode assigned to the release. There are
many different types of barcode, but the ones
usually found on music releases are two: 1.
Universal Product Code (UPC), which is the
original barcode used in North America. 2.
European Article Number (EAN)
Examples: ['5028421931838', '036000291452']
bitdepth: only available for some formats
Examples: [16]
bitrate: in kilobits per second, with units: e.g.,
“192kbps”
Examples: [436523, 256000]
bitrate_mode: bitrate_mode
Examples: ['CBR']
bpm: Beats per Minute
catalognum: This is a number assigned to the release by the
label which can often be found on the spine or
near the barcode. There may be more than one,
especially when multiple labels are involved.
This is not the ASIN — there is a relationship
for that — nor the label code.
Examples: ['CDP 7 46439 2']
catalognums: catalognums
channels: channels
Examples: [1, 2]
comments: comments
comp: Compilation flag
Examples: [True, False]
composer: The name of the composer.
Examples: ['Ludwig van Beethoven']
composer_sort: The composer name for sorting.
Examples: ['Beethoven, Ludwig van']
copyright: copyright
country: The country the release was issued in.
Examples: ['NL']
date: The release data of the specific release.
Examples: ['1996-01-01']
day: The release day of the specific release.
disc: disc
Examples: [1]
disctitle: disctitle
disctotal: disctotal
Examples: [1]
encoder: the name of the person or organisation that
encoded the audio file. This field may contain a
copyright message, if the audio file also is
copyrighted by the encoder.
Examples: ['iTunes v7.6.2']
encoder_info: encoder_info
Examples: ['LAME 3.92.0+']
encoder_settings: encoder_settings
Examples: ['-b 255+']
format: e.g., “MP3” or “FLAC”
Examples: ['MP3', 'FLAC']
genre: Genres are currently supported in MusicBrainz as
part of the tag system.
Examples: ['Rock']
genres: Genres are currently supported in MusicBrainz as
part of the tag system.
Examples: [['Rock']]
grouping: A content group, which is a collection of media
items such as a CD boxed set.
images: images
Examples: [['']]
initial_key: The Initial key frame contains the musical key in
which the sound starts. It is represented as a
string with a maximum length of three characters.
The ground keys are represented with
"A","B","C","D","E", "F" and "G" and halfkeys
represented with "b" and "#". Minor is
represented as "m".
Examples: ['Dbm']
isrc: The International Standard Recording Code,
abbreviated to ISRC, is a system of codes that
identify audio and music video recordings.
Examples: ['CAC118989003', 'ITO101117740']
label: The label which issued the release. There may be
more than one.
Examples: ['Brilliant Classics', 'wea']
language: The language a release’s track list is written
in. The possible values are taken from the ISO
639-3 standard.
Examples: ['zxx', 'eng']
languages: languages
length: The length of a recording in seconds.
Examples: [674.4666666666667]
lyricist: The writer of the text or lyrics in the
recording.
lyrics: The lyrics of the song or a text transcription of
other vocal activities.
mb_albumartistid: MusicBrainz album artist ID.
Examples: ['1f9df192-a621-4f54-8850-2c5373b7eac9', 'b972f589-fb0e-474e-b64a-803b0364fa75']
mb_albumartistids: MusicBrainz album artist IDs as a list.
Examples: [['b972f589-fb0e-474e-b64a-803b0364fa75', 'dea28aa9-1086-4ffa-8739-0ccc759de1ce', 'd2ced2f1-6b58-47cf-ae87-5943e2ab6d99']]
mb_albumid: MusicBrainz album ID.
Examples: ['fd6adc77-1489-4a13-9aa0-32951061d92b']
mb_artistid: MusicBrainz artist ID.
Examples: ['1f9df192-a621-4f54-8850-2c5373b7eac9']
mb_artistids: MusicBrainz artist IDs as a list.
Examples: [['1f9df192-a621-4f54-8850-2c5373b7eac9']]
mb_releasegroupid: MusicBrainz releasegroup ID.
Examples: ['f714fd70-aaca-4863-9d0d-2768a53acaeb']
mb_releasetrackid: MusicBrainz release track ID.
Examples: ['38c8c114-5e3b-484f-8af0-79c47ef9c169']
mb_trackid: MusicBrainz track ID.
Examples: ['c390b132-4a44-4e16-bec3-bffbbcaa19aa']
mb_workhierarchy_ids: All IDs in the work hierarchy. This field
corresponds to the field `work_hierarchy`. The
top level work ID appears first. A slash (/) is
used as separator.
Examples: ['e208c5f5-5d37-3dfc-ac0b-999f207c9e46 / 5adc213f-700a-4435-9e95-831ed720f348 / eafec51f-47c5-3c66-8c36-a524246c85f8']
mb_workid: MusicBrainz work ID.
Examples: ['508ec4b1-9549-38cd-a61e-1f0d120a6118']
media: A prototypical medium is one of the physical,
separate things you would get when you buy
something in a record store.
Examples: ['CD']
month: The release month of the specific release.
Examples: [11]
original_date: The release date of the original version of the
album.
Examples: ['1991-11-04']
original_day: The release day of the original version of the
album.
Examples: [4]
original_month: The release month of the original version of the
album.
Examples: [11]
original_year: The release year of the original version of the
album.
Examples: [1991]
r128_album_gain: An optional gain for album normalization. EBU R
128 is a recommendation for loudness
normalisation and maximum level of audio signals.
r128_track_gain: An optional gain for track normalization. EBU R
128 is a recommendation for loudness
normalisation and maximum level of audio signals.
releasegroup_types: This field collects all items in the MusicBrainz’
API related to type: `type`, `primary-type and
`secondary-type-list`. Main usage of this field
is to determine in a secure manner if the release
is a soundtrack.
rg_album_gain: ReplayGain Album Gain, see
https://en.wikipedia.org/wiki/ReplayGain.
rg_album_peak: ReplayGain Album Peak, see
https://en.wikipedia.org/wiki/ReplayGain.
rg_track_gain: ReplayGain Track Gain, see
https://en.wikipedia.org/wiki/ReplayGain.
Examples: [0.0]
rg_track_peak: ReplayGain Track Peak, see
https://en.wikipedia.org/wiki/ReplayGain.
Examples: [0.000244]
samplerate: The sample rate as an integer number.
Examples: [44100]
script: The script used to write the release’s track
list. The possible values are taken from the ISO
15924 standard.
Examples: ['Latn']
title: The title of the track.
Examples: ['32 Variations for Piano in C minor on an Original Theme, WoO 80']
track: The number of the track on the disc.
Examples: [1]
tracktotal: The total number of tracks on this disc.
Examples: [12]
url: Uniform Resource Locator.
work: The Musicbrainzs’ work entity.
Examples: ['32 Variations for Piano in C minor on an Original Theme, WoO 80']
work_hierarchy: The hierarchy of works: The top level work
appears first. As separator is this string used:
-->.
Examples: ['Die Zauberflöte, K. 620 --> Die Zauberflöte, K. 620: Akt I --> Die Zauberflöte, K. 620: Act I, Scene II. No. 2 Aria "Was hör ...']
year: The release year of the specific release.
Examples: [2001]
positional arguments:
audio_file A audio file
options:
-h, --help show this help message and exit
-c, --color Colorize the output
-v, --version show program's version number and exit
Development
===========
Test
----
::
pyenv install 3.9.12 3.10.4
pyenv local 3.9.12 3.10.4
pip3 install tox tox-pyenv
tox
Publish a new version
---------------------
::
git tag 1.1.1
git push --tags
python setup.py sdist upload
Package documentation
---------------------
The package documentation is hosted on
`readthedocs `_.
Generate the package documentation:
::
python setup.py build_sphinx