git.sesse.net Git - vlc/blob - src/input/input_interface.h

   1 /*****************************************************************************
   2  * input_interface.h: Input functions usable ouside input code.
   3  *****************************************************************************
   4  * Copyright (C) 1998-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar < fenrir _AT_ videolan _DOT_ org >
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
  25 # error This header file can only be included from LibVLC.
  26 #endif
  27
  28 #ifndef _INPUT_INTERFACE_H
  29 #define _INPUT_INTERFACE_H 1
  30
  31 #include <vlc_input.h>
  32 #include <libvlc.h>
  33
  34 /**********************************************************************
  35  * Item metadata
  36  **********************************************************************/
  37 void input_item_SetPreparsed( input_item_t *p_i, bool b_preparsed );
  38 void input_item_SetArtNotFound( input_item_t *p_i, bool b_not_found );
  39 void input_item_SetArtFetched( input_item_t *p_i, bool b_art_fetched );
  40
  41 /* misc/stats.c
  42  * FIXME it should NOT be defined here or not coded in misc/stats.c */
  43 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
  44
  45 /**
  46  * This defines an opaque input ressource handler.
  47  */
  48 typedef struct input_ressource_t input_ressource_t;
  49
  50 /**
  51  * This function releases an input_ressource_t and all associated ressources.
  52  */
  53 void input_ressource_Delete( input_ressource_t * );
  54
  55 /**
  56  * This function return the current sout (if any) from the ressource
  57  * and stop tracking it.
  58  *
  59  * You are then responsible of its release.
  60  */
  61 sout_instance_t *input_ressource_ExtractSout( input_ressource_t *p_ressource );
  62
  63 /* input.c */
  64 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
  65 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
  66
  67 /**
  68  * This function detaches ressources from a dead input.
  69  *
  70  * It MUST be called on a dead input (p_input->b_dead true) otherwise
  71  * it will assert.
  72  * It does not support concurrent calls.
  73  */
  74 input_ressource_t *input_DetachRessource( input_thread_t * );
  75
  76 /* */
  77 typedef enum
  78 {
  79     INPUT_STATISTIC_DECODED_VIDEO,
  80     INPUT_STATISTIC_DECODED_AUDIO,
  81     INPUT_STATISTIC_DECODED_SUBTITLE,
  82
  83     /* Use them only if you do not goes through a access_out module */
  84     INPUT_STATISTIC_SENT_PACKET,
  85     INPUT_STATISTIC_SENT_BYTE,
  86
  87 } input_statistic_t;
  88 /**
  89  * It will update internal input statistics from external sources.
  90  * XXX For now, the only one allowed to do it is stream_out and input core.
  91  */
  92 void input_UpdateStatistic( input_thread_t *, input_statistic_t, int i_delta );
  93
  94 #endif