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