iPod Touch, iPad remote control)

[mmote]

I need to be able to do the following:

• Retrieve lists of artists, albums, genres contained in the library with the ability to filter the results, e.g. retrieve a list of all albums for a certain artist
• Retrieve tracks depending on certain criteria, e.g. all tracks contained in album x by artist y. I need to be able to retrieve metadata for these tracks and add them to playlists
• Perform keyword searches of the whole library

As far as I can tell the current SDK won't let me do this.

[Artem]

I thought so.
General issue with that API is that music library is too general unlike playlist and other elements. For example, the "local files" data source provides all information about the indexed tracks including support of grouping (and custom grouping critera), filtering features and different views for data. But, any plugin can implement own data source and populate the music library view by own data. Of course, each data source must provide two standard field - ID and FileName, but all other fields may be missed. So, I will try to implement functionality for basic functionality in near releases, but I have no idea when full api for music library will be available.

[mmote]

That'd be nice. I get emails every once in a while asking what happened to AIMP support 

[Artem]

Hello,

I have extended Music Library's API. Of course, it just a low level interfaces that provides an ability to fetch data from specified data storage.
Note that this is not a final version of API and it may be changed / extended before an official release.

Here is a build with extended API:
https://yadi.sk/d/g80ydFh-BU_LiA

Here is a SDK:
https://yadi.sk/d/ypjmP1YHgpNRBw

What changed?
1. IAIMPMLDataProviderSelection.HasNextPage method (required for data-storage working in pagination mode) has been transformed to separate interface called IAIMPMLDataProvider2
2. Added new IAIMPMLDataStorage2 interface that provides an ability to create data-storage related objects like IAIMPMLDataFilter
3. Now you can get an IAIMPMLDataProvider / IAIMPMLDataProvider2 interface via IAIMPMLDataStorage2.QueryInterface method. IAIMPMLDataProvider provides an low level access to data.


Here is a small demo (in Delphi) that shows how to use new api to browse the database:
https://yadi.sk/d/Dq2Ao3ITEr8Sdw

General thing here is (look at uDataProvider.pas):

Code: [Select]

  AService: IAIMPServiceMusicLibrary;

...
  AService.GetStorageByID(MakeString(AIMPML_LOCALDATASTORAGE_ID), IAIMPMLDataStorage2, FDataStorage);
...

  if Supports(FDataStorage, IAIMPMLDataProvider, ADataProvider) then
  begin
    if Succeeded(ADataProvider.GetData(BuildFieldList, BuildFilter, AData)) then
    begin
      if Supports(AData, IAIMPMLDataProviderSelection, ASelection) then
      repeat
        SetString(AValue, ASelection.GetValueAsString(0, ALength), ALength);
        ...
      until not ASelection.NextRow;
    end;
  end;

  function <>.BuildFieldList: IAIMPObjectList;
  begin
     CoreCreateObject(IAIMPObjectList, Result);
     Result.Add(MakeString('FileName'));
     Result.Add(MakeString('Title'));
  end;

  function <>.BuildFilter: IAIMPMLDataFilter;
  var
    AFieldFilter: IAIMPMLDataFieldFilter;
  begin
     CheckResult(FDataStorage.CreateObject(IAIMPMLDataFilter, Result));
     CheckResult(Result.SetValueAsInt32(AIMPML_FILTERGROUP_OPERATION, AIMPML_FILTERGROUP_OPERATION_AND));
     CheckResult(Result.Add(MakeString('Artist'), FArtist, Null, AIMPML_FIELDFILTER_OPERATION_EQUALS, AFieldFilter));
     CheckResult(Result.Add(MakeString('Album'), FAlbum, Null, AIMPML_FIELDFILTER_OPERATION_EQUALS, AFieldFilter));
  end;

Please, try to play with it. Let me know if you have any suggestions or comments.

[mmote]

Thanks, I'll check it out! The demo appears to be working well enough, I'll need to port the code to C++, though.

[mmote]

Does IAIMPServiceMusicLibrary::GetStorageByID need to be called from the main thread?

[Artem]

Does IAIMPServiceMusicLibrary::GetStorageByID need to be called from the main thread?

Yes, for now. You suggest to remove this limitation?

[mmote]

I'm basically doing everything on background threads and only dispatch to the main thread if absolutely necessary, so just making sure.
Presumably there's no harm in getting that IAIMPMLDataStorage2 object when the plugin is initialized and holding on to it?

[Artem]

Presumably there's no harm in getting that IAIMPMLDataStorage2 object when the plugin is initialized and holding on to it?

Yep, you can do that for the "Local Files" data storage, but I will improve this moment before release.

[mmote]

Ok, great.

Is there a list of field/column names somewhere?

[Artem]

Code: [Select]

static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_ID = _T("ID"); // Int32
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_ADDDED = _T("Added"); // DateTime (Float);
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_ALBUM = _T("Album"); // String, multiple values
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_ALBUMARTIST = _T("AlbumArtist"); // String, multiple values
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_ARTIST = _T("Artist"); // String, multiple values
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_BITDEPTH = _T("BitDepth"); // Int32;
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_BITRATE = _T("Bitrate"); // Int32
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_BPM = _T("BPM"); // Int32;
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_CHANNELS = _T("Channels"); // Int32;
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_COMMENT = _T("Comment"); // String (Memo)
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_COMPOSER = _T("Composer"); // String, multiple values
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_CONDUCTOR = _T("Conductor"); // String
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_COPYRIGHTS = _T("Copyrights"); // String
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_DISKNUMBER = _T("DiskNumber"); // String
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_DURATION = _T("Duration"); // = AIMPML_RESERVED_FIELD_DURATION; // Duration (Float)
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_FILEFORMAT = _T("FileFormat"); // String
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_FILENAME = _T("FileName"); // = AIMPML_RESERVED_FIELD_FILENAME; // FileName (String);
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_FILESIZE =_T("FileSize"); // = AIMPML_RESERVED_FIELD_FILESIZE; // FileSize (Int64);
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_GENRE = _T("Genre"); // String, multiple values
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_LABELS = _T("Labels"); // String, multiple values
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_LASTMODIFICATION = _T("LastModification"); // DateTime (Float)
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_LASTPLAYBACK = _T("LastPlayback"); // DateTime (Float);
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_LYRICIST = _T("Lyricist"); // String, multiple values
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_MOOD = _T("Mood"); // String, multiple values
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_PLAYBACKCOUNT = _T("PlaybackCount"); // Int32
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_PUBLISHER = _T("Publisher"); // String, multiple values
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_RATING = _T("Rating"); // Int32
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_SAMPLERATE = _T("SampleRate"); // Int32
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_TITLE = _T("Title"); // String
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_TRACKNUMBER = _T("TrackNumber"); // String
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_URL = _T("URL"); // String
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_USERMARK = _T("UserMark"); // = AIMPML_RESERVED_FIELD_USERMARK;
static const WCHAR* AIMPML_LOCALDATASTORAGE_FIELD_YEAR = _T("Year"); // String


[mmote]

Thanks

[mmote]

While updating the code to use the new interface, I noticed IAIMPServiceAlbumArt::Get is relatively slow (takes about 800ms on average). Any plans to optimize that?

[Artem]

What parameters you have using with IAIMPServiceAlbumArt.Get method?

[mmote]

Code: [Select]

m_albumArt->Get(fileUriObj, artistObj, albumObj, AIMP_SERVICE_ALBUMART_FLAGS_ORIGINAL | AIMP_SERVICE_ALBUMART_FLAGS_WAITFOR, AIMPServiceAlbumArtReceiveProc, &info, &taskId)
Removing AIMP_SERVICE_ALBUMART_FLAGS_ORIGINAL only yields a very small speedup.