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 #include <libvlc.h>
  35
  36 /*****************************************************************************
  37  *  Private input fields
  38  *****************************************************************************/
  39 /* input_source_t: gathers all information per input source */
  40 typedef struct
  41 {
  42     /* Input item description */
  43     input_item_t *p_item;
  44
  45     /* Access/Stream/Demux plugins */
  46     access_t *p_access;
  47     stream_t *p_stream;
  48     demux_t  *p_demux;
  49
  50     /* Title infos for that input */
  51     bool         b_title_demux; /* Titles/Seekpoints provided by demux */
  52     int          i_title;
  53     input_title_t **title;
  54
  55     int i_title_offset;
  56     int i_seekpoint_offset;
  57
  58     int i_title_start;
  59     int i_title_end;
  60     int i_seekpoint_start;
  61     int i_seekpoint_end;
  62
  63     /* Properties */
  64     bool b_can_pause;
  65     bool b_can_pace_control;
  66     bool b_can_rate_control;
  67     bool b_can_stream_record;
  68     bool b_rescale_ts;
  69
  70     bool       b_eof;   /* eof of demuxer */
  71     double     f_fps;
  72
  73     /* Clock average variation */
  74     int     i_cr_average;
  75
  76 } input_source_t;
  77
  78 /** Private input fields */
  79 struct input_thread_private_t
  80 {
  81     /* Object's event manager */
  82     vlc_event_manager_t event_manager;
  83
  84     /* Global properties */
  85     bool        b_can_pause;
  86     bool        b_can_rate_control;
  87
  88     int         i_rate;
  89     bool        b_recording;
  90     /* */
  91     int64_t     i_start;    /* :start-time,0 by default */
  92     int64_t     i_stop;     /* :stop-time, 0 if none */
  93     int64_t     i_run;      /* :run-time, 0 if none */
  94
  95     /* Title infos FIXME multi-input (not easy) ? */
  96     int          i_title;
  97     input_title_t **title;
  98
  99     int i_title_offset;
 100     int i_seekpoint_offset;
 101
 102     /* User bookmarks FIXME won't be easy with multiples input */
 103     int         i_bookmark;
 104     seekpoint_t **bookmark;
 105
 106     /* Input attachment */
 107     int i_attachment;
 108     input_attachment_t **attachment;
 109
 110     /* Output */
 111     es_out_t        *p_es_out;
 112     es_out_t        *p_es_out_display;
 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     /* 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     vlc_cond_t  wait_control;
 145     int i_control;
 146     struct
 147     {
 148         /* XXX for string value you have to allocate it before calling
 149          * input_ControlPush */
 150         int         i_type;
 151         vlc_value_t val;
 152     } control[INPUT_CONTROL_FIFO_SIZE];
 153 };
 154
 155 /***************************************************************************
 156  * Internal control helpers
 157  ***************************************************************************/
 158 enum input_control_e
 159 {
 160     INPUT_CONTROL_SET_DIE,
 161
 162     INPUT_CONTROL_SET_STATE,
 163
 164     INPUT_CONTROL_SET_RATE,
 165     INPUT_CONTROL_SET_RATE_SLOWER,
 166     INPUT_CONTROL_SET_RATE_FASTER,
 167
 168     INPUT_CONTROL_SET_POSITION,
 169     INPUT_CONTROL_SET_POSITION_OFFSET,
 170
 171     INPUT_CONTROL_SET_TIME,
 172     INPUT_CONTROL_SET_TIME_OFFSET,
 173
 174     INPUT_CONTROL_SET_PROGRAM,
 175
 176     INPUT_CONTROL_SET_TITLE,
 177     INPUT_CONTROL_SET_TITLE_NEXT,
 178     INPUT_CONTROL_SET_TITLE_PREV,
 179
 180     INPUT_CONTROL_SET_SEEKPOINT,
 181     INPUT_CONTROL_SET_SEEKPOINT_NEXT,
 182     INPUT_CONTROL_SET_SEEKPOINT_PREV,
 183
 184     INPUT_CONTROL_SET_BOOKMARK,
 185
 186     INPUT_CONTROL_SET_ES,
 187     INPUT_CONTROL_RESTART_ES,
 188
 189     INPUT_CONTROL_SET_AUDIO_DELAY,
 190     INPUT_CONTROL_SET_SPU_DELAY,
 191
 192     INPUT_CONTROL_ADD_SLAVE,
 193
 194     INPUT_CONTROL_ADD_SUBTITLE,
 195
 196     INPUT_CONTROL_SET_RECORD_STATE,
 197
 198     INPUT_CONTROL_SET_FRAME_NEXT,
 199 };
 200
 201 /* Internal helpers */
 202 static inline void input_ControlPush( input_thread_t *p_input,
 203                                       int i_type, vlc_value_t *p_val )
 204 {
 205     vlc_mutex_lock( &p_input->p->lock_control );
 206     if( i_type == INPUT_CONTROL_SET_DIE )
 207     {
 208         /* Special case, empty the control */
 209         p_input->p->i_control = 1;
 210         p_input->p->control[0].i_type = i_type;
 211         memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
 212     }
 213     else if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
 214     {
 215         msg_Err( p_input, "input control fifo overflow, trashing type=%d",
 216                  i_type );
 217     }
 218     else
 219     {
 220         p_input->p->control[p_input->p->i_control].i_type = i_type;
 221         if( p_val )
 222             p_input->p->control[p_input->p->i_control].val = *p_val;
 223         else
 224             memset( &p_input->p->control[p_input->p->i_control].val, 0,
 225                     sizeof( vlc_value_t ) );
 226
 227         p_input->p->i_control++;
 228     }
 229     vlc_cond_signal( &p_input->p->wait_control );
 230     vlc_mutex_unlock( &p_input->p->lock_control );
 231 }
 232
 233 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
 234  * anyway. */
 235
 236 static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
 237 {
 238     bool send_event = false;
 239
 240     if( !p_i->p_meta )
 241         p_i->p_meta = vlc_meta_New();
 242
 243     vlc_mutex_lock( &p_i->lock );
 244     int new_status;
 245     if( preparsed )
 246         new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
 247     else
 248         new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
 249     if( p_i->p_meta->i_status != new_status )
 250     {
 251         p_i->p_meta->i_status = new_status;
 252         send_event = true;
 253     }
 254
 255     vlc_mutex_unlock( &p_i->lock );
 256
 257     if( send_event )
 258     {
 259         vlc_event_t event;
 260         event.type = vlc_InputItemPreparsedChanged;
 261         event.u.input_item_preparsed_changed.new_status = new_status;
 262         vlc_event_send( &p_i->event_manager, &event );
 263     }
 264 }
 265
 266 static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
 267 {
 268     if( !p_i->p_meta )
 269         p_i->p_meta = vlc_meta_New();
 270
 271     if( notfound )
 272         p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
 273     else
 274         p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
 275 }
 276
 277 static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
 278 {
 279     if( !p_i->p_meta )
 280         p_i->p_meta = vlc_meta_New();
 281
 282     if( artfetched )
 283         p_i->p_meta->i_status |= ITEM_ART_FETCHED;
 284     else
 285         p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
 286 }
 287
 288 void input_item_SetHasErrorWhenReading( input_item_t *p_i, bool error );
 289
 290 /**********************************************************************
 291  * Item metadata
 292  **********************************************************************/
 293 typedef struct playlist_album_t
 294 {
 295     char *psz_artist;
 296     char *psz_album;
 297     char *psz_arturl;
 298     bool b_found;
 299 } playlist_album_t;
 300
 301 int         input_ArtFind       ( playlist_t *, input_item_t * );
 302 int         input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
 303
 304 /* Becarefull; p_item lock HAS to be taken */
 305 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
 306
 307 /***************************************************************************
 308  * Internal prototypes
 309  ***************************************************************************/
 310
 311 /* misc/stats.c */
 312 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
 313
 314 /* input.c */
 315 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
 316 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
 317
 318 sout_instance_t * input_DetachSout( input_thread_t *p_input );
 319
 320 /* var.c */
 321 void input_ControlVarInit ( input_thread_t * );
 322 void input_ControlVarStop( input_thread_t * );
 323 void input_ControlVarNavigation( input_thread_t * );
 324 void input_ControlVarTitle( input_thread_t *, int i_title );
 325
 326 void input_ConfigVarInit ( input_thread_t * );
 327
 328 /* Subtitles */
 329 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
 330 int subtitles_Filter( const char *);
 331
 332 static inline void input_ChangeStateWithVarCallback( input_thread_t *p_input, int i_state, bool callback )
 333 {
 334     const bool changed = p_input->i_state != i_state;
 335
 336     p_input->i_state = i_state;
 337     if( i_state == ERROR_S )
 338         p_input->b_error = true;
 339     else if( i_state == END_S )
 340         p_input->b_eof = true;
 341
 342     input_item_SetHasErrorWhenReading( p_input->p->input.p_item, (i_state == ERROR_S) );
 343
 344     if( callback )
 345     {
 346         var_SetInteger( p_input, "state", i_state );
 347     }
 348     else
 349     {
 350         vlc_value_t val;
 351         val.i_int = i_state;
 352         var_Change( p_input, "state", VLC_VAR_SETVALUE, &val, NULL );
 353     }
 354     if( changed )
 355     {
 356         vlc_event_t event;
 357         event.type = vlc_InputStateChanged;
 358         event.u.input_state_changed.new_state = i_state;
 359         vlc_event_send( &p_input->p->event_manager, &event );
 360     }
 361 }
 362
 363 static inline void input_ChangeState( input_thread_t *p_input, int state )
 364 {
 365     input_ChangeStateWithVarCallback( p_input, state, true );
 366 }
 367
 368 /* Helpers FIXME to export without input_ prefix */
 369 char *input_CreateFilename( vlc_object_t *p_obj, const char *psz_path, const char *psz_prefix, const char *psz_extension );
 370
 371 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"
 372
 373 #endif