MX Foundation 4
ar629_updating_data_sampling.cs
/*****************************************************************************
//
// File:
// ar629_updating_data_sampling.cs
//
// Copyright (c) MAX Technologies Inc. 1988-2019, All Rights Reserved.
// CONFIDENTIAL AND PROPRIETARY INFORMATION WHICH IS THE
// PROPERTY OF MAX TECHNOLOGIES INC.
//
// This example demonstrates the basic steps to update the data during transmission.
// In this example, we use the sampling mode for acquisition.
// It is also shown how to set a record to be a "variable length" record (use of MXF_A629_TXPERIODIC_MJRFRAME_MSG_OPT_VARIABLE_LENGTH constant).
//
// It demonstrates how to:
//
// - Get handle to first BM and RT with mxfModuleChannelAllGet().
// - Set the CID with mxfAttributeUint64Set().
// - Configure major frame with mxfA629TxPeriodicMajorFrameSet().
// - Write messages of a record array into a buffer with mxfA629TxPeriodicUpdateMsgWrite().
// - Start major frame with mxfA629TxPeriodicMajorFrameStart().
// - Stop major frame mxfTxPeriodicMajorFrameStop().
//
// Hardware requirements:
// - MAXT FlexMulti-629.
//
*****************************************************************************/
#define TTL
//#define LOCAL
using System;
using static MAXT.MXFoundation.mxf;
using System.Runtime.InteropServices;
using System.Text;
using System.IO;
namespace ar629_example
{
class ar629_updating_data_sampling
{
const int MAX_RX_RECORDS_TO_RECEIVE = 1000;
const int MAX_TX_RECORDS_TO_TRANSMIT = 1;
static void Main(string[] args)
{
int RX_BUFFER_SIZE = MAX_RX_RECORDS_TO_RECEIVE * Marshal.SizeOf(typeof(MXF_A629_SAMPREC));
int TX_BUFFER_SIZE = MAX_TX_RECORDS_TO_TRANSMIT * Marshal.SizeOf(typeof(MXF_A629_DATAREC));
var aMinorFrame = new MXF_A629_TXPERIODIC_MJRFRAME_MSG[32];
MXF_A629_TXPERIODIC_MJRFRAME_PROPERTIES majorProperties = new MXF_A629_TXPERIODIC_MJRFRAME_PROPERTIES();
var aRec629 = new MXF_A629_DATAREC[10];
var hChannel = new UInt64[1];
var ahBM = new UInt64[1];
UInt64 server = 0;
UInt64 device = 0;
var module = new UInt64[1];
IntPtr hostBuffer = IntPtr.Zero;
IntPtr recPtr = IntPtr.Zero;
UInt64 rxBuffer = 0;
var txBuffer = new UInt64[3];
UInt32 rc;
UInt64 TI, bytesCount, msgsCount, indexBuffer;
UInt32 length;
UInt64 count = 0, index, iMsg;
aRec629[0].data = new UInt16[258];
// Connects to services and initialize environment
#if LOCAL
rc = mxfServerConnect("0.0.0.0", "", "", Convert.ToUInt64(false), out server);
#else
rc = mxfServerConnect("192.168.0.1", "admin", "admin", Convert.ToUInt64(false), out server);
#endif
// Initializes MX Foundation library
if (rc == MAXT_SUCCESS)
{
Console.WriteLine("Starting ...");
rc = mxfSystemInit(server);
}
// Gets the first device handle
if (rc == MAXT_SUCCESS)
rc = mxfSystemDeviceGet(server, 0, out device);
if (rc == MAXT_SUCCESS)
rc = mxfDeviceModuleAllGet(device, MXF_MODULE_A629MRT_EH, 1, out count, module);
// Detects first BM
if (rc == MAXT_SUCCESS)
rc = mxfModuleChannelAllGet(module[0], MXF_CLASS_A629, MXF_SCLASS_BM_CHANNEL, 1, out count, ahBM);
// Detects first RT channel
if (rc == MAXT_SUCCESS)
rc = mxfModuleChannelAllGet(module[0], MXF_CLASS_A629, MXF_SCLASS_RT_CHANNEL, 1, out count, hChannel);
// If module or channel not found, returns an error
if ((rc == MAXT_SUCCESS) && (count == 0))
rc = MAXT_ERROR_NOT_FOUND;
// Sets timebase to 64-bit nanoseconds
if (rc == MAXT_SUCCESS)
rc = mxfSystemTimeBaseSet(server, MXF_TIMEBASE_DEVICE_NSEC);
// Sets interface to SIM or TTL
#if TTL
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(module[0], KMXF_A629_MODULE_INTERFACE, VMXF_A629_MODULE_INTERFACE_TTL);
#else
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(module[0], KMXF_A629_MODULE_INTERFACE, VMXF_A629_MODULE_INTERFACE_SIM);
#endif
// Allocates RX sampling buffer
if (rc == MAXT_SUCCESS)
rc = mxfRxSamplingBufferAlloc(ahBM[0], (UInt64)RX_BUFFER_SIZE, out rxBuffer, IntPtr.Zero);
// Sets sampling kill time to 2 seconds.
if (rc == MAXT_SUCCESS)
rc = mxfRxSamplingKilltimeSet(rxBuffer, 2000000000);
// Allocates six TX Periodic Update Message buffer
for (index = 0; (index < 3) && (rc == MAXT_SUCCESS); index++)
rc = mxfTxPeriodicUpdateMsgBufferAlloc(hChannel[0], index, (UInt64)TX_BUFFER_SIZE, out txBuffer[index], IntPtr.Zero);
// Allocates host buffer
if (rc == MAXT_SUCCESS)
{
try
{
hostBuffer = Marshal.AllocHGlobal(Math.Max(RX_BUFFER_SIZE, TX_BUFFER_SIZE));
}
catch (OutOfMemoryException)
{
rc = MAXT_ERROR_MEM;
}
try
{
recPtr = Marshal.AllocHGlobal(Marshal.SizeOf(aRec629[0]));
}
catch (OutOfMemoryException)
{
rc = MAXT_ERROR_MEM;
}
}
//Sets the CID to 0xF
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(hChannel[0], KMXF_A629_RT_CID, 0xF);
// Starts sampling
if (rc == MAXT_SUCCESS)
rc = mxfRxSamplingStart(rxBuffer);
if (rc == MAXT_SUCCESS)
Console.WriteLine("Sampling started");
// Stops and clears major frame on RT #0
if (rc == MAXT_SUCCESS)
rc = mxfTxPeriodicMajorFrameStop(hChannel[0], 0, 0);
if (rc == MAXT_SUCCESS)
rc = mxfTxPeriodicMajorFrameClear(hChannel[0], 0);
if (rc == MAXT_SUCCESS)
{
//--- Sets the minor frame #0 with 3 WordStrings --//
//WordString #0 : Label 0x1, CID 0xF
iMsg = 0;
aMinorFrame[iMsg].buffer = txBuffer[0];
aMinorFrame[iMsg].label = 0x1;
aMinorFrame[iMsg].cid = 0xF;
aMinorFrame[iMsg].options = MXF_A629_TXPERIODIC_MJRFRAME_MSG_OPT_VARIABLE_LENGTH;
aMinorFrame[iMsg].length = 0;
iMsg = 1;
aMinorFrame[iMsg].buffer = txBuffer[1];
aMinorFrame[iMsg].label = 0x2;
aMinorFrame[iMsg].cid = 0xF;
aMinorFrame[iMsg].options = MXF_A629_TXPERIODIC_MJRFRAME_MSG_OPT_DEFAULT;
aMinorFrame[iMsg].length = 1;
iMsg = 2;
aMinorFrame[iMsg].buffer = txBuffer[2];
aMinorFrame[iMsg].label = 0x3;
aMinorFrame[iMsg].cid = 0xF;
aMinorFrame[iMsg].options = MXF_A629_TXPERIODIC_MJRFRAME_MSG_OPT_DEFAULT;
aMinorFrame[iMsg].length = 1;
if (rc == MAXT_SUCCESS)
rc = mxfA629TxPeriodicMajorFrameSet(hChannel[0], 0, 0, 3, aMinorFrame);
}
//--- Sets default data for label 0x1, CID 0xF ---//
if (rc == MAXT_SUCCESS)
{
//Sets the lentgh of this label/CID
length = 4; //4 bytes (label + 1 data word)
aRec629[0].control = 0;
aRec629[0].repeatCount = 1;
aRec629[0].dataSize = length;
aRec629[0].data[0] = 0;
aRec629[0].data[1] = 0x1101;
Marshal.StructureToPtr(aRec629[0], recPtr, false);
rc = mxfA629TxPeriodicUpdateMsgWrite(txBuffer[0], 1, recPtr);
}
if (rc == MAXT_SUCCESS)
{
//Sets the lentgh of this label/CID
length = 4; //4 bytes (label + 1 data word)
aRec629[0].control = 0;
aRec629[0].repeatCount = 1;
aRec629[0].dataSize = length;
aRec629[0].data[0] = 0;
aRec629[0].data[1] = 0x2201;
Marshal.StructureToPtr(aRec629[0], recPtr, false);
rc = mxfA629TxPeriodicUpdateMsgWrite(txBuffer[1], 1, recPtr);
}
if (rc == MAXT_SUCCESS)
{
//Sets the lentgh of this label/CID
length = 4; //4 bytes (label + 1 data word)
aRec629[0].control = 0;
aRec629[0].repeatCount = 1;
aRec629[0].dataSize = length;
aRec629[0].data[0] = 0;
aRec629[0].data[1] = 0x3301;
Marshal.StructureToPtr(aRec629[0], recPtr, false);
rc = mxfA629TxPeriodicUpdateMsgWrite(txBuffer[2], 1, recPtr);
}
//Starts the major frame in the Block mode
TI = 25000000;
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(module[0], KMXF_A629_MODULE_TI, TI);
if (rc == MAXT_SUCCESS)
{
majorProperties.mode = MXF_A629_TXPERIODIC_MJRFRAME_PROPERTIES_MODE_BLOCK;
majorProperties.reserved = 0;
rc = mxfA629TxPeriodicMajorFrameStart(hChannel[0], 0, ref majorProperties);
}
//Waiting 5 seconds. Allows major frame to run a little bit.
mxfSleep(5000);
//Reads first datas
if (rc == MAXT_SUCCESS)
{
rc = mxfA629RxSamplingRead(rxBuffer, MXF_RXSAMPLING_FLAG_DEFAULT, 0, (UInt64)RX_BUFFER_SIZE, out msgsCount, out bytesCount, hostBuffer);
if (rc == MAXT_SUCCESS)
Console.WriteLine("Read {0} messages", msgsCount);
DisplayDataSampArray(msgsCount, hostBuffer);
}
//--- Change data for label 0x1, CID 0xF ---//
if (rc == MAXT_SUCCESS)
Console.WriteLine("Changing data for last 5 seconds");
if (rc == MAXT_SUCCESS)
{
//Sets the lentgh of this label/CID
length = 8; //8 bytes (label + 3 data word)
aRec629[0].control = 0;
aRec629[0].repeatCount = 1;
aRec629[0].dataSize = length;
aRec629[0].data[0] = 0;
aRec629[0].data[1] = 0xFF03;
aRec629[0].data[2] = 0xFFFF;
aRec629[0].data[3] = 0xFFFF;
Marshal.StructureToPtr(aRec629[0], recPtr, false);
rc = mxfA629TxPeriodicUpdateMsgWrite(txBuffer[0], 1, recPtr);
}
//Waiting 5 seconds. Allows major frame to run a little bit.
mxfSleep(5000);
if (rc == MAXT_SUCCESS)
{
rc = mxfA629RxSamplingRead(rxBuffer, MXF_RXSAMPLING_FLAG_DEFAULT, 0, (UInt64)RX_BUFFER_SIZE, out msgsCount, out bytesCount, hostBuffer);
if (rc == MAXT_SUCCESS)
Console.WriteLine("Read {0} messages", msgsCount);
DisplayDataSampArray(msgsCount, hostBuffer);
}
//Stops the major frame
if (rc == MAXT_SUCCESS)
rc = mxfTxPeriodicMajorFrameStop(hChannel[0], 0, 0);
// Stops sampling and reads last datas
if (rc == MAXT_SUCCESS)
rc = mxfRxSamplingStop(rxBuffer);
if (rc == MAXT_SUCCESS)
{
Console.WriteLine("Sampling stopped");
}
if (rc != MAXT_SUCCESS)
{
StringBuilder buffer = new StringBuilder(256);
if (mxfSystemErrorStringGet(server, rc, 256, buffer) != MAXT_SUCCESS)
buffer.Append(string.Format("ERROR # 0x{0:x8}", rc));
Console.WriteLine(buffer);
}
Console.WriteLine("Terminating ...");
// Free all buffers and terminate
if (rxBuffer != 0)
mxfRxSamplingBufferFree(rxBuffer);
for (indexBuffer = 0; indexBuffer < 3; indexBuffer++)
{
if (txBuffer[indexBuffer] != 0)
{
mxfTxPeriodicUpdateMsgBufferFree(txBuffer[indexBuffer]);
}
}
if (hostBuffer != IntPtr.Zero)
Marshal.FreeHGlobal(hostBuffer);
if (recPtr != IntPtr.Zero)
Marshal.FreeHGlobal(recPtr);
// Unloads MX Foundation library
mxfSystemTerminate(server);
// Disconnects from MX Foundation library
mxfServerDisconnect(server);
Console.WriteLine();
Console.WriteLine("Press a key to terminate");
Console.Read();
return;
}
private static void DisplayDataSampArray(UInt64 recNum, IntPtr rec)
{
UInt64 iRec,
iData;
IntPtr p = rec;
MXF_A629_SAMPREC sampRec = new MXF_A629_SAMPREC()
{
data = new UInt16[258]
};
Console.WriteLine();
for (iRec = 0; iRec < recNum; iRec++)
{
sampRec = (MXF_A629_SAMPREC)Marshal.PtrToStructure(p, typeof(MXF_A629_SAMPREC));
Console.Write("{0:D3} {1:D10} {2:D2} {3} ", iRec, sampRec.timeTag, sampRec.dataSize, sampRec.rate);
if ((sampRec.control & MXF_A629_RX_REC_CTRL_STRING_CRC_ERROR) == MXF_A629_RX_REC_CTRL_STRING_CRC_ERROR)
Console.Write(" CRC error ");
if ((sampRec.control & MXF_A629_RX_REC_CTRL_STRING_DATA_SYNC_ERROR) == MXF_A629_RX_REC_CTRL_STRING_DATA_SYNC_ERROR)
Console.Write(" Data sync error ");
if (((sampRec.control & (MXF_A629_RX_REC_CTRL_STRING_LABEL_MANCHESTER_ERROR)) == (MXF_A629_RX_REC_CTRL_STRING_LABEL_MANCHESTER_ERROR)) ||
((sampRec.control & (MXF_A629_RX_REC_CTRL_STRING_DATA_MANCHESTER_ERROR)) == (MXF_A629_RX_REC_CTRL_STRING_DATA_MANCHESTER_ERROR)))
Console.Write(" Manchester error ");
if (((sampRec.control & (MXF_A629_RX_REC_CTRL_STRING_LABEL_PARITY_ERROR)) == (MXF_A629_RX_REC_CTRL_STRING_LABEL_PARITY_ERROR)) ||
((sampRec.control & (MXF_A629_RX_REC_CTRL_STRING_DATA_PARITY_ERROR)) == (MXF_A629_RX_REC_CTRL_STRING_DATA_PARITY_ERROR)))
Console.Write(" Parity error ");
if ((sampRec.control & MXF_A629_RX_REC_CTRL_STRING_EOS_ERROR) == MXF_A629_RX_REC_CTRL_STRING_EOS_ERROR)
Console.Write(" End of String error ");
for (iData = 0; iData < sampRec.dataSize / 2; iData++)
{
Console.Write("{0:x4} ", sampRec.data[iData]);
if ((((iData + 1) % 8) == 0) && (iData + 1 < sampRec.dataSize / 2))
Console.Write("\n ");
}
Console.WriteLine();
mxfA629NextSamplingRecordPtrGet(p, out p);
}
}
}
}
Updated 10/23/2023