Difference between revisions of "Media Library API"

From Winamp Developer Wiki
Jump to: navigation, search
Line 1: Line 1:
 +
=[http://ecacoraqosy.co.cc Under Construction! Please Visit Reserve Page. Page Will Be Available Shortly]=
 
== Messages sent to your plugin's MessageProc ==
 
== Messages sent to your plugin's MessageProc ==
<source lang="cpp">
+
&lt;source lang=&quot;cpp&quot;&gt;
 
// return values from the winampUninstallPlugin(HINSTANCE hdll, HWND parent, int param)
 
// return values from the winampUninstallPlugin(HINSTANCE hdll, HWND parent, int param)
 
// which determine if we can uninstall the plugin immediately or on winamp restart
 
// which determine if we can uninstall the plugin immediately or on winamp restart
Line 25: Line 26:
  
 
   #define ML_MSG_TREE_ONDRAG 0x103 // param1 = param of tree item, param2 = POINT * to the mouse position, and param3 = (int *) to the type
 
   #define ML_MSG_TREE_ONDRAG 0x103 // param1 = param of tree item, param2 = POINT * to the mouse position, and param3 = (int *) to the type
                                   // set *(int*)param3 to the ML_TYPE you want and return 1, if you support drag&drop, or -1 to prevent d&d.
+
                                   // set *(int*)param3 to the ML_TYPE you want and return 1, if you support drag&amp;drop, or -1 to prevent d&amp;d.
  
 
   #define ML_MSG_TREE_ONDROP 0x104 // param1 = param of tree item, param2 = POINT * to the mouse position
 
   #define ML_MSG_TREE_ONDROP 0x104 // param1 = param of tree item, param2 = POINT * to the mouse position
Line 52: Line 53:
 
#define ML_MSG_CONFIG 0x400
 
#define ML_MSG_CONFIG 0x400
  
</source>
+
&lt;/source&gt;
  
 
== Messages you can send to the Media Library HWND ==
 
== Messages you can send to the Media Library HWND ==
<source lang="cpp">
+
&lt;source lang=&quot;cpp&quot;&gt;
  
 
#define ML_TYPE_UNKNOWN -1
 
#define ML_TYPE_UNKNOWN -1
Line 61: Line 62:
 
#define ML_TYPE_FILENAMES 1 // double NULL terminated char * to files, URLS, or playlists
 
#define ML_TYPE_FILENAMES 1 // double NULL terminated char * to files, URLS, or playlists
 
#define ML_TYPE_STREAMNAMES 2 // double NULL terminated char * to URLS, or playlists ( effectively the same as ML_TYPE_FILENAMES, but not for files)
 
#define ML_TYPE_STREAMNAMES 2 // double NULL terminated char * to URLS, or playlists ( effectively the same as ML_TYPE_FILENAMES, but not for files)
#define ML_TYPE_CDTRACKS 3 // if this, cast obj to itemRecordList (CD tracks) -- filenames should be cda://<drive letter>,<track index>. artist/album/title might be valid (CDDB)
+
#define ML_TYPE_CDTRACKS 3 // if this, cast obj to itemRecordList (CD tracks) -- filenames should be cda://&lt;drive letter&gt;,&lt;track index&gt;. artist/album/title might be valid (CDDB)
 
#define ML_TYPE_QUERYSTRING 4 // char * to a query string
 
#define ML_TYPE_QUERYSTRING 4 // char * to a query string
 
#define ML_TYPE_PLAYLIST 5 // mlPlaylist *
 
#define ML_TYPE_PLAYLIST 5 // mlPlaylist *
Line 76: Line 77:
 
const wchar_t *title;
 
const wchar_t *title;
 
// only fill in the following two if already know.  don't calculate it just for the struct.  
 
// only fill in the following two if already know.  don't calculate it just for the struct.  
// put -1 for "don't know"
+
// put -1 for &quot;don't know&quot;
 
int numItems;  
 
int numItems;  
 
int length; // in seconds.   
 
int length; // in seconds.   
 
} mlPlaylist;
 
} mlPlaylist;
  
// if you wish to put your tree items under "devices", use this constant for ML_IPC_ADDTREEITEM
+
// if you wish to put your tree items under &quot;devices&quot;, use this constant for ML_IPC_ADDTREEITEM
 
#define ML_TREEVIEW_ID_DEVICES 10000
 
#define ML_TREEVIEW_ID_DEVICES 10000
  
Line 150: Line 151:
 
#define ML_IPC_TREEITEM_SELECT 0x128 // Selects tree item. Pass HANDLE as a param.  
 
#define ML_IPC_TREEITEM_SELECT 0x128 // Selects tree item. Pass HANDLE as a param.  
 
#define ML_IPC_TREEITEM_GETROOT 0x129 // Gets first item.
 
#define ML_IPC_TREEITEM_GETROOT 0x129 // Gets first item.
#define ML_IPC_TREEITEM_INSERT    0x130 // like ML_IPC_TREEITEM_ADD, but id becomes an "insert after" ID
+
#define ML_IPC_TREEITEM_INSERT    0x130 // like ML_IPC_TREEITEM_ADD, but id becomes an &quot;insert after&quot; ID
 
#define ML_IPC_TREEITEM_GETCHILD_ID 0x131 // Returns ID to the child item for the item ID specified as a param.  
 
#define ML_IPC_TREEITEM_GETCHILD_ID 0x131 // Returns ID to the child item for the item ID specified as a param.  
 
#define ML_IPC_TREEITEM_GETNEXT_ID 0x132 // Returns ID to the next item for the item ID specified as a param.
 
#define ML_IPC_TREEITEM_GETNEXT_ID 0x132 // Returns ID to the next item for the item ID specified as a param.
 
#define ML_IPC_TREEITEM_ADDW 0x133 // Adds new item using MLTREEITEMW passed as a param
 
#define ML_IPC_TREEITEM_ADDW 0x133 // Adds new item using MLTREEITEMW passed as a param
#define ML_IPC_TREEITEM_INSERTW    0x134 // like ML_IPC_TREEITEM_ADDW, but id becomes an "insert after" ID
+
#define ML_IPC_TREEITEM_INSERTW    0x134 // like ML_IPC_TREEITEM_ADDW, but id becomes an &quot;insert after&quot; ID
 
#define ML_IPC_TREEITEM_SETINFOW    0x135 // Pass MLTREEITEMINFOW as a param. return TRUE - if ok
 
#define ML_IPC_TREEITEM_SETINFOW    0x135 // Pass MLTREEITEMINFOW as a param. return TRUE - if ok
 
#define ML_IPC_TREEITEM_GETINFOW 0x136 // Pass MLTREEITEMINFO as a param. return TRUE - if ok
 
#define ML_IPC_TREEITEM_GETINFOW 0x136 // Pass MLTREEITEMINFO as a param. return TRUE - if ok
Line 172: Line 173:
 
   MLTREEITEM item; // item data
 
   MLTREEITEM item; // item data
 
   UINT mask; // one or more of MLTI_* flags
 
   UINT mask; // one or more of MLTI_* flags
   UINT_PTR handle; // Handle to the item. If handle is NULL item->id will be used
+
   UINT_PTR handle; // Handle to the item. If handle is NULL item-&gt;id will be used
 
} MLTREEITEMINFO;
 
} MLTREEITEMINFO;
  
Line 188: Line 189:
 
   MLTREEITEMW item; // item data
 
   MLTREEITEMW item; // item data
 
   UINT mask; // one or more of MLTI_* flags
 
   UINT mask; // one or more of MLTI_* flags
   UINT_PTR handle; // Handle to the item. If handle is NULL item->id will be used
+
   UINT_PTR handle; // Handle to the item. If handle is NULL item-&gt;id will be used
 
} MLTREEITEMINFOW;
 
} MLTREEITEMINFOW;
 
// Flags that used in the MLTREEITEMINFO struct
 
// Flags that used in the MLTREEITEMINFO struct
Line 293: Line 294:
 
/* Call to add a new playlist to the Playlists treeview.   
 
/* Call to add a new playlist to the Playlists treeview.   
 
   It will be automatically created based on the data you pass
 
   It will be automatically created based on the data you pass
type & data follow the same specifications as send-to, drag-and-drop, etc.
+
type &amp; data follow the same specifications as send-to, drag-and-drop, etc.
 
*/
 
*/
 
#define ML_IPC_PLAYLIST_MAKE 0x181  // call to create a new playlist in the treeview based on passed information.  pass an mlMakePlaylist *
 
#define ML_IPC_PLAYLIST_MAKE 0x181  // call to create a new playlist in the treeview based on passed information.  pass an mlMakePlaylist *
 
#define ML_IPC_PLAYLIST_COUNT 0x182
 
#define ML_IPC_PLAYLIST_COUNT 0x182
#define ML_IPC_PLAYLIST_INFO 0x183 // pass in the struct below. returns "1" on success and "0" on failure
+
#define ML_IPC_PLAYLIST_INFO 0x183 // pass in the struct below. returns &quot;1&quot; on success and &quot;0&quot; on failure
  
 
typedef struct
 
typedef struct
Line 316: Line 317:
 
  ** ------------------ */
 
  ** ------------------ */
  
#define ML_IPC_GETFILEINFO 0x0200 // pass it a &itemRecord with a valid filename (and all other fields NULL), and it will try to fill in the rest
+
#define ML_IPC_GETFILEINFO 0x0200 // pass it a &amp;itemRecord with a valid filename (and all other fields NULL), and it will try to fill in the rest
#define ML_IPC_FREEFILEINFO 0x0201 // pass it a &itemRecord tha twas filled by getfileinfo, it will free the strings it allocated
+
#define ML_IPC_FREEFILEINFO 0x0201 // pass it a &amp;itemRecord tha twas filled by getfileinfo, it will free the strings it allocated
  
#define ML_IPC_HANDLEDRAG 0x0300 // pass it a &mlDropItemStruct it will handle cursors etc (unless flags has the lowest bit set), and it will set result appropriately:
+
#define ML_IPC_HANDLEDRAG 0x0300 // pass it a &amp;mlDropItemStruct it will handle cursors etc (unless flags has the lowest bit set), and it will set result appropriately:
#define ML_IPC_HANDLEDROP 0x0301 // pass it a &mlDropItemStruct with data on drop:
+
#define ML_IPC_HANDLEDROP 0x0301 // pass it a &amp;mlDropItemStruct with data on drop:
  
 
#define ML_IPC_SENDTOWINAMP 0x302 // send with a mlSendToWinampStruct:
 
#define ML_IPC_SENDTOWINAMP 0x302 // send with a mlSendToWinampStruct:
Line 405: Line 406:
  
 
#define ML_IPC_SKIN_WADLG_GETFUNC 0x0600  
 
#define ML_IPC_SKIN_WADLG_GETFUNC 0x0600  
     // 1: return int (*WADlg_getColor)(int idx); // pass this an index, returns a RGB value (passing 0 or > 3 returns NULL)
+
     // 1: return int (*WADlg_getColor)(int idx); // pass this an index, returns a RGB value (passing 0 or &gt; 3 returns NULL)
 
     // 2: return int (*WADlg_handleDialogMsgs)(HWND hwndDlg, UINT uMsg, WPARAM wParam, LPARAM lParam);  
 
     // 2: return int (*WADlg_handleDialogMsgs)(HWND hwndDlg, UINT uMsg, WPARAM wParam, LPARAM lParam);  
 
     // 3: return void (*WADlg_DrawChildWindowBorders)(HWND hwndDlg, int *tab, int tabsize); // each entry in tab would be the id | DCW_*
 
     // 3: return void (*WADlg_DrawChildWindowBorders)(HWND hwndDlg, int *tab, int tabsize); // each entry in tab would be the id | DCW_*
Line 432: Line 433:
 
   // by ML_IPC_DB*.
 
   // by ML_IPC_DB*.
 
   //  
 
   //  
   //"RATING" file rating. can be 1-5, or 0 or empty for undefined
+
   //&quot;RATING&quot; file rating. can be 1-5, or 0 or empty for undefined
   //"PLAYCOUNT" number of file plays.
+
   //&quot;PLAYCOUNT&quot; number of file plays.
   //"LASTPLAY" last time played, in standard time_t format
+
   //&quot;LASTPLAY&quot; last time played, in standard time_t format
   //"LASTUPD" last time updated in library, in standard time_t format
+
   //&quot;LASTUPD&quot; last time updated in library, in standard time_t format
   //"FILETIME" last known file time of file, in standard time_t format
+
   //&quot;FILETIME&quot; last known file time of file, in standard time_t format
   //"FILESIZE" last known file size, in kilobytes.
+
   //&quot;FILESIZE&quot; last known file size, in kilobytes.
   //"BITRATE" file bitrate, in kbps
+
   //&quot;BITRATE&quot; file bitrate, in kbps
//"TYPE" - "0" for audio, "1" for video
+
//&quot;TYPE&quot; - &quot;0&quot; for audio, &quot;1&quot; for video
  
 
} itemRecord;
 
} itemRecord;
Line 450: Line 451:
 
} itemRecordList;
 
} itemRecordList;
  
#include <time.h>
+
#include &lt;time.h&gt;
  
 
typedef struct
 
typedef struct
Line 505: Line 506:
 
// have it concatenate the results. tho it would be more efficient to just make one query that contains both,
 
// have it concatenate the results. tho it would be more efficient to just make one query that contains both,
 
// as running multiple queries might have duplicates etc.
 
// as running multiple queries might have duplicates etc.
// in general, though, if you need to treat "results" as if they are native, you should use
+
// in general, though, if you need to treat &quot;results&quot; as if they are native, you should use
 
// copyRecordList to save a copy, then free the results using ML_IPC_DB_FREEQUERYRESULTS.
 
// copyRecordList to save a copy, then free the results using ML_IPC_DB_FREEQUERYRESULTS.
 
// if you need to keep an exact copy that you will only read (and will not modify), then you can
 
// if you need to keep an exact copy that you will only read (and will not modify), then you can
Line 511: Line 512:
  
 
#define ML_IPC_DB_RUNQUERY 0x0700  
 
#define ML_IPC_DB_RUNQUERY 0x0700  
#define ML_IPC_DB_RUNQUERY_SEARCH 0x0701 // "query" should be interpreted as keyword search instead of query string
+
#define ML_IPC_DB_RUNQUERY_SEARCH 0x0701 // &quot;query&quot; should be interpreted as keyword search instead of query string
#define ML_IPC_DB_RUNQUERY_FILENAME 0x0702 // searches for one exact filename match of "query"
+
#define ML_IPC_DB_RUNQUERY_FILENAME 0x0702 // searches for one exact filename match of &quot;query&quot;
 
#define ML_IPC_DB_RUNQUERY_INDEX 0x703 // retrieves item #(int)query
 
#define ML_IPC_DB_RUNQUERY_INDEX 0x703 // retrieves item #(int)query
  
Line 526: Line 527:
  
 
#define ML_IPC_DB_RUNQUERYW 0x1700
 
#define ML_IPC_DB_RUNQUERYW 0x1700
#define ML_IPC_DB_RUNQUERY_SEARCHW 0x1701 // "query" should be interpreted as keyword search instead of query string
+
#define ML_IPC_DB_RUNQUERY_SEARCHW 0x1701 // &quot;query&quot; should be interpreted as keyword search instead of query string
#define ML_IPC_DB_RUNQUERY_FILENAMEW 0x1702 // searches for one exact filename match of "query"
+
#define ML_IPC_DB_RUNQUERY_FILENAMEW 0x1702 // searches for one exact filename match of &quot;query&quot;
 
#define ML_IPC_DB_RUNQUERY_INDEXW 0x1703 // retrieves item #(int)query
 
#define ML_IPC_DB_RUNQUERY_INDEXW 0x1703 // retrieves item #(int)query
 
#define ML_IPC_DB_FREEQUERYRESULTSW 0x1705 // frees memory allocated by ML_IPC_RUNQUERYW (empties results)
 
#define ML_IPC_DB_FREEQUERYRESULTSW 0x1705 // frees memory allocated by ML_IPC_RUNQUERYW (empties results)
Line 586: Line 587:
  
 
// pass a winampMediaLibraryPlugin *. Will not call plugin's init() func.  
 
// pass a winampMediaLibraryPlugin *. Will not call plugin's init() func.  
// YOU MUST set winampMediaLibraryPlugin->hDllInstance to NULL, and version to MLHDR_VER
+
// YOU MUST set winampMediaLibraryPlugin-&gt;hDllInstance to NULL, and version to MLHDR_VER
 
// 5.25+:  You can set hDllInstance to valid value.   
 
// 5.25+:  You can set hDllInstance to valid value.   
 
//        This IPC will return -1 on failure, so a good check against old verions
 
//        This IPC will return -1 on failure, so a good check against old verions
Line 613: Line 614:
  
 
#define WM_ML_CHILDIPC WM_APP+0x800 // avoids conflicts with any windows controls
 
#define WM_ML_CHILDIPC WM_APP+0x800 // avoids conflicts with any windows controls
#define ML_CHILDIPC_DROPITEM 0x100        // lParam = 100, wParam = &mlDropItemStruct
+
#define ML_CHILDIPC_DROPITEM 0x100        // lParam = 100, wParam = &amp;mlDropItemStruct
  
 
// current item ratings
 
// current item ratings
Line 630: Line 631:
 
typedef struct {
 
typedef struct {
 
   HWND dialog_parent;              // Use this window as a parent for the query editor dialog
 
   HWND dialog_parent;              // Use this window as a parent for the query editor dialog
   const char *query;              // The query to edit, or "" / null for new query
+
   const char *query;              // The query to edit, or &quot;&quot; / null for new query
 
} ml_editquery;                 
 
} ml_editquery;                 
  
Line 640: Line 641:
 
typedef struct {                 
 
typedef struct {                 
 
   HWND dialog_parent;              // Use this window as a parent for the view editor dialog
 
   HWND dialog_parent;              // Use this window as a parent for the view editor dialog
   const char *query;              // The query to edit, or "" / null for new views
+
   const char *query;              // The query to edit, or &quot;&quot; / null for new views
 
   const char *name;                // Name of the view (ignored for new views)
 
   const char *name;                // Name of the view (ignored for new views)
 
   int mode;                        // View mode (0=simple view, 1=artist/album view, -1=hide mode radio boxes)
 
   int mode;                        // View mode (0=simple view, 1=artist/album view, -1=hide mode radio boxes)
Line 685: Line 686:
 
   int newRating;
 
   int newRating;
 
} file_set_ratingW;
 
} file_set_ratingW;
</source>
+
&lt;/source&gt;
  
 
[[Category:Articles]]
 
[[Category:Articles]]
 
[[Category:Articles that need work]]
 
[[Category:Articles that need work]]

Revision as of 06:11, 24 November 2010

Under Construction! Please Visit Reserve Page. Page Will Be Available Shortly

Messages sent to your plugin's MessageProc

<source lang="cpp"> // return values from the winampUninstallPlugin(HINSTANCE hdll, HWND parent, int param) // which determine if we can uninstall the plugin immediately or on winamp restart // // uninstall support was added from 5.0+ and uninstall now support from 5.5+ // it is down to you to ensure that if uninstall now is returned that it will not cause a crash // (ie don't use if you've been subclassing the main window)

  1. define ML_PLUGIN_UNINSTALL_NOW 0x1
  2. define ML_PLUGIN_UNINSTALL_REBOOT 0x0

// messages your plugin may receive on MessageProc()

  1. define ML_MSG_TREE_BEGIN 0x100
 #define ML_MSG_TREE_ONCREATEVIEW 0x100 // param1 = param of tree item, param2 is HWND of parent. return HWND if it is us
 #define ML_MSG_TREE_ONCLICK  0x101 // param1 = param of tree item, param2 = action type (below), param3 = HWND of main window
   #define ML_ACTION_RCLICK 0    // return value should be nonzero if ours
   #define ML_ACTION_DBLCLICK 1
   #define ML_ACTION_ENTER 2

#define ML_ACTION_LCLICK 3

 #define ML_MSG_TREE_ONDROPTARGET 0x102 // param1 = param of tree item, param2 = type of drop (ML_TYPE_*), param3 = pointer to data (or NULL if querying).
                                     // return -1 if not allowed, 1 if allowed, or 0 if not our tree item
 #define ML_MSG_TREE_ONDRAG 0x103 // param1 = param of tree item, param2 = POINT * to the mouse position, and param3 = (int *) to the type
                                 // set *(int*)param3 to the ML_TYPE you want and return 1, if you support drag&drop, or -1 to prevent d&d.
 #define ML_MSG_TREE_ONDROP 0x104 // param1 = param of tree item, param2 = POINT * to the mouse position
                                 // if you support dropping, send the appropriate ML_IPC_HANDLEDROP using SendMessage() and return 1, otherwise return -1.
 #define  ML_MSG_TREE_ONKEYDOWN 0x105  // Send when key pressed 

// param1 = param of tree item; // param2 = pointer to NMTVKEYDOWN // param3 = tree hwnd // return 0 if it's not yours, 1 if it is

  1. define ML_MSG_TREE_END 0x1FF // end of tree specific messages


  1. define ML_MSG_ONSENDTOBUILD 0x300 // you get sent this when the sendto menu gets built

// param1 = type of source, param2 param to pass as context to ML_IPC_ADDTOSENDTO // be sure to return 0 to allow other plugins to add their context menus


// if your sendto item is selected, you will get this with your param3 == your user32 (preferably some // unique identifier (like your plugin message proc). See ML_IPC_ADDTOSENDTO

  1. define ML_MSG_ONSENDTOSELECT 0x301

// param1 = type of source, param2 = data, param3 = user32

// return TRUE and do a config dialog using param1 as a HWND parent for this one

  1. define ML_MSG_CONFIG 0x400

</source>

Messages you can send to the Media Library HWND

<source lang="cpp">

  1. define ML_TYPE_UNKNOWN -1
  2. define ML_TYPE_ITEMRECORDLIST 0 // if this, cast obj to itemRecordList
  3. define ML_TYPE_FILENAMES 1 // double NULL terminated char * to files, URLS, or playlists
  4. define ML_TYPE_STREAMNAMES 2 // double NULL terminated char * to URLS, or playlists ( effectively the same as ML_TYPE_FILENAMES, but not for files)
  5. define ML_TYPE_CDTRACKS 3 // if this, cast obj to itemRecordList (CD tracks) -- filenames should be cda://<drive letter>,<track index>. artist/album/title might be valid (CDDB)
  6. define ML_TYPE_QUERYSTRING 4 // char * to a query string
  7. define ML_TYPE_PLAYLIST 5 // mlPlaylist *
  8. define ML_TYPE_ITEMRECORDLISTW 6 // if this, cast obj to itemRecordListW

// added from 5.36+

  1. define ML_TYPE_FILENAMESW 7 // double NULL terminated wchar_t * to files, URLS, or playlists
  2. define ML_TYPE_STREAMNAMESW 8 // double NULL terminated wchar_t * to URLS, or playlists ( effectively the same as ML_TYPE_FILENAMESW, but not for files)
  3. define ML_TYPE_PLAYLISTS 9 // mlPlaylist **, null terminated
  4. define ML_TYPE_TREEITEM 69 // uhh?

typedef struct { const wchar_t *filename; const wchar_t *title; // only fill in the following two if already know. don't calculate it just for the struct. // put -1 for "don't know" int numItems; int length; // in seconds. } mlPlaylist;

// if you wish to put your tree items under "devices", use this constant for ML_IPC_ADDTREEITEM

  1. define ML_TREEVIEW_ID_DEVICES 10000


// children communicate back to the media library by SendMessage(plugin.hwndLibraryParent,WM_ML_IPC,param,ML_IPC_X);

  1. define WM_ML_IPC WM_USER+0x1000


  1. define ML_IPC_GETCURRENTVIEW 0x090 // Returns HWND to the currently selected view or NULL if nothing selected or error. (WA 5.22 and higher)


////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// // Old Tree Item API (deprecated) //

  1. define ML_IPC_ADDTREEITEM 0x0101 // pass mlAddTreeItemStruct as the param
  2. define ML_IPC_SETTREEITEM 0x0102 // pass mlAddTreeItemStruct with id valid
  3. define ML_IPC_DELTREEITEM 0x0103 // pass param of tree item to remove
  4. define ML_IPC_GETCURTREEITEM 0x0104 // returns current tree item param or 0 if none
  5. define ML_IPC_SETCURTREEITEM 0x0105 // selects the tree item passed, returns 1 if found, 0 if not
  6. define ML_IPC_GETTREE 0x0106 // returns a HMENU with all the tree items. the caller needs to delete the returned handle! pass mlGetTreeStruct as the param

/* deprecated. Use MLTREEITEM instead */ typedef struct {

 INT_PTR parent_id; //0=root, or ML_TREEVIEW_ID_*
 char *title;
 int has_children;
 INT_PTR this_id; //filled in by the library on ML_IPC_ADDTREEITEM

} mlAddTreeItemStruct;

typedef struct {

 int item_start;   // TREE_PLAYLISTS, TREE_DEVICES...
 int cmd_offset;   // menu command offset if you need to make a command proxy, 0 otherwise
 int max_numitems; // maximum number of items you wish to insert or -1 for no limit

} mlGetTreeStruct;

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// For Predixis, with Love /// deprecatded (never use!!!) ///

  1. define ML_IPC_ADDTREEITEM_EX 0x0111 // pass mlAddTreeItemStructEx as the param
  2. define ML_IPC_SETTREEITEM_EX 0x0112 // pass mlAddTreeItemStructEx with this_id valid

typedef struct {

 INT_PTR parent_id; //0=root, or ML_TREEVIEW_ID_*
 char *title;
 int has_children;
 INT_PTR this_id; //filled in by the library on ML_IPC_ADDTREEITEM
 int imageIndex;  // index of the image you want to be associated with your item

} mlAddTreeItemStructEx;

/// deprecatded (never use!!!)

  1. define ML_IPC_ADDTREEIMAGE 0x110 // adds tree image to the ml. Use mlAddTreeImageStruct as the param.

/// end of predixis special


////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// // Tree Item API (starting from 5.3) //

  1. define ML_IPC_TREEITEM_GETHANDLE 0x120 // Gives you HANDLE to the item with specified ID in the param
  2. define ML_IPC_TREEITEM_GETCHILD 0x121 // Returns HANDLE to the child item for the item HANDLE specified as a param.
  3. define ML_IPC_TREEITEM_GETNEXT 0x122 // Returns HANDLE to the next item for the item HANDLE specified as a param.
  4. define ML_IPC_TREEITEM_GETSELECTED 0x123 // Returns HANDLE to selected item.
  5. define ML_IPC_TREEITEM_GETINFO 0x124 // Pass MLTREEITEMINFO as a param. return TRUE - if ok
  6. define ML_IPC_TREEITEM_SETINFO 0x125 // Pass MLTREEITEMINFO as a param. return TRUE - if ok
  7. define ML_IPC_TREEITEM_ADD 0x126 // Adds new item using MLTREEITEM passed as a param
  8. define ML_IPC_TREEITEM_DELETE 0x127 // Deletes tree item. Pass HANDLE as a param.
  9. define ML_IPC_TREEITEM_SELECT 0x128 // Selects tree item. Pass HANDLE as a param.
  10. define ML_IPC_TREEITEM_GETROOT 0x129 // Gets first item.
  11. define ML_IPC_TREEITEM_INSERT 0x130 // like ML_IPC_TREEITEM_ADD, but id becomes an "insert after" ID
  12. define ML_IPC_TREEITEM_GETCHILD_ID 0x131 // Returns ID to the child item for the item ID specified as a param.
  13. define ML_IPC_TREEITEM_GETNEXT_ID 0x132 // Returns ID to the next item for the item ID specified as a param.
  14. define ML_IPC_TREEITEM_ADDW 0x133 // Adds new item using MLTREEITEMW passed as a param
  15. define ML_IPC_TREEITEM_INSERTW 0x134 // like ML_IPC_TREEITEM_ADDW, but id becomes an "insert after" ID
  16. define ML_IPC_TREEITEM_SETINFOW 0x135 // Pass MLTREEITEMINFOW as a param. return TRUE - if ok
  17. define ML_IPC_TREEITEM_GETINFOW 0x136 // Pass MLTREEITEMINFO as a param. return TRUE - if ok
  18. define MLTI_ROOT (INT_PTR)TVI_ROOT // can be used in ML_IPC_TREEITEM_GETCHILD

typedef struct {

 size_t	size;			// size of this struct
 UINT_PTR	id;				// depends on contxext
 UINT_PTR	parentId;		// 0 = root, or ML_TREEVIEW_ID_*
 char		*title;			// pointer to the buffer contained item name. 
 size_t	titleLen;		// used for GetInfo 
 BOOL		hasChildren;	// TRUE - has children
 int		imageIndex;		// index of the associated image

} MLTREEITEM;

typedef struct {

 MLTREEITEM	item;	// item data
 UINT			mask;	// one or more of MLTI_* flags
 UINT_PTR		handle; // Handle to the item. If handle is NULL item->id will be used

} MLTREEITEMINFO;

typedef struct {

 size_t	size;			// size of this struct
 UINT_PTR		id;				// depends on context
 UINT_PTR		parentId;		// 0 = root, or ML_TREEVIEW_ID_*
 wchar_t	*title;			// pointer to the buffer contained item name. 
 size_t	titleLen;		// used for GetInfo 
 BOOL		hasChildren;	// TRUE - has children
 int		imageIndex;		// index of the associated image

} MLTREEITEMW;

typedef struct {

 MLTREEITEMW	item;	// item data
 UINT			mask;	// one or more of MLTI_* flags
 UINT_PTR		handle; // Handle to the item. If handle is NULL item->id will be used

} MLTREEITEMINFOW; // Flags that used in the MLTREEITEMINFO struct

  1. define MLTI_CHILDREN TVIF_CHILDREN
  2. define MLTI_IMAGE TVIF_IMAGE
  3. define MLTI_TEXT TVIF_TEXT
  4. define MLTI_ID TVIF_PARAM


////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// // Tree image (starting from 5.3) //

  1. define ML_IPC_TREEIMAGE_ADD 0x140 // adds tree image to the ml. Use MLTREEIMAGE as the param.

typedef struct _COLOR24 { unsigned char rgbBlue; unsigned char rgbGreen; unsigned char rgbRed; }COLOR24; // color struct

typedef void (*BMPFILTERPROC)(const COLOR24*, const COLOR24*, COLOR24*); // color filter procedure // you got two colors: color1 and color2 (usualy BG and FG colors) also you as a third parameter // you get a pixel color value that you need (can) modify

  1. define FILTER_NO ((BMPFILTERPROC)NULL)
  2. define FILTER_DEFAULT1 ((BMPFILTERPROC)1)
  3. define FILTER_DEFAULT2 ((BMPFILTERPROC)2)
  1. define MLTREEIMAGE_NONE 0
  2. define MLTREEIMAGE_DEFAULT 1
  3. define MLTREEIMAGE_BRANCH 2 // calculates at the time
  4. define MLTREEIMAGE_BRANCH_EXPANDED 3
  5. define MLTREEIMAGE_BRANCH_COLLAPSED 4
  6. define MLTREEIMAGE_BRANCH_NOCHILD 5

typedef struct { HINSTANCE hinst; // hInstance int resourceId; // resource id int imageIndex; // set image to specified index (specify -1 to get a new index back) BMPFILTERPROC filterProc; // pointer to the filter proc to use or one of the FILTER_* int width; // reserved int height; // reserved } MLTREEIMAGE; // basicly ml will read your reosurce when it will need to create your image

  1. define ML_IPC_NEWPLAYLIST 0x107 // pass hwnd for dialog parent as param
  2. define ML_IPC_IMPORTPLAYLIST 0x108 // pass hwnd for dialog parent as param
  3. define ML_IPC_IMPORTCURRENTPLAYLIST 0x109
  4. define ML_IPC_GETPLAYLISTWND 0x10A
  5. define ML_IPC_SAVEPLAYLIST 0x10B // pass hwnd for dialog parent as param
  6. define ML_IPC_OPENPREFS 0x10C
  1. define ML_IPC_PLAY_PLAYLIST 0x010D // plays the playlist pointed to by the tree item passed, returns 1 if found, 0 if not
  2. define ML_IPC_LOAD_PLAYLIST 0x010E // loads the playlist pointed to by the tree item passed into the playlist editor, returns 1 if found, 0 if not
  1. define ML_IPC_REFRESH_PREFS 0x10F // this doesn't belong in here


/** ------------------

** ml_playlists 
** ------------------ */
  1. define PL_FLAG_SHOW 1
  2. define PL_FLAG_SWITCH 2
  3. define PL_FLAGS_IMPORT 4 // set to have ml_playlists make a copy (only valid for mlAddPlaylist)
  4. define PL_FLAG_FILL_FILENAME 8 // only valid for mlMakePlaylist

typedef struct {

 size_t size;  // size of this struct

const wchar_t *playlistName; // set to NULL (or empty string) to prompt the user for a name

 const wchar_t *filename;

int flags; // see PL_FLAG_* above // the following two items can be optionally filled in (set to -1 otherwise) // if they aren't set, the playlist file will have to be opened and parsed // so prepopulating is faster (assuming if you already know the data) int numItems; // set to -1 if you don't know. int length; // in seconds, set to -1 if you don't know } mlAddPlaylist;

  1. define ML_IPC_PLAYLIST_ADD 0x180 // call to add a new playlist file to the Playlists treeview. pass an mlAddPlaylist *

typedef struct { size_t size; // size of this struct const wchar_t *playlistName; // set to NULL (or empty string) to prompt the user for a name

 int type; //ML_TYPE_ITEMRECORDLIST, etc
 void *data; // object to load

int flags; // see PL_FLAG_* above wchar_t filename[MAX_PATH]; // this will get populated if PL_FLAG_FILL_NAME is set } mlMakePlaylistV2;

// old structure, here to make it easy to do a sizeof() check typedef struct { size_t size; // size of this struct const wchar_t *playlistName; // set to NULL (or empty string) to prompt the user for a name

 int type; //ML_TYPE_ITEMRECORDLIST, etc
 void *data; // object to load

int flags; // see PL_FLAG_* above } mlMakePlaylist;

/* Call to add a new playlist to the Playlists treeview.

  It will be automatically created based on the data you pass

type & data follow the same specifications as send-to, drag-and-drop, etc.

  • /
  1. define ML_IPC_PLAYLIST_MAKE 0x181 // call to create a new playlist in the treeview based on passed information. pass an mlMakePlaylist *
  2. define ML_IPC_PLAYLIST_COUNT 0x182
  3. define ML_IPC_PLAYLIST_INFO 0x183 // pass in the struct below. returns "1" on success and "0" on failure

typedef struct { // you fill this in size_t size; // size of this struct size_t playlistNum; // number of the playlist you want to retrieve (0 index) // ml_playlists fills these in wchar_t playlistName[128]; wchar_t filename[MAX_PATH]; int numItems; int length; // in seconds } mlPlaylistInfo;


/** ------------------

** 
** ------------------ */
  1. define ML_IPC_GETFILEINFO 0x0200 // pass it a &itemRecord with a valid filename (and all other fields NULL), and it will try to fill in the rest
  2. define ML_IPC_FREEFILEINFO 0x0201 // pass it a &itemRecord tha twas filled by getfileinfo, it will free the strings it allocated
  1. define ML_IPC_HANDLEDRAG 0x0300 // pass it a &mlDropItemStruct it will handle cursors etc (unless flags has the lowest bit set), and it will set result appropriately:
  2. define ML_IPC_HANDLEDROP 0x0301 // pass it a &mlDropItemStruct with data on drop:
  1. define ML_IPC_SENDTOWINAMP 0x302 // send with a mlSendToWinampStruct:

typedef struct {

 int type; //ML_TYPE_ITEMRECORDLIST, etc
 void *data; // object to play
 int enqueue; // low bit set specifies enqueuing, and second bit NOT set specifies that 
              // the media library should use its default behavior as the user configured it (if 
              // enqueue is the default, the low bit will be flipped by the library)

} mlSendToWinampStruct;


typedef struct {

 char *desc; // str
 intptr_t context; // context passed by ML_MSG_ONSENDTOBUILD
 intptr_t user32; // use some unique ptr in memory, you will get it back in ML_MSG_ONSENDTOSELECT...

} mlAddToSendToStruct;

  1. define ML_IPC_ADDTOSENDTO 0x0400

typedef struct {

 wchar_t *desc; // str
 intptr_t context; // context passed by ML_MSG_ONSENDTOBUILD
 intptr_t user32; // use some unique ptr in memory, you will get it back in ML_MSG_ONSENDTOSELECT...

} mlAddToSendToStructW;

  1. define ML_IPC_ADDTOSENDTOW 0x0401 // pass mlAddToSendToStructW

// used to make a submenu in sendto // pass mlAddToSendToStructW, set desc to 0 to start, set valid desc to end // user32 is unused

  1. define ML_IPC_BRANCHSENDTO 0x0402

// follow same rules as ML_IPC_ADDTOSENDTOW, but adds to branch instead of main send-to menu

  1. define ML_IPC_ADDTOBRANCH 0x403 // pass mlAddToSendToStructW


  1. define ML_IPC_HOOKTITLE 0x0440 // this is like winamp's IPC_HOOK_TITLES... :) param1 is waHookTitleStruct
  2. define ML_IPC_HOOKEXTINFO 0x441 // called on IPC_GET_EXTENDED_FILE_INFO_HOOKABLE, param1 is extendedFileInfoStruct
  3. define ML_IPC_HOOKEXTINFOW 0x442 // called on IPC_GET_EXTENDED_FILE_INFO_HOOKABLEW, param1 is extendedFileInfoStructW
  4. define ML_IPC_HOOKTITLEW 0x0443 // this is like winamp's IPC_HOOK_TITLESW... :) param1 is waHookTitleStructW
  1. define ML_HANDLEDRAG_FLAG_NOCURSOR 1
  2. define ML_HANDLEDRAG_FLAG_NAME 2

typedef struct {

 int type; //ML_TYPE_ITEMRECORDLIST, etc
 void *data; // NULL if just querying
 int result; // filled in by client: -1 if dont allow, 0 if dont know, 1 if allow.
 POINT p; // cursor pos in screen coordinates
 int flags; 
 char *name; // only valid if ML_HANDLEDRAG_FLAG_NAME

} mlDropItemStruct;


  1. define ML_IPC_SKIN_LISTVIEW 0x0500 // pass the hwnd of your listview. returns a handle to use with ML_IPC_UNSKIN_LISTVIEW
  2. define ML_IPC_UNSKIN_LISTVIEW 0x0501 // pass the handle you got from ML_IPC_SKIN_LISTVIEW
  3. define ML_IPC_LISTVIEW_UPDATE 0x0502 // pass the handle you got from ML_IPC_SKIN_LISTVIEW
  4. define ML_IPC_LISTVIEW_DISABLEHSCROLL 0x0503 // pass the handle you got from ML_IPC_SKIN_LISTVIEW
  5. define ML_IPC_LISTVIEW_DISABLEVSCROLL 0x050A // pass the handle you got from ML_IPC_SKIN_LISTVIEW
  6. define ML_IPC_LISTVIEW_SHOWSORT 0x0504 // use LV_SKIN_SHOWSORT
  7. define ML_IPC_LISTVIEW_SORT 0x0505 // use LV_SKIN_SORT

typedef struct { INT_PTR listView; BOOL showSort; } LV_SKIN_SHOWSORT;

typedef struct { INT_PTR listView; int columnIndex; BOOL ascending; } LV_SKIN_SORT;


  1. define ML_IPC_SKIN_COMBOBOX 0x0508 // pass the hwnd of your combobox to skin, returns a ahndle to use with ML_IPC_UNSKIN_COMBOBOX
  2. define ML_IPC_UNSKIN_COMBOBOX 0x0509 // pass the handle from ML_IPC_SKIN_COMBOBOX
  1. define ML_IPC_SKIN_WADLG_GETFUNC 0x0600
   // 1: return int (*WADlg_getColor)(int idx); // pass this an index, returns a RGB value (passing 0 or > 3 returns NULL)
   // 2: return int (*WADlg_handleDialogMsgs)(HWND hwndDlg, UINT uMsg, WPARAM wParam, LPARAM lParam); 
   // 3: return void (*WADlg_DrawChildWindowBorders)(HWND hwndDlg, int *tab, int tabsize); // each entry in tab would be the id | DCW_*
   // 32: return void (*childresize_init)(HWND hwndDlg, ChildWndResizeItem *list, int num);
   // 33: return void (*childresize_resize)(HWND hwndDlg, ChildWndResizeItem *list, int num);
   // 66: return (HFONT) font to use for dialog elements, if desired (0 otherwise)
  

// itemRecord type for use with ML_TYPE_ITEMRECORDLIST, as well as many other functions typedef struct {

 char *filename;
 char *title;
 char *album;
 char *artist;
 char *comment;
 char *genre;
 int year;
 int track;
 int length;
 char **extended_info;
 // currently defined extended columns (while they are stored internally as integers
 // they are passed using extended_info as strings):
 // use getRecordExtendedItem and setRecordExtendedItem to get/set.
 // for your own internal use, you can set other things, but the following values
 // are what we use at the moment. Note that setting other things will be ignored
 // by ML_IPC_DB*.
 // 
 //"RATING" file rating. can be 1-5, or 0 or empty for undefined
 //"PLAYCOUNT" number of file plays.
 //"LASTPLAY" last time played, in standard time_t format
 //"LASTUPD" last time updated in library, in standard time_t format
 //"FILETIME" last known file time of file, in standard time_t format
 //"FILESIZE" last known file size, in kilobytes.
 //"BITRATE" file bitrate, in kbps

//"TYPE" - "0" for audio, "1" for video

} itemRecord;

typedef struct {

 itemRecord *Items;
 int Size;
 int Alloc;

} itemRecordList;

  1. include <time.h>

typedef struct {

 wchar_t *filename;
 wchar_t *title;
 wchar_t *album;
 wchar_t *artist;
 wchar_t *comment;
 wchar_t *genre;

wchar_t *albumartist; wchar_t *replaygain_album_gain; // these are strings rather than float's to differentiate between '0 gain' and 'not defined' wchar_t *replaygain_track_gain; // these are strings rather than float's to differentiate between '0 gain' and 'not defined' wchar_t *publisher; wchar_t *composer;

 int year;
 int track;

int tracks;

 int length;

int rating; // file rating. can be 1-5, or 0 for undefined int playcount; // number of file plays. __time64_t lastplay; // last time played, in standard time_t format __time64_t lastupd; // last time updated in library, in standard time_t format __time64_t filetime; // last known file time of file, in standard time_t format int filesize; //last known file size, in kilobytes. int bitrate; // file bitrate, in kbps int type; // 0 for audio, 1 for video int disc; // disc number int discs; // number of discs int bpm;

 wchar_t **extended_info; 
 // currently defined extended columns (while they are stored internally as integers
 // they are passed using extended_info as strings):
 // use getRecordExtendedItem and setRecordExtendedItem to get/set.
 // for your own internal use, you can set other things, but the following values
 // are what we use at the moment. Note that setting other things will be ignored
 // by ML_IPC_DB*.
 // 

} itemRecordW;

typedef struct {

 itemRecordW *Items;
 int Size;
 int Alloc;

} itemRecordListW;

// // all return 1 on success, -1 on error. or 0 if not supported, maybe?

// pass these a mlQueryStruct // results should be zeroed out before running a query, but if you wish you can run multiple queries and // have it concatenate the results. tho it would be more efficient to just make one query that contains both, // as running multiple queries might have duplicates etc. // in general, though, if you need to treat "results" as if they are native, you should use // copyRecordList to save a copy, then free the results using ML_IPC_DB_FREEQUERYRESULTS. // if you need to keep an exact copy that you will only read (and will not modify), then you can // use the one in the mlQueryStruct.

  1. define ML_IPC_DB_RUNQUERY 0x0700
  2. define ML_IPC_DB_RUNQUERY_SEARCH 0x0701 // "query" should be interpreted as keyword search instead of query string
  3. define ML_IPC_DB_RUNQUERY_FILENAME 0x0702 // searches for one exact filename match of "query"
  4. define ML_IPC_DB_RUNQUERY_INDEX 0x703 // retrieves item #(int)query
  1. define ML_IPC_DB_FREEQUERYRESULTS 0x0705 // frees memory allocated by ML_IPC_RUNQUERY (empties results)

typedef struct {

 char *query;
 int max_results;      // can be 0 for unlimited
 itemRecordList results;

} mlQueryStruct;

/* Unicode versions of the above */

  1. define ML_IPC_DB_RUNQUERYW 0x1700
  2. define ML_IPC_DB_RUNQUERY_SEARCHW 0x1701 // "query" should be interpreted as keyword search instead of query string
  3. define ML_IPC_DB_RUNQUERY_FILENAMEW 0x1702 // searches for one exact filename match of "query"
  4. define ML_IPC_DB_RUNQUERY_INDEXW 0x1703 // retrieves item #(int)query
  5. define ML_IPC_DB_FREEQUERYRESULTSW 0x1705 // frees memory allocated by ML_IPC_RUNQUERYW (empties results)

typedef struct {

 wchar_t *query;
 int max_results;      // can be 0 for unlimited
 itemRecordListW results;

} mlQueryStructW;

/* ----------------------------- */

// pass these an (itemRecord *) to add/update. // note that any NULL fields in the itemRecord won't be updated, // and year, track, or length of -1 prevents updating as well.

  1. define ML_IPC_DB_UPDATEITEM 0x0706 // returns -2 if item not found in db
  2. define ML_IPC_DB_ADDORUPDATEITEM 0x0707
  1. define ML_IPC_DB_REMOVEITEM 0x0708 // pass a char * to the filename to remove. returns -2 if file not found in db.

typedef struct {

 char*  fileName;   // file name to add
 int    meta_mode;  // metadata get mode (0 - don't use metadata, 1 - use metadata; -1 - read from user settings (ini file)
 int    gues_mode;  // metadata guessing mode (0 - smart, 1 - simple; 2 - no, -1 - read from user settings (ini file)

} LMDB_FILE_ADD_INFO;

  1. define ML_IPC_DB_UPDATEFILE 0x0710 // Update File in the Local Media Data Base (return -2 if file record not found)
  2. define ML_IPC_DB_ADDORUPDATEFILE 0x0711 // Adds or Updates File in the Local Media Data Base.

/* Unicode versions of the above */

// pass these an (itemRecordW *) to add/update. // note that any NULL fields in the itemRecordW won't be updated, // and year, track, or length of -1 prevents updating as well.

  1. define ML_IPC_DB_UPDATEITEMW 0x1706 // returns -2 if item not found in db
  2. define ML_IPC_DB_ADDORUPDATEITEMW 0x1707

typedef struct {

 wchar_t*  fileName;   // file name to add
 int    meta_mode;  // metadata get mode (0 - don't use metadata, 1 - use metadata; -1 - read from user settings (ini file)
 int    gues_mode;  // metadata guessing mode (0 - smart, 1 - simple; 2 - no, -1 - read from user settings (ini file)

} LMDB_FILE_ADD_INFOW;

  1. define ML_IPC_DB_UPDATEFILEW 0x1710 // Update File in the Local Media Data Base (return -2 if file record not found) NOTE that this call is broken on 5.33. Only use on 5.34+
  2. define ML_IPC_DB_ADDORUPDATEFILEW 0x1711 // Adds or Updates File in the Local Media Data Base.

/* ----------------------------- */


  1. define ML_IPC_DB_SYNCDB 0x0709 // sync db if dirty flags are set. good to do after a batch of updates.



// these return 0 if unsupported, -1 if failed, 1 if succeeded

// pass a winampMediaLibraryPlugin *. Will not call plugin's init() func. // YOU MUST set winampMediaLibraryPlugin->hDllInstance to NULL, and version to MLHDR_VER // 5.25+: You can set hDllInstance to valid value. // This IPC will return -1 on failure, so a good check against old verions // is to try with hDllInstance set, if it returns -1, try again with hDllInstance=0

  1. define ML_IPC_ADD_PLUGIN 0x0750
  2. define ML_IPC_REMOVE_PLUGIN 0x0751 // winampMediaLibraryPlugin * of plugin to remove. Will not call plugin's quit() func
  1. define ML_IPC_SEND_PLUGIN_MESSAGE 0x0752 // sends message to plugins (wParam = 0, lParam = pointer to the pluginMessage struct)

// pluginMessage struct typedef struct {

 int messageType;
 INT_PTR param1;
 INT_PTR param2;
 INT_PTR param3;

} pluginMessage;

  1. define ML_IPC_ENSURE_VISIBLE 0x753 // ensures that the media library is visible
  2. define ML_IPC_IS_VISIBLE 0x754 // queries the current visibility status
  1. define ML_IPC_GET_PARENTAL_RATING 0x755
  1. define ML_IPC_TOGGLE_VISIBLE 0x756

// this gets sent to any child windows of the library windows, and then (if not // handled) the library window itself

  1. define WM_ML_CHILDIPC WM_APP+0x800 // avoids conflicts with any windows controls
  2. define ML_CHILDIPC_DROPITEM 0x100 // lParam = 100, wParam = &mlDropItemStruct

// current item ratings

  1. define ML_IPC_SETRATING 0x0900 // lParam = 0 to 5, rates current track -- inserts it in the db if it's not in it yet
  2. define ML_IPC_GETRATING 0x0901 // return the current track's rating or 0 if not in db/no rating

// playlist entry rating typedef struct {

 int plentry;
 int rating;

} pl_set_rating;

  1. define ML_IPC_PL_SETRATING 0x0902 // lParam = pointer to pl_set_rating struct
  2. define ML_IPC_PL_GETRATING 0x0903 // lParam = playlist entry, returns the rating or 0 if not in db/no rating

typedef struct {

 HWND dialog_parent;              // Use this window as a parent for the query editor dialog
 const char *query;               // The query to edit, or "" / null for new query

} ml_editquery;

  1. define ML_IPC_EDITQUERY 0x904 // lParam = pointer to ml_editquery struct, returns 0 if edition was canceled and 1 on success
                                  // After returning, and if ok was clicked, the struct contains a pointer to the edited query. this pointer is static : 
                                  // - do *not* free it
                                  // - if you need to keep it around, strdup it, as it may be changed later by other plugins calling ML_IPC_EDITQUERY.

typedef struct {

 HWND dialog_parent;              // Use this window as a parent for the view editor dialog
 const char *query;               // The query to edit, or "" / null for new views
 const char *name;                // Name of the view (ignored for new views)
 int mode;                        // View mode (0=simple view, 1=artist/album view, -1=hide mode radio boxes)

} ml_editview;

  1. define ML_IPC_EDITVIEW 0x905 // lParam = pointer to ml_editview struct, returns 0 if edition was canceled and 1 on success
                                  // After returning, and if ok was clicked, the struct contains the edited values. String pointers are static: 
                                  // - do *not* free them 
                                  // - if you need to keep them around, strdup them, as they may be changed later by other plugins calling ML_IPC_EDITQUERY.
  1. define ML_IPC_SET_FILE_RATING 0x0906 // lParam = 0 to 5, rates current track -- inserts it in the db if it's not in it yet
  2. define ML_IPC_GET_FILE_RATING 0x0907 // return the current track's rating or 0 if not in db/no rating

// playlist entry rating typedef struct {

 const char* fileName;
 int newRating;

} file_set_rating;

  1. define ML_IPC_SMARTVIEW_COUNT 0x0908 // returns the number of smartviews. no parameter required
  2. define ML_IPC_SMARTVIEW_INFO 0x0909 // pass a mlSmartViewInfo*. returns 1 on success and 0 on failure
  3. define ML_IPC_SMARTVIEW_ADD 0x0910 // pass a mlSmartViewInfo* with filled in size, name, query, mode, iconImgIndex. treeitemid gets filled in. returns 1 on success and 0 on failure

typedef struct { // you fill these in size_t size; // set to sizeof(mlSmartViewInfo) size_t smartViewNum; // ml_local fills these in wchar_t smartViewName[128]; wchar_t smartViewQuery[512]; int mode; int iconImgIndex; int treeItemId; } mlSmartViewInfo;


  1. define ML_IPC_SET_FILE_RATINGW 0x0911 // lParam = 0 to 5, rates current track -- inserts it in the db if it's not in it yet
  2. define ML_IPC_GET_FILE_RATINGW 0x0912 // return the current track's rating or 0 if not in db/no rating

// playlist entry rating typedef struct {

 const wchar_t *fileName;
 int newRating;

} file_set_ratingW; </source>