C++ and Python Interface Alignment Plan

[JackLau1222]

In BMF, there are many inconsistencies between the Python and C++ interfaces. Therefore, we plan to align them, referred to as the Interface Alignment Plan.

Python and Cpp both call function through Connector (writed by cpp)

bmf/bmf/python/py_engine.cpp

Line 22 in a7d1669

#include "connector.hpp"

bmf/bmf/engine/connector/include/builder.hpp

Line 32 in a7d1669

#include "connector.hpp"

Python interface implementation is not same as Cpp caused by pybind.
So we're hard to align all of the python and cpp builder function.
However, we can use similar interfaces to abstract away differences in functionality implementation.

Everyone is welcome to share any inconsistencies you have identified between the interfaces here. Please include the relevant code for both Python and C++, and, if possible, provide your suggestions for alignment.

[JackLau1222]

In this issue, it was reported that the PushData mode cannot be properly invoked in C++. After investigation, the problem lies in the C++ interface design:

• The PushData enumeration type is missing in C++.
• The Graph::Start() function is not implemented in C++.
• The Graph::Close() function is designed only for the sync module scenario, which is not versatile enough.

[JackLau1222]

resolved by #155

[JackLau1222]

This issue reported that C++ lacks a dynamic change node interface.

Interface list:

• dynamic_remove
• dynamic_add
• dynamic_reset
• update

[JackLau1222]

C++ cannot run FFmpeg by config

• C++ lacks this function to run FFmpeg
  

  bmf/bmf/builder/bmf_graph.py

  Line 771 in a7d1669

  def runFFmpegByConfig(self, config_path):

• C++ lacks the FFmpeg engine like this https://github.com/BabitMF/bmf/blob/master/bmf/ffmpeg_engine/engine.py

[JackLau1222]

This #77 (comment) reported that C++ lacks a ForceClose interface.

[JackLau1222]

resolved by #157