vlc_sout.h 7.78 KB
Newer Older
1
2
3
/*****************************************************************************
 * stream_output.h : stream output module
 *****************************************************************************
4
 * Copyright (C) 2002-2007 the VideoLAN team
5
 * $Id$
6
7
 *
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
8
9
 *          Laurent Aimar <fenrir@via.ecp.fr>
 *          Eric Petit <titer@videolan.org>
10
 *          Jean-Paul Saman <jpsaman #_at_# m2x.nl>
11
12
13
14
15
 *
 * 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.
16
 *
17
18
19
20
21
22
23
 * 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
dionoea's avatar
dionoea committed
24
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25
26
 *****************************************************************************/

zorglub's avatar
zorglub committed
27
28
29
30
#if !defined( __LIBVLC__ )
  #error You are not libvlc or one of its plugins. You cannot include this file
#endif

zorglub's avatar
zorglub committed
31
32
#ifndef _VLC_SOUT_H_
#define _VLC_SOUT_H_
33

zorglub's avatar
zorglub committed
34
35
36
#ifdef __cplusplus
extern "C" {
#endif
37

zorglub's avatar
zorglub committed
38
39
40
#include <vlc_es.h>

/** Stream output instance */
41
42
43
struct sout_instance_t
{
    VLC_COMMON_MEMBERS
44

45
46
    char *psz_sout;
    char *psz_chain;
47

48
49
    /* meta data (Read only) XXX it won't be set before the first packet received */
    vlc_meta_t          *p_meta;
50

zorglub's avatar
zorglub committed
51
52
    /** count of output that can't control the space */
    int                 i_out_pace_nocontrol;
53

54
55
56
    vlc_mutex_t         lock;
    sout_stream_t       *p_stream;

zorglub's avatar
zorglub committed
57
    /** Private */
58
59
60
61
62
63
64
65
    sout_instance_sys_t *p_sys;
};

/****************************************************************************
 * sout_stream_id_t: opaque (private for all sout_stream_t)
 ****************************************************************************/
typedef struct sout_stream_id_t  sout_stream_id_t;

zorglub's avatar
zorglub committed
66
/** Stream output access_output */
67
68
69
70
71
72
struct sout_access_out_t
{
    VLC_COMMON_MEMBERS

    module_t                *p_module;
    char                    *psz_access;
73

74
    int                      i_writes;
zorglub's avatar
zorglub committed
75
76
    /** Local counter reset each time it is transferred to stats */
    int64_t                  i_sent_bytes;
77

78
79
    char                    *psz_name;
    sout_access_out_sys_t   *p_sys;
80
81
82
    int                     (*pf_seek)( sout_access_out_t *, off_t );
    int                     (*pf_read)( sout_access_out_t *, block_t * );
    int                     (*pf_write)( sout_access_out_t *, block_t * );
83
84
85
86
    int                     (*pf_control)( sout_access_out_t *, int, va_list);

    config_chain_t              *p_cfg;
    sout_instance_t         *p_sout;
87
};
gbazin's avatar
   
gbazin committed
88

89
90
91
92
93
VLC_EXPORT( sout_access_out_t *,sout_AccessOutNew, ( sout_instance_t *, char *psz_access, char *psz_name ) );
VLC_EXPORT( void,               sout_AccessOutDelete, ( sout_access_out_t * ) );
VLC_EXPORT( int,                sout_AccessOutSeek,   ( sout_access_out_t *, off_t ) );
VLC_EXPORT( int,                sout_AccessOutRead,   ( sout_access_out_t *, block_t * ) );
VLC_EXPORT( int,                sout_AccessOutWrite,  ( sout_access_out_t *, block_t * ) );
94
VLC_EXPORT( int,                sout_AccessOutControl,( sout_access_out_t *, int, va_list ) );
95

zorglub's avatar
zorglub committed
96
/** Muxer structure */
97
struct  sout_mux_t
98
99
{
    VLC_COMMON_MEMBERS
100
    module_t            *p_module;
101

102
    sout_instance_t     *p_sout;
103

104
    char                *psz_mux;
105
    config_chain_t          *p_cfg;
106

107
    sout_access_out_t   *p_access;
108

109
110
111
    int                 (*pf_addstream)( sout_mux_t *, sout_input_t * );
    int                 (*pf_delstream)( sout_mux_t *, sout_input_t * );
    int                 (*pf_mux)      ( sout_mux_t * );
112
    int                 (*pf_control)  ( sout_mux_t *, int, va_list );
113

114
    /* here are all inputs accepted by muxer */
115
116
    int                 i_nb_inputs;
    sout_input_t        **pp_inputs;
117

118
    /* mux private */
119
    sout_mux_sys_t      *p_sys;
zorglub's avatar
zorglub committed
120

121
122
123
124
125
126
127
128
129
    /* XXX private to stream_output.c */
    /* if muxer doesn't support adding stream at any time then we first wait
     *  for stream then we refuse all stream and start muxing */
    vlc_bool_t  b_add_stream_any_time;
    vlc_bool_t  b_waiting_stream;
    /* we wait one second after first stream added */
    mtime_t     i_add_stream_start;
};

130
131
132
133
134
135
136
137
enum sout_mux_query_e
{
    /* capabilities */
    MUX_CAN_ADD_STREAM_WHILE_MUXING,    /* arg1= vlc_bool_t *,      res=cannot fail */
    /* properties */
    MUX_GET_ADD_STREAM_WAIT,            /* arg1= vlc_bool_t *,      res=cannot fail */
    MUX_GET_MIME,                       /* arg1= char **            res=can fail    */
};
138

139
struct sout_input_t
140
{
141
    sout_instance_t *p_sout;
142

143
144
145
146
    es_format_t     *p_fmt;
    block_fifo_t    *p_fifo;

    void            *p_sys;
147
148
};

149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

VLC_EXPORT( sout_mux_t *,   sout_MuxNew,          ( sout_instance_t*, char *, sout_access_out_t * ) );
VLC_EXPORT( sout_input_t *, sout_MuxAddStream,    ( sout_mux_t *, es_format_t * ) );
VLC_EXPORT( void,           sout_MuxDeleteStream, ( sout_mux_t *, sout_input_t * ) );
VLC_EXPORT( void,           sout_MuxDelete,       ( sout_mux_t * ) );
VLC_EXPORT( void,           sout_MuxSendBuffer, ( sout_mux_t *, sout_input_t  *, block_t * ) );

static inline int sout_MuxControl( sout_mux_t *p_mux, int i_query, ... )
{
    va_list args;
    int     i_result;

    va_start( args, i_query );
    i_result = p_mux->pf_control( p_mux, i_query, args );
    va_end( args );
    return i_result;
}

/****************************************************************************
 * sout_stream:
 ****************************************************************************/
170
171
172
173
struct sout_stream_t
{
    VLC_COMMON_MEMBERS

174
175
    module_t          *p_module;
    sout_instance_t   *p_sout;
176

177
    char              *psz_name;
178
    config_chain_t        *p_cfg;
179
    char              *psz_next;
180

181
182
    /* Subpicture unit */
    spu_t             *p_spu;
183

184
    /* add, remove a stream */
185
186
    sout_stream_id_t *(*pf_add)( sout_stream_t *, es_format_t * );
    int               (*pf_del)( sout_stream_t *, sout_stream_id_t * );
187
    /* manage a packet */
188
    int               (*pf_send)( sout_stream_t *, sout_stream_id_t *, block_t* );
189
190

    /* private */
191
    sout_stream_sys_t *p_sys;
192
193
};

194
195
VLC_EXPORT( sout_stream_t *, sout_StreamNew, ( sout_instance_t *, char *psz_chain ) );
VLC_EXPORT( void,            sout_StreamDelete, ( sout_stream_t * ) );
zorglub's avatar
zorglub committed
196

197
198
199
200
201
202
203
204
205
206
207
208
static inline sout_stream_id_t *sout_StreamIdAdd( sout_stream_t *s, es_format_t *fmt )
{
    return s->pf_add( s, fmt );
}
static inline int sout_StreamIdDel( sout_stream_t *s, sout_stream_id_t *id )
{
    return s->pf_del( s, id );
}
static inline int sout_StreamIdSend( sout_stream_t *s, sout_stream_id_t *id, block_t *b )
{
    return s->pf_send( s, id, b );
}
zorglub's avatar
zorglub committed
209

210
211
212
/****************************************************************************
 * Announce handler mess
 ****************************************************************************/
zorglub's avatar
zorglub committed
213
VLC_EXPORT( int,                sout_AnnounceRegister, (sout_instance_t *,session_descriptor_t*, announce_method_t* ) );
214
VLC_EXPORT(session_descriptor_t*,sout_AnnounceRegisterSDP, (sout_instance_t *, const char *, const char *, const char *, announce_method_t* ) );
zorglub's avatar
zorglub committed
215
216
VLC_EXPORT( int,                sout_AnnounceUnRegister, (sout_instance_t *,session_descriptor_t* ) );

217
VLC_EXPORT(session_descriptor_t*,sout_AnnounceSessionCreate, (vlc_object_t *obj, const char *cfgpref) );
zorglub's avatar
zorglub committed
218
VLC_EXPORT(void,                 sout_AnnounceSessionDestroy, (session_descriptor_t *) );
219
VLC_EXPORT(announce_method_t*,   sout_SAPMethod, (void) );
220
VLC_EXPORT(void,                 sout_MethodRelease, (announce_method_t *) );
zorglub's avatar
zorglub committed
221

zorglub's avatar
zorglub committed
222
223
224
#ifdef __cplusplus
}
#endif
zorglub's avatar
zorglub committed
225

zorglub's avatar
zorglub committed
226
#endif