/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s): Shane Stephens (CSIRO), Michael Martin
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef __PLUGIN_H__
#define __PLUGIN_H__

#include "pluginbase.h"
#include "nsScriptablePeer.h"
#include "nsIServiceManager.h"
#include "std_semaphore.h"

#if defined(XP_UX)
#include <X11/Xlib.h>
#include <X11/Intrinsic.h>
#include <gtk/gtk.h>
#endif

#include <vector>
 
class nsPluginInstance : public nsPluginInstanceBase
{
public:
  nsPluginInstance(NPP aInstance, const char *source);
  ~nsPluginInstance();

  NPBool init(NPWindow* aWindow);
  void shut();
  NPBool isInitialized();

  // we need to provide implementation of this method as it will be
  // used by Mozilla to retrive the scriptable peer
  // and couple of other things on Unix
  NPError	GetValue(NPPVariable variable, void *value);

  uint16 HandleEvent(void *aEvent);
  NPError SetWindow(NPWindow *aWindow);
  NPError NewStream(NPMIMEType type, NPStream* stream,  
			NPBool seekable, uint16* stype);    

#if defined (XP_MACOSX) || defined(XP_WIN)
  // wrapper method (for MACOSX and Win32 only)   
  // this is used only in Win32 and MACOSX version of the plugin
  // to pass back CMML callback and associated data to Javascript  
  void executeCmmlCallback();
#endif

  nsScriptablePeer* getScriptablePeer();

  // Javascript API
  void    getVersionString(
            char **versionString, int apiVersionMajor, int apiVersionMinor
          );
  void    play();
  void    pause();
  void    restart();  
  short   getCurrentState();
  void    setCurrentMovie(const char *URL);
  char  * getCurrentMovie();
  bool    setPlayPosition(long milliseconds);
  long    getPlayPosition();
  void    setVolume(float volume);
  float   getVolume();
  long    getWindowWidth();
  long    getWindowHeight();
  long    getBufferedTime();
  long    getMovieLength();
  bool    retrieveAnnotations(nsILibOggCallbackString *cbObj);

  void    freezePlaylistProgression();
  void    unfreezePlaylistProgression();
  long    getPlaylistLength();
  long    getCurrentPlaylistPosition();
  bool    playMovieAt(long position);
  bool    playlistNext();
  bool    playlistPrev();
  char  * getMovieAt(long position);
  bool    setMovieAt(long position, const char *url);
  void    appendMovie(const char *url);
  bool    insertMovieBefore(long position, const char *url);
  bool    removeMovieAt(long position);
  bool    retrieveAnnotationsAt(long position,
                                      nsILibOggCallbackString *cbObj);
  long    getMovieLengthAt(long position);

  void    registerCMMLCallback(nsILibOggCallbackString *cbObj);
  void    registerEndPlayCallback(nsILibOggCallbackNoArg *cbObj);
  void    registerPlaylistCallback(nsILibOggCallbackNoArg *cbObj);
  void    registerOnMouseClickCallback(nsILibOggCallbackNoArg *cbObj);
  void    onCMMLData(char **cmml_data, int cmml_size, int async);
  void    onEndOfMovie();
  void    onMovieDownload();
  void    onMouseClick();

  // This is only public so the Windows "heartbeat" function can
  // access it. If you're not PluginCallbackProc, don't touch!
  void    processCrossThreadCalls(bool useSemaphore);

private:
  void    clearCmmlStrings();
  char  * curMovie() const;
  bool    playlistIndexOk(long index) const;
  int     playlistLastIndex() const;

  NPP                         mInstance;
  bool                        mPluginInitialised;
  bool                        mWindowInitialised;
  NPWindow                  * mWindow;
  nsScriptablePeer          * mScriptablePeer;
  void                      * mOggHandle;
  void                      * mGuiHandle;
  nsIServiceManager         * mServiceManager;
  char                      * mProxyHost;
  int                         mProxyPort;
  std::vector<char*>          mPlaylist;
  int                         mPlaylistPos;
  bool                        mPlaylistFreeze;
  bool                        mPlaylistFrozen;
  bool                        mReachedEndOfMovie;
  bool                        mMouseButtonDown;
  std::vector<char*>          mCmmlStrings;
  char                      * mAsyncCmmlString;
  nsILibOggCallbackString   * mCmmlCallback;
  nsILibOggCallbackString   * mAsyncCmmlCallback;
  nsILibOggCallbackNoArg    * mEndPlayCallback;
  nsILibOggCallbackNoArg    * mPlaylistCallback;
  nsILibOggCallbackNoArg    * mMouseClickCallback;
  semaphore                   mCrossThreadSem;

#if defined(XP_WIN)
  bool                        mPollingStarted;
  UINT                        mPollingPeriod;  
#elif defined(XP_MACOSX)
  bool                        mOutputCleared;
#endif
};

#endif // __PLUGIN_H__