Rebased on master and removed alpha channel (again)

1 files changed, 3 insertions, 147 deletions

diff --git a/toxav/toxav.h b/toxav/toxav.h
index c75f8bff..0b9be241 100644
--- a/toxav/toxav.h
+++ b/toxav/toxav.h
@@ -82,35 +82,27 @@ typedef struct Tox Tox;
 #define TOXAV_DEFINED
 typedef struct ToxAV ToxAV;
 #endif /* TOXAV_DEFINED */
-
-
 /*******************************************************************************
  *
  * :: API version
  *
  ******************************************************************************/
-
-
-
 /**
  * The major version number. Incremented when the API or ABI changes in an
  * incompatible way.
  */
 #define TOXAV_VERSION_MAJOR               0u
-
 /**
  * The minor version number. Incremented when functionality is added without
  * breaking the API or ABI. Set to 0 when the major version number is
  * incremented.
  */
 #define TOXAV_VERSION_MINOR               0u
-
 /**
  * The patch or revision number. Incremented when bugfixes are applied without
  * changing any functionality or API or ABI.
  */
 #define TOXAV_VERSION_PATCH               0u
-
 /**
  * A macro to check at preprocessing time whether the client code is compatible
  * with the installed version of ToxAV.
@@ -120,84 +112,65 @@ typedef struct ToxAV ToxAV;
    (TOXAV_VERSION_MINOR > MINOR ||                                \
     (TOXAV_VERSION_MINOR == MINOR &&                              \
      TOXAV_VERSION_PATCH >= PATCH)))
-
 /**
  * A macro to make compilation fail if the client code is not compatible with
  * the installed version of ToxAV.
  */
 #define TOXAV_VERSION_REQUIRE(MAJOR, MINOR, PATCH)                \
   typedef char toxav_required_version[TOXAV_IS_COMPATIBLE(MAJOR, MINOR, PATCH) ? 1 : -1]
-
 /**
  * A convenience macro to call toxav_version_is_compatible with the currently
  * compiling API version.
  */
 #define TOXAV_VERSION_IS_ABI_COMPATIBLE()                         \
   toxav_version_is_compatible(TOXAV_VERSION_MAJOR, TOXAV_VERSION_MINOR, TOXAV_VERSION_PATCH)
-
 /**
  * Return the major version number of the library. Can be used to display the
  * ToxAV library version or to check whether the client is compatible with the
  * dynamically linked version of ToxAV.
  */
 uint32_t toxav_version_major(void);
-
 /**
  * Return the minor version number of the library.
  */
 uint32_t toxav_version_minor(void);
-
 /**
  * Return the patch number of the library.
  */
 uint32_t toxav_version_patch(void);
-
 /**
  * Return whether the compiled library version is compatible with the passed
  * version numbers.
  */
 bool toxav_version_is_compatible(uint32_t major, uint32_t minor, uint32_t patch);
-
-
 /*******************************************************************************
  * 
  * :: Creation and destruction
  *
  ******************************************************************************/
-
-
-
 typedef enum TOXAV_ERR_NEW {
-
   /**
    * The function returned successfully.
    */
   TOXAV_ERR_NEW_OK,
-  
   /**
    * One of the arguments to the function was NULL when it was not expected.
    */
   TOXAV_ERR_NEW_NULL,
-  
   /**
    * Memory allocation failure while trying to allocate structures required for
    * the A/V session.
    */
   TOXAV_ERR_NEW_MALLOC,
-  
   /**
    * Attempted to create a second session for the same Tox instance.
    */
   TOXAV_ERR_NEW_MULTIPLE,
-  
 } TOXAV_ERR_NEW;
-
-
 /**
  * Start new A/V session. There can only be only one session per Tox instance.
  */
 ToxAV *toxav_new(Tox *tox, TOXAV_ERR_NEW *error);
-
 /**
  * Releases all resources associated with the A/V session.
  *
@@ -206,80 +179,59 @@ ToxAV *toxav_new(Tox *tox, TOXAV_ERR_NEW *error);
  * called and the av pointer becomes invalid.
  */
 void toxav_kill(ToxAV *toxAV);
-
 /**
  * Returns the Tox instance the A/V object was created for.
  */
 Tox *toxav_get_tox(const ToxAV *toxAV);
-
-
 /*******************************************************************************
  * 
  * :: A/V event loop
  *
  ******************************************************************************/
-
-
-
 /**
  * Returns the interval in milliseconds when the next toxav_iterate call should
  * be. If no call is active at the moment, this function returns 200.
  */
 uint32_t toxav_iteration_interval(const ToxAV *toxAV);
-
 /**
  * Main loop for the session. This function needs to be called in intervals of
  * toxav_iteration_interval() milliseconds. It is best called in the separate 
  * thread from tox_iterate.
  */
 void toxav_iterate(ToxAV *toxAV);
-
-
 /*******************************************************************************
  * 
  * :: Call setup
  *
  ******************************************************************************/
-
-
-
 typedef enum TOXAV_ERR_CALL {
-
   /**
    * The function returned successfully.
    */
   TOXAV_ERR_CALL_OK,
-  
   /**
    * A resource allocation error occurred while trying to create the structures
    * required for the call.
    */
   TOXAV_ERR_CALL_MALLOC,
-  
   /**
    * The friend number did not designate a valid friend.
    */
   TOXAV_ERR_CALL_FRIEND_NOT_FOUND,
-  
   /**
    * The friend was valid, but not currently connected.
    */
   TOXAV_ERR_CALL_FRIEND_NOT_CONNECTED,
-  
   /**
    * Attempted to call a friend while already in an audio or video call with
    * them.
    */
   TOXAV_ERR_CALL_FRIEND_ALREADY_IN_CALL,
-  
   /**
    * Audio or video bit rate is invalid.
    */
   TOXAV_ERR_CALL_INVALID_BIT_RATE,
-  
 } TOXAV_ERR_CALL;
-
-
 /**
  * Call a friend. This will start ringing the friend.
  *
@@ -294,7 +246,6 @@ typedef enum TOXAV_ERR_CALL {
  * video sending.
  */
 bool toxav_call(ToxAV *toxAV, uint32_t friend_number, uint32_t audio_bit_rate, uint32_t video_bit_rate, TOXAV_ERR_CALL *error);
-
 /**
  * The function type for the call callback.
  * 
@@ -303,47 +254,36 @@ bool toxav_call(ToxAV *toxAV, uint32_t friend_number, uint32_t audio_bit_rate, u
  * @param video_enabled True if friend is sending video.
  */
 typedef void toxav_call_cb(ToxAV *toxAV, uint32_t friend_number, bool audio_enabled, bool video_enabled, void *user_data);
-
-
 /**
  * Set the callback for the `call` event. Pass NULL to unset.
  *
  */
 void toxav_callback_call(ToxAV *toxAV, toxav_call_cb *callback, void *user_data);
-
 typedef enum TOXAV_ERR_ANSWER {
-
   /**
    * The function returned successfully.
    */
   TOXAV_ERR_ANSWER_OK,
-  
   /**
    * Failed to initialize codecs for call session. Note that codec initiation
    * will fail if there is no receive callback registered for either audio or
    * video.
    */
   TOXAV_ERR_ANSWER_CODEC_INITIALIZATION,
-  
   /**
    * The friend number did not designate a valid friend.
    */
   TOXAV_ERR_ANSWER_FRIEND_NOT_FOUND,
-  
   /**
    * The friend was valid, but they are not currently trying to initiate a call.
    * This is also returned if this client is already in a call with the friend.
    */
   TOXAV_ERR_ANSWER_FRIEND_NOT_CALLING,
-  
   /**
    * Audio or video bit rate is invalid.
    */
   TOXAV_ERR_ANSWER_INVALID_BIT_RATE,
-  
 } TOXAV_ERR_ANSWER;
-
-
 /**
  * Accept an incoming call.
  *
@@ -357,18 +297,12 @@ typedef enum TOXAV_ERR_ANSWER {
  * video sending.
  */
 bool toxav_answer(ToxAV *toxAV, uint32_t friend_number, uint32_t audio_bit_rate, uint32_t video_bit_rate, TOXAV_ERR_ANSWER *error);
-
-
 /*******************************************************************************
  * 
  * :: Call state graph
  *
  ******************************************************************************/
-
-
-
 enum TOXAV_CALL_STATE {
-
   /**
    * Set by the AV core if an error occurred on the remote end or if friend 
    * timed out. This is the final state after which no more state
@@ -376,34 +310,28 @@ enum TOXAV_CALL_STATE {
    * in combination with other call states.
    */
   TOXAV_CALL_STATE_ERROR = 1,
-  
   /**
    * The call has finished. This is the final state after which no more state
    * transitions can occur for the call. This call state will never be 
    * triggered in combination with other call states.
    */
   TOXAV_CALL_STATE_FINISHED = 2,
-  
   /**
    * The flag that marks that friend is sending audio.
    */
   TOXAV_CALL_STATE_SENDING_A = 4,
-  
   /**
    * The flag that marks that friend is sending video.
    */
   TOXAV_CALL_STATE_SENDING_V = 8,
-  
   /**
    * The flag that marks that friend is receiving audio.
    */
   TOXAV_CALL_STATE_RECEIVING_A = 16,
-  
   /**
    * The flag that marks that friend is receiving video.
    */
   TOXAV_CALL_STATE_RECEIVING_V = 32,
-  
 };
 
 
@@ -415,96 +343,72 @@ enum TOXAV_CALL_STATE {
  * the previous state. The state is set to 0 when the call is paused.
  */
 typedef void toxav_call_state_cb(ToxAV *toxAV, uint32_t friend_number, uint32_t state, void *user_data);
-
-
 /**
  * Set the callback for the `call_state` event. Pass NULL to unset.
  *
  */
 void toxav_callback_call_state(ToxAV *toxAV, toxav_call_state_cb *callback, void *user_data);
-
-
 /*******************************************************************************
  * 
  * :: Call control
  *
  ******************************************************************************/
-
-
-
 typedef enum TOXAV_CALL_CONTROL {
-
   /**
    * Resume a previously paused call. Only valid if the pause was caused by this
    * client, if not, this control is ignored. Not valid before the call is accepted.
    */
   TOXAV_CALL_CONTROL_RESUME,
-  
   /**
    * Put a call on hold. Not valid before the call is accepted.
    */
   TOXAV_CALL_CONTROL_PAUSE,
-  
   /**
    * Reject a call if it was not answered, yet. Cancel a call after it was
    * answered.
    */
   TOXAV_CALL_CONTROL_CANCEL,
-  
   /**
    * Request that the friend stops sending audio. Regardless of the friend's
    * compliance, this will cause the audio_receive_frame event to stop being
    * triggered on receiving an audio frame from the friend.
    */
   TOXAV_CALL_CONTROL_MUTE_AUDIO,
-  
   /**
    * Calling this control will notify client to start sending audio again.
    */
   TOXAV_CALL_CONTROL_UNMUTE_AUDIO,
-  
   /**
    * Request that the friend stops sending video. Regardless of the friend's
    * compliance, this will cause the video_receive_frame event to stop being
    * triggered on receiving an video frame from the friend.
    */
   TOXAV_CALL_CONTROL_HIDE_VIDEO,
-  
   /**
    * Calling this control will notify client to start sending video again.
    */
   TOXAV_CALL_CONTROL_SHOW_VIDEO,
-  
 } TOXAV_CALL_CONTROL;
-
-
 typedef enum TOXAV_ERR_CALL_CONTROL {
-
   /**
    * The function returned successfully.
    */
   TOXAV_ERR_CALL_CONTROL_OK,
-  
   /**
    * The friend_number passed did not designate a valid friend.
    */
   TOXAV_ERR_CALL_CONTROL_FRIEND_NOT_FOUND,
-  
   /**
    * This client is currently not in a call with the friend. Before the call is
    * answered, only CANCEL is a valid control.
    */
   TOXAV_ERR_CALL_CONTROL_FRIEND_NOT_IN_CALL,
-  
   /**
    * Happens if user tried to pause an already paused call or if trying to
    * resume a call that is not paused.
    */
   TOXAV_ERR_CALL_CONTROL_INVALID_TRANSITION,
-  
 } TOXAV_ERR_CALL_CONTROL;
-
-
 /**
  * Sends a call control command to a friend.
  *
@@ -515,41 +419,29 @@ typedef enum TOXAV_ERR_CALL_CONTROL {
  * @return true on success.
  */
 bool toxav_call_control(ToxAV *toxAV, uint32_t friend_number, TOXAV_CALL_CONTROL control, TOXAV_ERR_CALL_CONTROL *error);
-
-
 /*******************************************************************************
  * 
  * :: Controlling bit rates
  *
  ******************************************************************************/
-
-
-
 typedef enum TOXAV_ERR_SET_BIT_RATE {
-
   /**
    * The function returned successfully.
    */
   TOXAV_ERR_SET_BIT_RATE_OK,
-  
   /**
    * The bit rate passed was not one of the supported values.
    */
   TOXAV_ERR_SET_BIT_RATE_INVALID,
-  
   /**
    * The friend_number passed did not designate a valid friend.
    */
   TOXAV_ERR_SET_BIT_RATE_FRIEND_NOT_FOUND,
-  
   /**
    * This client is currently not in a call with the friend.
    */
   TOXAV_ERR_SET_BIT_RATE_FRIEND_NOT_IN_CALL,
-  
 } TOXAV_ERR_SET_BIT_RATE;
-
-
 /**
  * The function type for the audio_bit_rate_status callback.
  * 
@@ -564,14 +456,11 @@ typedef enum TOXAV_ERR_SET_BIT_RATE {
  * @param bit_rate The bit rate in Kb/sec.
  */
 typedef void toxav_audio_bit_rate_status_cb(ToxAV *toxAV, uint32_t friend_number, bool stable, uint32_t bit_rate, void *user_data);
-
-
 /**
  * Set the callback for the `audio_bit_rate_status` event. Pass NULL to unset.
  *
  */
 void toxav_callback_audio_bit_rate_status(ToxAV *toxAV, toxav_audio_bit_rate_status_cb *callback, void *user_data);
-
 /**
  * Set the audio bit rate to be used in subsequent audio frames. If the passed 
  * bit rate is the same as the current bit rate this function will return true 
@@ -588,7 +477,6 @@ void toxav_callback_audio_bit_rate_status(ToxAV *toxAV, toxav_audio_bit_rate_sta
  * 
  */
 bool toxav_audio_bit_rate_set(ToxAV *toxAV, uint32_t friend_number, uint32_t audio_bit_rate, bool force, TOXAV_ERR_SET_BIT_RATE *error);
-
 /**
  * The function type for the video_bit_rate_status callback.
  * 
@@ -603,14 +491,11 @@ bool toxav_audio_bit_rate_set(ToxAV *toxAV, uint32_t friend_number, uint32_t aud
  * @param bit_rate The bit rate in Kb/sec.
  */
 typedef void toxav_video_bit_rate_status_cb(ToxAV *toxAV, uint32_t friend_number, bool stable, uint32_t bit_rate, void *user_data);
-
-
 /**
  * Set the callback for the `video_bit_rate_status` event. Pass NULL to unset.
  *
  */
 void toxav_callback_video_bit_rate_status(ToxAV *toxAV, toxav_video_bit_rate_status_cb *callback, void *user_data);
-
 /**
  * Set the video bit rate to be used in subsequent video frames. If the passed 
  * bit rate is the same as the current bit rate this function will return true 
@@ -627,53 +512,39 @@ void toxav_callback_video_bit_rate_status(ToxAV *toxAV, toxav_video_bit_rate_sta
  * 
  */
 bool toxav_video_bit_rate_set(ToxAV *toxAV, uint32_t friend_number, uint32_t audio_bit_rate, bool force, TOXAV_ERR_SET_BIT_RATE *error);
-
-
 /*******************************************************************************
  * 
  * :: A/V sending
  *
  ******************************************************************************/
-
-
-
 typedef enum TOXAV_ERR_SEND_FRAME {
-
   /**
    * The function returned successfully.
    */
   TOXAV_ERR_SEND_FRAME_OK,
-  
   /**
    * In case of video, one of Y, U, or V was NULL. In case of audio, the samples
    * data pointer was NULL.
    */
   TOXAV_ERR_SEND_FRAME_NULL,
-  
   /**
    * The friend_number passed did not designate a valid friend.
    */
   TOXAV_ERR_SEND_FRAME_FRIEND_NOT_FOUND,
-  
   /**
    * This client is currently not in a call with the friend.
    */
   TOXAV_ERR_SEND_FRAME_FRIEND_NOT_IN_CALL,
-  
   /**
    * One of the frame parameters was invalid. E.g. the resolution may be too
    * small or too large, or the audio sampling rate may be unsupported.
    */
   TOXAV_ERR_SEND_FRAME_INVALID,
-  
   /**
    * Failed to push frame through rtp interface.
    */
   TOXAV_ERR_SEND_FRAME_RTP_FAILED,
-  
 } TOXAV_ERR_SEND_FRAME;
-
-
 /**
  * Send an audio frame to a friend.
  *
@@ -695,7 +566,6 @@ typedef enum TOXAV_ERR_SEND_FRAME {
  * rates are 8000, 12000, 16000, 24000, or 48000.
  */
 bool toxav_audio_send_frame(ToxAV *toxAV, uint32_t friend_number, const int16_t *pcm, size_t sample_count, uint8_t channels, uint32_t sampling_rate, TOXAV_ERR_SEND_FRAME *error);
-
 /**
  * Send a video frame to a friend.
  *
@@ -710,19 +580,13 @@ bool toxav_audio_send_frame(ToxAV *toxAV, uint32_t friend_number, const int16_t
  * @param y Y (Luminance) plane data.
  * @param u U (Chroma) plane data.
  * @param v V (Chroma) plane data.
- * @param a A (Alpha) plane data.
  */
-bool toxav_video_send_frame(ToxAV *toxAV, uint32_t friend_number, uint16_t width, uint16_t height, const uint8_t *y, const uint8_t *u, const uint8_t *v, const uint8_t *a, TOXAV_ERR_SEND_FRAME *error);
-
-
+bool toxav_video_send_frame(ToxAV *toxAV, uint32_t friend_number, uint16_t width, uint16_t height, const uint8_t *y, const uint8_t *u, const uint8_t *v, TOXAV_ERR_SEND_FRAME *error);
 /*******************************************************************************
  * 
  * :: A/V receiving
  *
  ******************************************************************************/
-
-
-
 /**
  * The function type for the audio_receive_frame callback.
  *
@@ -734,14 +598,11 @@ bool toxav_video_send_frame(ToxAV *toxAV, uint32_t friend_number, uint16_t width
  *
  */
 typedef void toxav_audio_receive_frame_cb(ToxAV *toxAV, uint32_t friend_number, const int16_t *pcm, size_t sample_count, uint8_t channels, uint32_t sampling_rate, void *user_data);
-
-
 /**
  * Set the callback for the `audio_receive_frame` event. Pass NULL to unset.
  *
  */
 void toxav_callback_audio_receive_frame(ToxAV *toxAV, toxav_audio_receive_frame_cb *callback, void *user_data);
-
 /**
  * The function type for the video_receive_frame callback.
  *
@@ -755,23 +616,18 @@ void toxav_callback_audio_receive_frame(ToxAV *toxAV, toxav_audio_receive_frame_
  *          Y = MAX(width, abs(ystride)) * height, 
  *          U = MAX(width/2, abs(ustride)) * (height/2) and 
  *          V = MAX(width/2, abs(vstride)) * (height/2).
- *          A = MAX(width, abs(astride)) * height.
  * @param ystride
  * @param ustride
- * @param vstride
- * @param astride Strides data. Strides represent padding for each plane
+ * @param vstride Strides data. Strides represent padding for each plane
  *                that may or may not be present. You must handle strides in
  *                your image processing code. Strides are negative if the 
  *                image is bottom-up hence why you MUST abs() it when
  *                calculating plane buffer size.
  */
-typedef void toxav_video_receive_frame_cb(ToxAV *toxAV, uint32_t friend_number, uint16_t width, uint16_t height, const uint8_t *y, const uint8_t *u, const uint8_t *v, const uint8_t *a, int32_t ystride, int32_t ustride, int32_t vstride, int32_t astride, void *user_data);
-
-
+typedef void toxav_video_receive_frame_cb(ToxAV *toxAV, uint32_t friend_number, uint16_t width, uint16_t height, const uint8_t *y, const uint8_t *u, const uint8_t *v, int32_t ystride, int32_t ustride, int32_t vstride, void *user_data);
 /**
  * Set the callback for the `video_receive_frame` event. Pass NULL to unset.
  *
  */
 void toxav_callback_video_receive_frame(ToxAV *toxAV, toxav_video_receive_frame_cb *callback, void *user_data);
-
 #endif