src/playlist/preparser.h

   1 /*****************************************************************************
   2  * playlist_preparser.h:
   3  *****************************************************************************
   4  * Copyright (C) 1999-2008 VLC authors and VideoLAN
   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 it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef _PLAYLIST_PREPARSER_H
  26 #define _PLAYLIST_PREPARSER_H 1
  27
  28 /**
  29  * Preparser opaque structure.
  30  *
  31  * The preparser object will retreive the meta data of any given input item in
  32  * an asynchronous way.
  33  * It will also issue art fetching requests.
  34  */
  35 typedef struct playlist_preparser_t playlist_preparser_t;
  36
  37 /**
  38  * This function creates the preparser object and thread.
  39  */
  40 playlist_preparser_t *playlist_preparser_New( vlc_object_t *,
  41                                               playlist_fetcher_t * );
  42
  43 /**
  44  * This function enqueues the provided item to be preparsed.
  45  *
  46  * The input item is retained until the preparsing is done or until the
  47  * preparser object is deleted.
  48  */
  49 void playlist_preparser_Push( playlist_preparser_t *, input_item_t * );
  50
  51 /**
  52  * This function destroys the preparser object and thread.
  53  *
  54  * All pending input items will be released.
  55  */
  56 void playlist_preparser_Delete( playlist_preparser_t * );
  57
  58 #endif
  59