VideoLAN Wiki - User contributions [en]

AndroidCompile

2012-01-31T00:35:14Z

MessiahAndrw: /* Troubleshooting */

This page is an introduction to compilation of VLC for Android on Linux.

= Eclipse, SDK and NDK installation =

== Android SDK ==

#Create a working directory ''android''.
#Go to [http://developer.android.com/sdk/index.html Android SDK page] and download android-sdk_r10-linux_x86.tgz.
#Decompress into ''android'' folder.
#Run ''tools/android''.
#In the tool, install '''"SDK Platform Android 2.3, API 10"''', and follow the instructions.

You can have [http://developer.android.com/sdk/installing.html more details], if needed.

 

== Android NDK ==

# Check that the SDK installation is correct.
# Go to [http://developer.android.com/sdk/ndk/index.html Android NDK page].
# Download http://dl.google.com/android/ndk/android-ndk-r5b-linux-x86.tar.bz2.
# Decompress into ''android'' folder, next to your android-sdk-linux_x86 folder.

'''Note''': If you use the Android v7 NDK, replace your /vlc-android/build.xml file as follows:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<project name="VLC" default="help">


<loadproperties srcFile="local.properties" />


<property file="ant.properties" />


<loadproperties srcFile="project.properties" />


<fail
message="sdk.dir is missing. Make sure to generate local.properties using 'android update project'"
unless="sdk.dir"
/>






<import file="${sdk.dir}/tools/ant/build.xml" />

</project>
</pre>

== Eclipse ==

As used by your distribution, install eclipse with your package manager:

apt-get install eclipse (debian)
yum install eclipse (Fedora)
pacman -S eclipse (Arch)
emerge -av eclipse-sdk (Gentoo)
...

And run it, at least once, and then quit eclipse.

=== ADT ===

The '''ADT''' plugin is required to compile on Android.

#Go to [http://developer.android.com/sdk/eclipse-adt.html#installing ADT page].
#Start Eclipse, then select Help > Install New Software....
#Add the "ADT Plugin" repository with https://dl-ssl.google.com/android/eclipse/ as '''URL'''
#Validate and select the checkbox next to Developer Tools and click Next, Next, Finish.
#Restart Eclipse.
#Go to ''Menu'' > ''Window'' > ''Preferences...'' and then ''Android'' from the left pane.
#Point the SDK Location in to your downloaded SDK directory.
#Ok, and quit Eclipse.

See [http://developer.android.com/sdk/eclipse-adt.html#troubleshooting extra information here].

== Environment setup ==

=== Linux and autotools ===

You '''MUST''' be on Linux, and a recent one.

You '''MUST''' have installed: ''apache-ant'', ''autoconf'', ''automake'', ''libtool'', ''gawk'' (or ''nawk''), ''gcc'', ''g++'', ''pkg-config'', ''cmake'', ''patch'', ''subversion''. And very up-to-date versions of those tools.

You '''MUST''' install: ''git''.

=== Environment ===

Set $ANDROID_SDK to point to your Android SDK directory

export ANDROID_SDK=/path/to/android-sdk

Set $ANDROID_NDK to point to your Android NDK directory

export ANDROID_NDK=/path/to/android-ndk

Add some useful binaries to your $PATH

export PATH=$PATH:$ANDROID_SDK/tools:$ANDROID_SDK/platform-tools

If you plan to use the emulator or if you have a phone that does not support NEON, you need a build without [[wikipedia:ARM_architecture#Advanced_SIMD_.28NEON.29|NEON]]

export NO_NEON=1

Those exports must be set at all times, notably for the contribs and the configure.

= Building =
== Get VLC Source ==

Use the VLC git repository to get the source!

In your ''android'' folder, run:

git clone git://git.videolan.org/vlc-ports/android.git

=== Compile ===
'''Read''' compile.sh first, as it contains some very useful important information. Then run it:
sh compile.sh

=== Package in eclipse ===
# In Eclipse, create a new Android project from existing source by giving the vlc-android path.
# Compile your project using Eclipse.

== Run ==

Run it and enjoy!

= Debuging =
Here are some helpful links if you wish to debug VLC on Android:
* [http://developer.android.com/guide/developing/debugging/ddms.html DDMS]
* [http://developer.android.com/guide/developing/tools/logcat.html Logcat]

= Troubleshooting =
== Outdated Awk ==
If you receive the error message while building:

Android NDK: Host 'awk' tool is outdated. Please define HOST_AWK to point to Gawk or Nawk !

The prebuilt version of Awk that comes with the Android NDK is outdated. Defining HOST_AWK in your environment does nothing as the system still tries to just the one that comes with the Android NDK. To get around this issue, simply rename or delete the Awk binary that comes with the Android NDK. For example to move it:

mv $ANDROID_NDK/prebuilt/linux-x86/bin/awk $ANDROID_NDK/prebuilt/linux-x86/bin/awk.old

== Can't find Ant ==
If you're new to Ant, please be aware that some Linux distros don't install it in the usual spot as with other programs. Try checking to see if the directory /usr/share/java/apache-ant/bin exists and add it to your path.

AndroidCompile

2012-01-31T00:29:43Z

MessiahAndrw: fixed section indenting, started troubleshooting section

AndroidCompile

2012-01-31T00:22:03Z

MessiahAndrw: /* Linux and autotools */ added ant to required tools

This page is an introduction to compilation of VLC for Android on Linux.

= Eclipse, SDK and NDK installation =

== Android SDK ==

#Create a working directory ''android''.
#Go to [http://developer.android.com/sdk/index.html Android SDK page] and download android-sdk_r10-linux_x86.tgz.
#Decompress into ''android'' folder.
#Run ''tools/android''.
#In the tool, install '''"SDK Platform Android 2.3, API 10"''', and follow the instructions.

You can have [http://developer.android.com/sdk/installing.html more details], if needed.

 

== Android NDK ==

# Check that the SDK installation is correct.
# Go to [http://developer.android.com/sdk/ndk/index.html Android NDK page].
# Download http://dl.google.com/android/ndk/android-ndk-r5b-linux-x86.tar.bz2.
# Decompress into ''android'' folder, next to your android-sdk-linux_x86 folder.

'''Note''': If you use the Android v7 NDK, replace your /vlc-android/build.xml file as follows:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<project name="VLC" default="help">


<loadproperties srcFile="local.properties" />


<property file="ant.properties" />


<loadproperties srcFile="project.properties" />


<fail
message="sdk.dir is missing. Make sure to generate local.properties using 'android update project'"
unless="sdk.dir"
/>






<import file="${sdk.dir}/tools/ant/build.xml" />

</project>
</pre>

== Eclipse ==

As used by your distribution, install eclipse with your package manager:

apt-get install eclipse (debian)
yum install eclipse (Fedora)
pacman -S eclipse (Arch)
emerge -av eclipse-sdk (Gentoo)
...

And run it, at least once, and then quit eclipse.

=== ADT ===

The '''ADT''' plugin is required to compile on Android.

#Go to [http://developer.android.com/sdk/eclipse-adt.html#installing ADT page].
#Start Eclipse, then select Help > Install New Software....
#Add the "ADT Plugin" repository with https://dl-ssl.google.com/android/eclipse/ as '''URL'''
#Validate and select the checkbox next to Developer Tools and click Next, Next, Finish.
#Restart Eclipse.
#Go to ''Menu'' > ''Window'' > ''Preferences...'' and then ''Android'' from the left pane.
#Point the SDK Location in to your downloaded SDK directory.
#Ok, and quit Eclipse.

See [http://developer.android.com/sdk/eclipse-adt.html#troubleshooting extra information here].

== Environment setup ==

=== Linux and autotools ===

You '''MUST''' be on Linux, and a recent one.

You '''MUST''' have installed: ''apache-ant'', ''autoconf'', ''automake'', ''libtool'', ''gcc'', ''g++'', ''pkg-config'', ''cmake'', ''patch'', ''subversion''. And very up-to-date versions of those tools.

You '''MUST''' install: ''git''.

=== Environment ===

Set $ANDROID_SDK to point to your Android SDK directory

export ANDROID_SDK=/path/to/android-sdk

Set $ANDROID_NDK to point to your Android NDK directory

export ANDROID_NDK=/path/to/android-ndk

Add some useful binaries to your $PATH

export PATH=$PATH:$ANDROID_SDK/tools:$ANDROID_SDK/platform-tools

If you plan to use the emulator or if you have a phone that does not support NEON, you need a build without [[wikipedia:ARM_architecture#Advanced_SIMD_.28NEON.29|NEON]]

export NO_NEON=1

Those exports must be set at all times, notably for the contribs and the configure.

= Get VLC Source =

Use the VLC git repository to get the source!

In your ''android'' folder, run:

git clone git://git.videolan.org/vlc-ports/android.git

=== Compile ===
'''Read''' compile.sh first, as it contains some very useful important information. Then run it:
sh compile.sh

=== Package in eclipse ===
# In Eclipse, create a new Android project from existing source by giving the vlc-android path.
# Compile your project using Eclipse.

== Run ==

Run it and enjoy!

== Debug ==
* [http://developer.android.com/guide/developing/debugging/ddms.html DDMS]
* [http://developer.android.com/guide/developing/tools/logcat.html Logcat]

SoC 2011/Stereoscopic Video

2011-09-18T04:36:54Z

MessiahAndrw: /* Donations */

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

Stereoscopic, or 3D, video support was implemented into the VLC Media Player as part of my Google Summer of Code project. It is currently experimental with a couple of bugs and I'm still actively working on it. At present you must build it from source, and I'm looking to soon merge it into the main tree.

I'm in need of hardware, if you would like to help out see [[#Donations|here]].

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. https://github.com/MessiahAndrw/Stereoscopic-VLC

A build (that my be out of date by the time you read this) is available here: http://streams.videolan.org/misc/stereo/vlc-1.2.0-git-stereoscopy.zip�

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

Flags:
{| border="1"
|-
| STEREO_WAIT_FOR_NEXT_FRAME_BIT
| Do not present straight away and instead wait for the next frame.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

Mask i_eye by STEREO_EYE_MASK to get the eye number without any flags. It is possible that two images represent the same point in time (this is only untrue for field sequential video). If the STEREO_WAIT_FOR_NEXT_FRAME_BIT is set then the vout shouldn't present the frame straight away, but expect another picture immediately joining it representing the other eye at the same point of time, and display them together at once.

== nVidia 3D Vision ==
The focus of the Google SoC project has been on nVidia 3D Vision. To use 3D Vision you require the following:

* A compatible nVidia GPU
* nVidia 3D Vision Kit (the glasses you wear)
* A 120Hz LCD or 100Hz CRT monitor
* Windows

You also have to rename 'vlc.exe' since VLC isn't yet supported by the nVidia drivers. I'd recommend 'wow.exe' or 'googleearth.exe'. Also, make sure you have 3D Vision enabled in the nVidia control panel.

3D Vision will work straight out the box with the Direct3D (XP) vout. You don't need to do anything special, it'll activate as soon as the Direct3D vout starts receiving stereoscopic frames.

== AMD HD3D ==
I would really love to start working on supporting AMD HD3D, but I need your help, see [[#Donations|here]].

== Quad Buffered OpenGL ==
There is some experimental code for quad-buffered OpenGL if you build from source. I highly doubt it will work since I currently lack the hardware needed to test it. Help speed up development, see [[#Donations|here]].

== Other Planned Features ==
* ''A vout-independent anaglyph combining filter.'' This will combine the images for both eyes into a single anaglyph image before being passed to the vout. This will make it possible to display stereoscopic content with non-stereoscopic-aware vouts.
* ''3D TV output.'' Non-HDMI 1.4 3D outputs - e.g. outputting side-by-side checkerboard, row interleaved, etc.
* ''Other proprietary shutter glasses''. For example e-Dimensional.
* ''More input formats''. Column and row interleaved input sources.

== Donations ==
The best way you can help me out is by donating hardware. Any hardware you donate will become my top priority to add support for. If you do wish to donate, please contact me by e-mail at messiahandrw-at-gmail-dot-com (my shipping address is in Australia). I'll accept any hardware that you wish to donate, however the following will be especially useful:

* AMD Radeon HD 5xxx or 6xxx.
* AMD FirePro Vx800, Vx7x0
* HDMI 1.4 compliant 3D TVs
* 120Hz monitors

If instead you'd like to donate money for me to purchase the above hardware, see [http://pledgie.com/campaigns/16038 my pledge].

== Troubleshooting & Support ==
There are several issues I am aware of. If you need support directly from me or have any enquiries then feel free to e-mail me directly at messiahandrw-at-gmail-dot-com (also mention Stereoscopic VLC in the subject so I don't mistake it for spam).

=== VLC Crashes when I click stop ===
I know about this bug and I'm trying to fix it, so stay tuned!

=== The frame rate is too slow ===
The stereoscopy module is alternating outputting left and right frames, because VLC starts to drop frames when I start doubling the frame rate. I'm working on a way around this (and if you're a developer I'd love for some input on this!)

=== My Video is black! ===
Either there's a bug I don't know about, or the stereoscopy module doesn't support your particular colour encoding. Check VLC's messages to see if anything is being reported (Tools > Messages). Either way, e-mail me and I'll get straight on to it!

=== 3D Vision isn't working ===
This could be any number of things:
* 3D Vision is not enabled in the nVidia control panel.
* You haven't renamed vlc.exe (see above).
* You're not using the Direct3D vout.
* The stereoscopy module is turned off.
* You don't have the latest nVidia drivers.

I'd love to solve your issue, but please check VLC's messages for any warnings and errors before contacting me.

SoC 2011/Stereoscopic Video

2011-09-15T12:17:54Z

MessiahAndrw: /* Donations */

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

Stereoscopic, or 3D, video support was implemented into the VLC Media Player as part of my Google Summer of Code project. It is currently experimental with a couple of bugs and I'm still actively working on it. At present you must build it from source, and I'm looking to soon merge it into the main tree.

I'm in need of hardware, if you would like to help out see [[#Donations|here]].

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. https://github.com/MessiahAndrw/Stereoscopic-VLC

A build (that my be out of date by the time you read this) is available here: http://streams.videolan.org/misc/stereo/vlc-1.2.0-git-stereoscopy.zip�

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

Flags:
{| border="1"
|-
| STEREO_WAIT_FOR_NEXT_FRAME_BIT
| Do not present straight away and instead wait for the next frame.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

Mask i_eye by STEREO_EYE_MASK to get the eye number without any flags. It is possible that two images represent the same point in time (this is only untrue for field sequential video). If the STEREO_WAIT_FOR_NEXT_FRAME_BIT is set then the vout shouldn't present the frame straight away, but expect another picture immediately joining it representing the other eye at the same point of time, and display them together at once.

== nVidia 3D Vision ==
The focus of the Google SoC project has been on nVidia 3D Vision. To use 3D Vision you require the following:

* A compatible nVidia GPU
* nVidia 3D Vision Kit (the glasses you wear)
* A 120Hz LCD or 100Hz CRT monitor
* Windows

You also have to rename 'vlc.exe' since VLC isn't yet supported by the nVidia drivers. I'd recommend 'wow.exe' or 'googleearth.exe'. Also, make sure you have 3D Vision enabled in the nVidia control panel.

3D Vision will work straight out the box with the Direct3D (XP) vout. You don't need to do anything special, it'll activate as soon as the Direct3D vout starts receiving stereoscopic frames.

== AMD HD3D ==
I would really love to start working on supporting AMD HD3D, but I need your help, see [[#Donations|here]].

== Quad Buffered OpenGL ==
There is some experimental code for quad-buffered OpenGL if you build from source. I highly doubt it will work since I currently lack the hardware needed to test it. Help speed up development, see [[#Donations|here]].

== Other Planned Features ==
* ''A vout-independent anaglyph combining filter.'' This will combine the images for both eyes into a single anaglyph image before being passed to the vout. This will make it possible to display stereoscopic content with non-stereoscopic-aware vouts.
* ''3D TV output.'' Non-HDMI 1.4 3D outputs - e.g. outputting side-by-side checkerboard, row interleaved, etc.
* ''Other proprietary shutter glasses''. For example e-Dimensional.
* ''More input formats''. Column and row interleaved input sources.

== Donations ==
The best way you can help me out is by donating hardware. Any hardware you donate will become my top priority to add support for. If you do wish to donate, please contact me by e-mail at messiahandrw-at-gmail-dot-com (my shipping address is in Australia). I'll accept any hardware that you wish to donate, however the following will be especially useful:

* AMD Radeon HD 5xxx or 6xxx.
* AMD FirePro Vx800, Vx7x0
* HDMI 1.4 compliant 3D TVs
* 120Hz monitors

== Troubleshooting & Support ==
There are several issues I am aware of. If you need support directly from me or have any enquiries then feel free to e-mail me directly at messiahandrw-at-gmail-dot-com (also mention Stereoscopic VLC in the subject so I don't mistake it for spam).

=== VLC Crashes when I click stop ===
I know about this bug and I'm trying to fix it, so stay tuned!

=== The frame rate is too slow ===
The stereoscopy module is alternating outputting left and right frames, because VLC starts to drop frames when I start doubling the frame rate. I'm working on a way around this (and if you're a developer I'd love for some input on this!)

=== My Video is black! ===
Either there's a bug I don't know about, or the stereoscopy module doesn't support your particular colour encoding. Check VLC's messages to see if anything is being reported (Tools > Messages). Either way, e-mail me and I'll get straight on to it!

=== 3D Vision isn't working ===
This could be any number of things:
* 3D Vision is not enabled in the nVidia control panel.
* You haven't renamed vlc.exe (see above).
* You're not using the Direct3D vout.
* The stereoscopy module is turned off.
* You don't have the latest nVidia drivers.

I'd love to solve your issue, but please check VLC's messages for any warnings and errors before contacting me.

SoC 2011/Stereoscopic Video

2011-09-15T12:06:15Z

MessiahAndrw: /* Donations */

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

Stereoscopic, or 3D, video support was implemented into the VLC Media Player as part of my Google Summer of Code project. It is currently experimental with a couple of bugs and I'm still actively working on it. At present you must build it from source, and I'm looking to soon merge it into the main tree.

I'm in need of hardware, if you would like to help out see [[#Donations|here]].

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. https://github.com/MessiahAndrw/Stereoscopic-VLC

A build (that my be out of date by the time you read this) is available here: http://streams.videolan.org/misc/stereo/vlc-1.2.0-git-stereoscopy.zip�

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

Flags:
{| border="1"
|-
| STEREO_WAIT_FOR_NEXT_FRAME_BIT
| Do not present straight away and instead wait for the next frame.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

Mask i_eye by STEREO_EYE_MASK to get the eye number without any flags. It is possible that two images represent the same point in time (this is only untrue for field sequential video). If the STEREO_WAIT_FOR_NEXT_FRAME_BIT is set then the vout shouldn't present the frame straight away, but expect another picture immediately joining it representing the other eye at the same point of time, and display them together at once.

== nVidia 3D Vision ==
The focus of the Google SoC project has been on nVidia 3D Vision. To use 3D Vision you require the following:

* A compatible nVidia GPU
* nVidia 3D Vision Kit (the glasses you wear)
* A 120Hz LCD or 100Hz CRT monitor
* Windows

You also have to rename 'vlc.exe' since VLC isn't yet supported by the nVidia drivers. I'd recommend 'wow.exe' or 'googleearth.exe'. Also, make sure you have 3D Vision enabled in the nVidia control panel.

3D Vision will work straight out the box with the Direct3D (XP) vout. You don't need to do anything special, it'll activate as soon as the Direct3D vout starts receiving stereoscopic frames.

== AMD HD3D ==
I would really love to start working on supporting AMD HD3D, but I need your help, see [[#Donations|here]].

== Quad Buffered OpenGL ==
There is some experimental code for quad-buffered OpenGL if you build from source. I highly doubt it will work since I currently lack the hardware needed to test it. Help speed up development, see [[#Donations|here]].

== Other Planned Features ==
* ''A vout-independent anaglyph combining filter.'' This will combine the images for both eyes into a single anaglyph image before being passed to the vout. This will make it possible to display stereoscopic content with non-stereoscopic-aware vouts.
* ''3D TV output.'' Non-HDMI 1.4 3D outputs - e.g. outputting side-by-side checkerboard, row interleaved, etc.
* ''Other proprietary shutter glasses''. For example e-Dimensional.
* ''More input formats''. Column and row interleaved input sources.

== Donations ==
The best way you can help me out is by donating hardware. Any hardware you donate will become my top priority to add support for. If you do wish to donate, please contact me by e-mail at messiahandrw-at-gmail-dot-com (my shipping address is in Australia). I'll accept any hardware that you wish to donate, however the following will be especially useful:

* AMD Radeon HD 5xxx or 6xxx.
* AMD FirePro Vx800, Vx7x0
* 3D TVs
* 120Hz monitors

== Troubleshooting & Support ==
There are several issues I am aware of. If you need support directly from me or have any enquiries then feel free to e-mail me directly at messiahandrw-at-gmail-dot-com (also mention Stereoscopic VLC in the subject so I don't mistake it for spam).

=== VLC Crashes when I click stop ===
I know about this bug and I'm trying to fix it, so stay tuned!

=== The frame rate is too slow ===
The stereoscopy module is alternating outputting left and right frames, because VLC starts to drop frames when I start doubling the frame rate. I'm working on a way around this (and if you're a developer I'd love for some input on this!)

=== My Video is black! ===
Either there's a bug I don't know about, or the stereoscopy module doesn't support your particular colour encoding. Check VLC's messages to see if anything is being reported (Tools > Messages). Either way, e-mail me and I'll get straight on to it!

=== 3D Vision isn't working ===
This could be any number of things:
* 3D Vision is not enabled in the nVidia control panel.
* You haven't renamed vlc.exe (see above).
* You're not using the Direct3D vout.
* The stereoscopy module is turned off.
* You don't have the latest nVidia drivers.

I'd love to solve your issue, but please check VLC's messages for any warnings and errors before contacting me.

SoC 2011/Stereoscopic Video

2011-09-15T12:01:07Z

MessiahAndrw:

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

Stereoscopic, or 3D, video support was implemented into the VLC Media Player as part of my Google Summer of Code project. It is currently experimental with a couple of bugs and I'm still actively working on it. At present you must build it from source, and I'm looking to soon merge it into the main tree.

I'm in need of hardware, if you would like to help out see [[#Donations|here]].

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. https://github.com/MessiahAndrw/Stereoscopic-VLC

A build (that my be out of date by the time you read this) is available here: http://streams.videolan.org/misc/stereo/vlc-1.2.0-git-stereoscopy.zip�

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

Flags:
{| border="1"
|-
| STEREO_WAIT_FOR_NEXT_FRAME_BIT
| Do not present straight away and instead wait for the next frame.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

Mask i_eye by STEREO_EYE_MASK to get the eye number without any flags. It is possible that two images represent the same point in time (this is only untrue for field sequential video). If the STEREO_WAIT_FOR_NEXT_FRAME_BIT is set then the vout shouldn't present the frame straight away, but expect another picture immediately joining it representing the other eye at the same point of time, and display them together at once.

== nVidia 3D Vision ==
The focus of the Google SoC project has been on nVidia 3D Vision. To use 3D Vision you require the following:

* A compatible nVidia GPU
* nVidia 3D Vision Kit (the glasses you wear)
* A 120Hz LCD or 100Hz CRT monitor
* Windows

You also have to rename 'vlc.exe' since VLC isn't yet supported by the nVidia drivers. I'd recommend 'wow.exe' or 'googleearth.exe'. Also, make sure you have 3D Vision enabled in the nVidia control panel.

3D Vision will work straight out the box with the Direct3D (XP) vout. You don't need to do anything special, it'll activate as soon as the Direct3D vout starts receiving stereoscopic frames.

== AMD HD3D ==
I would really love to start working on supporting AMD HD3D, but I need your help, see [[#Donations|here]].

== Quad Buffered OpenGL ==
There is some experimental code for quad-buffered OpenGL if you build from source. I highly doubt it will work since I currently lack the hardware needed to test it. Help speed up development, see [[#Donations|here]].

== Other Planned Features ==
* ''A vout-independent anaglyph combining filter.'' This will combine the images for both eyes into a single anaglyph image before being passed to the vout. This will make it possible to display stereoscopic content with non-stereoscopic-aware vouts.
* ''3D TV output.'' Non-HDMI 1.4 3D outputs - e.g. outputting side-by-side checkerboard, row interleaved, etc.
* ''Other proprietary shutter glasses''. For example e-Dimensional.
* ''More input formats''. Column and row interleaved input sources.

== Donations ==
The best way you can help me out is by donating hardware. Any hardware you donate will become my top priority to add support for. If you do wish to donate, please contact me by e-mail messiahandrw-at-gmail-dot-com (my shipping address is in Australia). I'll accept any hardware that you wish to donate, however the following will be especially useful:

* AMD Radeon HD 5xxx or 6xxx.
* AMD FirePro Vx800, Vx7x0
* 3D TVs
* 120Hz monitors

== Troubleshooting & Support ==
There are several issues I am aware of. If you need support directly from me or have any enquiries then feel free to e-mail me directly at messiahandrw-at-gmail-dot-com (also mention Stereoscopic VLC in the subject so I don't mistake it for spam).

=== VLC Crashes when I click stop ===
I know about this bug and I'm trying to fix it, so stay tuned!

=== The frame rate is too slow ===
The stereoscopy module is alternating outputting left and right frames, because VLC starts to drop frames when I start doubling the frame rate. I'm working on a way around this (and if you're a developer I'd love for some input on this!)

=== My Video is black! ===
Either there's a bug I don't know about, or the stereoscopy module doesn't support your particular colour encoding. Check VLC's messages to see if anything is being reported (Tools > Messages). Either way, e-mail me and I'll get straight on to it!

=== 3D Vision isn't working ===
This could be any number of things:
* 3D Vision is not enabled in the nVidia control panel.
* You haven't renamed vlc.exe (see above).
* You're not using the Direct3D vout.
* The stereoscopy module is turned off.
* You don't have the latest nVidia drivers.

I'd love to solve your issue, but please check VLC's messages for any warnings and errors before contacting me.

SoC 2011/Stereoscopic Video

2011-09-15T11:58:09Z

MessiahAndrw:

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

Stereoscopic, or 3D, video support was implemented into the VLC Media Player as part of my Google Summer of Code project. It is currently experimental with a couple of bugs and I'm still actively working on it. At present you must build it from source, and I'm looking to soon merge it into the main tree.

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. https://github.com/MessiahAndrw/Stereoscopic-VLC

A build (that my be out of date by the time you read this) is available here: http://streams.videolan.org/misc/stereo/vlc-1.2.0-git-stereoscopy.zip�

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

Flags:
{| border="1"
|-
| STEREO_WAIT_FOR_NEXT_FRAME_BIT
| Do not present straight away and instead wait for the next frame.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

Mask i_eye by STEREO_EYE_MASK to get the eye number without any flags. It is possible that two images represent the same point in time (this is only untrue for field sequential video). If the STEREO_WAIT_FOR_NEXT_FRAME_BIT is set then the vout shouldn't present the frame straight away, but expect another picture immediately joining it representing the other eye at the same point of time, and display them together at once.

== nVidia 3D Vision ==
The focus of the Google SoC project has been on nVidia 3D Vision. To use 3D Vision you require the following:

* A compatible nVidia GPU
* nVidia 3D Vision Kit (the glasses you wear)
* A 120Hz LCD or 100Hz CRT monitor
* Windows

You also have to rename 'vlc.exe' since VLC isn't yet supported by the nVidia drivers. I'd recommend 'wow.exe' or 'googleearth.exe'. Also, make sure you have 3D Vision enabled in the nVidia control panel.

3D Vision will work straight out the box with the Direct3D (XP) vout. You don't need to do anything special, it'll activate as soon as the Direct3D vout starts receiving stereoscopic frames.

== AMD HD3D ==
I would really love to start working on supporting AMD HD3D, but I need your help, see [[#Donations|here]].

== Quad Buffered OpenGL ==
There is some experimental code for quad-buffered OpenGL if you build from source. I highly doubt it will work since I currently lack the hardware needed to test it. Help speed up development, see [[#Donations|here]].

== Other Planned Features ==
* ''A vout-independent anaglyph combining filter.'' This will combine the images for both eyes into a single anaglyph image before being passed to the vout. This will make it possible to display stereoscopic content with non-stereoscopic-aware vouts.
* ''3D TV output.'' Non-HDMI 1.4 3D outputs - e.g. outputting side-by-side checkerboard, row interleaved, etc.
* ''Other proprietary shutter glasses''. For example e-Dimensional.
* ''More input formats''. Column and row interleaved input sources.

== Donations ==
The best way you can help me out is by donating hardware. Any hardware you donate will become my top priority to add support for. If you do wish to donate, please contact me by e-mail messiahandrw-at-gmail-dot-com (my shipping address is in Australia). I'll accept any hardware that you wish to donate, however the following will be especially useful:

* AMD Radeon HD 5xxx or 6xxx.
* AMD FirePro Vx800, Vx7x0
* 3D TVs
* 120Hz monitors

== Troubleshooting & Support ==
There are several issues I am aware of. If you need support directly from me or have any enquiries then feel free to e-mail me directly at messiahandrw-at-gmail-dot-com (also mention Stereoscopic VLC in the subject so I don't mistake it for spam).

=== VLC Crashes when I click stop ===
I know about this bug and I'm trying to fix it, so stay tuned!

=== The frame rate is too slow ===
The stereoscopy module is alternating outputting left and right frames, because VLC starts to drop frames when I start doubling the frame rate. I'm working on a way around this (and if you're a developer I'd love for some input on this!)

=== My Video is black! ===
Either there's a bug I don't know about, or the stereoscopy module doesn't support your particular colour encoding. Check VLC's messages to see if anything is being reported (Tools > Messages). Either way, e-mail me and I'll get straight on to it!

=== 3D Vision isn't working ===
This could be any number of things:
* 3D Vision is not enabled in the nVidia control panel.
* You haven't renamed vlc.exe (see above).
* You're not using the Direct3D vout.
* The stereoscopy module is turned off.
* You don't have the latest nVidia drivers.

I'd love to solve your issue, but please check VLC's messages for any warnings and errors before contacting me.

SoC 2011/Stereoscopic Video

2011-09-15T11:37:31Z

MessiahAndrw: /* Planned Features */

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

Stereoscopic, or 3D, video support was implemented into the VLC Media Player as part of my Google Summer of Code project. It is currently experimental with a couple of bugs and I'm still actively working on it. At present you must build it from source, and I'm looking to soon merge it into the main tree.

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. https://github.com/MessiahAndrw/Stereoscopic-VLC

A build (that my be out of date by the time you read this) is available here: http://streams.videolan.org/misc/stereo/vlc-1.2.0-git-stereoscopy.zip�

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

Flags:
{| border="1"
|-
| STEREO_WAIT_FOR_NEXT_FRAME_BIT
| Do not present straight away and instead wait for the next frame.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

Mask i_eye by STEREO_EYE_MASK to get the eye number without any flags. It is possible that two images represent the same point in time (this is only untrue for field sequential video). If the STEREO_WAIT_FOR_NEXT_FRAME_BIT is set then the vout shouldn't present the frame straight away, but expect another picture immediately joining it representing the other eye at the same point of time, and display them together at once.

== nVidia 3D Vision ==
The focus of the Google SoC project has been on nVidia 3D Vision. To use 3D Vision you require the following:

* A compatible nVidia GPU
* nVidia 3D Vision Kit (the glasses you wear)
* A 120Hz LCD or 100Hz CRT monitor
* Windows

You also have to rename 'vlc.exe' since VLC isn't yet supported by the nVidia drivers. I'd recommend 'wow.exe' or 'googleearth.exe'. Also, make sure you have 3D Vision enabled in the nVidia control panel.

3D Vision will work straight out the box with the Direct3D (XP) vout. You don't need to do anything special, it'll activate as soon as the Direct3D vout starts receiving stereoscopic frames.

== Quad Buffered OpenGL ==
There is some experimental code for quad-buffered OpenGL if you build from source. I highly doubt it will work since I lack the hardware needed to test it - either a compatible nVidia Quadro or AMD Firepro and monitor - donations welcomed. :)

== Planned Features ==
* ''AMD HD3D''. AMD's quad buffered Direct3D solution for Windows.
* ''A vout-independent anaglyph combining filter.'' This will combine the images for both eyes into a single anaglyph image before being passed to the vout. This will make it possible to display stereoscopic content with non-stereoscopic-aware vouts.
* ''3D over HDMI.'' I will need to investigate this and experiment (nVidia 3DTV Play, AMD, non-Windows platforms).
* ''3D TV output.'' Non-HDMI 1.4 3D outputs - e.g. outputting side-by-side checkerboard, row interleaved, etc.
* ''Other proprietary shutter glasses''. For example e-Dimensional.
* ''More input features''. Column and row interleaved input sources.

== Troubleshooting & Support ==
There are several issues I am aware of. If you need support directly from me or have any enquiries then feel free to e-mail me directly at messiahandrw-at-gmail-dot-com (also mention Stereoscopic VLC in the subject so I don't mistake it for spam).

=== VLC Crashes when I click stop ===
I know about this bug and I'm trying to fix it, so stay tuned!

=== The frame rate is too slow ===
The stereoscopy module is alternating outputting left and right frames, because VLC starts to drop frames when I start doubling the frame rate. I'm working on a way around this (and if you're a developer I'd love for some input on this!)

=== My Video is black! ===
Either there's a bug I don't know about, or the stereoscopy module doesn't support your particular colour encoding. Check VLC's messages to see if anything is being reported (Tools > Messages). Either way, e-mail me and I'll get straight on to it!

=== 3D Vision isn't working ===
This could be any number of things:
* 3D Vision is not enabled in the nVidia control panel.
* You haven't renamed vlc.exe (see above).
* You're not using the Direct3D vout.
* The stereoscopy module is turned off.
* You don't have the latest nVidia drivers.

I'd love to solve your issue, but please check VLC's messages for any warnings and errors before contacting me.

SoC 2011/Stereoscopic Video

2011-09-12T17:18:58Z

MessiahAndrw: mentioned quad buffered opengl

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

Stereoscopic, or 3D, video support was implemented into the VLC Media Player as part of my Google Summer of Code project. It is currently experimental with a couple of bugs and I'm still actively working on it. At present you must build it from source, and I'm looking to soon merge it into the main tree.

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. https://github.com/MessiahAndrw/Stereoscopic-VLC

A build (that my be out of date by the time you read this) is available here: http://streams.videolan.org/misc/stereo/vlc-1.2.0-git-stereoscopy.zip�

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

Flags:
{| border="1"
|-
| STEREO_WAIT_FOR_NEXT_FRAME_BIT
| Do not present straight away and instead wait for the next frame.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

Mask i_eye by STEREO_EYE_MASK to get the eye number without any flags. It is possible that two images represent the same point in time (this is only untrue for field sequential video). If the STEREO_WAIT_FOR_NEXT_FRAME_BIT is set then the vout shouldn't present the frame straight away, but expect another picture immediately joining it representing the other eye at the same point of time, and display them together at once.

== nVidia 3D Vision ==
The focus of the Google SoC project has been on nVidia 3D Vision. To use 3D Vision you require the following:

* A compatible nVidia GPU
* nVidia 3D Vision Kit (the glasses you wear)
* A 120Hz LCD or 100Hz CRT monitor
* Windows

You also have to rename 'vlc.exe' since VLC isn't yet supported by the nVidia drivers. I'd recommend 'wow.exe' or 'googleearth.exe'. Also, make sure you have 3D Vision enabled in the nVidia control panel.

3D Vision will work straight out the box with the Direct3D (XP) vout. You don't need to do anything special, it'll activate as soon as the Direct3D vout starts receiving stereoscopic frames.

== Quad Buffered OpenGL ==
There is some experimental code for quad-buffered OpenGL if you build from source. I highly doubt it will work since I lack the hardware needed to test it - either a compatible nVidia Quadro or AMD Firepro and monitor - donations welcomed. :)

== Planned Features ==
* ''A vout-independent anaglyph combining filter.'' This will combine the images for both eyes into a single anaglyph image before being passed to the vout. This will make it possible to display stereoscopic content with non-stereoscopic-aware vouts.
* ''3D over HDMI.'' I will need to investigate this and experiment (nVidia 3DTV Play, AMD, non-Windows platforms).
* ''3D TV output.'' Non-HDMI 1.4 3D outputs - e.g. outputting side-by-side checkerboard, row interleaved, etc.
* ''Other proprietary shutter glasses''. For example e-Dimensional.
* ''More input features''. Column and row interleaved input sources.

== Troubleshooting & Support ==
There are several issues I am aware of. If you need support directly from me or have any enquiries then feel free to e-mail me directly at messiahandrw-at-gmail-dot-com (also mention Stereoscopic VLC in the subject so I don't mistake it for spam).

=== VLC Crashes when I click stop ===
I know about this bug and I'm trying to fix it, so stay tuned!

=== The frame rate is too slow ===
The stereoscopy module is alternating outputting left and right frames, because VLC starts to drop frames when I start doubling the frame rate. I'm working on a way around this (and if you're a developer I'd love for some input on this!)

=== My Video is black! ===
Either there's a bug I don't know about, or the stereoscopy module doesn't support your particular colour encoding. Check VLC's messages to see if anything is being reported (Tools > Messages). Either way, e-mail me and I'll get straight on to it!

=== 3D Vision isn't working ===
This could be any number of things:
* 3D Vision is not enabled in the nVidia control panel.
* You haven't renamed vlc.exe (see above).
* You're not using the Direct3D vout.
* The stereoscopy module is turned off.
* You don't have the latest nVidia drivers.

I'd love to solve your issue, but please check VLC's messages for any warnings and errors before contacting me.

SoC 2011/Stereoscopic Video

2011-09-05T00:50:04Z

MessiahAndrw: /* Developer notes */

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

Stereoscopic, or 3D, video support was implemented into the VLC Media Player as part of my Google Summer of Code project. It is currently experimental with a couple of bugs and I'm still actively working on it. At present you must build it from source, and I'm looking to soon merge it into the main tree.

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. https://github.com/MessiahAndrw/Stereoscopic-VLC

A build (that my be out of date by the time you read this) is available here: http://streams.videolan.org/misc/stereo/vlc-1.2.0-git-stereoscopy.zip�

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

Flags:
{| border="1"
|-
| STEREO_WAIT_FOR_NEXT_FRAME_BIT
| Do not present straight away and instead wait for the next frame.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

Mask i_eye by STEREO_EYE_MASK to get the eye number without any flags. It is possible that two images represent the same point in time (this is only untrue for field sequential video). If the STEREO_WAIT_FOR_NEXT_FRAME_BIT is set then the vout shouldn't present the frame straight away, but expect another picture immediately joining it representing the other eye at the same point of time, and display them together at once.

== nVidia 3D Vision ==
The focus of the Google SoC project has been on nVidia 3D Vision. To use 3D Vision you require the following:

* A compatible nVidia GPU
* nVidia 3D Vision Kit (the glasses you wear)
* A 120Hz LCD or 100Hz CRT monitor
* Windows

You also have to rename 'vlc.exe' since VLC isn't yet supported by the nVidia drivers. I'd recommend 'wow.exe' or 'googleearth.exe'. Also, make sure you have 3D Vision enabled in the nVidia control panel.

3D Vision will work straight out the box with the Direct3D (XP) vout. You don't need to do anything special, it'll activate as soon as the Direct3D vout starts receiving stereoscopic frames.

== Planned Features ==
* ''A vout-independent anaglyph combining filter.'' This will combine the images for both eyes into a single anaglyph image before being passed to the vout. This will make it possible to display stereoscopic content with non-stereoscopic-aware vouts.
* ''Quad-buffered OpenGL.'' This seems trivial enough to implement but I'll need a supporting video card!
* ''3D over HDMI.'' I will need to investigate this and experiment (nVidia 3DTV Play, AMD, non-Windows platforms).
* ''3D TV output.'' Non-HDMI 1.4 3D outputs - e.g. outputting side-by-side checkerboard, row interleaved, etc.
* ''Other proprietary shutter glasses''. For example e-Dimensional.
* ''More input features''. Column and row interleaved input sources.

== Troubleshooting & Support ==
There are several issues I am aware of. If you need support directly from me or have any enquiries then feel free to e-mail me directly at messiahandrw-at-gmail-dot-com (also mention Stereoscopic VLC in the subject so I don't mistake it for spam).

=== VLC Crashes when I click stop ===
I know about this bug and I'm trying to fix it, so stay tuned!

=== The frame rate is too slow ===
The stereoscopy module is alternating outputting left and right frames, because VLC starts to drop frames when I start doubling the frame rate. I'm working on a way around this (and if you're a developer I'd love for some input on this!)

=== My Video is black! ===
Either there's a bug I don't know about, or the stereoscopy module doesn't support your particular colour encoding. Check VLC's messages to see if anything is being reported (Tools > Messages). Either way, e-mail me and I'll get straight on to it!

=== 3D Vision isn't working ===
This could be any number of things:
* 3D Vision is not enabled in the nVidia control panel.
* You haven't renamed vlc.exe (see above).
* You're not using the Direct3D vout.
* The stereoscopy module is turned off.
* You don't have the latest nVidia drivers.

I'd love to solve your issue, but please check VLC's messages for any warnings and errors before contacting me.

SoC 2011/Stereoscopic Video

2011-09-05T00:49:44Z

MessiahAndrw: /* Developer notes */ mentioned about syncing with STEREO_WAIT_FOR_NEXT_FRAME_BIT

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

Stereoscopic, or 3D, video support was implemented into the VLC Media Player as part of my Google Summer of Code project. It is currently experimental with a couple of bugs and I'm still actively working on it. At present you must build it from source, and I'm looking to soon merge it into the main tree.

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. https://github.com/MessiahAndrw/Stereoscopic-VLC

A build (that my be out of date by the time you read this) is available here: http://streams.videolan.org/misc/stereo/vlc-1.2.0-git-stereoscopy.zip�

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

Flags:
{| border="1"
|-
| STEREO_WAIT_FOR_NEXT_FRAME_BIT
| Do not present straight away and instead wait for the next frame.
}}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

Mask i_eye by STEREO_EYE_MASK to get the eye number without any flags. It is possible that two images represent the same point in time (this is only untrue for field sequential video). If the STEREO_WAIT_FOR_NEXT_FRAME_BIT is set then the vout shouldn't present the frame straight away, but expect another picture immediately joining it representing the other eye at the same point of time, and display them together at once.

== nVidia 3D Vision ==
The focus of the Google SoC project has been on nVidia 3D Vision. To use 3D Vision you require the following:

* A compatible nVidia GPU
* nVidia 3D Vision Kit (the glasses you wear)
* A 120Hz LCD or 100Hz CRT monitor
* Windows

You also have to rename 'vlc.exe' since VLC isn't yet supported by the nVidia drivers. I'd recommend 'wow.exe' or 'googleearth.exe'. Also, make sure you have 3D Vision enabled in the nVidia control panel.

3D Vision will work straight out the box with the Direct3D (XP) vout. You don't need to do anything special, it'll activate as soon as the Direct3D vout starts receiving stereoscopic frames.

== Planned Features ==
* ''A vout-independent anaglyph combining filter.'' This will combine the images for both eyes into a single anaglyph image before being passed to the vout. This will make it possible to display stereoscopic content with non-stereoscopic-aware vouts.
* ''Quad-buffered OpenGL.'' This seems trivial enough to implement but I'll need a supporting video card!
* ''3D over HDMI.'' I will need to investigate this and experiment (nVidia 3DTV Play, AMD, non-Windows platforms).
* ''3D TV output.'' Non-HDMI 1.4 3D outputs - e.g. outputting side-by-side checkerboard, row interleaved, etc.
* ''Other proprietary shutter glasses''. For example e-Dimensional.
* ''More input features''. Column and row interleaved input sources.

== Troubleshooting & Support ==
There are several issues I am aware of. If you need support directly from me or have any enquiries then feel free to e-mail me directly at messiahandrw-at-gmail-dot-com (also mention Stereoscopic VLC in the subject so I don't mistake it for spam).

=== VLC Crashes when I click stop ===
I know about this bug and I'm trying to fix it, so stay tuned!

=== The frame rate is too slow ===
The stereoscopy module is alternating outputting left and right frames, because VLC starts to drop frames when I start doubling the frame rate. I'm working on a way around this (and if you're a developer I'd love for some input on this!)

=== My Video is black! ===
Either there's a bug I don't know about, or the stereoscopy module doesn't support your particular colour encoding. Check VLC's messages to see if anything is being reported (Tools > Messages). Either way, e-mail me and I'll get straight on to it!

=== 3D Vision isn't working ===
This could be any number of things:
* 3D Vision is not enabled in the nVidia control panel.
* You haven't renamed vlc.exe (see above).
* You're not using the Direct3D vout.
* The stereoscopy module is turned off.
* You don't have the latest nVidia drivers.

I'd love to solve your issue, but please check VLC's messages for any warnings and errors before contacting me.

SoC 2011/Stereoscopic Video

2011-09-04T03:17:06Z

MessiahAndrw:

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

Stereoscopic, or 3D, video support was implemented into the VLC Media Player as part of my Google Summer of Code project. It is currently experimental with a couple of bugs and I'm still actively working on it. At present you must build it from source, and I'm looking to soon merge it into the main tree.

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. https://github.com/MessiahAndrw/Stereoscopic-VLC

A build (that my be out of date by the time you read this) is available here: http://streams.videolan.org/misc/stereo/vlc-1.2.0-git-stereoscopy.zip�

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

== nVidia 3D Vision ==
The focus of the Google SoC project has been on nVidia 3D Vision. To use 3D Vision you require the following:

* A compatible nVidia GPU
* nVidia 3D Vision Kit (the glasses you wear)
* A 120Hz LCD or 100Hz CRT monitor
* Windows

You also have to rename 'vlc.exe' since VLC isn't yet supported by the nVidia drivers. I'd recommend 'wow.exe' or 'googleearth.exe'. Also, make sure you have 3D Vision enabled in the nVidia control panel.

3D Vision will work straight out the box with the Direct3D (XP) vout. You don't need to do anything special, it'll activate as soon as the Direct3D vout starts receiving stereoscopic frames.

== Planned Features ==
* ''A vout-independent anaglyph combining filter.'' This will combine the images for both eyes into a single anaglyph image before being passed to the vout. This will make it possible to display stereoscopic content with non-stereoscopic-aware vouts.
* ''Quad-buffered OpenGL.'' This seems trivial enough to implement but I'll need a supporting video card!
* ''3D over HDMI.'' I will need to investigate this and experiment (nVidia 3DTV Play, AMD, non-Windows platforms).
* ''3D TV output.'' Non-HDMI 1.4 3D outputs - e.g. outputting side-by-side checkerboard, row interleaved, etc.
* ''Other proprietary shutter glasses''. For example e-Dimensional.
* ''More input features''. Column and row interleaved input sources.

== Troubleshooting & Support ==
There are several issues I am aware of. If you need support directly from me or have any enquiries then feel free to e-mail me directly at messiahandrw-at-gmail-dot-com (also mention Stereoscopic VLC in the subject so I don't mistake it for spam).

=== VLC Crashes when I click stop ===
I know about this bug and I'm trying to fix it, so stay tuned!

=== The frame rate is too slow ===
The stereoscopy module is alternating outputting left and right frames, because VLC starts to drop frames when I start doubling the frame rate. I'm working on a way around this (and if you're a developer I'd love for some input on this!)

=== My Video is black! ===
Either there's a bug I don't know about, or the stereoscopy module doesn't support your particular colour encoding. Check VLC's messages to see if anything is being reported (Tools > Messages). Either way, e-mail me and I'll get straight on to it!

=== 3D Vision isn't working ===
This could be any number of things:
* 3D Vision is not enabled in the nVidia control panel.
* You haven't renamed vlc.exe (see above).
* You're not using the Direct3D vout.
* The stereoscopy module is turned off.
* You don't have the latest nVidia drivers.

I'd love to solve your issue, but please check VLC's messages for any warnings and errors before contacting me.

SoC 2011/Stereoscopic Video

2011-08-27T14:24:28Z

MessiahAndrw: /* nVidia 3D Vision */

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

Stereoscopic, or 3D, video support was implemented into the VLC Media Player as part of my Google Summer of Code project. It is currently experimental with a couple of bugs and I'm still actively working on it. At present you must build it from source, and I'm looking to soon merge it into the main tree.

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. https://github.com/MessiahAndrw/Stereoscopic-VLC

A build (that my be out of date by the time you read this) is available here: http://streams.videolan.org/misc/stereo/vlc-1.2.0-git-stereoscopy.zip�

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

== nVidia 3D Vision ==
The focus of the Google SoC project has been on nVidia 3D Vision. To use 3D Vision you require the following:

* A compatible nVidia GPU
* nVidia 3D Vision Kit (the glasses you wear)
* A 120Hz LCD or 100Hz CRT monitor
* Windows

You also have to rename 'vlc.exe' since VLC isn't yet supported by the nVidia drivers. I'd recommend 'wow.exe' or 'googleearth.exe'. Also, make sure you have 3D Vision enabled in the nVidia control panel.

3D Vision will work straight out the box with the Direct3D (XP) vout. You don't need to do anything special, it'll activate as soon as the Direct3D vout starts receiving stereoscopic frames.

== Planned Features ==
* ''A vout-independent anaglyph combining filter.'' This will combine the images for both eyes into a single anaglyph image before being passed to the vout. This will make it possible to display stereoscopic content with non-stereoscopic-aware vouts.
* ''Quad-buffered OpenGL.'' This seems trivial enough to implement but I'll need a supporting video card!
* ''3D over HDMI.'' I will need to investigate this and experiment (nVidia 3DTV Play, AMD, non-Windows platforms).
* ''Other proprietary shutter glasses'. For example e-Dimensional.

== Troubleshooting & Support ==
There are several issues I am aware of. If you need support directly from me or have any enquiries then feel free to e-mail me directly at messiahandrw-at-gmail-dot-com (also mention Stereoscopic VLC in the subject so I don't mistake it for spam).

=== VLC Crashes when I click stop ===
I know about this bug and I'm trying to fix it, so stay tuned!

=== The frame rate is too slow ===
The stereoscopy module is alternating outputting left and right frames, because VLC starts to drop frames when I start doubling the frame rate. I'm working on a way around this (and if you're a developer I'd love for some input on this!)

=== My Video is black! ===
Either there's a bug I don't know about, or the stereoscopy module doesn't support your particular colour encoding. Check VLC's messages to see if anything is being reported (Tools > Messages). Either way, e-mail me and I'll get straight on to it!

=== 3D Vision isn't working ===
This could be any number of things:
* 3D Vision is not enabled in the nVidia control panel.
* You haven't renamed vlc.exe (see above).
* You're not using the Direct3D vout.
* The stereoscopy module is turned off.
* You don't have the latest nVidia drivers.

I'd love to solve your issue, but please check VLC's messages for any warnings and errors before contacting me.

SoC 2011/Stereoscopic Video

2011-08-26T15:18:58Z

MessiahAndrw:

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

Stereoscopic, or 3D, video support was implemented into the VLC Media Player as part of my Google Summer of Code project. It is currently experimental with a couple of bugs and I'm still actively working on it. At present you must build it from source, and I'm looking to soon merge it into the main tree.

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. https://github.com/MessiahAndrw/Stereoscopic-VLC

A build (that my be out of date by the time you read this) is available here: http://streams.videolan.org/misc/stereo/vlc-1.2.0-git-stereoscopy.zip�

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

== nVidia 3D Vision ==
The focus of the Google SoC project has been on nVidia 3D Vision. To use 3D Vision you require the following:

* A compatible nVidia GPU
* nVidia 3D Vision Kit (the glasses you wear)
* A 120Hz LCD or 100Hz CRT monitor
* Windows

You also have to rename 'vlc.exe' since VLC isn't yet supported by the nVidia drivers. I'd recommend 'wow.exe' or 'googleearth.exe'. Also, make sure you have 3D Vision enabled in the nVidia control panel.

3D Vision will work straight out the box with the Direct3D vout. You don't need to do anything special, it'll activate as soon as the Direct3D vout starts receiving stereoscopic frames.

== Planned Features ==
* ''A vout-independent anaglyph combining filter.'' This will combine the images for both eyes into a single anaglyph image before being passed to the vout. This will make it possible to display stereoscopic content with non-stereoscopic-aware vouts.
* ''Quad-buffered OpenGL.'' This seems trivial enough to implement but I'll need a supporting video card!
* ''3D over HDMI.'' I will need to investigate this and experiment (nVidia 3DTV Play, AMD, non-Windows platforms).
* ''Other proprietary shutter glasses'. For example e-Dimensional.

== Troubleshooting & Support ==
There are several issues I am aware of. If you need support directly from me or have any enquiries then feel free to e-mail me directly at messiahandrw-at-gmail-dot-com (also mention Stereoscopic VLC in the subject so I don't mistake it for spam).

=== VLC Crashes when I click stop ===
I know about this bug and I'm trying to fix it, so stay tuned!

=== The frame rate is too slow ===
The stereoscopy module is alternating outputting left and right frames, because VLC starts to drop frames when I start doubling the frame rate. I'm working on a way around this (and if you're a developer I'd love for some input on this!)

=== My Video is black! ===
Either there's a bug I don't know about, or the stereoscopy module doesn't support your particular colour encoding. Check VLC's messages to see if anything is being reported (Tools > Messages). Either way, e-mail me and I'll get straight on to it!

=== 3D Vision isn't working ===
This could be any number of things:
* 3D Vision is not enabled in the nVidia control panel.
* You haven't renamed vlc.exe (see above).
* You're not using the Direct3D vout.
* The stereoscopy module is turned off.
* You don't have the latest nVidia drivers.

I'd love to solve your issue, but please check VLC's messages for any warnings and errors before contacting me.

SoC 2011/Stereoscopic Video

2011-08-26T14:38:57Z

MessiahAndrw: Introduction

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

Stereoscopic, or 3D, video support was implemented into the VLC Media Player as part of my Google Summer of Code project. It is currently experimental with a couple of bugs and I'm still actively working on it. At present you must build it from source, and I'm looking to soon merge it into the main tree.

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. [https://github.com/MessiahAndrw/Stereoscopic-VLC]

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

== nVidia 3D Vision ==
The focus of the Google SoC project has been on nVidia 3D Vision. To use 3D Vision you require the following:

* A compatible nVidia GPU
* nVidia 3D Vision Kit (the glasses you wear)
* A 120Hz LCD or 100Hz CRT monitor
* Windows

You also have to rename 'vlc.exe' since VLC isn't yet supported by the nVidia drivers. I'd recommend 'wow.exe' or 'googleearth.exe'. Also, make sure you have 3D Vision enabled in the nVidia control panel.

3D Vision will work straight out the box with the Direct3D vout. You don't need to do anything special, it'll activate as soon as the Direct3D vout starts receiving stereoscopic frames.

== Planned Features ==
* ''A vout-independent anaglyph combining filter.'' This will combine the images for both eyes into a single anaglyph image before being passed to the vout. This will make it possible to display stereoscopic content with non-stereoscopic-aware vouts.
* ''Quad-buffered OpenGL.'' This seems trivial enough to implement but I'll need a supporting video card!
* ''3D over HDMI.'' I will need to investigate this and experiment (nVidia 3DTV Play, AMD, non-Windows platforms).
* ''Other proprietary shutter glasses'. For example e-Dimensional.

== Troubleshooting & Support ==
There are several issues I am aware of. If you need support directly from me or have any enquiries then feel free to e-mail me directly at messiahandrw-at-gmail-dot-com (also mention Stereoscopic VLC in the subject so I don't mistake it for spam).

=== VLC Crashes when I click stop ===
I know about this bug and I'm trying to fix it, so stay tuned!

=== The frame rate is too slow ===
The stereoscopy module is alternating outputting left and right frames, because VLC starts to drop frames when I start doubling the frame rate. I'm working on a way around this (and if you're a developer I'd love for some input on this!)

=== My Video is black! ===
Either there's a bug I don't know about, or the stereoscopy module doesn't support your particular colour encoding. Check VLC's messages to see if anything is being reported (Tools > Messages). Either way, e-mail me and I'll get straight on to it!

=== 3D Vision isn't working ===
This could be any number of things:
* 3D Vision is not enabled in the nVidia control panel.
* You haven't renamed vlc.exe (see above).
* You're not using the Direct3D vout.
* The stereoscopy module is turned off.
* You don't have the latest nVidia drivers.

I'd love to solve your issue, but please check VLC's messages for any warnings and errors before contacting me.

SoC 2011/Stereoscopic Video

2011-08-26T14:30:53Z

MessiahAndrw: planned features, 3d vision

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. [https://github.com/MessiahAndrw/Stereoscopic-VLC]

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

== nVidia 3D Vision ==
The focus of the Google SoC project has been on nVidia 3D Vision. To use 3D Vision you require the following:

* A compatible nVidia GPU
* nVidia 3D Vision Kit (the glasses you wear)
* A 120Hz LCD or 100Hz CRT monitor
* Windows

You also have to rename 'vlc.exe' since VLC isn't yet supported by the nVidia drivers. I'd recommend 'wow.exe' or 'googleearth.exe'. Also, make sure you have 3D Vision enabled in the nVidia control panel.

3D Vision will work straight out the box with the Direct3D vout. You don't need to do anything special, it'll activate as soon as the Direct3D vout starts receiving stereoscopic frames.

== Planned Features ==
* ''A vout-independent anaglyph combining filter.'' This will combine the images for both eyes into a single anaglyph image before being passed to the vout. This will make it possible to display stereoscopic content with non-stereoscopic-aware vouts.
* ''Quad-buffered OpenGL.'' This seems trivial enough to implement but I'll need a supporting video card!
* ''3D over HDMI.'' I will need to investigate this and experiment (nVidia 3DTV Play, AMD, non-Windows platforms).
* ''Other proprietary shutter glasses'. For example e-Dimensional.

== Troubleshooting & Support ==
There are several issues I am aware of. If you need support directly from me or have any enquiries then feel free to e-mail me directly at messiahandrw-at-gmail-dot-com (also mention Stereoscopic VLC in the subject so I don't mistake it for spam).

=== VLC Crashes when I click stop ===
I know about this bug and I'm trying to fix it, so stay tuned!

=== The frame rate is too slow ===
The stereoscopy module is alternating outputting left and right frames, because VLC starts to drop frames when I start doubling the frame rate. I'm working on a way around this (and if you're a developer I'd love for some input on this!)

=== My Video is black! ===
Either there's a bug I don't know about, or the stereoscopy module doesn't support your particular colour encoding. Check VLC's messages to see if anything is being reported (Tools > Messages). Either way, e-mail me and I'll get straight on to it!

=== 3D Vision isn't working ===
This could be any number of things:
* 3D Vision is not enabled in the nVidia control panel.
* You haven't renamed vlc.exe (see above).
* You're not using the Direct3D vout.
* The stereoscopy module is turned off.
* You don't have the latest nVidia drivers.

I'd love to solve your issue, but please check VLC's messages for any warnings and errors before contacting me.

SoC 2011/Stereoscopic Video

2011-08-26T14:01:06Z

MessiahAndrw: /* Trouble shooting= */

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. [https://github.com/MessiahAndrw/Stereoscopic-VLC]

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

 

== nVidia 3D Vision ==

== non-nVidia 3D Vision ==

== Coming Soon ==

== Troubleshooting & Support ==
There are several issues I am aware of. If you need support directly from me or have any enquiries then feel free to e-mail me directly at messiahandrw-at-gmail-dot-com (also mention Stereoscopic VLC in the subject so I don't mistake it for spam).

=== VLC Crashes when I click stop ===
I know about this bug and I'm trying to fix it, so stay tuned!

=== The frame rate is too slow ===
The stereoscopy module is alternating outputting left and right frames, because VLC starts to drop frames when I start doubling the frame rate. I'm working on a way around this (and if you're a developer I'd love for some input on this!)

=== My Video is black! ===
Either there's a bug I don't know about, or the stereoscopy module doesn't support your particular colour encoding. Check VLC's messages to see if anything is being reported (Tools > Messages). Either way, e-mail me and I'll get straight on to it!

=== 3D Vision isn't working ===
This could be any number of things:
* 3D Vision is not enabled in the nVidia control panel.
* You haven't renamed vlc.exe (see above).
* You're not using the Direct3D vout.
* The stereoscopy module is turned off.

I'd love to solve your issue, but please check VLC's messages for any warnings and errors before contacting me.

SoC 2011/Stereoscopic Video

2011-08-26T11:02:02Z

MessiahAndrw: /* Input formats */

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. [https://github.com/MessiahAndrw/Stereoscopic-VLC]

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyg.jpg]]
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcf.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmf.jpg]]
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRightyf.jpg]]
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

 

== nVidia 3D Vision ==

== non-nVidia 3D Vision ==

== Coming Soon ==

== Trouble shooting= ==

File:StereoRightmf.jpg

2011-08-26T11:01:50Z

MessiahAndrw:

File:StereoRightyf.jpg

2011-08-26T10:59:47Z

MessiahAndrw:

File:StereoRightcf.jpg

2011-08-26T10:58:41Z

MessiahAndrw:

SoC 2011/Stereoscopic Video

2011-08-26T10:55:16Z

MessiahAndrw: /* Input formats */

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. [https://github.com/MessiahAndrw/Stereoscopic-VLC]

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightbg.jpg]]
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightcg.jpg]]
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightgg.jpg]]
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightmg.jpg]]
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftrg.jpg]]
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
|
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightyg.jpg]]
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
|
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
|
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

 

== nVidia 3D Vision ==

== non-nVidia 3D Vision ==

== Coming Soon ==

== Trouble shooting= ==

File:StereoRightyg.jpg

2011-08-26T10:55:02Z

MessiahAndrw:

File:StereoLeftrg.jpg

2011-08-26T10:53:04Z

MessiahAndrw:

File:StereoRightmg.jpg

2011-08-26T10:50:50Z

MessiahAndrw:

File:StereoRightgg.jpg

2011-08-26T10:48:13Z

MessiahAndrw:

File:StereoRightcg.jpg

2011-08-26T10:38:28Z

MessiahAndrw:

File:StereoRightbg.jpg

2011-08-26T10:31:57Z

MessiahAndrw:

SoC 2011/Stereoscopic Video

2011-08-26T10:28:56Z

MessiahAndrw: /* Input formats */

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. [https://github.com/MessiahAndrw/Stereoscopic-VLC]

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoRightc.jpg]]
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
| [[File:StereoRightg.jpg]]
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
| [[File:StereoRightm.jpg]]
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
| [[File:StereoLeftr.jpg]]
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
| [[File:StereoRighty.jpg]]
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
|
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
|
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
|
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
|
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
|
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
|
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
|
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
|
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
|
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

 

== nVidia 3D Vision ==

== non-nVidia 3D Vision ==

== Coming Soon ==

== Trouble shooting= ==

File:StereoRighty.jpg

2011-08-26T10:28:42Z

MessiahAndrw:

File:StereoLeftr.jpg

2011-08-26T10:26:45Z

MessiahAndrw:

File:StereoRightm.jpg

2011-08-26T10:25:53Z

MessiahAndrw:

File:StereoRightg.jpg

2011-08-26T10:24:57Z

MessiahAndrw:

File:StereoRightc.jpg

2011-08-26T10:23:05Z

MessiahAndrw:

SoC 2011/Stereoscopic Video

2011-08-26T07:28:17Z

MessiahAndrw: /* Input formats */

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. [https://github.com/MessiahAndrw/Stereoscopic-VLC]

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
| [[File:StereoRightb.jpg]]
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
|
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
|
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
|
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
|
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
|
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
|
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
|
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
|
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
|
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
|
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
|
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
|
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
|
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
|
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

 

== nVidia 3D Vision ==

== non-nVidia 3D Vision ==

== Coming Soon ==

== Trouble shooting= ==

File:StereoRightb.jpg

2011-08-26T07:27:38Z

MessiahAndrw:

SoC 2011/Stereoscopic Video

2011-08-26T07:25:51Z

MessiahAndrw: /* Input formats */

{{SoCProject|year=2011|student=[[User:MessiahAndrw|Andrew Price]]|mentor=[[User:j-b|Jean-Baptiste Kempf]]}}

== Building from Source ==

At the present state you must acquire the source code of the stereoscopic 3D branch and build it yourself. [https://github.com/MessiahAndrw/Stereoscopic-VLC]

There are build instructions in a file named 'STEREOSCOPY README' but I'll also repeat the instructions here.

=== Build Environment ===

I use 32-bit MSYS/x86 Windows 7. To set up your build environment first follow through the instructions on [Win32CompileMSYSNew] to make sure you're able to build VLC successfully on your system.

The following build instructions should work on any Windows system.

=== Building ===

Create a new empty directory somewhere, and at the MSYS terminal type:

git pull git://github.com/MessiahAndrw/Stereoscopic-VLC.git

To bootstrap the build I use the following:

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

Then to configure:

sh extras/package/win32/configure-msys.sh

Finally to build:

PATH=/usr/win32/bin:$PATH make package-win32 -j6

(The -j6 switch is optional and tells makefile to use 6 threads, it speeds up the build time on my 6-core machine.)

'make package-win32' will exit with the following error but that's normal and VLC has still been built:

cp: cannot stat `./npapi-vlc/installed/lib/npvlc.dll': No such file or directory

If everything else was successful you will now have built VLC with stereoscopic support! You will find this build in the directory 'vlc-1.2.0-git'.

=== Note on 3D Vision support ===

nVidia 3D Vision only activates for windowed-mode programs which are supported by the nVidia driver. At the present state VLC is not supported by the nVidia driver. However, the driver only performs a simple file-name check of the application, so as a workaround you can rename vlc.exe to the same file-name as a supported application. This can be done simply by:

cd vlc-1.2.0-git
mv vlc.exe wow.exe

== Splitting ==

To play a stereoscopic 3D video you must tell the stereoscopy module how to get the image for each eye. The stereoscopic module is takes a 2D input picture, and produces 2 output pictures (one for the left eye, and one for the right eye).

=== Command line ===

To enable the stereoscopic module you should add the following command line parameters when you start vlc:

--video-filter="stereoscopy" --stereoscopy-left="<left>" --stereoscopy-right="<right>"

Where <left> and <right> are valid input formats (see the table below).

=== QT4 ===

You can configure the stereoscopy module through the QT4 interface. To do this, open the 'Tools' menu and click on 'Effects and Filters'. In the 'Adjustments and Effects' dialog that opens navigate to the 'Video Effects' tab. Then find the sub-tab titled 'Stereoscopy'. Check 'Split' to enable the stereoscopy module to split the image into separate left and right frames. Select your video's input formats for the 'Left Eye and the 'Right Eye'.

[[File:StereoscopyoptionsQt4.png]]

 

=== Input formats ===

{| border="1"
|-
| Source
| Extracted Image
| Format name
| Description
|-
| [[File:StereoRb.jpg]]
|
| blue
| The eye is encoded into the blue channel of the image and returned as a blue image.
|-
| [[File:StereoRc.jpg]]
|
| cyan
| The eye is encoded into the blue and green channels of the image returned as a cyan image.
|-
| [[File:StereoRg.jpg]]
|
| green
| The eye is encoded into the green channel of the image and returned as a green image.
|-
| [[File:StereoGm.jpg]]
|
| magenta
| The eye is encoded into the red and blue channels of the image returned as a magenta image.
|-
| [[File:StereoRc.jpg]]
|
| red
| The eye is encoded into the red channel of the image and returned as a red image.
|-
| [[File:StereoBy.jpg]]
|
| yellow
| The eye is encoded into the red and green channels of the image returned as a yellow image.
|-
| [[File:StereoRb.jpg]]
|
| blue-gray
| The eye is encoded into the blue channel and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
|
| cyan-gray
| The eye is encoded into the blue and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRg.jpg]]
|
| green-gray
| The eye is encoded into the green channel of the image and returned as a grayscale image.
|-
| [[File:StereoGm.jpg]]
|
| magenta-gray
| The eye is encoded into the red and blue channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
|
| red-gray
| The eye is encoded into the red channel of the image and returned a grayscale image.
|-
| [[File:StereoBy.jpg]]
|
| yellow-gray
| The eye is encoded into the red and green channels of the image and returned as a grayscale image.
|-
| [[File:StereoRc.jpg]]
|
| cyan-fill
| The eye is encoded into the blue and green channels of the image and returned as a full colour image. The missing red channel is filled in with the average of the blue and green channels.
|-
| [[File:StereoGm.jpg]]
|
| magenta-fill
| The eye is encoded into the red and blue channels of the image and returned as a full colour image. The missing green channel is filled in with the average of the red and blue channels.
|-
| [[File:StereoBy.jpg]]
|
| yellow-fill
| The eye is encoded into the red and green channels of the image and returned as a full colour image. The missing blue channel is filled in with the average of the red and green channels.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoLeft.jpg]]
| left
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoLr.jpg]]
| [[File:StereoRight.jpg]]
| right
| The eye is encoded into the left half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoLeft.jpg]]
| top
| The eye is encoded into the right half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|-
| [[File:StereoTb.jpg]]
| [[File:StereoRight.jpg]]
| bottom
| The eye is encoded into the bottom half of the image. Assumes the source is half-SBS but the aspect ratio will need to be halved for full-SBS.
|}

=== Developer notes ===

picture_t contains a new field i_eye that is the eye the picture represents. Valid values at the moment are:

{| border="1"
|-
| 0
| The picture is 2D.
|-
| 1
| The picture is destined for the left eye.
|-
| 2
| The picture is destined for the right eye.
|}

The default value for i_eye is 0, and all present video codecs output frames where i_eye is 0. It is up to the stereoscopy module to split it into left and right. But it's possible for someone to develop a video codec that output pictures where i_eye>0, for example for a container format where the data is stored as separate left/right images. In this case the stereoscopy module does nothing, and forwards the pictures on as is.

 

== nVidia 3D Vision ==

== non-nVidia 3D Vision ==

== Coming Soon ==

== Trouble shooting= ==

File:StereoTb.jpg

2011-08-26T07:25:28Z

MessiahAndrw:

File:StereoLr.jpg

2011-08-26T07:23:46Z

MessiahAndrw:

File:StereoRight.jpg

2011-08-26T07:23:32Z

MessiahAndrw:

File:StereoLeft.jpg

2011-08-26T07:21:58Z

MessiahAndrw:

File:StereoBy.jpg

2011-08-26T07:15:29Z

MessiahAndrw:

File:StereoGm.jpg

2011-08-26T07:14:14Z

MessiahAndrw:

File:StereoRg.jpg

2011-08-26T07:13:19Z

MessiahAndrw:

File:StereoRc.jpg

2011-08-26T07:12:40Z

MessiahAndrw:

File:StereoRb.jpg

2011-08-26T07:12:05Z

MessiahAndrw:

SoC 2011/Stereoscopic Video

2011-08-26T07:07:02Z

MessiahAndrw:

File:StereoscopyoptionsQt4.png

2011-08-26T07:05:38Z

MessiahAndrw: The stereoscopy options for the QT4 gui.

The stereoscopy options for the QT4 gui.

3D

2011-08-26T06:25:33Z

MessiahAndrw:

The intention of this page is to describe how to use VLC to watch 3D video. Please add to it if you can.

==3D Display Technologies==

Generally there are three widely use 3D display technologies, all based on the principles of stereoscopic projection:

* [http://en.wikipedia.org/wiki/Anaglyph_image Anaglyph] - red/green or red/blue images with glasses filtering out one colour or the other
* Polarisation - technique used in cinemas, with two images projected with different polarisations, a silvered screen and polarised glasses
* [http://en.wikipedia.org/wiki/Liquid_crystal_shutter_glasses Shutter Glasses] - technique used by the new 3D televisions, where each alternating frame represent the left or right views.

==Video formats supporting 3D==

to do

==How to view 3D videos in VLC==

See [[SoC 2011/Stereoscopic Video]].

==Related Pages==

* [http://en.wikipedia.org/wiki/Multiview_Video_Coding Multiview Video Coding]
* [http://en.wikipedia.org/wiki/Stereoscopy Stereoscopy]
* [http://netblender.ning.com/forum/topics/bluray-3d-sample-disc-encoded Blu-ray 3D sample disc encoded and authored with DoStudio]
* [http://www.avsforum.com/avs-vb/showthread.php?t=1176599 BD 3D details start to trickle out...] - forum posting
* [http://www.youtube.com/watch?v=5ANcspdYh_U YouTube in 3D]
{{stub}}