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