Skip to content

Commit

Permalink
v0.2.0
Browse files Browse the repository at this point in the history
Updates:
- ReadMe with premature exit warning
  • Loading branch information
jdryu committed Nov 25, 2024
1 parent 47fd207 commit c89f75a
Showing 1 changed file with 20 additions and 7 deletions.
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,14 @@

ROS2 package to play and save videos

- [Installation instructions](#installation_instructions)

<a name=installation_instructions></a>

# Installation instructions
Use the installation script:

Install FFMPEG through terminal:
./install_description.sh

This will install all dependencies, including the FFMPEG.

```bash
sudo apt install ffmpeg
```

# Hardware acceleration

Expand Down Expand Up @@ -51,6 +48,22 @@ ffmpeg -hwaccels
* `save_as_single_video` (only for `burst_video_saver`): compile all burst save events as a single video stream, otherwise each burst record command will save their own partial video [*default*: True]


### **WARNING ON PREMATURE EXIT**

In order for the saved MPEG video file to be decoded and read properly in the future,
the container must include a *moov atom* that acts as a sort of table of contents.
This is generally added at the end of the file, so exiting an active stream
prematurely can result in an incomplete container. This can be remedied by
copying the atom from a video with similar structure. This can be achieved
using a library called `untrunc`:

```bash
sudo snap install --edge untrunc-anthwlock
untrunc-anthwlock -s GOOD_VIDEO BROKEN_VIDEO
```



# Example

> ***DEPRECATED: new examples are in progress***
Expand Down

0 comments on commit c89f75a

Please sign in to comment.