Skip to content

Commit

Permalink
Rewrite reference to use spec data, relicense to BSD-2-Clause
Browse files Browse the repository at this point in the history
  • Loading branch information
cyanreg committed Nov 4, 2023
1 parent 4d2efc9 commit 43d3d73
Show file tree
Hide file tree
Showing 40 changed files with 2,606 additions and 1,523 deletions.
43 changes: 22 additions & 21 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
The MIT License (MIT)
=====================
BSD 2-clause license
====================

Copyright © 2022 Lynne
Copyright © 2023, Lynne
All rights reserved.

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the “Software”), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,33 @@
AVTransport
===========

# AVTransport
This repository hosts the AVTransport container/media transmission protocol, and the reference implementation code.

Currently, the protocol is a draft, and its syntax is subject to change.

You can read the current rendered draft by opening the [autogenerated webpage](https://cyanreg.github.io/avtransport/).

Links
=====
## Provisional information

### URI Scheme
The URI scheme shall be `avt://[<transport>@]<address>[:<port>]`. If `port` is not specified, the default port of `8212` shall be used.
If `transport` is not specified, the *udp* transport method shall be assumed. `transport` can be `udp`, `udplite` or `quic`.
Alternatively, for UDP-only, the `udp://<address>:<port>` URI scheme can be used, at the risk of conflict with other protocols (`MPEG-TS`).

### File extension
The `.at` or `.avt` file extensions shall be used.

## Links
You can talk about the project and get in touch with developers on:
- IRC: **`#avtransport`** on the [Libera.Chat](ircs://irc.libera.chat:6697) network
- [Libera.Chat’s guide on how to connect](https://libera.chat/guides/connect)
- Or use the [Kiwi web client](https://kiwiirc.com/nextclient/irc.libera.chat/?#avtransport)

# Feature comparison between protocols and containers
## License
The [specifications document)(draft-avtransport-spec.bs), and generated [HTML](https://cyanreg.github.io/avtransport/) are licensed under the **MIT-Zero** license.

The reference software (`libavtransport`) is licensed under the [**BSD 2-clause license**](LICENSE.md), in order to permit embedding, and free creation of alternative implementations.

## Feature comparison between protocols and containers

- Streamable - whether a protocol can be reliably streamed
* AVTransport: Yes. As both a protocol and a container, it can be direcly streamed over networks, pipes, packets, or serial links.
Expand Down
Loading

0 comments on commit 43d3d73

Please sign in to comment.