[RSDK-8274, RSDK-8624, RSDK-8647, RSDK-8687] Video Storage and Save/Fetch DoCommand

.canon.yaml

@@ -0,0 +1,9 @@
+vs:
+    image_amd64: ghcr.io/viamrobotics/antique2:amd64-cache
+    image_arm64: ghcr.io/viamrobotics/antique2:arm64-cache
+    image_arm: ghcr.io/viamrobotics/antique2:armhf-cache
+    minimum_date: 2023-10-26T20:00:00.0Z
+    update_interval: 168h0m0s
+    user: testbot
+    group: testbot
+    persistent: true

.gitattributes

@@ -0,0 +1 @@
+*.mp4 filter=lfs diff=lfs merge=lfs -text

.github/workflows/lint.yml

@@ -0,0 +1,35 @@
+name: run linter on each commit
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - '**/**.go'
+      - 'Makefile'
+      - '.github/workflows/lint.yml'
+  pull_request:
+    paths:
+      - '**/**.go'
+      - 'Makefile'
+      - '.github/workflows/lint.yml'
+
+jobs:
+  quality-checks:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.21
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libx264-dev
+
+    - name: Run linter
+      run: make lint

.gitignore

@@ -0,0 +1,5 @@
+*video-store
+FFmpeg
+.env
+*.DS_Store
+bin

Makefile

@@ -0,0 +1,78 @@
+SOURCE_OS ?= $(shell uname -s | tr '[:upper:]' '[:lower:]')
+SOURCE_ARCH ?= $(shell uname -m)
+TARGET_OS ?= $(SOURCE_OS)
+TARGET_ARCH ?= $(SOURCE_ARCH)
+normalize_arch = $(if $(filter aarch64,$(1)),arm64,$(if $(filter x86_64,$(1)),amd64,$(1)))
+SOURCE_ARCH := $(call normalize_arch,$(SOURCE_ARCH))
+TARGET_ARCH := $(call normalize_arch,$(TARGET_ARCH))
+
+BIN_OUTPUT_PATH = bin/$(TARGET_OS)-$(TARGET_ARCH)
+TOOL_BIN = bin/gotools/$(shell uname -s)-$(shell uname -m)
+
+FFMPEG_TAG ?= n6.1
+FFMPEG_VERSION ?= $(shell pwd)/FFmpeg/$(FFMPEG_TAG)
+FFMPEG_VERSION_PLATFORM ?= $(FFMPEG_VERSION)/$(TARGET_OS)-$(TARGET_ARCH)
+FFMPEG_BUILD ?= $(FFMPEG_VERSION_PLATFORM)/build
+FFMPEG_OPTS ?= --prefix=$(FFMPEG_BUILD) \
+               --disable-shared \
+               --disable-programs \
+               --disable-doc \
+               --disable-everything \
+               --enable-static \
+               --enable-libx264 \
+               --enable-gpl \
+               --enable-encoder=libx264 \
+               --enable-muxer=segment \
+               --enable-muxer=mp4 \
+               --enable-demuxer=segment \
+               --enable-demuxer=concat \
+               --enable-demuxer=mov \
+               --enable-demuxer=mp4 \
+               --enable-parser=h264 \
+               --enable-protocol=file \
+               --enable-protocol=concat \
+               --enable-protocol=crypto \
+               --enable-bsf=h264_mp4toannexb
+
+CGO_LDFLAGS := "-L$(FFMPEG_BUILD)/lib -lavcodec -lavutil -lavformat -l:libjpeg.a /usr/lib/aarch64-linux-gnu/libx264.a -lz"
+CGO_CFLAGS := -I$(FFMPEG_BUILD)/include
+GOFLAGS := -buildvcs=false
+export PKG_CONFIG_PATH=$(FFMPEG_BUILD)/lib/pkgconfig
+
+.PHONY: lint tool-install test clean
+
+$(BIN_OUTPUT_PATH)/video-store: *.go cam/*.go $(FFMPEG_BUILD)
+	go mod tidy
+	CGO_LDFLAGS=$(CGO_LDFLAGS) CGO_CFLAGS=$(CGO_CFLAGS) go build -o $(BIN_OUTPUT_PATH)/video-store main.go
+
+$(FFMPEG_VERSION_PLATFORM):
+	git clone https://github.com/FFmpeg/FFmpeg.git --depth 1 --branch $(FFMPEG_TAG) $(FFMPEG_VERSION_PLATFORM)
+
+$(FFMPEG_BUILD): $(FFMPEG_VERSION_PLATFORM)
+# Only need nasm to build assembly kernels for amd64 targets.
+ifeq ($(SOURCE_OS),linux)
+ifeq ($(SOURCE_ARCH),amd64)
+	which nasm || (sudo apt update && sudo apt install -y nasm)
+endif
+endif
+	cd $(FFMPEG_VERSION_PLATFORM) && ./configure $(FFMPEG_OPTS) && $(MAKE) -j$(NPROC) && $(MAKE) install
+
+tool-install:
+	GOBIN=`pwd`/$(TOOL_BIN) go install \
+		github.com/edaniels/golinters/cmd/combined \
+		github.com/golangci/golangci-lint/cmd/golangci-lint \
+		github.com/rhysd/actionlint/cmd/actionlint
+
+lint: tool-install $(FFMPEG_BUILD)
+	go mod tidy
+	CGO_CFLAGS=$(CGO_CFLAGS) GOFLAGS=$(GOFLAGS) $(TOOL_BIN)/golangci-lint run -v --fix --config=./etc/.golangci.yaml
+
+
+test: $(BIN_OUTPUT_PATH)/video-store
+	git lfs pull
+	go test -v ./tests/
+
+clean:
+	rm -rf $(BIN_OUTPUT_PATH)
+	rm -rf FFmpeg
+	git clean -fxd

README.md

@@ -0,0 +1,102 @@
+# Video Storage
+The `video-store` module brings security camera functionality to your smart machine! The module consumes a source [Camera](https://docs.viam.com/components/camera/) and saves the output as video files on disk. You can then upload video slices to the cloud using the [save](#save) command, or request the video bytes directly using the [fetch](#fetch) command.
+
+> **Note:** This component is a work in progress and is not yet fully implemented.
+
+## Configure your `video-store` component
+
+Fill in the attributes as applicable to the component, according to the template below.
+
+```json
+    {
+      "name": <video_store_component_name>,
+      "namespace": "rdk",
+      "type": "camera",
+      "model": "viam:video:storage",
+      "attributes": {
+        "camera": <camera_component_name>, [required]
+        "sync": <data_manager_service_name>, [required]
+        "storage": { [required]
+            "segment_seconds": <length_of_video_segments>, [optional]
+            "size_gb": <total_storage_max_size>, [required]
+            "storage_path": <custom_path_to_store_video_files>, [optional]
+            "upload_path": <custom_path_to_upload_video_files>, [optional]
+        },
+        "video": { [optional]
+            "format": <video_format>, [optional]
+            "codec": <video_codec>, [optional]
+            "bitrate": <bits_pers_second>, [optional]
+            "preset": <video_preset>, [optional]
+        },
+        "cam_props": { [required]
+            "width": <pixel_width>, [required]
+            "height": <pixel_height>, [required]
+            "framerate": <frames_per_second>, [required]
+        },
+      },
+      "depends_on": [
+        <camera_component_name>, [required]
+        <data_manager_service_name> [required]
+      ]
+    }
+```
+
+Make sure to configure a [Data Manager Service](https://docs.viam.com/services/data/cloud-sync/) to uplaod video files to the cloud.
+
+```json
+    {
+      "name": <data_manager_service_name>,
+      "namespace": "rdk",
+      "type": "data_manager",
+      "attributes": {
+        "tags": [],
+        "additional_sync_paths": [
+          <custom_path_to_upload_video_files>
+        ],
+        "capture_disabled": true,
+        "sync_interval_mins": <sync_interval_minutes>,
+        "capture_dir": ""
+      }
+    }
+```
+
+## Do Commands
+
+### `save`
+
+#### Save Request
+```json
+{
+  "command": "save",
+  "from": <start_timestamp>, [required]
+  "to": <end_timestamp>, [required]
+  "metadata": <arbitrary_metadata_string> [optional]
+}
+```
+
+#### Save Response
+```json
+{
+  "command": "save",
+  "filename": <filename_to_be_uploaded>
+}
+```
+
+### `fetch`
+
+#### Fetch Request
+```json
+{
+  "command": "fetch",
+  "from": <start_timestamp>, [required]
+  "to": <end_timestamp> [required]
+}
+```
+
+#### Fetch Response
+```json
+{
+  "command": "fetch",
+  "video": <video_bytes>
+}
+```