[vlc-devel] [RFC PATCH 6/8] Add a new media library core API

Hugo Beauzée-Luyssen hugo at beauzee.fr
Mon Jun 25 10:10:04 CEST 2018


---
 include/vlc_media_library.h | 652 ++++++++++++++++++++++++++++++++++++
 src/Makefile.am             |   3 +-
 src/libvlccore.sym          |  15 +
 src/misc/medialibrary.c     | 214 ++++++++++++
 4 files changed, 883 insertions(+), 1 deletion(-)
 create mode 100644 src/misc/medialibrary.c

diff --git a/include/vlc_media_library.h b/include/vlc_media_library.h
index 5ef7c621e8..7e1842c7b0 100644
--- a/include/vlc_media_library.h
+++ b/include/vlc_media_library.h
@@ -28,10 +28,662 @@
 #ifndef VLC_MEDIA_LIBRARY_H
 # define VLC_MEDIA_LIBRARY_H
 
+//FIXME: Remove this, it's not needed but it keeps clang-model happy
+#include <vlc_common.h>
+
 # ifdef __cplusplus
 extern "C" {
 # endif
 
+typedef enum ml_media_type_t
+{
+    ML_MEDIA_TYPE_UNKNOWN,
+    ML_MEDIA_TYPE_VIDEO,
+    ML_MEDIA_TYPE_AUDIO,
+    ML_MEDIA_TYPE_EXTERNAL,
+} ml_media_type_t;
+
+typedef enum ml_media_subtype_t
+{
+    ML_MEDIA_SUBTYPE_UNKNOWN,
+    ML_MEDIA_SUBTYPE_SHOW_EPISODE,
+    ML_MEDIA_SUBTYPE_MOVIE,
+    ML_MEDIA_SUBTYPE_ALBUMTRACK,
+} ml_media_subtype_t;
+
+typedef enum ml_file_type_t
+{
+    ML_FILE_TYPE_UNKNOWN,
+    ML_FILE_TYPE_MAIN,
+    ML_FILE_TYPE_PART,
+    ML_FILE_TYPE_SOUNDTRACK,
+    ML_FILE_TYPE_SUBTITLE,
+    ML_FILE_TYPE_PLAYLIST,
+} ml_file_type_t;
+
+typedef struct ml_movie_t
+{
+    char* psz_summary;
+    char* psz_imdb_id;
+} ml_movie_t;
+
+typedef struct ml_show_episode_t
+{
+    char* psz_summary;
+    char* psz_tvdb_id;
+    uint32_t i_episode_nb;
+    uint32_t i_season_number;
+} ml_show_episode_t;
+
+typedef struct ml_show_t
+{
+    int64_t i_id;
+    char* psz_name;
+    char* psz_summary;
+    char* psz_artwork_mrl;
+    char* psz_tvdb_id;
+    unsigned int i_release_year;
+    uint32_t i_nb_episodes;
+    uint32_t i_nb_seasons;
+} ml_show_t;
+
+typedef struct ml_album_track_t
+{
+    int64_t i_artist_id;
+    int64_t i_album_id;
+    int64_t i_genre_id;
+
+    int i_track_nb;
+    int i_disc_nb;
+} ml_album_track_t;
+
+typedef struct ml_label_t
+{
+    int64_t i_id;
+    char* psz_name;
+} ml_label_t;
+
+typedef struct ml_label_list_t
+{
+    size_t i_nb_items;
+    ml_label_t* p_items;
+} ml_label_list_t;
+
+typedef struct ml_file_t
+{
+    char* psz_mrl;
+    ml_file_type_t i_type;
+    bool b_external;
+} ml_file_t;
+
+typedef struct ml_file_list_t
+{
+    size_t i_nb_items;
+    ml_file_t* p_items;
+} ml_file_list_t;
+
+typedef struct ml_media_t
+{
+    int64_t i_id;
+
+    ml_media_type_t i_type;
+    ml_media_subtype_t i_subtype;
+
+    ml_file_list_t* p_files;
+
+    int32_t i_year;
+    /* Duration in milliseconds */
+    int64_t i_duration;
+    uint32_t i_playcount;
+    char* psz_title;
+
+    char* psz_artwork_mrl;
+    bool b_is_favorite;
+
+    union
+    {
+        ml_show_episode_t show_episode;
+        ml_movie_t movie;
+        ml_album_track_t album_track;
+    };
+} ml_media_t;
+
+
+typedef struct ml_artist_t {
+    int64_t i_id;
+    char* psz_name;
+    char* psz_shortbio;
+    char* psz_artwork_mrl;
+    char* psz_mb_id;
+
+    unsigned int i_nb_album;
+    unsigned int i_nb_tracks;
+} ml_artist_t;
+
+typedef struct ml_artist_list_t
+{
+    size_t i_nb_items;
+    ml_artist_t* p_items;
+} ml_artist_list_t;
+
+typedef struct ml_album_t {
+    int64_t i_id;
+    char* psz_title;
+    char* psz_summary;
+    char* psz_artwork_mrl;
+    char* psz_artist;
+    int64_t i_artist_id;
+
+    ml_artist_list_t* p_featuring;
+
+    size_t i_nb_tracks;
+    unsigned int i_duration;
+    unsigned int i_year;
+} ml_album_t;
+
+typedef struct ml_genre_t
+{
+    int64_t i_id;
+    char* psz_name;
+    size_t i_nb_tracks;
+} ml_genre_t;
+
+typedef struct ml_media_list_t
+{
+    size_t i_nb_items;
+    ml_media_t* p_items;
+} ml_media_list_t;
+
+typedef struct ml_album_list_t
+{
+    size_t i_nb_items;
+    ml_album_t* p_items;
+} ml_album_list_t;
+
+typedef struct ml_show_list_t
+{
+    size_t i_nb_items;
+    ml_show_t* p_items;
+} ml_show_list_t;
+
+typedef struct ml_genre_list_t {
+    void (*pf_release)( struct ml_genre_list_t* );
+
+    size_t i_nb_items;
+    ml_genre_t* p_items;
+} ml_genre_list_t;
+
+
+typedef struct ml_entrypoint_t ml_entrypoint_t;
+struct ml_entrypoint_t
+{
+    char* psz_mrl; /**< This entrypoint's MRL. Will be NULL if b_present is false */
+    bool b_present; /**< The presence state for this entrypoint. */
+    bool b_banned; /**< Will be true if the user required this entrypoint to be excluded */
+};
+
+typedef struct vlc_medialibrary_t vlc_medialibrary_t;
+
+VLC_API vlc_medialibrary_t* vlc_ml_create( vlc_object_t* p_obj );
+#define vlc_ml_create(x) vlc_ml_create( VLC_OBJECT( x ) )
+VLC_API void vlc_ml_release( vlc_medialibrary_t* p_ml );
+VLC_API void vlc_ml_entrypoints_release( ml_entrypoint_t* p_list, size_t i_nb_items );
+
+VLC_API void vlc_ml_show_release( ml_show_t* p_show );
+VLC_API void vlc_ml_artist_release( ml_artist_t* p_artist );
+VLC_API void vlc_ml_genre_release( ml_genre_t* p_genre );
+VLC_API void vlc_ml_media_release( ml_media_t* p_media );
+VLC_API void vlc_ml_album_release( ml_album_t* p_album );
+
+VLC_API void vlc_ml_label_list_release( ml_label_list_t* p_list );
+VLC_API void vlc_ml_file_list_release( ml_file_list_t* p_list );
+VLC_API void vlc_ml_artist_list_release( ml_artist_list_t* p_list );
+VLC_API void vlc_ml_media_list_release( ml_media_list_t* p_list );
+VLC_API void vlc_ml_album_list_release( ml_album_list_t* p_list );
+VLC_API void vlc_ml_show_list_release( ml_show_list_t* p_list );
+VLC_API void vlc_ml_genre_list_release( ml_genre_list_t* p_list );
+
+typedef enum ml_sorting_criteria_t
+{
+    /*
+     * Default depends on the entity type:
+     * - By track number (and disc number) for album tracks
+     * - Alphabetical order for others
+     */
+    ML_SORTING_DEFAULT,
+    ML_SORTING_ALPHA,
+    ML_SORTING_DURATION,
+    ML_SORTING_INSERTIONDATE,
+    ML_SORTING_LASTMODIFICATIONDATE,
+    ML_SORTING_RELEASEDATE,
+    ML_SORTING_FILESIZE,
+    ML_SORTING_ARTIST,
+    ML_SORTING_PLAYCOUNT,
+    ML_SORTING_ALBUM,
+    ML_SORTING_FILENAME,
+    ML_SORTING_TRACKNUMBER,
+} ml_sorting_criteria_t;
+
+typedef struct ml_query_params_t ml_query_params_t;
+struct ml_query_params_t
+{
+    const char* psz_pattern;
+    ml_sorting_criteria_t i_sort;
+    uint32_t i_nbResults;
+    uint32_t i_offset;
+    bool b_desc;
+};
+
+struct vlc_medialibrary_t
+{
+    struct vlc_common_members obj;
+
+    module_t *p_module;
+
+    void* p_sys;
+
+    int (*pf_control)( vlc_medialibrary_t* p_ml, int i_query, ... );
+    /**
+     * List some entities from the medialibrary.
+     *
+     * \param p_ml The medialibrary module instance.
+     * \param i_query The type search to be performed. \see ml_list enumeration
+     * \param p_params A pointer to a ml_query_params_t structure, or NULL for
+     * the default parameters (alphabetical ascending sort, no pagination)
+     *
+     * \return VLC_SUCCESS or an error code
+     *
+     * Refer to the individual list of ml_list requests for the additional
+     * per-query input/ouput parameters values & types
+     */
+    int (*pf_list)( vlc_medialibrary_t* p_ml, int i_query,
+                    const ml_query_params_t* p_params, ... );
+
+    /**
+     * Get a specific entity by its id.
+     *
+     * \return The required entity, or a NULL pointer if couldn't be found.
+     *
+     * Refer to the list of queries for the specific return type
+     */
+    void* (*pf_get)( vlc_medialibrary_t* p_ml, int i_query, int64_t i_id );
+};
+
+enum ml_control
+{
+    /* Adds a folder to discover through the medialibrary */
+    ML_ADD_FOLDER,              /**< arg1: mrl (const char*)  res: can't fail */
+    ML_REMOVE_FOLDER,           /**< arg1: mrl (const char*)  res: can't fail */
+    ML_BAN_FOLDER,              /**< arg1: mrl (const char*)  res: can't fail */
+    ML_UNBAN_FOLDER,            /**< arg1: mrl (const char*)  res: can't fail */
+    ML_LIST_FOLDERS,            /**< arg1: entrypoints (ml_entrypoint_t**); arg2: nb results(size_t*), res: can fail */
+
+    /* Pause/resume background operations, such as media discovery & media analysis */
+    ML_PAUSE_BACKGROUND,        /**< no args; can't fail */
+    ML_RESUME_BACKGROUND,       /**< no args; can't fail */
+
+    /* Misc operations */
+    ML_CLEAR_HISTORY,           /**< no args; can't fail */
+
+    /* Media management */
+    ML_MEDIA_INCREASE_PLAY_COUNT,       /**< arg1: media id; can fail */
+    ML_MEDIA_GET_MEDIA_PLAYBACK_PREF,   /**< arg1: media id; arg2 ml_playback_pref; arg3: char**; */
+    ML_MEDIA_SET_MEDIA_PLAYBACK_PREF,   /**< arg1: media id; arg2 ml_playback_pref; arg3: const char*; */
+};
+
+/**
+ * User playback settings.
+ * All values/units are up to the caller and are not interpreted by the media
+ * library.
+ * All values are stored and returned as strings.
+ * When calling vlc_medialibrary_t::pf_control with ML_MEDIA_GET_MEDIA_PLAYBACK_PREF,
+ * the value will be returned stored in the provided char**. If the preference was
+ * not set yet, NULL will be returned.
+ * When setting a preference, NULL can be provided as a value to unset it.
+ */
+enum ml_playback_pref
+{
+    ML_PLAYBACK_PREF_RATING,
+    ML_PLAYBACK_PREF_PROGRESS,
+    ML_PLAYBACK_PREF_SPEED,
+    ML_PLAYBACK_PREF_TITLE,
+    ML_PLAYBACK_PREF_CHAPTER,
+    ML_PLAYBACK_PREF_PROGRAM,
+    ML_PLAYBACK_PREF_SEEN,
+    ML_PLAYBACK_PREF_VIDEO_TRACK,
+    ML_PLAYBACK_PREF_ASPECT_RATIO,
+    ML_PLAYBACK_PREF_ZOOM,
+    ML_PLAYBACK_PREF_CROP,
+    ML_PLAYBACK_PREF_DEINTERLACE,
+    ML_PLAYBACK_PREF_VIDEO_FILTER,
+    ML_PLAYBACK_PREF_AUDIO_TRACK,
+    ML_PLAYBACK_PREF_GAIN,
+    ML_PLAYBACK_PREF_AUDIO_DELAY,
+    ML_PLAYBACK_PREF_SUBTITLE_TRACK,
+    ML_PLAYBACK_PREF_SUBTITLE_DELAY,
+    ML_PLAYBACK_PREF_APP_SPECIFIC,
+};
+
+static inline void vlc_ml_add_folder( vlc_medialibrary_t* p_ml, const char* psz_folder )
+{
+    p_ml->pf_control( p_ml, ML_ADD_FOLDER, psz_folder );
+}
+
+static inline void vlc_ml_remove_folder( vlc_medialibrary_t* p_ml, const char* psz_folder )
+{
+    p_ml->pf_control( p_ml, ML_REMOVE_FOLDER, psz_folder );
+}
+
+static inline void vlc_ml_ban_folder( vlc_medialibrary_t* p_ml, const char* psz_folder )
+{
+    p_ml->pf_control( p_ml, ML_BAN_FOLDER, psz_folder );
+}
+
+static inline void vlc_ml_unban_folder( vlc_medialibrary_t* p_ml, const char* psz_folder )
+{
+    p_ml->pf_control( p_ml, ML_UNBAN_FOLDER, psz_folder );
+}
+
+static inline int vlc_ml_list_folder( vlc_medialibrary_t* p_ml,
+                                      ml_entrypoint_t** pp_entrypoints, size_t* p_nb_items )
+{
+    return p_ml->pf_control( p_ml, ML_LIST_FOLDERS, pp_entrypoints, p_nb_items );
+}
+
+static inline void vlc_ml_pause_background( vlc_medialibrary_t* p_ml )
+{
+    p_ml->pf_control( p_ml, ML_PAUSE_BACKGROUND );
+}
+
+static inline void vlc_ml_resume_background( vlc_medialibrary_t* p_ml )
+{
+    p_ml->pf_control( p_ml, ML_RESUME_BACKGROUND );
+}
+
+static inline void vlc_ml_clear_history( vlc_medialibrary_t* p_ml )
+{
+    p_ml->pf_control( p_ml, ML_CLEAR_HISTORY );
+}
+
+static inline int vlc_ml_increase_playcount( vlc_medialibrary_t* p_ml, int64_t i_media_id )
+{
+    return p_ml->pf_control( p_ml, ML_MEDIA_INCREASE_PLAY_COUNT, i_media_id );
+}
+
+static inline int vlc_ml_get_playback_pref( vlc_medialibrary_t* p_ml, int64_t i_media_id, int i_pref, char** ppsz_result )
+{
+    return p_ml->pf_control( p_ml, ML_MEDIA_GET_MEDIA_PLAYBACK_PREF, i_media_id, i_pref, ppsz_result );
+}
+
+static inline int vlc_ml_set_playback_pref( vlc_medialibrary_t* p_ml, int64_t i_media_id, int i_pref, const char* psz_value )
+{
+    return p_ml->pf_control( p_ml, ML_MEDIA_SET_MEDIA_PLAYBACK_PREF, i_media_id, i_pref, psz_value );
+}
+
+enum ml_get_queries
+{
+    ML_GET_MEDIA,           /**< arg1: Media  ID; ret: ml_media_t*  */
+    ML_GET_ALBUM,           /**< arg1: Album  ID; ret: ml_album_t*  */
+    ML_GET_ARTIST,          /**< arg1: Artist ID; ret: ml_artist_t* */
+    ML_GET_GENRE,           /**< arg1: Genre  ID; ret: ml_genre_t*  */
+    ML_GET_SHOW,            /**< arg1: Show   ID; ret: ml_show_t*   */
+};
+
+static inline ml_media_t* ml_get_media( vlc_medialibrary_t* p_ml, int64_t i_media_id )
+{
+    return (ml_media_t*)p_ml->pf_get( p_ml, ML_GET_MEDIA, i_media_id );
+}
+
+static inline ml_album_t* ml_get_album( vlc_medialibrary_t* p_ml, int64_t i_album_id )
+{
+    return (ml_album_t*)p_ml->pf_get( p_ml, ML_GET_ALBUM, i_album_id );
+}
+
+static inline ml_artist_t* ml_get_artist( vlc_medialibrary_t* p_ml, int64_t i_artist_id )
+{
+    return (ml_artist_t*)p_ml->pf_get( p_ml, ML_GET_ARTIST, i_artist_id );
+}
+
+static inline ml_genre_t* ml_get_genre( vlc_medialibrary_t* p_ml, int64_t i_genre_id )
+{
+    return (ml_genre_t*)p_ml->pf_get( p_ml, ML_GET_GENRE, i_genre_id );
+}
+
+static inline ml_show_t* ml_get_show( vlc_medialibrary_t* p_ml, int64_t i_show_id )
+{
+    return (ml_show_t*)p_ml->pf_get( p_ml, ML_GET_SHOW, i_show_id );
+}
+
+enum ml_list_queries
+{
+    /* General listing: */
+
+    ML_LIST_VIDEOS,           /**< arg1 (out): ml_media_list_t**    */
+    ML_COUNT_VIDEOS,          /**< arg1 (out): size_t*              */
+    ML_LIST_AUDIOS,           /**< arg1 (out): ml_media_list_t**    */
+    ML_COUNT_AUDIOS,          /**< arg1 (out): size_t*              */
+    ML_LIST_ALBUMS,           /**< arg1 (out): ml_album_list_t**    */
+    ML_COUNT_ALBUMS,          /**< arg1 (out): size_t*              */
+    ML_LIST_GENRES,           /**< arg1 (out): ml_genre_list_t**    */
+    ML_COUNT_GENRES,          /**< arg1 (out): size_t*              */
+    ML_LIST_ARTISTS,          /**< arg1 (out): ml_genre_list_t**    */
+    ML_COUNT_ARTISTS,         /**< arg1 (out): size_t*              */
+
+    /* Album specific listings */
+    ML_LIST_ALBUM_TRACKS,     /**< arg1: The album id. arg2 (out): ml_media_list_t**  */
+    ML_COUNT_ALBUM_TRACKS,    /**< arg1: The album id. arg2 (out): size_t**  */
+
+    /* Artist specific listings */
+    ML_LIST_ARTIST_ALBUMS,  /**< arg1: The artist id. arg2(out): ml_album_list_t**    */
+    ML_COUNT_ARTIST_ALBUMS, /**< arg1: The artist id. arg2(out): size_t*              */
+    ML_LIST_ARTIST_TRACKS,  /**< arg1: The artist id. arg2(out): ml_media_list_t**    */
+    ML_COUNT_ARTIST_TRACKS, /**< arg1: The artist id. arg2(out): size_t*              */
+
+    /* Genre specific listings */
+    ML_LIST_GENRE_ARTISTS,    /**< arg1: genre id;  arg2 (out): ml_artist_list_t**  */
+    ML_COUNT_GENRE_ARTISTS,   /**< arg1: genre id;  arg2 (out): size_t*             */
+    ML_LIST_GENRE_TRACKS,     /**< arg1: genre id;  arg2 (out): ml_media_list_t**   */
+    ML_COUNT_GENRE_TRACKS,    /**< arg1: genre id;  arg2 (out): size_t*             */
+    ML_LIST_GENRE_ALBUMS,     /**< arg1: genre id;  arg2 (out): ml_album_list_t**   */
+    ML_COUNT_GENRE_ALBUMS,    /**< arg1: genre id;  arg2 (out): size_t*             */
+
+    /* Media specific listings */
+    ML_LIST_MEDIA_LABELS,     /**< arg1: media id;  arg2 (out) ml_label_list_t**    */
+    ML_COUNT_MEDIA_LABELS,    /**< arg1: media id;  arg2 (out) size_t*              */
+};
+
+static inline ml_media_list_t* ml_list_album_tracks( vlc_medialibrary_t* p_ml, ml_query_params_t* params, int64_t i_album_id )
+{
+    ml_media_list_t* res;
+    if ( p_ml->pf_list( p_ml, ML_LIST_ALBUM_TRACKS, params, i_album_id, &res ) != VLC_SUCCESS )
+        return NULL;
+    return res;
+}
+
+static inline size_t ml_count_album_tracks( vlc_medialibrary_t* p_ml, ml_query_params_t* params, int64_t i_album_id )
+{
+    size_t count;
+    if ( p_ml->pf_list( p_ml, ML_COUNT_ALBUM_TRACKS, params, i_album_id, &count ) != VLC_SUCCESS )
+        return 0;
+    return count;
+}
+
+static inline ml_album_list_t* ml_list_artist_albums( vlc_medialibrary_t* p_ml, ml_query_params_t* params, int64_t i_artist_id )
+{
+    ml_album_list_t* res;
+    if ( p_ml->pf_list( p_ml, ML_LIST_ARTIST_ALBUMS, params, i_artist_id, &res ) != VLC_SUCCESS )
+        return NULL;
+    return res;
+}
+
+static inline size_t ml_count_artist_albums( vlc_medialibrary_t* p_ml, ml_query_params_t* params, int64_t i_artist_id )
+{
+    size_t count;
+    if ( p_ml->pf_list( p_ml, ML_COUNT_ARTIST_ALBUMS, params, i_artist_id, &count ) != VLC_SUCCESS )
+        return 0;
+    return count;
+}
+
+static inline ml_media_list_t* ml_list_artist_tracks( vlc_medialibrary_t* p_ml, ml_query_params_t* params, int64_t i_artist_id )
+{
+    ml_media_list_t* res;
+    if ( p_ml->pf_list( p_ml, ML_LIST_ARTIST_TRACKS, params, i_artist_id, &res ) != VLC_SUCCESS )
+        return NULL;
+    return res;
+}
+
+static inline size_t ml_count_artist_tracks( vlc_medialibrary_t* p_ml, ml_query_params_t* params, int64_t i_artist_id )
+{
+    size_t count;
+    if ( p_ml->pf_list( p_ml, ML_COUNT_ARTIST_TRACKS, params, i_artist_id, &count ) != VLC_SUCCESS )
+        return 0;
+    return count;
+}
+
+static inline ml_media_list_t* ml_list_video_media( vlc_medialibrary_t* p_ml, ml_query_params_t* params )
+{
+    ml_media_list_t* res;
+    if ( p_ml->pf_list( p_ml, ML_LIST_VIDEOS, params, &res ) != VLC_SUCCESS )
+        return NULL;
+    return res;
+}
+
+static inline size_t ml_count_video_media( vlc_medialibrary_t* p_ml, ml_query_params_t* params )
+{
+    size_t count;
+    if ( p_ml->pf_list( p_ml, ML_COUNT_VIDEOS, params, &count ) != VLC_SUCCESS )
+        return 0;
+    return count;
+}
+
+static inline ml_media_list_t* ml_list_audio_media( vlc_medialibrary_t* p_ml, ml_query_params_t* params )
+{
+    ml_media_list_t* res;
+    if ( p_ml->pf_list( p_ml, ML_LIST_AUDIOS, params, &res ) != VLC_SUCCESS )
+        return NULL;
+    return res;
+}
+
+static inline size_t ml_count_audio_media( vlc_medialibrary_t* p_ml, ml_query_params_t* params )
+{
+    size_t count;
+    if ( p_ml->pf_list( p_ml, ML_COUNT_AUDIOS, params, &count ) != VLC_SUCCESS )
+        return 0;
+    return count;
+}
+
+static inline ml_album_list_t* ml_list_albums( vlc_medialibrary_t* p_ml, ml_query_params_t* params )
+{
+    ml_album_list_t* res;
+    if ( p_ml->pf_list( p_ml, ML_LIST_ALBUMS, params, &res ) != VLC_SUCCESS )
+        return NULL;
+    return res;
+}
+
+static inline size_t ml_count_albums( vlc_medialibrary_t* p_ml, ml_query_params_t* params )
+{
+    size_t count;
+    if ( p_ml->pf_list( p_ml, ML_COUNT_ALBUMS, params, &count ) != VLC_SUCCESS )
+        return 0;
+    return count;
+}
+
+static inline ml_genre_list_t* ml_list_genres( vlc_medialibrary_t* p_ml, ml_query_params_t* params )
+{
+    ml_genre_list_t* res;
+    if ( p_ml->pf_list( p_ml, ML_LIST_GENRES, params, &res ) != VLC_SUCCESS )
+        return NULL;
+    return res;
+}
+
+static inline size_t ml_count_genres( vlc_medialibrary_t* p_ml, ml_query_params_t* params )
+{
+    size_t count;
+    if ( p_ml->pf_list( p_ml, ML_COUNT_GENRES, params, &count ) != VLC_SUCCESS )
+        return 0;
+    return count;
+}
+
+static inline ml_artist_list_t* ml_list_artists( vlc_medialibrary_t* p_ml, ml_query_params_t* params )
+{
+    ml_artist_list_t* res;
+    if ( p_ml->pf_list( p_ml, ML_LIST_ARTISTS, params, &res ) != VLC_SUCCESS )
+        return NULL;
+    return res;
+}
+
+static inline size_t ml_count_artists( vlc_medialibrary_t* p_ml, ml_query_params_t* params )
+{
+    size_t count;
+    if ( p_ml->pf_list( p_ml, ML_COUNT_ARTISTS, params, &count ) != VLC_SUCCESS )
+        return 0;
+    return count;
+}
+
+static inline ml_media_list_t* ml_list_genre_artists( vlc_medialibrary_t* p_ml, ml_query_params_t* params, int64_t i_genre_id )
+{
+    ml_media_list_t* res;
+    if ( p_ml->pf_list( p_ml, ML_LIST_GENRE_ARTISTS, params, i_genre_id, &res ) != VLC_SUCCESS )
+        return NULL;
+    return res;
+}
+
+static inline size_t ml_count_genre_artists( vlc_medialibrary_t* p_ml, ml_query_params_t* params, int64_t i_genre_id )
+{
+    size_t count;
+    if ( p_ml->pf_list( p_ml, ML_COUNT_GENRE_ARTISTS, params, i_genre_id, &count ) != VLC_SUCCESS )
+        return 0;
+    return count;
+}
+
+static inline ml_media_list_t* ml_list_genre_tracks( vlc_medialibrary_t* p_ml, ml_query_params_t* params, int64_t i_genre_id )
+{
+    ml_media_list_t* res;
+    if ( p_ml->pf_list( p_ml, ML_LIST_GENRE_TRACKS, params, i_genre_id, &res ) != VLC_SUCCESS )
+        return NULL;
+    return res;
+}
+
+static inline size_t ml_count_genre_tracks( vlc_medialibrary_t* p_ml, ml_query_params_t* params, int64_t i_genre_id )
+{
+    size_t count;
+    if ( p_ml->pf_list( p_ml, ML_COUNT_GENRE_TRACKS, params, i_genre_id, &count ) != VLC_SUCCESS )
+        return 0;
+    return count;
+}
+
+static inline ml_album_list_t* ml_list_genre_albums( vlc_medialibrary_t* p_ml, ml_query_params_t* params, int64_t i_genre_id )
+{
+    ml_album_list_t* res;
+    if ( p_ml->pf_list( p_ml, ML_LIST_GENRE_ALBUMS, params, i_genre_id, &res ) != VLC_SUCCESS )
+        return NULL;
+    return res;
+}
+
+static inline size_t ml_count_genre_albums( vlc_medialibrary_t* p_ml, ml_query_params_t* params, int64_t i_genre_id )
+{
+    size_t count;
+    if ( p_ml->pf_list( p_ml, ML_COUNT_GENRE_ALBUMS, params, i_genre_id, &count ) != VLC_SUCCESS )
+        return 0;
+    return count;
+}
+
+static inline ml_label_list_t* ml_list_media_labels( vlc_medialibrary_t* p_ml, ml_query_params_t* params, int64_t i_media_id )
+{
+    ml_label_list_t* res;
+    if ( p_ml->pf_list( p_ml, ML_LIST_MEDIA_LABELS, params, i_media_id, &res ) != VLC_SUCCESS )
+        return NULL;
+    return res;
+}
+
+static inline size_t ml_count_media_labels( vlc_medialibrary_t* p_ml, ml_query_params_t* params, int64_t i_media_id )
+{
+    size_t count;
+    if ( p_ml->pf_list( p_ml, ML_LIST_MEDIA_LABELS, params, i_media_id, &count ) != VLC_SUCCESS )
+        return 0;
+    return count;
+}
+
 #ifdef __cplusplus
 }
 #endif /* C++ */
diff --git a/src/Makefile.am b/src/Makefile.am
index 897c557e55..50c434424c 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -356,7 +356,8 @@ libvlccore_la_SOURCES = \
 	misc/fingerprinter.c \
 	misc/text_style.c \
 	misc/subpicture.c \
-	misc/subpicture.h
+	misc/subpicture.h \
+	misc/medialibrary.c
 libvlccore_la_LIBADD = $(LIBS_libvlccore) \
 	../compat/libcompat.la \
 	$(LTLIBINTL) $(LTLIBICONV) \
diff --git a/src/libvlccore.sym b/src/libvlccore.sym
index 3959225233..01cdd77bb5 100644
--- a/src/libvlccore.sym
+++ b/src/libvlccore.sym
@@ -587,6 +587,21 @@ vlc_keystore_find
 vlc_keystore_remove
 vlc_keystore_store
 vlc_keystore_release_entries
+vlc_ml_create
+vlc_ml_release
+vlc_ml_entrypoints_release
+vlc_ml_show_release
+vlc_ml_artist_release
+vlc_ml_genre_release
+vlc_ml_media_release
+vlc_ml_album_release
+vlc_ml_label_list_release
+vlc_ml_file_list_release
+vlc_ml_artist_list_release
+vlc_ml_media_list_release
+vlc_ml_album_list_release
+vlc_ml_show_list_release
+vlc_ml_genre_list_release
 vlc_poll_i11e
 vlc_read_i11e
 vlc_readv_i11e
diff --git a/src/misc/medialibrary.c b/src/misc/medialibrary.c
new file mode 100644
index 0000000000..2e0c7b98aa
--- /dev/null
+++ b/src/misc/medialibrary.c
@@ -0,0 +1,214 @@
+/*****************************************************************************
+ * medialib.cpp: medialibrary module
+ *****************************************************************************
+ * Copyright © 2015-2016 VLC authors, VideoLAN and VideoLabs
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ *****************************************************************************/
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_media_library.h>
+#include <vlc_modules.h>
+#include <libvlc.h>
+
+#include <assert.h>
+
+void vlc_ml_entrypoints_release( ml_entrypoint_t* p_list, size_t i_nb_items )
+{
+    for ( size_t i = 0; i < i_nb_items; ++i )
+    {
+        free( p_list[i].psz_mrl );
+    }
+    free( p_list );
+}
+
+#undef vlc_ml_create
+vlc_medialibrary_t* vlc_ml_create( vlc_object_t* p_obj )
+{
+    vlc_medialibrary_t *p_ml = vlc_custom_create( p_obj, sizeof( *p_ml ), "medialibrary" );
+    if ( unlikely( p_ml == NULL ) )
+        return NULL;
+    p_ml->p_module = module_need( p_ml, "medialibrary", NULL, false );
+    if ( p_ml->p_module == NULL )
+    {
+        vlc_object_release( p_ml );
+        return NULL;
+    }
+    return p_ml;
+}
+
+void vlc_ml_release( vlc_medialibrary_t* p_ml )
+{
+    assert( p_ml != NULL );
+    module_unneed( p_ml, p_ml->p_module );
+    vlc_object_release( p_ml );
+}
+
+static void vlc_ml_show_release_inner( ml_show_t* p_show )
+{
+    free( p_show->psz_artwork_mrl );
+    free( p_show->psz_name );
+    free( p_show->psz_summary );
+    free( p_show->psz_tvdb_id );
+}
+
+void vlc_ml_show_release( ml_show_t* p_show )
+{
+    if ( p_show == NULL )
+        return;
+    vlc_ml_show_release_inner( p_show );
+    free( p_show );
+}
+
+static void vlc_ml_media_release_inner( ml_media_t* p_media )
+{
+    vlc_ml_file_list_release( p_media->p_files );
+    free( p_media->psz_title );
+    free( p_media->psz_artwork_mrl );
+    switch( p_media->i_subtype )
+    {
+        case ML_MEDIA_SUBTYPE_ALBUMTRACK:
+            break;
+        case ML_MEDIA_SUBTYPE_SHOW_EPISODE:
+            free( p_media->show_episode.psz_summary );
+            free( p_media->show_episode.psz_tvdb_id );
+            break;
+        case ML_MEDIA_SUBTYPE_MOVIE:
+            free( p_media->movie.psz_summary );
+            free( p_media->movie.psz_imdb_id );
+            break;
+        default:
+            vlc_assert_unreachable();
+    }
+}
+
+static void vlc_ml_artist_release_inner( ml_artist_t* p_artist )
+{
+    free( p_artist->psz_artwork_mrl );
+    free( p_artist->psz_name );
+    free( p_artist->psz_shortbio );
+    free( p_artist->psz_mb_id );
+}
+
+void vlc_ml_artist_release( ml_artist_t* p_artist )
+{
+    if ( p_artist == NULL )
+        return;
+    vlc_ml_artist_release_inner( p_artist );
+    free( p_artist );
+}
+
+static void vlc_ml_album_release_inner( ml_album_t* p_album )
+{
+    free( p_album->psz_artist );
+    free( p_album->psz_artwork_mrl );
+    free( p_album->psz_summary );
+    free( p_album->psz_title );
+    vlc_ml_artist_list_release( p_album->p_featuring );
+}
+
+void vlc_ml_album_release( ml_album_t* p_album )
+{
+    if ( p_album == NULL )
+        return;
+    vlc_ml_album_release_inner( p_album );
+    free( p_album );
+}
+
+void vlc_ml_genre_release( ml_genre_t* p_genre )
+{
+    if ( p_genre == NULL )
+        return;
+    free( p_genre->psz_name );
+    free( p_genre );
+}
+
+/* Lists release */
+
+void vlc_ml_media_release( ml_media_t* p_media )
+{
+    if ( p_media == NULL )
+        return;
+    vlc_ml_media_release_inner( p_media );
+    free( p_media );
+}
+
+void vlc_ml_label_list_release( ml_label_list_t* p_list )
+{
+    if ( p_list == NULL )
+        return;
+    for ( size_t i = 0; i < p_list->i_nb_items; ++i )
+        free( p_list->p_items[i].psz_name );
+    free( p_list );
+}
+
+void vlc_ml_file_list_release( ml_file_list_t* p_list )
+{
+    if ( p_list == NULL )
+        return;
+    for ( size_t i = 0; i < p_list->i_nb_items; ++i )
+        free( p_list->p_items[i].psz_mrl );
+    free( p_list );
+}
+
+void vlc_ml_artist_list_release( ml_artist_list_t* p_list )
+{
+    if ( p_list == NULL )
+        return;
+    for ( size_t i = 0; i < p_list->i_nb_items; ++i )
+        vlc_ml_artist_release_inner( &p_list->p_items[i] );
+    free( p_list );
+}
+
+
+void vlc_ml_media_list_release( ml_media_list_t* p_list )
+{
+    if ( p_list == NULL )
+        return;
+    for ( size_t i = 0; i < p_list->i_nb_items; ++i )
+        vlc_ml_media_release_inner( &p_list->p_items[i] );
+    free( p_list );
+}
+
+void vlc_ml_album_list_release( ml_album_list_t* p_list )
+{
+    if ( p_list == NULL )
+        return;
+    for ( size_t i = 0; i < p_list->i_nb_items; ++i )
+        vlc_ml_album_release_inner( &p_list->p_items[i] );
+    free( p_list );
+}
+
+void vlc_ml_show_list_release( ml_show_list_t* p_list )
+{
+    if ( p_list == NULL )
+        return;
+    for ( size_t i = 0; i < p_list->i_nb_items; ++i )
+        vlc_ml_show_release_inner( &p_list->p_items[i] );
+    free( p_list );
+}
+
+void vlc_ml_genre_list_release( ml_genre_list_t* p_list )
+{
+    if ( p_list == NULL )
+        return;
+    for ( size_t i = 0; i < p_list->i_nb_items; ++i )
+        free( p_list->p_items[i].psz_name );
+    free( p_list );
+}
-- 
2.18.0



More information about the vlc-devel mailing list