[fdkaac.git] / README

==========================================================================
fdkaac - command line frontend encoder for libfdk-aac
==========================================================================

Prerequisites
-------------
You need libfdk-aac.
On Posix environment, you will also need GNU gettext (for iconv.m4) and
GNU autoconf/automake.

How to build on Posix environment
---------------------------------
First, you need to build libfdk-aac and install on your system.
Once you have done it, the following will do the task.
(MinGW build can be done the same way, and doesn't require gettext/iconv)

$ autoreconf -i
$ ./configure && make && make install

How to build on MSVC
--------------------
First you have to extract libfdk-aac source here, so that directory tree will
look like the following:
+- fdk-aac ---+-documentation
|             +-libAACdec
|             +-libAACenc
|             :
+- m4
+- missings
+- MSVC
+- src

MSVC solution for Visual Studio 2010 is under MSVC directory.

Tagging Options
---------------
Generic tagging options like --tag, --tag-from-file, --long-tag allows you
to set arbitrary tags.
Available tags and their fcc (four char code) for --tag and --tag-from-file
can be found at http://code.google.com/p/mp4v2/wiki/iTunesMetadata

For tags such as Artist where first char of fcc is copyright sign,
you can skip first char and just say like --tag="ART:Foo Bar" or
--tag-from-file=lyr:/path/to/your/lyrics.txt

Currently, --tag-from-file just stores file contents into m4a without any
character encoding / line terminater conversion.
Therefore, only use UTF-8 (without BOM) when setting text tags by this option.

On the other hand, --tag / --long-tag (and other command line arguments) are
converted from locale character encoding to UTF-8 on Posix environment.
On Windows, command line arguments are always treated as Unicode.
Commit	Line	Data
48e2f01c	1	==========================================================================
	2	fdkaac - command line frontend encoder for libfdk-aac
	3	==========================================================================
	4
	5	Prerequisites
	6	-------------
e9014663	7	You need libfdk-aac.
	8	On Posix environment, you will also need GNU gettext (for iconv.m4) and
	9	GNU autoconf/automake.
	10
	11	How to build on Posix environment
	12	---------------------------------
	13	First, you need to build libfdk-aac and install on your system.
	14	Once you have done it, the following will do the task.
	15	(MinGW build can be done the same way, and doesn't require gettext/iconv)
48e2f01c	16
48e2f01c	17	$ autoreconf -i
e9014663	18	$ ./configure && make && make install
	19
	20	How to build on MSVC
	21	--------------------
	22	First you have to extract libfdk-aac source here, so that directory tree will
	23	look like the following:
	24	+- fdk-aac ---+-documentation
	25	\| +-libAACdec
	26	\| +-libAACenc
	27	\| :
	28	+- m4
	29	+- missings
	30	+- MSVC
	31	+- src
	32
	33	MSVC solution for Visual Studio 2010 is under MSVC directory.
a56831da	34
	35	Tagging Options
	36	---------------
	37	Generic tagging options like --tag, --tag-from-file, --long-tag allows you
	38	to set arbitrary tags.
	39	Available tags and their fcc (four char code) for --tag and --tag-from-file
	40	can be found at http://code.google.com/p/mp4v2/wiki/iTunesMetadata
	41
	42	For tags such as Artist where first char of fcc is copyright sign,
	43	you can skip first char and just say like --tag="ART:Foo Bar" or
	44	--tag-from-file=lyr:/path/to/your/lyrics.txt
adbd1aac	45
	46	Currently, --tag-from-file just stores file contents into m4a without any
	47	character encoding / line terminater conversion.
	48	Therefore, only use UTF-8 (without BOM) when setting text tags by this option.
	49
	50	On the other hand, --tag / --long-tag (and other command line arguments) are
	51	converted from locale character encoding to UTF-8 on Posix environment.
	52	On Windows, command line arguments are always treated as Unicode.