1 /*****************************************************************************
2 * stream_output.h : stream output module
3 *****************************************************************************
4 * Copyright (C) 2002-2008 the VideoLAN team
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
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 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 General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26 *****************************************************************************/
33 * This file defines structures and functions for stream ouput in vlc
42 /** Stream output instance */
43 struct sout_instance_t
49 /* meta data (Read only) XXX it won't be set before the first packet received */
52 /** count of output that can't control the space */
53 int i_out_pace_nocontrol
;
56 sout_stream_t
*p_stream
;
59 sout_instance_sys_t
*p_sys
;
62 /****************************************************************************
63 * sout_stream_id_t: opaque (private for all sout_stream_t)
64 ****************************************************************************/
65 typedef struct sout_stream_id_t sout_stream_id_t
;
67 /** Stream output access_output */
68 struct sout_access_out_t
76 /** Local counter reset each time it is transferred to stats */
80 sout_access_out_sys_t
*p_sys
;
81 int (*pf_seek
)( sout_access_out_t
*, off_t
);
82 ssize_t (*pf_read
)( sout_access_out_t
*, block_t
* );
83 ssize_t (*pf_write
)( sout_access_out_t
*, block_t
* );
84 int (*pf_control
)( sout_access_out_t
*, int, va_list );
86 config_chain_t
*p_cfg
;
89 enum access_out_query_e
91 ACCESS_OUT_CONTROLS_PACE
, /* arg1=bool *, can fail (assume true) */
94 VLC_EXPORT( sout_access_out_t
*,sout_AccessOutNew
, ( vlc_object_t
*, const char *psz_access
, const char *psz_name
) LIBVLC_USED
);
95 #define sout_AccessOutNew( obj, access, name ) \
96 sout_AccessOutNew( VLC_OBJECT(obj), access, name )
97 VLC_EXPORT( void, sout_AccessOutDelete
, ( sout_access_out_t
* ) );
98 VLC_EXPORT( int, sout_AccessOutSeek
, ( sout_access_out_t
*, off_t
) );
99 VLC_EXPORT( ssize_t
, sout_AccessOutRead
, ( sout_access_out_t
*, block_t
* ) );
100 VLC_EXPORT( ssize_t
, sout_AccessOutWrite
, ( sout_access_out_t
*, block_t
* ) );
101 VLC_EXPORT( int, sout_AccessOutControl
, ( sout_access_out_t
*, int, ... ) );
103 static inline bool sout_AccessOutCanControlPace( sout_access_out_t
*p_ao
)
106 if( sout_AccessOutControl( p_ao
, ACCESS_OUT_CONTROLS_PACE
, &b
) )
111 /** Muxer structure */
117 sout_instance_t
*p_sout
;
120 config_chain_t
*p_cfg
;
122 sout_access_out_t
*p_access
;
124 int (*pf_addstream
)( sout_mux_t
*, sout_input_t
* );
125 int (*pf_delstream
)( sout_mux_t
*, sout_input_t
* );
126 int (*pf_mux
) ( sout_mux_t
* );
127 int (*pf_control
) ( sout_mux_t
*, int, va_list );
129 /* here are all inputs accepted by muxer */
131 sout_input_t
**pp_inputs
;
134 sout_mux_sys_t
*p_sys
;
136 /* XXX private to stream_output.c */
137 /* if muxer doesn't support adding stream at any time then we first wait
138 * for stream then we refuse all stream and start muxing */
139 bool b_add_stream_any_time
;
140 bool b_waiting_stream
;
141 /* we wait one second after first stream added */
142 mtime_t i_add_stream_start
;
145 enum sout_mux_query_e
148 MUX_CAN_ADD_STREAM_WHILE_MUXING
, /* arg1= bool *, res=cannot fail */
150 MUX_GET_ADD_STREAM_WAIT
, /* arg1= bool *, res=cannot fail */
151 MUX_GET_MIME
, /* arg1= char ** res=can fail */
156 sout_instance_t
*p_sout
;
159 block_fifo_t
*p_fifo
;
165 VLC_EXPORT( sout_mux_t
*, sout_MuxNew
, ( sout_instance_t
*, const char *, sout_access_out_t
* ) LIBVLC_USED
);
166 VLC_EXPORT( sout_input_t
*, sout_MuxAddStream
, ( sout_mux_t
*, es_format_t
* ) LIBVLC_USED
);
167 VLC_EXPORT( void, sout_MuxDeleteStream
, ( sout_mux_t
*, sout_input_t
* ) );
168 VLC_EXPORT( void, sout_MuxDelete
, ( sout_mux_t
* ) );
169 VLC_EXPORT( void, sout_MuxSendBuffer
, ( sout_mux_t
*, sout_input_t
*, block_t
* ) );
170 VLC_EXPORT( int, sout_MuxGetStream
, (sout_mux_t
*, int , mtime_t
*));
172 static inline int sout_MuxControl( sout_mux_t
*p_mux
, int i_query
, ... )
177 va_start( args
, i_query
);
178 i_result
= p_mux
->pf_control( p_mux
, i_query
, args
);
183 /****************************************************************************
185 ****************************************************************************/
191 sout_instance_t
*p_sout
;
194 config_chain_t
*p_cfg
;
195 sout_stream_t
*p_next
;
197 /* Subpicture unit */
200 /* add, remove a stream */
201 sout_stream_id_t
*(*pf_add
)( sout_stream_t
*, es_format_t
* );
202 int (*pf_del
)( sout_stream_t
*, sout_stream_id_t
* );
203 /* manage a packet */
204 int (*pf_send
)( sout_stream_t
*, sout_stream_id_t
*, block_t
* );
207 sout_stream_sys_t
*p_sys
;
210 VLC_EXPORT( void, sout_StreamChainDelete
, (sout_stream_t
*p_first
, sout_stream_t
*p_last
) );
211 VLC_EXPORT( sout_stream_t
*, sout_StreamChainNew
, (sout_instance_t
*p_sout
,
212 char *psz_chain
, sout_stream_t
*p_next
, sout_stream_t
**p_last
) LIBVLC_USED
);
214 static inline sout_stream_id_t
*sout_StreamIdAdd( sout_stream_t
*s
, es_format_t
*fmt
)
216 return s
->pf_add( s
, fmt
);
218 static inline int sout_StreamIdDel( sout_stream_t
*s
, sout_stream_id_t
*id
)
220 return s
->pf_del( s
, id
);
222 static inline int sout_StreamIdSend( sout_stream_t
*s
, sout_stream_id_t
*id
, block_t
*b
)
224 return s
->pf_send( s
, id
, b
);
227 /****************************************************************************
229 ****************************************************************************/
231 VLC_EXPORT( encoder_t
*, sout_EncoderCreate
, ( vlc_object_t
*obj
) );
232 #define sout_EncoderCreate(o) sout_EncoderCreate(VLC_OBJECT(o))
234 /****************************************************************************
236 ****************************************************************************/
237 VLC_EXPORT(session_descriptor_t
*,sout_AnnounceRegisterSDP
, ( vlc_object_t
*, const char *, const char * ) LIBVLC_USED
);
238 VLC_EXPORT( int, sout_AnnounceUnRegister
, (vlc_object_t
*,session_descriptor_t
* ) );
239 #define sout_AnnounceRegisterSDP(o, sdp, addr) \
240 sout_AnnounceRegisterSDP(VLC_OBJECT (o), sdp, addr)
241 #define sout_AnnounceUnRegister(o, a) \
242 sout_AnnounceUnRegister(VLC_OBJECT (o), a)
248 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
) LIBVLC_USED
);
249 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
) );
250 VLC_EXPORT( char *, sdp_AddAttribute
, (char **sdp
, const char *name
, const char *fmt
, ...) LIBVLC_FORMAT( 3, 4 ) );
252 /** Description module */
253 typedef struct sout_description_data_t
258 } sout_description_data_t
;