Difference between revisions of "Sapphire"

From AwkwardTV
Jump to: navigation, search
(Sapphire Fetch Tool File Formats)
m (Protected "Sapphire" ([edit=autoconfirmed] (indefinite) [move=autoconfirmed] (indefinite)))
 
(42 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
== Description ==
 
== Description ==
  
[http://appletv.nanopi.net Sapphire Browser] is a plug-in designed to take all the hassle out of managing media collections connected to your AppleTV. [http://appletv.nanopi.net Sapphire] has the ability to identify TV Shows and Movies* simply by looking at the filename. Once identified, [http://appletv.nanopi.net Sapphire] will download show/movie* information and cover art (from [http://www.tvrage.com TVRage] /[http://www.imdb.com IMDB]*/[http://wwwimpawards.com IMPAwards]*) turning your stale file list into something worth looking at. Sapphire Browser also has the ability to filter out watched media files from several different directory trees and intuitively display them. Additionally [http://appletv.nanopi.net Sapphire] allows for marking favorite files that can also be viewed in a filtered menu. Media playback has also been improved allowing the user to fast-forward through shows at a constant (aggregated) rate independent of the file duration.
+
[http://appletv.nanopi.net Sapphire Browser] is a plug-in designed to take all the hassle out of managing media collections connected to your AppleTV. [http://appletv.nanopi.net Sapphire] has the ability to identify TV Shows and Movies* simply by looking at the filename. Once identified, [http://appletv.nanopi.net Sapphire] will download show/movie* information and cover art (from [http://www.tvrage.com TVRage] /[http://www.imdb.com IMDB] /[http://wwwimpawards.com IMPAwards]) turning your stale file list into something worth looking at. Sapphire Browser also has the ability to filter out watched media files from several different directory trees and intuitively display them. Additionally [http://appletv.nanopi.net Sapphire] allows for marking favorite files that can also be viewed in a filtered menu. Media playback has also been improved allowing the user to fast-forward through shows at a constant (aggregated) rate independent of the file duration.
  
*Movie Support will be coming soon.
+
=== 3.0 support ===
 +
Sapphire Browser beta 7.6 now supports AppleTV 3.0
 +
 
 +
== Source Code ==
 +
Sapphire Browser is now an open source project. Details can be found [http://appletv.nanopi.net/develop/ here].
 +
 
 +
== Downloads ==
 +
The latest version of Sapphire is available on its [http://appletv.nanopi.net/sapphire-browser-downloads/ download page].
  
 
== Version Information ==
 
== Version Information ==
 +
=== [http://appletv.nanopi.net/488/sapphire-browser-beta-7-8-release-notes/ Sapphire Beta 7.8] ===
 +
 +
=== [http://appletv.nanopi.net/360/sapphire-browser-beta-7-7-release-notes/ Sapphire Beta 7.7] ===
 +
 +
=== [http://appletv.nanopi.net/339/sapphire-browser-beta-7-6-release-notes/ Sapphire Beta 7.6] ===
 +
 +
=== [http://appletv.nanopi.net/284/sapphire-beta-7-coredata-preview/ Sapphire Core Data Previews] ===
 +
 +
=== [http://appletv.nanopi.net/98/sapphire-browser-beta-65-release-notes/ Sapphire Beta 6.5] ===
 +
 +
=== [http://appletv.nanopi.net/96/sapphire-browser-beta-64-release-notes/ Sapphire Beta 6.4] ===
 +
 +
=== [http://appletv.nanopi.net/95/sapphire-browser-beta-63-release-notes/ Sapphire Beta 6.3] ===
 +
 +
=== [http://appletv.nanopi.net/94/sapphire-browser-beta-62-release-notes/ Sapphire Beta 6.2] ===
 +
 +
=== [http://appletv.nanopi.net/93/sapphire-browser-beta-61-release-notes/ Sapphire Beta 6.1] ===
 +
 +
=== [http://appletv.nanopi.net/92/beta-6-release-notes/ Sapphire Beta 6] ===
 +
 +
=== [http://appletv.nanopi.net/89/sapphire-browser-beta-5-release-notes/ Sapphire Beta 5] ===
 +
 +
=== [http://appletv.nanopi.net/81/sapphire-browser-beta-42-release-notes/ Sapphire Beta 4.2] ===
 +
 +
=== [http://appletv.nanopi.net/76/sapphire-browser-beta-41-release-notes/ Sapphire Beta 4.1] ===
 +
 +
=== [http://appletv.nanopi.net/42/sapphire-browser-beta-4-release-notes/ Sapphire Beta 4] ===
 +
 +
=== [http://appletv.nanopi.net/21/sapphire-beta-4-preview-10b4/ Sapphire Beta 4 Preview] ===
  
 
=== [http://appletv.nanopi.net/8/release-notes-10b31/ Sapphire Beta 3 (1.0b3.1)] ===
 
=== [http://appletv.nanopi.net/8/release-notes-10b31/ Sapphire Beta 3 (1.0b3.1)] ===
Line 23: Line 59:
  
 
----
 
----
 
  
 
== Screenshots ==
 
== Screenshots ==
 
+
[http://appletv.nanopi.net http://appletv.nanopi.net/Images/All_VD_S.jpg]
 +
=== Beta 4 ===
  
 
[http://appletv.nanopi.net http://appletv.nanopi.net/Images/Browser_s.jpg]
 
[http://appletv.nanopi.net http://appletv.nanopi.net/Images/Browser_s.jpg]
Line 85: Line 121:
  
 
=== Folder Cover Art ===
 
=== Folder Cover Art ===
 +
'''[http://appletv.nanopi.net/18/sapphire-file-type-support/ Supported Cover Art File Types]'''
 +
 
Folder cover art for the most part works exactly as it does in [[ATVFiles]].  The only difference is that files inside a respective folder will default to the folder's cover art if it doesn't have its own specific (<filename>.ext) to display.  This mechanism allows episodes to inherit cover art from two directories above itself.  
 
Folder cover art for the most part works exactly as it does in [[ATVFiles]].  The only difference is that files inside a respective folder will default to the folder's cover art if it doesn't have its own specific (<filename>.ext) to display.  This mechanism allows episodes to inherit cover art from two directories above itself.  
  
Line 95: Line 133:
  
 
''Sapphire will display the respective covers if the directories don't have their own cover art. If a cover.ext doesn't exist the browser will default to the Sapphire icon.''
 
''Sapphire will display the respective covers if the directories don't have their own cover art. If a cover.ext doesn't exist the browser will default to the Sapphire icon.''
 
'''ext={jpg,png,tif,tiff}'''
 
  
 
----
 
----
Line 105: Line 141:
  
 
* show.name.S##E##...ext
 
* show.name.S##E##...ext
** (REGEX IS [\. -]?S[0-9]+E[S0-9]+ )
+
** The.Office.S03E11.avi
 
* show.name.#x##...ext     
 
* show.name.#x##...ext     
 
** Heroes.1x22.avi
 
** Heroes.1x22.avi
Line 111: Line 147:
 
** Dead.Like.Me.203.avi
 
** Dead.Like.Me.203.avi
  
=== For further details see: [http://appletv.nanopi.net/19/sapphire-supported-tv-show-file-naming-conventions/ Sapphire File Naming Conventions] ===
+
For further details see: [http://appletv.nanopi.net/19/sapphire-supported-tv-show-file-naming-conventions/ Sapphire File Naming Conventions]
  
 
----
 
----
Line 118: Line 154:
  
  
* '''Populate Show Data''' - This tool is used to preform a search of your /Movies/ directory to gather meta data info.
+
* '''Populate File Data''' - This tool is used to preform a search of your directory to gather meta data info.
* '''Fetch TV Data''' - This tool is used to get episode information and episode cover art from TVRage.com.
+
* '''Fetch TV Show Data''' - This tool is used to get episode information and episode cover art from TVRage.com.
* '''Hide "Favorite Shows"''' - Removes the Favorite Shows browser from the main menu.
+
* '''Fetch Movie Data''' - This tool is used to get mvoie information and posters from IMDB.com.
* '''Hide "Unwatched Shows"''' - Removes the Unwatched Shows browser from the main menu.
+
* '''Hide Collections''' - Lets the user choose which collections to hide on the main menu.
* '''Hide "Hide UI Quit"''' - Removes the UI reset option from the main menu.
+
* '''Don't Import Collections''' - Lets the user choose which collections to skip with the import tools.
 +
* '''Skip "Favorite Shows Filter"''' - Removes the Favorite Shows browser from the predicate toggle.
 +
* '''Skip "Unwatched Shows Filter"''' - Removes the Unwatched Shows browser from the predicate toggle.
 +
* '''Hide Show Spoilers''' - Removes the movie plot / episode summary from the media preview.
 +
* '''Hide Audio Info''' - Removes the audio information from the media preview.
 +
* '''Hide Video Info''' - Removes the video information from the media preview.
 +
* '''Hide "UI Quit"''' - Removes the UI reset option from the main menu.
 +
* '''Enable AC3 Passthrough''' - Turns on AC3 passthrough for files that have AC3 data.
 
* '''Disable Anonymous Reporting''' - Turns off the anonymous filename reporting (used for debugging and developing future Sapphire features)
 
* '''Disable Anonymous Reporting''' - Turns off the anonymous filename reporting (used for debugging and developing future Sapphire features)
  
Line 129: Line 172:
  
 
== Installation ==
 
== Installation ==
 +
Step-by-step instructions on how to install Sapphire.
 +
 +
=== Installing Sapphire in Leopard ===
 +
* Installing [http://appletv.nanopi.net/manual/install-leopard/ Sapphire on a Mac Running Leopard ]
 +
 +
=== Installing Sapphire AppleTV ===
 +
These instructions assume you have already patched your AppleTV using one of the methods described on this wiki (EX: [[Patchstick/Testing]] ).
 +
* Installing [http://appletv.nanopi.net/manual/install-atv/ Sapphire on an AppleTV]
 +
 +
=== After Installation ===
 +
* [http://appletv.nanopi.net/manual/getting-started Getting Started With Sapphire]
 +
* [http://appletv.nanopi.net/manual Sapphire Manual]
 +
 +
----
  
 +
== FAQ ==
  
* 1. Download the Sapphire Plug-in [http://plugins.awkwardtv.org/det.php?recordID=sapphire Here].
+
* Frequently asked Questions can be found [http://appletv.nanopi.net/faq/ here ]
* 2. Unzip and place the Sapphire.frappliance folder inside the directory /System/Library/CoreServices/Finder.app/Contents/PlugIns/ located on your Apple TV's OSBoot partition.
+
 
* 3. Access the Sapphire main menu using your Apple TV.
+
== Crashing when importing ==
* 4. Go to the "Settings" Menu and select "Populate Show Data". This import tool will go through your /frontrow/Movies/ directory collecting file information that is used to when browsing through Sapphire.
+
 
* 5. Be patient.  The import tool can take a considerable amount of time depending on how many mounts you are using.  During testing, a fresh import on ~1 Tera byte worth of TV Shows took about 5 minutes.  The import might be slower if you are using the airport.
+
A common problem seems to be crashing when importing - hanging and eventually killing FrontRow / Finder. If you go to ~user/Library/Application Support/Sapphire and delete meraData.plist, this may solve your problem. You will also keep show data (useful time saver if you have many files), although you will lose watched / unwatched items and some settings.
* 6. Once the import has finished, you might want to tag the files you have already watched, or tag your favorite files.  The best way to do this is to select "Browse Shows" from the main menu. Once you have found a directory or file you wish to "Mark as Favorite" or "Mark as Watched", use the right arrow to toggle to the "Mark" mode.  Select the file/directory and mark appropriately. To toggle back into "Select" mode hit the left arrow.
 
* 7. If you would like to fetch TV Episode information for your media collection, this would be a good time to run it. As Sapphire fetches episode information from http://www.tvrage.com it might ask you to select from a list of TV show titles to match the current file being processed.
 
* 8. Enjoy your fully personalized "Unwatched" and "Favorite Shows" menus packed full of Episode information!
 
  
  
 
----
 
----
 +
 +
 
[[Category:Plugins]]
 
[[Category:Plugins]]

Latest revision as of 08:26, 30 December 2012

Description

Sapphire Browser is a plug-in designed to take all the hassle out of managing media collections connected to your AppleTV. Sapphire has the ability to identify TV Shows and Movies* simply by looking at the filename. Once identified, Sapphire will download show/movie* information and cover art (from TVRage /IMDB /IMPAwards) turning your stale file list into something worth looking at. Sapphire Browser also has the ability to filter out watched media files from several different directory trees and intuitively display them. Additionally Sapphire allows for marking favorite files that can also be viewed in a filtered menu. Media playback has also been improved allowing the user to fast-forward through shows at a constant (aggregated) rate independent of the file duration.

3.0 support

Sapphire Browser beta 7.6 now supports AppleTV 3.0

Source Code

Sapphire Browser is now an open source project. Details can be found here.

Downloads

The latest version of Sapphire is available on its download page.

Version Information

Sapphire Beta 7.8

Sapphire Beta 7.7

Sapphire Beta 7.6

Sapphire Core Data Previews

Sapphire Beta 6.5

Sapphire Beta 6.4

Sapphire Beta 6.3

Sapphire Beta 6.2

Sapphire Beta 6.1

Sapphire Beta 6

Sapphire Beta 5

Sapphire Beta 4.2

Sapphire Beta 4.1

Sapphire Beta 4

Sapphire Beta 4 Preview

Sapphire Beta 3 (1.0b3.1)

Sapphire Beta 2

Sapphire Beta 1

Comments and any bug reports would be greatly appreciated. Submit a Report

Enjoy!



Screenshots

All_VD_S.jpg

Beta 4

Browser_s.jpg

Beta 3

browsershc5.gif

Beta 2

More screenshots of the UI can be found Here.



Gem Colors

Sapphire uses some gem icons to identify files. Here is a short description on what each color signifies:


File Gems

  • Blue Gems - Mark Unwatched files.
  • Yellow Gems - Mark Favorite files that have already been watched.
  • Red Gems - Mark files that have already been watched and are not favorites.

Directory Gems

  • Blue Gems - Mark directories containing any unwatched files.
  • Yellow Gems - Mark directories with favorite files and no unwatched files.
  • Red Gems - Mark directories that contain files that have been watched and are not favorites.

Cover Art

ATVFiles

Sapphire now supports ATVFiles's cover art naming convention.

  • Directories will use an image with the name cover.ext
  • Files will use an image with the name <FileName>.ext

Fetch Tool

Sapphire will also attempt to download cover art (for files only) automatically from TVRage.com. Any cover art that the fetch tool finds will be placed in a directory @ the same level of the file.

Example:

If we have the following files:

  • /TV Shows/Rome/Season 1/Rome.S01E01.avi
  • /TV Shows/Rome/Season 1/Rome.S01E02.avi
  • /TV Shows/Rome/Season 1/Rome.S01E03.avi
  • /TV Shows/Rome/Season 1/Rome.S01E04.avi
  • /TV Shows/Rome/Season 1/Rome.S01E05.avi


The Fetch tool will find and make a cover art directory with the following:

  • /TV Shows/Rome/Season 1/Cover Art/Rome.S01E01.ext
  • /TV Shows/Rome/Season 1/Cover Art/Rome.S01E02.ext
  • /TV Shows/Rome/Season 1/Cover Art/Rome.S01E03.ext
  • /TV Shows/Rome/Season 1/Cover Art/Rome.S01E04.ext
  • /TV Shows/Rome/Season 1/Cover Art/Rome.S01E05.ext

Folder Cover Art

Supported Cover Art File Types

Folder cover art for the most part works exactly as it does in ATVFiles. The only difference is that files inside a respective folder will default to the folder's cover art if it doesn't have its own specific (<filename>.ext) to display. This mechanism allows episodes to inherit cover art from two directories above itself.

Example:

If we have the following directories:

  • /TV Shows/Heroes/Season 1/cover.ext
  • /TV Shows/Heroes/Season 1/
  • /TV Shows/Lost/cover.ext
  • /TV Shows/Lost/Season 2/

Sapphire will display the respective covers if the directories don't have their own cover art. If a cover.ext doesn't exist the browser will default to the Sapphire icon.


Sapphire Fetch Tool File Formats

To get better results fetching show information from TVRage.com we have chosen to specifically support three typical naming schemes.

  • show.name.S##E##...ext
    • The.Office.S03E11.avi
  • show.name.#x##...ext
    • Heroes.1x22.avi
  • show.name.###...ext
    • Dead.Like.Me.203.avi

For further details see: Sapphire File Naming Conventions


Settings Menu

  • Populate File Data - This tool is used to preform a search of your directory to gather meta data info.
  • Fetch TV Show Data - This tool is used to get episode information and episode cover art from TVRage.com.
  • Fetch Movie Data - This tool is used to get mvoie information and posters from IMDB.com.
  • Hide Collections - Lets the user choose which collections to hide on the main menu.
  • Don't Import Collections - Lets the user choose which collections to skip with the import tools.
  • Skip "Favorite Shows Filter" - Removes the Favorite Shows browser from the predicate toggle.
  • Skip "Unwatched Shows Filter" - Removes the Unwatched Shows browser from the predicate toggle.
  • Hide Show Spoilers - Removes the movie plot / episode summary from the media preview.
  • Hide Audio Info - Removes the audio information from the media preview.
  • Hide Video Info - Removes the video information from the media preview.
  • Hide "UI Quit" - Removes the UI reset option from the main menu.
  • Enable AC3 Passthrough - Turns on AC3 passthrough for files that have AC3 data.
  • Disable Anonymous Reporting - Turns off the anonymous filename reporting (used for debugging and developing future Sapphire features)



Installation

Step-by-step instructions on how to install Sapphire.

Installing Sapphire in Leopard

Installing Sapphire AppleTV

These instructions assume you have already patched your AppleTV using one of the methods described on this wiki (EX: Patchstick/Testing ).

After Installation


FAQ

  • Frequently asked Questions can be found here

Crashing when importing

A common problem seems to be crashing when importing - hanging and eventually killing FrontRow / Finder. If you go to ~user/Library/Application Support/Sapphire and delete meraData.plist, this may solve your problem. You will also keep show data (useful time saver if you have many files), although you will lose watched / unwatched items and some settings.