git.sesse.net Git - vlc/blob - src/playlist/fetcher.h

   1 /*****************************************************************************
   2  * playlist_fetcher.h:
   3  *****************************************************************************
   4  * Copyright (C) 1999-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *          Clément Stenac <zorglub@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef _PLAYLIST_FETCHER_H
  26 #define _PLAYLIST_FETCHER_H 1
  27
  28 /**
  29  * Fetcher opaque structure.
  30  *
  31  * The fether object will retreive the art album data for any given input
  32  * item in an asynchronous way.
  33  */
  34 typedef struct playlist_fetcher_t playlist_fetcher_t;
  35
  36 /**
  37  * This function creates the fetcher object and thread.
  38  */
  39 playlist_fetcher_t *playlist_fetcher_New( playlist_t * );
  40
  41 /**
  42  * This function enqueues the provided item to be art fetched.
  43  *
  44  * The input item is retained until the art fetching is done or until the
  45  * fetcher object is destroyed.
  46  */
  47 void playlist_fetcher_Push( playlist_fetcher_t *, input_item_t * );
  48
  49 /**
  50  * This function destroys the fetcher object and thread.
  51  *
  52  * All pending input items will be released.
  53  */
  54 void playlist_fetcher_Delete( playlist_fetcher_t * );
  55
  56 #endif
  57