Read Me

******************************ENGLISH******************************

Stealth Player - short description

STEALTH PLAYER - mini player with no GUI 
Version: 1.0 
http://sourceforge.net/projects/stealthplayer/
(c) Alkatraz Studio, 2008-2010


***DESCRIPTION***

Stealth Player is very convenient if you don't need any flashy GUI to control playback or manage playlists. Here you just run it and then forget about it. The player is running in background. Switching tracks, volume regulation, loading and saving playlists, all of this performed by using hotkeys. Therefore, you can control the player while working in any application.

Supported sound formats: MO3/IT/XM/S3M/MTM/MOD/UMX/MP3/MP2/MP1/OGG/WAV
Player can open playlists with extensions: LST/M3U/M3U8
Player can open internet radio streams, but not remote playlists containing those streams.

Stealth Player will work on Windows XP or later. But all features (i. e. balloon tooltips or support for dynamic change of the output device) become available only on Windows 7.
 
 
***QUICK START***

1. Unpack contents of the archive;
2. Run StealthReg.bat;
3. Right-click on any folder with music;
4. Choose "Open with Stealth Player" from a context menu.
 

***SETUP***

For further information on how to setup or compile Stealth Player or use it with a bluetooth remote control read INSTALL.DIZ


***COMMAND LINE KEYS***

Command line format:
stealth [commands] [files]

Commands:
	--numlock=x - if x=0, then do not turn Numlock on automatically (useful for laptops or palmtops without numeric keypad); default: 1;
	--shuffle=x - if x=1, then turn random playback on; default: 0;
	--recursive=x - if x=1, then load files from subfolders too (if not specified or x=0 then load only from folder); default: 0;
	--priority=x - if x='low', then set player process priority to lowest (may decrease performance); if x='high', then set player process priority to highest (may decrease performance of other programs); default: normal;
	--resume=x - if x=1, then if player was closed, but user didn't stop playback (for example, on Windows shutdown), then resume playback automatically when the player will start. This key works only if no input files were specified; default: 0;
	--volume-step=x - increasing/decreasing volume by x points (0<x<=100); default: 1;
	--hotkeys=x - turn on x set of the hotkeys, where x is:
		extra1 - turn "extra keys 1" on (see below)
		extra2 - turn "extra keys 2" on
		multimedia - turn "media keys" on
		general - turn "general keys" on (default)
	--hotkeys-off=x - turn off x set of the hotkeys, where x is:
		extra1 - turn "extra keys 1" off (default)
		extra2 - turn "extra keys 2" off (default)
		multimedia - turn "media keys" off (default)
		general - turn "general keys" off
	--playlists-limit=x - if x=0, then turn on unlimited playlist mode, so you can operate on more than 9 playlists. Hold down CTRL to load playlist (or CTRL+ALT to save playlist) and type its number. Keep holding CTRL until playlist loads. See more info below; default: 1;
	--typing-timeout=x - set timeout for typing playlist's number to x milliseconds. That's it, if set to 1000 (default), you must wait 1 second before releasing CTRL key to load playlist after typing it's number. Works only if --playlists-limit=0. See example below; default: 1000;
	--auto-play=x - if x=0, then disable the automatic music playing after program start; default: 1;
	--balloons=x - if x=1, then use balloon tooltips. Balloon tooltips will popup every time the track or sound volume changes; default: 0;
	--captions=x - if x=short, then display only track title in a tray hint; default: normal;
	-- - after this parameter, all other parameters are ignored, it useful to open files or folders whose names start with "--"

"files" means any supported audio-files, internet streams, playlists or folders. Parameters can follow in any sequence. Remember, to open files or folders that starts with "--", you must first use "--" parameter, that disables any parsing of further parameters (see example below).

Examples:
1) stealth musiс.m3u --shuffle=1 - opens playlist music.m3u and turns random playback on;
2) stealth --hotkeys=extra1 --hotkeys=extra2 --numlock=0  - loads nothing, turns on "extra keys 1" and two additional keys from "extra keys 2" (see below) and will not affect NumLock;
3) stealth "http://72.26.204.28:6414/" --hotkeys-off=general - connects to radio and turns numpad hotkeys off, so you can use them in other applications;
4) stealth "C:\Mod Music" --recursive=1 "C:\MP3s" - loads all files from C:\Mod Music\, then all files from C:\MP3s and from all subfolders of C:\MP3s.
5) Stealth.exe "C:\Mod Music\" --playlists-limit=0 --typing-timeout=2000 - loads files from C:\Mod Music\, set unlimited playlists mode, so you can handle more than 9 playlists, i. e. to save current files in playlist 1337.lst: hold down CTRL+ALT, type "1337" on numpad, wait for 2 sec holding CTRL+ALT. The playlist is saved. You may now release CTRL+ALT.
6) .\stealth.exe --auto-play=0 -- --auto-play=0 - start Stealth Player from a current folder, then try to load all files from the folder "--auto-play=0", but not subfolders, and player would not start playing after the start


***HOTKEYS***

Control keys available everywhere and therefore cannot be used in other applications unless disabled (or unless player is closed). Numlock mode should be on to make general hotkeys work. Common keys work all the time while the player is running. You can't disable them. Multimedia keys also supported. Extra keys are helpful when you control your computer from cellphone by bluetooth. Read INSTALL.DIZ for more information. 

------common keys (always on)------
	Scroll Lock - random/sequential playback
	Shift+Alt+Pause - hotkeys off/on (except common keys)
	Left click on tray icon - sound mixer
	Right click on tray icon - exit
	Middle Click on tray icon - show playlists folder

------general keys (--hotkeys=general option)------
	NumPad 5 - stop/play
	NumPad 4 - previous track
	NumPad 6 - next track
	NumPad 8 - volume up
	NumPad 2 - volume down
	NumPad 7 - jump to previous folder
	NumPad 9 - jump to next folder
	NumPad 0 - exit
	CTRL+NumPad X - load playlist number X
	CTRL+ALT+NumPad X - save current tracks in playlist number X
	
------extra keys 1 (--hotkeys=extra1 option)-------
	Ctrl+P - stop/play
	Ctrl+B - previous track
	Ctrl+F - next track
	F10 - volume up
	F9 - volume down
	Ctrl+Shift+B - jump to previous folder (if combined with -kb2 option)
	Ctrl+Shift+F - jump to next folder (if combined with -kb2 option)

------extra keys 2 (--hotkeys=extra2 option)-------	
	Ctrl+S - stop/play
	Ctrl+B - previous track
	Ctrl+F - next track
	Ctrl+P - volume up
	F10 - volume down
	Ctrl+Shift+B - jump to previous folder
	Ctrl+Shift+F - jump to next folder
	
------media keys (--hotkeys=multimedia option)-------
	PLAY_PAUSE - play/stop
	PREV_TRACK - previous track
	NEXT_TRACK - next track


***PLAYLISTS***

Playlists must be located in "playlists" subfolder. Here are some tips regarding playlists:
	1. file extension must be one of supported playlist extensions (see above);
	2. first symbols in filename should be a digits representing playlist number. A non-numeric symbol should follow after playlist's number. For example playlist 7-Neskimos.lst will be loaded by pressing Ctrl+Numpad 7;
	3. if unlimited playlists mode is on (see above) then you can operate with almost unlimited number of playlists (see Examples to understand this technique) ;
	4. playlists parsed line by line, so you can put comments in it (see playlists/101 - Folder.lst for example);
	5. you can load folders from playlists (see playlists/101 - Folder.lst for example);
	6. playlists can be either in ANSI or UTF-8 (with BOM) format.
	
	
***KNOWN BUGS***

Known bugs,which are not planned to be solved in near future:
	1. Some MOD files can run forever if they have infinite loops in their structure (it's not a bug but a warning). Stealth Player plays MOD files as they must be played;
	2. Player may not understand some *.IT and *.XM files;
	3. When random playback is on player may jump to the same file next (well, it's random playback! isn't it? :);
	4. Metadata from some radio stations may be incorrect. It's not Stealth Player's fault, it's because some radios are transmitting metadata in code pages other than ASCII, but they must not.
	

***PROJECT SUPPORT***

If you want to help a project, the best you can is to report a bug, you have found.
To submit a bug, follow this link:
https://sourceforge.net/tracker/?group_id=332937&atid=1395937
and press "Add New"
... or, in a pinch, mail me (on address below).

If have other suggestions on how to improve the project, for example, about new functionality, write me:
alkatrazstudio@yandex.ru - Alexey Parfenov


******************************RUSSIAN******************************

Stealth Player - краткое описание

STEALTH PLAYER - мини плеер без графического интерфейса 
Версия: 1.0 
http://sourceforge.net/projects/stealthplayer/
(c) Alkatraz Studio, 2008-2010


***ОПИСАНИЕ***

Очень удобен для воспроизведения музыки в фоновом режиме, т.е. по принципу “включил и забыл”. Переключение трэков, регулировка громкости, загрузка и сохранение плэйлистов осуществляется одной-двумя клавишами на цифровой клавиатуре. При этом эти горячие клавиши доступны из любого приложения, поэтому нет необходимости переключать окна и отвлекаться от основной работы. 

Поддерживаемые аудио-форматы: MO3/IT/XM/S3M/MTM/MOD/UMX/MP3/MP2/MP1/OGG/WAV
Плеер может открывать плэйлисты с расширениями: LST/M3U/M3U8
Плеер может воспроизводить интернет-радио, в том числе и из плэйлистов, но только тех, которые находятся на компьютере.

Stealth Player будет работать на Windows XP или более поздних версиях. Но все возможности программы (например, "сообщения-облачка" или поддержка динамической смены устройства воспроизведения) будут доступны только на Windows 7.
 

***БЫСТРЫЙ СТАРТ***

1. Распакуйте содержимое архива;
2. Запустите StealthReg.bat;
3. Щелкните правой кнопкой мыши на любой папке с музыкой;
4. Выберите "Open with Stealth Player" из контекстного меню.


***УСТАНОВКА***

Инструкции по настройке или компиляции Stealth Player или по использованию его совместно с ПДУ через bluetooth вы можете найти в INSTALL.DIZ


***ПАРАМЕТРЫ КОМАНДНОЙ СТРОКИ***

Формат командной строки:
stealth [commands] [files]

Параметры:
	--numlock=x - если x=0, не включать Numlock автоматически (полезно для ноутбуков без цифровой клавиатуры); по умолчанию: 1;
	--shuffle=x - если x=1, включить режим случайного воспроизведения; по умолчанию: 0;
	--recursive=x - если x=1, загружать файлы также из подпапок (если параметр не указан, то загружаются только файлы непосредственно из папки); по умолчанию: 0;
	--priority=x  - если x='low', установить наименьший приоритет для процесса (может снизить качество звука); если x='high', установить наивысший приоритет (может снизить производительность других программ); по умолчанию: normal;
	--resume=x - при x=1 если плеер был закрыт, но пользователь не останавливал воспроизведение (например, при выходе из Windows), то автоматически возобновить воспроизведение при запуске плеера. Данный ключ работает только в том случае, если не было указано никаких входных файлов; по умолчанию: 0;
	--volume-step=x - увеличивать/уменьшать громкость с шагом x (0<x<=100); по умолчанию: 1;
	--hotkeys=x - включить набор x горячих клавиш, где x:
		extra1 - включить набор "extra keys 1" (см. ниже)
		extra2 - включить набор "extra keys 2"
		multimedia - включить набор "media keys"
		general - включить набор "general keys" (по умолчанию)		
	--hotkeys=x - выключить набор x горячих клавиш, где x:
		extra1 - выключить набор "extra keys 1" (по умолчанию)
		extra2 - выключить набор "extra keys 2" (по умолчанию)
		multimedia - выключить набор "media keys" (по умолчанию)
		general - выключить набор "general keys"
	--playlists-limit=x - если x=0, то это включит режим неограниченных плэйлистов, так что вы сможете оперировать более чем 9 плэйлистами. Зажмите CTRL для загрузки плэйлиста (или CTRL+ALT для сохранения), затем наберите его номер и подождите определенный интервал времени (держа CTRL), пока плэйлист не загрузится. См. ниже; по умолчанию: 1;
	--typing-timeout=x - выставляет интервал времени в миллисекундах, который должен пройти с набора последней цифры, перед тем как плэйлист загрузится (или сохранится). Т. е. при --typing-timeout=1000, нужно подождать 1 секунду перед тем, как отпускать CTRL после набора номера плэйлиста. Имеет действие только при --playlists-limit=0. См. пример ниже; по умолчанию: 1000;
	--auto-play=x - если x=0, то не начинать автоматическое воспроизведение музыки после запуска программы; по умолчанию: 1;
	--balloons=x - если x=1, то использовать сообщения в виде "облачков". Эти сообщения будут появляться каждый раз при смене трека или уровня звука; по умолчанию: 0;
	--captions=x - если x=short, то во всплывающей подсказке из трея показывать только название трека; по умолчанию: normal;
	-- - после этого параметра все остальные параметры игнорируются, удобно для открытия файлов или папок с именами, начинающимися на "--"
	
"files" означает любые поддерживаемые аудио-файлы, интернет радио, плэйлисты или папки. Параметры могут идти в произвольном порядке. Помните, чтобы открыть файлы или папки, начинающиеся с "--", вы должны сначала указать параметр "--", который отключает дальнейший разбор параметров (см. пример ниже).

Примеры:
1) stealth musiс.m3u --shuffle=1 - откроет плэйлист music.m3u и включит режим случайного воспроизведения;
2) stealth --hotkeys=extra1 --hotkeys=extra2 --numlock=0 - не загружает ничего, включит "extra keys 1" и две добавочные клавиши из "extra keys 2" (см. ниже) при этом не изменит состояние NumLock;
3) stealth "http://72.26.204.28:6414/" --hotkeys-off=general - присоединится к радио и выключит горячие клавиши на NumPad, таким образом, вы сможете их использовать в других приложениях;
4) stealth "C:\Mod Music" --recursive=1 "C:\MP3s" - загрузит все файлы из C:\Mod Music\, затем из C:\MP3s и всех подпапок C:\MP3s;
5) Stealth.exe "C:\Mod Music\" --playlists-limit=0 --typing-timeout=2000 - загрузит файлы из C:\Mod Music\, установит режим неограниченных плэйлистов, таким образом, вы сможете управлять более чем 9 плэйлистами. Например, чтобы сохранить загруженные файлы в плэйлист 1337.lst сделайте следующее: зажмите CTRL+ALT, наберите "1337" на цифровой клавиатуре, подождите 2 секунды. Плэйлист сохранен. Теперь можете отпустить CTRL+ALT;
6) .\stealth.exe --auto-play=0 -- --auto-play=0 - запустит Stealth Player из текущей папки, затем попытается загрузить все файлы из папки "--auto-play=0", но не из подпапок, также плеер не начнет воспроизводить музыку после запуска.


***ГОРЯЧИЕ КЛАВИШИ***

Управляющие клавиши доступны везде, поэтому их нельзя использовать в других приложениях до тех пор, пока они не будут отключены (или плеер не будет закрыт). Numlock должен быть включен, чтобы горячие клавиши на цифровой клавиатуре работали. Common keys работают всегда, пока плеер запущен. Также поддерживаются мультимедиа клавиши. "Extra keys" полезны, когда вы управляете компьютером с мобильного телефона посредством bluetooth. Читайте INSTALL.DIZ.

------common keys (всегда включены)------
	Scroll Lock - случайное/последовательное воспроизведение
	Shift+Alt+Pause - включить/выключить горячие клавиши (кроме common keys)
	Щелчок левой кнопкой мыши на иконке в трее - аудио-микшер
	Щелчок правой кнопкой мыши на иконке в трее - выход из программы
	Щелчок средней кнопкой мыши на иконке в трее - открыть папку playlists
	
------general keys (параметр --hotkeys=general)------
	NumPad 5 - стоп/воспроизведение
	NumPad 4 - предыдущий трек
	NumPad 6 - следующий трек
	NumPad 8 - увеличить громкость
	NumPad 2 - уменьшить громкость
	NumPad 7 - перейти к предыдущей папке
	NumPad 9 - перейти к следующей папке
	NumPad 0 - выход из программы
	CTRL+NumPad X - загрузить плэйлист с номером X
	CTRL+ALT+NumPad X - сохранить текущие треки в плэйлист с номером X
	
------extra keys 1 (параметр --hotkeys=extra1)-------
	Ctrl+P - стоп/воспроизведение
	Ctrl+B - предыдущий трек
	Ctrl+F - следующий трек
	F10 - увеличить громкость
	F9 - уменьшить громкость
	Ctrl+Shift+B - перейти к предыдущей папке (если также указан параметр -kb2)
	Ctrl+Shift+F - перейти к следующей папке (если также указан параметр -kb2)

------extra keys 2 (параметр --hotkeys=extra2)-------	
	Ctrl+S - стоп/воспроизведение
	Ctrl+B - предыдущий трек
	Ctrl+F - следующий трек
	Ctrl+P - увеличить громкость
	F10 - уменьшить громкость
	Ctrl+Shift+B - перейти к предыдущей папке
	Ctrl+Shift+F - перейти к следующей папке
	
------media keys (параметр --hotkeys=multimedia)-------
	PLAY_PAUSE - стоп/воспроизведение
	PREV_TRACK - предыдущий трек
	NEXT_TRACK - следующий трек

	
***ПЛЭЙЛИСТЫ***

Плэйлисты должны находиться в подпапке "playlists". Вы можете давать им любые имена, но:
	1. расширение файла должно поддерживаться плеером (см. выше);
	2. первые символы в имени файла должны быть цифрами, обозначающими номер плэйлиста. После номера плэйлиста должен идти нецифровой символ. Например, плэйлист 7-Neskimos.lst будет открыт при нажатии Ctrl+Numpad 7;
	3. если включен режим неограниченных плэйлистов, то вы можете управлять более чем 9 плэйлистами (см. Примеры, чтобы лучше понять);
	4. плэйлисты обрабатываются построчно, поэтому вы можете писать там комментарии (см. playlists/101 - Folder.lst в качестве примера);
	5. вы можете загружать папки из плэйлистов (см. playlists/101 - Folder.lst в качестве примера);
	6. плэйлисты могут быть или в формате ANSI или в формате UTF-8 (с BOM).

***ИЗВЕСТНЫЕ БАГИ***

Баги, которые не подлежат решению в близлежащее время:
	1. Некоторые MOD файлы могут воспроизводиться вечно, если в них присутствует бесконечный цикл (это не баг, а скорее предупреждение). Stealth Player воспроизводит MOD файлы так, как они должны воспроизводиться;
	2. Плеер может не читать некоторые *.IT и *.XM файлы;
	3. Когда включен режим случайного воспроизведения, один и тот же трек может воспроизвестись несколько раз подряд (ну все-таки это случайное воспроизведение! :);
	4. Метаданные, принимаемые с некоторых радиостанций, могут быть неверны. Это не вина StealthPlayer. Некоторые станции вещают метаданные не в ASCII-кодировке, хотя должны именно в ней.	
	

***ПОДДЕРЖКА ПРОЕКТА***

Если вы нашли баг в программе, то запишите его на баг-треккере SourceForge:
https://sourceforge.net/tracker/?group_id=332937&atid=1395937
там нажмите "Add New"
... или, в крайнем случае, напишите мне (адрес ниже).

Если у вас есть другие предложения по проекту, например, по новой функциональности, то пишите мне:
alkatrazstudio@yandex.ru - Парфёнов Алексей