xmms-sid: INSTALL annotate

annotate INSTALL @ 776:bb7b3ded919a

Indeed, libsidplay-fp's audio renderer expects buffer of 16-bit shorts and number of samples as input, AND returns number of samples. Thus, we need to divide and multiply the values accordingly. However, it also seems that some internal buffers in resid-fp are hardcoded to certain size, and using too big audio buffers cause overflows .. trying to compensate for that by limiting the amount of audio rendered. Unfortunately there are still memory corruptions.

author	Matti Hamalainen <ccr@tnsp.org>
date	Tue, 06 Nov 2012 11:59:24 +0200
parents	8c80b3c5c053
children	b8b9da405e8c

rev	line source
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	1 This document describes overall requirements and procedure
9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	2 for installation of XMMS-SID package, please read it carefully!
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	3 For more information and tips, please refer to README and FAQ.
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	4
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	5 Requirements
183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	6 ============
738 73608042aec8 Update version requirements. Matti Hamalainen <ccr@tnsp.org> parents: 680 diff changeset	7 - Last version of XMMS1, version 1.2.11.
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	8
738 73608042aec8 Update version requirements. Matti Hamalainen <ccr@tnsp.org> parents: 680 diff changeset	9 - Last versions of Gtk+1 and Glib1: 1.2.10 (http://www.gtk.org/)
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	10
304 512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	11 - ANSI-C and C++-compiler. Preferably GCC along with rest of
512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	12 the GNU toolchain. I have no idea whether this compiles with
171 78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	13 any other compiler ... sorry.
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	14
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	15 - You need AT LEAST one of the following emulation libraries:
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	16
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	17 * libSIDPlay1
741 8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	18 * libSIDPlay2 or libSIDPlay-FP (mutually exclusive)
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	19
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	20 Only one emulator backend library is required, but all are
336 171b428ee806 Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 304 diff changeset	21 supported with compile & run-time configuration. You may also
171b428ee806 Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 304 diff changeset	22 need some supplementary libraries for each emulator library.
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	23 See below for more information.
171 78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	24
78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	25
336 171b428ee806 Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 304 diff changeset	26 Emulator library selection hints
171b428ee806 Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 304 diff changeset	27 ================================
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	28 Some words on which emulation library you should choose to install
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	29 and use - it depends somewhat on your system and personal preferences.
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	30
416 eff5ea454bae Changed wording. Matti Hamalainen <ccr@tnsp.org> parents: 391 diff changeset	31 - libSIDPlay v1: This is the old and original emulation library. Its
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	32 emulation is "frame-based" and not very accurate. The waveforms
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	33 produced are harsher and emulation of SID filter is far from
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	34 accurate.
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	35
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	36 libSIDPlay v1 requires very little CPU power, it is faster and
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	37 may have fewer bugs due to being more mature software. Many
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	38 OS distributions have pre-built packages of it, not something that
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	39 can be said of libSIDPlay v2. Some people may even like the
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	40 harsher sound produced by libSIDPlay v1.
171 78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	41
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	42 Drawbacks are: worse emulation, eventually weakening compability
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	43 as new SID-tunes/files are ripped into "RSID"-format which
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	44 libSIDPlay v1 does NOT support.
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	45
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	46
741 8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	47 - libSIDPlay2+reSID or HardSID: A much more accurate emulation
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	48 framework. Unfortunately the original fork has mostly stalled,
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	49 though works. Much heavier CPU-load compared to libSIDPlay1,
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	50 but not as heavy as libSIDPlay-FP.
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	51
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	52
741 8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	53 - libSIDPlay-FP: Fork of libSIDPlay2. New, next generation modular
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	54 SID-emulation framework. Along with reSID-library it produces
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	55 probably most accurate software-emulated representation of
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	56 SID-chip available. This, however, comes at high cost:
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	57 libSIDPlay2/FP tends to eat CPU like popcorn.
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	58
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	59 It is also less spread, not packaged in distributions (that I know of,
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	60 at the time of writing of this), so you may have to roll your own.
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	61
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	62 Also the API-stability of libSIDPlay2/FP is not yet 100%, there may
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	63 be changes. Bugs are evident, though many of them will be fixed
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	64 eventually.
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	65
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	66
741 8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	67 Conclusion thus is as follows: If you are using a VERY old system with not
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	68 much spare CPU-power, choose libSIDPlay v1. On a relatively "recent"
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	69 system (Pentium-M, Pentium4 1GHz+) you may wish to choose libSIDPlay v2.
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	70
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	71 On a Intel Core2 or Intel Core i5/7 level system you could choose
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc. Matti Hamalainen <ccr@tnsp.org> parents: 739 diff changeset	72 libSIDPlay-FP, if you have ~20% CPU to spare.
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	73
183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	74
183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	75 Where to get XMMS?
183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	76 ==================
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	77 Latest version of XMMS should be available from:
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	78
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	79 http://www.xmms.org/
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	80
171 78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	81 Please refer to XMMS documentation for information on its usage
78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	82 and installation, etc. You probably have XMMS already installed,
78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	83 but if you installed from a pre-built package, make sure that
78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	84 you have corresponding xmms-devel -package also.
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	85
183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	86
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	87 Where to get libSIDPlay1?
9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	88 =========================
679 36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	89 Typically your OS distribution and/or some supplementary package
559 80f7cafcda0a Updated installation instructions, also moved libSIDPlay2 Matti Hamalainen <ccr@tnsp.org> parents: 483 diff changeset	90 repository may contain libSIDPlay1 packages. Usually those work
391 3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	91 well, but remember to also install the corresponding -dev/-devel
559 80f7cafcda0a Updated installation instructions, also moved libSIDPlay2 Matti Hamalainen <ccr@tnsp.org> parents: 483 diff changeset	92 package so that XMMS-SID can be compiled.
391 3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	93
559 80f7cafcda0a Updated installation instructions, also moved libSIDPlay2 Matti Hamalainen <ccr@tnsp.org> parents: 483 diff changeset	94 If you can't find pre-made packages for your OS, source tarballs
80f7cafcda0a Updated installation instructions, also moved libSIDPlay2 Matti Hamalainen <ccr@tnsp.org> parents: 483 diff changeset	95 for libSIDPlay1 are available at SIDPlay's homepage:
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	96
145 e85ea6735767 Updated requirements. Matti Hamalainen <ccr@tnsp.org> parents: 123 diff changeset	97 http://www.geocities.com/SiliconValley/Lakes/5147/sidplay/linux.html
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	98
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	99 You only need libsidplay, the sidplay-base is not necessary
559 80f7cafcda0a Updated installation instructions, also moved libSIDPlay2 Matti Hamalainen <ccr@tnsp.org> parents: 483 diff changeset	100 for building or using XMMS-SID (it contains a command-line
80f7cafcda0a Updated installation instructions, also moved libSIDPlay2 Matti Hamalainen <ccr@tnsp.org> parents: 483 diff changeset	101 SID-player).
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	102
23 469efc05e01e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 7 diff changeset	103
559 80f7cafcda0a Updated installation instructions, also moved libSIDPlay2 Matti Hamalainen <ccr@tnsp.org> parents: 483 diff changeset	104 Where to get and how to install libSIDPlay2?
80f7cafcda0a Updated installation instructions, also moved libSIDPlay2 Matti Hamalainen <ccr@tnsp.org> parents: 483 diff changeset	105 ============================================
80f7cafcda0a Updated installation instructions, also moved libSIDPlay2 Matti Hamalainen <ccr@tnsp.org> parents: 483 diff changeset	106 Please read the following web-page:
391 3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	107
559 80f7cafcda0a Updated installation instructions, also moved libSIDPlay2 Matti Hamalainen <ccr@tnsp.org> parents: 483 diff changeset	108 http://www.tnsp.org/?p=libsidplay2
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	109
80 7047a6390b08 Updated and improved documentation Matti Hamalainen <ccr@tnsp.org> parents: 41 diff changeset	110
679 36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	111 Building a Mercurial-version
680 f5b818a57d0c Few cosmetic fixes and clarifications. Matti Hamalainen <ccr@tnsp.org> parents: 679 diff changeset	112 ============================
679 36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	113 To build a version of XMMS-SID from Mercurial repository,
36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	114 you need to have following tools installed:
34 0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	115
679 36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	116 - GNU autoconf 2.60 or newer
738 73608042aec8 Update version requirements. Matti Hamalainen <ccr@tnsp.org> parents: 680 diff changeset	117 - GNU automake 1.11 or newer
680 f5b818a57d0c Few cosmetic fixes and clarifications. Matti Hamalainen <ccr@tnsp.org> parents: 679 diff changeset	118 - GNU libtool 1.5.22 or newer
41 c145ff12f2d0 Various improvements Matti Hamalainen <ccr@tnsp.org> parents: 36 diff changeset	119 - Glade for Gtk+ 1.2 programs (I use Glade 0.6.4)
34 0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	120
679 36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	121 Source repository can be fetched via Mercurial using:
36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	122
739 bd12199a9a84 Update Mercurial repository URL. Matti Hamalainen <ccr@tnsp.org> parents: 738 diff changeset	123 $ hg clone http://tnsp.org/hg/xmms-sid xmms-sid-hg
679 36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	124
36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	125 If you have all required tools installed, you can then just
36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	126
36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	127 $ cd xmms-sid-hg
36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	128 $ hg update tip
680 f5b818a57d0c Few cosmetic fixes and clarifications. Matti Hamalainen <ccr@tnsp.org> parents: 679 diff changeset	129 $ ./bootstrap.sh
679 36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	130
36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	131 Running bootstrap.sh should generate all necessary build-files,
36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	132 assuming everything went well. After successfull bootstrapping,
36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	133 you should be able to compile the package normally, following
36a2d95e4644 Updated documentation, added Mercurial instructions. Matti Hamalainen <ccr@tnsp.org> parents: 559 diff changeset	134 steps described below.
34 0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	135
0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	136
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	137 Installing XMMS-SID
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	138 ===================
171 78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	139 When you have the requirements installed and working succesfully,
559 80f7cafcda0a Updated installation instructions, also moved libSIDPlay2 Matti Hamalainen <ccr@tnsp.org> parents: 483 diff changeset	140 you may try compilation and installation of XMMS-SID.
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	141
559 80f7cafcda0a Updated installation instructions, also moved libSIDPlay2 Matti Hamalainen <ccr@tnsp.org> parents: 483 diff changeset	142 Invoke configure script (use 'configure --help' for help)
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	143
738 73608042aec8 Update version requirements. Matti Hamalainen <ccr@tnsp.org> parents: 680 diff changeset	144 $ ./configure
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	145
559 80f7cafcda0a Updated installation instructions, also moved libSIDPlay2 Matti Hamalainen <ccr@tnsp.org> parents: 483 diff changeset	146 The configure script will print out lots of information and in
34 0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	147 the end it tells you some of the selected build options.
0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	148
304 512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	149 NOTICE! On some systems it may be necessary to force 'configure'
512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	150 to use gcc instead of g++ with following syntax:
512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	151
512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	152 $ CC=gcc CXX=g++ ./configure
512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	153
512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	154
34 0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	155 If configure passed without errors, try compilation. (Depending
0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	156 on your system, you may need to invoke 'gmake' instead of 'make'.)
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	157
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	158 $�make
e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	159
198 c7b5120c53c8 Cleanup Matti Hamalainen <ccr@tnsp.org> parents: 181 diff changeset	160 If that went OK too, then you may try installation. Again, you
c7b5120c53c8 Cleanup Matti Hamalainen <ccr@tnsp.org> parents: 181 diff changeset	161 may need to invoke 'gmake' instead of 'make'. Install globally
c7b5120c53c8 Cleanup Matti Hamalainen <ccr@tnsp.org> parents: 181 diff changeset	162 to whole system (as root):
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	163
e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	164 # make install
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	165
483 3f58a06bc9df Typofixes in instructions. Matti Hamalainen <ccr@tnsp.org> parents: 416 diff changeset	166 or install for current user only: (NOTICE! Locales and data files
3f58a06bc9df Typofixes in instructions. Matti Hamalainen <ccr@tnsp.org> parents: 416 diff changeset	167 will not be installed with this method)
181 be1cf864f28e Added install-user and uninstall-user targets which install to current Matti Hamalainen <ccr@tnsp.org> parents: 171 diff changeset	168
be1cf864f28e Added install-user and uninstall-user targets which install to current Matti Hamalainen <ccr@tnsp.org> parents: 171 diff changeset	169 $ make install-user
be1cf864f28e Added install-user and uninstall-user targets which install to current Matti Hamalainen <ccr@tnsp.org> parents: 171 diff changeset	170
249 b02705a9b2d6 Duh. Matti Hamalainen <ccr@tnsp.org> parents: 210 diff changeset	171 Assuming all went correctly, XMMS-SID is now installed. You should
b02705a9b2d6 Duh. Matti Hamalainen <ccr@tnsp.org> parents: 210 diff changeset	172 now start or re-start XMMS and configure XMMS-SID's various options.
199 6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	173
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	174
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	175 Post-installation configuration
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	176 ===============================
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	177 To gain full advantage of using XMMS-SID, you need to configure it.
199 6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	178 XMMS-SID can be configured just like any other XMMS plugin, in XMMS
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	179 do as follows:
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	180
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	181 -> Press <ctrl+p>
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	182 -> Select "Audio I/O Plugins"-tab
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	183 -> Choose "XMMS-SID x.y.z [libxmmssid.so]" from the list
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	184 -> Click "Configure"
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	185
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	186 Please refer to README for more information about configuration.
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	187

Mercurial > hg > xmms-sid

annotate INSTALL @ 776:bb7b3ded919a