Open Media Library User Manual
Open Media Library User Manual
Open Media Library Installation & Quick Start Guide........................................ 1 Document Version .................................................................................. 4 About Open Media Library ........................................................................ 4 Installing Open Media Library .................................................................... 5 i. Prerequisites: .......................................................................................5 ii. Optional Software:.................................................................................5 iii. Installing Open Media Library: ...................................................................6 i. Server Installation (Required): ................................................................6 ii. Client Installation (Optional): ............................................................... 13 V. Using the Open Media Library Database Editor .............................................. 17 i. Opening the Open Media Library Database Editor .......................................... 17 ii. Navigation ......................................................................................... 18 i. Menu Bar........................................................................................ 18 ii. Media/Titles Pane ............................................................................. 19 iii. Quick Links (bottom left corner)............................................................ 20 iv. Disks/Genres/Tags ............................................................................ 21 iii. Importing Movies into Open Media Library ................................................... 21 i. DVD Profiler Import Option .................................................................. 21 ii. DVR-MS Movie Files Import Option.......................................................... 23 iii. Movie Collectorz Import Option ............................................................. 24 iv. MyMovies Import Option...................................................................... 26 v. OML.XML Import Option ...................................................................... 28 vi. Scan Folders for DVDs and Videos Import Option......................................... 29 iv. Importing/Updating Metadata ................................................................. 31 i. Select Source for all Metadata .............................................................. 31 ii. Update Metadata using Preferred Sources ................................................ 32 iii. Downloading Fanart ........................................................................... 33 v. Customize your Database ....................................................................... 33 vi. Maintaining your database...................................................................... 34 i. Database Tools................................................................................. 34 i. Backup database............................................................................ 34 ii. Restore a database ......................................................................... 35 iii. Optimize database ......................................................................... 36 ii. Delete Movies from your database ......................................................... 36 VI. Using Open Media Library ........................................................................ 37 i. The First Run Wizard ............................................................................ 37 ii. Launching Open Media Library ................................................................. 38 iii. Playing a Movie in Open Media Library ....................................................... 39 iv. Sorting your Movie Collection .................................................................. 40 v. Sorting Movies using the Tags Feature ........................................................ 41 vi. Sorting Movies using the Alpha Jump Bar .................................................... 42 VII. Customizing Open Media Library ............................................................... 43 i. Open Media Library Settings.................................................................... 43 i. General Settings ............................................................................... 43 i. Gallery........................................................................................ 44 ii. Theme ........................................................................................ 44 iii. Background .................................................................................. 45 iv. Open Media Library Setup ................................................................. 45 v. Additional Settings ......................................................................... 45 vi. Start Menu ................................................................................... 46 i. New Shortcut ............................................................................. 47 vii. Automatic Updates ......................................................................... 47 viii. About Open Media Library................................................................. 48 ii. Favorites ........................................................................................ 48
Filters ........................................................................................... 48 Media Changers ................................................................................ 49 Optimization ................................................................................... 49 Image Mounting ................................................................................ 50 Language........................................................................................ 50 Trailers.......................................................................................... 51 Extender ........................................................................................ 51 i. Impersonation ............................................................................... 52 ii. Transcoding.................................................................................. 52 VIII. Appendix A: Installing Optional Software .................................................... 53 i. How to install Daemon Tools for use with Open Media Library ........................... 53 IX. Appendix B: Writing your own SQL Scripts ................................................... 54 i. Pre-requisites: .................................................................................... 55 ii. Installing Microsoft SQL Server Database Management tools: ............................. 55 iii. Writing your own SQL Scripts................................................................... 57 iv. Entity Relationship Diagram (ERD) ............................................................ 59 X. Revision History .................................................................................... 60
Document Version
This guide was written for the SQL beta release. The screenshots in this guide may be slightly different than what you see if you are using a version other than this version.
Optional Software:
Tools for mounting ISOs Note: One of these will be needed if you will be doing ISO mounting of your DVD files. Daemon Tools Version 4.12 has been verified to work. Available here Should be installed into the default location. See Appendix A for recommended Installation Virtual Clone Drive Available here Should be installed into the default location. Tools for gathering movie meta data. Note: OML supports importing movie meta data from several different providers. Additionally, there is an internal tool for gathering meta data so these tools are not required if you do not currently have them installed. DVD Profiler Available here OML supports DVD Profiler version 3.1.1 and 3.5 Beta 1 Should be installed into the default location MyMovies Available here Movie Collectorz Available here
About: The server installation is used to set up your database and is a required component. The server installation will install both the server and client components. 1. To install Open Media Library, download the latest release of the Open Media Library program from the Open Media Library web page. The official releases are noted with Featured next to the install link. Click on the link to download the appropriate server installation file (32 bit (x86) or 64 bit (x64)).
2. Once the file is downloaded, find where you saved the installer to and double-click it. After the installer opens, you will see the following screen. Click Next to continue
3. Read through the License Agreement, and then choose to accept the terms and click Install.
4. The next screen allows you to choose what items will be installed. For the server installation, keep the defaults and click Next.
8. The installation process now needs to install SQL Server and setup the Open Media Library database. To do this click Next on the Database Setup screen to continue.
9. The SQL Server installer will extract the files for the installation.
10. Once the extraction has completed, the SQL server installer will begin. If you get an error and do not see the following screen, ensure that Microsoft Windows Installer 4.5 is installed
13. Once the SQL Server installation is finished click Finish. Setup is now complete
14. Browse to Start -> All Programs -> Open Media Library -> OML Database Editor to launch the Open Media Library DB Editor.
16. You may now begin creating your database **NOTE** If you have an existing database from another version of OML in your programdata\openmedialibrary folder called OML.DAT, the application will ask if you would like to convert the database.
About: The client installation is an optional component. This installation can be used if you have many clients that want to connect to a single database. 1. To install Open Media Library, download the latest release of the Open Media Library program from the Open Media Library web page. The official releases are noted with Featured next to the install link. Click on the link to download the appropriate server installation file (32 bit (x86) or 64 bit (x64)).
2. Once the file is downloaded, find where you saved the installer to and double-click it. After the installer opens, you will see the following screen. Choose to accept the license agreement and click Next to continue.
5. The OML Database setup wizard will then open. click Next to continue.
6. The Database setup will search for server hosts on your network. When the search is finished choose the server that your database is housed on and click Next to continue.
7. The Database server setup is complete, click Finish to exit the installer.
8. Browse to Start -> All Programs -> Open Media Library -> OML Database Editor to launch the Open Media Library DB Editor.
10. If you get the following error message click Yes to continue.
11. Ensure that you selected the correct server that your database is housed on. Make any changes that are necessary and click OK to continue. You will need to restart the application for the changes to take effect.
12. Once the Database Editor opens you can begin creating your database.
3. Select the OML Database Editor 4. The OML Database Editor opens. This section will go through the features and explain how to use the database editor
Navigation
This Section will help you navigate through the DB Editor.
Menu Bar
File New Movie - Create a new movie in the DB Editor From Scratch - Create a new movie with no metadata From Preferred Sources - Create a new movie using your preferred Sources to retrieve the metadata From Amazon - Create a new movie using Amazon to retrieve the metadata From DVDProfiler - Create a new movie using DVDProfiler to retrieve the metadata From Netflix - Create a new movie using Netflix to retrieve the metadata From themoviedb.org - Create a new movie using themoviedb.org to retrieve the metadata Save Movie - Save the current movie details Exit Edit Delete Current Movie - Delete the current movie from the database Delete Selected Movies - Delete movies that are currently selected Delete All Movies - Delete all movies from the database Regenerate Thumbnails Current Movie - Regenerate thumbnail for the current movie All Movies - Regenerate thumbnails for all movies
View Tools Customize - Allows the user to customize the database editor Options - Allows the user to change the options for the database editor Database Tools - Has tools to backup/restore your database as well as optimize your database Metadata Settings - allows the user to choose which source metadata is automatically downloaded from Amazon DVDProfiler Netflix themoviedb.org Preferred Metadata Mappings - This allows you to specify where metadata is retrieved for the Fanart and Genres in your DB Move Disks - Allows you to change where your movies are stored without reimporting Transcoder Diagnostics - This is being used to debug any transcoding issues. Help Contents Index Search All movies Filter By Genre - Allows user to filter movies by genres available in the database Filter By Completeness - Allows user to filter movies by metadata completeness Filter By Parental Rating - Allows user to filter movies by Parental Ratings available in the database Filter By Tag - Allows user to filter movies by tags stored in the database
Media/Titles Pane
The Media Pane on the left is broken down into 3 different areas. This section will explain those areas in more detail: Media Pane This pane allows users to customize the way their database is stored. For instance, you can create a heading under All Media called Movies and store only your movies
under this heading, or you can create one called TV Shows and store your TV shows under this heading. These headings will come in handy when you are setting up your Open Media Library strip in Windows Media Center. Titles This pane is where you titles will be displayed for the heading you have selected in the media pane. The following items are available to help you with your collection. Search for title - Use the search bar at the top to search for a specific title in your database Sort your titles Ascending Descending Color Coding - There is a colored ball below every movie title that will tell you how much metadata is downloaded for each movie. The colors are listed below Red - 0-20% of metadata is downloaded for the title Orange - 20-40% of metadata is downloaded for the title Yellow - 40-60% of metadata is downloaded for the title Blue - 60-80% of metadata is downloaded for the title Green - 80-100% of metadata is downloaded for the title Stars - There are 5 stars listed below the movie title that helps tell you at a glance what the rating for the movie is. You can click on the stars in the movie details screen to rate the movie how you want.
This pane has some quick links to get you to some of the most used areas in the DB editor. The options available are: Media - Jump to your media from other areas in the DB editor People - Jump to a list of all people stored in the database (Actors, Directors, Writers, etc.) Tags - Jump to a list of all tags that are stored in the database Import - Jump to the import utility to import your movies
Disks/Genres/Tags
Disks This button can be used if you have a title with more than one disk. When you import your database your multiple disks will all show up as a separate title, but you can use the disks button to move all of the disks to one title Genres This button can be used to view what genres the selected title fits under - you can also add/remove genres for the title here Tags This button can be used to view what tags are associated to this title - you can also add/remove tags for the title here
Importing Movies into Open Media Library DVD Profiler Import Option
If you use DVD profiler to maintain your database connection, this import option will pull from your DVD profiler database. You will first need to create an export of your database in an XML file to use it. To create an export file, open DVD Profiler and go to file -> Export Profile Database and save your XML file. This import option by default will expect a file called "Collection.xml" but you can point it at any file. 1. Click Import
4. Browse to the location on your computer that the XML file is stored at and click OK 5. When the import is finished a results window will display
6. Your movies will now display under the titles heading. You can view the details of any of your movies by clicking on the title.
4. Browse to the location on your computer that your DVR-MS files are stored at and click OK 5. When the import is finished a results window will display
6. Your movies will now display under the titles heading. You can view the details of any of your movies by clicking on the title.
it. This import option by default will expect a file called "movies.xml" but you can point it at any file. 1. Click Import
4. Browse to the location on your computer that your files are stored at and click OK 5. When the import is finished a results window will display
6. Your movies will now display under the titles heading. You can view the details of any of your movies by clicking on the title.
4. Browse to the location on your computer that your files are stored at and click OK 5. When the import is finished a results window will display
6. Your movies will now display under the titles heading. You can view the details of any of your movies by clicking on the title.
4. Browse to the location on your computer that your files are stored at and click OK 5. When the import is finished a results window will display
6. Your movies will now display under the titles heading. You can view the details of any of your movies by clicking on the title.
2. Select Scan Folders for DVDs and Videos from the menu that appears
4. Browse to the location on your computer that your files are stored at and click OK 5. When the import is finished a results window will display
6. Your movies will now display under the titles heading. You can view the details of any of your movies by clicking on the title.
Importing/Updating Metadata
Metadata is available from 4 different sources. Those sources are listed below: Amazon DVDProfiler Netflix themoviedb.org There are a couple of different ways to import the metadata for your movies database. These options are: Select the source that you want all of the metadata to come from Set the specific source that you want certain metadata to come from (preferred sources)
4. Once you choose your source, the application will search for matching records. The matching records will be presented to you.
5. Select the result that best matches your title and click on Select Movie 6. If you did not get a good result you can refine your search at the top of the window.
3. Click OK to save this change 4. Click on Tools - Preferred MetaData Mappings 5. If you would like any fields to update from another source other than your default choose them in this screen. Any fields left blank will update from your default metadata source.
6. Once your preferred metadata mappings are setup, select the title(s) that you would like to update 7. Right Click on one of the selected titles and navigate to update metadata. 8. Choose From Preferred Sources
Downloading Fanart
Fanart is a feature in Open Media Library where when your browse the details of a title, if a backdrop image (fanart) exists for that title it will show it behind the movie details. If there are multiple images for the fanart the image will change on a cycle that is customizable. The DB Editor will automatically download backdrop (fanart) images from themoviedb.org if they exist, however you can also add your own images if you would like as well. To do this follow the steps below: 1. Highlight a movie from your titles list 2. Click on the backdrop tab 3. Right click in a blank spot and choose Add New Backdrop 4. The browse for file window opens 5. Select the image that you want to use and click on OK
3. 4. 5. 6. 7.
Create Folder (TV Season/Series) Create Movie Create TV Episode/Show Select the new heading and modify the name by changing it in the Movie Name/Sort Name fields Once you have it named the way you want it click on the All Media link in the media pane Select the movies that you want to move to that heading from the titles pane (you can use the CTRL key to select multiple movies) Left-click and hold on one of the movies you have selected and drag them to the heading that you have selected Click on the new heading and verify that all of your movies are listed under that heading
Backup database
The past method of backing up the database consisted of creating an OML.XML file in each folder that your movies were stored in. Now you can back up the database to a flat file for easier backups. 1. Click on Tools - Database Tools
2. Click on the Backup to a file button 3. Choose the name of the file that you would like to save it as and where you would like to save the file to. 1. By default the file is stored as OMLDatabase.bak in the C:\ProgramData\OpenMediaLibrary\Backups 4. When the backup is complete you will see the below dialog box
Restore a database
This can be used if you have previously backed up your database with the backup utility and need to restore your database. To restore your database follow the below steps. 1. Click on Tools - Database Tools
2. Click on the Restore from a file button 3. The browse for file window will open - browse to where your backup file is located and click on OK
4. When the restore is completed you will see the below dialog box
Optimize database Optimizing your database will help with performance. Follow the steps below to optimize your database. 1. lick on Tools - Database Tools
2. Click on the Optimize button 3. Depending on the size of your database this may take awhile. If you want to proceed click the Yes button
4. Once the optimization has been completed you will see the dialog box below
3. Windows Media Center opens 4. Once Windows Media Center loads you will be prompted with a message asking you if you want to configure Open Media Library. If you wish to run the wizard click the Configure OML button. If you do not want to run it click No Thanks. You can re-launch the wizard from the Open Media Library settings if you cancel out of this wizard.
6. Choose how you would like to launch Open Media Library and click next.
The following options are available for this: Keep my Existing Start menu Configuration (will only show up if you have previously installed the SQL version of Open Media Library) Create an Open Media Library Start Menu Strip (Creates a strip called Open Media Library from the main Media Center Menu) Access open Media Library from Program Library (Creates a link in Online Media -> Program Library for Open Media Library) 7. Open Media Library is now configured, click Finish to close the wizard. You must restart Windows Media center for your changes to take effect.
3. Windows Media Center opens 4. Once you have opened Windows Media Center, navigate to your Open Media Library installation and launch the application If you created your own start menu for Open Media Library, browse to the Open Media Library strip and click on Movies to launch the application If you created the application under the program library browse to Online Media and click on Program Library. Open Media Library will have a tile in this screen.
5. Once you launch the Open Media Library you should something similar to the screenshot below
3. Windows Media Center opens 4. Once you have opened Windows Media Center, navigate to your Open Media Library installation and launch the application If you created your own start menu for Open Media Library, browse to the Open Media Library strip and click on Movies to launch the application If you created the application under the program library browse to Online Media and click on Program Library. Open Media Library will have a tile in this screen. 5. Once you launch the Open Media Library you should something similar to the screenshot below
6. Browse to a movie that you want to watch and select it 7. The Movie Details screen appears
3. Click on the filter you would like to use (We will use Genre in this example) 4. A list of items that match your filter will show
6. If you would like to do a filter on these matches you can follow steps 2-5 again. 7. Select a movie, the movie details screen appears
5. Select the tag you want to filter by 6. A list of movies that matches that tag will display
General Settings
General Settings affect the way that the application looks and feels to the user. The following subscreens are available:
Gallery Theme Background Open Media Library Setup Additional Settings Start Menu Automatic Updates About Open Media Library
Gallery
The Gallery Screen allows you to modify how Open Media Library will look to users. The following settings are available: Choose how you would like OML to display your titles List view - Lists out the movies (no cover art is shown) Poster view - Displays cover art Show two rows - Allows you to set how many movies must be in your database to show 2 rows of movies Show three rows - Allows you to set how many movies must be in your database to show 2 rows of movies
Background
The Background page allows you to put a customized background on the main Movie page. You can put as many images as you want in the C:\ProgramData\OpenMediaLibrary\MainBackDrops folder and set how often you want the image to rotate. The following settings are available for this feature: Enable Custom Background - Enabled (checked) or disabled (Unchecked) Transparency - This determines how faded the image will show up Rotate Background every - Allows user to customize how often they want the backdrop image to change. If only one image is in the folder the rotate feature will not work.
Open Media Library Setup This setting allows the user to re-run the first time setup wizard
Additional Settings
The following settings are available in this screen: Use Alpha Jump - This setting will put an alphabetical quick list at the top of the movies screen which allows users to jump to movies that start with a certain letter
Show unwatched icon - This setting will display an icon on the movies that have not been watched Allow deletion of movies - This setting will allow users to delete movies from the database from within media center. If users delete movies from within media center, the movie will be deleted from the database and from your server - this cannot be undone.
Start Menu
The Start Menu screen allows users to determine what shortcuts are on the Open Media Library strip (if used). Users are also able to select the order in which they appear. Use the Up and down arrows to move the shortcuts around or the 'x' to delete the shortcut. Users are also able to create new links by using the new shortcut link on the side of the screen. By default the Open Media Library strip will have the following shortcuts available: Movies TV Trailers Search
New Shortcut
Make the setting changes below to create a new shortcut on the Open Media Library strip (You will need to restart Media Center for these changes to take affect) Name - How you would like the shortcut to read Shortcut - you can quick link the shortcut to the following items OML Home - link to your media in Open Media Library Trailers - quick link to trailers Search - quick link to search for a movie Settings - quick link to the settings screen Icon - If you want to put a custom picture in the shortcut you can assign it here
Automatic Updates
If you would like Open Media Library to update automatically when a new build is posted, enable them here. Your options are: Enable Automatic Updates - This will apply only when featured builds are posted Enable Beta Updates - This will apply when any build is posted
This area has information from what version of the software is installed to who contributed to the project.
Favorites
Not currently active
Filters
The filters screen allows you to select which options are available for sorting the movies. All of the filters can be modified in the dbeditor. The following filters are available Unwatched Actors Country Date Added Directors Format Genres Parental Rating Runtime Tags User Rating Year
Media Changers
If you use a media changer to store your movies, use this screen to change the settings for how your media changer interacts with Open Media Library Enable Support for media changers - enabled (checked) or disabled (unchecked) Allow OML to Detect new discs added to your changer retrieve metadata from Microsoft Manage Discs - connects to your media changer and allows you to manage the discs that OML uses.
Optimization
Optimization tasks can be performed at a specified time to help keep your database running smoothly. Perform Optimization - Enabled (Checked) or disabled (Unchecked) Optimization Schedule - when you would like the optimization to run every day Optimize now - if you want to optimize your database manually click on this button
Image Mounting
If you use a tool such as Daemon Tools or Virtual Clone drive to mount ISO files go into this screen to make changes. When you first click on the button for image mounting, Open Media Library will attempt to find your image mounting software. If it is not found click on the advanced button and set it up manually Manually configure image mounting - enabled (Checked) or disabled (unchecked) Mounting Tool Daemon Tools Lite Virtual Clone Drive Mounting Tool Path - Path to where the mounting tool is installed Virtual Drive - Drive that your Virtual Clone Drive tool uses
Language
By default Open Media Library uses the same language that your operating system is set to use. If another language is desired change it in this screen
Trailers
The trailers settings page allows user to determine what format the trailers will be displayed in. The following settings are available for the format HD - High Definition Standard - Standard Definition
Extender
Impersonation
Impersonation settings are used to determine a user that has access to network shares that movies can be stored on
Transcoding
Transcoding settings are used for extenders. If you have an extender and are running Microsoft Windows Vista, you will need to transcode some file types to allow them to play on your extender. If you are running Microsoft Windows 7 you will not need to modify these settings as Windows 7 will automatically transcode for you. The following settings are available for transcoding: Transcoding Delay - the amount of delay that will be delayed before the movie starts playing. Slower systems or network connections may need to set this to a higher number to avoid stuttering in movies Additional Formats - Configure what formats need to be transcoded. Some extenders play formats that others will not. You should find out what formats are supported on your extender before changing these settings Transcode AVI files Transcode MKV files Transcode OGM files
If you are transcoding a non-DVD format you can choose to preserve the audio stream or have that transcoded with the file.
5. Once Daemon tools starts, right-click on the Daemon Tools icon in your task tray. Deselect 'Secure mode' (critical for use with OML) and 'Check for updates.'
Pre-requisites:
The following programs are needed in order to get the Database Mangement Tools installed: 1. Windows Powershell 1.0. Can be downloaded here 2. Microsoft SQL Server Database Management Tools (See next section for installation instructions).
3. Once you install the Web Platform Installer, you will see the following screen. Click on install to continue
5. If you do not already have Microsoft Powershell installed, the installer will automatically download and install it for you.
6. Once powershell is installed the installer will install the Management Studio tools (this may take several minutes to complete).
8. Click Exit
1. Server Name: MachineName\OML 2. Authentication: SQL Server Authentication 3. Login: oml 4. Password: oml 3. Once you have connected to the database you can start writing SQL Queries by clicking on the New Query button
4. You can view the database properties using the tree in the left-hand pane
5. Once you click on the New Query button, type your query in the right-hand pane (We have included the Entity Relationship Diagram below to show you the table structure of the OML database).
6. To execute your query click on the execute button above your query
Revision History
Document Version 1.001 1.002 1.003 1.004 1.005 1.006 Editor Gahvey Gahvey Gahvey Gahvey Gahvey Gahvey Date 6/05/09 7/28/09 7/31/09 8/11/09 8/21/09 8/24/09 Changes Original- New SQL Quide Added new DB Editor Instructions Added Appendix A and B Started work on Media Center UI documentation Completed most of the settings section Added ERD