diff --git a/cmd/audio-netsender/main.go b/cmd/audio-netsender/main.go index 4cc9d0c6..ec2da04b 100644 --- a/cmd/audio-netsender/main.go +++ b/cmd/audio-netsender/main.go @@ -27,7 +27,7 @@ LICENSE If not, see http://www.gnu.org/licenses. */ -// audio-netsender is a NetSender client for sending audio to +// Package audio-netsender is a NetSender client for sending audio to // NetReceiver. Audio is captured by means of an ALSA recording // device, specified by the NetReceiver "source" variable. It sent via // HTTP to NetReceiver in raw audio form, i.e., as PCM data, where it diff --git a/cmd/audio-player/looper/main.go b/cmd/audio-player/looper/main.go index 358ed00d..c2ddd118 100644 --- a/cmd/audio-player/looper/main.go +++ b/cmd/audio-player/looper/main.go @@ -24,7 +24,7 @@ LICENSE in gpl.txt. If not, see http://www.gnu.org/licenses. */ -// Looper is a bare bones program for repeated playback of an audio file. +// Package looper is a bare bones program for repeated playback of an audio file. package main import ( diff --git a/codec/h264/extract.go b/codec/h264/extract.go index 9c7da115..62d4453b 100644 --- a/codec/h264/extract.go +++ b/codec/h264/extract.go @@ -25,6 +25,9 @@ LICENSE along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. */ +// Package h264 provides functionality for handling the H.264 video codec. +// This includes extraction from an RTP stream, lexing of NAL units from +// byte stream, and decoding. package h264 import ( diff --git a/codec/h264/h264dec/helpers.go b/codec/h264/h264dec/helpers.go index d215b839..8f60262c 100644 --- a/codec/h264/h264dec/helpers.go +++ b/codec/h264/h264dec/helpers.go @@ -4,6 +4,22 @@ DESCRIPTION AUTHORS Saxon Nelson-Milton , The Australian Ocean Laboratory (AusOcean) + +LICENSE + rtp.go is Copyright (C) 2018 the Australian Ocean Lab (AusOcean) + + It 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 + for more details. + + You should have received a copy of the GNU General Public License + along with revid in gpl.txt. If not, see [GNU licenses](http://www.gnu.org/licenses). */ package h264dec diff --git a/codec/mjpeg/extract.go b/codec/mjpeg/extract.go index d8baa7a1..3d7e9ca9 100644 --- a/codec/mjpeg/extract.go +++ b/codec/mjpeg/extract.go @@ -23,6 +23,9 @@ LICENSE along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. */ +// Package mjpeg provides functionality for extraction of MJPEG from an +// RTP-MJPEG stream and lexing of individual JPEGs from a bare bones +// MJPEG stream. package mjpeg import ( diff --git a/codec/mjpeg/jpeg.go b/codec/mjpeg/jpeg.go index be09289a..6506fc39 100644 --- a/codec/mjpeg/jpeg.go +++ b/codec/mjpeg/jpeg.go @@ -30,7 +30,6 @@ LICENSE Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -// Package mjpeg a lexer and decoder for mjpeg video. package mjpeg import ( diff --git a/codec/pcm/pcm_test.go b/codec/pcm/pcm_test.go index 8e9cf891..8af24855 100644 --- a/codec/pcm/pcm_test.go +++ b/codec/pcm/pcm_test.go @@ -24,6 +24,7 @@ LICENSE You should have received a copy of the GNU General Public License in gpl.txt. If not, see [GNU licenses](http://www.gnu.org/licenses). */ + package pcm import ( diff --git a/container/flv/encoder.go b/container/flv/encoder.go index 7355af43..2905a736 100644 --- a/container/flv/encoder.go +++ b/container/flv/encoder.go @@ -1,6 +1,6 @@ /* NAME - flv_generator.go + encoder.go DESCRIPTION See Readme.md diff --git a/container/mts/pes/pes.go b/container/mts/pes/pes.go index 3de57e11..2be40f41 100644 --- a/container/mts/pes/pes.go +++ b/container/mts/pes/pes.go @@ -1,6 +1,7 @@ /* NAME pes.go - + DESCRIPTION See Readme.md diff --git a/container/mts/pes/pes_test.go b/container/mts/pes/pes_test.go index d54d0f4a..27dccd24 100644 --- a/container/mts/pes/pes_test.go +++ b/container/mts/pes/pes_test.go @@ -1,6 +1,6 @@ /* NAME - mpegts_test.go + pes_test.go DESCRIPTION See Readme.md diff --git a/container/mts/psi/helpers.go b/container/mts/psi/helpers.go index 621460f5..1a780f81 100644 --- a/container/mts/psi/helpers.go +++ b/container/mts/psi/helpers.go @@ -1,6 +1,7 @@ /* NAME helpers.go + DESCRIPTION helpers.go provides functionality for editing and reading bytes slices directly in order to insert/read timestamp and location data in psi. diff --git a/container/mts/psi/psi.go b/container/mts/psi/psi.go index 8af447f1..96b630b1 100644 --- a/container/mts/psi/psi.go +++ b/container/mts/psi/psi.go @@ -1,6 +1,7 @@ /* NAME psi.go + DESCRIPTION See Readme.md @@ -24,7 +25,7 @@ LICENSE along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. */ -// Package psi provides encoding of PSI packets. +// Package psi provides encoding of MPEG-TS program specific information. package psi import ( diff --git a/container/mts/psi/psi_test.go b/container/mts/psi/psi_test.go index 7e3a3104..657ed533 100644 --- a/container/mts/psi/psi_test.go +++ b/container/mts/psi/psi_test.go @@ -1,6 +1,7 @@ /* NAME psi_test.go + DESCRIPTION See Readme.md diff --git a/container/mts/psi/std.go b/container/mts/psi/std.go index 1ebe5ea3..97a09d92 100644 --- a/container/mts/psi/std.go +++ b/container/mts/psi/std.go @@ -1,6 +1,7 @@ /* NAME std.go + DESCRIPTION See Readme.md diff --git a/device/device.go b/device/device.go index efdc7043..96eb9394 100644 --- a/device/device.go +++ b/device/device.go @@ -24,6 +24,8 @@ LICENSE in gpl.txt. If not, see http://www.gnu.org/licenses. */ +// Package device provides an interface and implementations for input devices +// that can be started and stopped from which media data can be obtained. package device import ( diff --git a/device/geovision/config/config-cli/main.go b/device/geovision/config/config-cli/main.go index 72cab4d7..148e82ad 100644 --- a/device/geovision/config/config-cli/main.go +++ b/device/geovision/config/config-cli/main.go @@ -22,7 +22,7 @@ LICENSE in gpl.txt. If not, see http://www.gnu.org/licenses. */ -// config-cli is a command-line program for configuring the GeoVision camera. +// Package config-cli is a command-line program for configuring the GeoVision camera. package main import ( diff --git a/device/raspivid/raspivid.go b/device/raspivid/raspivid.go index ae77d8e2..6be1785c 100644 --- a/device/raspivid/raspivid.go +++ b/device/raspivid/raspivid.go @@ -22,7 +22,8 @@ LICENSE in gpl.txt. If not, see http://www.gnu.org/licenses. */ -// Package raspivid provides an implementation of AVDevice for the raspberry pi camera. +// Package raspivid provides an implementation of AVDevice for the raspberry +// pi camera. package raspivid import ( diff --git a/device/raspivid/raspivid_test.go b/device/raspivid/raspivid_test.go index a1822317..76a54e3c 100644 --- a/device/raspivid/raspivid_test.go +++ b/device/raspivid/raspivid_test.go @@ -21,6 +21,7 @@ LICENSE You should have received a copy of the GNU General Public License in gpl.txt. If not, see http://www.gnu.org/licenses. */ + package raspivid import ( diff --git a/device/webcam/webcam_test.go b/device/webcam/webcam_test.go index 45f8e205..3c58c6e8 100644 --- a/device/webcam/webcam_test.go +++ b/device/webcam/webcam_test.go @@ -21,6 +21,7 @@ LICENSE You should have received a copy of the GNU General Public License in gpl.txt. If not, see http://www.gnu.org/licenses. */ + package webcam import ( diff --git a/exp/adpcm/decode-pcm/decode-pcm.go b/exp/adpcm/decode-pcm/decode-pcm.go index 2d471324..d4b238d5 100644 --- a/exp/adpcm/decode-pcm/decode-pcm.go +++ b/exp/adpcm/decode-pcm/decode-pcm.go @@ -22,7 +22,7 @@ LICENSE If not, see [GNU licenses](http://www.gnu.org/licenses). */ -// decode-pcm is a command-line program for decoding/decompressing an adpcm file to a pcm file. +// Package decode-pcm is a command-line program for decoding/decompressing an adpcm file to a pcm file. package main import ( diff --git a/exp/adpcm/encode-pcm/encode-pcm.go b/exp/adpcm/encode-pcm/encode-pcm.go index ded88017..4d70d0de 100644 --- a/exp/adpcm/encode-pcm/encode-pcm.go +++ b/exp/adpcm/encode-pcm/encode-pcm.go @@ -22,7 +22,7 @@ LICENSE If not, see [GNU licenses](http://www.gnu.org/licenses). */ -// encode-pcm is a command-line program for encoding/compressing a pcm file to an adpcm file. +// Package encode-pcm is a command-line program for encoding/compressing a pcm file to an adpcm file. package main import ( diff --git a/exp/flac/flac_test.go b/exp/flac/flac_test.go index 1f8019e5..7366d643 100644 --- a/exp/flac/flac_test.go +++ b/exp/flac/flac_test.go @@ -24,6 +24,7 @@ LICENSE 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. */ + package flac import ( diff --git a/exp/pcm/resample/resample.go b/exp/pcm/resample/resample.go index 6c7106b6..6d9a1af7 100644 --- a/exp/pcm/resample/resample.go +++ b/exp/pcm/resample/resample.go @@ -22,7 +22,7 @@ LICENSE If not, see [GNU licenses](http://www.gnu.org/licenses). */ -// resample is a command-line program for resampling a pcm file. +// Package resample is a command-line program for resampling a pcm file. package main import ( diff --git a/exp/pcm/stereo-to-mono/stereo-to-mono.go b/exp/pcm/stereo-to-mono/stereo-to-mono.go index 84700737..6fc421b5 100644 --- a/exp/pcm/stereo-to-mono/stereo-to-mono.go +++ b/exp/pcm/stereo-to-mono/stereo-to-mono.go @@ -22,7 +22,7 @@ LICENSE If not, see [GNU licenses](http://www.gnu.org/licenses). */ -// stereo-to-mono is a command-line program for converting a mono pcm file to a stereo pcm file. +// Package stereo-to-mono is a command-line program for converting a mono pcm file to a stereo pcm file. package main import ( diff --git a/exp/rvcl/main.go b/exp/rvcl/main.go index 7e51c457..7f9ff87f 100644 --- a/exp/rvcl/main.go +++ b/exp/rvcl/main.go @@ -54,7 +54,7 @@ USAGE bitbucket.org/ausocean/av/device for input device specific variables. */ -// rvcl is a command line interface for revid. +// Package rvcl is a command line interface for revid. package main import ( diff --git a/filter/filter.go b/filter/filter.go index ec182531..55e557ed 100644 --- a/filter/filter.go +++ b/filter/filter.go @@ -22,8 +22,8 @@ LICENSE in gpl.txt. If not, see http://www.gnu.org/licenses. */ -// Package filter provides the interface and implementations of the filters to be used -// on video input that has been lexed. +// Package filter provides the interface and implementations of the filters +// to be used on video input that has been lexed. package filter import ( diff --git a/protocol/rtp/rtp.go b/protocol/rtp/rtp.go index ba9ab8f5..7551914b 100644 --- a/protocol/rtp/rtp.go +++ b/protocol/rtp/rtp.go @@ -1,11 +1,13 @@ /* NAME - rtp.go - provides a data structure intended to encapsulate the properties - of an rtp packet and also functions to allow manipulation of these packets. + rtp.go DESCRIPTION See Readme.md + See https://tools.ietf.org/html/rfc6184 and https://tools.ietf.org/html/rfc3550 + for rtp-h264 and rtp standards. + AUTHOR Saxon A. Nelson-Milton @@ -26,10 +28,8 @@ LICENSE along with revid in gpl.txt. If not, see [GNU licenses](http://www.gnu.org/licenses). */ -/* -See https://tools.ietf.org/html/rfc6184 and https://tools.ietf.org/html/rfc3550 -for rtp-h264 and rtp standards. -*/ +// Package rtp provides a data structure intended to encapsulate the properties +// of an rtp packet and also functions to allow manipulation of these packets. package rtp import (