Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/mono/taglib-sharp

Library for reading and writing metadata in media files
https://github.com/mono/taglib-sharp

Last synced: 18 days ago
JSON representation

Library for reading and writing metadata in media files

Lists

README 

        
# TagLib#



[![Join the chat at https://gitter.im/mono/taglib-sharp](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mono/taglib-sharp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)



(aka *Taglib-sharp*) is a .NET platform-independent library (tested on Windows/Linux) for reading and writing

metadata in media files, including video, audio, and photo formats.

This is a convenient one-stop-shop to present or tag all your media collection, regardless of which format/container

these might use. You can read/write the standard or more common tags/properties of a media, or you can also create and

retrieve your own custom tags.



It supports the following formats (by file-extensions):

 * **Video:** mkv, ogv, avi, wmv, asf, mp4 (m4p, m4v), mpeg (mpg, mpe, mpv, mpg, m2v)

 * **Audio:** aa, aax, aac, aiff, ape, dsf, flac, m4a, m4b, m4p, mp3, mpc, mpp, ogg, oga, wav, wma, wv, webm

 * **Images:** bmp, gif, jpeg, pbm, pgm, ppm, pnm, pcx, png, tiff, dng, svg



It is API stable, with only API additions (not changes or removals)

occuring in the 2.0 series.



## Examples



### Read/write metadata from a video

```C#

var tfile = TagLib.File.Create(@"C:\My video.avi");

string title = tfile.Tag.Title;

TimeSpan duration = tfile.Properties.Duration;

Console.WriteLine("Title: {0}, duration: {1}", title, duration);



// change title in the file

tfile.Tag.Title = "my new title";

tfile.Save();

```



### Read/write metadata from a Audio file

```C#

var tfile = TagLib.File.Create(@"C:\My audio.mp3");

string title = tfile.Tag.Title;

TimeSpan duration = tfile.Properties.Duration;

Console.WriteLine("Title: {0}, duration: {1}", title, duration);



// change title in the file

tfile.Tag.Title = "my new title";

tfile.Save();

```



### Read/write metadata from an Image

```C#

var tfile = TagLib.File.Create(@"C:\My picture.jpg");

string title = tfile.Tag.Title;

var tag =  tfile.Tag as TagLib.Image.CombinedImageTag;

DateTime? snapshot = tag.DateTime;

Console.WriteLine("Title: {0}, snapshot taken on {1}", title, snapshot);



// change title in the file

tfile.Tag.Title = "my new title";

tfile.Save();

```



### Read/write custom tags from a specific format

```C#

var tfile = TagLib.File.Create(@"C:\My song.flac");

var custom = (TagLib.Ogg.XiphComment) tfile.GetTag(TagLib.TagTypes.Xiph);



// Read

string [] myfields = custom.GetField("MY_TAG");

Console.WriteLine("First MY_TAG entry: {0}", myfields[0]);



// Write

custom.SetField("MY_TAG", new string[] { "value1", "value2" });

custom.RemoveField("OTHER_FIELD");

rgFile.Save();

```



## Website

TagLib# is available on GitHub: 

* **Bugs:**     Create an [issue](https://github.com/mono/taglib-sharp/issues)

* **Chat:**     Join us at [Gitter](https://gitter.im/mono/taglib-sharp)

* **Git:**      Get the source at 



## Installation From NuGet



TagLib# is available on NuGet: 



Install from package manager:



PM> Install-Package TagLibSharp -Version 2.3.0



## Building and Running



### Command Line



#### To Build From Git:



```sh

git clone https://github.com/mono/taglib-sharp.git

cd taglib-sharp

dotnet build

```



#### To Test:



```

dotnet test

```



### Build in IDE (Visual Studio, Visual Studio for Mac, Rider, etc):



You can open it in Visual Studio by using TaglibSharp.sln



#### Running regression by using Nunit 3 Test Adapter:



1. Ensure NuGet packages have been restored

    1. See: 

2. In Visual Studio, go to menu: Tools > Extensions and Updates > Online

   (In Visual Studio 2019, use Extensions > Manage Extensions)

3. Search: Nunit 3 Test Adapter

4. Download and install it

5. Open from menu: Test > Windows > Test Explorer

   (In Visual Studio 2019, use Test > Test Explorer)

6. You can run your tests from this panel (*not* using the "Start" button)

7. You can debug your tests from this panel:

   1. Double click on a test. Set some breakpoints in the test in the editor panel.

   2. right-click on the same test, select "Debug Selected tests".



#### To test some scenarios and take advantage of the debugger:



1. Make the "debug" project the Startup project

    (Right-click on the project, select: "Set as StartUp Project")

2. Just modify the "Program.cs"

3. Set some breakpoints and hit the "Start" button



## They also use TagLib#

Non exhaustive list of projects that use TagLib#:

* [Lidarr](https://lidarr.audio/)

* [MediaPortal 2](https://www.team-mediaportal.com/wiki/display/MediaPortal2/MediaPortal+2)

* [F-Spot](https://en.wikipedia.org/wiki/F-Spot)



And you, what do you use TagLib# for? Reply [here](https://github.com/mono/taglib-sharp/issues/120)



## Contributions



TagLib# is free/open source software, released under the LGPL.

We welcome contributions!  Please try to match our coding style,

and include unit tests with any patches.  Patches can be submitted

by issuing a Pull Request (Git).