[deb_x265.git] / build / README.txt

= Mandatory Prerequisites =

* GCC, MSVC (9, 10, 11, 12), Xcode or Intel C/C++
* CMake 2.8.8 or later http://www.cmake.org
* On linux, ccmake is helpful, usually a package named cmake-curses-gui 

Note: MSVC12 requires cmake 2.8.11 or later


= Optional Prerequisites =

1. Yasm 1.2.0 or later, to compile assembly primitives (performance)

   For Windows, download the latest yasm executable
   http://yasm.tortall.net/Download.html and copy the EXE into
   C:\Windows or somewhere else in your %PATH% that a 32-bit app (cmake)
   can find it. If it is not in the path, you must manually tell cmake
   where to find it.  Note: you do not need the vsyasm packages, x265
   does not use them.  You only need the yasm executable itself.

   On Linux, the packaged yasm may be older than 1.2, in which case
   so you will need get the latest source and build it yourself.

   Once YASM is properly installed, run cmake to regenerate projects. If you
   do not see the below line in the cmake output, YASM is not in the PATH.

   -- Found Yasm 1.3.0 to build assembly primitives

   Now build the encoder and run x265 -V:

   x265 [info]: using cpu capabilities: MMX, SSE2, ...

   If cpu capabilities line says 'none!', then the encoder was built
   without yasm.

2. VisualLeakDetector (Windows Only)

   Download from https://vld.codeplex.com/releases and install. May need
   to re-login in order for it to be in your %PATH%.  Cmake will find it
   and enable leak detection in debug builds without any additional work.

   If VisualLeakDetector is not installed, cmake will complain a bit, but
   it is completely harmless.


= Build Instructions Linux =

1. Use cmake to generate Makefiles: cmake ../source
2. Build x265:                      make

  Or use our shell script which runs cmake then opens the curses GUI to
  configure build options

1. cd build/linux ; ./make-Makefiles.bash
2. make


= Build Instructions Windows =

We recommend you use one of the make-solutions.bat files in the appropriate
build/ sub-folder for your preferred compiler.  They will open the cmake-gui
to configure build options, click configure until no more red options remain,
then click generate and exit.  There should now be an x265.sln file in the
same folder, open this in Visual Studio and build it.

= Version number considerations =

Note that cmake will update X265_VERSION each time cmake runs, if you are
building out of a Mercurial source repository.  If you are building out of
a release source package, the version will not change.  If Mercurial is not
found, the version will be "unknown".
Commit	Line	Data
72b9787e JB	1	= Mandatory Prerequisites =
	2
	3	* GCC, MSVC (9, 10, 11, 12), Xcode or Intel C/C++
	4	* CMake 2.8.8 or later http://www.cmake.org
	5	* On linux, ccmake is helpful, usually a package named cmake-curses-gui
	6
	7	Note: MSVC12 requires cmake 2.8.11 or later
	8
	9
	10	= Optional Prerequisites =
	11
	12	1. Yasm 1.2.0 or later, to compile assembly primitives (performance)
	13
b53f7c52 JB	14	For Windows, download the latest yasm executable
	15	http://yasm.tortall.net/Download.html and copy the EXE into
	16	C:\Windows or somewhere else in your %PATH% that a 32-bit app (cmake)
	17	can find it. If it is not in the path, you must manually tell cmake
	18	where to find it. Note: you do not need the vsyasm packages, x265
	19	does not use them. You only need the yasm executable itself.
72b9787e	20
b53f7c52 JB	21	On Linux, the packaged yasm may be older than 1.2, in which case
b53f7c52 JB	22	so you will need get the latest source and build it yourself.
72b9787e JB	23
	24	Once YASM is properly installed, run cmake to regenerate projects. If you
	25	do not see the below line in the cmake output, YASM is not in the PATH.
	26
b53f7c52	27	-- Found Yasm 1.3.0 to build assembly primitives
72b9787e	28
b53f7c52	29	Now build the encoder and run x265 -V:
72b9787e	30
b53f7c52 JB	31	x265 [info]: using cpu capabilities: MMX, SSE2, ...
	32
	33	If cpu capabilities line says 'none!', then the encoder was built
	34	without yasm.
72b9787e JB	35
	36	2. VisualLeakDetector (Windows Only)
	37
	38	Download from https://vld.codeplex.com/releases and install. May need
	39	to re-login in order for it to be in your %PATH%. Cmake will find it
	40	and enable leak detection in debug builds without any additional work.
	41
	42	If VisualLeakDetector is not installed, cmake will complain a bit, but
	43	it is completely harmless.
	44
	45
	46	= Build Instructions Linux =
	47
	48	1. Use cmake to generate Makefiles: cmake ../source
	49	2. Build x265: make
	50
	51	Or use our shell script which runs cmake then opens the curses GUI to
	52	configure build options
	53
	54	1. cd build/linux ; ./make-Makefiles.bash
	55	2. make
	56
	57
	58	= Build Instructions Windows =
	59
	60	We recommend you use one of the make-solutions.bat files in the appropriate
	61	build/ sub-folder for your preferred compiler. They will open the cmake-gui
	62	to configure build options, click configure until no more red options remain,
	63	then click generate and exit. There should now be an x265.sln file in the
	64	same folder, open this in Visual Studio and build it.
	65
	66	= Version number considerations =
	67
	68	Note that cmake will update X265_VERSION each time cmake runs, if you are
	69	building out of a Mercurial source repository. If you are building out of
	70	a release source package, the version will not change. If Mercurial is not
	71	found, the version will be "unknown".