1 /*****************************************************************************
2 * stream_output.h : stream output module
3 *****************************************************************************
4 * Copyright (C) 2002-2005 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>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
27 #if !defined( __LIBVLC__ )
28 #error You are not libvlc or one of its plugins. You cannot include this file
40 /** Stream output instance */
41 struct sout_instance_t
48 /* meta data (Read only) XXX it won't be set before the first packet received */
51 /** count of output that can't control the space */
52 int i_out_pace_nocontrol;
55 sout_stream_t *p_stream;
58 sout_instance_sys_t *p_sys;
61 /****************************************************************************
62 * sout_stream_id_t: opaque (private for all sout_stream_t)
63 ****************************************************************************/
64 typedef struct sout_stream_id_t sout_stream_id_t;
66 /** Stream output access_output */
67 struct sout_access_out_t
73 sout_instance_t *p_sout;
76 config_chain_t *p_cfg;
79 /** Local counter reset each time it is transferred to stats */
83 sout_access_out_sys_t *p_sys;
84 int (*pf_seek)( sout_access_out_t *, off_t );
85 int (*pf_read)( sout_access_out_t *, block_t * );
86 int (*pf_write)( sout_access_out_t *, block_t * );
89 VLC_EXPORT( sout_access_out_t *,sout_AccessOutNew, ( sout_instance_t *, char *psz_access, char *psz_name ) );
90 VLC_EXPORT( void, sout_AccessOutDelete, ( sout_access_out_t * ) );
91 VLC_EXPORT( int, sout_AccessOutSeek, ( sout_access_out_t *, off_t ) );
92 VLC_EXPORT( int, sout_AccessOutRead, ( sout_access_out_t *, block_t * ) );
93 VLC_EXPORT( int, sout_AccessOutWrite, ( sout_access_out_t *, block_t * ) );
95 /** Muxer structure */
101 sout_instance_t *p_sout;
104 config_chain_t *p_cfg;
106 sout_access_out_t *p_access;
108 int (*pf_addstream)( sout_mux_t *, sout_input_t * );
109 int (*pf_delstream)( sout_mux_t *, sout_input_t * );
110 int (*pf_mux) ( sout_mux_t * );
111 int (*pf_control) ( sout_mux_t *, int, va_list );
113 /* here are all inputs accepted by muxer */
115 sout_input_t **pp_inputs;
118 sout_mux_sys_t *p_sys;
120 /* XXX private to stream_output.c */
121 /* if muxer doesn't support adding stream at any time then we first wait
122 * for stream then we refuse all stream and start muxing */
123 vlc_bool_t b_add_stream_any_time;
124 vlc_bool_t b_waiting_stream;
125 /* we wait one second after first stream added */
126 mtime_t i_add_stream_start;
129 enum sout_mux_query_e
132 MUX_CAN_ADD_STREAM_WHILE_MUXING, /* arg1= vlc_bool_t *, res=cannot fail */
134 MUX_GET_ADD_STREAM_WAIT, /* arg1= vlc_bool_t *, res=cannot fail */
135 MUX_GET_MIME, /* arg1= char ** res=can fail */
140 sout_instance_t *p_sout;
143 block_fifo_t *p_fifo;
149 VLC_EXPORT( sout_mux_t *, sout_MuxNew, ( sout_instance_t*, char *, sout_access_out_t * ) );
150 VLC_EXPORT( sout_input_t *, sout_MuxAddStream, ( sout_mux_t *, es_format_t * ) );
151 VLC_EXPORT( void, sout_MuxDeleteStream, ( sout_mux_t *, sout_input_t * ) );
152 VLC_EXPORT( void, sout_MuxDelete, ( sout_mux_t * ) );
153 VLC_EXPORT( void, sout_MuxSendBuffer, ( sout_mux_t *, sout_input_t *, block_t * ) );
155 static inline int sout_MuxControl( sout_mux_t *p_mux, int i_query, ... )
160 va_start( args, i_query );
161 i_result = p_mux->pf_control( p_mux, i_query, args );
166 /****************************************************************************
168 ****************************************************************************/
174 sout_instance_t *p_sout;
177 config_chain_t *p_cfg;
180 /* Subpicture unit */
183 /* add, remove a stream */
184 sout_stream_id_t *(*pf_add)( sout_stream_t *, es_format_t * );
185 int (*pf_del)( sout_stream_t *, sout_stream_id_t * );
186 /* manage a packet */
187 int (*pf_send)( sout_stream_t *, sout_stream_id_t *, block_t* );
190 sout_stream_sys_t *p_sys;
193 VLC_EXPORT( sout_stream_t *, sout_StreamNew, ( sout_instance_t *, char *psz_chain ) );
194 VLC_EXPORT( void, sout_StreamDelete, ( sout_stream_t * ) );
196 static inline sout_stream_id_t *sout_StreamIdAdd( sout_stream_t *s, es_format_t *fmt )
198 return s->pf_add( s, fmt );
200 static inline int sout_StreamIdDel( sout_stream_t *s, sout_stream_id_t *id )
202 return s->pf_del( s, id );
204 static inline int sout_StreamIdSend( sout_stream_t *s, sout_stream_id_t *id, block_t *b )
206 return s->pf_send( s, id, b );
209 /****************************************************************************
210 * Announce handler mess
211 ****************************************************************************/
212 struct sap_session_t;
214 struct session_descriptor_t
219 int i_payload; /* SAP Payload type */
227 VLC_EXPORT( int, sout_AnnounceRegister, (sout_instance_t *,session_descriptor_t*, announce_method_t* ) );
228 VLC_EXPORT(session_descriptor_t*,sout_AnnounceRegisterSDP, (sout_instance_t *,const char *, const char *, announce_method_t* ) );
229 VLC_EXPORT( int, sout_AnnounceUnRegister, (sout_instance_t *,session_descriptor_t* ) );
231 VLC_EXPORT(session_descriptor_t*,sout_AnnounceSessionCreate, (void) );
232 VLC_EXPORT(void, sout_AnnounceSessionDestroy, (session_descriptor_t *) );
233 VLC_EXPORT(announce_method_t*, sout_SAPMethod, (void) );