test_res_rtp.c File Reference

RTP/RTCP Unit Tests. More...

#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/test.h"
#include "asterisk/rtp_engine.h"
#include "asterisk/data_buffer.h"
#include "asterisk/format_cache.h"
#include <assert.h>
#include <sched.h>

Include dependency graph for test_res_rtp.c:

Go to the source code of this file.

Enumerations
enum	test_type { TEST_TYPE_NONE = 0 , TEST_TYPE_NACK , TEST_TYPE_REMB , TEST_TYPE_STD_RTCP }

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static void	ast_sched_context_destroy_wrapper (struct ast_sched_context *sched)
	AST_TEST_DEFINE (fir_nominal)
	AST_TEST_DEFINE (lost_packet_stats_nominal)
	AST_TEST_DEFINE (mes)
	AST_TEST_DEFINE (nack_no_packet_loss)
	AST_TEST_DEFINE (nack_nominal)
	AST_TEST_DEFINE (nack_overflow)
	AST_TEST_DEFINE (remb_nominal)
	AST_TEST_DEFINE (sr_rr_nominal)
static int	load_module (void)
static void	SLEEP_SPINNER (int ms)
static int	test_init_rtp_instances (struct ast_rtp_instance **instance1, struct ast_rtp_instance **instance2, struct ast_sched_context *test_sched, enum test_type type)
static void	test_read_frames (struct ast_rtp_instance *instance, int num)
static void	test_write_and_read_frames (struct ast_rtp_instance *instance1, struct ast_rtp_instance *instance2, int seqno, int num)
static void	test_write_and_read_interleaved_frames (struct ast_rtp_instance *instance1, struct ast_rtp_instance *instance2, int howlong, int rtcp_interval)
static void	test_write_frames (struct ast_rtp_instance *instance, int seqno, int num)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "RTP/RTCP test module" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
static const struct ast_module_info *	ast_module_info = &__mod_info

Detailed Description

RTP/RTCP Unit Tests.

Author

Ben Ford bford.nosp@m.@dig.nosp@m.ium.c.nosp@m.om

Definition in file test_res_rtp.c.

Enumeration Type Documentation

test_type

enum test_type

Enumerator
TEST_TYPE_NONE
TEST_TYPE_NACK
TEST_TYPE_REMB
TEST_TYPE_STD_RTCP

Definition at line 42 of file test_res_rtp.c.

               {
    TEST_TYPE_NONE = 0, /* No special setup required */
    TEST_TYPE_NACK,     /* Enable NACK */
    TEST_TYPE_REMB,     /* Enable REMB */
    TEST_TYPE_STD_RTCP, /* Let the stack do RTCP */
};

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 719 of file test_res_rtp.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 719 of file test_res_rtp.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 719 of file test_res_rtp.c.

ast_sched_context_destroy_wrapper()

static void ast_sched_context_destroy_wrapper ( struct ast_sched_context *  sched )

static

Definition at line 49 of file test_res_rtp.c.

{
    if (sched) {
        ast_sched_context_destroy(sched);
    }
}

References ast_sched_context_destroy().

Referenced by AST_TEST_DEFINE().

AST_TEST_DEFINE() [1/8]

AST_TEST_DEFINE

(

fir_nominal

)

Definition at line 597 of file test_res_rtp.c.

{
    RAII_VAR(struct ast_rtp_instance *, instance1, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_rtp_instance *, instance2, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_sched_context *, test_sched, NULL, ast_sched_context_destroy_wrapper);
    RAII_VAR(struct ast_frame *, frame_in, NULL, ast_frfree);
    struct ast_frame frame_out = {
        .frametype = AST_FRAME_CONTROL,
        .subclass.integer = AST_CONTROL_VIDUPDATE,
    };
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "fir_nominal";
        info->category = "/res/res_rtp/";
        info->summary = "fir nominal unit test";
        info->description =
            "Tests sending and receiving a FIR packet";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    test_sched = ast_sched_context_create();
 
    if ((test_init_rtp_instances(&instance1, &instance2, test_sched, TEST_TYPE_NONE)) < 0) {
        ast_log(LOG_ERROR, "Failed to initialize test!\n");
        return AST_TEST_FAIL;
    }
 
    /* Send some packets to learn SSRC */
    test_write_and_read_frames(instance2, instance1, 1000, 10);
 
    /* The schedid must be 0 or greater, so let's do that now */
    ast_rtp_instance_set_schedid(instance1, 0);
 
    /*
     * This will not directly write a frame out, but cause Asterisk to see it as a FIR
     * request, which will then trigger rtp_write_rtcp_fir, which will send out the
     * appropriate packet.
     */
    ast_rtp_instance_write(instance1, &frame_out);
 
    /*
     * We only receive one frame, the FIR request. It won't have a subclass integer of
     * 206 (PSFB) because ast_rtcp_interpret sets it to 18 (AST_CONTROL_VIDUPDATE), so
     * check for that.
     */
    frame_in = ast_rtp_instance_read(instance2, 0);
    ast_test_validate(test, frame_in != NULL, "Did not receive a FIR frame");
    ast_test_validate(test, frame_in->frametype == AST_FRAME_CONTROL,
        "FIR frame did not have the expected frametype");
    ast_test_validate(test, frame_in->subclass.integer == AST_CONTROL_VIDUPDATE,
        "FIR frame did not have the expected subclass integer");
 
    return AST_TEST_PASS;
}

References AST_CONTROL_VIDUPDATE, AST_FRAME_CONTROL, ast_frfree, ast_log, ast_rtp_instance_destroy(), ast_rtp_instance_read(), ast_rtp_instance_write(), ast_sched_context_create(), ast_sched_context_destroy_wrapper(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_frame::frametype, sip_to_pjsip::info(), LOG_ERROR, NULL, RAII_VAR, TEST_EXECUTE, TEST_INIT, test_init_rtp_instances(), TEST_TYPE_NONE, and test_write_and_read_frames().

AST_TEST_DEFINE() [2/8]

AST_TEST_DEFINE

(

lost_packet_stats_nominal

)

Definition at line 395 of file test_res_rtp.c.

{
    RAII_VAR(struct ast_rtp_instance *, instance1, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_rtp_instance *, instance2, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_sched_context *, test_sched, NULL, ast_sched_context_destroy_wrapper);
    struct ast_rtp_instance_stats stats = { 0, };
    enum ast_rtp_instance_stat stat = AST_RTP_INSTANCE_STAT_ALL;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "lost_packet_stats_nominal";
        info->category = "/res/res_rtp/";
        info->summary = "lost packet stats nominal unit test";
        info->description =
            "Tests that when some packets are lost, we calculate that "
            "loss correctly when doing lost packet statistics";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    test_sched = ast_sched_context_create();
 
    if ((test_init_rtp_instances(&instance1, &instance2, test_sched, TEST_TYPE_NONE)) < 0) {
        ast_log(LOG_ERROR, "Failed to initialize test!\n");
        return AST_TEST_FAIL;
    }
 
    /* Start normally */
    test_write_and_read_frames(instance1, instance2, 1000, 10);
 
    /* Send some more packets, but with a gap */
    test_write_and_read_frames(instance1, instance2, 1015, 5);
 
    /* Send a RR to calculate lost packet statistics. We should be missing 5 packets */
    ast_rtp_instance_queue_report(instance1);
    test_write_frames(instance2, 1000, 1);
 
    /* Check RTCP stats to see if we got the expected packet loss count */
    ast_rtp_instance_get_stats(instance2, &stats, stat);
    ast_test_validate(test, stats.rxploss == 5 && stats.local_minrxploss == 5 &&
        stats.local_maxrxploss == 5, "Condition of 5 lost packets was not met");
 
    /* Drop 3 before writing 5 more */
    test_write_and_read_frames(instance1, instance2, 1023, 5);
 
    ast_rtp_instance_queue_report(instance1);
    test_write_frames(instance2, 1001, 1);
    ast_rtp_instance_get_stats(instance2, &stats, stat);
 
    /* Should now be missing 8 total packets with a change in min */
    ast_test_validate(test, stats.rxploss == 8 && stats.local_minrxploss == 3 &&
        stats.local_maxrxploss == 5);
 
    /* Write 5 more with no gaps */
    test_write_and_read_frames(instance1, instance2, 1028, 5);
 
    ast_rtp_instance_queue_report(instance1);
    test_write_frames(instance2, 1002, 1);
    ast_rtp_instance_get_stats(instance2, &stats, stat);
 
    /* Should still only be missing 8 total packets */
    ast_test_validate(test, stats.rxploss == 8 && stats.local_minrxploss == 3 &&
        stats.local_maxrxploss == 5);
 
    /* Now drop 1, write another 5, drop 8, and then write 5 */
    test_write_and_read_frames(instance1, instance2, 1034, 5);
    test_write_and_read_frames(instance1, instance2, 1047, 5);
 
    ast_rtp_instance_queue_report(instance1);
    test_write_frames(instance2, 1003, 1);
    ast_rtp_instance_get_stats(instance2, &stats, stat);
 
    /* Now it should be missing 17 total packets, with a change in max */
    ast_test_validate(test, stats.rxploss == 17 && stats.local_minrxploss == 3 &&
        stats.local_maxrxploss == 9);
 
    return AST_TEST_PASS;
}

References ast_log, ast_rtp_instance_destroy(), ast_rtp_instance_get_stats(), AST_RTP_INSTANCE_STAT_ALL, ast_sched_context_create(), ast_sched_context_destroy_wrapper(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, sip_to_pjsip::info(), ast_rtp_instance_stats::local_maxrxploss, ast_rtp_instance_stats::local_minrxploss, LOG_ERROR, NULL, RAII_VAR, ast_rtp_instance_stats::rxploss, TEST_EXECUTE, TEST_INIT, test_init_rtp_instances(), TEST_TYPE_NONE, test_write_and_read_frames(), and test_write_frames().

AST_TEST_DEFINE() [3/8]

AST_TEST_DEFINE

(

mes

)

Definition at line 659 of file test_res_rtp.c.

{
    RAII_VAR(struct ast_rtp_instance *, instance1, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_rtp_instance *, instance2, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_sched_context *, test_sched, NULL, ast_sched_context_destroy_wrapper);
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "mes";
        info->category = "/res/res_rtp/";
        info->summary = "Media Experience Score";
        info->description =
            "Tests calculation of Media Experience Score (only run by explicit request)";
        info->explicit_only = 1;
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    test_sched = ast_sched_context_create();
    ast_sched_start_thread(test_sched);
 
    if ((test_init_rtp_instances(&instance1, &instance2,
        test_sched, TEST_TYPE_NONE)) < 0) {
        ast_log(LOG_ERROR, "Failed to initialize test!\n");
        return AST_TEST_FAIL;
    }
 
    test_write_and_read_interleaved_frames(
        instance1, instance2, 1000, 5000);
 
    return AST_TEST_PASS;
}

References ast_log, ast_rtp_instance_destroy(), ast_sched_context_create(), ast_sched_context_destroy_wrapper(), ast_sched_start_thread(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, sip_to_pjsip::info(), LOG_ERROR, NULL, RAII_VAR, TEST_EXECUTE, TEST_INIT, test_init_rtp_instances(), TEST_TYPE_NONE, and test_write_and_read_interleaved_frames().

AST_TEST_DEFINE() [4/8]

AST_TEST_DEFINE

(

nack_no_packet_loss

)

Definition at line 262 of file test_res_rtp.c.

{
    RAII_VAR(struct ast_rtp_instance *, instance1, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_rtp_instance *, instance2, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_sched_context *, test_sched, NULL, ast_sched_context_destroy_wrapper);
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "nack_no_packet_loss";
        info->category = "/res/res_rtp/";
        info->summary = "nack no packet loss unit test";
        info->description =
            "Tests sending packets with no packet loss and "
            "validates that the send buffer stores sent packets "
            "and the receive buffer is empty";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    test_sched = ast_sched_context_create();
 
    if ((test_init_rtp_instances(&instance1, &instance2, test_sched, TEST_TYPE_NACK)) < 0) {
        ast_log(LOG_ERROR, "Failed to initialize test!\n");
        return AST_TEST_FAIL;
    }
 
    test_write_and_read_frames(instance1, instance2, 1000, 10);
 
    ast_test_validate(test, ast_rtp_instance_get_send_buffer_count(instance1) == 10,
        "Send buffer did not have the expected count of 10");
 
    ast_test_validate(test, ast_rtp_instance_get_recv_buffer_count(instance2) == 0,
        "Receive buffer did not have the expected count of 0");
 
    return AST_TEST_PASS;
}

References ast_log, ast_rtp_instance_destroy(), ast_sched_context_create(), ast_sched_context_destroy_wrapper(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, sip_to_pjsip::info(), LOG_ERROR, NULL, RAII_VAR, TEST_EXECUTE, TEST_INIT, test_init_rtp_instances(), TEST_TYPE_NACK, and test_write_and_read_frames().

AST_TEST_DEFINE() [5/8]

AST_TEST_DEFINE

(

nack_nominal

)

Definition at line 300 of file test_res_rtp.c.

{
    RAII_VAR(struct ast_rtp_instance *, instance1, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_rtp_instance *, instance2, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_sched_context *, test_sched, NULL, ast_sched_context_destroy_wrapper);
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "nack_nominal";
        info->category = "/res/res_rtp/";
        info->summary = "nack nominal unit test";
        info->description =
            "Tests sending packets with some packet loss and "
            "validates that a NACK request is sent on reaching "
            "the triggering amount of lost packets";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    test_sched = ast_sched_context_create();
 
    if ((test_init_rtp_instances(&instance1, &instance2, test_sched, TEST_TYPE_NACK)) < 0) {
        ast_log(LOG_ERROR, "Failed to initialize test!\n");
        return AST_TEST_FAIL;
    }
 
    /* Start normally */
    test_write_and_read_frames(instance1, instance2, 1000, 10);
 
    /* Set the number of packets to drop when we send them next */
    ast_rtp_instance_drop_packets(instance2, 10);
    test_write_and_read_frames(instance1, instance2, 1010, 10);
 
    /* Send enough packets to reach the NACK trigger */
    test_write_and_read_frames(instance1, instance2, 1020, ast_rtp_instance_get_recv_buffer_max(instance2) / 2);
 
    /* This needs to be read as RTCP */
    test_read_frames(instance1, 1);
 
    /* We should have the missing packets to read now */
    test_read_frames(instance2, 10);
 
    ast_test_validate(test, ast_rtp_instance_get_recv_buffer_count(instance2) == 0,
        "Receive buffer did not have the expected count of 0");
 
    return AST_TEST_PASS;
}

References ast_log, ast_rtp_instance_destroy(), ast_sched_context_create(), ast_sched_context_destroy_wrapper(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, sip_to_pjsip::info(), LOG_ERROR, NULL, RAII_VAR, TEST_EXECUTE, TEST_INIT, test_init_rtp_instances(), test_read_frames(), TEST_TYPE_NACK, and test_write_and_read_frames().

AST_TEST_DEFINE() [6/8]

AST_TEST_DEFINE

(

nack_overflow

)

Definition at line 349 of file test_res_rtp.c.

{
    RAII_VAR(struct ast_rtp_instance *, instance1, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_rtp_instance *, instance2, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_sched_context *, test_sched, NULL, ast_sched_context_destroy_wrapper);
    int max_packets;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "nack_overflow";
        info->category = "/res/res_rtp/";
        info->summary = "nack overflow unit test";
        info->description =
            "Tests that when the buffer hits its capacity, we "
            "queue all the packets we currently have stored";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    test_sched = ast_sched_context_create();
 
    if ((test_init_rtp_instances(&instance1, &instance2, test_sched, TEST_TYPE_NACK)) < 0) {
        ast_log(LOG_ERROR, "Failed to initialize test!\n");
        return AST_TEST_FAIL;
    }
 
    /* Start normally */
    test_write_and_read_frames(instance1, instance2, 1000, 10);
 
    /* Send enough packets to fill the buffer */
    max_packets = ast_rtp_instance_get_recv_buffer_max(instance2);
    test_write_and_read_frames(instance1, instance2, 1020, max_packets);
 
    ast_test_validate(test, ast_rtp_instance_get_recv_buffer_count(instance2) == max_packets,
        "Receive buffer did not have the expected count of max buffer size");
 
    /* Send the packet that will overflow the buffer */
    test_write_and_read_frames(instance1, instance2, 1020 + max_packets, 1);
 
    ast_test_validate(test, ast_rtp_instance_get_recv_buffer_count(instance2) == 0,
        "Receive buffer did not have the expected count of 0");
 
    return AST_TEST_PASS;
}

References ast_log, ast_rtp_instance_destroy(), ast_sched_context_create(), ast_sched_context_destroy_wrapper(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, sip_to_pjsip::info(), LOG_ERROR, NULL, RAII_VAR, TEST_EXECUTE, TEST_INIT, test_init_rtp_instances(), TEST_TYPE_NACK, and test_write_and_read_frames().

AST_TEST_DEFINE() [7/8]

AST_TEST_DEFINE

(

remb_nominal

)

Definition at line 475 of file test_res_rtp.c.

{
    RAII_VAR(struct ast_rtp_instance *, instance1, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_rtp_instance *, instance2, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_sched_context *, test_sched, NULL, ast_sched_context_destroy_wrapper);
    RAII_VAR(struct ast_frame *, frame_in, NULL, ast_frfree);
    /* Use the structure softmix_remb_collector uses to store information for REMB */
    struct ast_rtp_rtcp_feedback feedback = {
        .fmt = AST_RTP_RTCP_FMT_REMB,
        .remb.br_exp = 0,
        .remb.br_mantissa = 1000,
    };
    struct ast_frame frame_out = {
        .frametype = AST_FRAME_RTCP,
        .subclass.integer = AST_RTP_RTCP_PSFB,
        .data.ptr = &feedback,
        .datalen = sizeof(feedback),
    };
    struct ast_rtp_rtcp_feedback *received_feedback;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "remb_nominal";
        info->category = "/res/res_rtp/";
        info->summary = "remb nominal unit test";
        info->description =
            "Tests sending and receiving a REMB packet";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    test_sched = ast_sched_context_create();
 
    if ((test_init_rtp_instances(&instance1, &instance2, test_sched, TEST_TYPE_REMB)) < 0) {
        ast_log(LOG_ERROR, "Failed to initialize test!\n");
        return AST_TEST_FAIL;
    }
 
    /* The schedid must be 0 or greater, so let's do that now */
    ast_rtp_instance_set_schedid(instance1, 0);
 
    ast_rtp_instance_write(instance1, &frame_out);
 
    /* Verify the high level aspects of the frame */
    frame_in = ast_rtp_instance_read(instance2, 0);
    ast_test_validate(test, frame_in != NULL, "Did not receive a REMB frame");
    ast_test_validate(test, frame_in->frametype == AST_FRAME_RTCP,
        "REMB frame did not have the expected frametype");
    ast_test_validate(test, frame_in->subclass.integer == AST_RTP_RTCP_PSFB,
        "REMB frame did not have the expected subclass integer");
 
    /* Verify the actual REMB information itself */
    received_feedback = frame_in->data.ptr;
    ast_test_validate(test, received_feedback->fmt == AST_RTP_RTCP_FMT_REMB,
        "REMB frame did not have the expected feedback format");
    ast_test_validate(test, received_feedback->remb.br_exp == feedback.remb.br_exp,
        "REMB received exponent did not match sent exponent");
    ast_test_validate(test, received_feedback->remb.br_mantissa == feedback.remb.br_mantissa,
        "REMB received mantissa did not match sent mantissa");
 
    return AST_TEST_PASS;
}

References AST_FRAME_RTCP, ast_frfree, ast_log, ast_rtp_instance_destroy(), ast_rtp_instance_read(), ast_rtp_instance_write(), AST_RTP_RTCP_FMT_REMB, AST_RTP_RTCP_PSFB, ast_sched_context_create(), ast_sched_context_destroy_wrapper(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_rtp_rtcp_feedback_remb::br_exp, ast_rtp_rtcp_feedback_remb::br_mantissa, ast_rtp_rtcp_feedback::fmt, ast_frame::frametype, sip_to_pjsip::info(), LOG_ERROR, NULL, RAII_VAR, ast_rtp_rtcp_feedback::remb, TEST_EXECUTE, TEST_INIT, test_init_rtp_instances(), and TEST_TYPE_REMB.

AST_TEST_DEFINE() [8/8]

AST_TEST_DEFINE

(

sr_rr_nominal

)

Definition at line 539 of file test_res_rtp.c.

{
    RAII_VAR(struct ast_rtp_instance *, instance1, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_rtp_instance *, instance2, NULL, ast_rtp_instance_destroy);
    RAII_VAR(struct ast_sched_context *, test_sched, NULL, ast_sched_context_destroy_wrapper);
    RAII_VAR(struct ast_frame *, frame_in, NULL, ast_frfree);
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "sr_rr_nominal";
        info->category = "/res/res_rtp/";
        info->summary = "SR/RR nominal unit test";
        info->description =
            "Tests sending SR/RR and receiving it; includes SDES";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    test_sched = ast_sched_context_create();
 
    if ((test_init_rtp_instances(&instance1, &instance2, test_sched, TEST_TYPE_NONE)) < 0) {
        ast_log(LOG_ERROR, "Failed to initialize test!\n");
        return AST_TEST_FAIL;
    }
 
    test_write_and_read_frames(instance1, instance2, 1000, 10);
 
    /*
     * Set the send_report flag so we send a sender report instead of normal RTP. We
     * also need to ensure that SDES processed.
     */
    ast_rtp_instance_queue_report(instance1);
    test_write_frames(instance1, 1010, 1);
 
    frame_in = ast_rtp_instance_read(instance2, 0);
    ast_test_validate(test, frame_in->frametype == AST_FRAME_RTCP,
        "Sender report frame did not have the expected frametype");
    ast_test_validate(test, frame_in->subclass.integer == AST_RTP_RTCP_SR,
        "Sender report frame did not have the expected subclass integer");
    ast_test_validate(test, ast_rtp_instance_get_sdes_received(instance2) == 1,
        "SDES was never processed for sender report");
 
    ast_frfree(frame_in);
 
    /* Set the send_report flag so we send a receiver report instead of normal RTP */
    ast_rtp_instance_queue_report(instance1);
    test_write_frames(instance1, 1010, 1);
 
    frame_in = ast_rtp_instance_read(instance2, 0);
    ast_test_validate(test, frame_in->frametype == AST_FRAME_RTCP,
        "Receiver report frame did not have the expected frametype");
    ast_test_validate(test, frame_in->subclass.integer == AST_RTP_RTCP_RR,
        "Receiver report frame did not have the expected subclass integer");
 
    return AST_TEST_PASS;
}

References AST_FRAME_RTCP, ast_frfree, ast_log, ast_rtp_instance_destroy(), ast_rtp_instance_read(), AST_RTP_RTCP_RR, AST_RTP_RTCP_SR, ast_sched_context_create(), ast_sched_context_destroy_wrapper(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, sip_to_pjsip::info(), LOG_ERROR, NULL, RAII_VAR, TEST_EXECUTE, TEST_INIT, test_init_rtp_instances(), TEST_TYPE_NONE, test_write_and_read_frames(), and test_write_frames().

load_module()

static int load_module ( void  )

static

Definition at line 706 of file test_res_rtp.c.

{
    AST_TEST_REGISTER(nack_no_packet_loss);
    AST_TEST_REGISTER(nack_nominal);
    AST_TEST_REGISTER(nack_overflow);
    AST_TEST_REGISTER(lost_packet_stats_nominal);
    AST_TEST_REGISTER(remb_nominal);
    AST_TEST_REGISTER(sr_rr_nominal);
    AST_TEST_REGISTER(fir_nominal);
    AST_TEST_REGISTER(mes);
    return AST_MODULE_LOAD_SUCCESS;
}

References AST_MODULE_LOAD_SUCCESS, and AST_TEST_REGISTER.

SLEEP_SPINNER()

static void SLEEP_SPINNER ( int  ms )

static

Definition at line 155 of file test_res_rtp.c.

{
    struct timeval a = ast_tvnow();
 
    while(1) {
        sched_yield();
        if (ast_remaining_ms(a, ms) <= 0) {
            break;
        }
    }
}

References a, ast_remaining_ms(), and ast_tvnow().

Referenced by test_write_and_read_interleaved_frames().

test_init_rtp_instances()

static int test_init_rtp_instances ( struct ast_rtp_instance **  instance1, struct ast_rtp_instance **  instance2, struct ast_sched_context *  test_sched, enum test_type  type  )

static

Definition at line 56 of file test_res_rtp.c.

{
    struct ast_sockaddr addr1;
    struct ast_sockaddr addr2;
    enum ast_rtp_instance_rtcp rtcp_type = AST_RTP_INSTANCE_RTCP_MUX;
 
    ast_sockaddr_parse(&addr1, "127.0.0.1", 0);
    ast_sockaddr_parse(&addr2, "127.0.0.1", 0);
 
    *instance1 = ast_rtp_instance_new("asterisk", test_sched, &addr1, "instance1");
    *instance2 = ast_rtp_instance_new("asterisk", test_sched, &addr2, "instance2");
    if (!instance1 || !instance2) {
        return -1;
    }
 
    ast_rtp_instance_set_channel_id(*instance1, "instance1");
    ast_rtp_instance_set_channel_id(*instance2, "instance2");
 
    if (type == TEST_TYPE_STD_RTCP) {
        rtcp_type = AST_RTP_INSTANCE_RTCP_STANDARD;
    }
 
    ast_rtp_instance_set_prop(*instance1,
        AST_RTP_PROPERTY_RTCP, rtcp_type);
    ast_rtp_instance_set_prop(*instance2,
        AST_RTP_PROPERTY_RTCP, rtcp_type);
 
    if (type == TEST_TYPE_NACK) {
        ast_rtp_instance_set_prop(*instance1, AST_RTP_PROPERTY_RETRANS_RECV, 1);
        ast_rtp_instance_set_prop(*instance1, AST_RTP_PROPERTY_RETRANS_SEND, 1);
        ast_rtp_instance_set_prop(*instance2, AST_RTP_PROPERTY_RETRANS_RECV, 2);
        ast_rtp_instance_set_prop(*instance2, AST_RTP_PROPERTY_RETRANS_SEND, 2);
    } else if (type == TEST_TYPE_REMB) {
        ast_rtp_instance_set_prop(*instance1, AST_RTP_PROPERTY_REMB, 1);
        ast_rtp_instance_set_prop(*instance2, AST_RTP_PROPERTY_REMB, 1);
    }
 
    ast_rtp_instance_get_local_address(*instance1, &addr1);
    ast_rtp_instance_set_remote_address(*instance2, &addr1);
 
    ast_rtp_instance_get_local_address(*instance2, &addr2);
    ast_rtp_instance_set_remote_address(*instance1, &addr2);
 
    ast_rtp_instance_reset_test_engine(*instance1);
 
    ast_rtp_instance_activate(*instance1);
    ast_rtp_instance_activate(*instance2);
 
    return 0;
}

References ast_rtp_instance_activate(), ast_rtp_instance_get_local_address(), ast_rtp_instance_new(), AST_RTP_INSTANCE_RTCP_MUX, AST_RTP_INSTANCE_RTCP_STANDARD, ast_rtp_instance_set_channel_id(), ast_rtp_instance_set_prop(), ast_rtp_instance_set_remote_address, AST_RTP_PROPERTY_REMB, AST_RTP_PROPERTY_RETRANS_RECV, AST_RTP_PROPERTY_RETRANS_SEND, AST_RTP_PROPERTY_RTCP, ast_sockaddr_parse(), TEST_TYPE_NACK, TEST_TYPE_REMB, TEST_TYPE_STD_RTCP, and type.

Referenced by AST_TEST_DEFINE().

test_read_frames()

static void test_read_frames ( struct ast_rtp_instance *  instance, int  num  )

static

Definition at line 128 of file test_res_rtp.c.

{
    struct ast_frame *frame_in;
    int index;
 
    for (index = 0; index < num; index++) {
        frame_in = ast_rtp_instance_read(instance, 0);
        if (frame_in) {
            ast_frfree(frame_in);
        }
    }
}

References ast_frfree, and ast_rtp_instance_read().

Referenced by AST_TEST_DEFINE(), and test_write_and_read_frames().

test_write_and_read_frames()

static void test_write_and_read_frames ( struct ast_rtp_instance *  instance1, struct ast_rtp_instance *  instance2, int  seqno, int  num  )

static

Definition at line 141 of file test_res_rtp.c.

{
    test_write_frames(instance1, seqno, num);
    test_read_frames(instance2, num);
}

References ast_frame::seqno, test_read_frames(), and test_write_frames().

Referenced by AST_TEST_DEFINE().

test_write_and_read_interleaved_frames()

static void test_write_and_read_interleaved_frames ( struct ast_rtp_instance *  instance1, struct ast_rtp_instance *  instance2, int  howlong, int  rtcp_interval  )

static

Definition at line 171 of file test_res_rtp.c.

{
    char data[320] = "";
    int pktinterval = 20;
 
    struct ast_frame frame_out1 = {
        .frametype = AST_FRAME_VOICE,
        .subclass.format = ast_format_ulaw,
        .seqno = 4556,
        .data.ptr = data,
        .datalen = 160,
        .samples = 1,
        .len = pktinterval,
        .ts = 4622295,
    };
    struct ast_frame frame_out2 = {
        .frametype = AST_FRAME_VOICE,
        .subclass.format = ast_format_ulaw,
        .seqno = 6554,
        .data.ptr = data,
        .datalen = 160,
        .samples = 1,
        .len = pktinterval,
        .ts = 8622295,
    };
    struct ast_frame *frame_in1;
    struct ast_frame *frame_in2;
    int index;
    int num;
    int rtcpnum;
    int reverse = 1;
    int send_rtcp = 0;
 
    num = howlong / pktinterval;
 
    rtcpnum = rtcp_interval / pktinterval;
 
    ast_set_flag(&frame_out1, AST_FRFLAG_HAS_SEQUENCE_NUMBER);
    ast_set_flag(&frame_out1, AST_FRFLAG_HAS_TIMING_INFO);
    ast_set_flag(&frame_out2, AST_FRFLAG_HAS_SEQUENCE_NUMBER);
    ast_set_flag(&frame_out2, AST_FRFLAG_HAS_TIMING_INFO);
 
    for (index = 0; index < num; index++) {
        struct timeval start = ast_tvnow();
        time_t ms;
 
        if (index == 1) {
            ast_clear_flag(&frame_out1, AST_FRFLAG_HAS_SEQUENCE_NUMBER);
            ast_clear_flag(&frame_out1, AST_FRFLAG_HAS_TIMING_INFO);
            ast_clear_flag(&frame_out2, AST_FRFLAG_HAS_SEQUENCE_NUMBER);
            ast_clear_flag(&frame_out2, AST_FRFLAG_HAS_TIMING_INFO);
        }
        frame_out1.seqno += index;
        frame_out1.delivery = start;
        frame_out1.ts += frame_out1.len;
        ast_rtp_instance_write(instance1, &frame_out1);
 
        if (send_rtcp && index && (index % rtcpnum == 0)) {
            ast_rtp_instance_queue_report(instance1);
        }
 
        frame_in2 = ast_rtp_instance_read(instance2, 0);
        ast_frfree(frame_in2);
        frame_in2 = ast_rtp_instance_read(instance2, 1);
        ast_frfree(frame_in2);
 
        if (reverse) {
            frame_out2.seqno += index;
            frame_out2.delivery = ast_tvnow();
            frame_out2.ts += frame_out2.len;
            ast_rtp_instance_write(instance2, &frame_out2);
 
            if (send_rtcp && index && (index % rtcpnum == 0)) {
                ast_rtp_instance_queue_report(instance2);
            }
 
            frame_in1 = ast_rtp_instance_read(instance1, 0);
            ast_frfree(frame_in1);
            frame_in1 = ast_rtp_instance_read(instance1, 1);
            ast_frfree(frame_in1);
 
        }
 
        ms = frame_out1.len - ast_tvdiff_ms(ast_tvnow(),start);
        ms += (index % 2 ? 5 : 12);
        ms += (index % 3 ? 2 : 30);
        SLEEP_SPINNER(ms);
    }
}

References ast_clear_flag, ast_format_ulaw, AST_FRAME_VOICE, AST_FRFLAG_HAS_SEQUENCE_NUMBER, AST_FRFLAG_HAS_TIMING_INFO, ast_frfree, ast_rtp_instance_read(), ast_rtp_instance_write(), ast_set_flag, ast_tvdiff_ms(), ast_tvnow(), ast_frame::data, ast_frame::delivery, ast_frame::frametype, ast_frame::len, ast_frame::seqno, SLEEP_SPINNER(), and ast_frame::ts.

Referenced by AST_TEST_DEFINE().

test_write_frames()

static void test_write_frames ( struct ast_rtp_instance *  instance, int  seqno, int  num  )

static

Definition at line 109 of file test_res_rtp.c.

{
    char data[320] = "";
    struct ast_frame frame_out = {
        .frametype = AST_FRAME_VOICE,
        .subclass.format = ast_format_ulaw,
        .data.ptr = data,
        .datalen = 160,
    };
    int index;
 
    ast_set_flag(&frame_out, AST_FRFLAG_HAS_SEQUENCE_NUMBER);
 
    for (index = 0; index < num; index++) {
        frame_out.seqno = seqno + index;
        ast_rtp_instance_write(instance, &frame_out);
    }
}

References ast_format_ulaw, AST_FRAME_VOICE, AST_FRFLAG_HAS_SEQUENCE_NUMBER, ast_rtp_instance_write(), ast_set_flag, ast_frame::data, ast_frame::frametype, and ast_frame::seqno.

Referenced by AST_TEST_DEFINE(), and test_write_and_read_frames().

unload_module()

static int unload_module ( void  )

static

Definition at line 693 of file test_res_rtp.c.

{
    AST_TEST_UNREGISTER(mes);
    AST_TEST_UNREGISTER(nack_no_packet_loss);
    AST_TEST_UNREGISTER(nack_nominal);
    AST_TEST_UNREGISTER(nack_overflow);
    AST_TEST_UNREGISTER(lost_packet_stats_nominal);
    AST_TEST_UNREGISTER(remb_nominal);
    AST_TEST_UNREGISTER(sr_rr_nominal);
    AST_TEST_UNREGISTER(fir_nominal);
    return 0;
}

References AST_TEST_UNREGISTER.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "RTP/RTCP test module" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }

static

Definition at line 719 of file test_res_rtp.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 719 of file test_res_rtp.c.