enumeration.h

Go to the documentation of this file.

/*
 * Licensed under the MIT License (MIT)
 *
 * Copyright (c) 2013 AudioScience Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#pragma once
#ifndef _AVDECC_CONTROLLER_LIB_ENUMERATION_H_
#define _AVDECC_CONTROLLER_LIB_ENUMERATION_H_

namespace avdecc_lib
{
    enum aem_cmds_values 
    {
        AEM_CMD_ACQUIRE_ENTITY,
        AEM_CMD_LOCK_ENTITY,
        AEM_CMD_ENTITY_AVAILABLE,
        AEM_CMD_CONTROLLER_AVAILABLE,
        AEM_CMD_READ_DESCRIPTOR,
        AEM_CMD_WRITE_DESCRIPTOR,
        AEM_CMD_SET_CONFIGURATION,
        AEM_CMD_GET_CONFIGURATION,
        AEM_CMD_SET_STREAM_FORMAT,
        AEM_CMD_GET_STREAM_FORMAT,
        AEM_CMD_SET_VIDEO_FORMAT,
        AEM_CMD_GET_VIDEO_FORMAT,
        AEM_CMD_SET_SENSOR_FORMAT,
        AEM_CMD_GET_SENSOR_FORMAT,
        AEM_CMD_SET_STREAM_INFO,
        AEM_CMD_GET_STREAM_INFO,
        AEM_CMD_SET_NAME,
        AEM_CMD_GET_NAME,
        AEM_CMD_SET_ASSOCIATION_ID,
        AEM_CMD_GET_ASSOCIATION_ID,
        AEM_CMD_SET_SAMPLING_RATE,
        AEM_CMD_GET_SAMPLING_RATE,
        AEM_CMD_SET_CLOCK_SOURCE,
        AEM_CMD_GET_CLOCK_SOURCE,
        AEM_CMD_SET_CONTROL,
        AEM_CMD_GET_CONTROL,
        AEM_CMD_INCREMENT_CONTROL,
        AEM_CMD_DECREMENT_CONTROL,
        AEM_CMD_SET_SIGNAL_SELECTOR,
        AEM_CMD_GET_SIGNAL_SELECTOR,
        AEM_CMD_SET_MIXER,
        AEM_CMD_GET_MIXER,
        AEM_CMD_SET_MATRIX,
        AEM_CMD_GET_MATRIX,
        AEM_CMD_START_STREAMING,
        AEM_CMD_STOP_STREAMING,
        AEM_CMD_REGISTER_UNSOLICITED_NOTIFICATION,
        AEM_CMD_DEREGISTER_UNSOLICITED_NOTIFICATION,
        AEM_CMD_IDENTIFY_NOTIFICATION,
        AEM_CMD_GET_AVB_INFO,
        AEM_CMD_GET_AS_PATH,
        AEM_CMD_GET_COUNTERS,
        AEM_CMD_REBOOT,
        AEM_CMD_GET_AUDIO_MAP,
        AEM_CMD_ADD_AUDIO_MAPPINGS,
        AEM_CMD_REMOVE_AUDIO_MAPPINGS,
        AEM_CMD_GET_VIDEO_MAP,
        AEM_CMD_ADD_VIDEO_MAPPINGS,
        AEM_CMD_REMOVE_VIDEO_MAPPINGS,
        AEM_CMD_GET_SENSOR_MAP,
        AEM_CMD_ADD_SENSOR_MAPPINGS,
        AEM_CMD_REMOVE_SENSOR_MAPPINGS,
        AEM_CMD_START_OPERATION,
        AEM_CMD_ABORT_OPERATION,
        AEM_CMD_OPERATION_STATUS,
        AEM_CMD_AUTH_ADD_KEY,
        AEM_CMD_AUTH_DELETE_KEY,
        AEM_CMD_AUTH_GET_KEY_LIST,
        AEM_CMD_AUTH_GET_KEY,
        AEM_CMD_AUTH_ADD_KEY_TO_CHAIN,
        AEM_CMD_AUTH_DELETE_KEY_FROM_CHAIN,
        AEM_CMD_AUTH_GET_KEYCHAIN_LIST,
        AEM_CMD_AUTH_GET_IDENTITY,
        AEM_CMD_AUTH_ADD_TOKEN,
        AEM_CMD_AUTH_DELETE_TOKEN,
        AEM_CMD_AUTHENTICATE,
        AEM_CMD_DEAUTHENTICATE,
        AEM_CMD_ENABLE_TRANSPORT_SECURITY,
        AEM_CMD_DISABLE_TRANSPORT_SECURITY,
        AEM_CMD_ENABLE_STREAM_ENCRYPTION,
        AEM_CMD_DISABLE_STREAM_ENCRYPTION,
        AEM_CMD_SET_MEMORY_OBJECT_LENGTH,
        AEM_CMD_GET_MEMORY_OBJECT_LENGTH,
        AEM_CMD_SET_STREAM_BACKUP,
        AEM_CMD_GET_STREAM_BACKUP,
        TOTAL_NUM_OF_AEM_CMDS = 75, 
        AEM_CMD_ERROR = 0xffff
    };

    enum aem_descs_values 
    {
        AEM_DESC_ENTITY,
        AEM_DESC_CONFIGURATION,
        AEM_DESC_AUDIO_UNIT,
        AEM_DESC_VIDEO_UNIT,
        AEM_DESC_SENSOR_UNIT,
        AEM_DESC_STREAM_INPUT,
        AEM_DESC_STREAM_OUTPUT,
        AEM_DESC_JACK_INPUT,
        AEM_DESC_JACK_OUTPUT,
        AEM_DESC_AVB_INTERFACE,
        AEM_DESC_CLOCK_SOURCE,
        AEM_DESC_MEMORY_OBJECT,
        AEM_DESC_LOCALE,
        AEM_DESC_STRINGS,
        AEM_DESC_STREAM_PORT_INPUT,
        AEM_DESC_STREAM_PORT_OUTPUT,
        AEM_DESC_EXTERNAL_PORT_INPUT,
        AEM_DESC_EXTERNAL_PORT_OUTPUT,
        AEM_DESC_INTERNAL_PORT_INPUT,
        AEM_DESC_INTERNAL_PORT_OUTPUT,
        AEM_DESC_AUDIO_CLUSTER,
        AEM_DESC_VIDEO_CLUSTER,
        AEM_DESC_SENSOR_CLUSTER,
        AEM_DESC_AUDIO_MAP,
        AEM_DESC_VIDEO_MAP,
        AEM_DESC_SENSOR_MAP,
        AEM_DESC_CONTROL,
        AEM_DESC_SIGNAL_SELECTOR,
        AEM_DESC_MIXER,
        AEM_DESC_MATRIX,
        AEM_DESC_MATRIX_SIGNAL,
        AEM_DESC_SIGNAL_SPLITTER,
        AEM_DESC_SIGNAL_COMBINER,
        AEM_DESC_SIGNAL_DEMULTIPLEXER,
        AEM_DESC_SIGNAL_MULTIPLEXER,
        AEM_DESC_SIGNAL_TRANSCODER,
        AEM_DESC_CLOCK_DOMAIN,
        AEM_DESC_CONTROL_BLOCK,
        TOTAL_NUM_OF_AEM_DESCS = 38, 
        AEM_DESC_ERROR = 0xffff
    };

    enum aem_cmds_status
    {
        AEM_STATUS_SUCCESS = 0, 
        AEM_STATUS_NOT_IMPLEMENTED = 1, 
        AEM_STATUS_NO_SUCH_DESCRIPTOR = 2, 
        AEM_STATUS_ENTITY_LOCKED = 3, 
        AEM_STATUS_ENTITY_ACQUIRED = 4, 
        AEM_STATUS_NOT_AUTHENTICATED = 5, 
        AEM_STATUS_AUTHENTICATION_DISABLED = 6, 
        AEM_STATUS_BAD_ARGUMENTS = 7, 
        AEM_STATUS_NO_RESOURCES = 8, 
        AEM_STATUS_IN_PROGRESS = 9, 
        AEM_STATUS_ENTITY_MISBEHAVING = 10, 
        AEM_STATUS_NOT_SUPPORTED = 11, 
        AEM_STATUS_STREAM_IS_RUNNING = 12, 
        TOTAL_NUM_OF_AEM_CMDS_STATUS = 13,  
        AVDECC_LIB_STATUS_INVALID = 1023, 
        AVDECC_LIB_STATUS_TICK_TIMEOUT = 1024 
    };

    enum acmp_cmds_values 
    {
        CONNECT_TX_COMMAND,
        CONNECT_TX_RESPONSE,
        DISCONNECT_TX_COMMAND,
        DISCONNECT_TX_RESPONSE,
        GET_TX_STATE_COMMAND,
        GET_TX_STATE_RESPONSE,
        CONNECT_RX_COMMAND,
        CONNECT_RX_RESPONSE,
        DISCONNECT_RX_COMMAND,
        DISCONNECT_RX_RESPONSE,
        GET_RX_STATE_COMMAND,
        GET_RX_STATE_RESPONSE,
        GET_TX_CONNECTION_COMMAND,
        GET_TX_CONNECTION_RESPONSE,
        TOTAL_NUM_OF_ACMP_CMDS = 14, 
        AEM_ACMP_ERROR = 0xffff
    };

    enum acmp_cmds_status
    {
        ACMP_STATUS_SUCCESS = 0, 
        ACMP_STATUS_LISTENER_UNKNOWN_ID = 1, 
        ACMP_STATUS_TALKER_UNKNOWN_ID = 2, 
        ACMP_STATUS_TALKER_DEST_MAC_FAIL = 3, 
        ACMP_STATUS_TALKER_NO_STREAM_INDEX = 4, 
        ACMP_STATUS_TALKER_NO_BANDWIDTH = 5, 
        ACMP_STATUS_TALKER_EXCLUSIVE = 6, 
        ACMP_STATUS_LISTENER_TALKER_TIMEOUT = 7, 
        ACMP_STATUS_LISTENER_EXCLUSIVE = 8, 
        ACMP_STATUS_STATE_UNAVAILABLE = 9, 
        ACMP_STATUS_NOT_CONNECTED  = 10, 
        ACMP_STATUS_NO_SUCH_CONNECTION = 11, 
        ACMP_STATUS_COULD_NOT_SEND_MESSAGE = 12, 
        ACMP_STATUS_TALKER_MISBEHAVING = 13, 
        ACMP_STATUS_LISTENER_MISBEHAVING = 14, 
        ACMP_STATUS_RESERVED = 15, 
        ACMP_STATUS_CONTROLLER_NOT_AUTHORIZED = 16, 
        ACMP_STATUS_INCOMPATIBLE_REQUEST = 17, 
        ACMP_STATUS_LISTENER_INVALID_CONNECTION = 18,
        TOTAL_NUM_OF_ACMP_CMDS_STATUS = 19,  
    };

    enum aem_cmd_waiting
    {
        CMD_WITHOUT_NOTIFICATION = 0, 
        CMD_WITH_NOTIFICATION = 1, 
    };

    enum ether_hdr_info
    {
        SRC_MAC_SIZE = 6,
        DEST_MAC_SIZE = 6,
        ETHER_PROTOCOL_SIZE = 2,
        ETHER_HDR_SIZE = SRC_MAC_SIZE + DEST_MAC_SIZE + ETHER_PROTOCOL_SIZE, 
    };

    enum protocol_hdr_info
    {
        PROTOCOL_HDR_SIZE = 4 
    };

    enum frame_lengths
    {
        ADP_FRAME_LEN = 82, 
        ACMP_FRAME_LEN = 70, 
        AECP_FRAME_LEN = 64 
    };

    enum timeouts
    {
        NETIF_READ_TIMEOUT_MS = 100, 
        AVDECC_MSG_TIMEOUT_MS = 250,  
        ACMP_CONNECT_TX_COMMAND_TIMEOUT_MS = 2000,
        ACMP_DISCONNECT_TX_COMMAND_TIMEOUT_MS = 200,
        ACMP_GET_TX_STATE_COMMAND_TIMEOUT_MS = 200,
        ACMP_CONNECT_RX_COMMAND_TIMEOUT_MS = 4500,
        ACMP_DISCONNECT_RX_COMMAND_TIMEOUT_MS = 500,
        ACMP_GET_RX_STATE_COMMAND_TIMEOUT_MS = 200,
        ACMP_GET_TX_CONNECTION_COMMAND_TIMEOUT_MS = 200
    };

    enum flags
    {
        CMD_LOOKUP = 1024 
    };

    enum notifications 
    {
        NO_MATCH_FOUND = 0, 
        END_STATION_CONNECTED = 1, 
        END_STATION_DISCONNECTED = 2, 
        COMMAND_TIMEOUT = 3, 
        RESPONSE_RECEIVED = 4, 
        END_STATION_READ_COMPLETED = 5, 
        TOTAL_NUM_OF_NOTIFICATIONS = 6
    };

    enum logging_levels
    {
        LOGGING_LEVEL_ERROR   = 0,
        LOGGING_LEVEL_WARNING = 1,
        LOGGING_LEVEL_NOTICE  = 2,
        LOGGING_LEVEL_INFO    = 3,
        LOGGING_LEVEL_DEBUG   = 4,
        LOGGING_LEVEL_VERBOSE = 5,
        TOTAL_NUM_OF_LOGGING_LEVELS = 6
    };
}

#endif