Skip to content

Commit 151faba

Browse files
committed
added gitignore for tests and updated README
1 parent 55390f3 commit 151faba

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ and follow the [instructions here](https://github.com/ros-misc-utilities/.github
3030
## About encoders, decoders, and pixel formats
3131

3232
The tools in this package often have many parameters related to encoders, decoders, and pixel formats.
33-
It is important to understand the terminology, and how single-channel images (like ``mono8`` and Bayer images) handled. Please consult the [ffmpeg\_encoder\_decoder repo](https://github.com/ros-misc-utilities/ffmpeg_encoder_decoder) for more information.
33+
It is important to understand the terminology, and how single-channel images (like ``mono8`` and Bayer images) are handled.
34+
Please consult the [ffmpeg\_encoder\_decoder repo](https://github.com/ros-misc-utilities/ffmpeg_encoder_decoder) for more information.
3435

3536
## Programs for processing rosbags
3637

3738
### bag\_to\_file
38-
The ``bag_to_file`` tool simply concatenates the FFMPEGPacket message content from a rosbag into a file, and runs the ``ffmpeg`` tool to
39-
embed the stream into a an ``mp4`` container.
39+
The ``bag_to_file`` tool concatenates the FFMPEGPacket message content from a rosbag into a file, and runs the ``ffmpeg`` tool to embed the stream into a an ``mp4`` container.
4040
```
4141
bag_to_file -i input_bag -t topic -r rate [-o out_file] [-T timestamp_file] [-s start_time (sec since epoch)] [-e end_time (sec since epoch)]
4242
```
@@ -78,6 +78,7 @@ For example if the codec is ``hevc`` and a bayer image (``bayer_rggb8``) has bee
7878
[INFO] [1753428586.070137592] [bag_to_frames]: using decoder: hevc
7979
[WARN] [1753428586.406598438] [Decoder]: hardware frame transfer failed for pixel format yuv420p
8080
```
81+
8182
Before the image is written a final conversion to the ``output_format`` is performed. The default is ``bgr8``.
8283
The format string must follow [ROS convention](https://docs.ros.org/en/jazzy/p/sensor_msgs/generated/program_listing_file_include_sensor_msgs_image_encodings.hpp.html) rather than the libav convention, i.e. ``bgr8`` rather than ``bgr24``.
8384

@@ -139,7 +140,7 @@ ros2 run ffmpeg_image_transport_tools compress_bag -i <input_bag> -o <output_ba
139140
```
140141

141142
### uncompress\_bag
142-
The ``uncompress\_bag`` program can be used to convert a bag with ffmpeg-encoded images (FFMPEGPacket message type) into images.
143+
The ``uncompress\_bag`` program can be used to convert a bag with ffmpeg-encoded images (FFMPEGPacket message type) into a bag with regular (sensor_msgs/Image) messages.
143144
```
144145
uncompress_bag -i in_bag -o out_bag -t topic [-t topic ... ] [options]
145146
options:

test/.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
*.txt
2+
test_bag
3+
comp_bag
4+
uncomp_bag

0 commit comments

Comments
 (0)