input_internal.h 11.9 KB
Newer Older
Laurent Aimar's avatar
Laurent Aimar committed
1
/*****************************************************************************
Clément Stenac's avatar
Clément Stenac committed
2
 * input_internal.h: Internal input structures
Laurent Aimar's avatar
Laurent Aimar committed
3
 *****************************************************************************
Clément Stenac's avatar
Clément Stenac committed
4
 * Copyright (C) 1998-2006 the VideoLAN team
Antoine Cellerier's avatar
Antoine Cellerier committed
5
 * $Id$
Laurent Aimar's avatar
Laurent Aimar committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Laurent Aimar's avatar
Laurent Aimar committed
22 23 24 25 26
 *****************************************************************************/

#ifndef _INPUT_INTERNAL_H
#define _INPUT_INTERNAL_H 1

Clément Stenac's avatar
Clément Stenac committed
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
#include <vlc_access.h>
#include <vlc_demux.h>
#include <vlc_input.h>

/*****************************************************************************
 *  Private input fields
 *****************************************************************************/
/* input_source_t: gathers all information per input source */
typedef struct
{
    /* Input item description */
    input_item_t *p_item;

    /* Access/Stream/Demux plugins */
    access_t *p_access;
    stream_t *p_stream;
    demux_t  *p_demux;

    /* Title infos for that input */
    vlc_bool_t   b_title_demux; /* Titles/Seekpoints provided by demux */
    int          i_title;
    input_title_t **title;

    int i_title_offset;
    int i_seekpoint_offset;

    int i_title_start;
    int i_title_end;
    int i_seekpoint_start;
    int i_seekpoint_end;

    /* Properties */
    vlc_bool_t b_can_pace_control;
    vlc_bool_t b_can_pause;
    vlc_bool_t b_eof;   /* eof of demuxer */

    /* Clock average variation */
    int     i_cr_average;

} input_source_t;

/** Private input fields */
struct input_thread_private_t
{
    /* Global properties */
    vlc_bool_t  b_can_pause;

    int         i_rate;
    /* */
    int64_t     i_start;    /* :start-time,0 by default */
    int64_t     i_stop;     /* :stop-time, 0 if none */

    /* Title infos FIXME multi-input (not easy) ? */
    int          i_title;
    input_title_t **title;

    int i_title_offset;
    int i_seekpoint_offset;

    /* User bookmarks FIXME won't be easy with multiples input */
    int         i_bookmark;
    seekpoint_t **bookmark;

90 91 92 93
    /* Input attachment */
    int i_attachment;
    input_attachment_t **attachment;

Clément Stenac's avatar
Clément Stenac committed
94 95 96
    /* Output */
    es_out_t    *p_es_out;
    sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
97
    vlc_bool_t      b_sout_keep;
Clément Stenac's avatar
Clément Stenac committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
    vlc_bool_t      b_out_pace_control; /*     idem ? */

    /* Main input properties */
    input_source_t input;
    /* Slave demuxers (subs, and others) */
    int            i_slave;
    input_source_t **slave;

    /* Stats counters */
    struct {
        counter_t *p_read_packets;
        counter_t *p_read_bytes;
        counter_t *p_input_bitrate;
        counter_t *p_demux_read;
        counter_t *p_demux_bitrate;
        counter_t *p_decoded_audio;
        counter_t *p_decoded_video;
        counter_t *p_decoded_sub;
        counter_t *p_sout_sent_packets;
        counter_t *p_sout_sent_bytes;
        counter_t *p_sout_send_bitrate;
        counter_t *p_played_abuffers;
        counter_t *p_lost_abuffers;
        counter_t *p_displayed_pictures;
        counter_t *p_lost_pictures;
        vlc_mutex_t counters_lock;
    } counters;

    /* Buffer of pending actions */
    vlc_mutex_t lock_control;
    int i_control;
    struct
    {
131 132
        /* XXX for string value you have to allocate it before calling
         * input_ControlPush */
Clément Stenac's avatar
Clément Stenac committed
133 134 135 136 137 138 139 140
        int         i_type;
        vlc_value_t val;
    } control[INPUT_CONTROL_FIFO_SIZE];
};

/***************************************************************************
 * Internal control helpers
 ***************************************************************************/
Laurent Aimar's avatar
Laurent Aimar committed
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
enum input_control_e
{
    INPUT_CONTROL_SET_DIE,

    INPUT_CONTROL_SET_STATE,

    INPUT_CONTROL_SET_RATE,
    INPUT_CONTROL_SET_RATE_SLOWER,
    INPUT_CONTROL_SET_RATE_FASTER,

    INPUT_CONTROL_SET_POSITION,
    INPUT_CONTROL_SET_POSITION_OFFSET,

    INPUT_CONTROL_SET_TIME,
    INPUT_CONTROL_SET_TIME_OFFSET,

    INPUT_CONTROL_SET_PROGRAM,

    INPUT_CONTROL_SET_TITLE,
    INPUT_CONTROL_SET_TITLE_NEXT,
    INPUT_CONTROL_SET_TITLE_PREV,

    INPUT_CONTROL_SET_SEEKPOINT,
    INPUT_CONTROL_SET_SEEKPOINT_NEXT,
    INPUT_CONTROL_SET_SEEKPOINT_PREV,

    INPUT_CONTROL_SET_BOOKMARK,

    INPUT_CONTROL_SET_ES,
170 171 172

    INPUT_CONTROL_SET_AUDIO_DELAY,
    INPUT_CONTROL_SET_SPU_DELAY,
173 174

    INPUT_CONTROL_ADD_SLAVE,
Laurent Aimar's avatar
Laurent Aimar committed
175 176 177 178 179 180
};

/* Internal helpers */
static inline void input_ControlPush( input_thread_t *p_input,
                                      int i_type, vlc_value_t *p_val )
{
Clément Stenac's avatar
Clément Stenac committed
181
    vlc_mutex_lock( &p_input->p->lock_control );
Laurent Aimar's avatar
Laurent Aimar committed
182 183 184
    if( i_type == INPUT_CONTROL_SET_DIE )
    {
        /* Special case, empty the control */
Clément Stenac's avatar
Clément Stenac committed
185 186 187
        p_input->p->i_control = 1;
        p_input->p->control[0].i_type = i_type;
        memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
Laurent Aimar's avatar
Laurent Aimar committed
188 189 190
    }
    else
    {
Clément Stenac's avatar
Clément Stenac committed
191
        if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
Laurent Aimar's avatar
Laurent Aimar committed
192 193 194
        {
            msg_Err( p_input, "input control fifo overflow, trashing type=%d",
                     i_type );
Clément Stenac's avatar
Clément Stenac committed
195
            vlc_mutex_unlock( &p_input->p->lock_control );
Laurent Aimar's avatar
Laurent Aimar committed
196 197
            return;
        }
Clément Stenac's avatar
Clément Stenac committed
198
        p_input->p->control[p_input->p->i_control].i_type = i_type;
Laurent Aimar's avatar
Laurent Aimar committed
199
        if( p_val )
Clément Stenac's avatar
Clément Stenac committed
200
            p_input->p->control[p_input->p->i_control].val = *p_val;
Laurent Aimar's avatar
Laurent Aimar committed
201
        else
Clément Stenac's avatar
Clément Stenac committed
202
            memset( &p_input->p->control[p_input->p->i_control].val, 0,
Laurent Aimar's avatar
Laurent Aimar committed
203 204
                    sizeof( vlc_value_t ) );

Clément Stenac's avatar
Clément Stenac committed
205
        p_input->p->i_control++;
Laurent Aimar's avatar
Laurent Aimar committed
206
    }
Clément Stenac's avatar
Clément Stenac committed
207
    vlc_mutex_unlock( &p_input->p->lock_control );
Laurent Aimar's avatar
Laurent Aimar committed
208 209
}

Clément Stenac's avatar
Clément Stenac committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
/**********************************************************************
 * Item metadata
 **********************************************************************/
typedef struct playlist_album_t
{
    char *psz_artist;
    char *psz_album;
    vlc_bool_t b_found;
} playlist_album_t;

int         input_MetaFetch     ( playlist_t *, input_item_t * );
int         input_ArtFind       ( playlist_t *, input_item_t * );
vlc_bool_t  input_MetaSatisfied ( playlist_t*, input_item_t*,
                                  uint32_t*, uint32_t* );
int         input_DownloadAndCacheArt ( playlist_t *, input_item_t * );

226 227 228
/* Becarefull; p_item lock HAS to be taken */
void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );

Clément Stenac's avatar
Clément Stenac committed
229 230 231 232
/***************************************************************************
 * Internal prototypes
 ***************************************************************************/

233 234 235
/* misc/stats.c */
input_stats_t *stats_NewInputStats( input_thread_t *p_input );

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
236
/* input.c */
237 238 239 240
#define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );

void input_DestroyThreadExtended( input_thread_t *p_input, sout_instance_t ** );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
241

Laurent Aimar's avatar
Laurent Aimar committed
242 243 244 245 246 247 248 249 250
/* var.c */
void input_ControlVarInit ( input_thread_t * );
void input_ControlVarClean( input_thread_t * );
void input_ControlVarNavigation( input_thread_t * );
void input_ControlVarTitle( input_thread_t *, int i_title );

void input_ConfigVarInit ( input_thread_t * );

/* stream.c */
251
stream_t *stream_AccessNew( access_t *p_access, vlc_bool_t );
Laurent Aimar's avatar
Laurent Aimar committed
252 253
void stream_AccessDelete( stream_t *s );
void stream_AccessReset( stream_t *s );
254
void stream_AccessUpdate( stream_t *s );
Laurent Aimar's avatar
Laurent Aimar committed
255

256
/* decoder.c */
257
void       input_DecoderDiscontinuity( decoder_t * p_dec, vlc_bool_t b_flush );
Laurent Aimar's avatar
 
Laurent Aimar committed
258
vlc_bool_t input_DecoderEmpty( decoder_t * p_dec );
Laurent Aimar's avatar
Laurent Aimar committed
259 260

/* es_out.c */
Laurent Aimar's avatar
 
Laurent Aimar committed
261 262
es_out_t  *input_EsOutNew( input_thread_t * );
void       input_EsOutDelete( es_out_t * );
Laurent Aimar's avatar
Laurent Aimar committed
263
es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
264
void       input_EsOutDiscontinuity( es_out_t *, vlc_bool_t b_flush, vlc_bool_t b_audio );
Laurent Aimar's avatar
 
Laurent Aimar committed
265
void       input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
266
void       input_EsOutSetRate( es_out_t * );
Laurent Aimar's avatar
 
Laurent Aimar committed
267
vlc_bool_t input_EsOutDecodersEmpty( es_out_t * );
Laurent Aimar's avatar
Laurent Aimar committed
268 269 270 271 272 273 274 275 276 277 278 279 280 281

/* clock.c */
enum /* Synchro states */
{
    SYNCHRO_OK     = 0,
    SYNCHRO_START  = 1,
    SYNCHRO_REINIT = 2,
};

typedef struct
{
    /* Synchronization information */
    mtime_t                 delta_cr;
    mtime_t                 cr_ref, sysdate_ref;
282
    mtime_t                 last_sysdate;
Laurent Aimar's avatar
Laurent Aimar committed
283 284 285
    mtime_t                 last_cr; /* reference to detect unexpected stream
                                      * discontinuities                      */
    mtime_t                 last_pts;
286
    mtime_t                 last_update;
Laurent Aimar's avatar
Laurent Aimar committed
287 288 289 290
    int                     i_synchro_state;

    vlc_bool_t              b_master;

291 292
    int                     i_rate;

Laurent Aimar's avatar
Laurent Aimar committed
293 294
    /* Config */
    int                     i_cr_average;
295
    int                     i_delta_cr_residue;
Laurent Aimar's avatar
Laurent Aimar committed
296 297
} input_clock_t;

298
void    input_ClockInit( input_thread_t *, input_clock_t *, vlc_bool_t b_master, int i_cr_average );
Laurent Aimar's avatar
Laurent Aimar committed
299 300
void    input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
301
void    input_ClockSetRate( input_thread_t *, input_clock_t *cl );
Laurent Aimar's avatar
Laurent Aimar committed
302 303

/* Subtitles */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
304
char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
305 306
int subtitles_Filter( const char *);

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
307
void MRLSplit( vlc_object_t *, char *, const char **, const char **, char ** );
Laurent Aimar's avatar
Laurent Aimar committed
308

309 310 311
static inline void input_ChangeState( input_thread_t *p_input, int state )
{
    vlc_value_t val;
312
    val.i_int = p_input->i_state = state;
313 314 315
    var_Change( p_input, "state", VLC_VAR_SETVALUE, &val, NULL );
}

Clément Stenac's avatar
Clément Stenac committed
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
/* Access */

#define access2_New( a, b, c, d, e ) __access2_New(VLC_OBJECT(a), b, c, d, e )
access_t * __access2_New( vlc_object_t *p_obj, const char *psz_access,
                          const char *psz_demux, const char *psz_path,
                          vlc_bool_t b_quick );
access_t * access2_FilterNew( access_t *p_source,
                              const char *psz_access_filter );
void access2_Delete( access_t * );

/* Demuxer */
#include <vlc_demux.h>

/* stream_t *s could be null and then it mean a access+demux in one */
#define demux2_New( a, b, c, d, e, f,g ) __demux2_New(VLC_OBJECT(a),b,c,d,e,f,g)
demux_t *__demux2_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, vlc_bool_t );

void demux2_Delete(demux_t *);

static inline int demux2_Demux( demux_t *p_demux )
{
    return p_demux->pf_demux( p_demux );
}
static inline int demux2_vaControl( demux_t *p_demux, int i_query, va_list args )
{
    return p_demux->pf_control( p_demux, i_query, args );
}
static inline int demux2_Control( demux_t *p_demux, int i_query, ... )
{
    va_list args;
    int     i_result;

    va_start( args, i_query );
    i_result = demux2_vaControl( p_demux, i_query, args );
    va_end( args );
    return i_result;
}

354
#if defined(__PLUGIN__) || defined(__BUILTIN__)
355
# warning CAN'T YOU SEE THIS IS AN INTERNAL HEADER?! '
356
#else
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
/* Stream */
/**
 * stream_t definition
 */
struct stream_t
{
    VLC_COMMON_MEMBERS

    block_t *(*pf_block)  ( stream_t *, int i_size );
    int      (*pf_read)   ( stream_t *, void *p_read, int i_read );
    int      (*pf_peek)   ( stream_t *, uint8_t **pp_peek, int i_peek );
    int      (*pf_control)( stream_t *, int i_query, va_list );
    void     (*pf_destroy)( stream_t *);

    stream_sys_t *p_sys;

    /* UTF-16 and UTF-32 file reading */
    vlc_iconv_t     conv;
    int             i_char_width;
    vlc_bool_t      b_little_endian;
};

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
379
#include <libvlc.h>
380 381 382 383 384 385

static inline stream_t *vlc_stream_create( vlc_object_t *obj )
{
    return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
                                          VLC_OBJECT_STREAM, "stream" );
}
Laurent Aimar's avatar
Laurent Aimar committed
386
#endif
387 388

#endif