michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
michael@0:  * You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: "use strict";
michael@0: 
michael@0: var CastingApps = {
michael@0:   _castMenuId: -1,
michael@0: 
michael@0:   init: function ca_init() {
michael@0:     if (!this.isEnabled()) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     // Register a service target
michael@0:     SimpleServiceDiscovery.registerTarget("roku:ecp", function(aService, aApp) {
michael@0:       Cu.import("resource://gre/modules/RokuApp.jsm");
michael@0:       return new RokuApp(aService, "FirefoxTest");
michael@0:     });
michael@0: 
michael@0:     // Search for devices continuously every 120 seconds
michael@0:     SimpleServiceDiscovery.search(120 * 1000);
michael@0: 
michael@0:     this._castMenuId = NativeWindow.contextmenus.add(
michael@0:       Strings.browser.GetStringFromName("contextmenu.castToScreen"),
michael@0:       this.filterCast,
michael@0:       this.openExternal.bind(this)
michael@0:     );
michael@0: 
michael@0:     Services.obs.addObserver(this, "Casting:Play", false);
michael@0:     Services.obs.addObserver(this, "Casting:Pause", false);
michael@0:     Services.obs.addObserver(this, "Casting:Stop", false);
michael@0: 
michael@0:     BrowserApp.deck.addEventListener("TabSelect", this, true);
michael@0:     BrowserApp.deck.addEventListener("pageshow", this, true);
michael@0:     BrowserApp.deck.addEventListener("playing", this, true);
michael@0:     BrowserApp.deck.addEventListener("ended", this, true);
michael@0:   },
michael@0: 
michael@0:   uninit: function ca_uninit() {
michael@0:     BrowserApp.deck.removeEventListener("TabSelect", this, true);
michael@0:     BrowserApp.deck.removeEventListener("pageshow", this, true);
michael@0:     BrowserApp.deck.removeEventListener("playing", this, true);
michael@0:     BrowserApp.deck.removeEventListener("ended", this, true);
michael@0: 
michael@0:     Services.obs.removeObserver(this, "Casting:Play");
michael@0:     Services.obs.removeObserver(this, "Casting:Pause");
michael@0:     Services.obs.removeObserver(this, "Casting:Stop");
michael@0: 
michael@0:     NativeWindow.contextmenus.remove(this._castMenuId);
michael@0:   },
michael@0: 
michael@0:   isEnabled: function isEnabled() {
michael@0:     return Services.prefs.getBoolPref("browser.casting.enabled");
michael@0:   },
michael@0: 
michael@0:   observe: function (aSubject, aTopic, aData) {
michael@0:     switch (aTopic) {
michael@0:       case "Casting:Play":
michael@0:         if (this.session && this.session.remoteMedia.status == "paused") {
michael@0:           this.session.remoteMedia.play();
michael@0:         }
michael@0:         break;
michael@0:       case "Casting:Pause":
michael@0:         if (this.session && this.session.remoteMedia.status == "started") {
michael@0:           this.session.remoteMedia.pause();
michael@0:         }
michael@0:         break;
michael@0:       case "Casting:Stop":
michael@0:         if (this.session) {
michael@0:           this.closeExternal();
michael@0:         }
michael@0:         break;
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   handleEvent: function(aEvent) {
michael@0:     switch (aEvent.type) {
michael@0:       case "TabSelect": {
michael@0:         let tab = BrowserApp.getTabForBrowser(aEvent.target);
michael@0:         this._updatePageActionForTab(tab, aEvent);
michael@0:         break;
michael@0:       }
michael@0:       case "pageshow": {
michael@0:         let tab = BrowserApp.getTabForWindow(aEvent.originalTarget.defaultView);
michael@0:         this._updatePageActionForTab(tab, aEvent);
michael@0:         break;
michael@0:       }
michael@0:       case "playing":
michael@0:       case "ended": {
michael@0:         let video = aEvent.target;
michael@0:         if (video instanceof HTMLVideoElement) {
michael@0:           // If playing, send the <video>, but if ended we send nothing to shutdown the pageaction
michael@0:           this._updatePageActionForVideo(aEvent.type === "playing" ? video : null);
michael@0:         }
michael@0:         break;
michael@0:       }
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   _sendEventToVideo: function _sendEventToVideo(aElement, aData) {
michael@0:     let event = aElement.ownerDocument.createEvent("CustomEvent");
michael@0:     event.initCustomEvent("media-videoCasting", false, true, JSON.stringify(aData));
michael@0:     aElement.dispatchEvent(event);
michael@0:   },
michael@0: 
michael@0:   handleVideoBindingAttached: function handleVideoBindingAttached(aTab, aEvent) {
michael@0:     // Let's figure out if we have everything needed to cast a video. The binding
michael@0:     // defaults to |false| so we only need to send an event if |true|.
michael@0:     let video = aEvent.target;
michael@0:     if (!video instanceof HTMLVideoElement) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     if (SimpleServiceDiscovery.services.length == 0) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     if (!this.getVideo(video, 0, 0)) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     // Let the binding know casting is allowed
michael@0:     this._sendEventToVideo(video, { allow: true });
michael@0:   },
michael@0: 
michael@0:   handleVideoBindingCast: function handleVideoBindingCast(aTab, aEvent) {
michael@0:     // The binding wants to start a casting session
michael@0:     let video = aEvent.target;
michael@0:     if (!video instanceof HTMLVideoElement) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     // Close an existing session first. closeExternal has checks for an exsting
michael@0:     // session and handles remote and video binding shutdown.
michael@0:     this.closeExternal();
michael@0: 
michael@0:     // Start the new session
michael@0:     this.openExternal(video, 0, 0);
michael@0:   },
michael@0: 
michael@0:   makeURI: function makeURI(aURL, aOriginCharset, aBaseURI) {
michael@0:     return Services.io.newURI(aURL, aOriginCharset, aBaseURI);
michael@0:   },
michael@0: 
michael@0:   getVideo: function(aElement, aX, aY) {
michael@0:     // Fast path: Is the given element a video element
michael@0:     let video = this._getVideo(aElement);
michael@0:     if (video) {
michael@0:       return video;
michael@0:     }
michael@0: 
michael@0:     // The context menu system will keep walking up the DOM giving us a chance
michael@0:     // to find an element we match. When it hits <html> things can go BOOM.
michael@0:     try {
michael@0:       // Maybe this is an overlay, with the video element under it
michael@0:       // Use the (x, y) location to guess at a <video> element
michael@0:       let elements = aElement.ownerDocument.querySelectorAll("video");
michael@0:       for (let element of elements) {
michael@0:         // Look for a video element contained in the overlay bounds
michael@0:         let rect = element.getBoundingClientRect();
michael@0:         if (aY >= rect.top && aX >= rect.left && aY <= rect.bottom && aX <= rect.right) {
michael@0:           video = this._getVideo(element);
michael@0:           if (video) {
michael@0:             break;
michael@0:           }
michael@0:         }
michael@0:       }
michael@0:     } catch(e) {}
michael@0: 
michael@0:     // Could be null
michael@0:     return video;
michael@0:   },
michael@0: 
michael@0:   _getVideo: function(aElement) {
michael@0:     // Given the hardware support for H264, let's only look for 'mp4' sources
michael@0:     if (!aElement instanceof HTMLVideoElement) {
michael@0:       return null;
michael@0:     }
michael@0: 
michael@0:     function allowableExtension(aURI) {
michael@0:       if (aURI && aURI instanceof Ci.nsIURL) {
michael@0:         return (aURI.fileExtension == "mp4");
michael@0:       }
michael@0:       return false;
michael@0:     }
michael@0: 
michael@0:     // Grab the poster attribute from the <video>
michael@0:     let posterURL = aElement.poster;
michael@0: 
michael@0:     // First, look to see if the <video> has a src attribute
michael@0:     let sourceURL = aElement.src;
michael@0: 
michael@0:     // If empty, try the currentSrc
michael@0:     if (!sourceURL) {
michael@0:       sourceURL = aElement.currentSrc;
michael@0:     }
michael@0: 
michael@0:     if (sourceURL) {
michael@0:       // Use the file extension to guess the mime type
michael@0:       let sourceURI = this.makeURI(sourceURL, null, this.makeURI(aElement.baseURI));
michael@0:       if (allowableExtension(sourceURI)) {
michael@0:         return { element: aElement, source: sourceURI.spec, poster: posterURL };
michael@0:       }
michael@0:     }
michael@0: 
michael@0:     // Next, look to see if there is a <source> child element that meets
michael@0:     // our needs
michael@0:     let sourceNodes = aElement.getElementsByTagName("source");
michael@0:     for (let sourceNode of sourceNodes) {
michael@0:       let sourceURI = this.makeURI(sourceNode.src, null, this.makeURI(sourceNode.baseURI));
michael@0: 
michael@0:       // Using the type attribute is our ideal way to guess the mime type. Otherwise,
michael@0:       // fallback to using the file extension to guess the mime type
michael@0:       if (sourceNode.type == "video/mp4" || allowableExtension(sourceURI)) {
michael@0:         return { element: aElement, source: sourceURI.spec, poster: posterURL };
michael@0:       }
michael@0:     }
michael@0: 
michael@0:     return null;
michael@0:   },
michael@0: 
michael@0:   filterCast: {
michael@0:     matches: function(aElement, aX, aY) {
michael@0:       if (SimpleServiceDiscovery.services.length == 0)
michael@0:         return false;
michael@0:       let video = CastingApps.getVideo(aElement, aX, aY);
michael@0:       if (CastingApps.session) {
michael@0:         return (video && CastingApps.session.data.source != video.source);
michael@0:       }
michael@0:       return (video != null);
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   pageAction: {
michael@0:     click: function() {
michael@0:       // Since this is a pageaction, we use the selected browser
michael@0:       let browser = BrowserApp.selectedBrowser;
michael@0:       if (!browser) {
michael@0:         return;
michael@0:       }
michael@0: 
michael@0:       // Look for a castable <video> that is playing, and start casting it
michael@0:       let videos = browser.contentDocument.querySelectorAll("video");
michael@0:       for (let video of videos) {
michael@0:         if (!video.paused && video.mozAllowCasting) {
michael@0:           CastingApps.openExternal(video, 0, 0);
michael@0:           return;
michael@0:         }
michael@0:       }
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   _findCastableVideo: function _findCastableVideo(aBrowser) {
michael@0:       // Scan for a <video> being actively cast. Also look for a castable <video>
michael@0:       // on the page.
michael@0:       let castableVideo = null;
michael@0:       let videos = aBrowser.contentDocument.querySelectorAll("video");
michael@0:       for (let video of videos) {
michael@0:         if (video.mozIsCasting) {
michael@0:           // This <video> is cast-active. Break out of loop.
michael@0:           return video;
michael@0:         }
michael@0: 
michael@0:         if (!video.paused && video.mozAllowCasting) {
michael@0:           // This <video> is cast-ready. Keep looking so cast-active could be found.
michael@0:           castableVideo = video;
michael@0:         }
michael@0:       }
michael@0: 
michael@0:       // Could be null
michael@0:       return castableVideo;
michael@0:   },
michael@0: 
michael@0:   _updatePageActionForTab: function _updatePageActionForTab(aTab, aEvent) {
michael@0:     // We only care about events on the selected tab
michael@0:     if (aTab != BrowserApp.selectedTab) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     // Update the page action, scanning for a castable <video>
michael@0:     this._updatePageAction();
michael@0:   },
michael@0: 
michael@0:   _updatePageActionForVideo: function _updatePageActionForVideo(aVideo) {
michael@0:     this._updatePageAction(aVideo);
michael@0:   },
michael@0: 
michael@0:   _updatePageAction: function _updatePageAction(aVideo) {
michael@0:     // Remove any exising pageaction first, in case state changes or we don't have
michael@0:     // a castable video
michael@0:     if (this.pageAction.id) {
michael@0:       NativeWindow.pageactions.remove(this.pageAction.id);
michael@0:       delete this.pageAction.id;
michael@0:     }
michael@0: 
michael@0:     if (!aVideo) {
michael@0:       aVideo = this._findCastableVideo(BrowserApp.selectedBrowser);
michael@0:       if (!aVideo) {
michael@0:         return;
michael@0:       }
michael@0:     }
michael@0: 
michael@0:     // We only show pageactions if the <video> is from the selected tab
michael@0:     if (BrowserApp.selectedTab != BrowserApp.getTabForWindow(aVideo.ownerDocument.defaultView.top)) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     // We check for two state here:
michael@0:     // 1. The video is actively being cast
michael@0:     // 2. The video is allowed to be cast and is currently playing
michael@0:     // Both states have the same action: Show the cast page action
michael@0:     if (aVideo.mozIsCasting) {
michael@0:       this.pageAction.id = NativeWindow.pageactions.add({
michael@0:         title: Strings.browser.GetStringFromName("contextmenu.castToScreen"),
michael@0:         icon: "drawable://casting_active",
michael@0:         clickCallback: this.pageAction.click,
michael@0:         important: true
michael@0:       });
michael@0:     } else if (aVideo.mozAllowCasting) {
michael@0:       this.pageAction.id = NativeWindow.pageactions.add({
michael@0:         title: Strings.browser.GetStringFromName("contextmenu.castToScreen"),
michael@0:         icon: "drawable://casting",
michael@0:         clickCallback: this.pageAction.click,
michael@0:         important: true
michael@0:       });
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   prompt: function(aCallback) {
michael@0:     let items = [];
michael@0:     SimpleServiceDiscovery.services.forEach(function(aService) {
michael@0:       let item = {
michael@0:         label: aService.friendlyName,
michael@0:         selected: false
michael@0:       };
michael@0:       items.push(item);
michael@0:     });
michael@0: 
michael@0:     let prompt = new Prompt({
michael@0:       title: Strings.browser.GetStringFromName("casting.prompt")
michael@0:     }).setSingleChoiceItems(items).show(function(data) {
michael@0:       let selected = data.button;
michael@0:       let service = selected == -1 ? null : SimpleServiceDiscovery.services[selected];
michael@0:       if (aCallback)
michael@0:         aCallback(service);
michael@0:     });
michael@0:   },
michael@0: 
michael@0:   openExternal: function(aElement, aX, aY) {
michael@0:     // Start a second screen media service
michael@0:     let video = this.getVideo(aElement, aX, aY);
michael@0:     if (!video) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     this.prompt(function(aService) {
michael@0:       if (!aService)
michael@0:         return;
michael@0: 
michael@0:       // Make sure we have a player app for the given service
michael@0:       let app = SimpleServiceDiscovery.findAppForService(aService, "video-sharing");
michael@0:       if (!app)
michael@0:         return;
michael@0: 
michael@0:       video.title = aElement.ownerDocument.defaultView.top.document.title;
michael@0:       if (video.element) {
michael@0:         // If the video is currently playing on the device, pause it
michael@0:         if (!video.element.paused) {
michael@0:           video.element.pause();
michael@0:         }
michael@0:       }
michael@0: 
michael@0:       app.stop(function() {
michael@0:         app.start(function(aStarted) {
michael@0:           if (!aStarted) {
michael@0:             dump("CastingApps: Unable to start app");
michael@0:             return;
michael@0:           }
michael@0: 
michael@0:           app.remoteMedia(function(aRemoteMedia) {
michael@0:             if (!aRemoteMedia) {
michael@0:               dump("CastingApps: Failed to create remotemedia");
michael@0:               return;
michael@0:             }
michael@0: 
michael@0:             this.session = {
michael@0:               service: aService,
michael@0:               app: app,
michael@0:               remoteMedia: aRemoteMedia,
michael@0:               data: {
michael@0:                 title: video.title,
michael@0:                 source: video.source,
michael@0:                 poster: video.poster
michael@0:               },
michael@0:               videoRef: Cu.getWeakReference(video.element)
michael@0:             };
michael@0:           }.bind(this), this);
michael@0:         }.bind(this));
michael@0:       }.bind(this));
michael@0:     }.bind(this));
michael@0:   },
michael@0: 
michael@0:   closeExternal: function() {
michael@0:     if (!this.session) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     this.session.remoteMedia.shutdown();
michael@0:     this.session.app.stop();
michael@0: 
michael@0:     let video = this.session.videoRef.get();
michael@0:     if (video) {
michael@0:       this._sendEventToVideo(video, { active: false });
michael@0:       this._updatePageAction();
michael@0:     }
michael@0: 
michael@0:     delete this.session;
michael@0:   },
michael@0: 
michael@0:   // RemoteMedia callback API methods
michael@0:   onRemoteMediaStart: function(aRemoteMedia) {
michael@0:     if (!this.session) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     aRemoteMedia.load(this.session.data);
michael@0:     sendMessageToJava({ type: "Casting:Started", device: this.session.service.friendlyName });
michael@0: 
michael@0:     let video = this.session.videoRef.get();
michael@0:     if (video) {
michael@0:       this._sendEventToVideo(video, { active: true });
michael@0:       this._updatePageAction(video);
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   onRemoteMediaStop: function(aRemoteMedia) {
michael@0:     sendMessageToJava({ type: "Casting:Stopped" });
michael@0:   },
michael@0: 
michael@0:   onRemoteMediaStatus: function(aRemoteMedia) {
michael@0:     if (!this.session) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     let status = aRemoteMedia.status;
michael@0:     if (status == "completed") {
michael@0:       this.closeExternal();
michael@0:     }
michael@0:   }
michael@0: };
michael@0: