1 /*****************************************************************************
2 * vlc_sout.h : stream output module
3 *****************************************************************************
4 * Copyright (C) 2002-2008 VLC authors and VideoLAN
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
8 * Laurent Aimar <fenrir@via.ecp.fr>
9 * Eric Petit <titer@videolan.org>
10 * Jean-Paul Saman <jpsaman #_at_# m2x.nl>
11 * RĂ©mi Denis-Courmont
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU Lesser General Public License as published by
15 * the Free Software Foundation; either version 2.1 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License for more details.
23 * You should have received a copy of the GNU Lesser General Public License
24 * along with this program; if not, write to the Free Software Foundation,
25 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26 *****************************************************************************/
35 #include <sys/types.h>
39 * \defgroup sout Stream output
43 * Stream output modules interface
46 /** Stream output instance (FIXME: should be private to src/ to avoid
47 * invalid unsynchronized access) */
48 struct sout_instance_t
50 struct vlc_common_members obj
;
54 /** count of output that can't control the space */
55 int i_out_pace_nocontrol
;
58 sout_stream_t
*p_stream
;
62 * \defgroup sout_access Access output
63 * Raw output byte streams
67 /** Stream output access_output */
68 struct sout_access_out_t
70 struct vlc_common_members obj
;
77 int (*pf_seek
)( sout_access_out_t
*, off_t
);
78 ssize_t (*pf_read
)( sout_access_out_t
*, block_t
* );
79 ssize_t (*pf_write
)( sout_access_out_t
*, block_t
* );
80 int (*pf_control
)( sout_access_out_t
*, int, va_list );
82 config_chain_t
*p_cfg
;
85 enum access_out_query_e
87 ACCESS_OUT_CONTROLS_PACE
, /* arg1=bool *, can fail (assume true) */
88 ACCESS_OUT_CAN_SEEK
, /* arg1=bool *, can fail (assume false) */
91 VLC_API sout_access_out_t
* sout_AccessOutNew( vlc_object_t
*, const char *psz_access
, const char *psz_name
) VLC_USED
;
92 #define sout_AccessOutNew( obj, access, name ) \
93 sout_AccessOutNew( VLC_OBJECT(obj), access, name )
94 VLC_API
void sout_AccessOutDelete( sout_access_out_t
* );
95 VLC_API
int sout_AccessOutSeek( sout_access_out_t
*, off_t
);
96 VLC_API ssize_t
sout_AccessOutRead( sout_access_out_t
*, block_t
* );
97 VLC_API ssize_t
sout_AccessOutWrite( sout_access_out_t
*, block_t
* );
98 VLC_API
int sout_AccessOutControl( sout_access_out_t
*, int, ... );
100 static inline bool sout_AccessOutCanControlPace( sout_access_out_t
*p_ao
)
103 if( sout_AccessOutControl( p_ao
, ACCESS_OUT_CONTROLS_PACE
, &b
) )
110 * \defgroup sout_mux Multiplexer
111 * Multiplexers (file formatters)
115 /** Muxer structure */
118 struct vlc_common_members obj
;
121 sout_instance_t
*p_sout
;
124 config_chain_t
*p_cfg
;
126 sout_access_out_t
*p_access
;
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 );
133 /* here are all inputs accepted by muxer */
135 sout_input_t
**pp_inputs
;
140 /* XXX private to stream_output.c */
141 /* if muxer doesn't support adding stream at any time then we first wait
142 * for stream then we refuse all stream and start muxing */
143 bool b_add_stream_any_time
;
144 bool b_waiting_stream
;
145 /* we wait 1.5 second after first stream added */
146 mtime_t i_add_stream_start
;
149 enum sout_mux_query_e
152 MUX_CAN_ADD_STREAM_WHILE_MUXING
, /* arg1= bool *, res=cannot fail */
154 MUX_GET_ADD_STREAM_WAIT
, /* arg1= bool *, res=cannot fail */
155 MUX_GET_MIME
, /* arg1= char ** res=can fail */
160 const es_format_t
*p_fmt
;
161 block_fifo_t
*p_fifo
;
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 VLC_API
void sout_MuxDeleteStream( sout_mux_t
*, sout_input_t
* );
170 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
* );
175 static inline int sout_MuxControl( sout_mux_t
*p_mux
, int i_query
, ... )
180 va_start( args
, i_query
);
181 i_result
= p_mux
->pf_control( p_mux
, i_query
, args
);
188 enum sout_stream_query_e
{
189 SOUT_STREAM_EMPTY
, /* arg1=bool *, res=can fail (assume true) */
194 struct vlc_common_members obj
;
197 sout_instance_t
*p_sout
;
200 config_chain_t
*p_cfg
;
201 sout_stream_t
*p_next
;
203 /* add, remove a stream */
204 void *(*pf_add
)( sout_stream_t
*, const es_format_t
* );
205 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 * );
215 VLC_API
void sout_StreamChainDelete(sout_stream_t
*p_first
, sout_stream_t
*p_last
);
216 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
;
219 static inline void *sout_StreamIdAdd( sout_stream_t
*s
,
220 const es_format_t
*fmt
)
222 return s
->pf_add( s
, fmt
);
225 static inline void sout_StreamIdDel( sout_stream_t
*s
,
231 static inline int sout_StreamIdSend( sout_stream_t
*s
,
232 void *id
, block_t
*b
)
234 return s
->pf_send( s
, id
, b
);
237 static inline void sout_StreamFlush( sout_stream_t
*s
,
241 s
->pf_flush( s
, id
);
244 static inline int sout_StreamControlVa( sout_stream_t
*s
, int i_query
, va_list args
)
246 return s
->pf_control
? s
->pf_control( s
, i_query
, args
) : VLC_EGENERIC
;
249 static inline int sout_StreamControl( sout_stream_t
*s
, int i_query
, ... )
254 va_start( args
, i_query
);
255 i_result
= sout_StreamControlVa( s
, i_query
, args
);
260 /****************************************************************************
262 ****************************************************************************/
264 VLC_API encoder_t
* sout_EncoderCreate( vlc_object_t
*obj
);
265 #define sout_EncoderCreate(o) sout_EncoderCreate(VLC_OBJECT(o))
267 /****************************************************************************
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 #define sout_AnnounceRegisterSDP(o, sdp, addr) \
273 sout_AnnounceRegisterSDP(VLC_OBJECT (o), sdp, addr)
274 #define sout_AnnounceUnRegister(o, a) \
275 sout_AnnounceUnRegister(VLC_OBJECT (o), a)
280 struct vlc_memstream
;
282 VLC_API
int vlc_sdp_Start(struct vlc_memstream
*, vlc_object_t
*obj
,
284 const struct sockaddr
*src
, size_t slen
,
285 const struct sockaddr
*addr
, size_t alen
) VLC_USED
;
286 VLC_API
void sdp_AddMedia(struct vlc_memstream
*, const char *type
,
287 const char *protocol
, int dport
, unsigned pt
,
288 bool bw_indep
, unsigned bw
, const char *ptname
,
289 unsigned clockrate
, unsigned channels
,
291 VLC_API
void sdp_AddAttribute(struct vlc_memstream
*, const char *name
,
292 const char *fmt
, ...) VLC_FORMAT(3, 4);
294 /** Description module */
295 typedef struct sout_description_data_t
300 } sout_description_data_t
;