]> git.sesse.net Git - vlc/blobdiff - include/stream_output.h
FSF address change.
[vlc] / include / stream_output.h
index cfedad98452a8d1fccce0099abc3263e2d310008..7b8d863c78963a24d08003c9a5cfd6b30b424e44 100644 (file)
@@ -1,12 +1,13 @@
 /*****************************************************************************
  * stream_output.h : stream output module
  *****************************************************************************
- * Copyright (C) 2002 VideoLAN
- * $Id: stream_output.h,v 1.20 2004/01/25 18:17:08 zorglub Exp $
+ * Copyright (C) 2002-2005 the VideoLAN team
+ * $Id$
  *
  * Authors: Christophe Massiot <massiot@via.ecp.fr>
  *          Laurent Aimar <fenrir@via.ecp.fr>
  *          Eric Petit <titer@videolan.org>
+ *          Jean-Paul Saman <jpsaman #_at_# m2x.nl>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -20,7 +21,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /*****************************************************************************
 
 #include "vlc_es.h"
 
-/*
- * i_allocated_size: size of allocated buffer
- * p_allocated_buffer: where data has been allocated
- *
- * i_buffer_size: sizeof buffer from p_buffer
- * p_buffer: where data begins
- * i_size: size of valid data
- *
- */
-#define SOUT_BUFFER_FLAGS_HEADER    0x0001
-
-/*
- * Flags for muxer/access private usage.
- */
-#define SOUT_BUFFER_FLAGS_PRIVATE_MASK  0xffff0000
-#define SOUT_BUFFER_FLAGS_PRIVATE_SHIFT 16
-
-struct sout_buffer_t
+/****************************************************************************
+ * sout_instance_t: p_sout
+ ****************************************************************************/
+struct sout_instance_t
 {
-    size_t                  i_allocated_size;
-    byte_t                  *p_allocated_buffer;
+    VLC_COMMON_MEMBERS
 
-    size_t                  i_buffer_size;
-    byte_t                  *p_buffer;
+    char *psz_sout;
+    char *psz_chain;
 
-    size_t                  i_size;
-    mtime_t                 i_length;
+    /* meta data (Read only) XXX it won't be set before the first packet received */
+    vlc_meta_t          *p_meta;
 
-    mtime_t                 i_dts;
-    mtime_t                 i_pts;
+    int                 i_out_pace_nocontrol;   /* count of output that can't control the space */
 
-    uint32_t                i_flags;
-    int                     i_bitrate;
+    vlc_mutex_t         lock;
+    sout_stream_t       *p_stream;
 
-    struct sout_buffer_t    *p_next;
+    /* sout private */
+    sout_instance_sys_t *p_sys;
 };
 
-struct sout_fifo_t
+/****************************************************************************
+ * sout_cfg_t:
+ ****************************************************************************/
+struct sout_cfg_t
 {
-    vlc_mutex_t         lock;                         /* fifo data lock */
-    vlc_cond_t          wait;         /* fifo data conditional variable */
+    sout_cfg_t  *p_next;
 
-    int                 i_depth;
-    sout_buffer_t       *p_first;
-    sout_buffer_t       **pp_last;
+    char        *psz_name;
+    char        *psz_value;
 };
 
-typedef struct sout_stream_id_t  sout_stream_id_t;
-
-/* for mux */
-struct sout_input_t
-{
-    sout_instance_t *p_sout;
-
-    es_format_t     *p_fmt;
-    sout_fifo_t     *p_fifo;
+#define sout_CfgParse( a, b, c, d ) __sout_CfgParse( VLC_OBJECT(a), b, c, d )
+VLC_EXPORT( void,   __sout_CfgParse, ( vlc_object_t *, char *psz_prefix, const char **ppsz_options, sout_cfg_t * ) );
+VLC_EXPORT( char *, sout_CfgCreate, ( char **, sout_cfg_t **, char * ) );
 
-    void            *p_sys;
-};
+/****************************************************************************
+ * sout_stream_id_t: opaque (private for all sout_stream_t)
+ ****************************************************************************/
+typedef struct sout_stream_id_t  sout_stream_id_t;
 
-/* for packetizer */
+/****************************************************************************
+ * sout_packetizer_input_t: p_sout <-> p_packetizer
+ ****************************************************************************/
 struct sout_packetizer_input_t
 {
-
     sout_instance_t     *p_sout;
 
     es_format_t         *p_fmt;
@@ -100,12 +84,17 @@ struct sout_packetizer_input_t
     sout_stream_id_t    *id;
 };
 
+#define sout_NewInstance(a,b) __sout_NewInstance(VLC_OBJECT(a),b)
+VLC_EXPORT( sout_instance_t *,  __sout_NewInstance,  ( vlc_object_t *, char * ) );
+VLC_EXPORT( void,               sout_DeleteInstance, ( sout_instance_t * ) );
 
-#define SOUT_METHOD_NONE        0x00
-#define SOUT_METHOD_FILE        0x10
-#define SOUT_METHOD_NETWORK     0x20
+VLC_EXPORT( sout_packetizer_input_t *, sout_InputNew,( sout_instance_t *, es_format_t * ) );
+VLC_EXPORT( int,                sout_InputDelete,      ( sout_packetizer_input_t * ) );
+VLC_EXPORT( int,                sout_InputSendBuffer,  ( sout_packetizer_input_t *, block_t* ) );
 
-typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
+/****************************************************************************
+ * sout_access_out_t:
+ ****************************************************************************/
 struct sout_access_out_t
 {
     VLC_COMMON_MEMBERS
@@ -119,66 +108,44 @@ struct sout_access_out_t
 
     char                    *psz_name;
     sout_access_out_sys_t   *p_sys;
-    int                     (* pf_seek  )( sout_access_out_t *,
-                                           off_t );
-    int                     (* pf_read  )( sout_access_out_t *,
-                                           sout_buffer_t * );
-    int                     (* pf_write )( sout_access_out_t *,
-                                           sout_buffer_t * );
+    int                     (*pf_seek)( sout_access_out_t *, off_t );
+    int                     (*pf_read)( sout_access_out_t *, block_t * );
+    int                     (*pf_write)( sout_access_out_t *, block_t * );
 };
 
-/*
- * i_query parameter of pf_mux_capacity
- */
-/* SOUT_MUX_CAP_GET_ADD_STREAM_ANY_TIME:    p_args=NULL, p_answer=&boolean */
-#define SOUT_MUX_CAP_GET_ADD_STREAM_ANY_TIME    0x01
-/* SOUT_MUX_CAP_GET_STREAMABLE:             p_args=NULL, p_answer=&boolean */
-#define SOUT_MUX_CAP_GET_STREAMABLE             0x02
-/* SOUT_MUX_CAP_GET_ADD_STREAM_WAIT:        p_args=NULL, p_answer=&boolean */
-#define SOUT_MUX_CAP_GET_ADD_STREAM_WAIT        0x03
-
-/*
- * return error code
- */
-#define SOUT_MUX_CAP_ERR_OK                 0x00
-#define SOUT_MUX_CAP_ERR_UNKNOWN            0x01
-#define SOUT_MUX_CAP_ERR_UNIMPLEMENTED      0x02
-
-typedef struct sout_mux_sys_t sout_mux_sys_t;
+VLC_EXPORT( sout_access_out_t *,sout_AccessOutNew, ( sout_instance_t *, char *psz_access, char *psz_name ) );
+VLC_EXPORT( void,               sout_AccessOutDelete, ( sout_access_out_t * ) );
+VLC_EXPORT( int,                sout_AccessOutSeek,   ( sout_access_out_t *, off_t ) );
+VLC_EXPORT( int,                sout_AccessOutRead,   ( sout_access_out_t *, block_t * ) );
+VLC_EXPORT( int,                sout_AccessOutWrite,  ( sout_access_out_t *, block_t * ) );
+
+/****************************************************************************
+ * mux:
+ ****************************************************************************/
 struct  sout_mux_t
 {
     VLC_COMMON_MEMBERS
-    module_t                *p_module;
-
-    sout_instance_t         *p_sout;
+    module_t            *p_module;
 
-    char                    *psz_mux;
-    sout_cfg_t              *p_cfg;
+    sout_instance_t     *p_sout;
 
-    sout_access_out_t       *p_access;
+    char                *psz_mux;
+    sout_cfg_t          *p_cfg;
 
-    int                     i_preheader;
-    int                     (* pf_capacity)  ( sout_mux_t *,
-                                               int, void *, void *);
-    int                     (* pf_addstream )( sout_mux_t *,
-                                               sout_input_t * );
-    int                     (* pf_delstream )( sout_mux_t *,
-                                               sout_input_t * );
-    int                     (* pf_mux )      ( sout_mux_t * );
+    sout_access_out_t   *p_access;
 
+    int                 (*pf_addstream)( sout_mux_t *, sout_input_t * );
+    int                 (*pf_delstream)( sout_mux_t *, sout_input_t * );
+    int                 (*pf_mux)      ( sout_mux_t * );
+    int                 (*pf_control)  ( sout_mux_t *, int, va_list );
 
     /* here are all inputs accepted by muxer */
-    int                     i_nb_inputs;
-    sout_input_t            **pp_inputs;
+    int                 i_nb_inputs;
+    sout_input_t        **pp_inputs;
 
 
     /* mux private */
-    sout_mux_sys_t          *p_sys;
-
-#if 0
-    /* creater private */
-    void                    *p_sys_owner;
-#endif
+    sout_mux_sys_t      *p_sys;
 
     /* XXX private to stream_output.c */
     /* if muxer doesn't support adding stream at any time then we first wait
@@ -189,59 +156,159 @@ struct  sout_mux_t
     mtime_t     i_add_stream_start;
 };
 
+enum sout_mux_query_e
+{
+    /* capabilities */
+    MUX_CAN_ADD_STREAM_WHILE_MUXING,    /* arg1= vlc_bool_t *,      res=cannot fail */
+    /* properties */
+    MUX_GET_ADD_STREAM_WAIT,            /* arg1= vlc_bool_t *,      res=cannot fail */
+    MUX_GET_MIME,                       /* arg1= char **            res=can fail    */
+};
 
-
-struct sout_cfg_t
+struct sout_input_t
 {
-    sout_cfg_t  *p_next;
+    sout_instance_t *p_sout;
 
-    char        *psz_name;
-    char        *psz_value;
+    es_format_t     *p_fmt;
+    block_fifo_t    *p_fifo;
+
+    void            *p_sys;
 };
 
-typedef struct sout_stream_sys_t sout_stream_sys_t;
+
+VLC_EXPORT( sout_mux_t *,   sout_MuxNew,          ( sout_instance_t*, char *, sout_access_out_t * ) );
+VLC_EXPORT( sout_input_t *, sout_MuxAddStream,    ( sout_mux_t *, es_format_t * ) );
+VLC_EXPORT( void,           sout_MuxDeleteStream, ( sout_mux_t *, sout_input_t * ) );
+VLC_EXPORT( void,           sout_MuxDelete,       ( sout_mux_t * ) );
+VLC_EXPORT( void,           sout_MuxSendBuffer, ( sout_mux_t *, sout_input_t  *, block_t * ) );
+
+static inline int sout_MuxControl( sout_mux_t *p_mux, int i_query, ... )
+{
+    va_list args;
+    int     i_result;
+
+    va_start( args, i_query );
+    i_result = p_mux->pf_control( p_mux, i_query, args );
+    va_end( args );
+    return i_result;
+}
+
+/****************************************************************************
+ * sout_stream:
+ ****************************************************************************/
 struct sout_stream_t
 {
     VLC_COMMON_MEMBERS
 
-    module_t                *p_module;
-    sout_instance_t         *p_sout;
+    module_t          *p_module;
+    sout_instance_t   *p_sout;
 
-    char                    *psz_name;
-    sout_cfg_t              *p_cfg;
-    char                    *psz_next;
+    char              *psz_name;
+    sout_cfg_t        *p_cfg;
+    char              *psz_next;
 
-    /* add, remove a stream */
-    sout_stream_id_t *      (*pf_add) ( sout_stream_t *, es_format_t * );
-    int                     (*pf_del) ( sout_stream_t *, sout_stream_id_t * );
+    /* Subpicture unit */
+    spu_t             *p_spu;
 
+    /* add, remove a stream */
+    sout_stream_id_t *(*pf_add)( sout_stream_t *, es_format_t * );
+    int               (*pf_del)( sout_stream_t *, sout_stream_id_t * );
     /* manage a packet */
-    int                     (*pf_send)( sout_stream_t *, sout_stream_id_t *, sout_buffer_t* );
+    int               (*pf_send)( sout_stream_t *, sout_stream_id_t *, block_t* );
 
     /* private */
-    sout_stream_sys_t       *p_sys;
+    sout_stream_sys_t *p_sys;
 };
 
-typedef struct sout_instance_sys_t sout_instance_sys_t;
-struct sout_instance_t
+VLC_EXPORT( sout_stream_t *, sout_StreamNew, ( sout_instance_t *, char *psz_chain ) );
+VLC_EXPORT( void,            sout_StreamDelete, ( sout_stream_t * ) );
+
+static inline sout_stream_id_t *sout_StreamIdAdd( sout_stream_t *s, es_format_t *fmt )
 {
-    VLC_COMMON_MEMBERS
+    return s->pf_add( s, fmt );
+}
+static inline int sout_StreamIdDel( sout_stream_t *s, sout_stream_id_t *id )
+{
+    return s->pf_del( s, id );
+}
+static inline int sout_StreamIdSend( sout_stream_t *s, sout_stream_id_t *id, block_t *b )
+{
+    return s->pf_send( s, id, b );
+}
 
-    char * psz_sout;
-    char * psz_chain;
+/****************************************************************************
+ * Announce handler mess
+ ****************************************************************************/
+struct sap_session_t;
 
-    /* muxer data */
-    int                     i_preheader;    /* max over all muxer */
+struct session_descriptor_t
+{
+    char *psz_name;
+    char *psz_uri;
+    int i_port;
+    int i_ttl;
+    int i_payload;   /* SAP Payload type */
 
-    int                     i_padding;      /* needed by some decoders */
+    char *psz_group;
 
-    vlc_mutex_t             lock;
-    sout_stream_t           *p_stream;
+    sap_session_t *p_sap; /* If we have a sap session, remember it */
+    char *psz_sdp;
+    vlc_bool_t b_rtp;
+};
 
-    /* sout private */
-    sout_instance_sys_t     *p_sys;
+#define METHOD_TYPE_SAP 1
+
+struct announce_method_t
+{
+    int i_type;
+};
+
+
+/* A SAP session descriptor, enqueued in the SAP handler queue */
+struct sap_session_t
+{
+    char          *psz_sdp;
+    uint8_t       *psz_data;
+    unsigned      i_length;
+    sap_address_t *p_address;
+
+    /* Last and next send */
+    mtime_t        i_last;
+    mtime_t        i_next;
 };
 
+/* The SAP handler, running in a separate thread */
+struct sap_handler_t
+{
+    VLC_COMMON_MEMBERS /* needed to create a thread */
+
+    sap_session_t **pp_sessions;
+    sap_address_t **pp_addresses;
+
+    vlc_bool_t b_control;
+
+    int i_sessions;
+    int i_addresses;
+
+    int i_current_session;
+
+    int (*pf_add)  ( sap_handler_t*, session_descriptor_t *);
+    int (*pf_del)  ( sap_handler_t*, session_descriptor_t *);
+
+    /* private data, not in p_sys as there is one kind of sap_handler_t */
+};
+
+/* The main announce handler object */
+struct announce_handler_t
+{
+    VLC_COMMON_MEMBERS
+
+    sap_handler_t *p_sap;
+};
+
+/* End */
+
+
 static inline sout_cfg_t *sout_cfg_find( sout_cfg_t *p_cfg, char *psz_name )
 {
     while( p_cfg && strcmp( p_cfg->psz_name, psz_name ) )
@@ -266,47 +333,26 @@ static inline char *sout_cfg_find_value( sout_cfg_t *p_cfg, char *psz_name )
 
     return NULL;
 }
-/*****************************************************************************
- * Prototypes
- *****************************************************************************/
-#define sout_NewInstance(a,b) __sout_NewInstance(VLC_OBJECT(a),b)
-VLC_EXPORT( sout_instance_t *, __sout_NewInstance,  ( vlc_object_t *, char * ) );
-VLC_EXPORT( void,              sout_DeleteInstance, ( sout_instance_t * ) );
-
-VLC_EXPORT( sout_fifo_t *,   sout_FifoCreate,     ( sout_instance_t * ) );
-VLC_EXPORT( void,            sout_FifoDestroy,    ( sout_instance_t *, sout_fifo_t * ) );
-VLC_EXPORT( void,            sout_FifoFree,       ( sout_instance_t *,sout_fifo_t * ) );
-
-VLC_EXPORT( void,            sout_FifoPut,        ( sout_fifo_t *, sout_buffer_t* ) );
-VLC_EXPORT( sout_buffer_t *, sout_FifoGet,        ( sout_fifo_t * ) );
-VLC_EXPORT( sout_buffer_t *, sout_FifoShow,       ( sout_fifo_t * ) );
-
-
-#define sout_InputNew( a, b ) __sout_InputNew( VLC_OBJECT(a), b )
-VLC_EXPORT( sout_packetizer_input_t *, __sout_InputNew,       ( vlc_object_t *, es_format_t * ) );
-VLC_EXPORT( int,            sout_InputDelete,      ( sout_packetizer_input_t * ) );
-VLC_EXPORT( int,            sout_InputSendBuffer,  ( sout_packetizer_input_t *, sout_buffer_t* ) );
-
-VLC_EXPORT( sout_buffer_t*, sout_BufferNew,    ( sout_instance_t *, size_t ) );
-VLC_EXPORT( int,            sout_BufferRealloc,( sout_instance_t *, sout_buffer_t*, size_t ) );
-VLC_EXPORT( int,            sout_BufferReallocFromPreHeader,( sout_instance_t *, sout_buffer_t*, size_t ) );
-VLC_EXPORT( int,            sout_BufferDelete, ( sout_instance_t *, sout_buffer_t* ) );
-VLC_EXPORT( sout_buffer_t*, sout_BufferDuplicate,(sout_instance_t *, sout_buffer_t * ) );
-VLC_EXPORT( void,           sout_BufferChain,  ( sout_buffer_t **, sout_buffer_t * ) );
-
-VLC_EXPORT( sout_access_out_t *, sout_AccessOutNew, ( sout_instance_t *, char *psz_access, char *psz_name ) );
-VLC_EXPORT( void,                sout_AccessOutDelete, ( sout_access_out_t * ) );
-VLC_EXPORT( int,                 sout_AccessOutSeek,   ( sout_access_out_t *, off_t ) );
-VLC_EXPORT( int,                 sout_AccessOutRead,   ( sout_access_out_t *, sout_buffer_t * ) );
-VLC_EXPORT( int,                 sout_AccessOutWrite,  ( sout_access_out_t *, sout_buffer_t * ) );
-
-VLC_EXPORT( sout_mux_t *,       sout_MuxNew,          ( sout_instance_t*, char *, sout_access_out_t * ) );
-VLC_EXPORT( sout_input_t *,     sout_MuxAddStream,    ( sout_mux_t *, es_format_t * ) );
-VLC_EXPORT( void,               sout_MuxDeleteStream, ( sout_mux_t *, sout_input_t * ) );
-VLC_EXPORT( void,               sout_MuxDelete,       ( sout_mux_t * ) );
-VLC_EXPORT( void,               sout_MuxSendBuffer, ( sout_mux_t *, sout_input_t  *, sout_buffer_t * ) );
-
-VLC_EXPORT( char *,             sout_cfg_parser, ( char **, sout_cfg_t **, char * ) );
-VLC_EXPORT( sout_stream_t *,    sout_stream_new, ( sout_instance_t *, char *psz_chain ) );
-VLC_EXPORT( void,               sout_stream_delete, ( sout_stream_t *p_stream ) );
 
+/* Announce system */
+VLC_EXPORT( int,                sout_AnnounceRegister, (sout_instance_t *,session_descriptor_t*, announce_method_t* ) );
+VLC_EXPORT(session_descriptor_t*,sout_AnnounceRegisterSDP, (sout_instance_t *,const char *, const char *, announce_method_t* ) );
+VLC_EXPORT( int,                sout_AnnounceUnRegister, (sout_instance_t *,session_descriptor_t* ) );
+
+VLC_EXPORT(session_descriptor_t*,sout_AnnounceSessionCreate, (void) );
+VLC_EXPORT(void,                 sout_AnnounceSessionDestroy, (session_descriptor_t *) );
+VLC_EXPORT(announce_method_t*,   sout_AnnounceMethodCreate, (int) );
+
+#define announce_HandlerCreate(a) __announce_HandlerCreate(VLC_OBJECT(a))
+announce_handler_t*  __announce_HandlerCreate( vlc_object_t *);
+
+/* Private functions for the announce handler */
+int announce_HandlerDestroy( announce_handler_t * );
+int announce_Register( announce_handler_t *p_announce,
+                session_descriptor_t *p_session,
+                announce_method_t *p_method );
+int announce_UnRegister( announce_handler_t *p_announce,
+                session_descriptor_t *p_session );
+
+sap_handler_t *announce_SAPHandlerCreate( announce_handler_t *p_announce );
+void announce_SAPHandlerDestroy( sap_handler_t *p_sap );