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     /* pts delay fixup */
 116     struct {
 117         int  i_num_faulty;
 118         bool to_high;
 119         bool auto_adjust;
 120     } pts_adjust;
 121
 122     /* Stats counters */
 123     struct {
 124         counter_t *p_read_packets;
 125         counter_t *p_read_bytes;
 126         counter_t *p_input_bitrate;
 127         counter_t *p_demux_read;
 128         counter_t *p_demux_bitrate;
 129         counter_t *p_decoded_audio;
 130         counter_t *p_decoded_video;
 131         counter_t *p_decoded_sub;
 132         counter_t *p_sout_sent_packets;
 133         counter_t *p_sout_sent_bytes;
 134         counter_t *p_sout_send_bitrate;
 135         counter_t *p_played_abuffers;
 136         counter_t *p_lost_abuffers;
 137         counter_t *p_displayed_pictures;
 138         counter_t *p_lost_pictures;
 139         vlc_mutex_t counters_lock;
 140     } counters;
 141
 142     /* Buffer of pending actions */
 143     vlc_mutex_t lock_control;
 144     int i_control;
 145     struct
 146     {
 147         /* XXX for string value you have to allocate it before calling
 148          * input_ControlPush */
 149         int         i_type;
 150         vlc_value_t val;
 151     } control[INPUT_CONTROL_FIFO_SIZE];
 152 };
 153
 154 /***************************************************************************
 155  * Internal control helpers
 156  ***************************************************************************/
 157 enum input_control_e
 158 {
 159     INPUT_CONTROL_SET_DIE,
 160
 161     INPUT_CONTROL_SET_STATE,
 162
 163     INPUT_CONTROL_SET_RATE,
 164     INPUT_CONTROL_SET_RATE_SLOWER,
 165     INPUT_CONTROL_SET_RATE_FASTER,
 166
 167     INPUT_CONTROL_SET_POSITION,
 168     INPUT_CONTROL_SET_POSITION_OFFSET,
 169
 170     INPUT_CONTROL_SET_TIME,
 171     INPUT_CONTROL_SET_TIME_OFFSET,
 172
 173     INPUT_CONTROL_SET_PROGRAM,
 174
 175     INPUT_CONTROL_SET_TITLE,
 176     INPUT_CONTROL_SET_TITLE_NEXT,
 177     INPUT_CONTROL_SET_TITLE_PREV,
 178
 179     INPUT_CONTROL_SET_SEEKPOINT,
 180     INPUT_CONTROL_SET_SEEKPOINT_NEXT,
 181     INPUT_CONTROL_SET_SEEKPOINT_PREV,
 182
 183     INPUT_CONTROL_SET_BOOKMARK,
 184
 185     INPUT_CONTROL_SET_ES,
 186
 187     INPUT_CONTROL_SET_AUDIO_DELAY,
 188     INPUT_CONTROL_SET_SPU_DELAY,
 189
 190     INPUT_CONTROL_ADD_SLAVE,
 191 };
 192
 193 /* Internal helpers */
 194 static inline void input_ControlPush( input_thread_t *p_input,
 195                                       int i_type, vlc_value_t *p_val )
 196 {
 197     vlc_mutex_lock( &p_input->p->lock_control );
 198     if( i_type == INPUT_CONTROL_SET_DIE )
 199     {
 200         /* Special case, empty the control */
 201         p_input->p->i_control = 1;
 202         p_input->p->control[0].i_type = i_type;
 203         memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
 204     }
 205     else
 206     {
 207         if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
 208         {
 209             msg_Err( p_input, "input control fifo overflow, trashing type=%d",
 210                      i_type );
 211             vlc_mutex_unlock( &p_input->p->lock_control );
 212             return;
 213         }
 214         p_input->p->control[p_input->p->i_control].i_type = i_type;
 215         if( p_val )
 216             p_input->p->control[p_input->p->i_control].val = *p_val;
 217         else
 218             memset( &p_input->p->control[p_input->p->i_control].val, 0,
 219                     sizeof( vlc_value_t ) );
 220
 221         p_input->p->i_control++;
 222     }
 223     vlc_mutex_unlock( &p_input->p->lock_control );
 224 }
 225
 226 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
 227  * anyway. */
 228
 229 static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
 230 {
 231     bool send_event = false;
 232
 233     if( !p_i->p_meta )
 234         p_i->p_meta = vlc_meta_New();
 235
 236     vlc_mutex_lock( &p_i->lock );
 237     int new_status;
 238     if( preparsed )
 239         new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
 240     else
 241         new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
 242     if ( p_i->p_meta->i_status != new_status )
 243     {
 244         p_i->p_meta->i_status = new_status;
 245         send_event = true;
 246     }
 247
 248     vlc_mutex_unlock( &p_i->lock );
 249
 250     if ( send_event == true )
 251     {
 252         vlc_event_t event;
 253         event.type = vlc_InputItemPreparsedChanged;
 254         event.u.input_item_preparsed_changed.new_status = new_status;
 255         vlc_event_send( &p_i->event_manager, &event );
 256     }
 257 }
 258
 259 static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
 260 {
 261     if( !p_i->p_meta )
 262         p_i->p_meta = vlc_meta_New();
 263
 264     if( notfound )
 265         p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
 266     else
 267         p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
 268 }
 269
 270 static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
 271 {
 272     if( !p_i->p_meta )
 273         p_i->p_meta = vlc_meta_New();
 274
 275     if( artfetched )
 276         p_i->p_meta->i_status |= ITEM_ART_FETCHED;
 277     else
 278         p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
 279 }
 280
 281
 282 /**********************************************************************
 283  * Item metadata
 284  **********************************************************************/
 285 typedef struct playlist_album_t
 286 {
 287     char *psz_artist;
 288     char *psz_album;
 289     char *psz_arturl;
 290     bool b_found;
 291 } playlist_album_t;
 292
 293 int         input_ArtFind       ( playlist_t *, input_item_t * );
 294 int         input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
 295
 296 /* Becarefull; p_item lock HAS to be taken */
 297 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
 298
 299 /***************************************************************************
 300  * Internal prototypes
 301  ***************************************************************************/
 302
 303 /* misc/stats.c */
 304 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
 305
 306 /* input.c */
 307 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
 308 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
 309
 310 sout_instance_t * input_DetachSout( input_thread_t *p_input );
 311
 312 /* var.c */
 313 void input_ControlVarInit ( input_thread_t * );
 314 void input_ControlVarClean( input_thread_t * );
 315 void input_ControlVarNavigation( input_thread_t * );
 316 void input_ControlVarTitle( input_thread_t *, int i_title );
 317
 318 void input_ConfigVarInit ( input_thread_t * );
 319
 320 /* stream.c */
 321 stream_t *stream_AccessNew( access_t *p_access, bool );
 322 void stream_AccessDelete( stream_t *s );
 323 void stream_AccessReset( stream_t *s );
 324 void stream_AccessUpdate( stream_t *s );
 325
 326 /* decoder.c */
 327 void       input_DecoderDiscontinuity( decoder_t * p_dec, bool b_flush );
 328 bool input_DecoderEmpty( decoder_t * p_dec );
 329 int        input_DecoderSetCcState( decoder_t *, bool b_decode, int i_channel );
 330 int        input_DecoderGetCcState( decoder_t *, bool *pb_decode, int i_channel );
 331 void       input_DecoderIsCcPresent( decoder_t *, bool pb_present[4] );
 332
 333 /* es_out.c */
 334 es_out_t  *input_EsOutNew( input_thread_t *, int i_rate );
 335 void       input_EsOutDelete( es_out_t * );
 336 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
 337 void       input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
 338 void       input_EsOutChangeRate( es_out_t *, int );
 339 void       input_EsOutChangeState( es_out_t * );
 340 void       input_EsOutChangePosition( es_out_t * );
 341 bool input_EsOutDecodersEmpty( es_out_t * );
 342
 343 /* clock.c */
 344 enum /* Synchro states */
 345 {
 346     SYNCHRO_OK     = 0,
 347     SYNCHRO_START  = 1,
 348     SYNCHRO_REINIT = 2,
 349 };
 350
 351 typedef struct
 352 {
 353     /* Synchronization information */
 354     mtime_t                 delta_cr;
 355     mtime_t                 cr_ref, sysdate_ref;
 356     mtime_t                 last_sysdate;
 357     mtime_t                 last_cr; /* reference to detect unexpected stream
 358                                       * discontinuities                      */
 359     mtime_t                 last_pts;
 360     mtime_t                 last_update;
 361     int                     i_synchro_state;
 362
 363     bool              b_master;
 364
 365     int                     i_rate;
 366
 367     /* Config */
 368     int                     i_cr_average;
 369     int                     i_delta_cr_residue;
 370 } input_clock_t;
 371
 372 void    input_ClockInit( input_clock_t *, bool b_master, int i_cr_average, int i_rate );
 373 void    input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
 374 void    input_ClockResetPCR( input_clock_t * );
 375 mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
 376 void    input_ClockSetRate( input_clock_t *cl, int i_rate );
 377
 378 /* Subtitles */
 379 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
 380 int subtitles_Filter( const char *);
 381
 382 void MRLSplit( char *, const char **, const char **, char ** );
 383
 384 static inline void input_ChangeState( input_thread_t *p_input, int state )
 385 {
 386     var_SetInteger( p_input, "state", p_input->i_state = state );
 387 }
 388
 389 /* Access */
 390
 391 #define access_New( a, b, c, d ) __access_New(VLC_OBJECT(a), b, c, d )
 392 access_t * __access_New( vlc_object_t *p_obj, const char *psz_access,
 393                           const char *psz_demux, const char *psz_path );
 394 access_t * access_FilterNew( access_t *p_source,
 395                               const char *psz_access_filter );
 396 void access_Delete( access_t * );
 397
 398 /* Demuxer */
 399 #include <vlc_demux.h>
 400
 401 /* stream_t *s could be null and then it mean a access+demux in one */
 402 #define demux_New( a, b, c, d, e, f,g ) __demux_New(VLC_OBJECT(a),b,c,d,e,f,g)
 403 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 );
 404
 405 void demux_Delete(demux_t *);
 406
 407 static inline int demux_Demux( demux_t *p_demux )
 408 {
 409     return p_demux->pf_demux( p_demux );
 410 }
 411 static inline int demux_vaControl( demux_t *p_demux, int i_query, va_list args )
 412 {
 413     return p_demux->pf_control( p_demux, i_query, args );
 414 }
 415 static inline int demux_Control( demux_t *p_demux, int i_query, ... )
 416 {
 417     va_list args;
 418     int     i_result;
 419
 420     va_start( args, i_query );
 421     i_result = demux_vaControl( p_demux, i_query, args );
 422     va_end( args );
 423     return i_result;
 424 }
 425
 426 /* Stream */
 427 /**
 428  * stream_t definition
 429  */
 430 struct stream_t
 431 {
 432     VLC_COMMON_MEMBERS
 433
 434     /*block_t *(*pf_block)  ( stream_t *, int i_size );*/
 435     int      (*pf_read)   ( stream_t *, void *p_read, int i_read );
 436     int      (*pf_peek)   ( stream_t *, const uint8_t **pp_peek, int i_peek );
 437     int      (*pf_control)( stream_t *, int i_query, va_list );
 438     void     (*pf_destroy)( stream_t *);
 439
 440     stream_sys_t *p_sys;
 441
 442     /* UTF-16 and UTF-32 file reading */
 443     vlc_iconv_t     conv;
 444     int             i_char_width;
 445     bool      b_little_endian;
 446 };
 447
 448 #include <libvlc.h>
 449
 450 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
 451 {
 452     return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
 453                                           VLC_OBJECT_STREAM, "stream" );
 454 }
 455
 456 #endif