Merge pull request #7 from Telecommunication-Telemedia-Assessment/deb…

…ugging

debugging

.vscode/launch.json

@@ -0,0 +1,33 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "(gdb) Launch testmain",
+      "type": "cppdbg",
+      "request": "launch",
+      "program": "${workspaceFolder}/VideoParser/videoparser_testmain",
+      // "args": ["${workspaceFolder}/test.mp4"],
+      "stopAtEntry": false,
+      "cwd": "${fileDirname}",
+      "environment": [],
+      "externalConsole": false,
+      "MIMode": "gdb",
+      // "additionalSOLibSearchPath": "${workspaceFolder}/Outputs/lib/",
+      "setupCommands": [
+        {
+          "description": "Enable pretty-printing for gdb",
+          "text": "-enable-pretty-printing",
+          "ignoreFailures": true
+        },
+        {
+          "description": "Additional libs for gdb",
+          "text": "set environment LD_LIBRARY_PATH=${workspaceFolder}/Outputs/lib:${workspaceFolder}/VideoParser:$LD_LIBRARY_PATH",
+          "ignoreFailures": false
+        }
+      ]
+    }
+  ]
+}

development.md

@@ -88,3 +88,23 @@ cd ../VideoParser && scons
 ```
 
 Or, for a small test just run `build_and_test.sh`.
+
+## Debugging
+
+### C Code
+
+There is a GDB-based debugging script under `testmain.sh`. Execute it with a file:
+
+```bash
+./testmain.sh /path/to/file.mp4
+```
+
+You are now in a GDB console and can inspect the code.
+
+To debug with Visual Studio Code, a `launch.json` file is already provided, since setup is more complex. Simply uncomment the line with `args` and specify the path to the video file that should be launche.
+
+The `TestMain.cpp` code partly reproduces what the Python module does.
+
+### Python
+
+Simply add `breakpoint()` wherever you need it.