input_internal.h 6.94 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 27
#if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
# error This header file can only be included from LibVLC.
#endif

Laurent Aimar's avatar
Laurent Aimar committed
28 29 30
#ifndef _INPUT_INTERNAL_H
#define _INPUT_INTERNAL_H 1

Clément Stenac's avatar
Clément Stenac committed
31 32 33
#include <vlc_access.h>
#include <vlc_demux.h>
#include <vlc_input.h>
34
#include <libvlc.h>
35
#include "input_interface.h"
36
#include "event.h"
Clément Stenac's avatar
Clément Stenac committed
37 38 39 40

/*****************************************************************************
 *  Private input fields
 *****************************************************************************/
41 42 43

#define INPUT_CONTROL_FIFO_SIZE    100

Clément Stenac's avatar
Clément Stenac committed
44 45 46 47 48 49 50 51 52 53 54 55
/* 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 */
Antoine Cellerier's avatar
Antoine Cellerier committed
56
    bool         b_title_demux; /* Titles/Seekpoints provided by demux */
Clément Stenac's avatar
Clément Stenac committed
57 58 59 60 61 62 63 64 65 66 67 68
    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 */
69 70 71
    bool b_can_pause;
    bool b_can_pace_control;
    bool b_can_rate_control;
72
    bool b_can_stream_record;
73
    bool b_rescale_ts;
74

Antoine Cellerier's avatar
Antoine Cellerier committed
75
    bool       b_eof;   /* eof of demuxer */
76
    double     f_fps;
Clément Stenac's avatar
Clément Stenac committed
77 78 79 80 81 82 83 84 85

    /* Clock average variation */
    int     i_cr_average;

} input_source_t;

/** Private input fields */
struct input_thread_private_t
{
86 87 88
    /* Object's event manager */
    vlc_event_manager_t event_manager;

Clément Stenac's avatar
Clément Stenac committed
89
    /* Global properties */
Antoine Cellerier's avatar
Antoine Cellerier committed
90 91
    bool        b_can_pause;
    bool        b_can_rate_control;
Clément Stenac's avatar
Clément Stenac committed
92 93

    int         i_rate;
94
    bool        b_recording;
Clément Stenac's avatar
Clément Stenac committed
95 96 97
    /* */
    int64_t     i_start;    /* :start-time,0 by default */
    int64_t     i_stop;     /* :stop-time, 0 if none */
98
    int64_t     i_run;      /* :run-time, 0 if none */
Clément Stenac's avatar
Clément Stenac committed
99 100 101 102 103 104 105 106 107 108 109 110

    /* 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;

111 112 113 114
    /* Input attachment */
    int i_attachment;
    input_attachment_t **attachment;

Clément Stenac's avatar
Clément Stenac committed
115
    /* Output */
Antoine Cellerier's avatar
Antoine Cellerier committed
116
    es_out_t        *p_es_out;
117
    es_out_t        *p_es_out_display;
Clément Stenac's avatar
Clément Stenac committed
118
    sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
Antoine Cellerier's avatar
Antoine Cellerier committed
119
    bool            b_out_pace_control; /*     idem ? */
Clément Stenac's avatar
Clément Stenac committed
120 121

    /* Main input properties */
122 123 124
    input_source_t      input;
    input_event_times_t input_last_times;

Clément Stenac's avatar
Clément Stenac committed
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
    /* 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;
151
    vlc_cond_t  wait_control;
Clément Stenac's avatar
Clément Stenac committed
152 153 154
    int i_control;
    struct
    {
155 156
        /* XXX for string value you have to allocate it before calling
         * input_ControlPush */
Clément Stenac's avatar
Clément Stenac committed
157 158 159 160 161 162 163 164
        int         i_type;
        vlc_value_t val;
    } control[INPUT_CONTROL_FIFO_SIZE];
};

/***************************************************************************
 * Internal control helpers
 ***************************************************************************/
Laurent Aimar's avatar
Laurent Aimar committed
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
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,
194
    INPUT_CONTROL_RESTART_ES,
195 196 197

    INPUT_CONTROL_SET_AUDIO_DELAY,
    INPUT_CONTROL_SET_SPU_DELAY,
198 199

    INPUT_CONTROL_ADD_SLAVE,
200

201 202
    INPUT_CONTROL_ADD_SUBTITLE,

203
    INPUT_CONTROL_SET_RECORD_STATE,
204 205

    INPUT_CONTROL_SET_FRAME_NEXT,
Laurent Aimar's avatar
Laurent Aimar committed
206 207 208
};

/* Internal helpers */
Laurent Aimar's avatar
Laurent Aimar committed
209
void input_ControlPush( input_thread_t *, int i_type, vlc_value_t * );
Laurent Aimar's avatar
Laurent Aimar committed
210

Clément Stenac's avatar
Clément Stenac committed
211 212 213
/**********************************************************************
 * Item metadata
 **********************************************************************/
214 215
/* input_ExtractAttachmentAndCacheArt:
 *  Becarefull; p_item lock HAS to be taken */
216 217
void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );

218 219
void input_item_SetErrorWhenReading( input_item_t *p_i, bool b_error );

Clément Stenac's avatar
Clément Stenac committed
220 221 222 223
/***************************************************************************
 * Internal prototypes
 ***************************************************************************/

Laurent Aimar's avatar
Laurent Aimar committed
224 225
/* var.c */
void input_ControlVarInit ( input_thread_t * );
226
void input_ControlVarStop( input_thread_t * );
Laurent Aimar's avatar
Laurent Aimar committed
227 228 229 230 231 232
void input_ControlVarNavigation( input_thread_t * );
void input_ControlVarTitle( input_thread_t *, int i_title );

void input_ConfigVarInit ( input_thread_t * );

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

236 237 238
/* Helpers FIXME to export without input_ prefix */
char *input_CreateFilename( vlc_object_t *p_obj, const char *psz_path, const char *psz_prefix, const char *psz_extension );

239
#define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"
240

241
#endif