https://github.com/awslabs/amazon-kinesis-video-streams-pic

https://github.com/awslabs/amazon-kinesis-video-streams-pic

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: awslabs
  • License: apache-2.0
  • Language: C++
  • Default Branch: master
  • Size: 2.81 MB
Statistics
  • Stars: 53
  • Watchers: 15
  • Forks: 52
  • Open Issues: 22
  • Releases: 4
Created over 6 years ago · Last pushed 12 months ago
Metadata Files
Readme Contributing License Code of conduct

README.md

Amazon Kinesis Video Streams PIC

Platform Indendent Code for Amazon Kinesis Video Streams

Coverage Status

Key FeaturesBuildRunDocumentationRelatedLicense

Key Features

Build

Download

To download run the following command:

git clone https://github.com/awslabs/amazon-kinesis-video-streams-pic.git

You will also need to install pkg-config and CMake and a build enviroment

Configure

Create a build directory in the newly checked out repository, and execute CMake from it.

mkdir -p amazon-kinesis-video-streams-pic/build; cd amazon-kinesis-video-streams-pic/build; cmake ..

By default we download all the libraries from GitHub and build them locally, so should require nothing to be installed ahead of time. If you do wish to link to existing libraries you can use the following flags to customize your build.

Cross-Compilation

If you wish to cross-compile CC and CXX are respected when building the library and all its dependencies. See our .travis.yml for an example of this. Every commit is cross compiled to ensure that it continues to work.

CMake Arguments

You can pass the following options to cmake ..

  • -DBUILD_DEPENDENCIES -- Whether or not to build depending libraries from source
  • -DBUILD_TEST=TRUE -- Build unit/integration tests, may be useful for confirm support for your device. ./tst/kvspic_test
  • -DCODE_COVERAGE -- Enable coverage reporting
  • -DCOMPILER_WARNINGS -- Enable all compiler warnings
  • -DADDRESS_SANITIZER -- Build with AddressSanitizer
  • -DMEMORY_SANITIZER -- Build with MemorySanitizer
  • -DTHREAD_SANITIZER -- Build with ThreadSanitizer
  • -DUNDEFINED_BEHAVIOR_SANITIZER Build with UndefinedBehaviorSanitizer
  • -DBUILD_DEBUG_HEAP Build debug heap with guard bands and validation. This is ONLY intended for low-level debugging purposes. Default is OFF.
  • -DALIGNED_MEMORY_MODEL Build for aligned memory model only devices. Default is OFF.
  • -DCONSTRAINED_DEVICE -- Sets the default stack size of threads to 512 KiB (0.5 MiB). Incompatible with -DKVS_DEFAULT_STACK_SIZE. Not available in Windows. Default is OFF.
  • -DKVS_DEFAULT_STACK_SIZE -- Value in bytes for default stack size of threads. Incompatible with -DCONSTRAINED_DEVICE. Default is system default.

Build

To build the library run make in the build directory you executed CMake.

make

Note on alignment

The entire PIC codebase is built with aligned memory access to machine native word (up-to 64 bit). The only exception is the heap implementation. In order to provide for tight packing and low-fragmentation, we default to unaligned heap access. For devices and OS-es that do not have unaligned access or unaligned access emulation, -DALIGNED_MEMORY_MODEL CMake argument should be passed in build-time to ensure heap is aligned.

Contributing to this project

If you wish to submit a pull request to this project, please do so on the develop branch. Code from develop will be merged into master periodically as a part of our release cycle.

Documentation

Related

License

This library is licensed under the Apache 2.0 License.

Owner

  • Name: Amazon Web Services - Labs
  • Login: awslabs
  • Kind: organization
  • Location: Seattle, WA

AWS Labs

GitHub Events

Total
  • Create event: 21
  • Release event: 1
  • Issues event: 3
  • Watch event: 3
  • Delete event: 10
  • Issue comment event: 23
  • Push event: 80
  • Pull request review comment event: 29
  • Pull request review event: 56
  • Pull request event: 33
  • Fork event: 6
Last Year
  • Create event: 21
  • Release event: 1
  • Issues event: 3
  • Watch event: 3
  • Delete event: 10
  • Issue comment event: 23
  • Push event: 80
  • Pull request review comment event: 29
  • Pull request review event: 56
  • Pull request event: 33
  • Fork event: 6

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 11
  • Total pull requests: 123
  • Average time to close issues: 3 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 9
  • Total pull request authors: 14
  • Average comments per issue: 1.55
  • Average comments per pull request: 1.18
  • Merged pull requests: 80
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 29
  • Average time to close issues: N/A
  • Average time to close pull requests: 8 days
  • Issue authors: 4
  • Pull request authors: 6
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.76
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • vincentyanzhao (2)
  • thomas-roos (1)
  • PoshSylvester (1)
  • gustavofuhr (1)
  • yuluomeng (1)
  • danteblink (1)
  • daveisfera (1)
  • Nomidia (1)
  • ericriff (1)
  • liuyi96 (1)
Pull Request Authors
  • disa6302 (44)
  • sirknightj (27)
  • hassanctech (21)
  • jdelapla (16)
  • niyatim23 (12)
  • stefankiesz (8)
  • daveisfera (7)
  • rob-baily (4)
  • PoshSylvester (3)
  • MushMal (2)
  • grantralston (1)
  • chehefen (1)
  • RufUsul (1)
  • thinkski (1)
Top Labels
Issue Labels
bug (4) question (4) enhancement (1)
Pull Request Labels
v1.2.1 (11) Unit tests (8) ci (7) v1.2.0 (7) enhancement (3) Build (2) AL2 (2) Non-functional (2)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
proxy.golang.org: github.com/awslabs/amazon-kinesis-video-streams-pic
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.5%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 11 months ago

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v2 composite
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v2 composite
  • github/codeql-action/analyze v1 composite
  • github/codeql-action/autobuild v1 composite
  • github/codeql-action/init v1 composite