glimmer-cw-video 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10a0ed280e12d03b5c9a8a69e696043e208a58b54282d74fa8310bc4602ccbf7
+  data.tar.gz: 631708906e59bfb0232fd09fd20d673520dce51611fc59e16c8301fe098237d0
+SHA512:
+  metadata.gz: f8c79642df581ebef469df2b0993e5f32de0715345307652be76002a31f0ec238871a416797980db539843a5dab521649dea2f3d171dd795244944f9552b66ab
+  data.tar.gz: d584693154c69b17d1aaf9cd85a501a7dbc5062c787734c8832dc8ff1b6835db5451185faa0bb421d43d301cf361a86db29f5244eeed8e42c74bb23c6b9b9ff8

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2020 Andy Maleh
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,125 @@
+# Video 0.1.0 - Glimmer Custom Widget
+
+![Video Widget](images/glimmer-video-widget.png)
+
+Glimmer custom widget for video used via `video` keyword.
+
+## Pre-requisites
+
+- [Glimmer](https://github.com/AndyObtiva/glimmer) application
+- JRuby version required by Glimmer
+- Java version required by Glimmer
+
+## Setup
+
+Add the following to a Glimmer application `Gemfile`:
+
+```ruby
+gem 'glimmer-cw-video', '0.1.0'
+```
+
+Run:
+
+```
+jruby -S bundle
+```
+
+(or just `bundle` if using RVM)
+
+## Options 
+
+Passed in an options hash as arguments to `video` widget:
+- `autoplay` (true [default] or false): plays video automatically as soon as loaded
+- `controls` (true [default] or false): displays controls
+- `looped` (true or false [default]): plays video in looped mode
+- `background` (Glimmer color [default: white]): sets background color just like with any other widget
+- `fit_to_width` (true [default] or false): fits video width to widget allotted width regardless of video's original size. Maintains video aspect ratio.
+- `fit_to_height` (true [default] or false): fits video height to widget allotted height regardless of video's original size. Maintains video aspect ratio.
+- `offset_x` (integer [default: 0]): offset from left border. Could be a negative number if you want to show only an area of the video. Useful when fit_to_width is false to pick an area of the video to display.
+- `offset_y` (integer [default: 0]): offset from top border. Could be a negative number if you want to show only an area of the video. Useful when fit_to_height is false to pick an area of the video to display.
+
+## Methods
+
+- `#play`: plays video
+- `#pause`: pauses video
+- `#reload`: reloads video restarting from beginning
+- `#position`: position in seconds (and fractions)
+- `#position=`: seeks a new position in video
+- `#duration`: length of video, maximum video position possible
+- `#loaded?`: returns true when video has been initially loaded or reloaded
+- `#playing?`: returns true when video is actively playing
+- `#paused?`: returns true when video is not playing
+- `#ended?`: returns true when video has reached the end (position == duration)
+
+## Observer Events:
+
+- `on_loaded`: invoked when video `#loaded?` becomes true
+- `on_ended`: invoked when video `#ended?` becomes true
+- `on_playing`: invoked when video `#playing?` becomes true
+- `on_paused`: invoked when video `#paused?` becomes true
+
+## Examples:
+
+Example ([samples/hello_video.rb](samples/video/hello_video.rb)):
+
+```ruby
+# ...
+shell {
+  video(file: video_file)
+}.open
+```
+
+Example ([samples/hello_looped_video_with_black_background.rb](samples/video/hello_looped_video_with_black_background.rb)):
+
+```ruby
+# ...
+shell {
+  minimum_size 1024, 640
+  video(file: video_file, looped: true, background: :black)
+}.open
+```
+
+Example ([samples/hello_video_observers.rb](samples/video/hello_video_observers.rb)):
+
+```ruby
+# ...
+def display_video_status(video, status)
+  message_box = MessageBox.new(video.swt_widget.getShell)
+  message_box.setText(status)
+  message = "Video Position: #{video.position} seconds\n"
+  message += "Video Duration: #{video.duration} seconds"
+  message_box.setMessage(message)
+  message_box.open
+end
+
+@shell = shell {
+  minimum_size 800, 500
+  @video = video(file: video_file, background: :black) {
+    on_playing {
+      display_video_status(@video, 'Playing')
+    }
+    on_paused {
+      display_video_status(@video, 'Paused')
+    }
+    on_ended {
+      display_video_status(@video, 'Ended')
+    }
+  }
+}
+@shell.open
+```
+
+## Contributing to glimmer-cw-video
+ 
+- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+- Fork the project.
+- Start a feature/bugfix branch.
+- Commit and push until you are happy with your contribution.
+- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2020 Andy Maleh. See LICENSE.txt for
+further details.

data/lib/glimmer-cw-video.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.expand_path('..', __FILE__))
+
+require 'bundler/setup'
+Bundler.require(:default)
+require 'views/glimmer/video'

data/lib/views/glimmer/video.rb

@@ -0,0 +1,287 @@
+require 'glimmer/ui/custom_widget'
+
+module Glimmer
+  class Video
+    include Glimmer::UI::CustomWidget
+    include_package 'org.eclipse.swt.browser'
+
+    options :file, :url
+    option :autoplay, true
+    option :controls, true
+    option :looped, false
+    option :background, :white
+    option :fit_to_width, true
+    option :fit_to_height, true
+    option :offset_x, 0
+    option :offset_y, 0
+
+    alias autoplay? autoplay
+    alias controls? controls
+    alias looped? looped
+    alias fit_to_width? fit_to_width
+    alias fit_to_height? fit_to_height
+
+    body {
+      browser(:no_scroll) {
+        text html {
+          head {
+            style(id: "style") {
+              css {
+                body {
+                  margin 0
+                  padding 0
+                  overflow :hidden
+                }
+              }
+            }
+            style(id: "style-body-background") {
+              css {
+                body {
+                  pv 'background', browser_body_background
+                }
+              }
+            }
+            style(id: "style-body-offset-x") {
+              css {
+                body {
+                  margin_left "#{browser_body_offset_x}px"
+                }
+              }
+            }
+            style(id: "style-body-offset-y") {
+              css {
+                body {
+                  margin_top "#{browser_body_offset_y}px"
+                }
+              }
+            }
+          }
+          body {
+            video(browser_video_loop, browser_video_controls, browser_video_autoplay, id: 'video', src: source, width: browser_video_width, height: browser_video_height)
+          }
+        }
+        on_completed {
+          @completed = true
+        }
+      }
+    }
+
+    def source
+      file_source = file
+      if file_source
+        if file_source.start_with?('uri:classloader')
+          file_path = file_source.split(/\/\//).last
+          file_name = File.basename(file_source)
+          # supporting windows ENV['temp'] or mac/unix /tmp
+          tmp_dir = ENV['temp'] ? File.expand_path(ENV['temp']) : '/tmp'
+          tmp_dir += '/glimmer/lib/glimmer/ui/video'
+          FileUtils.mkdir_p(tmp_dir)
+          tmp_file = File.join(tmp_dir, file_name)
+          file_content = File.binread(file_source) rescue File.binread(file_path)
+          File.binwrite(tmp_file, file_content)
+          "file://#{tmp_file}"
+        else
+          "file://#{file_source}"
+        end
+      else
+        url
+      end
+    end
+
+    def file=(a_file)
+      options[:file] = a_file
+      set_video_source
+    end
+
+    def url=(a_url)
+      options[:url] = a_url
+      set_video_source
+    end
+
+    def play
+      video_action('play')
+    end
+
+    def pause
+      video_action('pause')
+    end
+
+    def reload
+      video_action('load')
+    end
+
+    def paused?
+      video_attribute('paused')
+    end
+
+    def playing?
+      !paused?
+    end
+
+    def ended?
+      video_attribute('ended')
+    end
+
+    # Video fully loaded and ready for playback
+    def loaded?
+      !!@completed
+    end
+
+    def position
+      video_attribute('currentTime')
+    end
+
+    def position=(new_position)
+      video_attribute_set('currentTime', new_position)
+    end
+
+    def duration
+      video_attribute('duration')
+    end
+
+    def can_handle_observation_request?(observation_request)
+      result = false
+      if observation_request.start_with?('on_')
+        attribute = observation_request.sub(/^on_/, '')
+        result = OBSERVED_ATTRIBUTE_TO_PROPERTY_MAPPING.keys.include?(attribute)
+      end
+      result || super
+    end
+
+    def handle_observation_request(observation_request, &block)
+      if observation_request.start_with?('on_')
+        attribute = observation_request.sub(/^on_/, '')
+        if attribute == 'loaded' && !@completed
+          super('on_completed', &block)
+        elsif OBSERVED_ATTRIBUTE_TO_PROPERTY_MAPPING.keys.include?(attribute)
+          add_video_observer(block, OBSERVED_ATTRIBUTE_TO_PROPERTY_MAPPING[attribute])
+        else
+          super
+        end
+      end
+    end
+
+    private
+
+    class VideoObserverBrowserFunction < BrowserFunction
+      def initialize(video, observer_proc, attribute)
+        @observer_proc = observer_proc
+        @attribute = attribute
+        name = self.class.generate_name(@attribute)
+        super(video.swt_widget, name)
+      end
+
+      def function(arguments)
+        @observer_proc.call
+      rescue => e
+        Glimmer::Config.logger&.error "#{e.message}\n#{e.backtrace.join("\n")}"
+      ensure
+        nil
+      end
+
+      private
+
+      class << self
+        def generate_name(attribute)
+          "video#{attribute}#{generate_attribute_id(attribute)}"
+        end
+
+        def generate_attribute_id(attribute)
+          attribute_max_ids[attribute] = attribute_max_id(attribute) + 1
+        end
+
+        def attribute_max_id(attribute)
+          attribute_max_ids[attribute] ||= 0
+        end
+
+        def attribute_max_ids
+          @attribute_max_ids ||= {}
+        end
+      end
+    end
+
+    OBSERVED_ATTRIBUTE_TO_PROPERTY_MAPPING = {
+      'playing' => 'play',
+      'paused' => 'pause',
+      'ended' => 'ended',
+      'loaded' => 'canplay',
+    }
+
+    def set_video_source
+      run_on_completed do
+        video_attribute_set('src', source)
+      end
+    end
+
+    def video_action(action)
+      run_on_completed do
+        swt_widget.execute("document.getElementById('video').#{action}()")
+      end
+    end
+
+    def video_attribute(attribute)
+      swt_widget.evaluate("return document.getElementById('video').#{attribute}") if @completed
+    end
+
+    def video_attribute_set(attribute, value)
+      value = "'#{value}'" if value.is_a?(String) || value.is_a?(Symbol)
+      run_on_completed do
+        swt_widget.execute("document.getElementById('video').#{attribute} = #{value}")
+      end
+    end
+
+    def add_video_observer(observer_proc, attribute)
+      run_on_completed do
+        video_observer_browser_function = VideoObserverBrowserFunction.new(self, observer_proc, attribute)
+        swt_widget.execute("document.getElementById('video').addEventListener('#{attribute}', function() {#{video_observer_browser_function.getName}()})")
+      end
+    end
+
+    def run_on_completed(&block)
+      if @completed
+        block.call
+      else
+        on_completed(&block)
+      end
+    end
+
+    def browser_video_autoplay
+      'autoplay' if autoplay?
+    end
+
+    def browser_video_controls
+      'controls' if controls?
+    end
+
+    def browser_video_loop
+      'loop' if looped?
+    end
+
+    def browser_video_width
+      "100%" if fit_to_width
+    end
+
+    def browser_video_height
+      "100%" if fit_to_height
+    end
+
+    def browser_body_background
+      color = background
+      if color.is_a?(Symbol) || color.is_a?(String)        
+        color = color(color)
+      end
+      if color.respond_to?(:swt_color)
+        color = color.swt_color
+      end
+      "rgba(#{color.getRed}, #{color.getGreen}, #{color.getBlue}, #{color.getAlpha})"
+    end
+
+    def browser_body_offset_x
+      offset_x
+    end
+
+    def browser_body_offset_y
+      offset_y
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: glimmer-cw-video
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Maleh
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  name: glimmer
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  name: rspec
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.9
+  name: jeweler
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.9
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: simplecov
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Glimmer video widget with basic functionality like play, pause, loop,
+  and reload. Support mp4, webm, and ogg. Works with both local files and web URLs.
+email: andy.am@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- lib/glimmer-cw-video.rb
+- lib/views/glimmer/video.rb
+homepage: http://github.com/AndyObtiva/glimmer-cw-video
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: Glimmer Custom Widget - Video
+test_files: []