autoplaylist.h

Go to the documentation of this file.

/*
    Autoplaylist APIs
    These APIs were introduced in foobar2000 0.9.5, to reduce amount of code required to create your own autoplaylists. Creation of autoplaylists is was also possible before through playlist lock APIs.
    In most cases, you'll want to turn regular playlists into autoplaylists using the following code:
    static_api_ptr_t<autoplaylist_manager>()->add_client_simple(querypattern, sortpattern, playlistindex, forceSort ? autoplaylist_flag_sort : 0);
    If you require more advanced functionality, such as using your own code to filter which part of user's Media Library should be placed in specific autoplaylist, you must implement autoplaylist_client (to let autoplaylist manager invoke your handlers when needed) / autoplaylist_client_factory (to re-instantiate your autoplaylist_client after a foobar2000 restart cycle).
*/

enum {
    autoplaylist_flag_sort  = 1 << 0,
};
class NOVTABLE autoplaylist_client : public service_base {
    FB2K_MAKE_SERVICE_INTERFACE(autoplaylist_client,service_base)
public:
    virtual GUID get_guid() = 0;
    virtual void filter(metadb_handle_list_cref data, bool * out) = 0;
    virtual bool sort(metadb_handle_list_cref p_items,t_size * p_orderbuffer) = 0;
    virtual void get_configuration(stream_writer * p_stream,abort_callback & p_abort) = 0;

    virtual void show_ui(t_size p_source_playlist) = 0;

    template<typename t_array> void get_configuration(t_array & p_out) {
        PFC_STATIC_ASSERT( sizeof(p_out[0]) == 1 );
        typedef pfc::array_t<t_uint8,pfc::alloc_fast_aggressive> t_temp; t_temp temp;
        get_configuration(&stream_writer_buffer_append_ref_t<t_temp>(temp),abort_callback_dummy());
        p_out = temp;
    }
};

typedef service_ptr_t<autoplaylist_client> autoplaylist_client_ptr;

class NOVTABLE autoplaylist_client_v2 : public autoplaylist_client {
    FB2K_MAKE_SERVICE_INTERFACE(autoplaylist_client_v2, autoplaylist_client);
public:
    virtual void set_full_refresh_notify(completion_notify::ptr notify) = 0;

    virtual bool show_ui_available() = 0;

    virtual void get_display_name(pfc::string_base & out) = 0;
};

class NOVTABLE autoplaylist_client_factory : public service_base {
    FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT(autoplaylist_client_factory)
public:
    virtual GUID get_guid() = 0;
    virtual autoplaylist_client_ptr instantiate(stream_reader * p_stream,t_size p_sizehint,abort_callback & p_abort) = 0;
};

PFC_DECLARE_EXCEPTION(exception_autoplaylist,pfc::exception,"Autoplaylist error")

PFC_DECLARE_EXCEPTION(exception_autoplaylist_already_owned,exception_autoplaylist,"This playlist is already an autoplaylist")
PFC_DECLARE_EXCEPTION(exception_autoplaylist_not_owned,exception_autoplaylist,"This playlist is not an autoplaylist")
PFC_DECLARE_EXCEPTION(exception_autoplaylist_lock_failure,exception_autoplaylist,"Playlist could not be locked")


class NOVTABLE autoplaylist_manager : public service_base {
public:
    virtual void add_client(autoplaylist_client_ptr p_client,t_size p_playlist,t_uint32 p_flags) = 0;
    virtual bool is_client_present(t_size p_playlist) = 0;
    virtual autoplaylist_client_ptr query_client(t_size p_playlist) = 0;
    virtual void remove_client(t_size p_playlist) = 0;
    virtual void add_client_simple(const char * p_query,const char * p_sort,t_size p_playlist,t_uint32 p_flags) = 0;

    FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT(autoplaylist_manager)
};

class NOVTABLE autoplaylist_manager_v2 : public autoplaylist_manager {
    FB2K_MAKE_SERVICE_INTERFACE(autoplaylist_manager_v2, autoplaylist_manager)
public:
    virtual t_uint32 get_client_flags(t_size playlist) = 0;
    virtual void set_client_flags(t_size playlist, t_uint32 newFlags) = 0;

    virtual t_uint32 get_client_flags(autoplaylist_client::ptr client) = 0;
    virtual void set_client_flags(autoplaylist_client::ptr client, t_uint32 newFlags) = 0;
};