transfer issue 4

[lachlan-00]

https://github.com/lachlan-00/python3-ampache/issues/4

[lachlan-00]

Hey,
I was wondering:
Is it possible to access custom Metadata of a song via python-ampache?
I enabled bpm as a custom Metadata field. It works in the gui-interface and bpm values are displayed in the song details card. So the values must be stored somewhere in the ampache database.
Do you think it might be possible to add these custom metadata fields in the output of:

playlist_songs = ampache.playlist_songs(ampache_url, ampache_api, single_playlist)

? That would be awesome :-)

[Rhythm-of-Time]

ooops... you archived the original thread. I was just trying to add a comment - I'll leave it here not to lose what I was writing. The following is about the custom Metadata implementation. Once you got the original moved, I'll copy it there... Cheers!

---

Code comment for the function update_ext_item starting at line 1549 of song.class.php mentions a song_ext_info table that I neither found in the database, nor other references to it in code. Was this from a previous version, maybe? A hook to external metadata files would be the right thing.

Now I see what you mean by confusing implementation... To me, it looks like it requires a rewrite. It's just not made for what I want to do with it... Ampache is very MP3 centric. But maybe that's ok for most users.

Logged in as an admin user, under Server Config/System (in the Edit Server Preferences dialog) I defined two Custom Metadata fields. Surprisingly, their names get written into the user_preference table, no matter whether "Apply to All" was checked. Is this systemwide or not?

All we get is two "virtual" field names in a user preference table. Where should the values be written to? Again, it is presumed they are already present in the files.

One might expect these fields to be attached to all songs (after the potentially dangerous altering of the song table structure to allow for two additional fields). But when does this happen - if at all? Verifying the catalogs does not trigger it. I have not found a function for this in the Metadata implementation.

"Tags" in Ampache could be a workaround to input custom metadata - at least there already is a table for them. Some require input validation, like the ISRC. That would be feasible on the client side, but the whole approach is not really elegant.

[lachlan-00]

I've got the fix for this @DjTuxeedo

<?xml version="1.0" encoding="UTF-8" ?>
<root>
<total_count>1</total_count>
<song id="77371">
	<title><![CDATA[Welcome to Planet Sexor]]></title>
	<name><![CDATA[Welcome to Planet Sexor]]></name>
	<artist id="4144"><![CDATA[Tiga]]></artist>
	<album id="51457"><![CDATA[Sexor]]></album>
	<tag id="4" count="1" ><![CDATA[Electronic]]></tag>
	<filename><![CDATA[/mnt/music/Tiga/(2005) Sexor/101 - Welcome to Planet Sexor.mp3]]></filename>
	<track>1</track>
	<time>50</time>
	<year>2006</year>
	<bitrate>192000</bitrate>
	<rate>44100</rate>
	<mode>cbr</mode>
	<mime>audio/mpeg</mime>
	<url><![CDATA[https://music.com.au/play/index.php?ssid=e07b04026bb95d2cc47190afa7feab6e&type=song&oid=77371&uid=2&player=api&name=Tiga%20-%20Welcome%20to%20Planet%20Sexor.mp3]]></url>
	<size>1209827</size>
	<mbid>936650f9-00e4-4476-accd-ccb5cf2c1d5b</mbid>
	<album_mbid></album_mbid>
	<artist_mbid></artist_mbid>
	<albumartist_mbid></albumartist_mbid>
	<art><![CDATA[https://music.com.au/image.php?object_id=51457&object_type=album&auth=e07b04026bb95d2cc47190afa7feab6e&name=art.jpg]]></art>
	<flag>0</flag>
	<preciserating>1</preciserating>
	<rating>1</rating>
	<averagerating>0</averagerating>
	<composer><![CDATA[]]></composer>
	<channels></channels>
	<comment><![CDATA[]]></comment>
	<publisher><![CDATA[Play It Again Sam; Different Recordings]]></publisher>
	<language></language>
	<replaygain_album_gain>0.000000</replaygain_album_gain>
	<replaygain_album_peak>0.000000</replaygain_album_peak>
	<replaygain_track_gain>-5.270000</replaygain_track_gain>
	<replaygain_track_peak>1.000000</replaygain_track_peak>
	<encoding><![CDATA[UTF-8]]></encoding>
	<disk><![CDATA[1]]></disk>
	<totaldisks><![CDATA[1]]></totaldisks>
	<band><![CDATA[Tiga]]></band>
	<release_type><![CDATA[album]]></release_type>
	<barcode><![CDATA[5413356594027]]></barcode>
	<audio_codec><![CDATA[mp3]]></audio_codec>
	<recording_time><![CDATA[2006-02-06]]></recording_time>
	<bpm><![CDATA[114]]></bpm>
	<album_artist_sort_order><![CDATA[Tiga]]></album_artist_sort_order>
	<performer_sort_order><![CDATA[Tiga]]></performer_sort_order>
	<media_type><![CDATA[CD]]></media_type>
	<original_release_time><![CDATA[2005-12]]></original_release_time>
	<totaltracks><![CDATA[14]]></totaltracks>
	<track_number><![CDATA[1]]></track_number>
	<isrc><![CDATA[BEP010500070]]></isrc>
	<tagging_time><![CDATA[2013-07-24T07:48:29]]></tagging_time>
	<genre><![CDATA[Electronic]]></genre>
</song>
</root>

@AshotN json_data will need to do the same.

            if (Song::isCustomMetadataEnabled()) {
                foreach ($song->getMetadata() as $metadata) {
                    $meta_name = $metadata->getField()->getName();
                    $string .= "\t<" . $meta_name . "><![CDATA[" . $metadata->getData() . "]]></" . $meta_name . ">\n";
                }
            }

[lachlan-00]

which i think is accomplished by this change

[lachlan-00]

That's valid json, @DjTuxeedo i think this covers you completely

[
    {
        "id": "77371",
        "title": "Welcome to Planet Sexor",
        "artist": {
            "id": "4144",
            "name": "Tiga"
        },
        "album": {
            "id": "51457",
            "name": "Sexor"
        },
        "filename": "\/mnt\/music\/Tiga\/(2005) Sexor\/101 - Welcome to Planet Sexor.mp3",
        "track": "1",
        "playlisttrack": "",
        "time": 50,
        "year": "2006",
        "bitrate": "192000",
        "rate": "44100",
        "mode": "cbr",
        "mime": "audio\/mpeg",
        "url": "https:\/\/music.lachlandewaard.org\/play\/index.php?ssid=e07b04026bb95d2cc47190afa7feab6e&type=song&oid=77371&uid=2&player=api&name=Tiga%20-%20Welcome%20to%20Planet%20Sexor.mp3",
        "size": "1209827",
        "mbid": "936650f9-00e4-4476-accd-ccb5cf2c1d5b",
        "album_mbid": null,
        "artist_mbid": null,
        "albumartist_mbid": null,
        "art": "https:\/\/music.lachlandewaard.org\/image.php?object_id=51457&object_type=album&auth=e07b04026bb95d2cc47190afa7feab6e&name=art.jpg",
        "flag": 0,
        "preciserating": 1,
        "rating": 1,
        "averagerating": 0,
        "composer": "",
        "channels": null,
        "comment": "",
        "publisher": "Play It Again Sam; Different Recordings",
        "language": "",
        "replaygain_album_gain": "0.000000",
        "replaygain_album_peak": "0.000000",
        "replaygain_track_gain": "-5.270000",
        "replaygain_track_peak": "1.000000",
        "encoding": "UTF-8",
        "disk": "1",
        "totaldisks": "1",
        "band": "Tiga",
        "release_type": "album",
        "barcode": "5413356594027",
        "audio_codec": "mp3",
        "recording_time": "2006-02-06",
        "bpm": "114",
        "album_artist_sort_order": "Tiga",
        "performer_sort_order": "Tiga",
        "media_type": "CD",
        "original_release_time": "2005-12",
        "totaltracks": "14",
        "track_number": "1",
        "isrc": "BEP010500070",
        "tagging_time": "2013-07-24T07:48:29",
        "tags": [
            "Electronic"
        ]
    }
]

[lachlan-00]

I forgot I need to put a browse/search filter too

[Rhythm-of-Time]

What is really the difference between metadata, custom metadata and tags? Are tags always Genres? They do have their own type "tag", while metadata are text and custom metadata are "mixed". The mixed type means what exactly?

Call me a dummy, but I only partly understand the docs on search here -
https://github.com/ampache/ampache/wiki/XML-methods#advanced_search
could you please post an example for a rules array with three rules using "and | or", please?

[lachlan-00]

Sure, metadata is the only mixed type whish isn't great as it adds another search array. I only just worked out what mixed was when we started on this.

I'm spending my day at home tomorrow so I'll be working on a few ampache things and will put up some examples. The mixed types actually need another writeup and the current code for python doesn't support the additional rule required.

In the docs folder here I think example.py uses a regular advanced search command as well

[lachlan-00]

to make a general advanced_search in web you can make the rules explicitly

http://music.com.au/server/xml.server.php?action=advanced_search&auth=AUTHKEY&version=400001&rule_1=year&rule_1_operator=2&rule_1_input=1999

In python you just make the rules in the correct order.

# inputs  [rule_1, rule_1_operator, rule_1_input]
# example ['year', 2, 1999]

To search metadata you need to add a 4th rule "rule_X_subtype"

Currently the ui/database is the only place i've seen these listed.
(I think the api will need a list/id search for meta types)

so for bpm i search in the ui/web like this

http://music.com.au/server/xml.server.php?action=advanced_search&auth=APIKEY&version=400001&rule_1=metadata&rule_1_operator=8&rule_1_input=100&rule_1_subtype=9

Operators for metadata are using the text/tag types AND numeric types in a single list as they can be ints/strings/dates. :/

rule_1_operator	Metadata
0	contains
1	does not contain
2	starts with
3	ends with
4	is
5	is not
6	sounds like (Text Only)
7	does not sound like (Text Only)
8	is greater than or equal to
9	is less than or equal to
10	is
11	is not
12	is greater than
13	is less than

So to make this searchable in python i need to extend the advanced search method to process a 4th array if metadata is the array value of rule 1

# inputs  [rule_1, rule_1_operator, rule_1_input, rule_1_subtype]
# example ['metadata', 12, 200, 9]

[Rhythm-of-Time]

Thank you for the great documentation and examples!

I am confused about the purpose of the custom metadata feature. Near the end of Ampache's debug window, I found the custom metadata I had wanted to add:

Now this looks like I have excluded them instead of adding (which I suppose does not work). The array seems to contain the exluded custom metadata. In Custom metadata - Define field list I entered "encoding", and it also appears in disabled_custom_metadata_field_input then.

But still, no matter what I add or delete here, the Song Edit Dialog and what I see after clicking on More Metadata remains the same with all wav data. Only Encoding and Audio Codec are listed here, and I cannot remove the fields by entering them in disabled_custom_metadata_field_input.

[lachlan-00]

I wonder if because wav files are not tagged they can't be added into the files?

I think we might have to add 'tagging' into the api to allow this.

[Rhythm-of-Time]

Tagging in the API would be great!

As you said, there should be a (customizable) default list of empty fields that gets initialised on import also for wav files. As these contain very few information, they otherwise will have only Encoding and Audio Codec as Meta Tags.

There is the Broadcast Wave Format, which has extended information inside the files (if that is what you mean). But it is not widely used, and there are compatibility isssues.

[lachlan-00]

okay, @DjTuxeedo and @Rhythm-of-Time this is almost done here. (at least for python)

if we look at methods to add for metadata i have at least these

Metadata Action API Methods

Update tags and metadata for files.

• metadata_fields (list the custom metadata fields)
• metadata_field (Get a single metadata field by name)
• metadata_create (create a new metadata field)
• metadata_edit (edit a metadata field)
• metadata_remove (remove a metadata field)

Then when we think about tagging i think they go into the object itself. this will edit anything in the db table for each object (e.g. name, prefix, etc) this will have to have write_id3 enabled to be allowed as the tags will overwrite when read again. (i'm not sure if this will edit vorbis/flac files?!)

• song_edit (edit a song field)
• artist_edit (edit an artist field)
• album_edit (edit an album field)

I've added the code into Ampache api for the custom fields and python to allow advanced metadata searches so if you're happy with these new methods i'll close this issue and put the new methods in the api project

https://github.com/orgs/ampache/projects/1

[DjTuxeedo]

I'm sorry @lachlan-00,
It will take me a while to grasp what you have done. My programming skills are very much limited.
I very much appreciate your work, its just a little above my head i guess :-)
What I originally was trying to accomplish was:
Using the python api - create a .csv file for every playlist in Ampache. First column is the path/filename, second column is Title, third column is the Artist and last column is the BPM value. Those .csv files then serve as an Input for an xwax instance for DJing.

My first problem seems to be that:
ampache.ping(ampache_url, ampache_api, 'json')
returns: false
As opposed to:
ampache.ping(ampache_url, ampache_api, 'xml')
returns the session key

Setup is:
Ampache 4.1.0
ampache.py is from January 31st from github

[Rhythm-of-Time]

I can pretty much say the same - it takes time to think and analyse... Thanks a lot for your work so far, and let's leave this open a bit.

For now, I am researching some questions:
In my test database containing many wav and a few mp3, the metadata_field table looks like this:

Where do the ids and names in the table metadata_field come from? What is the "Public" column used for? It looks like in catalog.class.php the method update_song_from_tags takes the decision which metadata tags are included by default. vainfo.class.php is also doing some work cleaning up tags (metadata) which are not found in the database. I see many metadata mentioned here, but the ISRC is not mentioned.

There is no "default list" of tags. But regarding Ampache's many features there is definitely need for more tags than the standard, depending on use case. How to configure this, i.e. specify which metadata to use (display) and define data types and field lenghts? Or is this included in your project schedule already...

In general, it should be possible to write tags also in Vorbis and FLAC (as Vorbis comments only). I am not sure if it's advisable to overwrite metadata within files. Optionally they should be kept as is with additional metadata in the Ampache database.