nice is a phony target
[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 /** Stream output statistics */
62 typedef enum
63 {
64     SOUT_STATISTIC_DECODED_VIDEO,
65     SOUT_STATISTIC_DECODED_AUDIO,
66     SOUT_STATISTIC_DECODED_SUBTITLE,
67
68     /* Use them only if you do not goes through a access_out module */
69     SOUT_STATISTIC_SENT_PACKET,
70     SOUT_STATISTIC_SENT_BYTE,
71
72 } sout_statistic_t;
73
74 VLC_EXPORT( void, sout_UpdateStatistic, ( sout_instance_t *p_sout, sout_statistic_t, int ) );
75
76 /****************************************************************************
77  * sout_stream_id_t: opaque (private for all sout_stream_t)
78  ****************************************************************************/
79 typedef struct sout_stream_id_t  sout_stream_id_t;
80
81 /** Stream output access_output */
82 struct sout_access_out_t
83 {
84     VLC_COMMON_MEMBERS
85
86     module_t                *p_module;
87     char                    *psz_access;
88
89     int                      i_writes;
90     /** Local counter reset each time it is transferred to stats */
91     int64_t                  i_sent_bytes;
92
93     char                    *psz_path;
94     sout_access_out_sys_t   *p_sys;
95     int                     (*pf_seek)( sout_access_out_t *, off_t );
96     ssize_t                 (*pf_read)( sout_access_out_t *, block_t * );
97     ssize_t                 (*pf_write)( sout_access_out_t *, block_t * );
98     int                     (*pf_control)( sout_access_out_t *, int, va_list);
99
100     config_chain_t              *p_cfg;
101     sout_instance_t         *p_sout;
102 };
103
104 VLC_EXPORT( sout_access_out_t *,sout_AccessOutNew, ( sout_instance_t *, const char *psz_access, const char *psz_name ) );
105 VLC_EXPORT( void,               sout_AccessOutDelete, ( sout_access_out_t * ) );
106 VLC_EXPORT( int,                sout_AccessOutSeek,   ( sout_access_out_t *, off_t ) );
107 VLC_EXPORT( ssize_t,            sout_AccessOutRead,   ( sout_access_out_t *, block_t * ) );
108 VLC_EXPORT( ssize_t,            sout_AccessOutWrite,  ( sout_access_out_t *, block_t * ) );
109 VLC_EXPORT( int,                sout_AccessOutControl,( sout_access_out_t *, int, va_list ) );
110
111 /** Muxer structure */
112 struct  sout_mux_t
113 {
114     VLC_COMMON_MEMBERS
115     module_t            *p_module;
116
117     sout_instance_t     *p_sout;
118
119     char                *psz_mux;
120     config_chain_t          *p_cfg;
121
122     sout_access_out_t   *p_access;
123
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 );
128
129     /* here are all inputs accepted by muxer */
130     int                 i_nb_inputs;
131     sout_input_t        **pp_inputs;
132
133     /* mux private */
134     sout_mux_sys_t      *p_sys;
135
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;
143 };
144
145 enum sout_mux_query_e
146 {
147     /* capabilities */
148     MUX_CAN_ADD_STREAM_WHILE_MUXING,    /* arg1= bool *,      res=cannot fail */
149     /* properties */
150     MUX_GET_ADD_STREAM_WAIT,            /* arg1= bool *,      res=cannot fail */
151     MUX_GET_MIME,                       /* arg1= char **            res=can fail    */
152 };
153
154 struct sout_input_t
155 {
156     sout_instance_t *p_sout;
157
158     es_format_t     *p_fmt;
159     block_fifo_t    *p_fifo;
160
161     void            *p_sys;
162 };
163
164
165 VLC_EXPORT( sout_mux_t *,   sout_MuxNew,          ( sout_instance_t*, char *, sout_access_out_t * ) );
166 VLC_EXPORT( sout_input_t *, sout_MuxAddStream,    ( sout_mux_t *, es_format_t * ) );
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
171 static inline int sout_MuxControl( sout_mux_t *p_mux, int i_query, ... )
172 {
173     va_list args;
174     int     i_result;
175
176     va_start( args, i_query );
177     i_result = p_mux->pf_control( p_mux, i_query, args );
178     va_end( args );
179     return i_result;
180 }
181
182 /****************************************************************************
183  * sout_stream:
184  ****************************************************************************/
185 struct sout_stream_t
186 {
187     VLC_COMMON_MEMBERS
188
189     module_t          *p_module;
190     sout_instance_t   *p_sout;
191
192     char              *psz_name;
193     config_chain_t        *p_cfg;
194     char              *psz_next;
195
196     /* Subpicture unit */
197     spu_t             *p_spu;
198
199     /* add, remove a stream */
200     sout_stream_id_t *(*pf_add)( sout_stream_t *, es_format_t * );
201     int               (*pf_del)( sout_stream_t *, sout_stream_id_t * );
202     /* manage a packet */
203     int               (*pf_send)( sout_stream_t *, sout_stream_id_t *, block_t* );
204
205     /* private */
206     sout_stream_sys_t *p_sys;
207 };
208
209 VLC_EXPORT( sout_stream_t *, sout_StreamNew, ( sout_instance_t *, char *psz_chain ) );
210 VLC_EXPORT( void,            sout_StreamDelete, ( sout_stream_t * ) );
211
212 static inline sout_stream_id_t *sout_StreamIdAdd( sout_stream_t *s, es_format_t *fmt )
213 {
214     return s->pf_add( s, fmt );
215 }
216 static inline int sout_StreamIdDel( sout_stream_t *s, sout_stream_id_t *id )
217 {
218     return s->pf_del( s, id );
219 }
220 static inline int sout_StreamIdSend( sout_stream_t *s, sout_stream_id_t *id, block_t *b )
221 {
222     return s->pf_send( s, id, b );
223 }
224
225 /****************************************************************************
226  * Announce handler
227  ****************************************************************************/
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* ) );
230
231 VLC_EXPORT(announce_method_t*,   sout_SAPMethod, (void) );
232 VLC_EXPORT(void,                 sout_MethodRelease, (announce_method_t *) );
233
234 /** SDP */
235
236 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 ) );
237 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) );
238 VLC_EXPORT( char *, sdp_AddAttribute, (char **sdp, const char *name, const char *fmt, ...) ATTRIBUTE_FORMAT( 3, 4 ) );
239
240
241 #ifdef __cplusplus
242 }
243 #endif
244
245 #endif