DSVMR9 Plugin - DirectShow using VMR9 in Ogre
Author: Stefano "Pagghiu" Cristiano (spagghiu@yahoo.it)

The code is not very clean, I'm forcing myself to release in hope
this will be useful to someone.

Follow the thread in the forums

FFDShow Problems

Remember prevent FFDShow from inserting its filters in the graph when using VMR9 as it causes some strange problems with videos.

Downloads and History

  • 0.1: DSVMR9_0.1.zip initial relase
  • 0.2: DSVMR9_0.2.zip manteniance release
    • Now searches for files in DEFAULT_RESOURCE_GROUP_NAME. Needs to be generalized to load from custom resource groups?
    • Now creates textures and dshow vmr9 streamer only if the material is actually loaded and not only parsed (see OgreDSVMR9Texture::UpdateTexture() ). Need to find a better way of doing this however...
    • Improved handling of some strange camera pixel formats I've been struggling with
    • Fixed various bugs and general cleanup of code

License

This editor is available under the same licensing scheme as the OGRE
engine i.e. the GNU Lesser Public License (LGPL).

If you use it please drop me a note just to let me be happy about it ;D

I'm not responsible for your crazy ways of using this code.

Introduction

This sample implements a link between Video Mixing Renderer 9, an user
mode OS component available since Windows Xp SP2 that allows to render
directshow video content directly into a Direct3D 9 Texture.
This makes use of some hardware accelerating capabilities available
on modern video card for video decoding/deinterlacing.
This limits the usage of plugin only with the Direct3D9 rendersystem,
but that's it,is not possibile to use VMR9 in opengl.
Obviously you need very good reason to use this plugin instead of
other available for ogre (Theora,etc.) as you have to stick with
a fixed rendersystem (D3d) and platform (windows).

Features

  • Stream images from arbitrary number of .avi files
  • Stream images from arbitrary number of webcams
  • Hardware accelerated de-interlacing and decoding
  • Pixel format conversion for some formats

Usage

You can use this plugin as an external texture source and specify
various options:

  • filename: filename of the video to be played (.avi or anything supported by an installed directshow filter)
  • camera_number: number of camera
  • use_vmr9: true/false whether to use vrm9 or stick with standard classic directshow "grab to dynamic texture" approach (to disable vrm9 in case of problems)
  • use_yuvmixing: true/false whether to use accelerated yuv mixing (to disable hw accel mixing in case of problems)
  • capture: true/false set this to false if you don't need to software process frames captured from camera or video file. If you set this to true, is probably smarter disabling also vrm9 setting user_vrm9 to false.




when capture is true you can register a callback like this

OgreDSVMR9Controller* WebcamCtrl;
....
    WebcamCtrl->getTextureByMaterialName("Plane/Background")->addCaptureFrameListerner(m_listener);
....

    void newFrame(OgreDSVMR9* webcam)
    {
        OgreDSVMR9::LockStruct myLock;
        if(!webcam->Lock(&myLock))
            return;

        webcam->Unlock();
    }

...
    WebcamCtrl->getTextureByMaterialName("Plane/Background")->removeCaptureListener(m_listener);


with LockStruct a struct that has everything you need to software process the grabbed grame (maybe can be refactored using Ogre::pixelbox?)

struct LockStruct
        {
            BYTE*    buffer;
            DWORD    bufferSize;
            int        width;
            int        height;
            bool    interlaced;
            PixelFormat pixelFormat;
        };

Examples


material Plane/Background
{
    technique
    {
        pass
        {
            cull_hardware none
            cull_software none

            depth_write off
            depth_check off

            lighting off

            texture_unit
            {
                texture_source dsvmr9_video
                {
                        camera_number 0 //Defines which webcam to use.
                        use_vmr9 true
                        use_yuvmixing true
                        capture false
                }
            }
        }
    }
}

material Ogre/Skin
{
    technique
    {
        pass
        {
            ambient 0.7 0.7 0.7
            cull_hardware none

            texture_unit
            {
                //texture GreenSkin.jpg
                texture_source dsvmr9_video
                {
                        use_vmr9 true
                        use_yuvmixing true
                        capture false
                        filename PANASONIC_TRAVE_1.avi

                }
                tex_address_mode mirror
            }
        }
    }
}

Notes on source code

Sources that interact with DirectShow and VMR9 are in a library
called 'DSVMR9' and gets compiled as a static .lib.
This library is linked to the ogre plugin "DSVMR9_Ogre" that provides
transparent access to VMR9.

This ogre plugin interface has been developed following the code shown in
http://www.ogre3d.org/phpBB2/viewtopic.php?t=16572

To make VMR9 work obviously you can't use the OpenGL renderer.
the Library can also be configured to act just like a normal directshow
grabbing plugin (changing a flag called mbUseVMR9 in OgreDSVMR9.cpp but
in this case is better use other plugins)

Compiling

I've used Microsoft Visual Studio 2005 Professional SP1

DSVMR9_Ogre

To compile "DSVMR9_Ogre" plugin you need

  • Ogre :-D (i've used version 1.4.5)
  • DSVMR9 Libray (comes already compiled in Code\src\DSVMR9\lib)
  • DirectX SDK Headers (you can use any recent version)



DSVMR9

If you need to recompile DSVMR9,the procedure is a bit more involved as you need:

  • Windows SDK:


download on msdn http://www.microsoft.com/downloads/details.aspx?FamilyId=0BAF2B35-C656-4969-ACE8-E4C0C0716ADB&displaylang=en
You must build the DirectShow Base classes (in \WindowsSDK\Samples\Multimedia\DirectShow\BaseClasses)

  • DXSDK:


The DirectX SDK available http://msdn.microsoft.com/directx/sdk/

  • DXSDK Old version:


you need some header of an old version of the dxsdk to successfully compile the directshow base classes...
maybe this is fixed in the new Windows SDK for vista because they are missing,but i've not checked it.

the headers are:

  • d3d.h
  • d3dcaps.h
  • d3drm.h
  • d3drmdef.h
  • d3drmobj.h
  • d3drmwin.h
  • d3dtypes.h
  • dxtrans.h

Directory structure

The directory structure of this package is

  • Bin: binaries
  • Code
    • Src
      • DSVMR9: the library that uses directshow
      • Ogre
        • Plugins
          • DSVMR9: the ogre plugin
        • Samples
          • DSVMR9_Ogre: a sample
  • Dependencies: on my system I like to have all dependencies here :-)

Sample

You can just run the demo in bin\Demo_DSVMR9Ogre.exe
If everything works, you will see three panels.
The first, big one, is connected to first camera available to the
sistem.
The other two panels are connected to a second camera and to a
streaming .avi video in xvid format.
If you have FFDShow installed be sure to prevent him from inserting
its filters into the dshow graph.
I tested the camera code only with my Sony Handycam Firewire camera
(DCR HC96E) and a simple Logitech Quickcam.
It may crash on other system/configuration.

<HR>
Creative Commons Copyright -- Some rights reserved.


THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

1. Definitions

  • "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
  • "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
  • "Licensor" means the individual or entity that offers the Work under the terms of this License.
  • "Original Author" means the individual or entity who created the Work.
  • "Work" means the copyrightable work of authorship offered under the terms of this License.
  • "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
  • "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.

2. Fair Use Rights

Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.

3. License Grant

Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:

  • to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
  • to create and reproduce Derivative Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
  • For the avoidance of doubt, where the work is a musical composition:
    • Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
    • Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
    • Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).


The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.

4. Restrictions

The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

  • You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
  • You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
  • If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.

5. Representations, Warranties and Disclaimer

UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.

6. Limitation on Liability.

EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. Termination

  • This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
  • Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.

8. Miscellaneous

  • Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
  • Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
  • If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
  • No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
  • This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.