Fixed up comments

This commit is contained in:
Unknown 2017-12-06 13:41:32 +10:30
parent 94f8ffb361
commit 93ad5ed247
2 changed files with 37 additions and 35 deletions

View File

@ -1,15 +1,16 @@
/* /*
NAME NAME
revid - a testbed for re-muxing and re-directing video streams as MPEG-TS over various protocols. BitrateCalculator.go - is a simple struct with methods to allow for easy
calculation of bitrate.
DESCRIPTION DESCRIPTION
See Readme.md See Readme.md
AUTHOR AUTHOR
Alan Noble <anoble@gmail.com> Saxon Nelson-Milton <saxon.milton@gmail.com>
LICENSE LICENSE
revid is Copyright (C) 2017 Alan Noble. BitrateCalculator.go is Copyright (C) 2017 the Australian Ocean Lab (AusOcean)
It is free software: you can redistribute it and/or modify them 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 under the terms of the GNU General Public License as published by the
@ -34,38 +35,38 @@ import (
// bitrateCalculator implements interface BitrateCalculator // bitrateCalculator implements interface BitrateCalculator
type BitrateCalculator struct { type BitrateCalculator struct {
outputDelay int // sec outputDelay int // sec
now time.Time now time.Time
prev time.Time prev time.Time
startedBefore bool startedBefore bool
elapsedTime time.Duration elapsedTime time.Duration
lastDisplayTime time.Time lastDisplayTime time.Time
} }
// Place this at the start of the code segment that you would like to time // Place this at the start of the code segment that you would like to time
func (bc *BitrateCalculator) Start(outputDelay int) { func (bc *BitrateCalculator) Start(outputDelay int) {
if outputDelay >= 0{ if outputDelay >= 0 {
bc.outputDelay = outputDelay bc.outputDelay = outputDelay
} else { } else {
bc.outputDelay = 0 bc.outputDelay = 0
} }
bc.prev = time.Now() bc.prev = time.Now()
if !bc.startedBefore { if !bc.startedBefore {
bc.startedBefore = true bc.startedBefore = true
bc.elapsedTime = time.Duration(0) bc.elapsedTime = time.Duration(0)
bc.lastDisplayTime = time.Now() bc.lastDisplayTime = time.Now()
} }
} }
// Place this at the end of the code segment that you would like to time // Place this at the end of the code segment that you would like to time
func (bc *BitrateCalculator) Stop(noOfKB float64) (bitrate int64) { func (bc *BitrateCalculator) Stop(noOfKB float64) (bitrate int64) {
bc.now = time.Now() bc.now = time.Now()
deltaTime := bc.now.Sub(bc.prev) deltaTime := bc.now.Sub(bc.prev)
if bc.now.Sub(bc.lastDisplayTime) > time.Duration(bc.outputDelay)*time.Second { if bc.now.Sub(bc.lastDisplayTime) > time.Duration(bc.outputDelay)*time.Second {
bitrate = int64(noOfKB / float64(deltaTime/1e9)) bitrate = int64(noOfKB / float64(deltaTime/1e9))
fmt.Printf("Bitrate: %d kbps\n", bitrate) fmt.Printf("Bitrate: %d kbps\n", bitrate)
bc.elapsedTime = time.Duration(0) bc.elapsedTime = time.Duration(0)
bc.lastDisplayTime = bc.now bc.lastDisplayTime = bc.now
} }
return return
} }

View File

@ -1,15 +1,16 @@
/* /*
NAME NAME
revid - a testbed for re-muxing and re-directing video streams as MPEG-TS over various protocols. BitrateCalculator_test.go - is a file that may be used to test the
BitrateCalculator.go file using the golang testing utilities
DESCRIPTION DESCRIPTION
See Readme.md See Readme.md
AUTHOR AUTHOR
Alan Noble <anoble@gmail.com> Saxon Nelson-Milton <saxon.milton@gmail.com>
LICENSE LICENSE
revid is Copyright (C) 2017 Alan Noble. BitrateCalculator_test.go is Copyright (C) 2017 the Australian Ocean Lab (AusOcean)
It is free software: you can redistribute it and/or modify them 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 under the terms of the GNU General Public License as published by the
@ -46,30 +47,30 @@ var bitrateCalc BitrateCalculator
// Simple test to check that the calculator can calc bitrate over a given // Simple test to check that the calculator can calc bitrate over a given
// duration of time // duration of time
func Test1(t *testing.T) { func Test1(t *testing.T) {
bitrateCalc = BitrateCalculator{} bitrateCalc = BitrateCalculator{}
bitrateCalc.Start(bitrateDelay1) bitrateCalc.Start(bitrateDelay1)
time.Sleep(testTime * time.Millisecond) time.Sleep(testTime * time.Millisecond)
currentBitrate := int64(bitrateCalc.Stop(amountOfData)) currentBitrate := int64(bitrateCalc.Stop(amountOfData))
actualBitrate := int64(amountOfData / ((testTime * time.Millisecond)/1e9)) actualBitrate := int64(amountOfData / ((testTime * time.Millisecond) / 1e9))
if currentBitrate != actualBitrate { if currentBitrate != actualBitrate {
t.Errorf("Bitrate is wrong! Calculated: %v Actual %v", currentBitrate, actualBitrate) t.Errorf("Bitrate is wrong! Calculated: %v Actual %v", currentBitrate, actualBitrate)
} }
} }
// Now let's check that the output delay feature works // Now let's check that the output delay feature works
func Test2(t *testing.T){ func Test2(t *testing.T) {
bitrateCalc = BitrateCalculator{} bitrateCalc = BitrateCalculator{}
var currentBitrate int64 var currentBitrate int64
for i := 0; i < 2; i++ { for i := 0; i < 2; i++ {
bitrateCalc.Start(bitrateDelay2) bitrateCalc.Start(bitrateDelay2)
time.Sleep(testTime*time.Millisecond) time.Sleep(testTime * time.Millisecond)
currentBitrate = int64(bitrateCalc.Stop(amountOfData)) currentBitrate = int64(bitrateCalc.Stop(amountOfData))
if i == 0 && currentBitrate != 0 { if i == 0 && currentBitrate != 0 {
t.Errorf("The bitrate calc did not delay outputting!") t.Errorf("The bitrate calc did not delay outputting!")
} }
time.Sleep(6000*time.Millisecond) time.Sleep(6000 * time.Millisecond)
} }
actualBitrate := int64(amountOfData / ((testTime * time.Millisecond)/1e9)) actualBitrate := int64(amountOfData / ((testTime * time.Millisecond) / 1e9))
if currentBitrate != actualBitrate { if currentBitrate != actualBitrate {
t.Errorf("Bitrate is wrong! Calculated: %v Actual %v", currentBitrate, actualBitrate) t.Errorf("Bitrate is wrong! Calculated: %v Actual %v", currentBitrate, actualBitrate)
} }