From b66f415e1ccdc142ddc74df2d75aa7cf24eccd4b Mon Sep 17 00:00:00 2001 From: Trek H Date: Mon, 11 Nov 2019 17:50:46 +1030 Subject: [PATCH] audio: renamed Device to AudioDevice --- device/audio/audio.go | 32 ++++++++++++++++---------------- device/audio/audio_test.go | 2 +- revid/audio_linux.go | 2 +- 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/device/audio/audio.go b/device/audio/audio.go index 949a4741..3ba11f69 100644 --- a/device/audio/audio.go +++ b/device/audio/audio.go @@ -61,8 +61,8 @@ const ( stopped ) -// Device holds everything we need to know about the audio input stream and implements io.Reader. -type Device struct { +// AudioDevice holds everything we need to know about the audio input stream and implements io.Reader. +type AudioDevice struct { l Logger // Logger for device's routines to log to. mode uint8 // Operating mode, either running, paused, or stopped. mu sync.Mutex // Provides synchronisation when changing modes concurrently. @@ -74,7 +74,7 @@ type Device struct { Config // Configuration parameters for this device. } -// Config provides parameters used by Device. +// Config provides parameters used by AudioDevice. type Config struct { SampleRate int Channels int @@ -93,14 +93,14 @@ type Logger interface { // OpenError is used to determine whether an error has originated from attempting to open a device. type OpenError error -// NewDevice initializes and returns a Device which has its logger set as the given logger. -func NewDevice(l Logger) *Device { return &Device{l: l} } +// NewAudioDevice initializes and returns a AudioDevice which has its logger set as the given logger. +func NewAudioDevice(l Logger) *AudioDevice { return &AudioDevice{l: l} } // Set will take a Config struct, check the validity of the relevant fields // and then performs any configuration necessary. If fields are not valid, // an error is added to the multiError and a default value is used. -// It then initialises the Device which can then be started, read from, and stopped. -func (d *Device) Set(c config.Config) error { +// It then initialises the AudioDevice which can then be started, read from, and stopped. +func (d *AudioDevice) Set(c config.Config) error { var errs device.MultiError if c.SampleRate <= 0 { errs = append(errs, fmt.Errorf("invalid sample rate: %v", c.SampleRate)) @@ -162,8 +162,8 @@ func (d *Device) Set(c config.Config) error { } // Start will start recording audio and writing to the ringbuffer. -// Once a Device has been stopped it cannot be started again. This is likely to change in future. -func (d *Device) Start() error { +// Once a AudioDevice has been stopped it cannot be started again. This is likely to change in future. +func (d *AudioDevice) Start() error { d.mu.Lock() mode := d.mode d.mu.Unlock() @@ -184,15 +184,15 @@ func (d *Device) Start() error { } // Stop will stop recording audio and close the device. -// Once a Device has been stopped it cannot be started again. This is likely to change in future. -func (d *Device) Stop() { +// Once a AudioDevice has been stopped it cannot be started again. This is likely to change in future. +func (d *AudioDevice) Stop() { d.mu.Lock() d.mode = stopped d.mu.Unlock() } // ChunkSize returns the number of bytes written to the ringbuffer per d.RecPeriod. -func (d *Device) ChunkSize() int { +func (d *AudioDevice) ChunkSize() int { return d.chunkSize } @@ -218,7 +218,7 @@ func validate(c *Config) error { // open the recording device with the given name and prepare it to record. // If name is empty, the first recording device is used. -func (d *Device) open() error { +func (d *AudioDevice) open() error { // Close any existing device. if d.dev != nil { d.l.Log(logger.Debug, pkg+"closing device", "title", d.title) @@ -351,7 +351,7 @@ func (d *Device) open() error { // input continously records audio and writes it to the ringbuffer. // Re-opens the device and tries again if ASLA returns an error. -func (d *Device) input() { +func (d *AudioDevice) input() { for { // Check mode. d.mu.Lock() @@ -402,7 +402,7 @@ func (d *Device) input() { } // Read reads from the ringbuffer, returning the number of bytes read upon success. -func (d *Device) Read(p []byte) (int, error) { +func (d *AudioDevice) Read(p []byte) (int, error) { // Ready ringbuffer for read. _, err := d.rb.Next(rbNextTimeout) if err != nil { @@ -414,7 +414,7 @@ func (d *Device) Read(p []byte) (int, error) { } // formatBuffer returns audio that has been converted to the desired format. -func (d *Device) formatBuffer() alsa.Buffer { +func (d *AudioDevice) formatBuffer() alsa.Buffer { var err error // If nothing needs to be changed, return the original. diff --git a/device/audio/audio_test.go b/device/audio/audio_test.go index f27a5659..da4c2cfd 100644 --- a/device/audio/audio_test.go +++ b/device/audio/audio_test.go @@ -49,7 +49,7 @@ func TestDevice(t *testing.T) { // Create a new audio Device, start, read/lex, and then stop it. l := logger.New(logger.Debug, os.Stderr, true) - ai := NewDevice(l) + ai := NewAudioDevice(l) err := ai.Set(c) // If there was an error opening the device, skip this test. if _, ok := err.(OpenError); ok { diff --git a/revid/audio_linux.go b/revid/audio_linux.go index 622188b4..631af00e 100644 --- a/revid/audio_linux.go +++ b/revid/audio_linux.go @@ -29,7 +29,7 @@ import ( // It returns a function that can be used to stop the device and any errors that occur. func (r *Revid) startAudioDevice() (func() error, error) { // Create audio device. - ai := audio.NewDevice(r.cfg.Logger) + ai := audio.NewAudioDevice(r.cfg.Logger) err := ai.Set(r.cfg) if err != nil {