]> git.sesse.net Git - vlc/blob - include/vlc_sout.h
SDL_INIT_EVENTTHREAD is supported on Windows now.
[vlc] / 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     char *psz_chain;
49
50     /* meta data (Read only) XXX it won't be set before the first packet received */
51     vlc_meta_t          *p_meta;
52
53     /** count of output that can't control the space */
54     int                 i_out_pace_nocontrol;
55
56     vlc_mutex_t         lock;
57     sout_stream_t       *p_stream;
58
59     /** Private */
60     sout_instance_sys_t *p_sys;
61 };
62
63 /** Stream output statistics */
64 typedef enum
65 {
66     SOUT_STATISTIC_DECODED_VIDEO,
67     SOUT_STATISTIC_DECODED_AUDIO,
68     SOUT_STATISTIC_DECODED_SUBTITLE,
69
70     /* Use them only if you do not goes through a access_out module */
71     SOUT_STATISTIC_SENT_PACKET,
72     SOUT_STATISTIC_SENT_BYTE,
73
74 } sout_statistic_t;
75
76 VLC_EXPORT( void, sout_UpdateStatistic, ( sout_instance_t *p_sout, sout_statistic_t, int ) );
77
78 /****************************************************************************
79  * sout_stream_id_t: opaque (private for all sout_stream_t)
80  ****************************************************************************/
81 typedef struct sout_stream_id_t  sout_stream_id_t;
82
83 /** Stream output access_output */
84 struct sout_access_out_t
85 {
86     VLC_COMMON_MEMBERS
87
88     module_t                *p_module;
89     char                    *psz_access;
90
91     int                      i_writes;
92     /** Local counter reset each time it is transferred to stats */
93     int64_t                  i_sent_bytes;
94
95     char                    *psz_path;
96     sout_access_out_sys_t   *p_sys;
97     int                     (*pf_seek)( sout_access_out_t *, off_t );
98     ssize_t                 (*pf_read)( sout_access_out_t *, block_t * );
99     ssize_t                 (*pf_write)( sout_access_out_t *, block_t * );
100     int                     (*pf_control)( sout_access_out_t *, int, va_list );
101
102     config_chain_t          *p_cfg;
103 };
104
105 enum access_out_query_e
106 {
107     ACCESS_OUT_CONTROLS_PACE, /* arg1=bool *, can fail (assume true) */
108 };
109
110 VLC_EXPORT( sout_access_out_t *,sout_AccessOutNew, ( vlc_object_t *, const char *psz_access, const char *psz_name ) );
111 #define sout_AccessOutNew( obj, access, name ) \
112         sout_AccessOutNew( VLC_OBJECT(obj), access, name )
113 VLC_EXPORT( void, sout_AccessOutDelete, ( sout_access_out_t * ) );
114 VLC_EXPORT( int, sout_AccessOutSeek, ( sout_access_out_t *, off_t ) );
115 VLC_EXPORT( ssize_t, sout_AccessOutRead, ( sout_access_out_t *, block_t * ) );
116 VLC_EXPORT( ssize_t, sout_AccessOutWrite, ( sout_access_out_t *, block_t * ) );
117 VLC_EXPORT( int, sout_AccessOutControl, ( sout_access_out_t *, int, ... ) );
118
119 static inline bool sout_AccessOutCanControlPace( sout_access_out_t *p_ao )
120 {
121     bool b;
122     if( sout_AccessOutControl( p_ao, ACCESS_OUT_CONTROLS_PACE, &b ) )
123         return true;
124     return b;
125 }
126
127 /** Muxer structure */
128 struct  sout_mux_t
129 {
130     VLC_COMMON_MEMBERS
131     module_t            *p_module;
132
133     sout_instance_t     *p_sout;
134
135     char                *psz_mux;
136     config_chain_t          *p_cfg;
137
138     sout_access_out_t   *p_access;
139
140     int                 (*pf_addstream)( sout_mux_t *, sout_input_t * );
141     int                 (*pf_delstream)( sout_mux_t *, sout_input_t * );
142     int                 (*pf_mux)      ( sout_mux_t * );
143     int                 (*pf_control)  ( sout_mux_t *, int, va_list );
144
145     /* here are all inputs accepted by muxer */
146     int                 i_nb_inputs;
147     sout_input_t        **pp_inputs;
148
149     /* mux private */
150     sout_mux_sys_t      *p_sys;
151
152     /* XXX private to stream_output.c */
153     /* if muxer doesn't support adding stream at any time then we first wait
154      *  for stream then we refuse all stream and start muxing */
155     bool  b_add_stream_any_time;
156     bool  b_waiting_stream;
157     /* we wait one second after first stream added */
158     mtime_t     i_add_stream_start;
159 };
160
161 enum sout_mux_query_e
162 {
163     /* capabilities */
164     MUX_CAN_ADD_STREAM_WHILE_MUXING,    /* arg1= bool *,      res=cannot fail */
165     /* properties */
166     MUX_GET_ADD_STREAM_WAIT,            /* arg1= bool *,      res=cannot fail */
167     MUX_GET_MIME,                       /* arg1= char **            res=can fail    */
168 };
169
170 struct sout_input_t
171 {
172     sout_instance_t *p_sout;
173
174     es_format_t     *p_fmt;
175     block_fifo_t    *p_fifo;
176
177     void            *p_sys;
178 };
179
180
181 VLC_EXPORT( sout_mux_t *,   sout_MuxNew,          ( sout_instance_t*, const char *, sout_access_out_t * ) );
182 VLC_EXPORT( sout_input_t *, sout_MuxAddStream,    ( sout_mux_t *, es_format_t * ) );
183 VLC_EXPORT( void,           sout_MuxDeleteStream, ( sout_mux_t *, sout_input_t * ) );
184 VLC_EXPORT( void,           sout_MuxDelete,       ( sout_mux_t * ) );
185 VLC_EXPORT( void,           sout_MuxSendBuffer, ( sout_mux_t *, sout_input_t  *, block_t * ) );
186 VLC_EXPORT( int,            sout_MuxGetStream, (sout_mux_t *, int , mtime_t *));
187
188 static inline int sout_MuxControl( sout_mux_t *p_mux, int i_query, ... )
189 {
190     va_list args;
191     int     i_result;
192
193     va_start( args, i_query );
194     i_result = p_mux->pf_control( p_mux, i_query, args );
195     va_end( args );
196     return i_result;
197 }
198
199 /****************************************************************************
200  * sout_stream:
201  ****************************************************************************/
202 struct sout_stream_t
203 {
204     VLC_COMMON_MEMBERS
205
206     module_t          *p_module;
207     sout_instance_t   *p_sout;
208
209     char              *psz_name;
210     config_chain_t        *p_cfg;
211     char              *psz_next;
212
213     /* Subpicture unit */
214     spu_t             *p_spu;
215
216     /* add, remove a stream */
217     sout_stream_id_t *(*pf_add)( sout_stream_t *, es_format_t * );
218     int               (*pf_del)( sout_stream_t *, sout_stream_id_t * );
219     /* manage a packet */
220     int               (*pf_send)( sout_stream_t *, sout_stream_id_t *, block_t* );
221
222     /* private */
223     sout_stream_sys_t *p_sys;
224 };
225
226 VLC_EXPORT( sout_stream_t *, sout_StreamNew, ( sout_instance_t *, char *psz_chain ) );
227 VLC_EXPORT( void,            sout_StreamDelete, ( sout_stream_t * ) );
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* ) );
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) );
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 ) );
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