JSymphonic - README

Please note that this README file contains images which can only be displayed if you have an Internet connection. The links given also refer to Internet pages. You can download an off-line manual here.

1) What's new!? (UP)

• Improve error reporting
  
• Improve transfer interruption
  
• Improve local folder guessing at first startup
  
• Add German and Russian translations
  
• Add a "Browse disk" button in the first time configuration windows
  
• Fix a display bug (concerning MPC files)
  
• Remove file extension from title when default pattern fails
  
• Other minor bug fixes
  
• Update the version of FFMPEG for Windows users
  

You can consult the complete change log here.

2) Warning! (UP)

You are using this software at your own risk, and the Symphonic Team is not responsible for any damage that may or may not come from the use of JSymphonic.

3) Installing JSymphonic (UP)

3.1) Overview

JSymphonic doesn't need any installation process, it is a stand alone application in a single file which can be copied anywhere and run under the condition that JAVA is installed.
If you are familiar with Java and ".jar" applications, you may skip to the Step 3 - Installing JSymphonic section.

3.2) Step-by-step installation

Step 1 - Dowloading JSymphonic

If it's not already done, the first thing to do is to dowload JSymphonic from the dowload section.
If you are not sure about what version to pick, choose one stable. Stable versions are the ones named (know more about JSymphonic versions code name). Unstable versions contain "a" or "b" letters, which means "alpha" (unstable) and "beta" (testing).

Step 2 - Installing Java

Second step consists in installing Java. But you only need to install it if it's not already installed, which is the case in many computers. To know if java is installed, do the following:

• Windows users (first method):
  a) Open the "Control Panel" from the Windows Start menu.
  
  b) Enter the "Add or Remove Programs" menu (Windows XP) or "Programs and Features" menu (Windows Vista).
  
  c) Search for a "Java(TM)" entry in the list. If it is present, Java is installed, you can skip to step 3, else you should install it. (Note that JSymphonic requires at least version 1.5 (also called 5) to work. The last version (1.6, also called 6) is advised.)
  
  
  To install Java, download it from the official website and install it on your computer.
  The installation of Java is quite basic and it won't be explained here. If you have any trouble, ask for help in the forum.
  
  
• Windows users (second method): Open a terminal (Start Menu>All Programs>Accessories>Command Prompt) and type
  
  java -version
  
  If the command doesn't return an error, Java is installed, and it returns the version, which must be at least 1.5 to run JSymphonic.
  
  
• Linux users:
  Open a terminal and type
  
  java -version
  
  If the command doesn't return an error, Java is installed, and it returns the version, which must be at least 1.5 to run JSymphonic.
  
  
• MacOS users: Java is always installed with MacOS. However, you may not have the lastest version. See this article in the FAQ to update your Java installation. Note: this is not compulsory.
  

Step 3 - Installing JSymphonic

You have downloaded a ".zip" file which you should unzip. It contains two files: the application "JSymphonic_vXXX.jar" (a JAVA ".jar" program) and a README file.
There is no installation process, you can copy the ".jar" where you want to store it. It is meant to be stored on the player itself to have the program available whatever the computer you plug your player to.
As it is shown on the picture below, you can create a "JSymphonic" folder on the root of your player to store the application.
On this picture, you can notice that a second file named "JSymphonic.xml" is present. This file is generated when you use JSymphonic. It holds your configuration. If you try to delete it, a new one will be created at next start up.
If you upgrade from version 0.2.x or 0.3.0a or 0.3.0a2, it is advised to delete your old configuration file to create a clean new one.

Step 4 - Installing FFMPEG

Walkmans can only play natively ATRAC and MP3 formats (and WMA format for generations 4 to 7 and AAC format for generations 6 and 7).
To transfer other formats, JSymphonic uses FFMPEG to transcode the other formats to MP3.
If you only want to transfer MP3 files, you can skip this step.
The installation of FFMPEG depends on your operating system.

• Windows users: you need to download FFMPEG from the download section. You should download the "r21657" version (the other one is for people using version of JSymphonic previous to v0.3.0 stable). Once again, your are downloading a ".zip" file which only needs to be unzipped and placed along with the JSymphonic program. You have to create a folder named "ffmpeg-win32" in the folder containing "JSymphonic_vXXX.jar" and place the files "ffmpeg.exe" in the "ffmpeg-win32" folder. This is pictured on the images below:
  
  
  
• Linux users: You need to have installed FFMPEG with MP3 support. You may compile FFMPEG from the sources (google to find the sources) but your distribution may offer you a
  package. Please refer to your distribution's documentation.
  
  For Ubuntu users (<= 8.04), Hardy release and older can have a package for FFMPEG in the Medibuntu repository.
  
  For Ubuntu users (>= 8.10), Intrepid release and newer offer a package of FFMPEG but it is compiled WITHOUT MP3 support. You have to install this version first
  and, to enable MP3 support, you need to enable Multiverse repositories and install the following packages:
  
  libavcodec-unstripped-51
libavdevice-unstripped-52
libavformat-unstripped-52
libavutil-unstripped-49
libpostproc-unstripped-51
libswscale-unstripped-0

  
  
• MacOS users: You need to install "ffmpegX". See: http://www.ffmpegx.com/.
  

Step 5 - Generating the key files

This step is needed for players from 3rd generation only. Others must skip this step.
3rd generation encrypts MP3 files and uses DRM in ATRAC files. JSymphonic cannot transfer files to your player without knowing its "encryption key". The key is stored into a file named "DvID.DAT". To generate this key file, please read the corresponding article in the FAQ.
NOTE: 3rd generation player owners: you must have this key file to use JSymphonic!!

Moreover, ATRAC files transfered to the player must hold DRM. Once again, JSymphonic is not able to guess the DRM system of your player. If you want to be able to transfer ATRAC files, you should generate also the DRM key files. To generate these files, please read the corresponding article in the FAQ.
NOTE: these files are only needed to transfer ATRAC files, JSymphonic can be run without these files.
NOTE: this feature is still under test, and it may not work. Please share your experience with the developers on the forum.

4) Using JSymphonic (UP)

4.1) Running JSymphonic

Before running JSymphonic, you should make sure that there is at least a folder named "OMGAUDIO" or "omgaudio" at the root of your player. JSymphonic will not be able to start if this folder is missing.
An empty OMGAUDIO folder doesn't prevent JSymphonic to work.

To run JSymphonic, on most operating system, you just have to double-click on the application. If your unzipper program is run instead of JSymphonic, it means that the ".jar" extension is not associated with Java on your computer.
If you can change file associations, just associate the ".jar" extension with Java, and then you will be able to open JSymphonic by double-clicking on it.

If you can't change the file association, you can run JSymphonic by typing the following command on a terminal:

by replacing "Path/Of/The/App" by the path where to find JSymphonic and "XXX" by the actual JSymphonic version you are using.

Mac users, please note that an application is dedicated to run Java program on MacOS. It is called "Jar Launcher". Some users noticed that this application is not so stable and may not be able to run program from a remote device. In this case, you should either use the command line or run the program from your local disk. To open a terminal, go to "Applications > Utilities > Terminal".

4.2) First run

On the first run (or if the configuration file "JSymphonic.xml" has been deleted), JSymphonic tries to auto detect your language, operating system, music and player paths. However, it cannot guess your player generation, so it will prompt you a window to ask for the generation (and check the device path). Here is the window:
If the device is plugged with an "OMGAUDIO" folder in it, the device path should be guessed, you can correct it if it is wrong.
You should set the generation according to the list you can consult here.

Note that in the screenshot above, the device path is denoted by "..". This means that the device is the parent folder of the folder where JSymphonic is placed (it is the case, see the configuration I used to take the screenshot). This has been guessed automaticly.

Once you have click on the "Apply" button, JSymphonic's main window is displayed, as follow:
The right panel lists the content of the player, it is empty here. The left panel lists the music on your computer, called the "Local folder". As it is showed on the picture above, at startup, JSymphonic scans the local folder to find audio files. At first startup, the local folder corresponds to what JSymphonic has guessed. To guess the local folder, JSymphonic tests the following folders:

• YourHomeFolder/My Documents/My Music
  
• YourHomeFolder/My Documents/Music
  
• YourHomeFolder/Documents/My Music
  
• YourHomeFolder/Documents/Music
  
• YourHomeFolder/My Music
  
• YourHomeFolder/Music
  
• YourHomeFolder/My Documents
  
• YourHomeFolder/Documents
  
• YourHomeFolder

The first one of these folders which exist is taken as the local folder. If this guess doesn't suit you, you can modify it in the Properties window. Moreover if your home folder has a lot of files, the scanning process may take a while... so you can cancel it by clicking on the "Cancel" button to avoid an useless task.

4.3) Configuring JSymphonic

To configure JSymphonic, you should open the Properties window. To do so, you can click on the Properties icon on the toolbar: or Click on "JSymphonic" menu > "Properties".

Let's have a look on each tab in the Properties window.

• Device an Path profiles:
  
  First tab is used to configure the profile. A profile is a collection of paths:
  - the device path
  - the local path: the folder containing your music on your computer
  - the export path: it is a folder on your computer where JSymphonic copies the music files you want to export from the player to the computer.
  - a temporary path: when files are transcoded (e.g. from OGG to MP3), JSymphonic creates temporary files on the computer which are then transfered to the walkman. These files are stored in the temporary folder, and then deleted. It is advised to not use the device as a temporary folder since temporary files may used space needed for transfered files.
  And a profile also stores the device generation.
  
  You can have as much profiles as you need. You may need several profiles if you have several devices or/and if you are used to run JSymphonic on several computers. Since the device and/or the local paths could be different from a computer to another, you can easily switch from a configuration to another by changing the profile.
  The last selected profile in the Properties windows will be used as default at next start up. But if the local path of the default profile is not found when JSymphonic is launched, it tries to find a local folder existing from the other profiles and loads the corresponding profile.
  To understand this behavior, here is a sketch:
  
  Assume that you are using JSymphonic at home and at work. The default profile corresponds to your home computer, the configuration is such that:
  

  Device Path: ..
Local Path: D:/My music

  
  Note: The ".." address corresponding to the device path means "my parent folder". In this example, "JSymphonic_vXXX.jar" file is placed in a folder named "JSymphonic" placed at the root of the player. Therefore the player folder is always the parent folder of the folder where "JSymphonic_vXXX.jar" file is.
  
  You created another profile, named "Work", which the configuration is this:
  

  Device Path: ..
Local Path: C:/Public/Music

  
  Note: In this case, the device path is always correct, whatever the computer the player is plugged to.
  
  When you run JSymphonic at home, the default profile is loaded. All is fine since default profile is the home one. But when you run JSymphonic at work, it tries to read the content of the local folder of the default profile (the home profile). If (and only if) there is no folder named "My music" in D: hard drive, JSymphonic tries to read the content of the local folder of the second profile. Since you are at work, the corresponding local folder exists and JSymphonic loads automaticly the work profile.
  
  
  
• Interface:
  
  In this tab, you can set the language, the theme of the graphical interface and configure the log feature.
  
  Note that Java comes along a default theme named "Metal". But it can also take the look'n'feel of the operating system (Java 1.6 only). A "Windows" theme is available when JSymphonic is run under Windows, and a "GTK" theme is available when JSymphonic is run under Linux. Mac users always have the look'n'feel of their OS.
  
  To know more about the log feature, please read the corresponding article on the FAQ.
  
  
• Transfer:
  
  Last tab is used to configure the transfer policy.
  In the "MP3 Options" frame, you can specify if you want JSymphonic to transcode all your music files before sending them to the device, or only the ones which are not compatible with your device. You also pick the bitrate to use when a file is transcoded.
  
  In the "Tag utilization" frame, you can specify if you want JSymphonic to used the tag (meta-data) available in the audio files or if you prefer JSymphonic to guess the song title, artist, album and genre from the files/folders structure.
  When tags are missing or not used, JSymphonic uses a given pattern to guess if the artist, album,... names should be taken from the file, the parent or the grand-parent folder (or whatever you want). You can compose your own pattern respecting the rules giving in that window. On the screenshot above, the whole file name is used as the title name, the parent folder is used as the album name and the grand-parent folder is used as the artist name.
  If the pattern is , the string after ". " in the file name is used as title, the string betwen "] - " and ". " in the file name is used as the track number, the string between " [" and "] - " in the file name is used as the year, the string before " [" in the file name is used as the album, the string between " [" and "]" in the parent folder name is used as the genre and the string before " [" in the parent folder name is used as the artist.
  
  NOTE: if JSymphonic is translated into your language, the word "Artist", "Album",... should be written in your language.
  

4.4) JSymphonic's features tour

Overview

The image below depicted the main window of JSymphonic.

• frame (A) is the toolbar. From this toolbar you can import, export or delete music on your device, apply or revert the changes made, open the properties window and change the profile.
  
• frame (B) is the local panel, it is composed by two tabs: "the local folder" (which lists the music files on your computer) and the "export folder" (which is used to copy the files you want to import from the player to the computer). Note that if the local and the export folders are taken the same, only the local folder tab is available.
  A filter function helps you to find some precise files (but not folders).
  You can choose with the drop down box at the bottom of the panel which formats of music you want to be appearing in the panel. By default it displays all formats supported by JSymphonic. (If formats are missing, you should install FFMPEG.)
  
• frame (B) is the device panel, it lists the content of your device.
  As in the local panel, a filter function helps you to fing songs.
  The view of the content can be ordered in various ways by changing the selected item in the drop down box at the top of the panel.
  A progression bar at the bottom of the panel informs you about the space left on the device.
  

Transfering music to the device is decomposed into two phases. First, you schedule all the changes you want and then you apply the changes. Scheduling import, export or deletion is instantaneous, and the content of the player is not altered. You have to apply the changes to modify the content in your device.

Importing, exporting or deleting music

Importing music means transfer music from the computer to the player. To import music, select one or several file(s) or/and folder(s) from the "Local folder" (B) and press the import button: . Files scheduled for importation will appear in green on the device panel. This only schedule the importation without modifying the content of your player. To apply the changes, click then on the Apply button: .



Exporting music means transfer music from the player to the computer. To export music, select one or several title(s) or/and album(s) from the "Device panel" (C) and press the export button: . Files scheduled for exportation will appear in blue on the device panel. Once again, the changes are only scheduled, you have to press the Apply button to apply the changes.


To remove music from your player, select one or several title(s) or/and album(s) from the "Device panel" (C) and press the delete button: . Files scheduled for deletion will appear in red on the device panel. Once again, the changes are only scheduled, you have to press the Apply button to apply the changes.


You don't have to apply changes after each actions. It is advised to make all the changes you want and to only apply when you're done.

If you made a mistake while sheduling import/export/deletion, you can cancel all changes and reload the device content by clicking on the undo icon: .

A quick view of the transfer panel

Once you have pressed the Apply button, the device panel is replaced by a transfer panel which informs you about the transfer progress. Here is the transfer panel:
The transfer panel is composed of three elements:

• (Ca): the overall progress,
  
• (Cb): the current actions (in the screenshot, JSymphonic was in the "import" phase and it was copying the file "And so what,..." by "My Favoite Band" and it also was encoding the file "Oh..." by "The Oh Oh and Yeah Yeah" since this last file wasn't in MP3 format, so it had to be transcoded.)
  
• (Cc): a "stop transfer" button which stop the transfer after the current operation. Note that if you interrupt a transfer, the database won't match the content of the player and you might get problems. It is advised to re-generate the database after interrupting a transfer.
  

Re-generate the database

To re-generate the database on the device, you just have to run JSymphonic and click the "Apply changes" button. Even if no change has been made, the database will be re-generated according to the content of the player.

Mounting/Unmouting the device

The device panel proposes a "mount/unmount" device button: / . This button only mounts/unmounts the device from JSymphonic !!! It's a way to be sure that JSymphonic doesn't use the device anymore. It DOES NOT REPLACE the "Unmount safety" option given by your operating system!!
In a daily utilization of JSymphonic, these buttons shouldn't be used!!

5) Troubleshooting (UP)

If you have a problem, please read this documentation and the FAQ before asking for help on our forum.

If you want to report a bug or propose an improvement, please use our forum. (It is advised to provided a log of the execution when reporting a bug.)

6) Credits and Licence Information (UP)

6.1) JSymphonic team

Patrick Balleux (founder)
Nicolas Cardoso De Castro
Daniel Žalar

6.2) Symphonic plugin, openSonyDb

Garthps
Mephx

6.3) Translators

Zhang Feng (Chinese)
Hpeat (Czech and Slovak)
Nicolas Cardoso De Castro (French)
Henning (German)
Mephx (Portuguese)
Lunatik, Mayday85 (Russian)
Daniel Žalar (Slovenian)
Hernan Badenes (Spanish)
Lenborje (Swedish)
Jackal53 (Turkish)

6.4) Misc

MetricJester (Documentation)
Ulluss (Website)
Pahra (Logo)
Henning (Translation tool)

6.5) Thanks

Thanks to the testers of the early alpha versions (Pipo, Simon Lejeune, Hernan Badenes, X, Maximillian, Marcus, Paulo Carvalho, Ace Denghar, Guillaume Lecomte)
Thanks to aingoppa, Pedro and dm_ig for the bug fixes.

6.6) License

JSymphonic is published under the GNU public license (click here to know more).




If you would like more information about Symphonic, or would like to join our team please contact us.

Last update: 13/02/2010