includes: add some LIBVLC_USED.
[vlc.git] / include / vlc_sout.h
1 /*****************************************************************************
2  * stream_output.h : stream output module
3  *****************************************************************************
4  * Copyright (C) 2002-2008 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  *          RĂ©mi Denis-Courmont
12  *
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.
17  *
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.
22  *
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  *****************************************************************************/
27
28 #ifndef VLC_SOUT_H_
29 #define VLC_SOUT_H_
30
31 /**
32  * \file
33  * This file defines structures and functions for stream ouput in vlc
34  */
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 #include <vlc_es.h>
41
42 /** Stream output instance */
43 struct sout_instance_t
44 {
45     VLC_COMMON_MEMBERS
46
47     char *psz_sout;
48
49     /* meta data (Read only) XXX it won't be set before the first packet received */
50     vlc_meta_t          *p_meta;
51
52     /** count of output that can't control the space */
53     int                 i_out_pace_nocontrol;
54
55     vlc_mutex_t         lock;
56     sout_stream_t       *p_stream;
57
58     /** Private */
59     sout_instance_sys_t *p_sys;
60 };
61
62 /** Stream output statistics */
63 typedef enum
64 {
65     SOUT_STATISTIC_DECODED_VIDEO,
66     SOUT_STATISTIC_DECODED_AUDIO,
67     SOUT_STATISTIC_DECODED_SUBTITLE,
68
69     /* Use them only if you do not goes through a access_out module */
70     SOUT_STATISTIC_SENT_PACKET,
71     SOUT_STATISTIC_SENT_BYTE,
72
73 } sout_statistic_t;
74
75 VLC_EXPORT( void, sout_UpdateStatistic, ( sout_instance_t *p_sout, sout_statistic_t, int ) );
76
77 /****************************************************************************
78  * sout_stream_id_t: opaque (private for all sout_stream_t)
79  ****************************************************************************/
80 typedef struct sout_stream_id_t  sout_stream_id_t;
81
82 /** Stream output access_output */
83 struct sout_access_out_t
84 {
85     VLC_COMMON_MEMBERS
86
87     module_t                *p_module;
88     char                    *psz_access;
89
90     int                      i_writes;
91     /** Local counter reset each time it is transferred to stats */
92     int64_t                  i_sent_bytes;
93
94     char                    *psz_path;
95     sout_access_out_sys_t   *p_sys;
96     int                     (*pf_seek)( sout_access_out_t *, off_t );
97     ssize_t                 (*pf_read)( sout_access_out_t *, block_t * );
98     ssize_t                 (*pf_write)( sout_access_out_t *, block_t * );
99     int                     (*pf_control)( sout_access_out_t *, int, va_list );
100
101     config_chain_t          *p_cfg;
102 };
103
104 enum access_out_query_e
105 {
106     ACCESS_OUT_CONTROLS_PACE, /* arg1=bool *, can fail (assume true) */
107 };
108
109 VLC_EXPORT( sout_access_out_t *,sout_AccessOutNew, ( vlc_object_t *, const char *psz_access, const char *psz_name ) LIBVLC_USED );
110 #define sout_AccessOutNew( obj, access, name ) \
111         sout_AccessOutNew( VLC_OBJECT(obj), access, name )
112 VLC_EXPORT( void, sout_AccessOutDelete, ( sout_access_out_t * ) );
113 VLC_EXPORT( int, sout_AccessOutSeek, ( sout_access_out_t *, off_t ) );
114 VLC_EXPORT( ssize_t, sout_AccessOutRead, ( sout_access_out_t *, block_t * ) );
115 VLC_EXPORT( ssize_t, sout_AccessOutWrite, ( sout_access_out_t *, block_t * ) );
116 VLC_EXPORT( int, sout_AccessOutControl, ( sout_access_out_t *, int, ... ) );
117
118 static inline bool sout_AccessOutCanControlPace( sout_access_out_t *p_ao )
119 {
120     bool b;
121     if( sout_AccessOutControl( p_ao, ACCESS_OUT_CONTROLS_PACE, &b ) )
122         return true;
123     return b;
124 }
125
126 /** Muxer structure */
127 struct  sout_mux_t
128 {
129     VLC_COMMON_MEMBERS
130     module_t            *p_module;
131
132     sout_instance_t     *p_sout;
133
134     char                *psz_mux;
135     config_chain_t          *p_cfg;
136
137     sout_access_out_t   *p_access;
138
139     int                 (*pf_addstream)( sout_mux_t *, sout_input_t * );
140     int                 (*pf_delstream)( sout_mux_t *, sout_input_t * );
141     int                 (*pf_mux)      ( sout_mux_t * );
142     int                 (*pf_control)  ( sout_mux_t *, int, va_list );
143
144     /* here are all inputs accepted by muxer */
145     int                 i_nb_inputs;
146     sout_input_t        **pp_inputs;
147
148     /* mux private */
149     sout_mux_sys_t      *p_sys;
150
151     /* XXX private to stream_output.c */
152     /* if muxer doesn't support adding stream at any time then we first wait
153      *  for stream then we refuse all stream and start muxing */
154     bool  b_add_stream_any_time;
155     bool  b_waiting_stream;
156     /* we wait one second after first stream added */
157     mtime_t     i_add_stream_start;
158 };
159
160 enum sout_mux_query_e
161 {
162     /* capabilities */
163     MUX_CAN_ADD_STREAM_WHILE_MUXING,    /* arg1= bool *,      res=cannot fail */
164     /* properties */
165     MUX_GET_ADD_STREAM_WAIT,            /* arg1= bool *,      res=cannot fail */
166     MUX_GET_MIME,                       /* arg1= char **            res=can fail    */
167 };
168
169 struct sout_input_t
170 {
171     sout_instance_t *p_sout;
172
173     es_format_t     *p_fmt;
174     block_fifo_t    *p_fifo;
175
176     void            *p_sys;
177 };
178
179
180 VLC_EXPORT( sout_mux_t *,   sout_MuxNew,          ( sout_instance_t*, const char *, sout_access_out_t * ) LIBVLC_USED );
181 VLC_EXPORT( sout_input_t *, sout_MuxAddStream,    ( sout_mux_t *, es_format_t * ) LIBVLC_USED );
182 VLC_EXPORT( void,           sout_MuxDeleteStream, ( sout_mux_t *, sout_input_t * ) );
183 VLC_EXPORT( void,           sout_MuxDelete,       ( sout_mux_t * ) );
184 VLC_EXPORT( void,           sout_MuxSendBuffer, ( sout_mux_t *, sout_input_t  *, block_t * ) );
185 VLC_EXPORT( int,            sout_MuxGetStream, (sout_mux_t *, int , mtime_t *));
186
187 static inline int sout_MuxControl( sout_mux_t *p_mux, int i_query, ... )
188 {
189     va_list args;
190     int     i_result;
191
192     va_start( args, i_query );
193     i_result = p_mux->pf_control( p_mux, i_query, args );
194     va_end( args );
195     return i_result;
196 }
197
198 /****************************************************************************
199  * sout_stream:
200  ****************************************************************************/
201 struct sout_stream_t
202 {
203     VLC_COMMON_MEMBERS
204
205     module_t          *p_module;
206     sout_instance_t   *p_sout;
207
208     char              *psz_name;
209     config_chain_t        *p_cfg;
210     sout_stream_t     *p_next;
211
212     /* Subpicture unit */
213     spu_t             *p_spu;
214
215     /* add, remove a stream */
216     sout_stream_id_t *(*pf_add)( sout_stream_t *, es_format_t * );
217     int               (*pf_del)( sout_stream_t *, sout_stream_id_t * );
218     /* manage a packet */
219     int               (*pf_send)( sout_stream_t *, sout_stream_id_t *, block_t* );
220
221     /* private */
222     sout_stream_sys_t *p_sys;
223 };
224
225 VLC_EXPORT( void, sout_StreamChainDelete, (sout_stream_t *p_first, sout_stream_t *p_last ) );
226 VLC_EXPORT( sout_stream_t *, sout_StreamChainNew, (sout_instance_t *p_sout,
227         char *psz_chain, sout_stream_t *p_next, sout_stream_t **p_last) LIBVLC_USED );
228
229 static inline sout_stream_id_t *sout_StreamIdAdd( sout_stream_t *s, es_format_t *fmt )
230 {
231     return s->pf_add( s, fmt );
232 }
233 static inline int sout_StreamIdDel( sout_stream_t *s, sout_stream_id_t *id )
234 {
235     return s->pf_del( s, id );
236 }
237 static inline int sout_StreamIdSend( sout_stream_t *s, sout_stream_id_t *id, block_t *b )
238 {
239     return s->pf_send( s, id, b );
240 }
241
242 /****************************************************************************
243  * Encoder
244  ****************************************************************************/
245
246 VLC_EXPORT( encoder_t *, sout_EncoderCreate, ( vlc_object_t *obj ) );
247 #define sout_EncoderCreate(o) sout_EncoderCreate(VLC_OBJECT(o))
248
249 /****************************************************************************
250  * Announce handler
251  ****************************************************************************/
252 VLC_EXPORT(session_descriptor_t*,sout_AnnounceRegisterSDP, ( vlc_object_t *, const char *, const char *, announce_method_t* ) LIBVLC_USED );
253 VLC_EXPORT( int,                sout_AnnounceUnRegister, (vlc_object_t *,session_descriptor_t* ) );
254 #define sout_AnnounceRegisterSDP(o, sdp, addr, m) \
255         sout_AnnounceRegisterSDP(VLC_OBJECT (o), sdp, addr, m)
256 #define sout_AnnounceUnRegister(o, a) \
257         sout_AnnounceUnRegister(VLC_OBJECT (o), a)
258
259 VLC_EXPORT(announce_method_t*,   sout_SAPMethod, (void) LIBVLC_USED );
260 VLC_EXPORT(void,                 sout_MethodRelease, (announce_method_t *) );
261
262 /** SDP */
263
264 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 );
265 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) );
266 VLC_EXPORT( char *, sdp_AddAttribute, (char **sdp, const char *name, const char *fmt, ...) LIBVLC_FORMAT( 3, 4 ) );
267
268
269 #ifdef __cplusplus
270 }
271 #endif
272
273 #endif