vlc_sout.h 9.52 KB
Newer Older
1
/*****************************************************************************
Pere Orga's avatar
Pere Orga committed
2
 * vlc_sout.h : stream output module
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
4
 * Copyright (C) 2002-2008 VLC authors and VideoLAN
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
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
13 14 15
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
16
 * (at your option) any later version.
17
 *
18 19
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
20 21
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
22
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
23 24 25
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software 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
#ifdef __cplusplus
extern "C" {
#endif
34

35
#include <sys/types.h>
36 37
#include <vlc_es.h>

38 39 40 41 42 43 44 45
/**
 * \defgroup sout Stream output
 * \ingroup output
 * @{
 * \file
 * Stream output modules interface
 */

46
/** Stream output instance (FIXME: should be private to src/ to avoid
Pierre Ynard's avatar
Pierre Ynard committed
47
 * invalid unsynchronized access) */
48 49
struct sout_instance_t
{
50
    struct vlc_common_members obj;
51

52
    char *psz_sout;
53

54 55
    /** count of output that can't control the space */
    int                 i_out_pace_nocontrol;
56

57 58 59 60
    vlc_mutex_t         lock;
    sout_stream_t       *p_stream;
};

61 62 63 64 65 66
/**
 * \defgroup sout_access Access output
 * Raw output byte streams
 * @{
 */

67
/** Stream output access_output */
68 69
struct sout_access_out_t
{
70
    struct vlc_common_members obj;
71 72 73

    module_t                *p_module;
    char                    *psz_access;
74

75
    char                    *psz_path;
76
    void                    *p_sys;
77
    int                     (*pf_seek)( sout_access_out_t *, off_t );
78 79
    ssize_t                 (*pf_read)( sout_access_out_t *, block_t * );
    ssize_t                 (*pf_write)( sout_access_out_t *, block_t * );
80
    int                     (*pf_control)( sout_access_out_t *, int, va_list );
81

82
    config_chain_t          *p_cfg;
83
};
84

85 86 87
enum access_out_query_e
{
    ACCESS_OUT_CONTROLS_PACE, /* arg1=bool *, can fail (assume true) */
88
    ACCESS_OUT_CAN_SEEK, /* arg1=bool *, can fail (assume false) */
89 90
};

91
VLC_API sout_access_out_t * sout_AccessOutNew( vlc_object_t *, const char *psz_access, const char *psz_name ) VLC_USED;
92 93
#define sout_AccessOutNew( obj, access, name ) \
        sout_AccessOutNew( VLC_OBJECT(obj), access, name )
94 95 96 97 98
VLC_API void sout_AccessOutDelete( sout_access_out_t * );
VLC_API int sout_AccessOutSeek( sout_access_out_t *, off_t );
VLC_API ssize_t sout_AccessOutRead( sout_access_out_t *, block_t * );
VLC_API ssize_t sout_AccessOutWrite( sout_access_out_t *, block_t * );
VLC_API int sout_AccessOutControl( sout_access_out_t *, int, ... );
99 100 101 102 103 104 105 106

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;
}
107

108 109 110 111 112 113 114
/**
 * @}
 * \defgroup sout_mux Multiplexer
 * Multiplexers (file formatters)
 * @{
 */

115
/** Muxer structure */
116
struct  sout_mux_t
117
{
118
    struct vlc_common_members obj;
119
    module_t            *p_module;
120

121
    sout_instance_t     *p_sout;
122

123
    char                *psz_mux;
124
    config_chain_t          *p_cfg;
125

126
    sout_access_out_t   *p_access;
127

128
    int                 (*pf_addstream)( sout_mux_t *, sout_input_t * );
129
    void                (*pf_delstream)( sout_mux_t *, sout_input_t * );
130
    int                 (*pf_mux)      ( sout_mux_t * );
131
    int                 (*pf_control)  ( sout_mux_t *, int, va_list );
132

133
    /* here are all inputs accepted by muxer */
134 135
    int                 i_nb_inputs;
    sout_input_t        **pp_inputs;
136

137
    /* mux private */
138
    void                *p_sys;
139

140 141 142
    /* 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 */
143 144
    bool  b_add_stream_any_time;
    bool  b_waiting_stream;
Steve Lhomme's avatar
Steve Lhomme committed
145
    /* we wait 1.5 second after first stream added */
146 147 148
    mtime_t     i_add_stream_start;
};

149 150 151
enum sout_mux_query_e
{
    /* capabilities */
152
    MUX_CAN_ADD_STREAM_WHILE_MUXING,    /* arg1= bool *,      res=cannot fail */
153
    /* properties */
154
    MUX_GET_ADD_STREAM_WAIT,            /* arg1= bool *,      res=cannot fail */
155 156
    MUX_GET_MIME,                       /* arg1= char **            res=can fail    */
};
157

158
struct sout_input_t
159
{
160 161 162 163
    const es_format_t *p_fmt;
    block_fifo_t      *p_fifo;
    void              *p_sys;
    es_format_t        fmt;
164 165
};

166

167
VLC_API sout_mux_t * sout_MuxNew( sout_instance_t*, const char *, sout_access_out_t * ) VLC_USED;
168
VLC_API sout_input_t *sout_MuxAddStream( sout_mux_t *, const es_format_t * ) VLC_USED;
169 170
VLC_API void sout_MuxDeleteStream( sout_mux_t *, sout_input_t * );
VLC_API void sout_MuxDelete( sout_mux_t * );
171
VLC_API int sout_MuxSendBuffer( sout_mux_t *, sout_input_t  *, block_t * );
172
VLC_API int sout_MuxGetStream(sout_mux_t *, unsigned, mtime_t *);
173
VLC_API void sout_MuxFlush( sout_mux_t *, sout_input_t * );
174 175 176 177 178 179 180 181 182 183 184 185

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;
}

186 187
/** @} */

188 189 190 191
enum sout_stream_query_e {
    SOUT_STREAM_EMPTY,    /* arg1=bool *,       res=can fail (assume true) */
};

192 193
struct sout_stream_t
{
194
    struct vlc_common_members obj;
195

196 197
    module_t          *p_module;
    sout_instance_t   *p_sout;
198

199
    char              *psz_name;
200
    config_chain_t    *p_cfg;
201
    sout_stream_t     *p_next;
202 203

    /* add, remove a stream */
204 205
    void             *(*pf_add)( sout_stream_t *, const es_format_t * );
    void              (*pf_del)( sout_stream_t *, void * );
206
    /* manage a packet */
207
    int               (*pf_send)( sout_stream_t *, void *, block_t* );
208
    int               (*pf_control)( sout_stream_t *, int, va_list );
209
    void              (*pf_flush)( sout_stream_t *, void * );
210

211
    void              *p_sys;
212
    bool pace_nocontrol;
213 214
};

215 216
VLC_API void sout_StreamChainDelete(sout_stream_t *p_first, sout_stream_t *p_last );
VLC_API sout_stream_t *sout_StreamChainNew(sout_instance_t *p_sout,
217
        const char *psz_chain, sout_stream_t *p_next, sout_stream_t **p_last) VLC_USED;
218

219 220
static inline void *sout_StreamIdAdd( sout_stream_t *s,
                                      const es_format_t *fmt )
221 222 223
{
    return s->pf_add( s, fmt );
}
224 225

static inline void sout_StreamIdDel( sout_stream_t *s,
226
                                     void *id )
227
{
228
    s->pf_del( s, id );
229
}
230 231

static inline int sout_StreamIdSend( sout_stream_t *s,
232
                                     void *id, block_t *b )
233 234 235
{
    return s->pf_send( s, id, b );
}
236

237
static inline void sout_StreamFlush( sout_stream_t *s,
238
                                     void *id )
239 240 241 242 243
{
    if (s->pf_flush)
        s->pf_flush( s, id );
}

244 245 246 247 248
static inline int sout_StreamControlVa( sout_stream_t *s, int i_query, va_list args )
{
    return s->pf_control ? s->pf_control( s, i_query, args ) : VLC_EGENERIC;
}

249 250 251 252 253 254
static inline int sout_StreamControl( sout_stream_t *s, int i_query, ... )
{
    va_list args;
    int     i_result;

    va_start( args, i_query );
255
    i_result = sout_StreamControlVa( s, i_query, args );
256 257 258 259
    va_end( args );
    return i_result;
}

260 261 262 263
/****************************************************************************
 * Encoder
 ****************************************************************************/

264
VLC_API encoder_t * sout_EncoderCreate( vlc_object_t *obj );
265 266
#define sout_EncoderCreate(o) sout_EncoderCreate(VLC_OBJECT(o))

267
/****************************************************************************
268
 * Announce handler
269
 ****************************************************************************/
270
VLC_API session_descriptor_t* sout_AnnounceRegisterSDP( vlc_object_t *, const char *, const char * ) VLC_USED;
271
VLC_API void sout_AnnounceUnRegister(vlc_object_t *,session_descriptor_t* );
272 273
#define sout_AnnounceRegisterSDP(o, sdp, addr) \
        sout_AnnounceRegisterSDP(VLC_OBJECT (o), sdp, addr)
274 275
#define sout_AnnounceUnRegister(o, a) \
        sout_AnnounceUnRegister(VLC_OBJECT (o), a)
276

277 278
/** SDP */

279
struct sockaddr;
280 281 282 283 284 285 286 287 288 289 290 291 292
struct vlc_memstream;

VLC_API int vlc_sdp_Start(struct vlc_memstream *, vlc_object_t *obj,
                          const char *cfgpref,
                          const struct sockaddr *src, size_t slen,
                          const struct sockaddr *addr, size_t alen) VLC_USED;
VLC_API void sdp_AddMedia(struct vlc_memstream *, 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);
VLC_API void sdp_AddAttribute(struct vlc_memstream *, const char *name,
                              const char *fmt, ...) VLC_FORMAT(3, 4);
293

294 295 296 297 298 299 300
/** Description module */
typedef struct sout_description_data_t
{
    int i_es;
    es_format_t **es;
    vlc_sem_t *sem;
} sout_description_data_t;
301

302 303
/** @} */

304 305 306
#ifdef __cplusplus
}
#endif
307

308
#endif