Merge pull request #8 from mutablelogic/5.1

Updated documentation and a few other changes

Author: djthorpe

README.md

@@ -23,20 +23,6 @@ On Macintosh with [homebrew](http://bew.sh/), for example:
 
 ```bash
 brew install ffmpeg chromaprint make
-git clone [email protected]:djthorpe/go-media.git
-cd go-media
-make
-```
-
-On Debian Linux:
-
-
-```bash
-sudo apt install libavcodec-dev libavdevice-dev libavfilter-dev \
-       libavformat-dev libavresample-dev libavutil-dev libchromaprint-dev
-git clone [email protected]:djthorpe/go-media.git
-cd go-media
-make
 ```
 
 There are some examples in the `cmd` folder of the main repository on how to use
@@ -47,6 +33,14 @@ the package. The various make targets are:
   * `make cmd` will build example command-line tools into the `build` folder;
   * `make clean` will remove all build artifacts.
 
+For example,
+
+```bash
+git clone [email protected]:djthorpe/go-media.git
+cd go-media
+make
+```
+
 ## Examples
 
 There are two example [Command Line applications](https://github.com/mutablelogic/go-media/tree/master/cmd):
@@ -59,9 +53,9 @@ You can compile both applications with `make cmd`which places the binaries into
 Use the `-help` option on either application to see the options.
 
 
-## The Media Transcoding API
+## Media Transcoding
 
-The API is split into two parts:
+You can programmatically demultiplex, re-multiplex and re-sample media files using the following packages:
 
   * `sys/ffmpeg51` provides the implementation of the lower-level function calls
     to ffmpeg. The documentation is [here](https://pkg.go.dev/github.com/mutablelogic/go-media/sys/ffmpeg51)
@@ -75,7 +69,15 @@ The API is split into two parts:
 
 ## Audio Fingerprinting
 
-TODO
+You can programmatically fingerprint audio files, compare fingerprints and identify music using the following packages:
+
+  * `sys/chromaprint` provides the implementation of the lower-level function calls
+    to chromaprint. The documentation is [here](https://pkg.go.dev/github.com/mutablelogic/go-media/sys/chromaprint)
+  * `pkg/chromaprint` provides the higher-level API for fingerprinting and identifying music. The documentation 
+    is [here](https://pkg.go.dev/github.com/mutablelogic/go-media/pkg/chromaprint).
+
+You'll need an API key in order to use the [AcoustID](https://acoustid.org/) service. You can get a key 
+[here](https://acoustid.org/login).
 
 ## Contributing & Distribution
 
@@ -86,7 +88,7 @@ The license is Apache 2 so feel free to redistribute. Redistributions in either
 code or binary form must reproduce the copyright notice, and please link back to this
 repository for more information:
 
-> Copyright (c) 2021, David Thorpe, All rights reserved.
+> Copyright (c) 2021-2023 David Thorpe, All rights reserved.
 
 ## References
 

cmd/transcode/main.go

@@ -118,7 +118,9 @@ func main() {
 		fmt.Fprintln(os.Stderr, err)
 		os.Exit(-2)
 	}
-	fmt.Println(media_map)
+
+	// Print the map
+	media_map.PrintMap(os.Stdout)
 
 	// For the output, we can output to a device, a URL, or a file
 	var out Media

media.go

@@ -107,6 +107,9 @@ type Map interface {
 
 	// Return streams which are mapped for decoding
 	Streams() []Stream
+
+	// Print a summary of the mapping
+	PrintMap(w io.Writer)
 }
 
 // Media is a source or destination of media

pkg/media/map.go

@@ -2,6 +2,8 @@ package media
 
 import (
 	"context"
+	"fmt"
+	"io"
 
 	// Packages
 	multierror "github.com/hashicorp/go-multierror"
@@ -172,9 +174,35 @@ func (m *decodemap) Demux(ctx context.Context, p Packet, fn DemuxFn) error {
 	}
 }
 
+// PrintMap will print out a summary of the mapping
+func (m *decodemap) PrintMap(w io.Writer) {
+	for id := range m.context {
+		stream := m.input.streams[id]
+		fmt.Fprintf(w, "Stream %2d (%s): %s\n", id, toMediaType(stream.Flags()), stream)
+	}
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 // PRIVATE METHODS
 
+// Return media type (audio, video, subtitle, etc)
+func toMediaType(flag MediaFlag) string {
+	switch {
+	case flag.Is(MEDIA_FLAG_AUDIO):
+		return "audio"
+	case flag.Is(MEDIA_FLAG_VIDEO):
+		return "video"
+	case flag.Is(MEDIA_FLAG_SUBTITLE):
+		return "subtitle"
+	case flag.Is(MEDIA_FLAG_DATA):
+		return "data"
+	case flag.Is(MEDIA_FLAG_ATTACHMENT):
+		return "attachment"
+	default:
+		return "other"
+	}
+}
+
 // Return streams of a given type for input media
 func streamsByType(input *input, media_type MediaFlag) map[int]*mapentry {
 	if input == nil || input.ctx == nil {

pkg/media/stream.go

@@ -65,10 +65,22 @@ func (stream *stream) Flags() MediaFlag {
 		return flags
 	}
 
-	// TODO: Add codec flags
-	//if stream.ctx.CodecPar()codec != nil {
-	//	flags |= s.codec.Flags()
-	//}
+	// Add codec parameter flags
+	if stream.ctx != nil {
+		t := stream.ctx.CodecPar().CodecType()
+		switch t {
+		case ffmpeg.AVMEDIA_TYPE_AUDIO:
+			flags |= MEDIA_FLAG_AUDIO
+		case ffmpeg.AVMEDIA_TYPE_VIDEO:
+			flags |= MEDIA_FLAG_VIDEO
+		case ffmpeg.AVMEDIA_TYPE_SUBTITLE:
+			flags |= MEDIA_FLAG_SUBTITLE
+		case ffmpeg.AVMEDIA_TYPE_DATA:
+			flags |= MEDIA_FLAG_DATA
+		case ffmpeg.AVMEDIA_TYPE_ATTACHMENT:
+			flags |= MEDIA_FLAG_ATTACHMENT
+		}
+	}
 
 	// Remove encoder/decoder flags
 	flags &^= (MEDIA_FLAG_ENCODER | MEDIA_FLAG_DECODER)

sys/ffmpeg51/avformat.go

@@ -43,7 +43,7 @@ const (
 	// Needs '%d' in filename.
 	AVFMT_NEEDNUMBER AVFormat = C.AVFMT_NEEDNUMBER
 	// The muxer/demuxer is experimental and should be used with caution
-	//AVFMT_EXPERIMENTAL AVFormat = C.AVFMT_EXPERIMENTAL
+	AVFMT_EXPERIMENTAL AVFormat = C.AVFMT_EXPERIMENTAL
 	// Show format stream IDs numbers.
 	AVFMT_SHOWIDS AVFormat = C.AVFMT_SHOW_IDS
 	// Format wants global header.
@@ -116,14 +116,14 @@ const (
 	AV_DISPOSITION_CLEAN_EFFECTS    AVDisposition = C.AV_DISPOSITION_CLEAN_EFFECTS
 	AV_DISPOSITION_ATTACHED_PIC     AVDisposition = C.AV_DISPOSITION_ATTACHED_PIC
 	AV_DISPOSITION_TIMED_THUMBNAILS AVDisposition = C.AV_DISPOSITION_TIMED_THUMBNAILS
-	//AV_DISPOSITION_NON_DIEGETIC     AVDisposition = C.AV_DISPOSITION_NON_DIEGETIC
-	AV_DISPOSITION_CAPTIONS     AVDisposition = C.AV_DISPOSITION_CAPTIONS
-	AV_DISPOSITION_DESCRIPTIONS AVDisposition = C.AV_DISPOSITION_DESCRIPTIONS
-	AV_DISPOSITION_METADATA     AVDisposition = C.AV_DISPOSITION_METADATA
-	AV_DISPOSITION_DEPENDENT    AVDisposition = C.AV_DISPOSITION_DEPENDENT
-	AV_DISPOSITION_STILL_IMAGE  AVDisposition = C.AV_DISPOSITION_STILL_IMAGE
-	AV_DISPOSITION_NONE         AVDisposition = 0
-	AV_DISPOSITION_MAX                        = AV_DISPOSITION_STILL_IMAGE
+	AV_DISPOSITION_NON_DIEGETIC     AVDisposition = C.AV_DISPOSITION_NON_DIEGETIC
+	AV_DISPOSITION_CAPTIONS         AVDisposition = C.AV_DISPOSITION_CAPTIONS
+	AV_DISPOSITION_DESCRIPTIONS     AVDisposition = C.AV_DISPOSITION_DESCRIPTIONS
+	AV_DISPOSITION_METADATA         AVDisposition = C.AV_DISPOSITION_METADATA
+	AV_DISPOSITION_DEPENDENT        AVDisposition = C.AV_DISPOSITION_DEPENDENT
+	AV_DISPOSITION_STILL_IMAGE      AVDisposition = C.AV_DISPOSITION_STILL_IMAGE
+	AV_DISPOSITION_NONE             AVDisposition = 0
+	AV_DISPOSITION_MAX                            = AV_DISPOSITION_STILL_IMAGE
 )
 
 const (

sys/ffmpeg51/avformat_core.go

@@ -60,10 +60,9 @@ func AVFormat_avformat_get_class() *AVClass {
 ////////////////////////////////////////////////////////////////////////////////
 // PUBLIC METHODS - AVSTREAM
 
-//Commented out due to not compiling on debian
-//func AVFormat_avstream_getclass() *AVClass {
-//	return (*AVClass)(C.av_stream_get_class())
-//}
+func AVFormat_avstream_getclass() *AVClass {
+	return (*AVClass)(C.av_stream_get_class())
+}
 
 func AVFormat_avformat_new_stream(oc *AVFormatContext, c *AVCodec) *AVStream {
 	return (*AVStream)(C.avformat_new_stream((*C.struct_AVFormatContext)(oc), (*C.struct_AVCodec)(c)))