wip

.clang-format

@@ -0,0 +1,88 @@
+# Generated from CLion C/C++ Code Style settings
+BasedOnStyle: LLVM
+Cpp11BracedListStyle: true
+AccessModifierOffset: -4
+AlignConsecutiveMacros: true
+AlignTrailingComments: false
+AlignAfterOpenBracket: Align
+AllowAllArgumentsOnNextLine: false
+AllowAllConstructorInitializersOnNextLine: false
+AllowAllParametersOfDeclarationOnNextLine: false
+AlignArrayOfStructures: Left
+AllowShortBlocksOnASingleLine: true
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLambdasOnASingleLine: None
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterReturnType: None
+AlwaysBreakTemplateDeclarations: Yes
+BreakBeforeBraces: Custom
+BinPackArguments: false
+BinPackParameters: false
+BraceWrapping:
+  AfterCaseLabel: false
+  AfterClass: false
+  AfterExternBlock: false
+  AfterControlStatement: Never
+  AfterEnum: false
+  AfterFunction: false
+  AfterNamespace: false
+  AfterUnion: false
+  BeforeCatch: false
+  BeforeElse: false
+  IndentBraces: false
+  SplitEmptyFunction: false
+  SplitEmptyRecord: true
+# BraceBreakingStyle: Attach
+BreakBeforeBinaryOperators: None
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: BeforeColon
+BreakInheritanceList: BeforeColon
+ColumnLimit: 0
+CommentPragmas:  '^[^ ]'
+CompactNamespaces: false
+ContinuationIndentWidth: 8
+IncludeBlocks:   Preserve
+IncludeCategories:
+  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority:        2
+    SortPriority:    0
+    CaseSensitive:   false
+  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
+    Priority:        3
+    SortPriority:    0
+    CaseSensitive:   false
+  - Regex:           '.*'
+    Priority:        1
+    SortPriority:    0
+    CaseSensitive:   false
+IndentCaseLabels: true
+IndentPPDirectives: None
+IndentWidth: 4
+InsertTrailingCommas: Wrapped
+KeepEmptyLinesAtTheStartOfBlocks: true
+MaxEmptyLinesToKeep: 2
+NamespaceIndentation: All
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PointerAlignment: Right
+ReflowComments: false
+SpaceAfterCStyleCast: true
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: false
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles: false
+SpacesInCStyleCastParentheses: false
+SpacesInContainerLiterals: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+TabWidth: 4
+UseTab: Never

.gitattributes

@@ -0,0 +1,4 @@
+*.py linguist-detectable=true
+demo/** linguist-detectable=false
+lib/** linguist-detectable=false
+resources/** linguist-detectable=false

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Bugs in Falcon
+title: 'Falcon Issue: '
+labels: bug
+assignees: ''
+
+---
+
+Make sure you have read the documentation, and have put forth a reasonable effort to find an existing answer.
+
+### Expected behaviour
+
+
+### Actual behaviour
+
+
+### Steps to reproduce the behaviour
+
+(Include enough details so that the issue can be reproduced independently.)

.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,14 @@
+---
+name: Documentation
+about: Issues around documentation of Falcon
+title: Falcon Documentation Issue
+labels: documentation
+assignees: ''
+
+---
+
+### What is the URL of the doc?
+
+
+
+### What's the nature of the issue? (e.g. steps do not work, typos/grammar/spelling, etc., out of date)

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Falcon suggestion
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/c-codestyle.yml

@@ -0,0 +1,32 @@
+name: C Codestyle
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ main ]
+    paths:
+      - '**/*.c'
+      - '.github/workflows/c-codestyle.yml'
+  pull_request:
+    branches: [ main, 'v[0-9]+.[0-9]+' ]
+    paths:
+      - '**/*.c'
+      - '.github/workflows/c-codestyle.yml'
+
+jobs:
+  check-c-codestyle:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+
+    - name: Install dependencies
+      run: sudo apt install clang-format
+
+    - name: Check c codestyle
+      run: python3 resources/.lint/c/formatter.py -c -v

.github/workflows/c-demos.yml

@@ -0,0 +1,119 @@
+name: C Demos
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ main ]
+    paths:
+      - '!demo/c/README.md'
+      - '.github/workflows/c-demos.yml'
+      - 'demo/c/**'
+      - 'lib/common/**'
+      - 'lib/jetson/**'
+      - 'lib/linux/**'
+      - 'lib/mac/**'
+      - 'lib/raspberry-pi/**'
+      - 'lib/windows/**'
+      - 'resources/audio_samples/*.wav'
+  pull_request:
+    branches: [ main, 'v[0-9]+.[0-9]+' ]
+    paths:
+      - '!demo/c/README.md'
+      - '.github/workflows/c-demos.yml'
+      - 'demo/c/**'
+      - 'lib/common/**'
+      - 'lib/jetson/**'
+      - 'lib/linux/**'
+      - 'lib/mac/**'
+      - 'lib/raspberry-pi/**'
+      - 'lib/windows/**'
+      - 'resources/audio_samples/*.wav'
+
+defaults:
+  run:
+    working-directory: demo/c
+
+jobs:
+  build-demo-github-hosted:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        # TODO: uncomment all commented lines
+#        os: [ubuntu-latest, windows-latest, macos-latest]
+        os: [ubuntu-latest]
+        include:
+          - os: ubuntu-latest
+            platform: linux
+            arch: x86_64
+            make_file: "Unix Makefiles"
+#          - os: windows-latest
+#            platform: windows
+#            arch: amd64
+#            make_file: "MinGW Makefiles"
+#          - os: macos-latest
+#            platform: mac
+#            arch: x86_64
+#            make_file: "Unix Makefiles"
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Set up Python '3.10'
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Create build directory
+        run: cmake -G "${{ matrix.make_file }}" -B ./build
+
+      - name: Build demo
+        run: cmake --build ./build --target falcon_demo
+
+      - name: Install dependencies
+        run: pip install -r test/requirements.txt
+
+      - name: Test
+        run: python test/test_falcon_c.py "${{secrets.PV_VALID_ACCESS_KEY}}" ${{ matrix.platform }} ${{ matrix.arch }}
+
+#  build-demo-self-hosted:
+#    runs-on: ${{ matrix.machine }}
+#
+#    strategy:
+#      matrix:
+#        machine: [rpi3-32, rpi3-64, rpi4-32, rpi4-64, jetson]
+#        include:
+#          - machine: rpi3-32
+#            platform: raspberry-pi
+#            arch: cortex-a53
+#          - machine: rpi3-64
+#            platform: raspberry-pi
+#            arch: cortex-a53-aarch64
+#          - machine: rpi4-32
+#            platform: raspberry-pi
+#            arch: cortex-a72
+#          - machine: rpi4-64
+#            platform: raspberry-pi
+#            arch: cortex-a72-aarch64
+#          - machine: jetson
+#            platform: jetson
+#            arch: cortex-a57-aarch64
+#
+#    steps:
+#      - uses: actions/checkout@v3
+#        with:
+#          submodules: recursive
+#
+#      - name: Create build directory
+#        run: cmake -B ./build
+#
+#      - name: Build demo
+#        run: cmake --build ./build --target falcon_demo
+#
+#      - name: Install dependencies
+#        run: pip install -r test/requirements.txt
+#
+#      - name: Test
+#        run: python3 test/test_falcon_c.py ${{secrets.PV_VALID_ACCESS_KEY}} ${{ matrix.platform }} ${{ matrix.arch }}

.github/workflows/link-check.yml

@@ -0,0 +1,18 @@
+name: Check Markdown links
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main, 'v[0-9]+.[0-9]+']
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: gaurav-nelson/[email protected]
+      with:
+        use-quiet-mode: 'yes'
+        use-verbose-mode: 'yes'

.github/workflows/python-codestyle.yml

@@ -0,0 +1,30 @@
+name: Python Codestyle
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+    paths:
+      - '**/*.py'
+  pull_request:
+    branches: [main, 'v[0-9]+.[0-9]+']
+    paths:
+      - '**/*.py'
+
+jobs:
+  check-python-codestyle:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+
+    - name: Install dependencies
+      run: pip install flake8 pep8-naming
+
+    - name: Check python codestyle
+      run: flake8 --ignore=F401,F403,F405 --max-line-length=120 .