zetton-stream

English | 中文

Table of Contents

• zetton-stream
  • Table of Contents
  • Introduction
  • What's New
  • Installation
  • Getting Started
  • Overview of Supported Sources and Sinks
  • FAQ
  • Contributing
  • Acknowledgement
  • License
  • Related Projects

Introduction

zetton-stream is an open source package for video streaming. It's a part of the Project Zetton.

Major features

• Modular Design: zetton-stream is designed to be modular, which means that you can easily add new stream source and sinks to the package.

• Support Multiple Frameworks: zetton-stream supports multiple video processing and streaming frameworks, such as OpenCV, GStreamer, FFmpeg, etc.

• High Efficiency: zetton-stream is designed to be high efficient, which means that you can easily deploy the streaming nodes to CPU/GPU servers or embedded devices.

What's New

Please refer to changelog.md for details and release history.

For compatibility changes between different versions of zetton-stream, please refer to compatibility.md.

Installation

Please refer to Installation for installation instructions.

Getting Started

Please see get_started.md for the basic usage of zetton-stream.

Overview of Supported Sources and Sinks

Task	Protocol	Format	Encoding	V4L2	GStreamer	FFmpeg
Source	V4L2	MJPEG	JPEG	✅	❌	❌
Source	V4L2	Raw	/	✅	❌	❌
Source	RTSP	/	H.264	/	✅	❌
Source	RTMP	/	H.264	/	❌	❌
Source	RTP	/	H.264	/	✅	❌
Sink	RTSP	/	H.264	/	✅	❌
Sink	RTMP	/	H.264	/	❌	❌
Sink	RTP	/	H.264	/	✅	❌
Sink	/	MP4	H.264	/	❌	❌

• ✅: Supported and tested
• ❓: Supported but not tested
• ❌: Not supported yet

FAQ

Please refer to FAQ for frequently asked questions.

Contributing

We appreciate all contributions to improve zetton-stream. Please refer to CONTRIBUTING.md for the contributing guideline.

Acknowledgement

We appreciate all the contributors who implement their methods or add new features, as well as users who give valuable feedbacks. We wish that the package and benchmark could serve the growing research and production community by providing a flexible toolkit to stream videos.

• v4l-utils for convience wrappers of V4L2 API

License

• For academic use, this project is licensed under the 2-clause BSD License, please see the LICENSE file for details.
• For commercial use, please contact Yusu Pan.

Related Projects

• zetton-stream-gst: GStreamer-based streaming extension for zetton-stream package

• zetton-ros-vendor: ROS-based examples