include/vlc_media_library.h

   1 /*****************************************************************************
   2  * vlc_media_library.h: SQL-based media library
   3  *****************************************************************************
   4  * Copyright (C) 2008-2010 the VideoLAN Team and AUTHORS
   5  *
   6  * Authors: Antoine Lejeune <phytos@videolan.org>
   7  *          Jean-Philippe André <jpeg@videolan.org>
   8  *          Rémi Duraffort <ivoire@videolan.org>
   9  *          Adrien Maglo <magsoft@videolan.org>
  10  *          Srikanth Raju <srikiraju at gmail dot com>
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU Lesser General Public License as published by
  14  * the Free Software Foundation; either version 2.1 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20  * GNU Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * along with this program; if not, write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 #ifndef VLC_MEDIA_LIBRARY_H
  28 # define VLC_MEDIA_LIBRARY_H
  29
  30 #include <assert.h>
  31 #include <vlc_common.h>
  32
  33 # ifdef __cplusplus
  34 extern "C" {
  35 # endif
  36
  37 typedef enum vlc_ml_media_type_t
  38 {
  39     VLC_ML_MEDIA_TYPE_UNKNOWN,
  40     VLC_ML_MEDIA_TYPE_VIDEO,
  41     VLC_ML_MEDIA_TYPE_AUDIO,
  42     VLC_ML_MEDIA_TYPE_EXTERNAL,
  43     VLC_ML_MEDIA_TYPE_STREAM,
  44 } vlc_ml_media_type_t;
  45
  46 typedef enum vlc_ml_media_subtype_t
  47 {
  48     VLC_ML_MEDIA_SUBTYPE_UNKNOWN,
  49     VLC_ML_MEDIA_SUBTYPE_SHOW_EPISODE,
  50     VLC_ML_MEDIA_SUBTYPE_MOVIE,
  51     VLC_ML_MEDIA_SUBTYPE_ALBUMTRACK,
  52 } vlc_ml_media_subtype_t;
  53
  54 typedef enum vlc_ml_file_type_t
  55 {
  56     VLC_ML_FILE_TYPE_UNKNOWN,
  57     VLC_ML_FILE_TYPE_MAIN,
  58     VLC_ML_FILE_TYPE_PART,
  59     VLC_ML_FILE_TYPE_SOUNDTRACK,
  60     VLC_ML_FILE_TYPE_SUBTITLE,
  61     VLC_ML_FILE_TYPE_PLAYLIST,
  62 } vlc_ml_file_type_t;
  63
  64 typedef enum vlc_ml_track_type_t
  65 {
  66     VLC_ML_TRACK_TYPE_UNKNOWN,
  67     VLC_ML_TRACK_TYPE_VIDEO,
  68     VLC_ML_TRACK_TYPE_AUDIO,
  69 } vlc_ml_track_type_t;
  70
  71 typedef struct vlc_ml_movie_t
  72 {
  73     char* psz_summary;
  74     char* psz_imdb_id;
  75 } vlc_ml_movie_t;
  76
  77 typedef struct vlc_ml_show_episode_t
  78 {
  79     char* psz_summary;
  80     char* psz_tvdb_id;
  81     uint32_t i_episode_nb;
  82     uint32_t i_season_number;
  83 } vlc_ml_show_episode_t;
  84
  85 typedef struct vlc_ml_show_t
  86 {
  87     int64_t i_id;
  88     char* psz_name;
  89     char* psz_summary;
  90     char* psz_artwork_mrl;
  91     char* psz_tvdb_id;
  92     unsigned int i_release_year;
  93     uint32_t i_nb_episodes;
  94     uint32_t i_nb_seasons;
  95 } vlc_ml_show_t;
  96
  97 typedef struct vlc_ml_album_track_t
  98 {
  99     int64_t i_artist_id;
 100     int64_t i_album_id;
 101     int64_t i_genre_id;
 102
 103     int i_track_nb;
 104     int i_disc_nb;
 105 } vlc_ml_album_track_t;
 106
 107 typedef struct vlc_ml_label_t
 108 {
 109     int64_t i_id;
 110     char* psz_name;
 111 } vlc_ml_label_t;
 112
 113 typedef struct vlc_ml_label_list_t
 114 {
 115     size_t i_nb_items;
 116     vlc_ml_label_t p_items[];
 117 } vlc_ml_label_list_t;
 118
 119 typedef struct vlc_ml_file_t
 120 {
 121     char* psz_mrl;
 122     vlc_ml_file_type_t i_type;
 123     bool b_external;
 124     bool b_removable;
 125     bool b_present;
 126 } vlc_ml_file_t;
 127
 128 typedef struct vlc_ml_file_list_t
 129 {
 130     size_t i_nb_items;
 131     vlc_ml_file_t p_items[];
 132 } vlc_ml_file_list_t;
 133
 134 typedef struct vlc_ml_media_track_t
 135 {
 136     char* psz_codec;
 137     char* psz_language;
 138     char* psz_description;
 139     vlc_ml_track_type_t i_type;
 140     uint32_t i_bitrate;
 141     union
 142     {
 143         struct
 144         {
 145             // Audio
 146             uint32_t i_nbChannels;
 147             uint32_t i_sampleRate;
 148         } a;
 149         struct
 150         {
 151             // Video
 152             uint32_t i_height;
 153             uint32_t i_width;
 154             uint32_t i_sarNum;
 155             uint32_t i_sarDen;
 156             uint32_t i_fpsNum;
 157             uint32_t i_fpsDen;
 158         } v;
 159     };
 160 } vlc_ml_media_track_t;
 161
 162 typedef struct vlc_ml_media_track_list_t
 163 {
 164     size_t i_nb_items;
 165     vlc_ml_media_track_t p_items[];
 166 } vlc_ml_media_track_list_t;
 167
 168 typedef struct vlc_ml_media_t
 169 {
 170     int64_t i_id;
 171
 172     vlc_ml_media_type_t i_type;
 173     vlc_ml_media_subtype_t i_subtype;
 174
 175     vlc_ml_file_list_t* p_files;
 176     vlc_ml_media_track_list_t* p_tracks;
 177
 178     int32_t i_year;
 179     /* Duration in milliseconds */
 180     int64_t i_duration;
 181     uint32_t i_playcount;
 182     time_t i_last_played_date;
 183     char* psz_title;
 184
 185     char* psz_artwork_mrl;
 186     /* True if a thumbnail is available, or if thumbnail generation was
 187      * attempted but failed */
 188     bool b_artwork_generated;
 189     bool b_is_favorite;
 190
 191     union
 192     {
 193         vlc_ml_show_episode_t show_episode;
 194         vlc_ml_movie_t movie;
 195         vlc_ml_album_track_t album_track;
 196     };
 197 } vlc_ml_media_t;
 198
 199 typedef struct vlc_ml_playlist_t
 200 {
 201     int64_t i_id;
 202     char* psz_name;
 203     uint32_t i_creation_date;
 204     char* psz_artwork_mrl;
 205 } vlc_ml_playlist_t;
 206
 207 typedef struct vlc_ml_artist_t
 208 {
 209     int64_t i_id;
 210     char* psz_name;
 211     char* psz_shortbio;
 212     char* psz_artwork_mrl;
 213     char* psz_mb_id;
 214
 215     unsigned int i_nb_album;
 216     unsigned int i_nb_tracks;
 217 } vlc_ml_artist_t;
 218
 219 typedef struct vlc_ml_artist_list_t
 220 {
 221     size_t i_nb_items;
 222     vlc_ml_artist_t p_items[];
 223 } vlc_ml_artist_list_t;
 224
 225 typedef struct vlc_ml_album_t {
 226     int64_t i_id;
 227     char* psz_title;
 228     char* psz_summary;
 229     char* psz_artwork_mrl;
 230     char* psz_artist;
 231     int64_t i_artist_id;
 232
 233     size_t i_nb_tracks;
 234     unsigned int i_duration;
 235     unsigned int i_year;
 236 } vlc_ml_album_t;
 237
 238 typedef struct vlc_ml_genre_t
 239 {
 240     int64_t i_id;
 241     char* psz_name;
 242     size_t i_nb_tracks;
 243 } vlc_ml_genre_t;
 244
 245 typedef struct vlc_ml_media_list_t
 246 {
 247     size_t i_nb_items;
 248     vlc_ml_media_t p_items[];
 249 } vlc_ml_media_list_t;
 250
 251 typedef struct vlc_ml_album_list_t
 252 {
 253     size_t i_nb_items;
 254     vlc_ml_album_t p_items[];
 255 } vlc_ml_album_list_t;
 256
 257 typedef struct vlc_ml_show_list_t
 258 {
 259     size_t i_nb_items;
 260     vlc_ml_show_t p_items[];
 261 } vlc_ml_show_list_t;
 262
 263 typedef struct vlc_ml_genre_list_t
 264 {
 265     size_t i_nb_items;
 266     vlc_ml_genre_t p_items[];
 267 } vlc_ml_genre_list_t;
 268
 269 typedef struct vlc_ml_playlist_list_t
 270 {
 271     size_t i_nb_items;
 272     vlc_ml_playlist_t p_items[];
 273 } vlc_ml_playlist_list_t;
 274
 275 typedef struct vlc_ml_entry_point_t
 276 {
 277     char* psz_mrl; /**< This entrypoint's MRL. Will be NULL if b_present is false */
 278     bool b_present; /**< The presence state for this entrypoint. */
 279     bool b_banned; /**< Will be true if the user required this entrypoint to be excluded */
 280 } vlc_ml_entry_point_t;
 281
 282 typedef struct vlc_ml_entry_point_list_t
 283 {
 284     size_t i_nb_items;
 285     vlc_ml_entry_point_t p_items[];
 286 } vlc_ml_entry_point_list_t;
 287
 288 /* Opaque medialibrary pointer, to be used by any non-medialibrary module */
 289 typedef struct vlc_medialibrary_t vlc_medialibrary_t;
 290 /* "Private" medialibrary pointer, to be used by the core & medialibrary modules */
 291 typedef struct vlc_medialibrary_module_t vlc_medialibrary_module_t;
 292 /* Opaque event callback type */
 293 typedef struct vlc_ml_event_callback_t vlc_ml_event_callback_t;
 294
 295 typedef enum vlc_ml_sorting_criteria_t
 296 {
 297     /*
 298      * Default depends on the entity type:
 299      * - By track number (and disc number) for album tracks
 300      * - Alphabetical order for others
 301      */
 302     VLC_ML_SORTING_DEFAULT,
 303     VLC_ML_SORTING_ALPHA,
 304     VLC_ML_SORTING_DURATION,
 305     VLC_ML_SORTING_INSERTIONDATE,
 306     VLC_ML_SORTING_LASTMODIFICATIONDATE,
 307     VLC_ML_SORTING_RELEASEDATE,
 308     VLC_ML_SORTING_FILESIZE,
 309     VLC_ML_SORTING_ARTIST,
 310     VLC_ML_SORTING_PLAYCOUNT,
 311     VLC_ML_SORTING_ALBUM,
 312     VLC_ML_SORTING_FILENAME,
 313     VLC_ML_SORTING_TRACKNUMBER,
 314 } vlc_ml_sorting_criteria_t;
 315
 316 typedef struct vlc_ml_query_params_t vlc_ml_query_params_t;
 317 struct vlc_ml_query_params_t
 318 {
 319     const char* psz_pattern;
 320     uint32_t i_nbResults;
 321     uint32_t i_offset;
 322     vlc_ml_sorting_criteria_t i_sort;
 323     bool b_desc;
 324 };
 325
 326 enum vlc_ml_get_queries
 327 {
 328     VLC_ML_GET_MEDIA,           /**< arg1: Media    ID; ret: vlc_ml_media_t*    */
 329     VLC_ML_GET_INPUT_ITEM,      /**< arg1: Media    ID; ret: input_item_t*      */
 330     VLC_ML_GET_ALBUM,           /**< arg1: Album    ID; ret: vlc_ml_album_t*    */
 331     VLC_ML_GET_ARTIST,          /**< arg1: Artist   ID; ret: vlc_ml_artist_t*   */
 332     VLC_ML_GET_GENRE,           /**< arg1: Genre    ID; ret: vlc_ml_genre_t*    */
 333     VLC_ML_GET_SHOW,            /**< arg1: Show     ID; ret: vlc_ml_show_t*     */
 334     VLC_ML_GET_PLAYLIST,        /**< arg1: Playlist ID; ret: vlc_ml_playlist_t* */
 335 };
 336
 337 enum vlc_ml_list_queries
 338 {
 339     /* General listing: */
 340
 341     VLC_ML_LIST_VIDEOS,           /**< arg1 (out): vlc_ml_media_list_t**                            */
 342     VLC_ML_COUNT_VIDEOS,          /**< arg1 (out): size_t*                                          */
 343     VLC_ML_LIST_AUDIOS,           /**< arg1 (out): vlc_ml_media_list_t**                            */
 344     VLC_ML_COUNT_AUDIOS,          /**< arg1 (out): size_t*                                          */
 345     VLC_ML_LIST_ALBUMS,           /**< arg1 (out): vlc_ml_album_list_t**                            */
 346     VLC_ML_COUNT_ALBUMS,          /**< arg1 (out): size_t*                                          */
 347     VLC_ML_LIST_GENRES,           /**< arg1 (out): vlc_ml_genre_list_t**                            */
 348     VLC_ML_COUNT_GENRES,          /**< arg1 (out): size_t*                                          */
 349     VLC_ML_LIST_ARTISTS,          /**< arg1 bool: includeAll; arg2 (out): vlc_ml_genre_list_t**     */
 350     VLC_ML_COUNT_ARTISTS,         /**< arg1 bool: includeAll; arg2 (out): size_t*                   */
 351     VLC_ML_LIST_SHOWS,            /**< arg1 (out): vlc_ml_show_list_t**                             */
 352     VLC_ML_COUNT_SHOWS,           /**< arg1 (out): size_t*                                          */
 353     VLC_ML_LIST_PLAYLISTS,        /**< arg1 (out): vlc_ml_playlist_list_t**                         */
 354     VLC_ML_COUNT_PLAYLISTS,       /**< arg1 (out): size_t*                                          */
 355     VLC_ML_LIST_HISTORY,          /**< arg1 (out): vlc_ml_media_list_t**                            */
 356     VLC_ML_LIST_STREAM_HISTORY,   /**< arg1 (out): vlc_ml_media_list_t**                            */
 357
 358     /* Album specific listings */
 359     VLC_ML_LIST_ALBUM_TRACKS,     /**< arg1: The album id. arg2 (out): vlc_ml_media_list_t**  */
 360     VLC_ML_COUNT_ALBUM_TRACKS,    /**< arg1: The album id. arg2 (out): size_t*  */
 361     VLC_ML_LIST_ALBUM_ARTISTS,    /**< arg1: The album id. arg2 (out): vlc_ml_album_list_t**  */
 362     VLC_ML_COUNT_ALBUM_ARTISTS,    /**< arg1: The album id. arg2 (out): size_t*  */
 363
 364     /* Artist specific listings */
 365     VLC_ML_LIST_ARTIST_ALBUMS,  /**< arg1: The artist id. arg2(out): vlc_ml_album_list_t**    */
 366     VLC_ML_COUNT_ARTIST_ALBUMS, /**< arg1: The artist id. arg2(out): size_t*              */
 367     VLC_ML_LIST_ARTIST_TRACKS,  /**< arg1: The artist id. arg2(out): vlc_ml_media_list_t**    */
 368     VLC_ML_COUNT_ARTIST_TRACKS, /**< arg1: The artist id. arg2(out): size_t*              */
 369
 370     /* Genre specific listings */
 371     VLC_ML_LIST_GENRE_ARTISTS,    /**< arg1: genre id;  arg2 (out): vlc_ml_artist_list_t**  */
 372     VLC_ML_COUNT_GENRE_ARTISTS,   /**< arg1: genre id;  arg2 (out): size_t*             */
 373     VLC_ML_LIST_GENRE_TRACKS,     /**< arg1: genre id;  arg2 (out): vlc_ml_media_list_t**   */
 374     VLC_ML_COUNT_GENRE_TRACKS,    /**< arg1: genre id;  arg2 (out): size_t*             */
 375     VLC_ML_LIST_GENRE_ALBUMS,     /**< arg1: genre id;  arg2 (out): vlc_ml_album_list_t**   */
 376     VLC_ML_COUNT_GENRE_ALBUMS,    /**< arg1: genre id;  arg2 (out): size_t*             */
 377
 378     /* Show specific listings */
 379     VLC_ML_LIST_SHOW_EPISODES,    /**< arg1: show id; arg2(out): vlc_ml_media_list_t**  */
 380     VLC_ML_COUNT_SHOW_EPISODES,   /**< arg1: show id; arg2(out): size_t*                */
 381
 382     /* Media specific listings */
 383     VLC_ML_LIST_MEDIA_LABELS,     /**< arg1: media id;  arg2 (out): vlc_ml_label_list_t**    */
 384     VLC_ML_COUNT_MEDIA_LABELS,    /**< arg1: media id;  arg2 (out): size_t*              */
 385
 386     /* Playlist specific listings */
 387     VLC_ML_LIST_PLAYLIST_MEDIA,   /**< arg1: playlist id; arg2 (out): vlc_ml_media_list_t** */
 388     VLC_ML_COUNT_PLAYLIST_MEDIA,  /**< arg1: playlist id; arg2 (out): size_t* */
 389
 390     /* Children entities listing */
 391     VLC_ML_LIST_MEDIA_OF,         /**< arg1: parent entity type; arg2: parent entity id; arg3(out): ml_media_list_t** */
 392     VLC_ML_COUNT_MEDIA_OF,        /**< arg1: parent entity type; arg2: parent entity id; arg3(out): size_t* */
 393     VLC_ML_LIST_ARTISTS_OF,       /**< arg1: parent entity type; arg2: parent entity id; arg3(out): ml_artist_list_t** */
 394     VLC_ML_COUNT_ARTISTS_OF,      /**< arg1: parent entity type; arg2: parent entity id; arg3(out): size_t* */
 395     VLC_ML_LIST_ALBUMS_OF,        /**< arg1: parent entity type; arg2: parent entity id; arg3(out): ml_album_list_t** */
 396     VLC_ML_COUNT_ALBUMS_OF,       /**< arg1: parent entity type; arg2: parent entity id; arg3(out): size_t* */
 397 };
 398
 399 enum vlc_ml_parent_type
 400 {
 401     VLC_ML_PARENT_UNKNOWN,
 402     VLC_ML_PARENT_ALBUM,
 403     VLC_ML_PARENT_ARTIST,
 404     VLC_ML_PARENT_SHOW,
 405     VLC_ML_PARENT_GENRE,
 406     VLC_ML_PARENT_PLAYLIST,
 407 };
 408
 409 enum vlc_ml_control
 410 {
 411     /* Adds a folder to discover through the medialibrary */
 412     VLC_ML_ADD_FOLDER,              /**< arg1: mrl (const char*)  res: can't fail */
 413     VLC_ML_REMOVE_FOLDER,           /**< arg1: mrl (const char*)  res: can't fail */
 414     VLC_ML_BAN_FOLDER,              /**< arg1: mrl (const char*)  res: can't fail */
 415     VLC_ML_UNBAN_FOLDER,            /**< arg1: mrl (const char*)  res: can't fail */
 416     VLC_ML_LIST_FOLDERS,            /**< arg1: entrypoints (vlc_ml_entry_point_list_t**); res: can fail */
 417     VLC_ML_IS_INDEXED,              /**< arg1: mrl (const char*) arg2 (out): bool*;       res: can fail */
 418     /**
 419      * Reload a specific folder, or all.
 420      * arg1: mrl (const char*), NULL to reload all folders
 421      * res: can't fail
 422      */
 423     VLC_ML_RELOAD_FOLDER,
 424
 425     /* Pause/resume background operations, such as media discovery & media analysis */
 426     VLC_ML_PAUSE_BACKGROUND,        /**< no args; can't fail */
 427     VLC_ML_RESUME_BACKGROUND,       /**< no args; can't fail */
 428
 429     /* Misc operations */
 430     VLC_ML_CLEAR_HISTORY,           /**< no args; can't fail */
 431
 432     /* Create media */
 433     VLC_ML_NEW_EXTERNAL_MEDIA,      /**< arg1: const char*; arg2(out): vlc_ml_media_t** */
 434     VLC_ML_NEW_STREAM,              /**< arg1: const char*; arg2(out): vlc_ml_media_t** */
 435
 436     /* Media management */
 437     VLC_ML_MEDIA_INCREASE_PLAY_COUNT,       /**< arg1: media id; can fail */
 438     VLC_ML_MEDIA_GET_MEDIA_PLAYBACK_PREF,   /**< arg1: media id; arg2: vlc_ml_playback_pref; arg3: char**; */
 439     VLC_ML_MEDIA_SET_MEDIA_PLAYBACK_PREF,   /**< arg1: media id; arg2: vlc_ml_playback_pref; arg3: const char*; */
 440     VLC_ML_MEDIA_SET_THUMBNAIL,             /**< arg1: media id; arg2: const char*; */
 441     VLC_ML_MEDIA_GENERATE_THUMBNAIL,        /**< arg1: media id; */
 442     VLC_ML_MEDIA_ADD_EXTERNAL_MRL,          /**< arg1: media id; arg2: const char*; arg3: type(vlc_ml_file_type_t) */
 443 };
 444
 445 /**
 446  * User playback settings.
 447  * All values/units are up to the caller and are not interpreted by the media
 448  * library.
 449  * All values are stored and returned as strings.
 450  * When calling vlc_medialibrary_t::pf_control with vlc_ml_MEDIA_GET_MEDIA_PLAYBACK_PREF,
 451  * the value will be returned stored in the provided char**. If the preference was
 452  * not set yet, NULL will be returned.
 453  * When setting a preference, NULL can be provided as a value to unset it.
 454  */
 455 enum vlc_ml_playback_pref
 456 {
 457     VLC_ML_PLAYBACK_PREF_RATING,
 458     VLC_ML_PLAYBACK_PREF_PROGRESS,
 459     VLC_ML_PLAYBACK_PREF_SPEED,
 460     VLC_ML_PLAYBACK_PREF_TITLE,
 461     VLC_ML_PLAYBACK_PREF_CHAPTER,
 462     VLC_ML_PLAYBACK_PREF_PROGRAM,
 463     VLC_ML_PLAYBACK_PREF_SEEN,
 464     VLC_ML_PLAYBACK_PREF_VIDEO_TRACK,
 465     VLC_ML_PLAYBACK_PREF_ASPECT_RATIO,
 466     VLC_ML_PLAYBACK_PREF_ZOOM,
 467     VLC_ML_PLAYBACK_PREF_CROP,
 468     VLC_ML_PLAYBACK_PREF_DEINTERLACE,
 469     VLC_ML_PLAYBACK_PREF_VIDEO_FILTER,
 470     VLC_ML_PLAYBACK_PREF_AUDIO_TRACK,
 471     VLC_ML_PLAYBACK_PREF_GAIN,
 472     VLC_ML_PLAYBACK_PREF_AUDIO_DELAY,
 473     VLC_ML_PLAYBACK_PREF_SUBTITLE_TRACK,
 474     VLC_ML_PLAYBACK_PREF_SUBTITLE_DELAY,
 475     VLC_ML_PLAYBACK_PREF_APP_SPECIFIC,
 476 };
 477
 478 enum vlc_ml_event_type
 479 {
 480     /**
 481      * Entity modification callbacks. The affected entity will be passed:
 482      * - As a vlc_ml_<type>_t, depending on the type of the modified/inserted
 483      * entity, in vlc_ml_event_t::modification::p_<type>
 484      * for ADDED and UPDATED variants.
 485      * - as an id, in vlc_ml_event_t::deletion::i_entity_id
 486      * When _DELETED callbacks get invoked, the entity will already have been
 487      * deleted from the database, and cannot be retrieved anymore
 488      */
 489     VLC_ML_EVENT_MEDIA_ADDED,
 490     VLC_ML_EVENT_MEDIA_UPDATED,
 491     VLC_ML_EVENT_MEDIA_DELETED,
 492     VLC_ML_EVENT_ARTIST_ADDED,
 493     VLC_ML_EVENT_ARTIST_UPDATED,
 494     VLC_ML_EVENT_ARTIST_DELETED,
 495     VLC_ML_EVENT_ALBUM_ADDED,
 496     VLC_ML_EVENT_ALBUM_UPDATED,
 497     VLC_ML_EVENT_ALBUM_DELETED,
 498     VLC_ML_EVENT_PLAYLIST_ADDED,
 499     VLC_ML_EVENT_PLAYLIST_UPDATED,
 500     VLC_ML_EVENT_PLAYLIST_DELETED,
 501     VLC_ML_EVENT_GENRE_ADDED,
 502     VLC_ML_EVENT_GENRE_UPDATED,
 503     VLC_ML_EVENT_GENRE_DELETED,
 504     /**
 505      * A discovery started.
 506      * For each VLC_ML_EVENT_DISCOVERY_STARTED event, there will be
 507      * 1 VLC_ML_EVENT_DISCOVERY_COMPLETED event, and N
 508      * VLC_ML_EVENT_DISCOVERY_COMPLETED events.
 509      * The entry point being discovered is stored in
 510      * vlc_ml_event_t::discovery_started::psz_entry_point.
 511      */
 512     VLC_ML_EVENT_DISCOVERY_STARTED,
 513     /**
 514      * Sent when a discovery or reload operation starts analyzing a new folder.
 515      * The discovered entry point is stored in
 516      * vlc_ml_event_t::discovery_progress::psz_entry_point.
 517      */
 518     VLC_ML_EVENT_DISCOVERY_PROGRESS,
 519     /**
 520      * Sent when an entry point discovery is completed.
 521      * The entry point that was being discovered is stored in
 522      * vlc_ml_event_t::discovery_completed::psz_entry_point.
 523      * The success or failure state is stored in
 524      * vlc_ml_event_t::discovery_completed::b_success
 525      */
 526     VLC_ML_EVENT_DISCOVERY_COMPLETED,
 527     /**
 528      * An entry point reload operation started.
 529      * For all the entry points being reloaded, N VLC_EVENT_DISCOVERY_PROGRESS
 530      * and 1 VLC_EVENT_RELOAD_COMPLETED event will be sent.
 531      * The entry point being reloaded is stored in
 532      * vlc_ml_event_t::reload_started::psz_entry_point.
 533      */
 534     VLC_ML_EVENT_RELOAD_STARTED,
 535     /**
 536      * Sent when an entry point reload is completed.
 537      * The entry point that was being reloaded is stored in
 538      * vlc_ml_event_t::reload_completed::psz_entry_point.
 539      * The success or failure state is stored in
 540      * vlc_ml_event_t::reload_completed::b_success
 541      */
 542     VLC_ML_EVENT_RELOAD_COMPLETED,
 543     /**
 544      * Sent when an entry point removal request has been processed.
 545      * The removed entry point is stored in
 546      * vlc_ml_event_t::entry_point_removed::psz_entry_point and the success or failure
 547      * state is stored in vlc_ml_event_t::entry_point_removed::b_success
 548      */
 549     VLC_ML_EVENT_ENTRY_POINT_REMOVED,
 550     /**
 551      * Sent when an entry point ban request has been processed.
 552      * The banned entry point is stored in
 553      * vlc_ml_event_t::entry_point_banned::psz_entry_point and the operation success
 554      * state is stored in vlc_ml_event_t::entry_point_banned::b_success
 555      */
 556     VLC_ML_EVENT_ENTRY_POINT_BANNED,
 557     /**
 558      * Sent when an entry point unban request has been processed.
 559      * The unbanned entry point is stored in
 560      * vlc_ml_event_t::entry_point_unbanned::psz_entry_point and the operation success
 561      * state is stored in vlc_ml_event_t::entry_point_unbanned::b_success
 562      */
 563     VLC_ML_EVENT_ENTRY_POINT_UNBANNED,
 564     /**
 565      * Sent when a discoverer or parser threads changes its idle state.
 566      * The idle state is stored in vlc_ml_event_t::background_idle_changed.b_idle.
 567      * False means at least one background thread is in running, true means
 568      * both discoverer & parser threads are paused.
 569      */
 570     VLC_ML_EVENT_BACKGROUND_IDLE_CHANGED,
 571     /**
 572      * Sent when the parsing progress percentage gets updated.
 573      * The percentage is stored as a [0;100] integer, in
 574      * vlc_ml_event_t::parsing_progress::i_percent
 575      * This value might decrease as more media get discovered, but it will only
 576      * increase once all discovery operations are completed.
 577      */
 578     VLC_ML_EVENT_PARSING_PROGRESS_UPDATED,
 579     /**
 580      * Sent after a media thumbnail was generated, or if it's generation failed.
 581      * The media is stored in vlc_ml_event_t::media_thumbnail_generated::p_media
 582      * and the success state is stored in
 583      * vlc_ml_event_t::media_thumbnail_generated::b_success
 584      */
 585     VLC_ML_EVENT_MEDIA_THUMBNAIL_GENERATED,
 586 };
 587
 588 typedef struct vlc_ml_event_t
 589 {
 590     int i_type;
 591     union
 592     {
 593         struct
 594         {
 595             const char* psz_entry_point;
 596         } discovery_started;
 597         struct
 598         {
 599             const char* psz_entry_point;
 600         } discovery_progress;
 601         struct
 602         {
 603             const char* psz_entry_point;
 604             bool b_success;
 605         } discovery_completed;
 606         struct
 607         {
 608             const char* psz_entry_point;
 609         } reload_started;
 610         struct
 611         {
 612             const char* psz_entry_point;
 613             bool b_success;
 614         } reload_completed;
 615         struct
 616         {
 617             const char* psz_entry_point;
 618             bool b_success;
 619         } entry_point_removed;
 620         struct
 621         {
 622             const char* psz_entry_point;
 623             bool b_success;
 624         } entry_point_banned;
 625         struct
 626         {
 627             const char* psz_entry_point;
 628             bool b_success;
 629         } entry_point_unbanned;
 630         struct
 631         {
 632             uint8_t i_percent;
 633         } parsing_progress;
 634         union
 635         {
 636             const vlc_ml_media_t* p_media;
 637             const vlc_ml_artist_t* p_artist;
 638             const vlc_ml_album_t* p_album;
 639             const vlc_ml_playlist_t* p_playlist;
 640             const vlc_ml_genre_t* p_genre;
 641         } modification;
 642         struct
 643         {
 644             int64_t i_entity_id;
 645         } deletion;
 646         struct
 647         {
 648             bool b_idle;
 649         } background_idle_changed;
 650         struct
 651         {
 652             const vlc_ml_media_t* p_media;
 653             bool b_success;
 654         } media_thumbnail_generated;
 655     };
 656 } vlc_ml_event_t;
 657
 658 typedef void (*vlc_ml_callback_t)( void* p_data, const vlc_ml_event_t* p_event );
 659
 660 typedef struct vlc_medialibrary_callbacks_t
 661 {
 662     void (*pf_send_event)( vlc_medialibrary_module_t* p_ml, const vlc_ml_event_t* p_event );
 663 } vlc_medialibrary_callbacks_t;
 664
 665 struct vlc_medialibrary_module_t
 666 {
 667     struct vlc_common_members obj;
 668
 669     module_t *p_module;
 670
 671     void* p_sys;
 672
 673     int (*pf_control)( struct vlc_medialibrary_module_t* p_ml, int i_query, va_list args );
 674     /**
 675      * List some entities from the medialibrary.
 676      *
 677      * \param p_ml The medialibrary module instance.
 678      * \param i_query The type search to be performed. \see vlc_ml_list enumeration
 679      * \param p_params A pointer to a vlc_ml_query_params_t structure, or NULL for
 680      * the default parameters (alphabetical ascending sort, no pagination)
 681      *
 682      * \return VLC_SUCCESS or an error code
 683      *
 684      * Refer to the individual list of vlc_ml_list requests for the additional
 685      * per-query input/ouput parameters values & types
 686      */
 687     int (*pf_list)( struct vlc_medialibrary_module_t* p_ml, int i_query,
 688                     const vlc_ml_query_params_t* p_params, va_list args );
 689
 690     /**
 691      * Get a specific entity by its id.
 692      *
 693      * \return The required entity, or a NULL pointer if couldn't be found.
 694      *
 695      * Refer to the list of queries for the specific return type
 696      */
 697     void* (*pf_get)( struct vlc_medialibrary_module_t* p_ml, int i_query, int64_t i_id );
 698
 699     const vlc_medialibrary_callbacks_t* cbs;
 700 };
 701
 702 vlc_medialibrary_t* libvlc_MlCreate( libvlc_int_t* p_libvlc );
 703 void libvlc_MlRelease( vlc_medialibrary_t* p_ml );
 704
 705 VLC_API vlc_medialibrary_t* vlc_ml_instance_get( vlc_object_t* p_obj ) VLC_USED;
 706 #define vlc_ml_instance_get(x) vlc_ml_instance_get( VLC_OBJECT(x) )
 707
 708 VLC_API void* vlc_ml_get( vlc_medialibrary_t* p_ml, int i_query, int64_t i_id ) VLC_USED;
 709 VLC_API int vlc_ml_control( vlc_medialibrary_t* p_ml, int i_query, ... ) VLC_USED;
 710 VLC_API int vlc_ml_list( vlc_medialibrary_t* p_ml, int i_query,
 711                              const vlc_ml_query_params_t* p_params, ... );
 712
 713 /**
 714  * \brief Registers a medialibrary callback.
 715  * \returns A handle to the callback, to be passed to vlc_ml_event_unregister_callback
 716  */
 717 VLC_API vlc_ml_event_callback_t*
 718 vlc_ml_event_register_callback( vlc_medialibrary_t* p_ml, vlc_ml_callback_t cb, void* p_data );
 719
 720 /**
 721  * \brief Unregisters a medialibrary callback
 722  * \param p_handle The handled returned by vlc_ml_register_callback
 723  */
 724 VLC_API void vlc_ml_event_unregister_callback( vlc_medialibrary_t* p_ml,
 725                                                vlc_ml_event_callback_t* p_callback );
 726 /**
 727  * \brief Unregisters a medialibrary callback from the said callback.
 728  * \param p_callback The handle returned by vlc_ml_register_callback
 729  *
 730  * This must only be called synchronously from the callback function provided to
 731  * vlc_ml_event_register_callback
 732  * The p_callback handle must be considered invalid when this function returns
 733  */
 734 VLC_API void vlc_ml_event_unregister_from_callback( vlc_medialibrary_t* p_ml,
 735                                                     vlc_ml_event_callback_t* p_callback );
 736
 737
 738 VLC_API void vlc_ml_show_release( vlc_ml_show_t* p_show );
 739 VLC_API void vlc_ml_artist_release( vlc_ml_artist_t* p_artist );
 740 VLC_API void vlc_ml_genre_release( vlc_ml_genre_t* p_genre );
 741 VLC_API void vlc_ml_media_release( vlc_ml_media_t* p_media );
 742 VLC_API void vlc_ml_album_release( vlc_ml_album_t* p_album );
 743 VLC_API void vlc_ml_playlist_release( vlc_ml_playlist_t* p_playlist );
 744
 745 VLC_API void vlc_ml_label_list_release( vlc_ml_label_list_t* p_list );
 746 VLC_API void vlc_ml_file_list_release( vlc_ml_file_list_t* p_list );
 747 VLC_API void vlc_ml_artist_list_release( vlc_ml_artist_list_t* p_list );
 748 VLC_API void vlc_ml_media_list_release( vlc_ml_media_list_t* p_list );
 749 VLC_API void vlc_ml_album_list_release( vlc_ml_album_list_t* p_list );
 750 VLC_API void vlc_ml_show_list_release( vlc_ml_show_list_t* p_list );
 751 VLC_API void vlc_ml_genre_list_release( vlc_ml_genre_list_t* p_list );
 752 VLC_API void vlc_ml_playlist_list_release( vlc_ml_playlist_list_t* p_list );
 753 VLC_API void vlc_ml_entry_point_list_release( vlc_ml_entry_point_list_t* p_list );
 754
 755 static inline vlc_ml_query_params_t vlc_ml_query_params_create()
 756 {
 757     return (vlc_ml_query_params_t) {
 758         .psz_pattern = NULL,
 759         .i_nbResults = 0,
 760         .i_offset = 0,
 761         .i_sort = VLC_ML_SORTING_DEFAULT,
 762         .b_desc = false
 763     };
 764 }
 765
 766 static inline int vlc_ml_add_folder( vlc_medialibrary_t* p_ml, const char* psz_folder )
 767 {
 768     return vlc_ml_control( p_ml, VLC_ML_ADD_FOLDER, psz_folder );
 769 }
 770
 771 static inline int vlc_ml_remove_folder( vlc_medialibrary_t* p_ml, const char* psz_folder )
 772 {
 773     return vlc_ml_control( p_ml, VLC_ML_REMOVE_FOLDER, psz_folder );
 774 }
 775
 776 static inline int vlc_ml_ban_folder( vlc_medialibrary_t* p_ml, const char* psz_folder )
 777 {
 778     return vlc_ml_control( p_ml, VLC_ML_BAN_FOLDER, psz_folder );
 779 }
 780
 781 static inline int vlc_ml_unban_folder( vlc_medialibrary_t* p_ml, const char* psz_folder )
 782 {
 783     return vlc_ml_control( p_ml, VLC_ML_UNBAN_FOLDER, psz_folder );
 784 }
 785
 786 static inline int vlc_ml_list_folder( vlc_medialibrary_t* p_ml,
 787                                       vlc_ml_entry_point_list_t** pp_entrypoints )
 788 {
 789     return vlc_ml_control( p_ml, VLC_ML_LIST_FOLDERS, pp_entrypoints );
 790 }
 791
 792 static inline int vlc_ml_is_indexed( vlc_medialibrary_t* p_ml,
 793                                      const char* psz_mrl, bool* p_res )
 794 {
 795     return vlc_ml_control( p_ml, VLC_ML_IS_INDEXED, psz_mrl, p_res );
 796 }
 797
 798 static inline int vlc_ml_reload_folder( vlc_medialibrary_t* p_ml, const char* psz_mrl )
 799 {
 800     return vlc_ml_control( p_ml, VLC_ML_RELOAD_FOLDER, psz_mrl );
 801 }
 802
 803 static inline int vlc_ml_pause_background( vlc_medialibrary_t* p_ml )
 804 {
 805     return vlc_ml_control( p_ml, VLC_ML_PAUSE_BACKGROUND );
 806 }
 807
 808 static inline int vlc_ml_resume_background( vlc_medialibrary_t* p_ml )
 809 {
 810     return vlc_ml_control( p_ml, VLC_ML_RESUME_BACKGROUND );
 811 }
 812
 813 static inline int vlc_ml_clear_history( vlc_medialibrary_t* p_ml )
 814 {
 815     return vlc_ml_control( p_ml, VLC_ML_CLEAR_HISTORY );
 816 }
 817
 818 static inline vlc_ml_media_t* vlc_ml_new_external_media( vlc_medialibrary_t* p_ml, const char* psz_mrl )
 819 {
 820     vlc_ml_media_t* res;
 821     if ( vlc_ml_control( p_ml, VLC_ML_NEW_EXTERNAL_MEDIA, psz_mrl, &res ) != VLC_SUCCESS )
 822         return NULL;
 823     return res;
 824 }
 825
 826 static inline vlc_ml_media_t* vlc_ml_new_stream( vlc_medialibrary_t* p_ml, const char* psz_mrl )
 827 {
 828     vlc_ml_media_t* res;
 829     if ( vlc_ml_control( p_ml, VLC_ML_NEW_STREAM, psz_mrl, &res ) != VLC_SUCCESS )
 830         return NULL;
 831     return res;
 832 }
 833
 834 static inline int vlc_ml_media_increase_playcount( vlc_medialibrary_t* p_ml, int64_t i_media_id )
 835 {
 836     return vlc_ml_control( p_ml, VLC_ML_MEDIA_INCREASE_PLAY_COUNT, i_media_id );
 837 }
 838
 839 static inline int vlc_ml_media_get_playback_pref( vlc_medialibrary_t* p_ml, int64_t i_media_id, int i_pref, char** ppsz_result )
 840 {
 841     return vlc_ml_control( p_ml, VLC_ML_MEDIA_GET_MEDIA_PLAYBACK_PREF, i_media_id, i_pref, ppsz_result );
 842 }
 843
 844 static inline int vlc_ml_media_set_playback_pref( vlc_medialibrary_t* p_ml, int64_t i_media_id, int i_pref, const char* psz_value )
 845 {
 846     return vlc_ml_control( p_ml, VLC_ML_MEDIA_SET_MEDIA_PLAYBACK_PREF, i_media_id, i_pref, psz_value );
 847 }
 848
 849 static inline int vlc_ml_media_set_thumbnail( vlc_medialibrary_t* p_ml, int64_t i_media_id, const char* psz_mrl )
 850 {
 851     return vlc_ml_control( p_ml, VLC_ML_MEDIA_SET_THUMBNAIL, i_media_id, psz_mrl );
 852 }
 853
 854 static inline int vlc_ml_media_generate_thumbnail( vlc_medialibrary_t* p_ml, int64_t i_media_id )
 855 {
 856     return vlc_ml_control( p_ml, VLC_ML_MEDIA_GENERATE_THUMBNAIL, i_media_id );
 857 }
 858
 859 static inline int vlc_ml_media_add_external_mrl( vlc_medialibrary_t* p_ml, int64_t i_media_id,
 860                                                  const char* psz_mrl, int i_type )
 861 {
 862     return vlc_ml_control( p_ml, VLC_ML_MEDIA_ADD_EXTERNAL_MRL, i_media_id, psz_mrl, i_type );
 863 }
 864
 865 static inline vlc_ml_media_t* vlc_ml_get_media( vlc_medialibrary_t* p_ml, int64_t i_media_id )
 866 {
 867     return (vlc_ml_media_t*)vlc_ml_get( p_ml, VLC_ML_GET_MEDIA, i_media_id );
 868 }
 869
 870 static inline input_item_t* vlc_ml_get_input_item( vlc_medialibrary_t* p_ml, int64_t i_media_id )
 871 {
 872     return (input_item_t*)vlc_ml_get( p_ml, VLC_ML_GET_INPUT_ITEM, i_media_id );
 873 }
 874
 875 static inline vlc_ml_album_t* vlc_ml_get_album( vlc_medialibrary_t* p_ml, int64_t i_album_id )
 876 {
 877     return (vlc_ml_album_t*)vlc_ml_get( p_ml, VLC_ML_GET_ALBUM, i_album_id );
 878 }
 879
 880 static inline vlc_ml_artist_t* vlc_ml_get_artist( vlc_medialibrary_t* p_ml, int64_t i_artist_id )
 881 {
 882     return (vlc_ml_artist_t*)vlc_ml_get( p_ml, VLC_ML_GET_ARTIST, i_artist_id );
 883 }
 884
 885 static inline vlc_ml_genre_t* vlc_ml_get_genre( vlc_medialibrary_t* p_ml, int64_t i_genre_id )
 886 {
 887     return (vlc_ml_genre_t*)vlc_ml_get( p_ml, VLC_ML_GET_GENRE, i_genre_id );
 888 }
 889
 890 static inline vlc_ml_show_t* vlc_ml_get_show( vlc_medialibrary_t* p_ml, int64_t i_show_id )
 891 {
 892     return (vlc_ml_show_t*)vlc_ml_get( p_ml, VLC_ML_GET_SHOW, i_show_id );
 893 }
 894
 895 static inline vlc_ml_playlist_t* vlc_ml_get_playlist( vlc_medialibrary_t* p_ml, int64_t i_playlist_id )
 896 {
 897     return (vlc_ml_playlist_t*)vlc_ml_get( p_ml, VLC_ML_GET_PLAYLIST, i_playlist_id );
 898 }
 899
 900 static inline vlc_ml_media_list_t* vlc_ml_list_media_of( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int i_parent_type, int64_t i_parent_id )
 901 {
 902     vlc_assert( p_ml != NULL );
 903     vlc_ml_media_list_t* res;
 904     if ( vlc_ml_list( p_ml, VLC_ML_LIST_MEDIA_OF, params, i_parent_type, i_parent_id, &res ) != VLC_SUCCESS )
 905         return NULL;
 906     return res;
 907 }
 908
 909 static inline size_t vlc_ml_count_media_of( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int i_parent_type, int64_t i_parent_id )
 910 {
 911     vlc_assert( p_ml != NULL );
 912     size_t res;
 913     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_MEDIA_OF, params, i_parent_type, i_parent_id, &res ) != VLC_SUCCESS )
 914         return 0;
 915     return res;
 916 }
 917
 918 static inline vlc_ml_artist_list_t* vlc_ml_list_artist_of( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int i_parent_type, int64_t i_parent_id )
 919 {
 920     vlc_assert( p_ml != NULL );
 921     vlc_ml_artist_list_t* res;
 922     if ( vlc_ml_list( p_ml, VLC_ML_LIST_ARTISTS_OF, params, i_parent_type, i_parent_id, &res ) != VLC_SUCCESS )
 923         return NULL;
 924     return res;
 925 }
 926
 927 static inline size_t vlc_ml_count_artists_of( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int i_parent_type, int64_t i_parent_id )
 928 {
 929     vlc_assert( p_ml != NULL );
 930     size_t res;
 931     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_ARTISTS_OF, params, i_parent_type, i_parent_id, &res ) != VLC_SUCCESS )
 932         return 0;
 933     return res;
 934 }
 935
 936 static inline vlc_ml_album_list_t* vlc_ml_list_albums_of( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int i_parent_type, int64_t i_parent_id )
 937 {
 938     vlc_assert( p_ml != NULL );
 939     vlc_ml_album_list_t* res;
 940     if ( vlc_ml_list( p_ml, VLC_ML_LIST_ALBUMS_OF, params, i_parent_type, i_parent_id, &res ) != VLC_SUCCESS )
 941         return NULL;
 942     return res;
 943 }
 944
 945 static inline size_t vlc_ml_count_albums_of( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int i_parent_type, int64_t i_parent_id )
 946 {
 947     vlc_assert( p_ml != NULL );
 948     size_t res;
 949     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_ALBUMS_OF, params, i_parent_type, i_parent_id, &res ) != VLC_SUCCESS )
 950         return 0;
 951     return res;
 952 }
 953
 954 static inline vlc_ml_media_list_t* vlc_ml_list_album_tracks( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_album_id )
 955 {
 956     vlc_assert( p_ml != NULL );
 957     vlc_ml_media_list_t* res;
 958     if ( vlc_ml_list( p_ml, VLC_ML_LIST_ALBUM_TRACKS, params, i_album_id, &res ) != VLC_SUCCESS )
 959         return NULL;
 960     return res;
 961 }
 962
 963 static inline size_t vlc_ml_count_album_tracks( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_album_id )
 964 {
 965     vlc_assert( p_ml != NULL );
 966     size_t count;
 967     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_ALBUM_TRACKS, params, i_album_id, &count ) != VLC_SUCCESS )
 968         return 0;
 969     return count;
 970 }
 971
 972 static inline vlc_ml_media_list_t* vlc_ml_list_album_artists( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_album_id )
 973 {
 974     vlc_assert( p_ml != NULL );
 975     vlc_ml_media_list_t* res;
 976     if ( vlc_ml_list( p_ml, VLC_ML_LIST_ALBUM_ARTISTS, params, i_album_id, &res ) != VLC_SUCCESS )
 977         return NULL;
 978     return res;
 979 }
 980
 981 static inline size_t vlc_ml_count_album_artists( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_album_id )
 982 {
 983     vlc_assert( p_ml != NULL );
 984     size_t count;
 985     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_ALBUM_ARTISTS, params, i_album_id, &count ) != VLC_SUCCESS )
 986         return 0;
 987     return count;
 988 }
 989
 990 static inline vlc_ml_album_list_t* vlc_ml_list_artist_albums( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_artist_id )
 991 {
 992     vlc_assert( p_ml != NULL );
 993     vlc_ml_album_list_t* res;
 994     if ( vlc_ml_list( p_ml, VLC_ML_LIST_ARTIST_ALBUMS, params, i_artist_id, &res ) != VLC_SUCCESS )
 995         return NULL;
 996     return res;
 997 }
 998
 999 static inline size_t vlc_ml_count_artist_albums( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_artist_id )
1000 {
1001     vlc_assert( p_ml != NULL );
1002     size_t count;
1003     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_ARTIST_ALBUMS, params, i_artist_id, &count ) != VLC_SUCCESS )
1004         return 0;
1005     return count;
1006 }
1007
1008 static inline vlc_ml_media_list_t* vlc_ml_list_artist_tracks( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_artist_id )
1009 {
1010     vlc_assert( p_ml != NULL );
1011     vlc_ml_media_list_t* res;
1012     if ( vlc_ml_list( p_ml, VLC_ML_LIST_ARTIST_TRACKS, params, i_artist_id, &res ) != VLC_SUCCESS )
1013         return NULL;
1014     return res;
1015 }
1016
1017 static inline size_t vlc_ml_count_artist_tracks( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_artist_id )
1018 {
1019     vlc_assert( p_ml != NULL );
1020     size_t count;
1021     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_ARTIST_TRACKS, params, i_artist_id, &count ) != VLC_SUCCESS )
1022         return 0;
1023     return count;
1024 }
1025
1026 static inline vlc_ml_media_list_t* vlc_ml_list_video_media( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params )
1027 {
1028     vlc_assert( p_ml != NULL );
1029     vlc_ml_media_list_t* res;
1030     if ( vlc_ml_list( p_ml, VLC_ML_LIST_VIDEOS, params, &res ) != VLC_SUCCESS )
1031         return NULL;
1032     return res;
1033 }
1034
1035 static inline size_t vlc_ml_count_video_media( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params )
1036 {
1037     vlc_assert( p_ml != NULL );
1038     size_t count;
1039     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_VIDEOS, params, &count ) != VLC_SUCCESS )
1040         return 0;
1041     return count;
1042 }
1043
1044 static inline vlc_ml_media_list_t* vlc_ml_list_audio_media( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params )
1045 {
1046     vlc_assert( p_ml != NULL );
1047     vlc_ml_media_list_t* res;
1048     if ( vlc_ml_list( p_ml, VLC_ML_LIST_AUDIOS, params, &res ) != VLC_SUCCESS )
1049         return NULL;
1050     return res;
1051 }
1052
1053 static inline size_t vlc_ml_count_audio_media( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params )
1054 {
1055     vlc_assert( p_ml != NULL );
1056     size_t count;
1057     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_AUDIOS, params, &count ) != VLC_SUCCESS )
1058         return 0;
1059     return count;
1060 }
1061
1062 static inline vlc_ml_album_list_t* vlc_ml_list_albums( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params )
1063 {
1064     vlc_assert( p_ml != NULL );
1065     vlc_ml_album_list_t* res;
1066     if ( vlc_ml_list( p_ml, VLC_ML_LIST_ALBUMS, params, &res ) != VLC_SUCCESS )
1067         return NULL;
1068     return res;
1069 }
1070
1071 static inline size_t vlc_ml_count_albums( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params )
1072 {
1073     vlc_assert( p_ml != NULL );
1074     size_t count;
1075     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_ALBUMS, params, &count ) != VLC_SUCCESS )
1076         return 0;
1077     return count;
1078 }
1079
1080 static inline vlc_ml_genre_list_t* vlc_ml_list_genres( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params )
1081 {
1082     vlc_assert( p_ml != NULL );
1083     vlc_ml_genre_list_t* res;
1084     if ( vlc_ml_list( p_ml, VLC_ML_LIST_GENRES, params, &res ) != VLC_SUCCESS )
1085         return NULL;
1086     return res;
1087 }
1088
1089 static inline size_t vlc_ml_count_genres( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params )
1090 {
1091     vlc_assert( p_ml != NULL );
1092     size_t count;
1093     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_GENRES, params, &count ) != VLC_SUCCESS )
1094         return 0;
1095     return count;
1096 }
1097
1098 /**
1099  * @brief vlc_ml_list_artists
1100  * @param params Query parameters, or NULL for the default
1101  * @param b_include_all True if you wish to fetch artists without at least one album.
1102  * @return
1103  */
1104 static inline vlc_ml_artist_list_t* vlc_ml_list_artists( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, bool b_include_all )
1105 {
1106     vlc_assert( p_ml != NULL );
1107     vlc_ml_artist_list_t* res;
1108     if ( vlc_ml_list( p_ml, VLC_ML_LIST_ARTISTS, params, (int)b_include_all, &res ) != VLC_SUCCESS )
1109         return NULL;
1110     return res;
1111 }
1112
1113 static inline size_t vlc_ml_count_artists( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, bool includeAll )
1114 {
1115     vlc_assert( p_ml != NULL );
1116     size_t count;
1117     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_ARTISTS, params, includeAll, &count ) != VLC_SUCCESS )
1118         return 0;
1119     return count;
1120 }
1121
1122 static inline vlc_ml_show_list_t* vlc_ml_list_shows( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params )
1123 {
1124     vlc_assert( p_ml != NULL );
1125     vlc_ml_show_list_t* res;
1126     if ( vlc_ml_list( p_ml, VLC_ML_LIST_SHOWS, params, &res ) != VLC_SUCCESS )
1127         return NULL;
1128     return res;
1129 }
1130
1131 static inline size_t vlc_ml_count_shows( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params )
1132 {
1133     vlc_assert( p_ml != NULL );
1134     size_t count;
1135     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_SHOWS, params, &count ) != VLC_SUCCESS )
1136         return 0;
1137     return count;
1138 }
1139
1140 static inline vlc_ml_media_list_t* vlc_ml_list_genre_artists( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_genre_id )
1141 {
1142     vlc_assert( p_ml != NULL );
1143     vlc_ml_media_list_t* res;
1144     if ( vlc_ml_list( p_ml, VLC_ML_LIST_GENRE_ARTISTS, params, i_genre_id, &res ) != VLC_SUCCESS )
1145         return NULL;
1146     return res;
1147 }
1148
1149 static inline size_t vlc_ml_count_genre_artists( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_genre_id )
1150 {
1151     vlc_assert( p_ml != NULL );
1152     size_t count;
1153     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_GENRE_ARTISTS, params, i_genre_id, &count ) != VLC_SUCCESS )
1154         return 0;
1155     return count;
1156 }
1157
1158 static inline vlc_ml_media_list_t* vlc_ml_list_genre_tracks( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_genre_id )
1159 {
1160     vlc_assert( p_ml != NULL );
1161     vlc_ml_media_list_t* res;
1162     if ( vlc_ml_list( p_ml, VLC_ML_LIST_GENRE_TRACKS, params, i_genre_id, &res ) != VLC_SUCCESS )
1163         return NULL;
1164     return res;
1165 }
1166
1167 static inline size_t vlc_ml_count_genre_tracks( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_genre_id )
1168 {
1169     vlc_assert( p_ml != NULL );
1170     size_t count;
1171     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_GENRE_TRACKS, params, i_genre_id, &count ) != VLC_SUCCESS )
1172         return 0;
1173     return count;
1174 }
1175
1176 static inline vlc_ml_album_list_t* vlc_ml_list_genre_albums( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_genre_id )
1177 {
1178     vlc_assert( p_ml != NULL );
1179     vlc_ml_album_list_t* res;
1180     if ( vlc_ml_list( p_ml, VLC_ML_LIST_GENRE_ALBUMS, params, i_genre_id, &res ) != VLC_SUCCESS )
1181         return NULL;
1182     return res;
1183 }
1184
1185 static inline size_t vlc_ml_count_genre_albums( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_genre_id )
1186 {
1187     vlc_assert( p_ml != NULL );
1188     size_t count;
1189     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_GENRE_ALBUMS, params, i_genre_id, &count ) != VLC_SUCCESS )
1190         return 0;
1191     return count;
1192 }
1193
1194 static inline vlc_ml_media_list_t* vlc_ml_list_show_episodes( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_show_id )
1195 {
1196     vlc_assert( p_ml != NULL );
1197     vlc_ml_media_list_t* res;
1198     if ( vlc_ml_list( p_ml, VLC_ML_LIST_SHOW_EPISODES, params, i_show_id, &res ) != VLC_SUCCESS )
1199         return NULL;
1200     return res;
1201 }
1202
1203 static inline size_t vlc_ml_count_show_episodes( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_show_id )
1204 {
1205     vlc_assert( p_ml != NULL );
1206     size_t count;
1207     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_GENRE_ALBUMS, params, i_show_id, &count ) != VLC_SUCCESS )
1208         return 0;
1209     return count;
1210 }
1211
1212 static inline vlc_ml_label_list_t* vlc_ml_list_media_labels( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_media_id )
1213 {
1214     vlc_assert( p_ml != NULL );
1215     vlc_ml_label_list_t* res;
1216     if ( vlc_ml_list( p_ml, VLC_ML_LIST_MEDIA_LABELS, params, i_media_id, &res ) != VLC_SUCCESS )
1217         return NULL;
1218     return res;
1219 }
1220
1221 static inline size_t vlc_ml_count_media_labels( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_media_id )
1222 {
1223     vlc_assert( p_ml != NULL );
1224     size_t count;
1225     if ( vlc_ml_list( p_ml, VLC_ML_LIST_MEDIA_LABELS, params, i_media_id, &count ) != VLC_SUCCESS )
1226         return 0;
1227     return count;
1228 }
1229
1230 static inline vlc_ml_media_list_t* vlc_ml_list_history( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params )
1231 {
1232     vlc_assert( p_ml != NULL );
1233     vlc_ml_media_list_t* res;
1234     if ( vlc_ml_list( p_ml, VLC_ML_LIST_HISTORY, params, &res ) != VLC_SUCCESS )
1235         return NULL;
1236     return res;
1237 }
1238
1239 static inline vlc_ml_media_list_t* vlc_ml_list_stream_history( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params )
1240 {
1241     vlc_assert( p_ml != NULL );
1242     vlc_ml_media_list_t* res;
1243     if ( vlc_ml_list( p_ml, VLC_ML_LIST_STREAM_HISTORY, params, &res ) != VLC_SUCCESS )
1244         return NULL;
1245     return res;
1246 }
1247
1248 static inline vlc_ml_playlist_list_t* vlc_ml_list_playlists( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params )
1249 {
1250     vlc_assert( p_ml != NULL );
1251     vlc_ml_playlist_list_t* res;
1252     if ( vlc_ml_list( p_ml, VLC_ML_LIST_PLAYLISTS, params, &res ) != VLC_SUCCESS )
1253         return NULL;
1254     return res;
1255 }
1256
1257 static inline size_t vlc_ml_count_playlists( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params )
1258 {
1259     vlc_assert( p_ml != NULL );
1260     size_t count;
1261     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_PLAYLISTS, params, &count ) != VLC_SUCCESS )
1262         return 0;
1263     return count;
1264 }
1265
1266 static inline vlc_ml_media_list_t* vlc_ml_list_playlist_media( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_playlist_id )
1267 {
1268     vlc_assert( p_ml != NULL );
1269     vlc_ml_media_list_t* res;
1270     if ( vlc_ml_list( p_ml, VLC_ML_LIST_PLAYLIST_MEDIA, params, i_playlist_id, &res ) != VLC_SUCCESS )
1271         return NULL;
1272     return res;
1273 }
1274
1275 static inline size_t vlc_ml_count_playlist_media( vlc_medialibrary_t* p_ml, const vlc_ml_query_params_t* params, int64_t i_playlist_id )
1276 {
1277     vlc_assert( p_ml != NULL );
1278     size_t count;
1279     if ( vlc_ml_list( p_ml, VLC_ML_COUNT_PLAYLIST_MEDIA, params, i_playlist_id, &count ) != VLC_SUCCESS )
1280         return 0;
1281     return count;
1282 }
1283
1284 #ifdef __cplusplus
1285 }
1286 #endif /* C++ */
1287
1288 #ifndef __cplusplus
1289 # define vlc_ml_release( OBJ ) _Generic( ( OBJ ), \
1290     vlc_ml_show_t*: vlc_ml_show_release, \
1291     vlc_ml_artist_t*: vlc_ml_artist_release, \
1292     vlc_ml_album_t*: vlc_ml_album_release, \
1293     vlc_ml_genre_t*: vlc_ml_genre_release, \
1294     vlc_ml_media_t*: vlc_ml_media_release, \
1295     vlc_ml_playlist_t*: vlc_ml_playlist_release, \
1296     vlc_ml_label_list_t*: vlc_ml_label_list_release, \
1297     vlc_ml_file_list_t*: vlc_ml_file_list_release, \
1298     vlc_ml_artist_list_t*: vlc_ml_artist_list_release, \
1299     vlc_ml_media_list_t*: vlc_ml_media_list_release, \
1300     vlc_ml_album_list_t*: vlc_ml_album_list_release, \
1301     vlc_ml_show_list_t*: vlc_ml_show_list_release, \
1302     vlc_ml_genre_list_t*: vlc_ml_genre_list_release, \
1303     vlc_ml_playlist_list_t*: vlc_ml_playlist_list_release, \
1304     vlc_ml_entry_point_list_t*: vlc_ml_entry_point_list_release \
1305     )( OBJ )
1306 #else
1307 static inline void vlc_ml_release( vlc_ml_show_t* show ) { vlc_ml_show_release( show ); }
1308 static inline void vlc_ml_release( vlc_ml_artist_t* artist ) { vlc_ml_artist_release( artist ); }
1309 static inline void vlc_ml_release( vlc_ml_album_t* album ) { vlc_ml_album_release( album ); }
1310 static inline void vlc_ml_release( vlc_ml_genre_t* genre ) { vlc_ml_genre_release( genre ); }
1311 static inline void vlc_ml_release( vlc_ml_media_t* media ) { vlc_ml_media_release( media ); }
1312 static inline void vlc_ml_release( vlc_ml_playlist_t* playlist ) { vlc_ml_playlist_release( playlist ); }
1313 static inline void vlc_ml_release( vlc_ml_label_list_t* list ) { vlc_ml_label_list_release( list ); }
1314 static inline void vlc_ml_release( vlc_ml_file_list_t* list ) { vlc_ml_file_list_release( list ); }
1315 static inline void vlc_ml_release( vlc_ml_artist_list_t* list ) { vlc_ml_artist_list_release( list ); }
1316 static inline void vlc_ml_release( vlc_ml_media_list_t* list ) { vlc_ml_media_list_release( list ); }
1317 static inline void vlc_ml_release( vlc_ml_album_list_t* list ) { vlc_ml_album_list_release( list ); }
1318 static inline void vlc_ml_release( vlc_ml_show_list_t* list ) { vlc_ml_show_list_release( list ); }
1319 static inline void vlc_ml_release( vlc_ml_genre_list_t* list ) { vlc_ml_genre_list_release( list ); }
1320 static inline void vlc_ml_release( vlc_ml_playlist_list_t* list ) { vlc_ml_playlist_list_release( list ); }
1321 static inline void vlc_ml_release( vlc_ml_entry_point_list_t* list ) { vlc_ml_entry_point_list_release( list ); }
1322 #endif
1323
1324 #endif /* VLC_MEDIA_LIBRARY_H */