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