l-acoustics / avdecc Goto Github PK

An AddressAccess write operation should support to be aborted by the user.
There is currently no link between a StartUploadMemoryObjectOperation and a writeDeviceMemory (in order to write to a device, you have to StartOperation).

So at the controller layer level, adding an OperationID (returned by a StartUploadMemoryObjectOperation) to the writeDeviceMemory API will allow it to track when abortOperation() is called, and automatically stop sending AA TLVs.

Milan compatibility is per configuration, not per device.
So the controller has to first query Entity descriptor to get configuration counts, then query for Milan compatibility (and store the information per configuration)

This type was incorrectly named that way, but should just be as specified in IEEE1722.1

Also remove makeVendorEntityModel and splitVendorEntityModel from the library.

Change UniqueIdentifier to be a helper class instead of a simple type and remove getNullIdentifier() and getUninitializedIdentifier().
Add operator bool() (effectivemlly calling old isValidUniqueIdentifier method) to the class
Add static methods getNullIdentifier and getUninitializedIdentifier to the class
Add member method returning the VendorID from the uniqueID

Warning: This will break almost all existing code (unit tests, examples, ... will have to be tested)

Change the log level for ignored entities (because of General Controller Ignore flag) from Trace to Info

See ControllerStateMachine::computeNextAdvertiseTime
(which should be moved to an ADP state machine, see #23 )

For each Entity, store a Entity info struct per interface index (from ADP message).

• Add a notification for each time the info in the struct changes (identify, available index, flags).
• Add a notification for each time a Entity info struct is added or removed

The EntityID and EntityModelID must be the same on all interfaces (add a warning for that).

Many serialization APIs from protocolAemPayloads.hpp/cpp are using AemAecpdu::MaximumPayloadLength as the maximum size for the serialization buffer.

But what happens when ALLOW_BIG_AEM_PAYLOADS is set??
Shouldn't we have a new constexpr (MaximumSerializationBufferLength) that takes either MaximumPayloadLength or MaximumBigPayloadLength?

Add an unit test that checks that, and possibly fix the issue, if there is one!

• In la_avdecc
• in la_avdecc_controller
• with all notifications (beware the value is stored in the ADP info struct in the controller)
• No need to manually get the value when using AEMCache since it's an EntityWide value that can be found in ADP

The library should limit the number of ACMP messages it sends at the same time:

• Have a limit of ACMP inflight message per entity (just like AECP)
• Have a limit of how fast it sends ACMP messages

By sending an Acquire command with RELEASE flag (so it won't change the current acquired state of the entity, except if we were the acquiring controller, which doesn't matter anyway because we got interrupted in the middle of our operation if the device if getting online again)

There is no runtime check for the minimum supported version of macOS, when using macOS native protocolInterface type.
We should do a runtime check of the minimum version specified in the documentation.

When an AECP enumeration response arrives at the same time as an ACMP enumeration response, a crash might occur when using macOS native Protocol Interface (because the handling of those messages is done in 2 separate threads, which is not the case with pcap)

If possible, give the reason for the EntityOffline event:

• Received a DEPARTING message
• Timed out

For the Controller library, we can even improve the possibility with "Simulated Offline"

Slightly improve controller's AEM cache introduce in (#6) so that if one descriptor dynamic information retrieval is not supported by the entity, get the corresponding descriptor instead of switching to full enumeration (most devices don't support GetMemoryObjectLength)

Add counters, like the descriptor counters, for the controller entity itself, to serve as debug purpose.
Like "Received unsol", "toxic unit detected", "unsol lost" ....

Key to access StreamOutput channel dynamic mappings should be the Stream pair, not the Cluster pair (which is for the StreamInput)

Add support for GET_COUNTERS (Clause 7.4.42) Unsolicited Notifications

For entities not supporting GetStreamInfo and/or GET_RX/TX_STATE, the initial value of isRunning is currently false, but should be true.

See ControllerImpl::queryInformation pragma message.
Leaving the code like this might cause crashes.
Implement a proper scheduler in a single thread.

Add support for IDENTITY_NOTIFICATION (Clause 7.4.39), Identify StateMachine and Identify control

la_avdecc_controller should not re-enumerate the AEM for a vendorID+entityModelID it already enumerated

Blocked by #5

la_avdecc should be able to load and parse aemxml files to generate the corresponding AEM tree.

Try to enumerate non-compliant entities, but flag them as so.

Issue with Hono 4.4M

Have the possibility to configure the controller so it doesn't retrieve every information from a discovered entity during first enumeration.

Have a "on-demand" mode to get missing information (possibly make usage of std::optional), with an easy to use API.

For a device having 2 AVB_INTERFACEs, only one being plugged to the same network than the controller at a given time.
Quickly unplugging this interface, then plugging the other one to the network will cause the controller to detect the new interface, but due to the timeout delay before the original one is discarded, we might have lost some unsolicited (like LINK_UP/LINK_DOWN for example) and possibly other dynamic state.

In this case the controller should detect that the original interface has been unplugged and simulate an offline/online.
An improvement should be to check the time between when the new interface was discovered and when the original one timed out. If that time is greater than the valid_time, no need to reenumerate.

(change and see if nothing breaks)

gen_cmake.sh should use "Visual Studio 15 2017 Win64" instead of "Visual Studio 14 2015 Win64" generator for 64 bits.

READ_DESCRIPTOR for example can return this status code.
Descriptor information should be optional (in case we don't want the controller to enumerate the full model, or in case it's protected by authentication).

The controller library is using the STREAM_[INPUT/OUTPUT] descriptor type instead of STREAM_PORT_[INPUT/OUTPUT] one to retrieve the dynamic audio map.

Search and replace " uint16_t" with " std::uint16_t"

Make a separate file/class for the ADP state machine so all entity kind can use it.
Do not make a thread inside it, rather have a method to be called on a regular basis.

all std::string in networkInterface helper class should be encoded in UTF-8

For a Milan device, the controller should remove the mappings before changing the stream format.

Some random crashed happens on macOS when using the "macOS native protocol interface".

Implement the unsolicited notification loss algorithm (only for Milan devices):

• For a first version, call a deregisterUnsolicitedNotification
• In the deregisterUnsolicitedNotificationResult handler, don't forget to call updateUnsolicitedNotificationsSubscription()

Forward all detected protocol/unpacking errors up to the controller (all the messages logged when such an error occurs), so the controller library can flag the device as either not fully IEEE compliant or misbehaving.

Currently, the controller library only handles the active configuration, not all of them.
Also if another controller changes the current active configuration, the controller library will discard the notification.

In order to be able to modify talker stream presentation time settings, the AECP command SET_STREAM_INFO is used and therefor means to access this are required in public inferface of controller lib.

When la::avdecc::entity::ControllerEntity acquired an entity and another controller is trying to acquire, the library do not receive the ControllerAvailable message when using macOSNative ProtocolInterface (fine using pcap).
This causes the other controller to successfully acquire the entity.

If the connection state is out of sync (for example, where sending an ACMP disconnect that times out, but was actually correctly processed by the talker and the listener), subsequent tentative to disconnect will cause an error status "Not connected". In this case, update the connection state.

This was supposed to be handled, but it looks like it's not always the case.

avdecc_controller library does not properly detect entities declaring 0 stream input or stream output descriptors in Configuration descriptor (but it works fine if the entity does not declare such descriptor).

Incorrect name: clockIdentify should be clockIdentity

Add a new layer than would receive all the warnings for non-milan compatible devices.
The layer should receive the entityID and the Milan Clause involved (a string).