don't fail on premature end of MP3 stream
[stretchplayer:stretchplayer.git] / README.txt
1 StretchPlayer - Audio file stretch player and phrase trainer\r
2 Copyright (C) 2010 by Gabriel M. Beddingfield\r
3 All Rights Reserved\r
4 \r
5 "For of him [God], and through him, and unto him, are all things.  To\r
6 him be the glory for ever. Amen." (Romans 11:36)\r
7 \r
8 CONTENTS\r
9 ========\r
10 1. Description\r
11 2. Dependencies and Installation\r
12 3. Usage\r
13 4. About StretchPlayer\r
14 \r
15 DESCRIPTION\r
16 ===========\r
17 \r
18 StretchPlayer is an audio file player that allows you to change the\r
19 speed of the song without changing the pitch.  It will also allow you\r
20 to transpose the song to another key (while also changing the speed).\r
21 This is a very powerful tool for musicians who are learning to play a\r
22 pre-recorded song.  It's features include:\r
23 \r
24     + Time Stretch (50% to 150% of song speed)\r
25     + Pitch shift (up or down 1 octave)\r
26     + A/B repeat\r
27 \r
28 The player supports all the audio formats that libsndfile supports,\r
29 which currently includes OGG/Vorbis, WAV, W64, AIFF, SND, and FLAC.\r
30 \r
31     +--------------------------------------------------+\r
32     | Note that neither libsndfile nor StretchPlayer   |\r
33     | supports MP3 files for patent liability reasons. |\r
34     +--------------------------------------------------+\r
35 \r
36 StretchPlayer is free software, distributed under the GNU Public\r
37 License, version 2 or later.  See the files gpl-2.0.txt and\r
38 gpl-3.0.txt for the details of the license.\r
39 \r
40 DEPENDENCIES AND INSTALLATION\r
41 =============================\r
42 \r
43 Please read the file INSTALL.txt for package dependencies and\r
44 installation instructions.\r
45 \r
46 USAGE\r
47 =====\r
48 \r
49 $ stretchplayer\r
50 \r
51 If you hover over the buttons with your mouse, you'll find several\r
52 keyboard shortcuts.  One extra shortcut is the [HOME] key, which will\r
53 set everything back to default settings (including relocating to the\r
54 beginning of the song).\r
55 \r
56     +-------------------------------------------+\r
57     | Important: Performance                    |\r
58     |                                           |\r
59     | Make sure that you use a JACK buffer size |\r
60     | larger than 256.  Less than 256 is known  |\r
61     | to have real-time issues.                 |\r
62     +-------------------------------------------+\r
63 \r
64 ABOUT STRETCHPLAYER\r
65 ===================\r
66 \r
67 StretchPlayer is free software written to glorify God and His Savior\r
68 Jesus Christ.  I dedicate this code to spreading His word and His\r
69 love.  If you have found this software useful, please make a donation\r
70 to a Christian missionary.  Suggested donation is US $10 or US $20.\r
71 \r
72 The mission is (of course) your choice... but if you don't know one to\r
73 pick, may I suggest Wycliffe Bible Translators (www.wycliffe.org).\r
74 They are an organization dedicated to translating the Bible into the\r
75 "heart language" of every person on earth -- *every* indigenous\r
76 language.  In doing so, they have brought literacy to thousands of\r
77 third-world peoples.  These peoples now have their language written\r
78 down, increased literacy rates, and greater pride in their heritage\r
79 through such literacy.  This is admirable even if you are not a\r
80 believer of Jesus Christ.\r
81 \r
82 Are you a believer and a follower of Jesus Christ?  Do you have in\r
83 your life peace and forgiveness of sins?  Or do you live in fear of\r
84 God because of your sins -- the evil things that you do every day?\r
85 Jesus didn't come put you down!  He came to SAVE you from your sins.\r
86 He came to:\r
87 \r
88  (1) forgive you for all your sins (past, present, and future)\r
89  (2) Make a way for God to live inside you (every day), to teach you\r
90      about Himself, and to be your friend.\r
91 \r
92 But this can only happen if you surrender your life to Him.  To say,\r
93 "I have sinned.  I am sorry.  I turn from that, and turn to you, God.\r
94 Please forgive me for my sins.  I give my life to you.  You are now in\r
95 control... I am your slave.  I will follow Your Word.  What You say, I\r
96 will do."  Not those exact words... but you get the idea.  When this\r
97 happens, the Holy Spirit comes into your life and lives within you.\r
98 This happens as a "down payment" (from God to you) -- as a way of\r
99 proving that you *will* be with God when you die.  Proving that you\r
100 are now a child of God -- no longer an enemy but a favored child.\r
101 (Otherwise, you will go to hell -- forever separated from God.)\r
102 \r
103 Don't believe me?  OK.  But this is what the Bible (the Christian\r
104 Scriptures / Holy Book) says about it:\r
105 \r
106 1. That people are separated from God by sins...\r
107 "All have sinned, and fall short of the glory of God." (Romans 3:26)\r
108 \r
109 2. That God loves you and wants to FREE you...\r
110 "For God so loved the world, that he gave his only begotten Son, that\r
111 whoever believes on him should not perish, but have eternal life. For\r
112 God sent not the Son into the world to judge the world; but that the\r
113 world should be saved through him. He that believes on him is not\r
114 judged: he that does not believe has been judged already, because he\r
115 has not believed on the name of the only begotten Son of God." (John\r
116 3:16-18)\r
117 \r
118 3. That Jesus is the ONLY way...\r
119 "And in no other is there salvation: for there is no other name under\r
120 heaven, that is given among men, by which we must be saved." (Acts\r
121 4:12)\r
122 \r
123 If you now believe -- tell someone.  Even me.\r
124 \r
125 Offended?  No flames, please.  I'm not forcing myself on anyone.\r
126 \r
127 Questions?  Drop me a line:  gabriel@teuton.org\r
128 \r
129 Grace and peace to you all!\r
130 \r