vlcshell.cpp 13.5 KB
Newer Older
1
/*****************************************************************************
2
 * vlcshell.cpp: a VLC plugin for Mozilla
3
 *****************************************************************************
Jean-Paul Saman's avatar
Jean-Paul Saman committed
4
 * Copyright (C) 2002-2009 the VideoLAN team
5
 * $Id$
6 7
 *
 * Authors: Samuel Hocevar <sam@zoy.org>
8
 *          Jean-Paul Saman <jpsaman@videolan.org>
9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 24 25 26 27
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
28 29 30 31 32

#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

33 34
#include <stdio.h>
#include <string.h>
35
#include <stdlib.h>
36

37
#include "vlcplugin.h"
38
#include "vlcshell.h"
39

40 41 42 43

/******************************************************************************
 * UNIX-only API calls
 *****************************************************************************/
44
NPP_GET_MIME_CONST char * NPP_GetMIMEDescription( void )
45
{
46
    return mimetype;
47 48 49 50
}

NPError NPP_GetValue( NPP instance, NPPVariable variable, void *value )
{
51
    static char psz_name[] = PLUGIN_NAME;
Sam Hocevar's avatar
Sam Hocevar committed
52
    static char psz_desc[1000];
53

54
    /* plugin class variables */
55 56 57
    switch( variable )
    {
        case NPPVpluginNameString:
58
            *((char **)value) = psz_name;
59 60 61
            return NPERR_NO_ERROR;

        case NPPVpluginDescriptionString:
62
            snprintf( psz_desc, sizeof(psz_desc), PLUGIN_DESCRIPTION,
63
                      libvlc_get_version() );
Sam Hocevar's avatar
Sam Hocevar committed
64
            *((char **)value) = psz_desc;
65
            return NPERR_NO_ERROR;
Sam Hocevar's avatar
Sam Hocevar committed
66

67 68 69 70 71 72
#if defined(XP_UNIX)
        case NPPVpluginNeedsXEmbed:
            *((bool *)value) = true;
            return NPERR_NO_ERROR;
#endif

Sam Hocevar's avatar
Sam Hocevar committed
73
        default:
74
            /* move on to instance variables ... */
75
            ;
76 77 78 79 80 81 82
    }

    if( instance == NULL )
    {
        return NPERR_INVALID_INSTANCE_ERROR;
    }

83
    /* plugin instance variables */
84

85
    VlcPluginBase *p_plugin = reinterpret_cast<VlcPluginBase *>(instance->pdata);
86
    if( NULL == p_plugin )
87
    {
88
        /* plugin has not been initialized yet ! */
89 90
        return NPERR_INVALID_INSTANCE_ERROR;
    }
91

92 93
    switch( variable )
    {
94
        case NPPVpluginScriptableNPObject:
95
        {
96 97 98
            /* retrieve plugin root class */
            NPClass *scriptClass = p_plugin->getScriptClass();
            if( scriptClass )
99
            {
100 101 102
                /* create an instance and return it */
                *(NPObject**)value = NPN_CreateObject(instance, scriptClass);
                return NPERR_NO_ERROR;
103 104
            }
            break;
105
        }
106

107
        default:
108
            ;
109
    }
110
    return NPERR_GENERIC_ERROR;
111 112
}

113 114 115 116 117
/*
 * there is some confusion in gecko headers regarding definition of this API
 * NPPVariable is wrongly defined as NPNVariable, which sounds incorrect.
 */

118
NPError NPP_SetValue( NPP, NPNVariable, void * )
119 120 121 122
{
    return NPERR_GENERIC_ERROR;
}

123 124 125 126 127
/******************************************************************************
 * General Plug-in Calls
 *****************************************************************************/
NPError NPP_Initialize( void )
{
128 129 130 131 132 133 134 135 136 137 138
#ifdef XP_UNIX
    NPError err = NPERR_NO_ERROR;
    bool supportsXEmbed = false;

    err = NPN_GetValue( NULL, NPNVSupportsXEmbedBool,
                        (void *)&supportsXEmbed );

    if ( err != NPERR_NO_ERROR || supportsXEmbed != true )
        return NPERR_INCOMPATIBLE_VERSION_ERROR;
#endif

139 140 141 142 143 144 145 146
    return NPERR_NO_ERROR;
}

void NPP_Shutdown( void )
{
    ;
}

147 148 149 150 151 152
static bool boolValue(const char *value) {
    return ( !strcmp(value, "1") ||
             !strcasecmp(value, "true") ||
             !strcasecmp(value, "yes") );
}

153
NPError NPP_New( NPMIMEType, NPP instance,
154
                 NPuint16_t mode, NPint16_t argc,
155
                 char* argn[], char* argv[], NPSavedData* )
156
{
157
    NPError status;
158
    VlcPluginBase *p_plugin;
159 160 161 162 163 164

    if( instance == NULL )
    {
        return NPERR_INVALID_INSTANCE_ERROR;
    }

165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
    /* we need to tell whether the plugin will be windowless
     * before it is instantiated */
    bool windowless = false;
    for( int i = 0; i < argc; i++ )
    {
        if( !strcmp( argn[i], "windowless" ) )
        {
            windowless = boolValue(argv[i]);
            break;
        }
    }

#ifdef WINDOWLESS
    if( windowless )
    {
        /* set windowless flag */
        status = NPN_SetValue( instance, NPPVpluginWindowBool,
                                       (void *)false);
        if( NPERR_NO_ERROR != status )
        {
            return status;
        }
        status = NPN_SetValue( instance, NPPVpluginTransparentBool,
                                       (void *)false);
        if( NPERR_NO_ERROR != status )
        {
            return status;
        }

        p_plugin = new VlcWindowless( instance, mode );
    }
    else
#endif
    {
        p_plugin = new VlcPlugin( instance, mode );
    }
201
    if( NULL == p_plugin )
202 203 204 205
    {
        return NPERR_OUT_OF_MEMORY_ERROR;
    }

206
    status = p_plugin->init(argc, argn, argv);
207 208
    if( NPERR_NO_ERROR == status )
    {
209
        instance->pdata = reinterpret_cast<void*>(p_plugin);
210
    }
211 212
    else
    {
213 214
        delete p_plugin;
    }
215
    return status;
216 217
}

218
NPError NPP_Destroy( NPP instance, NPSavedData** )
219
{
220
    if( NULL == instance )
221 222
        return NPERR_INVALID_INSTANCE_ERROR;

223
    VlcPluginBase *p_plugin = reinterpret_cast<VlcPluginBase *>(instance->pdata);
224 225 226 227
    if( NULL == p_plugin )
        return NPERR_NO_ERROR;

    instance->pdata = NULL;
228

229 230
    if( p_plugin->playlist_isplaying() )
        p_plugin->playlist_stop();
231

232
    delete p_plugin;
233 234 235 236 237 238

    return NPERR_NO_ERROR;
}

NPError NPP_SetWindow( NPP instance, NPWindow* window )
{
239
    if( ! instance )
240 241 242 243
    {
        return NPERR_INVALID_INSTANCE_ERROR;
    }

244
    /* NPP_SetWindow may be called before NPP_New (Opera) */
245
    VlcPluginBase *p_plugin = reinterpret_cast<VlcPluginBase *>(instance->pdata);
246
    if( NULL == p_plugin )
247 248 249 250
    {
        /* we should probably show a splash screen here */
        return NPERR_NO_ERROR;
    }
Jean-Paul Saman's avatar
Jean-Paul Saman committed
251

252
    p_plugin->getVLC();
253

254 255 256 257 258 259 260 261
    /*
     * PLUGIN DEVELOPERS:
     *  Before setting window to point to the
     *  new window, you may wish to compare the new window
     *  info to the previous window (if any) to note window
     *  size changes, etc.
     */

262
    /* retrieve current window */
263
    NPWindow& curr_window = p_plugin->getWindow();
264

265
    if (window/* && window->window */) {
266 267
        if (!curr_window.window) {
            /* we've just been created */
268
            p_plugin->setWindow(*window);
269 270
            p_plugin->create_windows();
            p_plugin->resize_windows();
271
            p_plugin->set_player_window();
272 273

            /* now set plugin state to that requested in parameters */
274 275
            bool show_toolbar = p_plugin->get_options().get_show_toolbar();
            p_plugin->set_toolbar_visible( show_toolbar );
276 277 278 279 280 281 282 283

            /* handle streams properly */
            if( !p_plugin->b_stream )
            {
                if( p_plugin->psz_target )
                {
                    if( p_plugin->playlist_add( p_plugin->psz_target ) != -1 )
                    {
284
                        if( p_plugin->get_options().get_autoplay() )
285 286 287 288 289 290 291
                        {
                            p_plugin->playlist_play();
                        }
                    }
                    p_plugin->b_stream = true;
                }
            }
292 293

            p_plugin->update_controls();
294 295 296
        } else {
            if (window->window == curr_window.window) {
                /* resize / move notification */
297
                p_plugin->setWindow(*window);
298 299
                p_plugin->resize_windows();
            } else {
300
                /* plugin parent window was changed, notify plugin about it */
301 302 303 304
                p_plugin->destroy_windows();
                p_plugin->setWindow(*window);
                p_plugin->create_windows();
                p_plugin->resize_windows();
305
            }
306
        }
307
    } else {
308 309
        /* NOTE: on Windows, Opera does not call NPP_SetWindow
         * on window destruction. */
310 311 312 313
        if (curr_window.window) {
            /* we've been destroyed */
            p_plugin->destroy_windows();
        }
314
    }
315 316 317
    return NPERR_NO_ERROR;
}

318 319
NPError NPP_NewStream( NPP instance, NPMIMEType, NPStream *stream,
                       NPBool, NPuint16_t *stype )
320
{
321
    if( NULL == instance  )
322 323 324 325
    {
        return NPERR_INVALID_INSTANCE_ERROR;
    }

326
    VlcPluginBase *p_plugin = reinterpret_cast<VlcPluginBase *>(instance->pdata);
327 328 329 330
    if( NULL == p_plugin )
    {
        return NPERR_INVALID_INSTANCE_ERROR;
    }
331

332 333 334 335 336 337 338 339
   /*
   ** Firefox/Mozilla may decide to open a stream from the URL specified
   ** in the SRC parameter of the EMBED tag and pass it to us
   **
   ** since VLC will open the SRC URL as well, we're not interested in
   ** that stream. Otherwise, we'll take it and queue it up in the playlist
   */
    if( !p_plugin->psz_target || strcmp(stream->url, p_plugin->psz_target) )
340
    {
341 342 343
        /* TODO: use pipes !!!! */
        *stype = NP_ASFILEONLY;
        return NPERR_NO_ERROR;
344
    }
345
    return NPERR_GENERIC_ERROR;
346 347
}

348
NPint32_t NPP_WriteReady( NPP, NPStream *)
349
{
350 351
    /* TODO */
    return 8*1024;
352 353
}

354 355
NPint32_t NPP_Write( NPP, NPStream *, NPint32_t,
                 NPint32_t len, void * )
356
{
357 358
    /* TODO */
    return len;
359 360
}

361
NPError NPP_DestroyStream( NPP instance, NPStream *, NPError )
362 363 364 365 366 367 368 369
{
    if( instance == NULL )
    {
        return NPERR_INVALID_INSTANCE_ERROR;
    }
    return NPERR_NO_ERROR;
}

370
void NPP_StreamAsFile( NPP instance, NPStream *stream, const char* )
371 372 373 374 375 376
{
    if( instance == NULL )
    {
        return;
    }

377
    VlcPluginBase *p_plugin = reinterpret_cast<VlcPluginBase *>(instance->pdata);
378 379 380 381
    if( NULL == p_plugin )
    {
        return;
    }
382

383
    if( p_plugin->playlist_add( stream->url ) != -1 )
384
    {
385
        if( p_plugin->get_options().get_autoplay() )
386
        {
387
            p_plugin->playlist_play();
388 389
        }
    }
390
}
391

392 393
void NPP_URLNotify( NPP instance, const char* ,
                    NPReason, void* )
394 395 396 397 398 399 400 401 402 403
{
    /***** Insert NPP_URLNotify code here *****\
    PluginInstance* p_plugin;
    if (instance != NULL)
        p_plugin = (PluginInstance*) instance->pdata;
    \*********************************************/
}

void NPP_Print( NPP instance, NPPrint* printInfo )
{
404 405
    if( printInfo == NULL )
    {
406
        return;
407
    }
408

409 410 411
    if( instance != NULL )
    {
        /***** Insert NPP_Print code here *****\
412
        PluginInstance* p_plugin = (PluginInstance*) instance->pdata;
413
        \**************************************/
414

415 416
        if( printInfo->mode == NP_FULL )
        {
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
            /*
             * PLUGIN DEVELOPERS:
             *  If your plugin would like to take over
             *  printing completely when it is in full-screen mode,
             *  set printInfo->pluginPrinted to TRUE and print your
             *  plugin as you see fit.  If your plugin wants Netscape
             *  to handle printing in this case, set
             *  printInfo->pluginPrinted to FALSE (the default) and
             *  do nothing.  If you do want to handle printing
             *  yourself, printOne is true if the print button
             *  (as opposed to the print menu) was clicked.
             *  On the Macintosh, platformPrint is a THPrint; on
             *  Windows, platformPrint is a structure
             *  (defined in npapi.h) containing the printer name, port,
             *  etc.
             */

434
            /***** Insert NPP_Print code here *****\
435 436 437 438
            void* platformPrint =
                printInfo->print.fullPrint.platformPrint;
            NPBool printOne =
                printInfo->print.fullPrint.printOne;
439
            \**************************************/
440 441

            /* Do the default*/
442
            printInfo->print.fullPrint.pluginPrinted = false;
443
        }
444 445 446
        else
        {
            /* If not fullscreen, we must be embedded */
447 448 449 450 451 452 453 454 455 456 457 458
            /*
             * PLUGIN DEVELOPERS:
             *  If your plugin is embedded, or is full-screen
             *  but you returned false in pluginPrinted above, NPP_Print
             *  will be called with mode == NP_EMBED.  The NPWindow
             *  in the printInfo gives the location and dimensions of
             *  the embedded plugin on the printed page.  On the
             *  Macintosh, platformPrint is the printer port; on
             *  Windows, platformPrint is the handle to the printing
             *  device context.
             */

459
            /***** Insert NPP_Print code here *****\
460 461 462 463
            NPWindow* printWindow =
                &(printInfo->print.embedPrint.window);
            void* platformPrint =
                printInfo->print.embedPrint.platformPrint;
464
            \**************************************/
465 466 467
        }
    }
}
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484

int16_t NPP_HandleEvent( NPP instance, void * event )
{
    if( instance == NULL )
    {
        return false;
    }

    VlcPluginBase *p_plugin = reinterpret_cast<VlcPluginBase *>(instance->pdata);
    if( p_plugin == NULL )
    {
        return false;
    }

    return p_plugin->handle_event(event);

}