Viewer Architecture

From Second Life Wiki
Revision as of 22:48, 25 March 2007 by Which Linden (Talk | contribs)

Jump to: navigation, search

The Second Life client (also known as the "viewer") is a complex piece of software. It can be visualized as a streaming media client like RealPlayer, a game engine like Quake 3, or a web browser.

First you'll need to learn some terminology like "agent", "sim", and "region" in the glossary.

Learn by Example

Major Systems

  • Message System - reliable and unreliable transport over UDP
  • Image System - prioritizes and decodes JPEG2000 images into OpenGL textures
    • Texture cache - used for reading and writing texture data to the local disk cache
  • Viewer Object System - objects in scene for rendering and editing
  • Rendering System - from viewer object to drawable to face to vertices to graphics card
  • Culling - octree and occlusion based culling to speed rendering
  • UI Widgets - cross platform buttons, scroll bars, etc.
  • UI Floaters - dialogs and windows built from XML files
  • Asset System - transport for animations, sounds, notecards, scripts, etc.
  • Inventory - server-side storage of assets for each user
  • Sound System - cross platform audio based on FMOD
  • Movie System - QuickTime-based video on object surfaces
  • VFS - cached data is held in two "virtual file systems" in large files on the client
  • Selection Manager - holds extended information for selected objects and allows editing
  • Avatar Appearance - appearance is constructed from a mesh, parameters to deform the mesh, and textures to describe clothing
  • Web Browser - the integration of the viewer with the web.
  • Avatar Profiles
  • Groups
  • L$ System
  • Tools - anything that takes effect when you click your mouse on the world view.
  • Error Logging System - command and control of debugging output

Threads

The viewer is a single process with a few threads:

  • Main thread -- The input/output main program function (including rendering).
  • VFS thread -- Thread responsible for reading/writing to the local virtual file system.
  • LFS thread -- Thread responsible for some reading/writing to the local native file system.
  • Image thread -- Thread responsible for requesting and decoding image data
  • Error Thread -- Thread responsible for catching exceptions, calling the (currently unused?) error handler, and retiring
  • Worker Threads -- Threads designed to do cpu intensive background tasks
    • These threads may be paused during rendering so as not to reduce performance (design in-progress)

Program Flow

  1. Initialize - newview/viewer.cpp :: main()
  2. Loop - newview/viewer.cpp :: main_loop()
    • Gathers keyboard and mouse input
    • Pumps the TCP i/o
    • idle()
    • Render the frame
    • let filesystem and worker threads process
  3. Shutdown

One way to see what goes on in the main loop is to bring up the debug menus (Ctrl-Alt-D) then Client->Consoles->Fast Timers (or Ctrl-Shift-9) and expand the entries in the caption.

Sources of Input

User Guides