vlc_sout.h 8.59 KB
Newer Older
1
2
3
/*****************************************************************************
 * stream_output.h : stream output module
 *****************************************************************************
4
 * Copyright (C) 2002-2008 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
 *          Rémi Denis-Courmont
12
13
14
15
16
 *
 * 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.
17
 *
18
19
20
21
22
23
24
 * 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
25
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26
27
 *****************************************************************************/

28
29
#ifndef VLC_SOUT_H_
#define VLC_SOUT_H_
30

31
32
33
34
35
/**
 * \file
 * This file defines structures and functions for stream ouput in vlc
 */

zorglub's avatar
zorglub committed
36
37
38
#ifdef __cplusplus
extern "C" {
#endif
39

zorglub's avatar
zorglub committed
40
41
42
#include <vlc_es.h>

/** Stream output instance */
43
44
45
struct sout_instance_t
{
    VLC_COMMON_MEMBERS
46

47
48
    char *psz_sout;
    char *psz_chain;
49

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

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

56
57
58
    vlc_mutex_t         lock;
    sout_stream_t       *p_stream;

zorglub's avatar
zorglub committed
59
    /** Private */
60
61
62
    sout_instance_sys_t *p_sys;
};

63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/** Stream output statistics */
typedef enum
{
    SOUT_STATISTIC_DECODED_VIDEO,
    SOUT_STATISTIC_DECODED_AUDIO,
    SOUT_STATISTIC_DECODED_SUBTITLE,

    /* Use them only if you do not goes through a access_out module */
    SOUT_STATISTIC_SENT_PACKET,
    SOUT_STATISTIC_SENT_BYTE,

} sout_statistic_t;

VLC_EXPORT( void, sout_UpdateStatistic, ( sout_instance_t *p_sout, sout_statistic_t, int ) );

78
79
80
81
82
/****************************************************************************
 * 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
83
/** Stream output access_output */
84
85
86
87
88
89
struct sout_access_out_t
{
    VLC_COMMON_MEMBERS

    module_t                *p_module;
    char                    *psz_access;
90

91
    int                      i_writes;
zorglub's avatar
zorglub committed
92
93
    /** Local counter reset each time it is transferred to stats */
    int64_t                  i_sent_bytes;
94

95
    char                    *psz_path;
96
    sout_access_out_sys_t   *p_sys;
97
    int                     (*pf_seek)( sout_access_out_t *, off_t );
98
99
    ssize_t                 (*pf_read)( sout_access_out_t *, block_t * );
    ssize_t                 (*pf_write)( sout_access_out_t *, block_t * );
100
101
    int                     (*pf_control)( sout_access_out_t *, int, va_list);

102
    config_chain_t          *p_cfg;
103
};
gbazin's avatar
   
gbazin committed
104

105
106
107
108
109
enum access_out_query_e
{
    ACCESS_OUT_CONTROLS_PACE, /* arg1=bool *, can fail (assume true) */
};

110
VLC_EXPORT( sout_access_out_t *,sout_AccessOutNew, ( sout_instance_t *, const char *psz_access, const char *psz_name ) );
111
112
VLC_EXPORT( void,               sout_AccessOutDelete, ( sout_access_out_t * ) );
VLC_EXPORT( int,                sout_AccessOutSeek,   ( sout_access_out_t *, off_t ) );
113
114
VLC_EXPORT( ssize_t,            sout_AccessOutRead,   ( sout_access_out_t *, block_t * ) );
VLC_EXPORT( ssize_t,            sout_AccessOutWrite,  ( sout_access_out_t *, block_t * ) );
115
116
117
118
119
120
121
122
123
VLC_EXPORT( int,                sout_AccessOutControl,( sout_access_out_t *, int, ... ) );

static inline bool sout_AccessOutCanControlPace( sout_access_out_t *p_ao )
{
    bool b;
    if( sout_AccessOutControl( p_ao, ACCESS_OUT_CONTROLS_PACE, &b ) )
        return true;
    return b;
}
124

zorglub's avatar
zorglub committed
125
/** Muxer structure */
126
struct  sout_mux_t
127
128
{
    VLC_COMMON_MEMBERS
129
    module_t            *p_module;
130

131
    sout_instance_t     *p_sout;
132

133
    char                *psz_mux;
134
    config_chain_t          *p_cfg;
135

136
    sout_access_out_t   *p_access;
137

138
139
140
    int                 (*pf_addstream)( sout_mux_t *, sout_input_t * );
    int                 (*pf_delstream)( sout_mux_t *, sout_input_t * );
    int                 (*pf_mux)      ( sout_mux_t * );
141
    int                 (*pf_control)  ( sout_mux_t *, int, va_list );
142

143
    /* here are all inputs accepted by muxer */
144
145
    int                 i_nb_inputs;
    sout_input_t        **pp_inputs;
146

147
    /* mux private */
148
    sout_mux_sys_t      *p_sys;
zorglub's avatar
zorglub committed
149

150
151
152
    /* 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 */
153
154
    bool  b_add_stream_any_time;
    bool  b_waiting_stream;
155
156
157
158
    /* we wait one second after first stream added */
    mtime_t     i_add_stream_start;
};

159
160
161
enum sout_mux_query_e
{
    /* capabilities */
162
    MUX_CAN_ADD_STREAM_WHILE_MUXING,    /* arg1= bool *,      res=cannot fail */
163
    /* properties */
164
    MUX_GET_ADD_STREAM_WAIT,            /* arg1= bool *,      res=cannot fail */
165
166
    MUX_GET_MIME,                       /* arg1= char **            res=can fail    */
};
167

168
struct sout_input_t
169
{
170
    sout_instance_t *p_sout;
171

172
173
174
175
    es_format_t     *p_fmt;
    block_fifo_t    *p_fifo;

    void            *p_sys;
176
177
};

178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198

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:
 ****************************************************************************/
199
200
201
202
struct sout_stream_t
{
    VLC_COMMON_MEMBERS

203
204
    module_t          *p_module;
    sout_instance_t   *p_sout;
205

206
    char              *psz_name;
207
    config_chain_t        *p_cfg;
208
    char              *psz_next;
209

210
211
    /* Subpicture unit */
    spu_t             *p_spu;
212

213
    /* add, remove a stream */
214
215
    sout_stream_id_t *(*pf_add)( sout_stream_t *, es_format_t * );
    int               (*pf_del)( sout_stream_t *, sout_stream_id_t * );
216
    /* manage a packet */
217
    int               (*pf_send)( sout_stream_t *, sout_stream_id_t *, block_t* );
218
219

    /* private */
220
    sout_stream_sys_t *p_sys;
221
222
};

223
224
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
225

226
227
228
229
230
231
232
233
234
235
236
237
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
238

239
/****************************************************************************
240
 * Announce handler
241
 ****************************************************************************/
242
VLC_EXPORT(session_descriptor_t*,sout_AnnounceRegisterSDP, ( sout_instance_t *, const char *, const char *, announce_method_t* ) );
zorglub's avatar
zorglub committed
243
244
VLC_EXPORT( int,                sout_AnnounceUnRegister, (sout_instance_t *,session_descriptor_t* ) );

245
VLC_EXPORT(announce_method_t*,   sout_SAPMethod, (void) );
246
VLC_EXPORT(void,                 sout_MethodRelease, (announce_method_t *) );
zorglub's avatar
zorglub committed
247

248
249
/** SDP */

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
250
VLC_EXPORT( char *, vlc_sdp_Start, ( vlc_object_t *obj, const char *cfgpref, const struct sockaddr *src, size_t srclen, const struct sockaddr *addr, size_t addrlen ) );
251
VLC_EXPORT( char *, sdp_AddMedia, (char **sdp, const char *type, const char *protocol, int dport, unsigned pt, bool bw_indep, unsigned bw, const char *ptname, unsigned clockrate, unsigned channels, const char *fmtp) );
252
VLC_EXPORT( char *, sdp_AddAttribute, (char **sdp, const char *name, const char *fmt, ...) LIBVLC_FORMAT( 3, 4 ) );
253
254


zorglub's avatar
zorglub committed
255
256
257
#ifdef __cplusplus
}
#endif
zorglub's avatar
zorglub committed
258

zorglub's avatar
zorglub committed
259
#endif