diff --git a/README.md b/README.md new file mode 100644 index 00000000..d205e29b --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Readme + +av is a collection of tools and packages written in Go for audio-video processing. + +Various tools are provided for media capture and playback (cmd). + +There are packages providing support for various codecs (codec), container formats (container), +input devices (device), filters (filter), protocols (protocol) and media capture +processing and forwarding (revid). + +# Contributing + +If you wish to contribute to this project, please contact info@ausocean.org for +permissions. Pull requests require an accompanying issue. +Please see [av issue](https://bitbucket.org/ausocean/av/issues) for current issues, +or creation of an issue. + +# License + +Copyright (C) 2017-2021 the Australian Ocean Lab (AusOcean). + +This is free software: you can redistribute it and/or modify them +under the terms of the GNU General Public License as published by the +Free Software Foundation, either version 3 of the License, or (at your +option) any later version. + +It is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +or more details. + +You should have received a copy of the GNU General Public License +along with revid in gpl.txt. If not, see http://www.gnu.org/licenses/. diff --git a/cmd/README.md b/cmd/README.md new file mode 100644 index 00000000..c75a736f --- /dev/null +++ b/cmd/README.md @@ -0,0 +1,13 @@ +# Readme + +cmd contains commands for media collection/processing/forwarding and playback. + +# Contributing + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "Contributing" +for information on how to contribute. + +# License + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "License" +for licensing. diff --git a/codec/README.md b/codec/README.md new file mode 100644 index 00000000..14612378 --- /dev/null +++ b/codec/README.md @@ -0,0 +1,13 @@ +# Readme + +codec provides support for various audio, video and image codecs. + +# Contributing + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "Contributing" +for information on how to contribute. + +# License + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "License" +for licensing. diff --git a/container/README.md b/container/README.md new file mode 100644 index 00000000..5fb3c9da --- /dev/null +++ b/container/README.md @@ -0,0 +1,14 @@ +# Readme + +Package container provides functionality for container formats, namely MPEG-TS +(see mts) and FLV (see flv). + +# Contributing + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "Contributing" +for information on how to contribute. + +# License + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "License" +for licensing. diff --git a/device/README.md b/device/README.md new file mode 100644 index 00000000..30b44ce2 --- /dev/null +++ b/device/README.md @@ -0,0 +1,16 @@ +# Readme + +Package device defines an input device interface (AVDevice) which implements +io.Reader and provides configuration and start/stop control. Various packages +containing implementations of this interface are also provided for various +input devices. + +# Contributing + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "Contributing" +for information on how to contribute. + +# License + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "License" +for licensing. diff --git a/exp/README.md b/exp/README.md new file mode 100644 index 00000000..ab946fd4 --- /dev/null +++ b/exp/README.md @@ -0,0 +1,13 @@ +# Readme + +Package exp contains experimental packages/commands. + +# Contributing + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "Contributing" +for information on how to contribute. + +# License + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "License" +for licensing. diff --git a/filter/README.md b/filter/README.md new file mode 100644 index 00000000..86db56cd --- /dev/null +++ b/filter/README.md @@ -0,0 +1,15 @@ +# Readme + +Package filter contains media filtering functionality. A "Filter" interface is +provided, along with implementations of this interface for primarily motion +detection models such as KNN and MOG. + +# Contributing + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "Contributing" +for information on how to contribute. + +# License + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "License" +for licensing. diff --git a/protocol/README.md b/protocol/README.md new file mode 100644 index 00000000..65825aa6 --- /dev/null +++ b/protocol/README.md @@ -0,0 +1,13 @@ +# Readme + +Package protocol provides support for various RT media protocols. + +# Contributing + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "Contributing" +for information on how to contribute. + +# License + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "License" +for licensing. diff --git a/revid/README.md b/revid/README.md new file mode 100644 index 00000000..ae0e2ccb --- /dev/null +++ b/revid/README.md @@ -0,0 +1,22 @@ +# Readme + +Package revid provides an API for a media capture/processing/forwarding +pipeline. The API is exposed in revid.go. + +Configuration is handled by the config package. + +Pipeline setup is handled in pipeline.go, where components of the pipeline are +pulled mostly from internal packages i.e. lexers, filters, packetisation and +protocols for forwarding. + +Sending is handled by "senders", defined in the senders.go file. + +# Contributing + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "Contributing" +for information on how to contribute. + +# License + +See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "License" +for licensing.