sample.cpp File Reference

WANPIPE(tm) API C++ Sample Code. More...

#include "sangoma_port.h"
#include "sangoma_port_configurator.h"
#include "sangoma_interface.h"
#include <conio.h>
#include <iostream>
#include <string>

Include dependency graph for sample.cpp:

Go to the source code of this file.

Macros
#define	MAX_PATH   100
#define	DBG_MAIN   if(1)printf
#define	ERR_MAIN   printf("%s():line:%d:Error:", __FUNCTION__, __LINE__);printf
#define	INFO_MAIN   if(1)printf
#define	MAIN_FUNC()   if(1)printf("%s():line:%d\n", __FUNCTION__, __LINE__)

Functions
sangoma_interface *	init (int wanpipe_number, int interface_number)
	Create a sangoma_interface class and setup callback functions. More...
void	cleanup (sangoma_interface *sang_if)
	Free Sangoma Interface Object. More...
int	start (sangoma_interface *sang_if)
	Run the main sangoma interface hanlder code. More...
void	stop (sangoma_interface *sang_if)
	Stop the Sangoma Interface Object. More...
void	PrintRxData (wp_api_hdr_t *hdr, void *pdata)
	Debug function used to print Rx Data. More...
int	tx_file (sangoma_interface *sang_if)
	Transmit a file on a sangoma interface / device. More...
int	my_getch ()
int __cdecl	main (int argc, char *argv[])

Variables
wp_program_settings_t	program_settings
callback_functions_t	callback_functions
CRITICAL_SECTION	PrintCriticalSection
CRITICAL_SECTION	TdmEventCriticalSection

Detailed Description

WANPIPE(tm) API C++ Sample Code.

Author(s): David Rokhvarg Nenad Corbic

Copyright: (c) 2005-2009 Sangoma Technologies

• Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of the Sangoma Technologies nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY Sangoma Technologies ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Sangoma Technologies BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

Definition in file sample.cpp.

Function Documentation

sangoma_interface * init	(	int	wanpipe_number,
		int	interface_number
	)

Create a sangoma_interface class and setup callback functions.

Parameters

wanpipe_number	wanpipe device number obtained from the hardware probe info, span
interface_number	wanpipe interface number, corresponds to a channel in a span

Returns

sangoma_interface object pointer - ok or NULL if error.

Definition at line 111 of file sample.cpp.

{
    sangoma_interface   *sang_if = NULL;
    DBG_MAIN("%s()\n", __FUNCTION__);

    if(program_settings.use_ctrl_dev == 1){
        sang_if = new sangoma_api_ctrl_dev();
    }else if(program_settings.use_logger_dev == 1){
        sang_if = new sangoma_api_logger_dev();
    }else{
        sang_if = new sangoma_interface(wanpipe_number, interface_number);
    }

    if(sang_if->init(&callback_functions)){
        delete sang_if;
        return NULL;
    }

    DBG_MAIN("init(): OK\n");
    return sang_if;
}

void cleanup

(

sangoma_interface *

sang_if

)

Free Sangoma Interface Object.

Parameters

sang_if

Sangoma interface object pointer

Returns

void

Definition at line 139 of file sample.cpp.

{
    DBG_MAIN("cleanup()\n");
    if(sang_if){
        delete sang_if;
    }
}

int start

(

sangoma_interface *

sang_if

)

Run the main sangoma interface hanlder code.

Parameters

sang_if

Sangoma interface object pointer

Returns

0 - ok Non Zero - Error

Definition at line 153 of file sample.cpp.

Referenced by sangoma_hwec_audio_buffer_playout().

{
    DBG_MAIN("start()\n");
    return sang_if->run();
}

Here is the caller graph for this function:

void stop

(

sangoma_interface *

sang_if

)

Stop the Sangoma Interface Object.

Parameters

sang_if

Sangoma interface object pointer

Returns

void

Definition at line 165 of file sample.cpp.

{
    DBG_MAIN("stop()\n");
    sang_if->stop();
}

void PrintRxData	(	wp_api_hdr_t *	hdr,
		void *	data
	)

Debug function used to print Rx Data.

Parameters

pRx	API data element strcutre containt header + data

Returns

void

Definition at line 177 of file sample.cpp.

References wp_api_hdr::data_length, wp_api_hdr::time_stamp_sec, and wp_api_hdr::time_stamp_usec.

{
    unsigned short  datlen;
    unsigned char * data;
    static unsigned int rx_counter = 0;

    //NOTE: if running in BitStream mode, there will be TOO MUCH to print 
    datlen = hdr->data_length;
    data = (unsigned char*)pdata;

    rx_counter++;
    if(program_settings.silent){
        if((rx_counter % 1000) == 0){
            INFO_MAIN("Rx counter: %d, Rx datlen: %d\n", rx_counter, datlen);
#if 1
            INFO_MAIN("Timestamp: Seconds: %d, Microseconds: %d\n", 
                hdr->time_stamp_sec, hdr->time_stamp_usec);
#endif
        }
        return;
    }else{
        INFO_MAIN("Rx counter: %d, Rx datlen: %d. Data:\n", rx_counter, datlen);
    }

#if 1
    for(int ln = 0; ln < datlen; ln++){
        if((ln % 20 == 0)){
            if(ln){
                INFO_MAIN("\n");
            }
            INFO_MAIN("%04d ", ln/20);
        }
        INFO_MAIN("%02X ", data[ln]);
    }
    INFO_MAIN("\n");
#endif
}

int tx_file

(

sangoma_interface *

sang_if

)

Transmit a file on a sangoma interface / device.

Parameters

sang_if_ptr

sangoma interface pointer

Returns

0 - ok non-zero - Error

Definition at line 385 of file sample.cpp.

References wp_api_hdr::data_length, wp_api_hdr::operation_status, SANG_STATUS_SUCCESS, SANG_STATUS_TX_TIMEOUT, and sangoma_interface::transmit().

{
    FILE            *pFile;
    unsigned int    tx_counter=0, bytes_read_from_file, total_bytes_read_from_file=0;
    wp_api_hdr_t    hdr;
    unsigned char   local_tx_data[SAMPLE_CPP_MAX_DATA_LEN];

    pFile = fopen( program_settings.szTxFileName, "rb" );
    if( pFile == NULL){
        ERR_MAIN( "Can't open file: [%s]\n", program_settings.szTxFileName );
        return 1;
    }

    do
    {
        //read tx data from the file. if 'bytes_read_from_file != txlength', end of file is reached
        bytes_read_from_file = fread( local_tx_data, 1, program_settings.txlength /* MTU size */, pFile );
        total_bytes_read_from_file += bytes_read_from_file;

        hdr.data_length = program_settings.txlength;//ALWAYS transmit MTU size over the BitStream/Voice interface
        hdr.operation_status = SANG_STATUS_TX_TIMEOUT;
        
        if(SANG_STATUS_SUCCESS != sang_if->transmit(&hdr, local_tx_data)){
            //error
            break;
        }
        
        tx_counter++;
        
        //DBG_MAIN("tx_counter: %u\r",tx_counter);

    }while(bytes_read_from_file == program_settings.txlength);

    INFO_MAIN("%s: Finished transmitting file \"%s\" (tx_counter: %u, total_bytes_read_from_file: %d)\n",
        sang_if->device_name, program_settings.szTxFileName, tx_counter, total_bytes_read_from_file);

    fclose( pFile );
    return 0;
}

Here is the call graph for this function: