test_args.h

Go to the documentation of this file.

// -------------------------------------------------------------------------------------------
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// This file is part of the AWS CDI-SDK, licensed under the BSD 2-Clause "Simplified" License.
// License details at: https://github.com/aws/aws-cdi-sdk/blob/mainline/LICENSE
// -------------------------------------------------------------------------------------------
 
#ifndef TEST_ARGS_H__
#define TEST_ARGS_H__
 
#include <stdbool.h>
 
#include "cdi_baseline_profile_01_00_api.h"
#include "cdi_baseline_profile_02_00_api.h"
#include "cdi_core_api.h"
#include "cdi_logger_api.h"
#include "cdi_os_api.h"
#include "cdi_utility_api.h"
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
#define OPTARG_INVALID_CORE           (-1)
 
#define DEFAULT_NUM_LOOPS             (1)
 
#define RUN_FOREVER_VALUE             (0)
 
#define MAX_CHARACTERS_LOG_COMPONENTS (256)
 
#define MAX_CHARACTERS_CONNECTION_INFO (20)
 
#define PCR_VIDEO_SAMPLE_RATE          (90000)
 
typedef enum {
    kTestPatternSame,
    kTestPatternInc,
    kTestPatternSHR,
    kTestPatternSHL,
    kTestPatternNone,
    kTestPatternIgnore,
} TestPatternType;
 
typedef enum {
    kTestOptionLogSingleFile,
    kTestOptionLogMultipleFiles,
    kTestOptionUseStderr,
    kTestOptionMultiWindowConsole,
    kTestOptionConnectionName,
    kTestOptionTransmit,
    kTestOptionReceive,
    kTestOptionAVMAutoRx,
    kTestOptionAVMVideo,
    kTestOptionAVMAudio,
    kTestOptionAVMAncillary,
    kTestOptionStreamID,
    kTestOptionConfigSkip,
    kTestOptionKeepAlive,
    kTestOptionAdapter,
    kTestOptionBufferType,
    kTestOptionLocalIP,
    kTestOptionDestPort,
    kTestOptionRemoteIP,
    kTestOptionBindIP,
    kTestOptionShareThread,
    kTestOptionCore,
    kTestOptionPayloadSize,
    kTestOptionNumTransactions,
    kTestOptionRate,
    kTestOptionTxTimeout,
    kTestOptionRxBufferDelay,
    kTestOptionPattern,
    kTestOptionPatternStart,
    kTestOptionUseRiffFile,
    kTestOptionFileRead,
    kTestOptionFileWrite,
    kTestOptionNewConnection,
    kTestOptionNewConnectionMultipleEndpoints,
    kTestOptionNewStream,
    kTestOptionConnectionTimeout,
    kTestOptionLogLevel,
    kTestOptionLogComponent,
    kTestOptionLogTimestamps,
    kTestOptionNumLoops,
    kTestOptionStatsConfigPeriod,
#ifndef CDI_NO_MONITORING
    kTestOptionStatsConfigCloudWatch,
#endif
    kTestOptionNoPayloadUserData,
    kTestOptionHelp,
    kTestOptionHelpVideo,
    kTestOptionHelpAudio,
    kTestOptionHelpRiff,
    kTestOptionHelpStats,
    kTestOptionVersion,
    // NOTE: Must keep in sync with OptDef my_options[] table in test_args.c.
} TestOptionNames;
 
typedef struct {
    int stream_id;
    int payload_size;
    bool avm_auto_rx;
    CdiBaselineAvmPayloadType avm_data_type;
    CdiAvmVideoConfig video_params;
    CdiAvmAudioConfig audio_params;
    CdiAvmAncillaryDataConfig ancillary_data_params;
    int config_skip;
    TestPatternType pattern_type;
    CdiAvmConfig avm_config;
    int unit_size;
    uint64_t pattern_start;
    bool riff_file;
    const char* file_read_str;
    const char* file_write_str;
 
    int dest_port;
 
    const char* remote_adapter_ip_str;
} StreamSettings;
 
typedef struct {
    bool tx;
    bool rx;
    char connection_name_str[CDI_MAX_CONNECTION_NAME_STRING_LENGTH];
    CdiConnectionProtocolType connection_protocol;
    bool keep_alive;
    CdiBufferType buffer_type;
    const char* local_adapter_ip_str;
    int dest_port;
    const char* remote_adapter_ip_str;
    const char* bind_ip_addr_str;
    int num_transactions;
    int rate_numerator;
    int rate_denominator;
    int tx_timeout;
    int rx_buffer_delay_ms;
    bool arg_error;
    uint32_t rate_period_microseconds;
    int shared_thread_id;
    int thread_core_num;
    int number_of_streams;
    StreamSettings stream_settings[CDI_MAX_SIMULTANEOUS_TX_PAYLOADS_PER_CONNECTION];
    int stats_period_seconds;
    bool multiple_endpoints;
} TestSettings;
 
typedef struct TestConnectionInfo TestConnectionInfo;
 
typedef struct {
    CdiLogLevel log_level;
 
    int num_loops;
 
    int connection_timeout_seconds;
 
    bool use_single_connection_log_file;
 
    CdiLogMethod base_log_method;
 
    char base_log_filename_str[CDI_MAX_LOG_FILENAME_LENGTH];
 
    char sdk_log_filename_str[CDI_MAX_LOG_FILENAME_LENGTH];
 
    CdiLogHandle test_app_global_log_handle;
 
    CdiLogComponent log_component[kLogComponentLast];
 
    bool use_multiwindow_console;
 
    bool use_stderr;
 
    CdiAdapterData adapter_data;
 
    bool use_cloudwatch;
 
    CdiCloudWatchConfigData cloudwatch_config;
 
    bool no_payload_user_data;
 
    int total_num_connections;
 
    TestConnectionInfo* connection_info_array;
 
    int num_connections_established;
 
    CdiSignalType all_connected_signal;
 
    bool log_timestamps;
} GlobalTestSettings;
 
typedef enum {
    kProgramExecutionStatusContinue, 
    kProgramExecutionStatusExitOk,   
    kProgramExecutionStatusExitError 
} ProgramExecutionStatus;
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
void PrintTestSettings(const TestSettings* const test_settings_ptr, const int num_connections);
 
 
void LogComponentToString(const CdiEnumStringKey* key_array, char* log_component_str, CdiLogComponent* log_component_ptr);
 
ProgramExecutionStatus GetArgs(int argc, const char** argv_ptr, TestSettings* test_settings_ptr,
                               int* num_connections_found);
 
#endif // TEST_ARGS_H__