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

   1 /*****************************************************************************
   2  * resource.h
   3  *****************************************************************************
   4  * Copyright (C) 2008 Laurent Aimar
   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_RESOURCE_H
  29 #define _INPUT_RESOURCE_H 1
  30
  31 #include <vlc_common.h>
  32
  33 /**
  34  * This function creates an empty input_resource_t.
  35  */
  36 input_resource_t *input_resource_New( void );
  37
  38 /**
  39  * This function set the associated input.
  40  */
  41 void input_resource_SetInput( input_resource_t *, input_thread_t * );
  42
  43 /**
  44  * This function return a input_resource_t with all resources detach from the
  45  * given input_resource_t.
  46  * It must not be associated to an input.
  47  */
  48 input_resource_t *input_resource_Detach( input_resource_t * );
  49
  50 /**
  51  * This function handles sout request.
  52  */
  53 sout_instance_t *input_resource_RequestSout( input_resource_t *, sout_instance_t *, const char *psz_sout );
  54
  55 /**
  56  * This function handles aout request.
  57  */
  58 aout_instance_t *input_resource_RequestAout( input_resource_t *, aout_instance_t * );
  59
  60 /**
  61  * This function return the current aout if any.
  62  *
  63  * You must call vlc_object_release on the value returned (if non NULL).
  64  */
  65 aout_instance_t *input_resource_HoldAout( input_resource_t *p_resource );
  66
  67 /**
  68  * This function handles vout request.
  69  */
  70 vout_thread_t *input_resource_RequestVout( input_resource_t *, vout_thread_t *, video_format_t *, bool b_recycle );
  71
  72 /**
  73  * This function return one of the current vout if any.
  74  *
  75  * You must call vlc_object_release on the value returned (if non NULL).
  76  */
  77 vout_thread_t *input_resource_HoldVout( input_resource_t * );
  78
  79 /**
  80  * This function return all current vouts if any.
  81  *
  82  * You must call vlc_object_release on all values returned (if non NULL).
  83  */
  84 void input_resource_HoldVouts( input_resource_t *, vout_thread_t ***, size_t * );
  85
  86 #endif
  87