home *** CD-ROM | disk | FTP | other *** search
/ mail.altrad.com / 2015.02.mail.altrad.com.tar / mail.altrad.com / TEST / vlc-2-0-5-win32.exe / sdk / include / vlc / plugins / vlc_input.h < prev    next >
C/C++ Source or Header  |  2012-12-12  |  22KB  |  673 lines
  1. /*****************************************************************************
  2.  * vlc_input.h: Core input structures
  3.  *****************************************************************************
  4.  * Copyright (C) 1999-2006 VLC authors and VideoLAN
  5.  * $Id: 7d8320a75ce9b2263aa3ec1fe34090cc4f7cf732 $
  6.  *
  7.  * Authors: Christophe Massiot <massiot@via.ecp.fr>
  8.  *          Laurent Aimar <fenrir@via.ecp.fr>
  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. /* __ is need because conflict with <vlc/input.h> */
  26. #ifndef VLC_INPUT_H
  27. #define VLC_INPUT_H 1
  28.  
  29. /**
  30.  * \file
  31.  * This file defines functions, structures and enums for input objects in vlc
  32.  */
  33.  
  34. #include <vlc_es.h>
  35. #include <vlc_meta.h>
  36. #include <vlc_epg.h>
  37. #include <vlc_events.h>
  38. #include <vlc_input_item.h>
  39.  
  40. #include <string.h>
  41.  
  42. /*****************************************************************************
  43.  * Meta data helpers
  44.  *****************************************************************************/
  45. static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
  46.                                                         const vlc_meta_t *p_meta )
  47. {
  48.     const char * psz_value;
  49.  
  50.     if( !p_meta )
  51.         return;
  52.  
  53.     if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_GAIN")) ||
  54.         (psz_value = vlc_meta_GetExtra(p_meta, "RG_RADIO")) )
  55.     {
  56.         p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
  57.         p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
  58.     }
  59.     else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_PEAK" )) ||
  60.              (psz_value = vlc_meta_GetExtra(p_meta, "RG_PEAK" )) )
  61.     {
  62.         p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
  63.         p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
  64.     }
  65.     else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_GAIN" )) ||
  66.              (psz_value = vlc_meta_GetExtra(p_meta, "RG_AUDIOPHILE" )) )
  67.     {
  68.         p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
  69.         p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
  70.     }
  71.     else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_PEAK" )) )
  72.     {
  73.         p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
  74.         p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
  75.     }
  76. }
  77.  
  78. /*****************************************************************************
  79.  * Seek point: (generalisation of chapters)
  80.  *****************************************************************************/
  81. struct seekpoint_t
  82. {
  83.     int64_t i_byte_offset;
  84.     int64_t i_time_offset;
  85.     char    *psz_name;
  86. };
  87.  
  88. static inline seekpoint_t *vlc_seekpoint_New( void )
  89. {
  90.     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
  91.     point->i_byte_offset =
  92.     point->i_time_offset = -1;
  93.     point->psz_name = NULL;
  94.     return point;
  95. }
  96.  
  97. static inline void vlc_seekpoint_Delete( seekpoint_t *point )
  98. {
  99.     if( !point ) return;
  100.     free( point->psz_name );
  101.     free( point );
  102. }
  103.  
  104. static inline seekpoint_t *vlc_seekpoint_Duplicate( const seekpoint_t *src )
  105. {
  106.     seekpoint_t *point = vlc_seekpoint_New();
  107.     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
  108.     point->i_time_offset = src->i_time_offset;
  109.     point->i_byte_offset = src->i_byte_offset;
  110.     return point;
  111. }
  112.  
  113. /*****************************************************************************
  114.  * Title:
  115.  *****************************************************************************/
  116. typedef struct
  117. {
  118.     char        *psz_name;
  119.  
  120.     bool        b_menu;      /* Is it a menu or a normal entry */
  121.  
  122.     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
  123.     int64_t     i_size;     /* Size (bytes) if known, else 0 */
  124.  
  125.     /* Title seekpoint */
  126.     int         i_seekpoint;
  127.     seekpoint_t **seekpoint;
  128.  
  129. } input_title_t;
  130.  
  131. static inline input_title_t *vlc_input_title_New(void)
  132. {
  133.     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
  134.  
  135.     t->psz_name = NULL;
  136.     t->b_menu = false;
  137.     t->i_length = 0;
  138.     t->i_size   = 0;
  139.     t->i_seekpoint = 0;
  140.     t->seekpoint = NULL;
  141.  
  142.     return t;
  143. }
  144.  
  145. static inline void vlc_input_title_Delete( input_title_t *t )
  146. {
  147.     int i;
  148.     if( t == NULL )
  149.         return;
  150.  
  151.     free( t->psz_name );
  152.     for( i = 0; i < t->i_seekpoint; i++ )
  153.     {
  154.         free( t->seekpoint[i]->psz_name );
  155.         free( t->seekpoint[i] );
  156.     }
  157.     free( t->seekpoint );
  158.     free( t );
  159. }
  160.  
  161. static inline input_title_t *vlc_input_title_Duplicate( const input_title_t *t )
  162. {
  163.     input_title_t *dup = vlc_input_title_New( );
  164.     int i;
  165.  
  166.     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
  167.     dup->b_menu      = t->b_menu;
  168.     dup->i_length    = t->i_length;
  169.     dup->i_size      = t->i_size;
  170.     dup->i_seekpoint = t->i_seekpoint;
  171.     if( t->i_seekpoint > 0 )
  172.     {
  173.         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
  174.                                                 sizeof(seekpoint_t*) );
  175.  
  176.         for( i = 0; i < t->i_seekpoint; i++ )
  177.         {
  178.             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
  179.         }
  180.     }
  181.  
  182.     return dup;
  183. }
  184.  
  185. /*****************************************************************************
  186.  * Attachments
  187.  *****************************************************************************/
  188. struct input_attachment_t
  189. {
  190.     char *psz_name;
  191.     char *psz_mime;
  192.     char *psz_description;
  193.  
  194.     int  i_data;
  195.     void *p_data;
  196. };
  197.  
  198. static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
  199.                                                             const char *psz_mime,
  200.                                                             const char *psz_description,
  201.                                                             const void *p_data,
  202.                                                             int i_data )
  203. {
  204.     input_attachment_t *a =
  205.         (input_attachment_t*)malloc( sizeof(input_attachment_t) );
  206.     if( !a )
  207.         return NULL;
  208.     a->psz_name = strdup( psz_name ? psz_name : "" );
  209.     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
  210.     a->psz_description = strdup( psz_description ? psz_description : "" );
  211.     a->i_data = i_data;
  212.     a->p_data = NULL;
  213.     if( i_data > 0 )
  214.     {
  215.         a->p_data = malloc( i_data );
  216.         if( a->p_data && p_data )
  217.             memcpy( a->p_data, p_data, i_data );
  218.     }
  219.     return a;
  220. }
  221. static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
  222. {
  223.     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
  224.                                      a->p_data, a->i_data );
  225. }
  226. static inline void vlc_input_attachment_Delete( input_attachment_t *a )
  227. {
  228.     if( !a )
  229.         return;
  230.     free( a->psz_name );
  231.     free( a->psz_mime );
  232.     free( a->psz_description );
  233.     free( a->p_data );
  234.     free( a );
  235. }
  236.  
  237. /*****************************************************************************
  238.  * input defines/constants.
  239.  *****************************************************************************/
  240.  
  241. /* i_update field of access_t/demux_t */
  242. #define INPUT_UPDATE_NONE       0x0000
  243. #define INPUT_UPDATE_SIZE       0x0001
  244. #define INPUT_UPDATE_TITLE      0x0010
  245. #define INPUT_UPDATE_SEEKPOINT  0x0020
  246. #define INPUT_UPDATE_META       0x0040
  247. #define INPUT_UPDATE_SIGNAL     0x0080
  248.  
  249. /**
  250.  * This defines private core storage for an input.
  251.  */
  252. typedef struct input_thread_private_t input_thread_private_t;
  253.  
  254. /**
  255.  * This defines an opaque input resource handler.
  256.  */
  257. typedef struct input_resource_t input_resource_t;
  258.  
  259. /**
  260.  * Main structure representing an input thread. This structure is mostly
  261.  * private. The only public fields are READ-ONLY. You must use the helpers
  262.  * to modify them
  263.  */
  264. struct input_thread_t
  265. {
  266.     VLC_COMMON_MEMBERS
  267.  
  268.     bool b_error;
  269.     bool b_eof;
  270.     bool b_preparsing;
  271.     bool b_dead;
  272.  
  273.     /* All other data is input_thread is PRIVATE. You can't access it
  274.      * outside of src/input */
  275.     input_thread_private_t *p;
  276. };
  277.  
  278. /**
  279.  * Record prefix string.
  280.  * TODO make it configurable.
  281.  */
  282. #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
  283.  
  284. /*****************************************************************************
  285.  * Input events and variables
  286.  *****************************************************************************/
  287.  
  288. /**
  289.  * \defgroup inputvariable Input variables
  290.  *
  291.  * The input provides multiples variable you can write to and/or read from.
  292.  *
  293.  * TODO complete the documentation.
  294.  * The read only variables are:
  295.  *  - "length"
  296.  *  - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
  297.  *    or not, for that check position != 0.0)
  298.  *  - "can-pause"
  299.  *  - "can-rate"
  300.  *  - "can-rewind"
  301.  *  - "can-record" (if a stream can be recorded while playing)
  302.  *  - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the
  303.  *                   variable value being the one currently selected, -1 if no teletext)
  304.  *  - "signal-quality"
  305.  *  - "signal-strength"
  306.  *  - "program-scrambled" (if the current program is scrambled)
  307.  *  - "cache" (level of data cached [0 .. 1])
  308.  *
  309.  * The read-write variables are:
  310.  *  - state (\see input_state_e)
  311.  *  - rate
  312.  *  - position, position-offset
  313.  *  - time, time-offset
  314.  *  - title, next-title, prev-title
  315.  *  - chapter, next-chapter, next-chapter-prev
  316.  *  - program, audio-es, video-es, spu-es
  317.  *  - audio-delay, spu-delay
  318.  *  - bookmark (bookmark list)
  319.  *  - record
  320.  *  - frame-next
  321.  *  - navigation (list of "title %2i")
  322.  *  - "title %2i"
  323.  *
  324.  * The variable used for event is
  325.  *  - intf-event (\see input_event_type_e)
  326.  */
  327.  
  328. /**
  329.  * Input state
  330.  *
  331.  * This enum is used by the variable "state"
  332.  */
  333. typedef enum input_state_e
  334. {
  335.     INIT_S = 0,
  336.     OPENING_S,
  337.     PLAYING_S,
  338.     PAUSE_S,
  339.     END_S,
  340.     ERROR_S,
  341. } input_state_e;
  342.  
  343. /**
  344.  * Input rate.
  345.  *
  346.  * It is an float used by the variable "rate" in the
  347.  * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MAX]
  348.  * the default value being 1. It represents the ratio of playback speed to
  349.  * nominal speed (bigger is faster).
  350.  *
  351.  * Internally, the rate is stored as a value in the range
  352.  * [INPUT_RATE_MIN, INPUT_RATE_MAX].
  353.  * internal rate = INPUT_RATE_DEFAULT / rate variable
  354.  */
  355.  
  356. /**
  357.  * Default rate value
  358.  */
  359. #define INPUT_RATE_DEFAULT  1000
  360. /**
  361.  * Minimal rate value
  362.  */
  363. #define INPUT_RATE_MIN        32            /* Up to 32/1 */
  364. /**
  365.  * Maximal rate value
  366.  */
  367. #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
  368.  
  369. /**
  370.  * Input events
  371.  *
  372.  * You can catch input event by adding a callback on the variable "intf-event".
  373.  * This variable is an integer that will hold a input_event_type_e value.
  374.  */
  375. typedef enum input_event_type_e
  376. {
  377.     /* "state" has changed */
  378.     INPUT_EVENT_STATE,
  379.     /* b_dead is true */
  380.     INPUT_EVENT_DEAD,
  381.     /* a *user* abort has been requested */
  382.     INPUT_EVENT_ABORT,
  383.  
  384.     /* "rate" has changed */
  385.     INPUT_EVENT_RATE,
  386.  
  387.     /* At least one of "position" or "time" */
  388.     INPUT_EVENT_POSITION,
  389.  
  390.     /* "length" has changed */
  391.     INPUT_EVENT_LENGTH,
  392.  
  393.     /* A title has been added or removed or selected.
  394.      * It imply that chapter has changed (not chapter event is sent) */
  395.     INPUT_EVENT_TITLE,
  396.     /* A chapter has been added or removed or selected. */
  397.     INPUT_EVENT_CHAPTER,
  398.  
  399.     /* A program ("program") has been added or removed or selected,
  400.      * or "program-scrambled" has changed.*/
  401.     INPUT_EVENT_PROGRAM,
  402.     /* A ES has been added or removed or selected */
  403.     INPUT_EVENT_ES,
  404.     /* "teletext-es" has changed */
  405.     INPUT_EVENT_TELETEXT,
  406.  
  407.     /* "record" has changed */
  408.     INPUT_EVENT_RECORD,
  409.  
  410.     /* input_item_t media has changed */
  411.     INPUT_EVENT_ITEM_META,
  412.     /* input_item_t info has changed */
  413.     INPUT_EVENT_ITEM_INFO,
  414.     /* input_item_t name has changed */
  415.     INPUT_EVENT_ITEM_NAME,
  416.     /* input_item_t epg has changed */
  417.     INPUT_EVENT_ITEM_EPG,
  418.  
  419.     /* Input statistics have been updated */
  420.     INPUT_EVENT_STATISTICS,
  421.     /* At least one of "signal-quality" or "signal-strength" has changed */
  422.     INPUT_EVENT_SIGNAL,
  423.  
  424.     /* "audio-delay" has changed */
  425.     INPUT_EVENT_AUDIO_DELAY,
  426.     /* "spu-delay" has changed */
  427.     INPUT_EVENT_SUBTITLE_DELAY,
  428.  
  429.     /* "bookmark" has changed */
  430.     INPUT_EVENT_BOOKMARK,
  431.  
  432.     /* cache" has changed */
  433.     INPUT_EVENT_CACHE,
  434.  
  435.     /* A audio_output_t object has been created/deleted by *the input* */
  436.     INPUT_EVENT_AOUT,
  437.     /* A vout_thread_t object has been created/deleted by *the input* */
  438.     INPUT_EVENT_VOUT,
  439.  
  440. } input_event_type_e;
  441.  
  442. /**
  443.  * Input queries
  444.  */
  445. enum input_query_e
  446. {
  447.     /* input variable "position" */
  448.     INPUT_GET_POSITION,         /* arg1= double *       res=    */
  449.     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
  450.  
  451.     /* input variable "length" */
  452.     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
  453.  
  454.     /* input variable "time" */
  455.     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
  456.     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
  457.  
  458.     /* input variable "rate" (nominal is INPUT_RATE_DEFAULT) */
  459.     INPUT_GET_RATE,             /* arg1= int *          res=    */
  460.     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
  461.  
  462.     /* input variable "state" */
  463.     INPUT_GET_STATE,            /* arg1= int *          res=    */
  464.     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
  465.  
  466.     /* input variable "audio-delay" and "sub-delay" */
  467.     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
  468.     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
  469.     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
  470.     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
  471.  
  472.     /* Meta datas */
  473.     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
  474.     INPUT_REPLACE_INFOS,/* arg1= info_category_t *            res=cannot fail */
  475.     INPUT_MERGE_INFOS,/* arg1= info_category_t *              res=cannot fail */
  476.     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
  477.     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
  478.     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
  479.  
  480.     /* Input properties */
  481.     INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
  482.  
  483.     /* bookmarks */
  484.     INPUT_GET_BOOKMARK,    /* arg1= seekpoint_t *               res=can fail */
  485.     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
  486.     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
  487.     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
  488.     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
  489.     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
  490.     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
  491.  
  492.     /* titles */
  493.     INPUT_GET_TITLE_INFO,     /* arg1=input_title_t** arg2= int * res=can fail */
  494.  
  495.     /* Attachments */
  496.     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
  497.     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
  498.  
  499.     /* On the fly input slave */
  500.     INPUT_ADD_SLAVE,       /* arg1= const char * */
  501.     INPUT_ADD_SUBTITLE,    /* arg1= const char *, arg2=bool b_check_extension */
  502.  
  503.     /* On the fly record while playing */
  504.     INPUT_SET_RECORD_STATE, /* arg1=bool    res=can fail */
  505.     INPUT_GET_RECORD_STATE, /* arg1=bool*   res=can fail */
  506.  
  507.     /* ES */
  508.     INPUT_RESTART_ES,       /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
  509.  
  510.     /* Input ressources
  511.      * XXX You must call vlc_object_release as soon as possible */
  512.     INPUT_GET_AOUT,         /* arg1=audio_output_t **              res=can fail */
  513.     INPUT_GET_VOUTS,        /* arg1=vout_thread_t ***, size_t *        res=can fail */
  514.     INPUT_GET_ES_OBJECTS,   /* arg1=int id, vlc_object_t **dec, vout_thread_t **, audio_output_t ** */
  515.  
  516.     /* External clock managments */
  517.     INPUT_GET_PCR_SYSTEM,   /* arg1=mtime_t *, arg2=mtime_t *       res=can fail */
  518.     INPUT_MODIFY_PCR_SYSTEM,/* arg1=int absolute, arg2=mtime_t      res=can fail */
  519. };
  520.  
  521. /** @}*/
  522.  
  523. /*****************************************************************************
  524.  * Prototypes
  525.  *****************************************************************************/
  526.  
  527. VLC_API input_thread_t * input_Create( vlc_object_t *p_parent, input_item_t *, const char *psz_log, input_resource_t * ) VLC_USED;
  528. #define input_Create(a,b,c,d) input_Create(VLC_OBJECT(a),b,c,d)
  529.  
  530. VLC_API input_thread_t * input_CreateAndStart( vlc_object_t *p_parent, input_item_t *, const char *psz_log ) VLC_USED;
  531. #define input_CreateAndStart(a,b,c) input_CreateAndStart(VLC_OBJECT(a),b,c)
  532.  
  533. VLC_API int input_Start( input_thread_t * );
  534.  
  535. VLC_API void input_Stop( input_thread_t *, bool b_abort );
  536.  
  537. VLC_API int input_Read( vlc_object_t *, input_item_t * );
  538. #define input_Read(a,b) input_Read(VLC_OBJECT(a),b)
  539.  
  540. VLC_API int input_vaControl( input_thread_t *, int i_query, va_list  );
  541.  
  542. VLC_API int input_Control( input_thread_t *, int i_query, ...  );
  543.  
  544. VLC_API void input_Close( input_thread_t * );
  545. void input_Join( input_thread_t * );
  546. void input_Release( input_thread_t * );
  547.  
  548. /**
  549.  * Get the input item for an input thread
  550.  *
  551.  * You have to keep a reference to the input or to the input_item_t until
  552.  * you do not need it anymore.
  553.  */
  554. VLC_API input_item_t* input_GetItem( input_thread_t * ) VLC_USED;
  555.  
  556. /**
  557.  * It will return the current state of the input.
  558.  * Provided for convenience.
  559.  */
  560. static inline input_state_e input_GetState( input_thread_t * p_input )
  561. {
  562.     input_state_e state = INIT_S;
  563.     input_Control( p_input, INPUT_GET_STATE, &state );
  564.     return state;
  565. }
  566. /**
  567.  * It will add a new subtitle source to the input.
  568.  * Provided for convenience.
  569.  */
  570. static inline int input_AddSubtitle( input_thread_t *p_input, const char *psz_url, bool b_check_extension )
  571. {
  572.     return input_Control( p_input, INPUT_ADD_SUBTITLE, psz_url, b_check_extension );
  573. }
  574.  
  575. /**
  576.  * Return one of the video output (if any). If possible, you should use
  577.  * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
  578.  * @param p_input an input thread from which to get a video output
  579.  * @return NULL on error, or a video output thread pointer (which needs to be
  580.  * released with vlc_object_release()).
  581.  */
  582. static inline vout_thread_t *input_GetVout( input_thread_t *p_input )
  583. {
  584.      vout_thread_t **pp_vout, *p_vout;
  585.      size_t i_vout;
  586.  
  587.      if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) )
  588.          return NULL;
  589.  
  590.      for( size_t i = 1; i < i_vout; i++ )
  591.          vlc_object_release( (vlc_object_t *)(pp_vout[i]) );
  592.  
  593.      p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
  594.      free( pp_vout );
  595.      return p_vout;
  596. }
  597.  
  598. /**
  599.  * Return the audio output (if any) associated with an input.
  600.  * @param p_input an input thread
  601.  * @return NULL on error, or the audio output (which needs to be
  602.  * released with vlc_object_release()).
  603.  */
  604. static inline audio_output_t *input_GetAout( input_thread_t *p_input )
  605. {
  606.      audio_output_t *p_aout;
  607.      return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
  608. }
  609.  
  610. /**
  611.  * Returns the objects associated to an ES.
  612.  *
  613.  * You must release all non NULL object using vlc_object_release.
  614.  * You may set pointer of pointer to NULL to avoid retreiving it.
  615.  */
  616. static inline int input_GetEsObjects( input_thread_t *p_input, int i_id,
  617.                                       vlc_object_t **pp_decoder,
  618.                                       vout_thread_t **pp_vout, audio_output_t **pp_aout )
  619. {
  620.     return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id,
  621.                           pp_decoder, pp_vout, pp_aout );
  622. }
  623.  
  624. /**
  625.  * \see input_clock_GetSystemOrigin
  626.  */
  627. static inline int input_GetPcrSystem( input_thread_t *p_input, mtime_t *pi_system, mtime_t *pi_delay )
  628. {
  629.     return input_Control( p_input, INPUT_GET_PCR_SYSTEM, pi_system, pi_delay );
  630. }
  631. /**
  632.  * \see input_clock_ChangeSystemOrigin
  633.  */
  634. static inline int input_ModifyPcrSystem( input_thread_t *p_input, bool b_absolute, mtime_t i_system )
  635. {
  636.     return input_Control( p_input, INPUT_MODIFY_PCR_SYSTEM, b_absolute, i_system );
  637. }
  638.  
  639. /* */
  640. VLC_API decoder_t * input_DecoderCreate( vlc_object_t *, es_format_t *, input_resource_t * ) VLC_USED;
  641. VLC_API void input_DecoderDelete( decoder_t * );
  642. VLC_API void input_DecoderDecode( decoder_t *, block_t *, bool b_do_pace );
  643.  
  644. /**
  645.  * This function creates a sane filename path.
  646.  */
  647. VLC_API char * input_CreateFilename( vlc_object_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) VLC_USED;
  648.  
  649. /**
  650.  * It creates an empty input resource handler.
  651.  *
  652.  * The given object MUST stay alive as long as the input_resource_t is
  653.  * not deleted.
  654.  */
  655. VLC_API input_resource_t * input_resource_New( vlc_object_t * ) VLC_USED;
  656.  
  657. /**
  658.  * It releases an input resource.
  659.  */
  660. VLC_API void input_resource_Release( input_resource_t * );
  661.  
  662. /**
  663.  * Forcefully destroys the video output (e.g. when the playlist is stopped).
  664.  */
  665. VLC_API void input_resource_TerminateVout( input_resource_t * );
  666.  
  667. /**
  668.  * This function releases all resources (object).
  669.  */
  670. VLC_API void input_resource_Terminate( input_resource_t * );
  671.  
  672. #endif
  673.