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

   1 /*****************************************************************************
   2  * input_internal.h: Internal input structures
   3  *****************************************************************************
   4  * Copyright (C) 1998-2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   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 #ifndef _INPUT_INTERNAL_H
  25 #define _INPUT_INTERNAL_H 1
  26
  27 #include <vlc_access.h>
  28 #include <vlc_demux.h>
  29 #include <vlc_input.h>
  30
  31 /*****************************************************************************
  32  *  Private input fields
  33  *****************************************************************************/
  34 /* input_source_t: gathers all information per input source */
  35 typedef struct
  36 {
  37     /* Input item description */
  38     input_item_t *p_item;
  39
  40     /* Access/Stream/Demux plugins */
  41     access_t *p_access;
  42     stream_t *p_stream;
  43     demux_t  *p_demux;
  44
  45     /* Title infos for that input */
  46     vlc_bool_t   b_title_demux; /* Titles/Seekpoints provided by demux */
  47     int          i_title;
  48     input_title_t **title;
  49
  50     int i_title_offset;
  51     int i_seekpoint_offset;
  52
  53     int i_title_start;
  54     int i_title_end;
  55     int i_seekpoint_start;
  56     int i_seekpoint_end;
  57
  58     /* Properties */
  59     vlc_bool_t b_can_pace_control;
  60     vlc_bool_t b_can_pause;
  61     vlc_bool_t b_eof;   /* eof of demuxer */
  62
  63     /* Clock average variation */
  64     int     i_cr_average;
  65
  66 } input_source_t;
  67
  68 /** Private input fields */
  69 struct input_thread_private_t
  70 {
  71     /* Global properties */
  72     vlc_bool_t  b_can_pause;
  73
  74     int         i_rate;
  75     /* */
  76     int64_t     i_start;    /* :start-time,0 by default */
  77     int64_t     i_stop;     /* :stop-time, 0 if none */
  78
  79     /* Title infos FIXME multi-input (not easy) ? */
  80     int          i_title;
  81     input_title_t **title;
  82
  83     int i_title_offset;
  84     int i_seekpoint_offset;
  85
  86     /* User bookmarks FIXME won't be easy with multiples input */
  87     int         i_bookmark;
  88     seekpoint_t **bookmark;
  89
  90     /* Global meta datas FIXME move to input_item_t ? */
  91     vlc_meta_t  *p_meta;
  92
  93     /* Output */
  94     es_out_t    *p_es_out;
  95     sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
  96     vlc_bool_t      b_sout_keep;
  97     vlc_bool_t      b_out_pace_control; /*     idem ? */
  98
  99     /* Main input properties */
 100     input_source_t input;
 101     /* Slave demuxers (subs, and others) */
 102     int            i_slave;
 103     input_source_t **slave;
 104
 105     /* Stats counters */
 106     struct {
 107         counter_t *p_read_packets;
 108         counter_t *p_read_bytes;
 109         counter_t *p_input_bitrate;
 110         counter_t *p_demux_read;
 111         counter_t *p_demux_bitrate;
 112         counter_t *p_decoded_audio;
 113         counter_t *p_decoded_video;
 114         counter_t *p_decoded_sub;
 115         counter_t *p_sout_sent_packets;
 116         counter_t *p_sout_sent_bytes;
 117         counter_t *p_sout_send_bitrate;
 118         counter_t *p_played_abuffers;
 119         counter_t *p_lost_abuffers;
 120         counter_t *p_displayed_pictures;
 121         counter_t *p_lost_pictures;
 122         vlc_mutex_t counters_lock;
 123     } counters;
 124
 125     /* Buffer of pending actions */
 126     vlc_mutex_t lock_control;
 127     int i_control;
 128     struct
 129     {
 130         /* XXX: val isn't duplicated so it won't works with string */
 131         int         i_type;
 132         vlc_value_t val;
 133     } control[INPUT_CONTROL_FIFO_SIZE];
 134 };
 135
 136 /***************************************************************************
 137  * Internal control helpers
 138  ***************************************************************************/
 139 enum input_control_e
 140 {
 141     INPUT_CONTROL_SET_DIE,
 142
 143     INPUT_CONTROL_SET_STATE,
 144
 145     INPUT_CONTROL_SET_RATE,
 146     INPUT_CONTROL_SET_RATE_SLOWER,
 147     INPUT_CONTROL_SET_RATE_FASTER,
 148
 149     INPUT_CONTROL_SET_POSITION,
 150     INPUT_CONTROL_SET_POSITION_OFFSET,
 151
 152     INPUT_CONTROL_SET_TIME,
 153     INPUT_CONTROL_SET_TIME_OFFSET,
 154
 155     INPUT_CONTROL_SET_PROGRAM,
 156
 157     INPUT_CONTROL_SET_TITLE,
 158     INPUT_CONTROL_SET_TITLE_NEXT,
 159     INPUT_CONTROL_SET_TITLE_PREV,
 160
 161     INPUT_CONTROL_SET_SEEKPOINT,
 162     INPUT_CONTROL_SET_SEEKPOINT_NEXT,
 163     INPUT_CONTROL_SET_SEEKPOINT_PREV,
 164
 165     INPUT_CONTROL_SET_BOOKMARK,
 166
 167     INPUT_CONTROL_SET_ES,
 168
 169     INPUT_CONTROL_SET_AUDIO_DELAY,
 170     INPUT_CONTROL_SET_SPU_DELAY,
 171
 172     INPUT_CONTROL_ADD_SLAVE,
 173 };
 174
 175 /* Internal helpers */
 176 static inline void input_ControlPush( input_thread_t *p_input,
 177                                       int i_type, vlc_value_t *p_val )
 178 {
 179     vlc_mutex_lock( &p_input->p->lock_control );
 180     if( i_type == INPUT_CONTROL_SET_DIE )
 181     {
 182         /* Special case, empty the control */
 183         p_input->p->i_control = 1;
 184         p_input->p->control[0].i_type = i_type;
 185         memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
 186     }
 187     else
 188     {
 189         if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
 190         {
 191             msg_Err( p_input, "input control fifo overflow, trashing type=%d",
 192                      i_type );
 193             vlc_mutex_unlock( &p_input->p->lock_control );
 194             return;
 195         }
 196         p_input->p->control[p_input->p->i_control].i_type = i_type;
 197         if( p_val )
 198             p_input->p->control[p_input->p->i_control].val = *p_val;
 199         else
 200             memset( &p_input->p->control[p_input->p->i_control].val, 0,
 201                     sizeof( vlc_value_t ) );
 202
 203         p_input->p->i_control++;
 204     }
 205     vlc_mutex_unlock( &p_input->p->lock_control );
 206 }
 207
 208 /**********************************************************************
 209  * Item metadata
 210  **********************************************************************/
 211 typedef struct playlist_album_t
 212 {
 213     char *psz_artist;
 214     char *psz_album;
 215     vlc_bool_t b_found;
 216 } playlist_album_t;
 217
 218 int         input_MetaFetch     ( playlist_t *, input_item_t * );
 219 int         input_ArtFind       ( playlist_t *, input_item_t * );
 220 vlc_bool_t  input_MetaSatisfied ( playlist_t*, input_item_t*,
 221                                   uint32_t*, uint32_t* );
 222 int         input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
 223
 224 /***************************************************************************
 225  * Internal prototypes
 226  ***************************************************************************/
 227
 228 /* input.c */
 229 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
 230 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
 231
 232 void input_DestroyThreadExtended( input_thread_t *p_input, sout_instance_t ** );
 233
 234 /* var.c */
 235 void input_ControlVarInit ( input_thread_t * );
 236 void input_ControlVarClean( input_thread_t * );
 237 void input_ControlVarNavigation( input_thread_t * );
 238 void input_ControlVarTitle( input_thread_t *, int i_title );
 239
 240 void input_ConfigVarInit ( input_thread_t * );
 241
 242 /* stream.c */
 243 stream_t *stream_AccessNew( access_t *p_access, vlc_bool_t );
 244 void stream_AccessDelete( stream_t *s );
 245 void stream_AccessReset( stream_t *s );
 246 void stream_AccessUpdate( stream_t *s );
 247
 248 /* decoder.c */
 249 void       input_DecoderDiscontinuity( decoder_t * p_dec );
 250 vlc_bool_t input_DecoderEmpty( decoder_t * p_dec );
 251 void       input_DecoderPreroll( decoder_t *p_dec, int64_t i_preroll_end );
 252
 253 /* es_out.c */
 254 es_out_t  *input_EsOutNew( input_thread_t * );
 255 void       input_EsOutDelete( es_out_t * );
 256 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
 257 void       input_EsOutDiscontinuity( es_out_t *, vlc_bool_t b_audio );
 258 void       input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
 259 vlc_bool_t input_EsOutDecodersEmpty( es_out_t * );
 260
 261 /* clock.c */
 262 enum /* Synchro states */
 263 {
 264     SYNCHRO_OK     = 0,
 265     SYNCHRO_START  = 1,
 266     SYNCHRO_REINIT = 2,
 267 };
 268
 269 typedef struct
 270 {
 271     /* Synchronization information */
 272     mtime_t                 delta_cr;
 273     mtime_t                 cr_ref, sysdate_ref;
 274     mtime_t                 last_sysdate;
 275     mtime_t                 last_cr; /* reference to detect unexpected stream
 276                                       * discontinuities                      */
 277     mtime_t                 last_pts;
 278     int                     i_synchro_state;
 279
 280     vlc_bool_t              b_master;
 281
 282     /* Config */
 283     int                     i_cr_average;
 284     int                     i_delta_cr_residue;
 285 } input_clock_t;
 286
 287 void input_ClockInit( input_clock_t *, vlc_bool_t b_master, int i_cr_average );
 288 void    input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
 289 mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
 290
 291 /* Subtitles */
 292 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
 293 int subtitles_Filter( const char *);
 294
 295 void MRLSplit( vlc_object_t *, char *, const char **, const char **, char ** );
 296
 297 static inline void input_ChangeState( input_thread_t *p_input, int state )
 298 {
 299     vlc_value_t val;
 300     val.i_int = p_input->i_state = state;
 301     var_Change( p_input, "state", VLC_VAR_SETVALUE, &val, NULL );
 302 }
 303
 304 /* Access */
 305
 306 #define access2_New( a, b, c, d, e ) __access2_New(VLC_OBJECT(a), b, c, d, e )
 307 access_t * __access2_New( vlc_object_t *p_obj, const char *psz_access,
 308                           const char *psz_demux, const char *psz_path,
 309                           vlc_bool_t b_quick );
 310 access_t * access2_FilterNew( access_t *p_source,
 311                               const char *psz_access_filter );
 312 void access2_Delete( access_t * );
 313
 314 /* Demuxer */
 315 #include <vlc_demux.h>
 316
 317 /* stream_t *s could be null and then it mean a access+demux in one */
 318 #define demux2_New( a, b, c, d, e, f,g ) __demux2_New(VLC_OBJECT(a),b,c,d,e,f,g)
 319 demux_t *__demux2_New(vlc_object_t *p_obj, const char *psz_access, const char *psz_demux, const char *psz_path, stream_t *s, es_out_t *out, vlc_bool_t );
 320
 321 void demux2_Delete(demux_t *);
 322
 323 static inline int demux2_Demux( demux_t *p_demux )
 324 {
 325     return p_demux->pf_demux( p_demux );
 326 }
 327 static inline int demux2_vaControl( demux_t *p_demux, int i_query, va_list args )
 328 {
 329     return p_demux->pf_control( p_demux, i_query, args );
 330 }
 331 static inline int demux2_Control( demux_t *p_demux, int i_query, ... )
 332 {
 333     va_list args;
 334     int     i_result;
 335
 336     va_start( args, i_query );
 337     i_result = demux2_vaControl( p_demux, i_query, args );
 338     va_end( args );
 339     return i_result;
 340 }
 341
 342 #endif