added comments

Author: Binozo

pkg/pcm/config.go

@@ -3,10 +3,15 @@ package pcm
 import "github.com/Binozo/GoTinyAlsa/internal/tinypcm"
 
 type Config struct {
-	Channels         int
-	SampleRate       int
-	PeriodSize       int
-	PeriodCount      int
+	// The number of audio channels
+	Channels int
+	// Sample rate (the higher, the better)
+	SampleRate int
+	// Number of frames in a period
+	PeriodSize int
+	// Number of periods
+	PeriodCount int
+	// IO Format
 	Format           tinypcm.Format
 	StartThreshold   int
 	StopThreshold    int

pkg/pcm/info.go

@@ -1,19 +1,34 @@
 package pcm
 
 type Info struct {
-	Access         uint
-	Format0        uint
-	Format1        uint
-	FormatNames    []string
-	Subformat      uint
-	RateMin        uint
-	RateMax        uint
-	ChannelsMin    uint
-	ChannelsMax    uint
-	SampleBitsMin  uint
-	SampleBitsMax  uint
-	PeriodSizeMin  uint
-	PeriodSizeMax  uint
+	// Mask that represents the type of read or write methods available
+	Access uint
+	// Mask that represents the PCM_FORMAT available (e.g. PCM_FORMAT_32_LE)
+	Format0 uint
+	// Mask that represents the PCM_FORMAT available (e.g. PCM_FORMAT_32_LE)
+	Format1 uint
+	// Pcm formats available
+	FormatNames []string
+	// Mask that represents the subformat available
+	Subformat uint
+	// Minimum available rate
+	RateMin uint
+	// Maximum available rate
+	RateMax uint
+	// Minimum available channels
+	ChannelsMin uint
+	// Maximum available channels
+	ChannelsMax uint
+	// Minimum available sample bits
+	SampleBitsMin uint
+	// Maximum available sample bits
+	SampleBitsMax uint
+	// Minimum available period size
+	PeriodSizeMin uint
+	// Maximum available period size
+	PeriodSizeMax uint
+	// Minimum available period count
 	PeriodCountMin uint
+	// Maximum available period count
 	PeriodCountMax uint
 }

pkg/tinyalsa/audio.go

@@ -21,6 +21,7 @@ const PCM_FORMAT_S32_LE = tinyapi.PCM_FORMAT_S32_LE
 const PCM_FORMAT_S32_BE = tinyapi.PCM_FORMAT_S32_BE
 const ErrorTolerance = 10 // defines how many error frames are allowed to be read without stopping reading the next ones
 
+// GetAudioStream Listens to the input of the defined device
 func (d *AlsaDevice) GetAudioStream(config pcm.Config, audioData chan []byte) error {
 	pcmDevice, err := tinyapi.PcmOpen(d.Card, d.Device, PCM_IN, config)
 	if err != nil {
@@ -61,6 +62,7 @@ FrameReader:
 	return nil
 }
 
+// SendAudioStream plays the given audio data (usually wav) to the device
 func (d *AlsaDevice) SendAudioStream(audioData []byte) error {
 	pcmDevice, err := tinyapi.PcmOpen(d.Card, d.Device, PCM_OUT, d.DeviceConfig)
 	if err != nil {

pkg/tinyalsa/device.go

@@ -12,6 +12,7 @@ type AlsaDevice struct {
 	DeviceConfig pcm.Config
 }
 
+// NewDevice defines a new device you want to interact with
 func NewDevice(cardNr int, deviceNr int, deviceConfig pcm.Config) AlsaDevice {
 	return AlsaDevice{
 		Card:         cardNr,
@@ -20,6 +21,7 @@ func NewDevice(cardNr int, deviceNr int, deviceConfig pcm.Config) AlsaDevice {
 	}
 }
 
+// BestDeviceConfig return you the best device config to use
 func BestDeviceConfig(cardNr int, deviceNr int, format int) pcm.Config {
 	device := AlsaDevice{
 		Card:         cardNr,
@@ -42,6 +44,7 @@ func BestDeviceConfig(cardNr int, deviceNr int, format int) pcm.Config {
 	}
 }
 
+// GetInfo returns information data about the given device's input & output
 func (d *AlsaDevice) GetInfo() DeviceInfo {
 	inInfo, outInfo := tinyapi.GetParams(d.Card, d.Device)
 	return DeviceInfo{

pkg/tinyalsa/deviceinfo.go

@@ -3,14 +3,18 @@ package tinyalsa
 import "github.com/Binozo/GoTinyAlsa/pkg/pcm"
 
 type DeviceInfo struct {
+	// Output info (e.g. speaker)
 	Out pcm.Info
-	In  pcm.Info
+	// Input info (e.g. microphone)
+	In pcm.Info
 }
 
+// HasOutput returns true, if the given device has an output (e.g. speaker)
 func (i *DeviceInfo) HasOutput() bool {
 	return i.Out.Access != 0 && i.Out.RateMin != 0
 }
 
+// HasInput returns true, if the given device has an input (e.g. microphone)
 func (i *DeviceInfo) HasInput() bool {
 	return i.In.Access != 0 && i.In.RateMin != 0
 }