glimmer-cw-video 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a029ae8b1eb4a79e6b3309549f3b9bba275cb63111f2c07f35cbf809b63465d9
-  data.tar.gz: 80a94bd9c7e16f942c7274692b0eea2a0cefc6bc0d288d8576d63901dd32efb8
+  metadata.gz: 12ba9b4c7e64db7a363ab1d05166ae8d9ff916726f44a691f44dd3107fb1c839
+  data.tar.gz: ede349878b4b018aaef0c56718800884a79efe4ee7c4cecbf3045f10d6ee36f8
 SHA512:
-  metadata.gz: 63c34b59eb60fa8ce1c1219f5828cb7fa4704bec5034b8f9270fc38c10d5a6eb4edd23ff3a0615a35c54f66bca85fdc12b1298a71c213a94383cd21109f66546
-  data.tar.gz: 91dc10dc49b09faa432528f0cd19449300152e806ba710c04a3e64c6e9a8cc5083ed919d41801da511f26a73b0bad036d65e3261dbe40bcaddd5f6f1a6cf9c99
+  metadata.gz: 798c5b9f4089204b473902de74ad83d3434a8f6817dc5d36bcfab1364ae2b046b05668005cef6d02558f29f4b99e39a8722c91b3d7812f59df8d5bfb80bda35c
+  data.tar.gz: 103dd4980a6779c63e545837752eb593e3c2507854413bcddcac32c8cb9000669afaed8e2a5ee369f141836d0afc4f092221482cb880cdba89727fe24be4c8b1

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Change Log
+
+## 1.0.0
+
+- Upgraded to Glimmer DSL for SWT 4.17.0.0
+- Made samples available via the `glimmer` command (e.g. glimmer sample:run[hello_video])
+- `#toggle` method for video play/pause action (plays if paused and pauses if playing)
+- Handle non-absolute files
+- Validate video file and raise error if invalid
+- Fast-Forward & Rewind
+- Volume get, set, up, and down
+- mute, unmute, muted?, and toggle_muted
+
+## 0.1.3
+
+- Fixed an issue with hooking widget observers via symbol instead of a string
+
+## 0.1.2
+
+- Upgraded to the glimmer-dsl-swt 0.4.1, glimmer-dsl-xml 0.1.0, and glimmer-dsl-css 0.1.0
+
+## 0.1.1
+
+- Upgraded to Glimmer 0.8.0 with a relaxed version requirement
+
+## 0.1.0
+
+- Initial version

data/README.md

@@ -1,4 +1,4 @@
-# Video 0.1.3
+# Video 1.0.0
 ## [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=40 /> Glimmer Custom Widget](https://github.com/AndyObtiva/glimmer#custom-widget-gem)
 [![Gem Version](https://badge.fury.io/rb/glimmer-cw-video.svg)](http://badge.fury.io/rb/glimmer-cw-video)
 [![Travis CI](https://travis-ci.com/AndyObtiva/glimmer-cw-video.svg?branch=master)](https://travis-ci.com/github/AndyObtiva/glimmer-cw-video)
@@ -29,7 +29,7 @@ This has been tested and confirmed to be working on:
 Add the following to a Glimmer application `Gemfile`:
 
 ```ruby
-gem 'glimmer-cw-video', '0.1.3'
+gem 'glimmer-cw-video', '1.0.0'
 ```
 
 Run:
@@ -49,9 +49,9 @@ require 'glimmer-cw-video'
 # ... more require statements follow
 ```
 
-## Options 
+## API Options 
 
-Here are the options to pass in as hash arguments to the `video` widget keyword (see in [Examples](#examples)):
+Here are the options to pass in as hash arguments to the `video` widget keyword (see in [Samples](#samples)):
 - `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
@@ -61,10 +61,11 @@ Here are the options to pass in as hash arguments to the `video` widget keyword
 - `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
+## API Methods
 
 - `#play`: plays video
 - `#pause`: pauses video
+- `#toggle`: toggles video playback, playing if paused, and pausing if playing.
 - `#reload`: reloads video restarting from beginning
 - `#position`: position in seconds (and fractions)
 - `#position=`: seeks a new position in video
@@ -73,17 +74,42 @@ Here are the options to pass in as hash arguments to the `video` widget keyword
 - `#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)
+- `#volume`: returns video volume (0.0 - 1.0 float value)
+- `#volume=`: sets video volume (0.0 - 1.0 float value)
+- `#volume_up(value=0.05)`: bumps video volume up by a specified value or default
+- `#volume_down(value=0.05)`: bumps video volume down by a specified value or default
+- `#mute`: mutes video
+- `#unmute`: unmutes video
+- `#muted?`: returns true if video is muted
+- `#toggle_muted`: mutes/unmutes video depending on `muted?` attribute
 
-## Observer Events (see in [Examples](#examples)):
+
+## API Observer Events
+
+(see in [Samples](#samples))
 
 - `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:
+## Samples
+
+Run this command to list available Video samples:
+
+```
+glimmer sample:list
+```
+
+### Hello, Video! 
+
+Run:
+
+```
+glimmer sample:run[hello_video]
+```
 
-Example ([samples/hello_video.rb](samples/video/hello_video.rb)):
+Glimmer Code (from [samples/video/hello_video.rb](samples/video/hello_video.rb)):
 
 ```ruby
 # ...
@@ -92,7 +118,19 @@ shell {
 }.open
 ```
 
-Example ([samples/hello_looped_video_with_black_background.rb](samples/video/hello_looped_video_with_black_background.rb)):
+Glimmer App:
+
+![glimmer cw video hello video](images/glimmer-cw-video-hello-video.png)
+
+### Hello, Looped Video with Black Background!
+
+Run:
+
+```
+glimmer sample:run[hello_looped_video_with_black_background]
+```
+
+Glimmer Code (from [samples/video/hello_looped_video_with_black_background.rb](samples/video/hello_looped_video_with_black_background.rb)):
 
 ```ruby
 # ...
@@ -102,28 +140,66 @@ shell {
 }.open
 ```
 
-Example ([samples/hello_video_observers.rb](samples/video/hello_video_observers.rb)):
+Glimmer App:
+
+![glimmer cw video hello video](images/glimmer-cw-video-hello-looped-video-with-black-background.png)
+
+### Hello, Video Observers!
+
+Run:
+
+```
+glimmer sample:run[hello_video_observers]
+```
+
+Glimmer Code (from [samples/video/hello_video_observers.rb](samples/video/hello_video_observers.rb)):
 
 ```ruby
 # ...
+require_relative '../../lib/glimmer-cw-video'
+
+include Glimmer
+
+video_file = File.expand_path('../videos/Ants.mp4', __FILE__)
+
 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
+  message_box {
+    text status
+    message "#{video.position.round(2)}/#{video.duration.round(2)} seconds have elapsed."
+  }.open
 end
 
 @shell = shell {
   minimum_size 800, 500
   @video = video(file: video_file, background: :black) {
+    on_swt_show { |event|
+      # set focus as soon as the SWT widget is shown to grab keyboard events below
+      @video.set_focus
+    }
+    
+    on_key_pressed { |event|
+      case event.keyCode
+      when swt(:space), swt(:cr)
+        @video.toggle
+      when swt(:arrow_left)
+        @video.rewind
+      when swt(:arrow_right)
+        @video.fast_forward
+      when swt(:arrow_up)
+        @video.volume_up
+      when swt(:arrow_down)
+        @video.volume_down
+      end
+    }   
+    
     on_playing {
       display_video_status(@video, 'Playing')
     }
+    
     on_paused {
       display_video_status(@video, 'Paused')
     }
+    
     on_ended {
       display_video_status(@video, 'Ended')
     }
@@ -132,12 +208,17 @@ end
 @shell.open
 ```
 
+Glimmer App:
+
+![glimmer cw video hello video observers](images/glimmer-cw-video-hello-video-observers.png)
+
+## TODO
+
+[TODO.md](TODO.md)
+
 ## Change Log
 
-- 0.1.3: Fixed an issue with hooking widget observers via symbol instead of a string
-- 0.1.2: Upgraded to the glimmer-dsl-swt 0.4.1, glimmer-dsl-xml 0.1.0, and glimmer-dsl-css 0.1.0
-- 0.1.1: Upgraded to Glimmer 0.8.0 with a relaxed version requirement
-- 0.1.0: Initial version
+[CHANGELOG.md](CHANGELOG.md)
 
 ## Contributing to glimmer-cw-video
  

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/glimmer-cw-video.rb

@@ -4,3 +4,5 @@ require 'glimmer-dsl-swt'
 require 'glimmer-dsl-xml'
 require 'glimmer-dsl-css'
 require 'views/glimmer/video'
+
+Glimmer::Config::SAMPLE_DIRECTORIES << File.expand_path('../../samples/video', __FILE__)

data/lib/views/glimmer/video.rb

@@ -20,7 +20,12 @@ module Glimmer
     alias looped? looped
     alias fit_to_width? fit_to_width
     alias fit_to_height? fit_to_height
-
+    
+    before_body {
+      file_source = file
+      raise "Video file does not exist: #{file_source}" if file_source && !file_source.start_with?('uri:classloader') && !File.exist?(File.expand_path(file_source))
+    }
+    
     body {
       browser(:no_scroll) {
         text html {
@@ -66,7 +71,7 @@ module Glimmer
       }
     }
 
-    def source
+    def source   
       file_source = file
       if file_source
         if file_source.start_with?('uri:classloader')
@@ -81,6 +86,7 @@ module Glimmer
           File.binwrite(tmp_file, file_content)
           "file://#{tmp_file}"
         else
+          file_source = File.expand_path(file_source)          
           "file://#{file_source}"
         end
       else
@@ -105,6 +111,10 @@ module Glimmer
     def pause
       video_action('pause')
     end
+    
+    def toggle
+      paused? ? play : pause
+    end
 
     def reload
       video_action('load')
@@ -132,12 +142,56 @@ module Glimmer
     end
 
     def position=(new_position)
+      new_position = [new_position, 0].max
+      new_position = [new_position, duration].min
       video_attribute_set('currentTime', new_position)
     end
+    
+    def fast_forward(seconds=15)
+      self.position += seconds
+    end
+
+    def rewind(seconds=15)
+      self.position -= seconds
+    end
 
     def duration
       video_attribute('duration')
     end
+    
+    def volume
+      video_attribute('volume')
+    end
+
+    def volume=(value)
+      value = [value, 0].max
+      value = [value, 1].min
+      video_attribute_set('volume', value)
+    end
+    
+    def volume_up(value=0.05)
+      self.volume += value
+    end
+
+    def volume_down(value=0.05)
+      self.volume -= value
+    end
+    
+    def mute
+      video_attribute_set('muted', true)
+    end
+    
+    def unmute
+      video_attribute_set('muted', false)
+    end
+    
+    def muted?
+      video_attribute('muted')
+    end
+    
+    def toggle_muted
+      muted? ? unmute : mute
+    end
 
     def can_handle_observation_request?(observation_request)
       result = false
@@ -162,7 +216,7 @@ module Glimmer
         end
       end
     end
-
+    
     private
 
     class VideoObserverBrowserFunction < BrowserFunction

data/samples/launch

@@ -0,0 +1,6 @@
+# Launches all samples
+export DIR=`echo $0 | sed "s/launch//"`
+glimmer \
+  "${DIR}hello_looped_video_with_black_background.rb" \
+  "${DIR}hello_video.rb" \
+  "${DIR}hello_video_observers.rb" \

data/samples/video/hello_looped_video_with_black_background.rb

@@ -0,0 +1,10 @@
+require_relative '../../lib/glimmer-cw-video'
+
+include Glimmer
+
+video_file = File.expand_path('../videos/Blackpool_Timelapse.mp4', __FILE__)
+
+shell {
+  minimum_size 1024, 640
+  video(file: video_file, looped: true, background: :black)
+}.open

data/samples/video/hello_video.rb

@@ -0,0 +1,9 @@
+require_relative '../../lib/glimmer-cw-video'
+
+include Glimmer
+
+video_file = File.expand_path('../videos/Clouds_passing_by_CCBY_NatureClip.mp4', __FILE__)
+
+shell {
+  video(file: video_file)
+}.open

data/samples/video/hello_video_observers.rb

@@ -0,0 +1,50 @@
+require_relative '../../lib/glimmer-cw-video'
+
+include Glimmer
+
+video_file = File.expand_path('../videos/Ants.mp4', __FILE__)
+
+def display_video_status(video, status)
+  message_box {
+    text status
+    message "#{video.position.round(2)}/#{video.duration.round(2)} seconds have elapsed."
+  }.open
+end
+
+@shell = shell {
+  minimum_size 800, 500
+  @video = video(file: video_file, background: :black) {
+    on_swt_show { |event|
+      # set focus as soon as the SWT widget is shown to grab keyboard events below
+      @video.set_focus
+    }
+    
+    on_key_pressed { |event|
+      case event.keyCode
+      when swt(:space), swt(:cr)
+        @video.toggle
+      when swt(:arrow_left)
+        @video.rewind
+      when swt(:arrow_right)
+        @video.fast_forward
+      when swt(:arrow_up)
+        @video.volume_up
+      when swt(:arrow_down)
+        @video.volume_down
+      end
+    }   
+    
+    on_playing {
+      display_video_status(@video, 'Playing')
+    }
+    
+    on_paused {
+      display_video_status(@video, 'Paused')
+    }
+    
+    on_ended {
+      display_video_status(@video, 'Ended')
+    }
+  }
+}
+@shell.open

metadata

@@ -1,24 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-cw-video
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 4.17.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 5.0.0.0
   name: glimmer-dsl-swt
   type: :runtime
   prerelease: false
@@ -26,16 +26,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 4.17.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 5.0.0.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -55,7 +55,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -98,20 +98,6 @@ dependencies:
     - - '='
       - !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: glimmer-cs-gladiator
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -154,6 +140,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: glimmer-cw-video
+  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
@@ -163,10 +163,19 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
+- VERSION
 - lib/glimmer-cw-video.rb
 - lib/views/glimmer/video.rb
+- samples/launch
+- samples/video/hello_looped_video_with_black_background.rb
+- samples/video/hello_video.rb
+- samples/video/hello_video_observers.rb
+- samples/video/videos/Ants.mp4
+- samples/video/videos/Blackpool_Timelapse.mp4
+- samples/video/videos/Clouds_passing_by_CCBY_NatureClip.mp4
 homepage: http://github.com/AndyObtiva/glimmer-cw-video
 licenses:
 - MIT