Added HERO10 info

intrabloom · Mar 22, 2022 · ac00d7e · ac00d7e
1 parent a8cd809
commit ac00d7e
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -580,7 +580,7 @@ For more information of GPSP (or DOP) see https://en.wikipedia.org/wiki/Dilution
 | SCEN | Scene classifier in probabilities | 8 - 10 | n/a | FourCC scenes: SNOW, URBAn, INDOor, WATR, VEGEtation, BEACh |
 | SROT | Sensor Read Out Time | at base frame rate 24/25/30  | n/a | this moves to a global value in HERO8 |
 
-### HERO8 Black (v1.2) Adds, Removes, Changes, Otherwise Supports All HERO7 metadata
+### HERO8 Black (v2.5) Adds, Removes, Changes, Otherwise Supports All HERO7 metadata
 
 | FourCC | Property | approximate frequency (Hz) | SIUN or UNIT | Comment |
 | --- | --- | --- | --- | --- |
@@ -601,7 +601,7 @@ For more information of GPSP (or DOP) see https://en.wikipedia.org/wiki/Dilution
 | DISP | Disparity track (360 modes) | frame rate | n/a | 1-D depth map for the objects seen by the two lenses |
 | MAGN | MAGNnetometer | 24 | µT | Camera pointing direction x,y,z (valid in v2.0 firmware.) |
 
-### HERO9 Black (v1.5) Adds, Removes, Changes, Otherwise Supports All HERO8 metadata
+### HERO9 & HERO10 Black Adds, Removes, Changes, Otherwise Supports All HERO8 metadata
 
 | FourCC | Property | approximate frequency (Hz) | SIUN or UNIT | Comment |
 | --- | --- | --- | --- | --- |

diff --git a/docs/README.md b/docs/README.md
@@ -40,12 +40,36 @@ Unless you explicitly state otherwise, any contribution intentionally submitted
 
 A new open source repository has been created for the purpose (GPMF-Write https://github.com/gopro/gpmf-write)
 
-## Quick Start for Developers
+## Quick Start for Developers using Docker
+
+### Run the Docker container
+```bash
+docker run runsascoded/gpmf-parser samples/hero8.mp4
+```
+Run on your own video(s) by mounting an `/input` directory (or individual files to paths matching `/input.*`):
+
+```bash
+docker run -v "/path/to/my/movie.mp4:/input.mp4" runsascoded/gpmf-parser
+```
 
 ### Setup
 
 Clone the project from Github (git clone https://github.com/gopro/gpmf-parser).
 
+Now you can run a quick demo on the sample data by compiling the demo:
+
+```bash
+cd gpmf-parser/demo/
+make
+./gpmfdemo ../samples/Fusion.mp4
+```
+
+This will return a brief overview of what metadata is stored in the given video file (Fusion.mp4). The following command will show the first few samples of the recorded payload (i.e. accelerometer, gyroscope, magnetometer, GPS, etc.):
+
+```bash
+./gpmfdemo ../samples/Fusion.mp4 -g
+```
+
 ### Sample Code
 
 GPMF-parser.c and .h provide a payload decoder for any raw stream stored in compliant GPMF. Extraction of the RAW GPMF from a video or image file is not covered by this tool.
@@ -556,12 +580,12 @@ For more information of GPSP (or DOP) see https://en.wikipedia.org/wiki/Dilution
 | SCEN | Scene classifier in probabilities | 8 - 10 | n/a | FourCC scenes: SNOW, URBAn, INDOor, WATR, VEGEtation, BEACh |
 | SROT | Sensor Read Out Time | at base frame rate 24/25/30  | n/a | this moves to a global value in HERO8 |
 
-### HERO8 Black (v1.2) Adds, Removes, Changes, Otherwise Supports All HERO7 metadata
+### HERO8 Black (v2.5) Adds, Removes, Changes, Otherwise Supports All HERO7 metadata
 
 | FourCC | Property | approximate frequency (Hz) | SIUN or UNIT | Comment |
 | --- | --- | --- | --- | --- |
-| CORI | Camera ORIentation | frame rate | n/a | Quaterions for the camera orientation since capture start |
-| IORI | Image ORIentation | frame rate | n/a | Quaterions for the image orientation relative to the camera body |
+| CORI | Camera ORIentation | frame rate | n/a | Quaternions for the camera orientation since capture start |
+| IORI | Image ORIentation | frame rate | n/a | Quaternions for the image orientation relative to the camera body |
 | GRAV | GRAvity Vector | frame rate | n/a | Vector for the direction for gravitiy |
 | WNDM | Wind Processing | 10Hz | n/a | marks whether wind processing is active |
 | MWET | Microphone is WET | 10Hz | n/a | marks whether some of the microphones are wet |
@@ -571,13 +595,13 @@ For more information of GPSP (or DOP) see https://en.wikipedia.org/wiki/Dilution
 
 | FourCC | Property | approximate frequency (Hz) | SIUN or UNIT | Comment |
 | --- | --- | --- | --- | --- |
-| CORI | Camera ORIentation | frame rate | n/a | Quaterions for the camera orientation since capture start |
-| IORI | Image ORIentation | frame rate | n/a | Quaterions for the image orientation relative to the camera body |
+| CORI | Camera ORIentation | frame rate | n/a | Quaternions for the camera orientation since capture start |
+| IORI | Image ORIentation | frame rate | n/a | Quaternions for the image orientation relative to the camera body |
 | GRAV | GRAvity Vector | frame rate | n/a | Vector for the direction for gravity |
 | DISP | Disparity track (360 modes) | frame rate | n/a | 1-D depth map for the objects seen by the two lenses |
 | MAGN | MAGNnetometer | 24 | µT | Camera pointing direction x,y,z (valid in v2.0 firmware.) |
 
-### HERO9 Black (v1.5) Adds, Removes, Changes, Otherwise Supports All HERO8 metadata
+### HERO9 & HERO10 Black Adds, Removes, Changes, Otherwise Supports All HERO8 metadata
 
 | FourCC | Property | approximate frequency (Hz) | SIUN or UNIT | Comment |
 | --- | --- | --- | --- | --- |