include/stream_output.h

   1 /*****************************************************************************
   2  * stream_output.h : stream output module
   3  *****************************************************************************
   4  * Copyright (C) 2002-2005 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 /*****************************************************************************
  28  * sout_instance_t: stream output thread descriptor
  29  *****************************************************************************/
  30
  31 #include "vlc_es.h"
  32
  33 /****************************************************************************
  34  * sout_instance_t: p_sout
  35  ****************************************************************************/
  36 struct sout_instance_t
  37 {
  38     VLC_COMMON_MEMBERS
  39
  40     char *psz_sout;
  41     char *psz_chain;
  42
  43     /* meta data (Read only) XXX it won't be set before the first packet received */
  44     vlc_meta_t          *p_meta;
  45
  46     int                 i_out_pace_nocontrol;   /* count of output that can't control the space */
  47
  48     vlc_mutex_t         lock;
  49     sout_stream_t       *p_stream;
  50
  51     /* sout private */
  52     sout_instance_sys_t *p_sys;
  53 };
  54
  55 /****************************************************************************
  56  * sout_stream_id_t: opaque (private for all sout_stream_t)
  57  ****************************************************************************/
  58 typedef struct sout_stream_id_t  sout_stream_id_t;
  59
  60 /****************************************************************************
  61  * sout_packetizer_input_t: p_sout <-> p_packetizer
  62  ****************************************************************************/
  63 struct sout_packetizer_input_t
  64 {
  65     sout_instance_t     *p_sout;
  66
  67     es_format_t         *p_fmt;
  68
  69     sout_stream_id_t    *id;
  70 };
  71
  72 #define sout_NewInstance(a,b) __sout_NewInstance(VLC_OBJECT(a),b)
  73 VLC_EXPORT( sout_instance_t *,  __sout_NewInstance,  ( vlc_object_t *, char * ) );
  74 VLC_EXPORT( void,               sout_DeleteInstance, ( sout_instance_t * ) );
  75
  76 VLC_EXPORT( sout_packetizer_input_t *, sout_InputNew,( sout_instance_t *, es_format_t * ) );
  77 VLC_EXPORT( int,                sout_InputDelete,      ( sout_packetizer_input_t * ) );
  78 VLC_EXPORT( int,                sout_InputSendBuffer,  ( sout_packetizer_input_t *, block_t* ) );
  79
  80 /****************************************************************************
  81  * sout_access_out_t:
  82  ****************************************************************************/
  83 struct sout_access_out_t
  84 {
  85     VLC_COMMON_MEMBERS
  86
  87     module_t                *p_module;
  88
  89     sout_instance_t         *p_sout;
  90
  91     char                    *psz_access;
  92     config_chain_t              *p_cfg;
  93
  94     int                      i_writes;
  95     int64_t                  i_sent_bytes;      ///< This is a "local" counter that is reset each
  96                                                 // time it is transferred to stats
  97
  98     char                    *psz_name;
  99     sout_access_out_sys_t   *p_sys;
 100     int                     (*pf_seek)( sout_access_out_t *, off_t );
 101     int                     (*pf_read)( sout_access_out_t *, block_t * );
 102     int                     (*pf_write)( sout_access_out_t *, block_t * );
 103 };
 104
 105 VLC_EXPORT( sout_access_out_t *,sout_AccessOutNew, ( sout_instance_t *, char *psz_access, char *psz_name ) );
 106 VLC_EXPORT( void,               sout_AccessOutDelete, ( sout_access_out_t * ) );
 107 VLC_EXPORT( int,                sout_AccessOutSeek,   ( sout_access_out_t *, off_t ) );
 108 VLC_EXPORT( int,                sout_AccessOutRead,   ( sout_access_out_t *, block_t * ) );
 109 VLC_EXPORT( int,                sout_AccessOutWrite,  ( sout_access_out_t *, block_t * ) );
 110
 111 /****************************************************************************
 112  * mux:
 113  ****************************************************************************/
 114 struct  sout_mux_t
 115 {
 116     VLC_COMMON_MEMBERS
 117     module_t            *p_module;
 118
 119     sout_instance_t     *p_sout;
 120
 121     char                *psz_mux;
 122     config_chain_t          *p_cfg;
 123
 124     sout_access_out_t   *p_access;
 125
 126     int                 (*pf_addstream)( sout_mux_t *, sout_input_t * );
 127     int                 (*pf_delstream)( sout_mux_t *, sout_input_t * );
 128     int                 (*pf_mux)      ( sout_mux_t * );
 129     int                 (*pf_control)  ( sout_mux_t *, int, va_list );
 130
 131     /* here are all inputs accepted by muxer */
 132     int                 i_nb_inputs;
 133     sout_input_t        **pp_inputs;
 134
 135
 136     /* mux private */
 137     sout_mux_sys_t      *p_sys;
 138
 139     /* XXX private to stream_output.c */
 140     /* if muxer doesn't support adding stream at any time then we first wait
 141      *  for stream then we refuse all stream and start muxing */
 142     vlc_bool_t  b_add_stream_any_time;
 143     vlc_bool_t  b_waiting_stream;
 144     /* we wait one second after first stream added */
 145     mtime_t     i_add_stream_start;
 146 };
 147
 148 enum sout_mux_query_e
 149 {
 150     /* capabilities */
 151     MUX_CAN_ADD_STREAM_WHILE_MUXING,    /* arg1= vlc_bool_t *,      res=cannot fail */
 152     /* properties */
 153     MUX_GET_ADD_STREAM_WAIT,            /* arg1= vlc_bool_t *,      res=cannot fail */
 154     MUX_GET_MIME,                       /* arg1= char **            res=can fail    */
 155 };
 156
 157 struct sout_input_t
 158 {
 159     sout_instance_t *p_sout;
 160
 161     es_format_t     *p_fmt;
 162     block_fifo_t    *p_fifo;
 163
 164     void            *p_sys;
 165 };
 166
 167
 168 VLC_EXPORT( sout_mux_t *,   sout_MuxNew,          ( sout_instance_t*, char *, sout_access_out_t * ) );
 169 VLC_EXPORT( sout_input_t *, sout_MuxAddStream,    ( sout_mux_t *, es_format_t * ) );
 170 VLC_EXPORT( void,           sout_MuxDeleteStream, ( sout_mux_t *, sout_input_t * ) );
 171 VLC_EXPORT( void,           sout_MuxDelete,       ( sout_mux_t * ) );
 172 VLC_EXPORT( void,           sout_MuxSendBuffer, ( sout_mux_t *, sout_input_t  *, block_t * ) );
 173
 174 static inline int sout_MuxControl( sout_mux_t *p_mux, int i_query, ... )
 175 {
 176     va_list args;
 177     int     i_result;
 178
 179     va_start( args, i_query );
 180     i_result = p_mux->pf_control( p_mux, i_query, args );
 181     va_end( args );
 182     return i_result;
 183 }
 184
 185 /****************************************************************************
 186  * sout_stream:
 187  ****************************************************************************/
 188 struct sout_stream_t
 189 {
 190     VLC_COMMON_MEMBERS
 191
 192     module_t          *p_module;
 193     sout_instance_t   *p_sout;
 194
 195     char              *psz_name;
 196     config_chain_t        *p_cfg;
 197     char              *psz_next;
 198
 199     /* Subpicture unit */
 200     spu_t             *p_spu;
 201
 202     /* add, remove a stream */
 203     sout_stream_id_t *(*pf_add)( sout_stream_t *, es_format_t * );
 204     int               (*pf_del)( sout_stream_t *, sout_stream_id_t * );
 205     /* manage a packet */
 206     int               (*pf_send)( sout_stream_t *, sout_stream_id_t *, block_t* );
 207
 208     /* private */
 209     sout_stream_sys_t *p_sys;
 210 };
 211
 212 VLC_EXPORT( sout_stream_t *, sout_StreamNew, ( sout_instance_t *, char *psz_chain ) );
 213 VLC_EXPORT( void,            sout_StreamDelete, ( sout_stream_t * ) );
 214
 215 static inline sout_stream_id_t *sout_StreamIdAdd( sout_stream_t *s, es_format_t *fmt )
 216 {
 217     return s->pf_add( s, fmt );
 218 }
 219 static inline int sout_StreamIdDel( sout_stream_t *s, sout_stream_id_t *id )
 220 {
 221     return s->pf_del( s, id );
 222 }
 223 static inline int sout_StreamIdSend( sout_stream_t *s, sout_stream_id_t *id, block_t *b )
 224 {
 225     return s->pf_send( s, id, b );
 226 }
 227
 228 /****************************************************************************
 229  * Announce handler mess
 230  ****************************************************************************/
 231 struct sap_session_t;
 232
 233 struct session_descriptor_t
 234 {
 235     char *psz_name;
 236     char *psz_uri;
 237     int i_port;
 238     int i_ttl;
 239     int i_payload;   /* SAP Payload type */
 240
 241     char *psz_group;
 242
 243     sap_session_t *p_sap; /* If we have a sap session, remember it */
 244     char *psz_sdp;
 245     vlc_bool_t b_rtp;
 246 };
 247
 248 #define METHOD_TYPE_SAP 1
 249
 250 struct announce_method_t
 251 {
 252     int i_type;
 253 };
 254
 255
 256 /* A SAP session descriptor, enqueued in the SAP handler queue */
 257 struct sap_session_t
 258 {
 259     char          *psz_sdp;
 260     uint8_t       *psz_data;
 261     unsigned      i_length;
 262     sap_address_t *p_address;
 263
 264     /* Last and next send */
 265     mtime_t        i_last;
 266     mtime_t        i_next;
 267 };
 268
 269 /* The SAP handler, running in a separate thread */
 270 struct sap_handler_t
 271 {
 272     VLC_COMMON_MEMBERS /* needed to create a thread */
 273
 274     sap_session_t **pp_sessions;
 275     sap_address_t **pp_addresses;
 276
 277     vlc_bool_t b_control;
 278
 279     int i_sessions;
 280     int i_addresses;
 281
 282     int i_current_session;
 283
 284     int (*pf_add)  ( sap_handler_t*, session_descriptor_t *);
 285     int (*pf_del)  ( sap_handler_t*, session_descriptor_t *);
 286
 287     /* private data, not in p_sys as there is one kind of sap_handler_t */
 288 };
 289
 290 /* The main announce handler object */
 291 struct announce_handler_t
 292 {
 293     VLC_COMMON_MEMBERS
 294
 295     sap_handler_t *p_sap;
 296 };
 297
 298 /* End */
 299
 300 /* Announce system */
 301 VLC_EXPORT( int,                sout_AnnounceRegister, (sout_instance_t *,session_descriptor_t*, announce_method_t* ) );
 302 VLC_EXPORT(session_descriptor_t*,sout_AnnounceRegisterSDP, (sout_instance_t *,const char *, const char *, announce_method_t* ) );
 303 VLC_EXPORT( int,                sout_AnnounceUnRegister, (sout_instance_t *,session_descriptor_t* ) );
 304
 305 VLC_EXPORT(session_descriptor_t*,sout_AnnounceSessionCreate, (void) );
 306 VLC_EXPORT(void,                 sout_AnnounceSessionDestroy, (session_descriptor_t *) );
 307 VLC_EXPORT(announce_method_t*,   sout_AnnounceMethodCreate, (int) );
 308
 309 #define announce_HandlerCreate(a) __announce_HandlerCreate(VLC_OBJECT(a))
 310 announce_handler_t*  __announce_HandlerCreate( vlc_object_t *);
 311
 312 /* Private functions for the announce handler */
 313 int announce_HandlerDestroy( announce_handler_t * );
 314 int announce_Register( announce_handler_t *p_announce,
 315                 session_descriptor_t *p_session,
 316                 announce_method_t *p_method );
 317 int announce_UnRegister( announce_handler_t *p_announce,
 318                 session_descriptor_t *p_session );
 319
 320 sap_handler_t *announce_SAPHandlerCreate( announce_handler_t *p_announce );
 321 void announce_SAPHandlerDestroy( sap_handler_t *p_sap );