MagicLantern (version) Help

MagicLantern is Copyright © 2009, P. Lutus.

MagicLantern is released under the GPL: http://www.gnu.org/licenses/gpl.html

Please visit http://www.arachnoid.com/MagicLantern for more documentation and to acquire the latest version of MagicLantern.

NOTE: For formatting reasons, users may want to temporarily make the MagicLantern program frame larger to properly read these instructions.

Introduction | Overview | Preliminaries
First Steps | Image Scaling | Memory Problems
Editing in Depth | Display in Depth | Total Recall
Thumbnail/Scaled Image Issues | Miscellaneous Notes

Introduction

MagicLantern is a Java program that helps you organize, create, edit and present electronic slide shows. MagicLantern is compatible with commonly available remote controls that work with PowerPoint and other slide management and presentation programs, to create screen-filling "slide shows" of user-provided media. MagicLantern has an integrated image editor and organizer to manage creation of slide shows. MagicLantern supports automated slide presentations, with many user-specified properties.

Because MagicLantern is written in Java, it will run on virtually any platform. To run, MagicLantern needs a recent version of Java, available free at http://java.com.

Overview

Modern photographers acquire their images with digital cameras, and the resulting image quality is usually spectacular. When it comes time to present a slide show, presenters usually discover that available electronic slide projectors have a much lower resolution than their camera. And editing slide shows require tiny images called "thumbnails" to represent the full-size images, but that are easily moved about in an editing window. This means modern slide show editing needs three kinds of images:

  1. The original, full-resolution images that came from the digital camera.
  2. Smaller versions of the above for presentation by a typical modern electronic slide projector.
  3. Tiny versions of the originals for use as tokens that can be easily moved about in an electronic slide organizer.

MagicLantern manages all these image types for you, and is able to create the second and third image types from the first. MagicLantern then allows you to design slide shows in an intuitive way, by dragging and dropping thumbnails from one place to another, or changing their order within your slide show.

Inexperienced digital photographers may wonder if it is necessary to keep the original, large, high-quality image files, since they cannot normally be used in their original form. Well, there are a number of reasons to keep an archive of large originals, as difficult and storage-consuming as they are:

In the following sections you will learn how to organize collections of digital images, produce different versions for different purposes, and create professional-quality "slide show" presentations of your own.

Preliminaries

First Steps

In this exercise, we will open a directory of images in MagicLantern for editing. Remember that MagicLantern doesn't edit your images directly, it only manipulates image names in a list, and all the editing actions are performed against a list, not the original images. Your images are never deleted or modified by MagicLantern.

To start using MagicLantern, follow these steps:

We'll return to the editor later, but because we've just created a show, we can take a preliminary look at MagicLantern's display features.

Image Scaling

The editing pane uses thumbnails to represent full-sized images, and thumbnails are rather small, so your system's resources won't get used up unless you place many hundreds of images in the scratchpad area or in your slide show. But when showing images using the "Display" tab, MagicLantern must load graphic images in their full, original size, and depending on the user's choices, this may lead to certain problems. It is at this point that we need to discuss the size of computer graphic images.

When a typical graphic image is stored, it is compressed, typically by a ratio of 7 to 1 or better. This makes graphic images seem smaller than they actually are and overlooks the fact that, to display an image, MagicLantern must first uncompress it.

For example, I have a large collection of nature images, taken with a modern digital camera. My camera creates images that are 3,888 by 2,592 pixels in size, and the images have a storage size of about 4 megabytes (the size varies from one image to another). As I was planning a predecessor to MagicLantern years ago, I thought "4 megabytes doesn't seem very large for a modern computer program, there shouldn't be any great difficulty in unpacking and displaying such an image."

I was quite wrong. As I designed that earlier program, I was reminded of the tremendous memory requirements of modern computer graphics. After being unpacked and put on display, a computer graphic image requires three bytes per pixel (one for red, one for green, one for blue). Remember that there are (width times height) pixels in such an image and each pixel is three bytes. So while it is unpacked, my 4 megabyte image is actually:

width x height x 3

— or —

3,888 x 2,592 x 3 = 30,233,088 bytes

If I had accepted this huge image size for a typical slide show, I would have prevented many owners of small systems from using MagicLantern. So instead I came up with a three-tiered image scheme:

MagicLantern manages this scheme for you — if you visit the "" (Configure) tab, you will notice that the "Scaled Image Generator" at the top can create intermediate-sized images as well as thumbnails. For a reliable slide show presentation on a system without vast amounts of memory, the user should create both intermediate-sized images and thumbnails, through this procedure:

This scaling procedure assures that the MagicLantern slide display routines won't take forever to load and display your images, the fade transition effect will work as intended, and MagicLantern won't halt with an "Out of Memory" error, our next topic.

Memory Problems

Despite the above instructions, it is virtually certain that MagicLantern users will sometimes have memory problems. One reason is that, while creating intermediate-scale images and thumbnails, MagicLantern must load the original full-size images in order to scale them.

There are several ways to detect that memory has become an issue:

Remedy for Windows XP

Under Windows XP, the user may notice that the "Maximum" memory amount listed under "Memory Statistics" is about 66 megabytes. This is not remotely adequate — it's the size of two typical camera images, with nothing to spare. The following procedure should provide an adequate amount of memory on Windows XP systems:

Now run MagicLantern again, and you should see a maximum memory amount of roughly a gigabyte, even if your system doesn't have that much memory.

The technical explanation is that the Windows Java runtime engine doesn't allocate enough memory for a modern non-toy computer program, and Sun Microsystems should be ashamed of themselves.

Remedy for Linux, Macintosh

The problem described above doesn't usually come up on these operating systems — they normally grant sufficient memory to the Java runtime engine by default. But if a memory problem should come up, a similar solution applies:

Values greater than 1000m (1 gigabyte) can be entered and some of them will work, but these excursions should be reserved for cases where there is an actual need.

Here is a summary of this issue. If you click "" (Configure) and examine the memory statistics, you will see at a glance whether you are going to have memory problems:

Editing in Depth

Let's explore the editor and its functions in greater detail. We've already covered the basics — the right-hand pane is meant to contain a collection of slides to consider for inclusion in a slide show, and the left-hand pane contains your developing slide show. Here are some details:

Display in Depth

Now we look at display issues in a bit more detail. The user might want to present a slide show using a media projector, or a large computer monitor, or even on a media center with a large flat-panel TV. MagicLantern can handle all these options.

There are three basic display modes that control the size of the image on the computer video display:

In full-screen mode, function keys are used for control because the mouse is unavailable. Remember — to recover from full-screen mode, press any of the function keys F1, F2, F3 or F4. While in full-screen mode, these control keys are available (a more complete list of MagicLantern keys appears in the "Miscellaneous Notes" section below):
Key(s)
Function
Home Jump to the start
Left-arrow/Up-arrow/Page Up/P/Backspace Prior slide
Right-arrow/Down-arrow/Page Down/N/Space bar Next slide
End Jump to the end
Period (".") or B Blank/unblank the screen
F5/Escape Context switch (see below)

Context Switching

The term "context switch" (F5/Escape) will require a word of explanation. MagicLantern has two show indices and the user can switch between them using the indicated keys (which happen to be keys commonly available on slideshow remote controls). The reason? In my slide shows I discovered that I wanted to switch between the normal sequence of slides and a map or chart, then switch back again without losing my place. So I added a feature that jumps out of the main body of my presentation to some charts located at the beginning of the sequence. The simplest way to implement this feature is to have two indices (counters) pointing to two different locations in the slide sequence, and an easy way to switch between them. Both indices are fully and independently controllable, and it's child's play to switch between them.

On first hearing this, some readers may think it's sort of a gimmick, but after using it a few times, they won't be able to get along without it. During side shows I am often asked how I manage to bring up a chart at any point during the show, and I have to explain that I wrote my own software to get the feature.

One additional note about this feature. When first activated, function key F5 switches into full-screen mode, but then it controls the context switch. This has the advantage that if you are managing the slide show with a remote control, and if the remote has the function key F5, it can be used to go into fullscreen mode, and then context switch after that.

Auto Show

MagicLantern has an automatic show feature that displays a slide show unattended, with user-specified delay times (set using the "" (Configure) tab / Auto Show Side Duration) and the option to repeat the show endlessly. Once the desired options have been set, simply press the "" (Auto-Show) button to start the show.

Fade Transition

Rather than cut directly from one image to another, MagicLantern has a fade transition option that dissolves one image into another, with controls located at the "" (Configure) tab:

Constant Aspect Ratio

MagicLantern maintains the original aspect ratio of your images, regardless of the display size or shape. MagicLantern will never stretch or otherwise distort your images, which means there will sometimes be black bars at the left and right, or top and bottom, of some images. This is intentional (it's a feature, not a bug), and to be frank, it is more difficult to produce an image with aspect ratio fidelity than it is to let the display's size and shape distort the images.

Image Size Issues

Earlier we discussed the issue of image size with respect to avoiding memory problems. But it turns out that an image size optimized for a particular display has advantages in display update speed and even the appearance of the fade transition. Typically I create scaled-down images one standard display size larger than my media projector (mine has an image size of 1024x768, so I create 1280x1024 images, and that is the default size in MagicLantern), because this extra size avoids minor image artifacts one sees in images that are identical to the size of the display.

If memory limitations exist, users may want to create images the same size as their display, in which case there are options to minimize the distortions inherent in this process. One way to improve the appearance of scaled-down images is to explore the quality level option in the scaled image generator located on the "" (Configure) tab. The options are named "Good", "Better", and "Best", but to be technical for a moment, they correspond to three image interpolation strategies:

Name Corresponds to
"Good" Nearest Neighbor
"Better" Bilinear
"Best" Bicubic

The better interpolations tend to take longer while generating images, but have no effect on the subsequent load and display speeds. Read more about this rather technical topic here.

Industry Standard Controls

Because most multimedia projectors must work with Microsoft PowerPoint (there is no connection whatever between MagicLantern and either Microsoft or PowerPoint), a standard set of control keys has come into existence and are honored by the majority of multimedia projectors and remote controls. Because MagicLantern honors this same set of controls, chances are if a user already has a multimedia projector with a remote control, or owns a wireless remote control independent of his projector, it will be able to control MagicLantern (and if this is not the case, if I have overlooked a control method, please post to my message board and tell me about it).

Sound Effects

MagicLantern has a feature that can tie a displayed slide with a sound effect by way of a special editing action that associates a sound with a slide.

As an example, I recently gave a slide show about birds I had photographed, and I thought it would be nice to accompany the pictures with bird calls. While editing my slide show, after I had selected a slide to put in my show, I clicked the slide, then used the context menu (right-click) item "Add Sound" to navigate to a directory where I keep my show sounds, and chose an MP3 file to play when that slide is on display.

The sound associations are saved along with the slide show. To remove a sound association, in the slide show editor simply right-click a slide and choose "Remove Sound".

Total Recall

When you exit the program, MagicLantern remembers everything — the size and shape of the program frame, your choices and option settings, which slide shows were on display and being edited, even the current settings of the slide show controls. This means you can set up a slide show just as you want, exit MagicLantern, and start the show by simply clicking on the MagicLantern icon.

For example, if you want a trouble-free slide show launch, just set things up the way you want including options such as full-screen or auto-show, then press function key F12, which exits the program. Then, when it's showtime and you restart MagicLantern, everything will be restored including full-screen mode, and if you chose auto-show, the auto-show will commence.

The configuration file that contains all the MagicLantern settings is a plain-text file located on this system at (configuration path).

Thumbnail/Scaled Image Issues

Changing Thumbnail Size

The user might want to change thumbnail size from the default of 120 pixels (which means a box 120 pixels on a side, into which the scaled image fits). But such a change means all existing thumbnails will be recreated. For a large image collection this activity might be better carried out during idle time, because the time required to recreate all the thumbnails can be substantial.

To change thumbnail size, click the "" (Configure) tab, and select the "Thumb" mode. Choose a new size, click the "" (Path) button and navigate to the directory where your images are stored. Now click "Start" to begin the generation process. The scaled image generator will scan the selected directory and all subdirectories, creating thumbnails in all cases where there is no existing thumbnail with the right size. This might take some time.

Rescanning your Image Collection

As you add images to your collection, it is a good idea to run the scaled image generator periodically (or you can wait until you see the message "No thumbnail" instead of a thumbnail). The generator is reasonably intelligent and will only create scaled images (thumbnails and presentation images) for cases where:

Sometimes, after making a lot of changes to your image collection, it might be more efficient to delete the thumbnail subdirectory (always named "MagicLanternThumbnails") and the scaled image subdirectory (always named "MagicLanternScaledImages") then use the scaled image generator to regenerate them.

Miscellaneous Notes

MagicLantern accepts two graphic file formats, "jpeg" (Joint Photographic Experts Group) and "png" (Portable Network Graphics). The first type is recognized with two file suffixes — "jpg" and "jpeg" in upper or lower case, while the second is recognized with just "png", also case insensitive.

If you find a bug in MagicLantern, please visit http://arachnoid.com/messages and leave a report.

Here are the keyboard keys defined in MagicLantern and their corresponding actions:

Key(s)
Action
Function key F1 Switch to Help panel
Function key F2 Switch to Edit panel
Function key F3 Switch to Display panel, normal size
Function key F4 Switch to Display panel, maximized
Function key F5 (first press) Switch to Display panel, full-screen
Function key F5 (subsequent presses)/Escape Context switch (jump to other slide sequence)
Function key F6 Show/hide screen boundary square
Function key F7 Switch to configure panel
Function key F8 Start/Stop auto show
Function key F12 Exit MagicLantern
Home Jump to beginning of slide sequence
End Jump to end of slide sequence
Backspace/P/Left Arrow/Up Arrow/PgUp Move to previous slide
Space bar/N/Right Arrow/Down Arrow/PgDn Move to next slide
Period (".") Blank/unblank screen

Here are some MagicLantern-related resource locations:

Resource
Location
MagicLantern Home Page http://arachnoid.com/MagicLantern
MagicLantern version (version)
User home directory (user home directory)
MagicLantern data directory location (data path)
MagicLantern configuration file location (configuration path)
Currently running MagicLantern application location (application path)
Scratchpad panel content file location (browse path)