gazebo_video_monitors contains packages that lets the user record videos of a Gazebo simulation. It provides a multicamera sensor that can be used for creating different types of videos with multiple views from inside the gazebo world.
There is a number of plugins available in the package which are explained next. More plugins can be developed, with minimal effort, to fit arbitrary use cases.
The GazeboVideoMonitorPlugin plugin records videos in the following format.
It assumes two cameras: one which can be used to get a view of the world, and another one which can be attached to a robot to get a view from its perspective. Additionally, time metadata are logged in the video to make tracking of world and robot events easier. To configure the plugin, see the gazebo_video_monitor_plugin.world file. The plugin exposes two ROS services to control the recordings:
- Use the start_recording service to initiate a recording. Setting disable_window to true removes the second view from the recording. world_as_main_view can be used to set the world or robot camera as the main view of the recording.
ros2 service call /gazebo/start_recording gazebo_video_monitor_interfaces/srv/StartGvmRecording "{disable_window: false, world_as_main_view: false}"- Use the stop_recording service to save or discard a recording. The filename must be given without the extension (.mp4). The recording is saved in the directory defined in the plugin configuration.
ros2 service call /gazebo/stop_recording gazebo_video_monitor_interfaces/srv/StopRecording "{discard: false, filename: navigation-test}"The GazeboMultiVideoMonitorPlugin plugin records multiple videos from different cameras simultaneously.
An arbitrary number of cameras can be set up, which the plugin will read and record a video for each one of them. Time metadata can be logged in the videos as well. To configure the plugin, see the gazebo_multi_video_monitor_plugin.world file. The plugin exposes two ROS services to control the recordings:
- Use the start_recording service to initiate a recording. There are no arguments.
ros2 service call /gazebo/start_recording std_srvs/srv/Empty "{}"- Use the stop_recording service to save or discard a recording, as explained in GazeboVideoMonitorPlugin. The recordings are saved together in the subdirectory under the directory defined in the plugin configuration.
The GazeboMultiCameraMonitorPlugin plugin records videos with a multi-camera setup. See the gif below (the video was created automatically; no editing was done).
An arbitrary number of cameras can be set up, from which the plugin can select and configure the video stream. The cameras can be updated dynamically during the recording. Time metadata can be logged in the videos as well. To configure the plugin, see the gazebo_multi_camera_monitor_plugin.world file. The plugin exposes two ROS services and one topic to control the recordings:
- Use the start_recording service to initiate a recording. You can optionally specify the cameras with which to initialize the video stream.
ros2 service call /gazebo/start_recording gazebo_video_monitor_interfaces/srv/StartGmcmRecording "{cameras: {names: []}}"-
Use the stop_recording service to save or discard a recording, as explained in GazeboVideoMonitorPlugin.
-
Publish a message to the camera_select topic to update the video stream. You can specify one or two cameras for the main and window view, respectively.
ros2 topic pub -1 /gazebo/camera_select gazebo_video_monitor_interfaces/msg/Strings "{names: [camera_0, camera_2]}"The GazeboMultiViewMonitorPlugin plugin records videos with up to 4 parallel camera streams.
An arbitrary number of cameras can be set up, from which the plugin can select and configure the video stream. The cameras can be updated dynamically during the recording. Time metadata can be logged in the videos as well. To configure the plugin, see the gazebo_multi_view_monitor_plugin.world file. The plugin exposes two ROS services and one topic to control the recordings:
- Use the start_recording service to initiate a recording. You can pass as arguments the cameras with which to initialize the video stream. An empty camera name results in a null camera stream in the respective quadrant.
ros2 service call /gazebo/start_recording gazebo_video_monitor_interfaces/srv/StartGmcmRecording "{cameras: {names: ['', camera_1, camera_2, '']}}"-
Use the stop_recording service to save or discard a recording, as explained in GazeboVideoMonitorPlugin.
-
Publish a message to the camera_select topic to update the video stream. You can specify up to 4 cameras for the top left, top right, bottom left, and bottom right quadrant, respectively. A camera name can be left empty to disable the respective quadrant.
ros2 topic pub -1 /gazebo/camera_select gazebo_video_monitor_interfaces/msg/Strings "{names: [camera_3, camera_1, '', camera_2]}"All plugins expose a set_camera ROS service for configuring the pose of a camera and the link to which the camera should be attached. You can call this service to dynamically reconfigure a camera during a simulation, or to fine tune and extract the initial pose of the camera when configuring the plugin (enabling the camera visualizations makes this process much easier).
ros2 service call /gazebo/set_camera gazebo_video_monitor_interfaces/srv/SetCamera "{camera_name: robot_camera, model_name: robot-0001, link_name: gripper_link, pose: {x: 0.0, y: -0.05, z: -0.1, roll: -0.2, pitch: 0.0, yaw: 0.0}}"A set of utility plugins is also available to be used along with the monitor plugins.
- CameraContainsPlugin: publishes a list of camera names when one or more of the tracked models enter the space of a box container.
- The camera visualizations (not the cameras used for the recordings) are created and set correctly, but they don't get attached to the models.
- The cameras are not always positioned correctly during initialization. The numberOfInitialAttachRetries parameter was introduced as a temporary fix.
- Gazebo may or may not crash upon launch if your robot has ray sensors (somehow creating the scene early makes collision detection explode; your guess is as good as mine). The initService parameter was introduced to trigger the initialization of the plugin by calling a service at the right moment (e.g. after your robot has been initialized).