Updated docs

Author: djthorpe

decoder.go

@@ -172,7 +172,6 @@ func (decoder *decoder) Rescale(width, height int) error {
 
 // Ref:
 // https://github.com/romatthe/alephone/blob/b1f7af38b14f74585f0442f1dd757d1238bfcef4/Source_Files/FFmpeg/SDL_ffmpeg.c#L2048
-
 func (decoder *decoder) re(src *ff.AVFrame) (*ff.AVFrame, error) {
 	switch decoder.codec.Codec().Type() {
 	case ff.AVMEDIA_TYPE_AUDIO:

mediatype.go

@@ -7,13 +7,13 @@ import (
 ////////////////////////////////////////////////////////////////////////////
 // TYPES
 
+// Media Types: Audio, Video, Subtitle or Data
 type MediaType int
 
 ////////////////////////////////////////////////////////////////////////////
 // GLOBALS
 
-// Media Types
 const (
-	AUDIO = MediaType(ff.AVMEDIA_TYPE_AUDIO)
-	VIDEO = MediaType(ff.AVMEDIA_TYPE_VIDEO)
+	AUDIO = MediaType(ff.AVMEDIA_TYPE_AUDIO) // Audio media type
+	VIDEO = MediaType(ff.AVMEDIA_TYPE_VIDEO) // Video media type
 )

reader.go

@@ -126,6 +126,7 @@ func (r *reader) Close() error {
 ////////////////////////////////////////////////////////////////////////////////
 // STRINGIFY
 
+// Display the reader as a string
 func (r *reader) MarshalJSON() ([]byte, error) {
 	return json.Marshal(r.input)
 }
@@ -175,7 +176,7 @@ func (r *reader) Demux(fn DecoderFunc) error {
 	return nil
 }
 
-// Decode packets from the streams into frames
+// Return a function to decode packets from the streams into frames
 func (r *reader) Decode(fn FrameFunc) DecoderFunc {
 	return func(codec Decoder, packet Packet) error {
 		if packet != nil {
@@ -231,7 +232,7 @@ type jsonMetadata struct {
 	Value string `json:"value"`
 }
 
-// Metadata returns the metadata for the media stream
+// Return the metadata for the media stream
 func (r *reader) Metadata() []Metadata {
 	entries := ff.AVUtil_dict_entries(r.input.Metadata())
 	result := make([]Metadata, len(entries))