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 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
  25 # error This header file can only be included from LibVLC.
  26 #endif
  27
  28 #ifndef _INPUT_INTERNAL_H
  29 #define _INPUT_INTERNAL_H 1
  30
  31 #include <vlc_access.h>
  32 #include <vlc_demux.h>
  33 #include <vlc_input.h>
  34
  35 /*****************************************************************************
  36  *  Private input fields
  37  *****************************************************************************/
  38 /* input_source_t: gathers all information per input source */
  39 typedef struct
  40 {
  41     /* Input item description */
  42     input_item_t *p_item;
  43
  44     /* Access/Stream/Demux plugins */
  45     access_t *p_access;
  46     stream_t *p_stream;
  47     demux_t  *p_demux;
  48
  49     /* Title infos for that input */
  50     bool   b_title_demux; /* Titles/Seekpoints provided by demux */
  51     int          i_title;
  52     input_title_t **title;
  53
  54     int i_title_offset;
  55     int i_seekpoint_offset;
  56
  57     int i_title_start;
  58     int i_title_end;
  59     int i_seekpoint_start;
  60     int i_seekpoint_end;
  61
  62     /* Properties */
  63     bool b_can_pause;
  64     bool b_can_pace_control;
  65     bool b_can_rate_control;
  66     bool b_rescale_ts;
  67
  68     bool b_eof;   /* eof of demuxer */
  69     double     f_fps;
  70
  71     /* Clock average variation */
  72     int     i_cr_average;
  73
  74 } input_source_t;
  75
  76 /** Private input fields */
  77 struct input_thread_private_t
  78 {
  79     /* Global properties */
  80     bool  b_can_pause;
  81     bool  b_can_rate_control;
  82
  83     int         i_rate;
  84     /* */
  85     int64_t     i_start;    /* :start-time,0 by default */
  86     int64_t     i_stop;     /* :stop-time, 0 if none */
  87     int64_t     i_run;      /* :run-time, 0 if none */
  88
  89     /* Title infos FIXME multi-input (not easy) ? */
  90     int          i_title;
  91     input_title_t **title;
  92
  93     int i_title_offset;
  94     int i_seekpoint_offset;
  95
  96     /* User bookmarks FIXME won't be easy with multiples input */
  97     int         i_bookmark;
  98     seekpoint_t **bookmark;
  99
 100     /* Input attachment */
 101     int i_attachment;
 102     input_attachment_t **attachment;
 103
 104     /* Output */
 105     es_out_t    *p_es_out;
 106     sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
 107     bool      b_out_pace_control; /*     idem ? */
 108
 109     /* Main input properties */
 110     input_source_t input;
 111     /* Slave demuxers (subs, and others) */
 112     int            i_slave;
 113     input_source_t **slave;
 114
 115     /* Stats counters */
 116     struct {
 117         counter_t *p_read_packets;
 118         counter_t *p_read_bytes;
 119         counter_t *p_input_bitrate;
 120         counter_t *p_demux_read;
 121         counter_t *p_demux_bitrate;
 122         counter_t *p_decoded_audio;
 123         counter_t *p_decoded_video;
 124         counter_t *p_decoded_sub;
 125         counter_t *p_sout_sent_packets;
 126         counter_t *p_sout_sent_bytes;
 127         counter_t *p_sout_send_bitrate;
 128         counter_t *p_played_abuffers;
 129         counter_t *p_lost_abuffers;
 130         counter_t *p_displayed_pictures;
 131         counter_t *p_lost_pictures;
 132         vlc_mutex_t counters_lock;
 133     } counters;
 134
 135     /* Buffer of pending actions */
 136     vlc_mutex_t lock_control;
 137     int i_control;
 138     struct
 139     {
 140         /* XXX for string value you have to allocate it before calling
 141          * input_ControlPush */
 142         int         i_type;
 143         vlc_value_t val;
 144     } control[INPUT_CONTROL_FIFO_SIZE];
 145 };
 146
 147 /***************************************************************************
 148  * Internal control helpers
 149  ***************************************************************************/
 150 enum input_control_e
 151 {
 152     INPUT_CONTROL_SET_DIE,
 153
 154     INPUT_CONTROL_SET_STATE,
 155
 156     INPUT_CONTROL_SET_RATE,
 157     INPUT_CONTROL_SET_RATE_SLOWER,
 158     INPUT_CONTROL_SET_RATE_FASTER,
 159
 160     INPUT_CONTROL_SET_POSITION,
 161     INPUT_CONTROL_SET_POSITION_OFFSET,
 162
 163     INPUT_CONTROL_SET_TIME,
 164     INPUT_CONTROL_SET_TIME_OFFSET,
 165
 166     INPUT_CONTROL_SET_PROGRAM,
 167
 168     INPUT_CONTROL_SET_TITLE,
 169     INPUT_CONTROL_SET_TITLE_NEXT,
 170     INPUT_CONTROL_SET_TITLE_PREV,
 171
 172     INPUT_CONTROL_SET_SEEKPOINT,
 173     INPUT_CONTROL_SET_SEEKPOINT_NEXT,
 174     INPUT_CONTROL_SET_SEEKPOINT_PREV,
 175
 176     INPUT_CONTROL_SET_BOOKMARK,
 177
 178     INPUT_CONTROL_SET_ES,
 179
 180     INPUT_CONTROL_SET_AUDIO_DELAY,
 181     INPUT_CONTROL_SET_SPU_DELAY,
 182
 183     INPUT_CONTROL_ADD_SLAVE,
 184 };
 185
 186 /* Internal helpers */
 187 static inline void input_ControlPush( input_thread_t *p_input,
 188                                       int i_type, vlc_value_t *p_val )
 189 {
 190     vlc_mutex_lock( &p_input->p->lock_control );
 191     if( i_type == INPUT_CONTROL_SET_DIE )
 192     {
 193         /* Special case, empty the control */
 194         p_input->p->i_control = 1;
 195         p_input->p->control[0].i_type = i_type;
 196         memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
 197     }
 198     else
 199     {
 200         if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
 201         {
 202             msg_Err( p_input, "input control fifo overflow, trashing type=%d",
 203                      i_type );
 204             vlc_mutex_unlock( &p_input->p->lock_control );
 205             return;
 206         }
 207         p_input->p->control[p_input->p->i_control].i_type = i_type;
 208         if( p_val )
 209             p_input->p->control[p_input->p->i_control].val = *p_val;
 210         else
 211             memset( &p_input->p->control[p_input->p->i_control].val, 0,
 212                     sizeof( vlc_value_t ) );
 213
 214         p_input->p->i_control++;
 215     }
 216     vlc_mutex_unlock( &p_input->p->lock_control );
 217 }
 218
 219 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
 220  * anyway. */
 221
 222 static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
 223 {
 224     bool send_event = false;
 225
 226     if( !p_i->p_meta )
 227         p_i->p_meta = vlc_meta_New();
 228
 229     vlc_mutex_lock( &p_i->lock );
 230     int new_status;
 231     if( preparsed )
 232         new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
 233     else
 234         new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
 235     if ( p_i->p_meta->i_status != new_status )
 236     {
 237         p_i->p_meta->i_status = new_status;
 238         send_event = true;
 239     }
 240
 241     vlc_mutex_unlock( &p_i->lock );
 242
 243     if ( send_event == true )
 244     {
 245         vlc_event_t event;
 246         event.type = vlc_InputItemPreparsedChanged;
 247         event.u.input_item_preparsed_changed.new_status = new_status;
 248         vlc_event_send( &p_i->event_manager, &event );
 249     }
 250 }
 251
 252 static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
 253 {
 254     if( !p_i->p_meta )
 255         p_i->p_meta = vlc_meta_New();
 256
 257     if( notfound )
 258         p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
 259     else
 260         p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
 261 }
 262
 263 static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
 264 {
 265     if( !p_i->p_meta )
 266         p_i->p_meta = vlc_meta_New();
 267
 268     if( artfetched )
 269         p_i->p_meta->i_status |= ITEM_ART_FETCHED;
 270     else
 271         p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
 272 }
 273
 274
 275 /**********************************************************************
 276  * Item metadata
 277  **********************************************************************/
 278 typedef struct playlist_album_t
 279 {
 280     char *psz_artist;
 281     char *psz_album;
 282     char *psz_arturl;
 283     bool b_found;
 284 } playlist_album_t;
 285
 286 int         input_ArtFind       ( playlist_t *, input_item_t * );
 287 int         input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
 288
 289 /* Becarefull; p_item lock HAS to be taken */
 290 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
 291
 292 /***************************************************************************
 293  * Internal prototypes
 294  ***************************************************************************/
 295
 296 /* misc/stats.c */
 297 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
 298
 299 /* input.c */
 300 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
 301 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
 302
 303 sout_instance_t * input_DetachSout( input_thread_t *p_input );
 304
 305 /* var.c */
 306 void input_ControlVarInit ( input_thread_t * );
 307 void input_ControlVarClean( input_thread_t * );
 308 void input_ControlVarNavigation( input_thread_t * );
 309 void input_ControlVarTitle( input_thread_t *, int i_title );
 310
 311 void input_ConfigVarInit ( input_thread_t * );
 312
 313 /* stream.c */
 314 stream_t *stream_AccessNew( access_t *p_access, bool );
 315 void stream_AccessDelete( stream_t *s );
 316 void stream_AccessReset( stream_t *s );
 317 void stream_AccessUpdate( stream_t *s );
 318
 319 /* decoder.c */
 320 void       input_DecoderDiscontinuity( decoder_t * p_dec, bool b_flush );
 321 bool input_DecoderEmpty( decoder_t * p_dec );
 322 int        input_DecoderSetCcState( decoder_t *, bool b_decode, int i_channel );
 323 int        input_DecoderGetCcState( decoder_t *, bool *pb_decode, int i_channel );
 324 void       input_DecoderIsCcPresent( decoder_t *, bool pb_present[4] );
 325
 326 /* es_out.c */
 327 es_out_t  *input_EsOutNew( input_thread_t *, int i_rate );
 328 void       input_EsOutDelete( es_out_t * );
 329 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
 330 void       input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
 331 void       input_EsOutChangeRate( es_out_t *, int );
 332 void       input_EsOutChangeState( es_out_t * );
 333 void       input_EsOutChangePosition( es_out_t * );
 334 bool input_EsOutDecodersEmpty( es_out_t * );
 335
 336 /* clock.c */
 337 enum /* Synchro states */
 338 {
 339     SYNCHRO_OK     = 0,
 340     SYNCHRO_START  = 1,
 341     SYNCHRO_REINIT = 2,
 342 };
 343
 344 typedef struct
 345 {
 346     /* Synchronization information */
 347     mtime_t                 delta_cr;
 348     mtime_t                 cr_ref, sysdate_ref;
 349     mtime_t                 last_sysdate;
 350     mtime_t                 last_cr; /* reference to detect unexpected stream
 351                                       * discontinuities                      */
 352     mtime_t                 last_pts;
 353     mtime_t                 last_update;
 354     int                     i_synchro_state;
 355
 356     bool              b_master;
 357
 358     int                     i_rate;
 359
 360     /* Config */
 361     int                     i_cr_average;
 362     int                     i_delta_cr_residue;
 363 } input_clock_t;
 364
 365 void    input_ClockInit( input_clock_t *, bool b_master, int i_cr_average, int i_rate );
 366 void    input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
 367 void    input_ClockResetPCR( input_clock_t * );
 368 mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
 369 void    input_ClockSetRate( input_clock_t *cl, int i_rate );
 370
 371 /* Subtitles */
 372 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
 373 int subtitles_Filter( const char *);
 374
 375 void MRLSplit( char *, const char **, const char **, char ** );
 376
 377 static inline void input_ChangeState( input_thread_t *p_input, int state )
 378 {
 379     var_SetInteger( p_input, "state", p_input->i_state = state );
 380 }
 381
 382 /* Access */
 383
 384 #define access_New( a, b, c, d ) __access_New(VLC_OBJECT(a), b, c, d )
 385 access_t * __access_New( vlc_object_t *p_obj, const char *psz_access,
 386                           const char *psz_demux, const char *psz_path );
 387 access_t * access_FilterNew( access_t *p_source,
 388                               const char *psz_access_filter );
 389 void access_Delete( access_t * );
 390
 391 /* Demuxer */
 392 #include <vlc_demux.h>
 393
 394 /* stream_t *s could be null and then it mean a access+demux in one */
 395 #define demux_New( a, b, c, d, e, f,g ) __demux_New(VLC_OBJECT(a),b,c,d,e,f,g)
 396 demux_t *__demux_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, bool );
 397
 398 void demux_Delete(demux_t *);
 399
 400 static inline int demux_Demux( demux_t *p_demux )
 401 {
 402     return p_demux->pf_demux( p_demux );
 403 }
 404 static inline int demux_vaControl( demux_t *p_demux, int i_query, va_list args )
 405 {
 406     return p_demux->pf_control( p_demux, i_query, args );
 407 }
 408 static inline int demux_Control( demux_t *p_demux, int i_query, ... )
 409 {
 410     va_list args;
 411     int     i_result;
 412
 413     va_start( args, i_query );
 414     i_result = demux_vaControl( p_demux, i_query, args );
 415     va_end( args );
 416     return i_result;
 417 }
 418
 419 /* Stream */
 420 /**
 421  * stream_t definition
 422  */
 423 struct stream_t
 424 {
 425     VLC_COMMON_MEMBERS
 426
 427     /*block_t *(*pf_block)  ( stream_t *, int i_size );*/
 428     int      (*pf_read)   ( stream_t *, void *p_read, int i_read );
 429     int      (*pf_peek)   ( stream_t *, const uint8_t **pp_peek, int i_peek );
 430     int      (*pf_control)( stream_t *, int i_query, va_list );
 431     void     (*pf_destroy)( stream_t *);
 432
 433     stream_sys_t *p_sys;
 434
 435     /* UTF-16 and UTF-32 file reading */
 436     vlc_iconv_t     conv;
 437     int             i_char_width;
 438     bool      b_little_endian;
 439 };
 440
 441 #include <libvlc.h>
 442
 443 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
 444 {
 445     return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
 446                                           VLC_OBJECT_STREAM, "stream" );
 447 }
 448
 449 #endif