@voipsdk/react-native-voipcloud 1.0.0 → 1.0.2

package/ios/VoipCloud.xcframework/ios-arm64_x86_64-simulator/Headers/pjmedia/vid_stream.h

@@ -0,0 +1,514 @@
+/* 
+ * Copyright (C) 2011 Teluu Inc. (http://www.teluu.com)
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * 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-1307  USA 
+ */
+#ifndef __PJMEDIA_VID_STREAM_H__
+#define __PJMEDIA_VID_STREAM_H__
+
+
+/**
+ * @file vid_stream.h
+ * @brief Video Stream.
+ */
+
+#include <pjmedia/endpoint.h>
+#include <pjmedia/jbuf.h>
+#include <pjmedia/port.h>
+#include <pjmedia/rtcp.h>
+#include <pjmedia/rtcp_fb.h>
+#include <pjmedia/transport.h>
+#include <pjmedia/vid_codec.h>
+#include <pjmedia/stream_common.h>
+#include <pj/sock.h>
+
+PJ_BEGIN_DECL
+
+
+/**
+ * @defgroup PJMED_VID_STRM Video streams
+ * @ingroup PJMEDIA_PORT
+ * @brief Video communication via the network
+ * @{
+ *
+ * A video stream is a bidirectional video communication between two
+ * endpoints. It corresponds to a video media description ("m=video" line)
+ * in SDP session descriptor.
+ *
+ * A video stream consists of two unidirectional channels:
+ *  - encoding channel, which transmits unidirectional video to remote, and
+ *  - decoding channel, which receives unidirectional media from remote.
+ *
+ * A video stream exports two media port interface (see @ref PJMEDIA_PORT),
+ * one for each direction, and application normally uses this interface to
+ * interconnect the stream to other PJMEDIA components, e.g: the video
+ * capture port supplies frames to the encoding port and video renderer
+ * consumes frames from the decoding port.
+ *
+ * A video stream internally manages the following objects:
+ *  - an instance of video codec (see @ref PJMEDIA_VID_CODEC),
+ *  - an @ref PJMED_JBUF,
+ *  - two instances of RTP sessions (#pjmedia_rtp_session, one for each
+ *    direction),
+ *  - one instance of RTCP session (#pjmedia_rtcp_session),
+ *  - and a reference to video transport to send and receive packets
+ *    to/from the network (see @ref PJMEDIA_TRANSPORT).
+ *
+ * Video streams are created by calling #pjmedia_vid_stream_create(),
+ * specifying #pjmedia_stream_info structure in the parameter. Application
+ * can construct the #pjmedia_vid_stream_info structure manually, or use 
+ * #pjmedia_vid_stream_info_from_sdp() function to construct the
+ * #pjmedia_vid_stream_info from local and remote SDP session descriptors.
+ */
+
+
+/**
+ * Enumeration of video stream sending rate control.
+ */
+typedef enum pjmedia_vid_stream_rc_method
+{
+    /**
+     * No sending rate control. All outgoing RTP packets will be transmitted
+     * immediately right after encoding process is done.
+     */
+    PJMEDIA_VID_STREAM_RC_NONE              = 0,
+
+    /**
+     * Simple blocking. Each outgoing RTP packet transmission may be delayed
+     * to avoid peak bandwidth that is much higher than specified. The thread
+     * invoking the video stream put_frame(), e.g: video capture device thread,
+     * will be blocked whenever transmission delay takes place.
+     */
+    PJMEDIA_VID_STREAM_RC_SIMPLE_BLOCKING   = 1
+
+} pjmedia_vid_stream_rc_method;
+
+
+/**
+ * Structure of configuration settings for video stream sending rate control.
+ */
+typedef struct pjmedia_vid_stream_rc_config
+{
+    /**
+     * Rate control method.
+     *
+     * Default: PJMEDIA_VID_STREAM_RC_SIMPLE_BLOCKING.
+     */
+    pjmedia_vid_stream_rc_method    method;
+
+    /**
+     * Upstream/outgoing bandwidth. If this is set to zero, the video stream
+     * will use codec maximum bitrate setting.
+     *
+     * Default: 0 (follow codec maximum bitrate).
+     */
+    unsigned                        bandwidth;
+
+} pjmedia_vid_stream_rc_config;
+
+/**
+ * Structure of configuration settings for video stream sending keyframe 
+ * after it is created.
+ */
+typedef struct pjmedia_vid_stream_sk_config
+{
+    /**
+     * The number of keyframe to be sent after the stream is created.
+     *
+     * Default: PJMEDIA_VID_STREAM_START_KEYFRAME_CNT
+     */
+    unsigned                        count;
+
+    /**
+     * The keyframe sending interval after the stream is created.
+     *
+     * Default: PJMEDIA_VID_STREAM_START_KEYFRAME_INTERVAL_MSEC
+     */
+    unsigned                        interval;
+
+} pjmedia_vid_stream_sk_config;
+
+
+/** 
+ * This structure describes video stream information. Each video stream
+ * corresponds to one "m=" line in SDP session descriptor, and it has
+ * its own RTP/RTCP socket pair.
+ */
+typedef struct pjmedia_vid_stream_info
+{
+    pjmedia_type        type;       /**< Media type (audio, video)          */
+    pjmedia_tp_proto    proto;      /**< Transport protocol (RTP/AVP, etc.) */
+    pjmedia_dir         dir;        /**< Media direction.                   */
+    pj_sockaddr         local_addr; /**< Local RTP address                  */
+    pj_sockaddr         rem_addr;   /**< Remote RTP address                 */
+    pj_sockaddr         rem_rtcp;   /**< Optional remote RTCP address. If
+                                         sin_family is zero, the RTP address
+                                         will be calculated from RTP.       */
+    pj_bool_t           rtcp_mux;   /**< Use RTP and RTCP multiplexing.     */
+    pjmedia_rtcp_fb_info loc_rtcp_fb; /**< Local RTCP-FB info.              */
+    pjmedia_rtcp_fb_info rem_rtcp_fb; /**< Remote RTCP-FB info.             */
+    unsigned            tx_pt;      /**< Outgoing codec paylaod type.       */
+    unsigned            rx_pt;      /**< Incoming codec paylaod type.       */
+    pj_uint32_t         ssrc;       /**< RTP SSRC.                          */
+    pj_str_t            cname;      /**< RTCP CNAME.                        */
+    pj_bool_t           has_rem_ssrc;/**<Has remote RTP SSRC?               */
+    pj_uint32_t         rem_ssrc;   /**< Remote RTP SSRC.                   */
+    pj_str_t            rem_cname;  /**< Remote RTCP CNAME.                 */
+    pj_uint32_t         rtp_ts;     /**< Initial RTP timestamp.             */
+    pj_uint16_t         rtp_seq;    /**< Initial RTP sequence number.       */
+    pj_uint8_t          rtp_seq_ts_set;
+                                    /**< Bitmask flags if initial RTP sequence 
+                                         and/or timestamp for sender are set.
+                                         bit 0/LSB : sequence flag 
+                                         bit 1     : timestamp flag         */
+    int                 jb_init;    /**< Jitter buffer init delay in msec.  
+                                         (-1 for default).                  */
+    int                 jb_min_pre; /**< Jitter buffer minimum prefetch
+                                         delay in msec (-1 for default).    */
+    int                 jb_max_pre; /**< Jitter buffer maximum prefetch
+                                         delay in msec (-1 for default).    */
+    int                 jb_max;     /**< Jitter buffer max delay in msec.   */
+
+#if defined(PJMEDIA_STREAM_ENABLE_KA) && PJMEDIA_STREAM_ENABLE_KA!=0
+    pj_bool_t           use_ka;     /**< Stream keep-alive and NAT hole punch
+                                         (see #PJMEDIA_STREAM_ENABLE_KA)
+                                         is enabled?                        */
+    pjmedia_stream_ka_config ka_cfg;
+                                    /**< Stream send kep-alive settings.    */
+#endif
+
+    pjmedia_vid_codec_info   codec_info;  /**< Incoming codec format info.  */
+    pjmedia_vid_codec_param *codec_param; /**< Optional codec param.        */
+
+    pj_bool_t           rtcp_sdes_bye_disabled; 
+                                    /**< Disable automatic sending of RTCP
+                                         SDES and BYE.                      */
+
+    pjmedia_vid_stream_rc_config rc_cfg;
+                                    /**< Stream send rate control settings. */
+
+    pjmedia_vid_stream_sk_config sk_cfg;
+                                    /**< Stream send keyframe settings.     */
+} pjmedia_vid_stream_info;
+
+
+/**
+ * This function will initialize the video stream info based on information
+ * in both SDP session descriptors for the specified stream index. 
+ * The remaining information will be taken from default codec parameters. 
+ * If socket info array is specified, the socket will be copied to the 
+ * session info as well.
+ *
+ * @param si            Stream info structure to be initialized.
+ * @param pool          Pool to allocate memory.
+ * @param endpt         PJMEDIA endpoint instance.
+ * @param local         Local SDP session descriptor.
+ * @param remote        Remote SDP session descriptor.
+ * @param stream_idx    Media stream index in the session descriptor.
+ *
+ * @return              PJ_SUCCESS if stream info is successfully initialized.
+ */
+PJ_DECL(pj_status_t)
+pjmedia_vid_stream_info_from_sdp(pjmedia_vid_stream_info *si,
+                                 pj_pool_t *pool,
+                                 pjmedia_endpt *endpt,
+                                 const pjmedia_sdp_session *local,
+                                 const pjmedia_sdp_session *remote,
+                                 unsigned stream_idx);
+
+
+/**
+ * Initialize the video stream rate control with default settings.
+ *
+ * @param cfg           Video stream rate control structure to be initialized.
+ */
+PJ_DECL(void)
+pjmedia_vid_stream_rc_config_default(pjmedia_vid_stream_rc_config *cfg);
+
+/**
+ * Initialize the video stream send keyframe with default settings.
+ *
+ * @param cfg           Video stream send keyframe structure to be initialized.
+ */
+PJ_DECL(void)
+pjmedia_vid_stream_sk_config_default(pjmedia_vid_stream_sk_config *cfg);
+
+
+/*
+ * Opaque declaration for video stream.
+ */
+typedef struct pjmedia_vid_stream pjmedia_vid_stream;
+
+
+/**
+ * Create a video stream based on the specified parameter. After the video
+ * stream has been created, application normally would want to get the media
+ * port interface of the stream, by calling pjmedia_vid_stream_get_port().
+ * The media port interface exports put_frame() and get_frame() function,
+ * used to transmit and receive media frames from the stream.
+ *
+ * Without application calling put_frame() and get_frame(), there will be 
+ * no media frames transmitted or received by the stream.
+ *
+ * @param endpt         Media endpoint.
+ * @param pool          Optional pool to allocate memory for the stream. If
+ *                      this is not specified, one will be created internally.
+ *                      A large number of memory may be needed because jitter
+ *                      buffer needs to preallocate some storage.
+ * @param info          Stream information to create the stream. Upon return,
+ *                      this info will be updated with the information from
+ *                      the instantiated codec. Note that if the "pool"
+ *                      argument is NULL, some fields in this "info" parameter
+ *                      will be allocated from the internal pool of the
+ *                      stream, which means that they will only remain valid
+ *                      as long as the stream is not destroyed.
+ * @param tp            Media transport instance used to transmit and receive
+ *                      RTP/RTCP packets to/from the underlying network.
+ * @param user_data     Arbitrary user data (for future callback feature).
+ * @param p_stream      Pointer to receive the video stream.
+ *
+ * @return              PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_stream_create(
+                                        pjmedia_endpt *endpt,
+                                        pj_pool_t *pool,
+                                        pjmedia_vid_stream_info *info,
+                                        pjmedia_transport *tp,
+                                        void *user_data,
+                                        pjmedia_vid_stream **p_stream);
+
+/**
+ * Destroy the video stream.
+ *
+ * @param stream        The video stream.
+ *
+ * @return              PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_stream_destroy(pjmedia_vid_stream *stream);
+
+
+/**
+ * Get the media port interface of the stream. The media port interface
+ * declares put_frame() and get_frame() function, which is the only 
+ * way for application to transmit and receive media frames from the
+ * stream. As bidirectional video streaming may have different video
+ * formats in the encoding and decoding direction, there are two media
+ * ports exported by the video stream, one for each direction.
+ *
+ * @param stream        The video stream.
+ * @param dir           The video direction.
+ * @param p_port        Pointer to receive the port interface.
+ *
+ * @return              PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_stream_get_port(
+                                            pjmedia_vid_stream *stream,
+                                            pjmedia_dir dir,
+                                            pjmedia_port **p_port);
+
+
+/**
+ * Get the media transport object associated with this stream.
+ *
+ * @param st            The video stream.
+ *
+ * @return              The transport object being used by the stream.
+ */
+PJ_DECL(pjmedia_transport*) pjmedia_vid_stream_get_transport(
+                                            pjmedia_vid_stream *st);
+
+
+/**
+ * Get the stream statistics. See also #pjmedia_stream_get_stat_jbuf()
+ *
+ * @param stream        The video stream.
+ * @param stat          Media stream statistics.
+ *
+ * @return              PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_stream_get_stat(
+                                            const pjmedia_vid_stream *stream,
+                                            pjmedia_rtcp_stat *stat);
+
+/**
+ * Reset the video stream statistics.
+ *
+ * @param stream        The video stream.
+ *
+ * @return              PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_stream_reset_stat(pjmedia_vid_stream *stream);
+
+
+/**
+ * Get current jitter buffer state. See also #pjmedia_stream_get_stat()
+ *
+ * @param stream        The video stream.
+ * @param state         Jitter buffer state.
+ *
+ * @return              PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_stream_get_stat_jbuf(
+                                            const pjmedia_vid_stream *stream,
+                                            pjmedia_jb_state *state);
+
+
+/**
+ * Get the stream info.
+ *
+ * @param stream        The video stream.
+ * @param info          Video stream info.
+ *
+ * @return              PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_stream_get_info(
+                                            const pjmedia_vid_stream *stream,
+                                            pjmedia_vid_stream_info *info);
+
+
+/**
+ * Start the video stream. This will start the appropriate channels
+ * in the video stream, depending on the video direction that was set
+ * when the stream was created.
+ *
+ * @param stream        The video stream.
+ *
+ * @return              PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_stream_start(pjmedia_vid_stream *stream);
+
+
+/**
+ * Modify the video stream's codec parameter after the codec is opened.
+ * Note that not all codec backends support modifying parameters during
+ * runtime and only certain parameters can be changed.
+ *
+ * Currently, only Video Toolbox and OpenH264 backends support runtime
+ * adjustment of encoding bitrate (avg_bps and max_bps).
+ *
+ * @param stream        The video stream.
+ * @param param         The new codec parameter.
+ *
+ * @return              PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t)
+pjmedia_vid_stream_modify_codec_param(pjmedia_vid_stream *stream,
+                                      const pjmedia_vid_codec_param *param);
+
+
+/**
+ * Query if the stream is started on the specified direction.
+ *
+ * @param stream        The video stream.
+ * @param dir           The direction to be checked.
+ *
+ * @return              PJ_TRUE if stream is started.
+ */
+PJ_DECL(pj_bool_t) pjmedia_vid_stream_is_running(pjmedia_vid_stream *stream,
+                                                 pjmedia_dir dir);
+
+/**
+ * Pause stream channels.
+ *
+ * @param stream        The video stream.
+ * @param dir           Which channel direction to pause.
+ *
+ * @return              PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_stream_pause(pjmedia_vid_stream *stream,
+                                              pjmedia_dir dir);
+
+/**
+ * Resume stream channels.
+ *
+ * @param stream        The video stream.
+ * @param dir           Which channel direction to resume.
+ *
+ * @return              PJ_SUCCESS on success;
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_stream_resume(pjmedia_vid_stream *stream,
+                                               pjmedia_dir dir);
+
+
+/**
+ * Force stream to send video keyframe on the next transmission.
+ *
+ * @param stream        The video stream.
+ *
+ * @return              PJ_SUCCESS on success;
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_stream_send_keyframe(
+                                                pjmedia_vid_stream *stream);
+
+
+/**
+ * Send RTCP SDES for the video stream.
+ *
+ * @param stream        The video stream.
+ *
+ * @return              PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_stream_send_rtcp_sdes(
+                                                pjmedia_vid_stream *stream);
+
+
+/**
+ * Send RTCP BYE for the video stream.
+ *
+ * @param stream        The video stream.
+ *
+ * @return              PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_stream_send_rtcp_bye(
+                                                pjmedia_vid_stream *stream);
+
+
+/**
+ * Send RTCP PLI for the video stream.
+ *
+ * @param stream        The video stream.
+ *
+ * @return              PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_stream_send_rtcp_pli(
+                                                pjmedia_vid_stream *stream);
+
+
+/**
+ * Get the RTP session information of the video media stream. This function 
+ * can be useful for app with custom media transport to inject/filter some 
+ * outgoing/incoming proprietary packets into normal video RTP traffics.
+ * This will return the original pointer to the internal states of the stream,
+ * and generally it is not advisable for app to modify them.
+ * 
+ * @param stream        The video media stream.
+ *
+ * @param session_info  The stream session info.
+ *
+ * @return              PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t)
+pjmedia_vid_stream_get_rtp_session_info(pjmedia_vid_stream *stream,
+                                   pjmedia_stream_rtp_sess_info *session_info);
+
+
+/**
+ * @}
+ */
+
+PJ_END_DECL
+
+
+#endif  /* __PJMEDIA_VID_STREAM_H__ */

package/ios/VoipCloud.xcframework/ios-arm64_x86_64-simulator/Headers/pjmedia/vid_tee.h

@@ -0,0 +1,141 @@
+/* 
+ * Copyright (C) 2011 Teluu Inc. (http://www.teluu.com)
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * 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-1307  USA 
+ */
+#ifndef __PJMEDIA_VID_TEE_H__
+#define __PJMEDIA_VID_TEE_H__
+
+/**
+ * @file vid_tee.h
+ * @brief Video tee (source duplicator).
+ */
+#include <pjmedia/port.h>
+
+/**
+ * @addtogroup PJMEDIA_VID_TEE Video source duplicator
+ * @ingroup PJMEDIA_PORT
+ * @brief Duplicate video data from a media port into multiple media port 
+ *  destinations
+ * @{
+ *
+ * This section describes media port to duplicate video data in the stream.
+ *
+ * A video tee branches video stream flow from one source port to multiple
+ * destination ports by simply duplicating the video data supplied by the
+ * source port and delivering the copy to all registered destinations.
+ *
+ * The video tee is a unidirectional port, i.e: data flows from source port
+ * to destination ports only. Also, the video source port MUST actively call
+ * pjmedia_port_put_frame() to the video tee and the video destination ports
+ * MUST NEVER call pjmedia_port_get_frame() to the video tee. Please note that
+ * there is no specific order of which destination port will receive a frame
+ * from the video tee.
+ *
+ * The video tee is not thread-safe, so it is application responsibility
+ * to synchronize video tee operations, e.g: make sure the source port is
+ * paused during adding or removing a destination port.
+ */
+
+PJ_BEGIN_DECL
+
+
+/**
+ * Enumeration of video tee flags.
+ */
+typedef enum pjmedia_vid_tee_flag
+{
+    /**
+     * Tell the video tee that the destination port will do in-place
+     * processing, so the delivered data may be modified by this port.
+     * If this flag is used, buffer will be copied before being given to
+     * the destination port.
+     */
+    PJMEDIA_VID_TEE_DST_DO_IN_PLACE_PROC    = 4,
+
+} pjmedia_vid_tee_flag;
+
+
+/**
+ * Create a video tee port with the specified source media port. Application
+ * should destroy the tee with pjmedia_port_destroy() as usual. Note that
+ * destroying the tee does not destroy its destination ports.
+ *
+ * @param pool              The pool.
+ * @param fmt               The source media port's format.
+ * @param max_dst_cnt       The maximum number of destination ports supported.
+ * @param p_vid_tee         Pointer to receive the video tee port.
+ *
+ * @return                  PJ_SUCCESS on success, or the appropriate
+ *                          error code.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_tee_create(pj_pool_t *pool,
+                                            const pjmedia_format *fmt,
+                                            unsigned max_dst_cnt,
+                                            pjmedia_port **p_vid_tee);
+
+/**
+ * Add a destination media port to the video tee. For this function, the
+ * destination port's media format must match the source format.
+ *
+ * @param vid_tee           The video tee.
+ * @param option            Video tee option, see pjmedia_vid_tee_flag.
+ * @param port              The destination media port.
+ *
+ * @return                  PJ_SUCCESS on success, or the appropriate error
+ *                          code.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_tee_add_dst_port(pjmedia_port *vid_tee,
+                                                  unsigned option,
+                                                  pjmedia_port *port);
+
+
+/**
+ * Add a destination media port to the video tee. This function will also
+ * create a converter if the destination port's media format does not match
+ * the source format.
+ *
+ * @param vid_tee           The video tee.
+ * @param option            Video tee option, see pjmedia_vid_tee_flag.
+ * @param port              The destination media port.
+ *
+ * @return                  PJ_SUCCESS on success, or the appropriate error
+ *                          code.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_tee_add_dst_port2(pjmedia_port *vid_tee,
+                                                   unsigned option,
+                                                   pjmedia_port *port);
+
+
+/**
+ * Remove a destination media port from the video tee.
+ *
+ * @param vid_tee           The video tee.
+ * @param port              The destination media port to be removed.
+ *
+ * @return                  PJ_SUCCESS on success, or the appropriate error
+ *                          code.
+ */
+PJ_DECL(pj_status_t) pjmedia_vid_tee_remove_dst_port(pjmedia_port *vid_tee,
+                                                     pjmedia_port *port);
+
+
+PJ_END_DECL
+
+/**
+ * @}
+ */
+
+#endif /* __PJMEDIA_VID_TEE_H__ */