Make sdp_Start static since it is used nowhere outside
[vlc.git] / include / vlc_sout.h
1 /*****************************************************************************
2  * stream_output.h : stream output module
3  *****************************************************************************
4  * Copyright (C) 2002-2007 the VideoLAN team
5  * $Id$
6  *
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  *
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.
16  *
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.
21  *
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  *****************************************************************************/
26
27 #if !defined( __LIBVLC__ )
28   #error You are not libvlc or one of its plugins. You cannot include this file
29 #endif
30
31 #ifndef _VLC_SOUT_H_
32 #define _VLC_SOUT_H_
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 #include <vlc_es.h>
39
40 /** Stream output instance */
41 struct sout_instance_t
42 {
43     VLC_COMMON_MEMBERS
44
45     char *psz_sout;
46     char *psz_chain;
47
48     /* meta data (Read only) XXX it won't be set before the first packet received */
49     vlc_meta_t          *p_meta;
50
51     /** count of output that can't control the space */
52     int                 i_out_pace_nocontrol;
53
54     vlc_mutex_t         lock;
55     sout_stream_t       *p_stream;
56
57     /** Private */
58     sout_instance_sys_t *p_sys;
59 };
60
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;
65
66 /** Stream output access_output */
67 struct sout_access_out_t
68 {
69     VLC_COMMON_MEMBERS
70
71     module_t                *p_module;
72     char                    *psz_access;
73
74     int                      i_writes;
75     /** Local counter reset each time it is transferred to stats */
76     int64_t                  i_sent_bytes;
77
78     char                    *psz_path;
79     sout_access_out_sys_t   *p_sys;
80     int                     (*pf_seek)( sout_access_out_t *, off_t );
81     int                     (*pf_read)( sout_access_out_t *, block_t * );
82     int                     (*pf_write)( sout_access_out_t *, block_t * );
83     int                     (*pf_control)( sout_access_out_t *, int, va_list);
84
85     config_chain_t              *p_cfg;
86     sout_instance_t         *p_sout;
87 };
88
89 VLC_EXPORT( sout_access_out_t *,sout_AccessOutNew, ( sout_instance_t *, const char *psz_access, const 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 * ) );
94 VLC_EXPORT( int,                sout_AccessOutControl,( sout_access_out_t *, int, va_list ) );
95
96 /** Muxer structure */
97 struct  sout_mux_t
98 {
99     VLC_COMMON_MEMBERS
100     module_t            *p_module;
101
102     sout_instance_t     *p_sout;
103
104     char                *psz_mux;
105     config_chain_t          *p_cfg;
106
107     sout_access_out_t   *p_access;
108
109     int                 (*pf_addstream)( sout_mux_t *, sout_input_t * );
110     int                 (*pf_delstream)( sout_mux_t *, sout_input_t * );
111     int                 (*pf_mux)      ( sout_mux_t * );
112     int                 (*pf_control)  ( sout_mux_t *, int, va_list );
113
114     /* here are all inputs accepted by muxer */
115     int                 i_nb_inputs;
116     sout_input_t        **pp_inputs;
117
118     /* mux private */
119     sout_mux_sys_t      *p_sys;
120
121     /* XXX private to stream_output.c */
122     /* if muxer doesn't support adding stream at any time then we first wait
123      *  for stream then we refuse all stream and start muxing */
124     vlc_bool_t  b_add_stream_any_time;
125     vlc_bool_t  b_waiting_stream;
126     /* we wait one second after first stream added */
127     mtime_t     i_add_stream_start;
128 };
129
130 enum sout_mux_query_e
131 {
132     /* capabilities */
133     MUX_CAN_ADD_STREAM_WHILE_MUXING,    /* arg1= vlc_bool_t *,      res=cannot fail */
134     /* properties */
135     MUX_GET_ADD_STREAM_WAIT,            /* arg1= vlc_bool_t *,      res=cannot fail */
136     MUX_GET_MIME,                       /* arg1= char **            res=can fail    */
137 };
138
139 struct sout_input_t
140 {
141     sout_instance_t *p_sout;
142
143     es_format_t     *p_fmt;
144     block_fifo_t    *p_fifo;
145
146     void            *p_sys;
147 };
148
149
150 VLC_EXPORT( sout_mux_t *,   sout_MuxNew,          ( sout_instance_t*, char *, sout_access_out_t * ) );
151 VLC_EXPORT( sout_input_t *, sout_MuxAddStream,    ( sout_mux_t *, es_format_t * ) );
152 VLC_EXPORT( void,           sout_MuxDeleteStream, ( sout_mux_t *, sout_input_t * ) );
153 VLC_EXPORT( void,           sout_MuxDelete,       ( sout_mux_t * ) );
154 VLC_EXPORT( void,           sout_MuxSendBuffer, ( sout_mux_t *, sout_input_t  *, block_t * ) );
155
156 static inline int sout_MuxControl( sout_mux_t *p_mux, int i_query, ... )
157 {
158     va_list args;
159     int     i_result;
160
161     va_start( args, i_query );
162     i_result = p_mux->pf_control( p_mux, i_query, args );
163     va_end( args );
164     return i_result;
165 }
166
167 /****************************************************************************
168  * sout_stream:
169  ****************************************************************************/
170 struct sout_stream_t
171 {
172     VLC_COMMON_MEMBERS
173
174     module_t          *p_module;
175     sout_instance_t   *p_sout;
176
177     char              *psz_name;
178     config_chain_t        *p_cfg;
179     char              *psz_next;
180
181     /* Subpicture unit */
182     spu_t             *p_spu;
183
184     /* add, remove a stream */
185     sout_stream_id_t *(*pf_add)( sout_stream_t *, es_format_t * );
186     int               (*pf_del)( sout_stream_t *, sout_stream_id_t * );
187     /* manage a packet */
188     int               (*pf_send)( sout_stream_t *, sout_stream_id_t *, block_t* );
189
190     /* private */
191     sout_stream_sys_t *p_sys;
192 };
193
194 VLC_EXPORT( sout_stream_t *, sout_StreamNew, ( sout_instance_t *, char *psz_chain ) );
195 VLC_EXPORT( void,            sout_StreamDelete, ( sout_stream_t * ) );
196
197 static inline sout_stream_id_t *sout_StreamIdAdd( sout_stream_t *s, es_format_t *fmt )
198 {
199     return s->pf_add( s, fmt );
200 }
201 static inline int sout_StreamIdDel( sout_stream_t *s, sout_stream_id_t *id )
202 {
203     return s->pf_del( s, id );
204 }
205 static inline int sout_StreamIdSend( sout_stream_t *s, sout_stream_id_t *id, block_t *b )
206 {
207     return s->pf_send( s, id, b );
208 }
209
210 /****************************************************************************
211  * Announce handler
212  ****************************************************************************/
213 VLC_EXPORT(session_descriptor_t*,sout_AnnounceRegisterSDP, (sout_instance_t *, const char *, const char *, const char *, announce_method_t* ) );
214 VLC_EXPORT( int,                sout_AnnounceUnRegister, (sout_instance_t *,session_descriptor_t* ) );
215
216 VLC_EXPORT(announce_method_t*,   sout_SAPMethod, (void) );
217 VLC_EXPORT(void,                 sout_MethodRelease, (announce_method_t *) );
218
219 /** SDP */
220
221 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 ) );
222 VLC_EXPORT( char *, sdp_AddMedia, (char **sdp, const char *type, const char *protocol, int dport, unsigned pt, vlc_bool_t bw_indep, unsigned bw, const char *rtpmap, const char *fmtp) );
223 VLC_EXPORT( char *, sdp_AddAttribute, (char **sdp, const char *name, const char *fmt, ...) ATTRIBUTE_FORMAT( 3, 4 ) );
224
225
226 #ifdef __cplusplus
227 }
228 #endif
229
230 #endif