Include dependency graph for fetcher.c:

Data Structures
struct	playlist_fetcher_t

struct	fetcher_request

struct	fetcher_thread

Macros
#define	DEF_STARTER(name, worker)

Functions
static char *	CreateCacheKey (input_item_t *item)

static void	FreeCacheEntry (void data, void obj)

static int	ReadAlbumCache (playlist_fetcher_t fetcher, input_item_t item)

static void	AddAlbumCache (playlist_fetcher_t fetcher, input_item_t item, bool overwrite)

static int	InvokeModule (playlist_fetcher_t fetcher, input_item_t item, int scope, char const *type)

static int	CheckMeta (input_item_t *item)

static int	CheckArt (input_item_t *item)

static int	SearchArt (playlist_fetcher_t fetcher, input_item_t item, int scope)

static int	SearchByScope (playlist_fetcher_t fetcher, struct fetcher_request req, int scope)

static void	SetPreparsed (struct fetcher_request *req)

static void	Downloader (playlist_fetcher_t fetcher, struct fetcher_request req)

static void	SearchLocal (playlist_fetcher_t fetcher, struct fetcher_request req)

static void	SearchNetwork (playlist_fetcher_t fetcher, struct fetcher_request req)

static void	RequestRelease (void *req_)

static void	RequestHold (void *req_)

static void *	FetcherThread (void *handle)

static int	StartWorker (playlist_fetcher_t fetcher, void(pf_worker)(playlist_fetcher_t , struct fetcher_request ), struct background_worker bg, struct fetcher_request req, void **handle)

static int	ProbeWorker (void fetcher_, void th_)

static void	CloseWorker (void fetcher_, void th_)

static int	StartSearchLocal (void fetcher_, void req_, void **out)

static int	StartSearchNetwork (void fetcher_, void req_, void **out)

static int	StartDownloader (void fetcher_, void req_, void **out)

static void	WorkerInit (playlist_fetcher_t fetcher, struct background_worker worker, int(starter)(void , void , void **))

playlist_fetcher_t *	playlist_fetcher_New (vlc_object_t *owner)
	This function creates the fetcher object and thread. More...

int	playlist_fetcher_Push (playlist_fetcher_t fetcher, input_item_t item, input_item_meta_request_option_t options, int preparse_status)
	This function enqueues the provided item to be art fetched. More...

void	playlist_fetcher_Delete (playlist_fetcher_t *fetcher)
	This function destroys the fetcher object and thread. More...

Macro Definition Documentation

◆ DEF_STARTER

#define DEF_STARTER	(	name,
		worker
	)

Value:

static int Start ## name( void* fetcher_, void* req_, void** out ) { \
    playlist_fetcher_t* fetcher = fetcher_; \
    return StartWorker( fetcher, name, worker, req_, out ); }

Function Documentation

◆ AddAlbumCache()

static void AddAlbumCache	(	playlist_fetcher_t *	fetcher,
		input_item_t *	item,
		bool	overwrite
	)

static

References playlist_fetcher_t::album_cache, CreateCacheKey(), input_item_GetArtURL, fetcher_request::item, playlist_fetcher_t::lock, vlc_dictionary_has_key(), vlc_dictionary_insert(), vlc_mutex_lock(), and vlc_mutex_unlock().

Referenced by Downloader(), and SearchByScope().

◆ CheckArt()

static int CheckArt ( input_item_t * item )

static

References fetcher_request::item, input_item_t::lock, input_item_t::p_meta, vlc_meta_ArtworkURL, vlc_meta_Get(), vlc_mutex_lock(), and vlc_mutex_unlock().

Referenced by SearchArt(), and SearchByScope().

◆ CheckMeta()

static int CheckMeta ( input_item_t * item )

static

References fetcher_request::item, input_item_t::lock, input_item_t::p_meta, vlc_meta_Album, vlc_meta_Artist, vlc_meta_Get(), vlc_meta_Title, vlc_mutex_lock(), and vlc_mutex_unlock().

Referenced by SearchByScope().

◆ CloseWorker()

static void CloseWorker	(	void *	fetcher_,
		void *	th_
	)

static

References fetcher_thread::interrupt, fetcher_thread::thread, vlc_interrupt_deinit(), vlc_interrupt_kill(), vlc_join(), and VLC_UNUSED.

Referenced by WorkerInit().

◆ CreateCacheKey()

static char* CreateCacheKey ( input_item_t * item )

static

Simple concatenation of artist and album can lead to the same key for entities that should not have such. Imagine { dogs, tick } and { dog, stick }

References asprintf(), fetcher_request::item, input_item_t::lock, input_item_t::p_meta, vlc_meta_Album, vlc_meta_Artist, vlc_meta_Get(), vlc_mutex_lock(), and vlc_mutex_unlock().

Referenced by AddAlbumCache(), and ReadAlbumCache().

◆ Downloader()

static void Downloader	(	playlist_fetcher_t *	fetcher,
		struct fetcher_request *	req
	)

static

◆ FetcherThread()

static void* FetcherThread ( void * handle )

static

References fetcher_thread::active, background_worker_RequestProbe(), fetcher_thread::fetcher, fetcher_thread::interrupt, fetcher_thread::pf_worker, fetcher_thread::req, vlc_interrupt_set(), and fetcher_thread::worker.

Referenced by StartWorker().

◆ FreeCacheEntry()

static void FreeCacheEntry	(	void *	data,
		void *	obj
	)

static

References VLC_UNUSED.

Referenced by playlist_fetcher_Delete().

◆ InvokeModule()

static int InvokeModule	(	playlist_fetcher_t *	fetcher,
		input_item_t *	item,
		int	scope,
		char const *	type
	)

static

< Not enough memory

< No error

References meta_fetcher_t::e_scope, fetcher_request::item, module_need, module_unneed, playlist_fetcher_t::owner, meta_fetcher_t::p_item, unlikely, vlc_custom_create, VLC_ENOMEM, vlc_object_release, and VLC_SUCCESS.

Referenced by SearchArt(), and SearchByScope().

◆ playlist_fetcher_Delete()

void playlist_fetcher_Delete ( playlist_fetcher_t * )

This function destroys the fetcher object and thread.

All pending input items will be released.

References playlist_fetcher_t::album_cache, background_worker_Delete(), playlist_fetcher_t::downloader, FreeCacheEntry(), playlist_fetcher_t::local, playlist_fetcher_t::lock, playlist_fetcher_t::network, vlc_dictionary_clear(), and vlc_mutex_destroy().

Referenced by playlist_preparser_Delete().

◆ playlist_fetcher_New()

playlist_fetcher_t* playlist_fetcher_New ( vlc_object_t * owner )

This function creates the fetcher object and thread.

References playlist_fetcher_t::album_cache, background_worker_Delete(), playlist_fetcher_t::downloader, playlist_fetcher_t::local, playlist_fetcher_t::lock, playlist_fetcher_t::network, playlist_fetcher_t::owner, StartDownloader(), StartSearchLocal(), StartSearchNetwork(), unlikely, vlc_dictionary_init(), vlc_mutex_init(), and WorkerInit().

Referenced by playlist_preparser_New().

◆ playlist_fetcher_Push()

int playlist_fetcher_Push	(	playlist_fetcher_t *	,
		input_item_t *	,
		input_item_meta_request_option_t	,
		int
	)

This function enqueues the provided item to be art fetched.

The input item is retained until the art fetching is done or until the fetcher object is destroyed.

< Not enough memory

< No error

References background_worker_Push(), input_item_Hold(), fetcher_request::item, playlist_fetcher_t::local, fetcher_request::options, fetcher_request::preparse_status, fetcher_request::refs, RequestRelease(), SetPreparsed(), unlikely, VLC_ENOMEM, and VLC_SUCCESS.

Referenced by playlist_preparser_fetcher_Push(), and PreparserCloseInput().

◆ ProbeWorker()

static int ProbeWorker	(	void *	fetcher_,
		void *	th_
	)

static

References fetcher_thread::active, and VLC_UNUSED.

Referenced by WorkerInit().

◆ ReadAlbumCache()

static int ReadAlbumCache	(	playlist_fetcher_t *	fetcher,
		input_item_t *	item
	)

static

< Unspecified error

< No error

< Unspecified error

References playlist_fetcher_t::album_cache, CreateCacheKey(), input_item_SetArtURL, fetcher_request::item, playlist_fetcher_t::lock, vlc_dictionary_value_for_key(), VLC_EGENERIC, vlc_mutex_lock(), vlc_mutex_unlock(), and VLC_SUCCESS.

Referenced by Downloader(), and SearchByScope().

◆ RequestHold()

static void RequestHold ( void * req_ )

static

References fetcher_request::refs.

Referenced by WorkerInit().

◆ RequestRelease()

static void RequestRelease ( void * req_ )

static

References input_item_Release(), fetcher_request::item, and fetcher_request::refs.

Referenced by playlist_fetcher_Push(), and WorkerInit().

◆ SearchArt()

static int SearchArt	(	playlist_fetcher_t *	fetcher,
		input_item_t *	item,
		int	scope
	)

static

References CheckArt(), InvokeModule(), and fetcher_request::item.

Referenced by SearchByScope().

◆ SearchByScope()

static int SearchByScope	(	playlist_fetcher_t *	fetcher,
		struct fetcher_request *	req,
		int	scope
	)

static

< Unspecified error

< No error

< Unspecified error

References AddAlbumCache(), background_worker_Push(), CheckArt(), CheckMeta(), playlist_fetcher_t::downloader, InvokeModule(), fetcher_request::item, playlist_FindArtInCache(), playlist_FindArtInCacheUsingItemUID(), ReadAlbumCache(), SearchArt(), VLC_EGENERIC, and VLC_SUCCESS.

Referenced by SearchLocal(), and SearchNetwork().

◆ SearchLocal()

static void SearchLocal	(	playlist_fetcher_t *	fetcher,
		struct fetcher_request *	req
	)

static

< No error

References background_worker_Push(), FETCHER_SCOPE_LOCAL, input_item_SetArtNotFound(), fetcher_request::item, META_REQUEST_OPTION_SCOPE_NETWORK, playlist_fetcher_t::network, fetcher_request::options, playlist_fetcher_t::owner, SearchByScope(), SetPreparsed(), var_InheritBool, and VLC_SUCCESS.

◆ SearchNetwork()

static void SearchNetwork	(	playlist_fetcher_t *	fetcher,
		struct fetcher_request *	req
	)

static

References FETCHER_SCOPE_NETWORK, input_item_SetArtNotFound(), fetcher_request::item, SearchByScope(), and SetPreparsed().

◆ SetPreparsed()

static void SetPreparsed ( struct fetcher_request * req )

static

References input_item_SetPreparsed(), input_item_SignalPreparseEnded(), fetcher_request::item, and fetcher_request::preparse_status.

Referenced by Downloader(), playlist_fetcher_Push(), SearchLocal(), and SearchNetwork().

◆ StartDownloader()

static int StartDownloader	(	void *	fetcher_,
		void *	req_,
		void **	out
	)

static

Referenced by playlist_fetcher_New().

◆ StartSearchLocal()

static int StartSearchLocal	(	void *	fetcher_,
		void *	req_,
		void **	out
	)

static

Referenced by playlist_fetcher_New().

◆ StartSearchNetwork()

static int StartSearchNetwork	(	void *	fetcher_,
		void *	req_,
		void **	out
	)

static

Referenced by playlist_fetcher_New().

◆ StartWorker()

static int StartWorker	(	playlist_fetcher_t *	fetcher,
		void()(playlist_fetcher_t , struct fetcher_request *)	pf_worker,
		struct background_worker *	bg,
		struct fetcher_request *	req,
		void **	handle
	)

static

< Not enough memory

< No error

< Unspecified error

References fetcher_thread::active, fetcher_thread::fetcher, FetcherThread(), fetcher_thread::interrupt, fetcher_thread::pf_worker, fetcher_thread::req, fetcher_thread::thread, unlikely, vlc_clone(), VLC_EGENERIC, VLC_ENOMEM, vlc_interrupt_deinit(), vlc_interrupt_init(), VLC_SUCCESS, VLC_THREAD_PRIORITY_LOW, and fetcher_thread::worker.

◆ WorkerInit()

static void WorkerInit	(	playlist_fetcher_t *	fetcher,
		struct background_worker **	worker,
		int()(void , void , void *)	starter
	)

static

References background_worker_New(), CloseWorker(), background_worker_config::default_timeout, ProbeWorker(), RequestHold(), and RequestRelease().

Referenced by playlist_fetcher_New().

Data Structures

Macros

Functions

Macro Definition Documentation

◆ DEF_STARTER

Function Documentation

◆ AddAlbumCache()

◆ CheckArt()

◆ CheckMeta()

◆ CloseWorker()

◆ CreateCacheKey()

◆ Downloader()

◆ FetcherThread()

◆ FreeCacheEntry()

◆ InvokeModule()

◆ playlist_fetcher_Delete()

◆ playlist_fetcher_New()

◆ playlist_fetcher_Push()

◆ ProbeWorker()

◆ ReadAlbumCache()

◆ RequestHold()

◆ RequestRelease()

◆ SearchArt()

◆ SearchByScope()

◆ SearchLocal()

◆ SearchNetwork()

◆ SetPreparsed()

◆ StartDownloader()

◆ StartSearchLocal()

◆ StartSearchNetwork()

◆ StartWorker()

◆ WorkerInit()