pi-slideshow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb62ebde2f8105c75f47676222be4a8cefe39e12
+  data.tar.gz: 2c5529831be525c682a7ab2ab4849ef60da0432d
+SHA512:
+  metadata.gz: 3ae87d936cbf68a657350ffd3dd713a8b63e565178f51dff0c3caac0e0f757f9f04928e9e0c2da9013a1c631f82bd0411e12203e090bf753035e7da5f0e732cc
+  data.tar.gz: 8c29b7f518d6b7d4a6f557fc735fb8d41a281f814c44723ef999b877fb2ad7868c9773ef964f916f2da84e3664e71abc5ea6a36e24811e37f674b197a03c4139

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2014 Jens Krämer
+
+The MIT License
+
+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,126 @@
+# Pi-Slideshow
+
+A slideshow application for the Raspberry Pi or similar setups involving Linux
+and a framebuffer.
+
+
+## Setup
+
+We will use [fim](http://www.autistici.org/dezperado/fim/) to display images,
+netcat for remote controlling fim, and Ruby for everything else.
+
+On [Raspbian](http://www.raspbian.org/) you should be all set with
+
+```
+aptitude install fim netcat ruby1.9.1 ruby-dev libssl-dev
+```
+.
+
+Any Ruby dependencies (basically that's Sinatra and Puma) will be pulled in
+once you install the gem:
+
+```
+gem install pi-slideshow
+```
+
+This gives you @/usr/local/bin/pi-slides@:
+
+```
+pi@raspberrypi ~ $ pi-slides --help
+Usage:
+       pi-slides [options]
+where [options] are:
+        --path, -p <s>:   image base directory (default: .)
+    --interval, -i <i>:   seconds between image changes (default: 30)
+   --web, --no-web, -w:   enable built in web interface (default: true)
+        --port, -o <i>:   listen port for the web interface (default: 4567)
+        --testmode, -t:   run against echo server instead launching a real fim
+    --fim-port, -f <i>:   port to use for communicating with fim (default: 9999)
+  --fim-binary, -m <s>:   path to fim binary (default: /usr/bin/fim)
+    --fim-opts, -s <s>:   fim options (default: -d /dev/fb0)
+  --remote-fim, -r <s>:   do not spawn fim, instead connect to this ip
+         --verbose, -v:   verbose mode
+           --quiet, -q:   quiet mode
+            --help, -h:   Show this message
+```
+
+Most of the time you will only need to bother with the @path@, @port@ and maybe
+@interval@ options, which tell pi-slides where your images are, which port
+the web interface should run on, and how long each image should be shown
+initially.
+
+Pi-slides scans the path given for JPGs and displays them in random
+order. Once finished, the path is re-scanned, so any changes (i.e. new
+pictures) will be picked up.
+
+For launching the slideshow upon boot, call pi-slides from @/etc/rc.local@:
+
+```
+pi@raspberrypi ~ $ cat /etc/rc.local
+#!/bin/sh -e
+#
+# rc.local
+#
+# This script is executed at the end of each multiuser runlevel.
+# Make sure that the script will "exit 0" on success or any other
+# value on error.
+#
+# In order to enable or disable this script just change the execution
+# bits.
+#
+# By default this script does nothing.
+
+# Print the IP address
+_IP=$(hostname -I) || true
+if [ "$_IP" ]; then
+  printf "My IP address is %s\n" "$_IP"
+fi
+
+/usr/local/bin/pi-slides --path=/home/pi/images --interval=90 --port=80 > /tmp/pim-slides.log
+
+exit 0
+```
+
+Note that if you call it like this, pi-slides will stay in the foreground,
+meaning the login prompt is never reached. This is a good thing since otherwise
+the blinking cursor of the prompt would be very visible all the time.
+
+Just make sure you can ssh into the Pi before you reboot if you made this
+change to @rc.local@.
+
+## Enjoy!
+
+After a reboot, your Pi should start happily displaying images in random order.
+
+Soon after all is up and running nicely you will most probably notice that it
+would be nice to change the slide interval *without* having to ssh into that
+tiny box. Or to hold the slideshow for a while at your favorite shot. Or to
+turn of the automatic fill-screen scaling that fim does by default. Here you go
+- point your browser (preferably on your phone) to port 4567 of your Raspberry
+Pi and you should see the remote control web interface.
+
+
+## Disclaimer / Security implications
+
+Setup like this you will have fim listening on port 9999 (localhost), and a
+webserver listening on port 4567 (all interfaces), both running as *root* on
+your Pi.
+
+Everybody on the same network may access the web frontend, and everybody on the
+Pi can make fim execute whatever fim script they like. Any security leak in
+fim's script parser or the puma, sinatra or the slideshow webapp can lead to
+somebody gaining root on your Pi.
+
+There are ways to do this better, i.e. it should be possible to run fim as a
+non-root user without losing access to the framebuffer, and of course puma does
+not need to run as root (at least as long as you don't want it to bind to a
+privileged port).  It would be awesome if puma could drop privileges after
+binding to port 80, however I didn't find any information regarding this.
+
+Whether all this is a risk for you largely depends on your environment - my Pi
+sits behind a NATting firewall in my home network, and serves no other purpose
+than showing pictures, that's why I don't care too much. I for sure wouldn't
+run it like this on a network with people I don't trust.
+
+
+

data/bin/fim-shell

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require 'trollop'
+require 'pi_slides'
+
+opts = Trollop::options do
+  banner <<-EOS
+Usage:
+       fim-shell [options]
+where [options] are:
+EOS
+  opt :port, 'port where fim is listening', :short => :p, :default => 9999
+  opt :host, 'host where fim is running', :default => 'localhost'
+end
+
+fim = PiSlides::Fim.new opts[:host], opts[:port]
+
+def prompt
+  print "> "
+  $stdout.flush
+end
+
+prompt
+while cmd = $stdin.readline
+  cmd.strip!
+  exit if %w(quit exit).include? cmd
+  cmd = "#{cmd};" unless cmd =~ /;$/
+  fim.exec cmd
+  prompt
+end
+

data/bin/pi-slides

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+
+require 'trollop'
+require 'pi_slides'
+
+
+opts = Trollop::options do
+  banner <<-EOS
+Usage:
+       pi-slides [options]
+where [options] are:
+EOS
+  opt :path, 'image base directory', :type => :string, :default => '.'
+  opt :interval, 'seconds between image changes', :default => 30
+  opt :web, 'enable built in web interface', :default => true
+  opt :port, 'listen port for the web interface', :default => 4567
+  opt :testmode, 'run against echo server instead launching a real fim', :default => false
+  opt :fim_port, 'port to use for communicating with fim', :default => 9999
+  opt :fim_binary, 'path to fim binary', :default => '/usr/bin/fim'
+  opt :fim_opts, 'fim options', :default => '-d /dev/fb0'
+  opt :remote_fim, 'do not spawn fim, instead connect to this ip', :default => nil, :type => :string
+  opt :verbose, 'verbose mode', :default => false
+  opt :quiet, 'quiet mode', :default => false
+end
+
+PiSlides.logger.level = if opts[:quiet]
+                          9
+                        elsif opts[:verbose]
+                          0
+                        else
+                          1
+                        end
+
+image_path = File.expand_path opts[:path]
+raise 'invalid image directory' unless File.directory?(image_path)
+
+fim_host = opts[:remote_fim] || '127.0.0.1'
+
+unless opts[:remote_fim]
+  # launch fim running a netcat loop, or, for test mode, launch something
+  # pretending to be fim running a netcat loop:
+  netcat_command = "nc -l #{fim_host} #{opts[:fim_port]}"
+  fim_pid = if opts[:testmode]
+    fork do
+      PiSlides.debug "spawned echo server with pid #{Process.pid}"
+      loop do
+        PiSlides.info "fim: #{`#{netcat_command}`}"
+      end
+    end
+  else
+    spawn %{#{opts[:fim_binary]} #{opts[:fim_opts]} -c 'while(1){popen "#{netcat_command}";}'}
+  end
+  PiSlides.debug "fim pid is #{fim_pid}"
+end
+
+# start the show
+$slideshow = PiSlides::Slideshow.new(
+  PiSlides::ImageDir.new(image_path),
+  PiSlides::Fim.new(:host => fim_host, :port => opts[:fim_port]),
+  opts
+)
+$slideshow.run
+
+# do a clean shutdown
+Kernel.at_exit do
+  PiSlides.debug "bye!"
+  $slideshow.stop
+end
+
+if opts[:web]
+  # fire up sinatra
+  require 'pi_slides/web_frontend'
+  PiSlides::WebFrontend.set :port, opts[:port]
+  PiSlides::WebFrontend.run!
+else
+  # join the slideshow thread to prevent us from exiting
+  $slideshow.join
+end
+

data/lib/pi-slides.rb

@@ -0,0 +1 @@
+require 'pi_slides'

data/lib/pi_slides.rb

@@ -0,0 +1,23 @@
+require 'logger'
+
+require 'pi_slides/fim'
+require 'pi_slides/image_dir'
+require 'pi_slides/slideshow'
+
+module PiSlides
+
+  class << self
+
+    def logger
+      @logger ||= (STDOUT.sync = true; Logger.new(STDOUT))
+    end
+
+    %w(debug info error).each do |m|
+      define_method m do |msg|
+        logger.send m, msg
+      end
+    end
+
+  end
+
+end

data/lib/pi_slides/fim.rb

@@ -0,0 +1,60 @@
+require 'socket'
+
+module PiSlides
+  class Fim
+
+    def initialize(options = {})
+      @mutex = Mutex.new
+      options = {
+        :host => 'localhost', :port => 9999
+      }.merge options
+      @host = options[:host]
+      @port = options[:port]
+    end
+
+    # pushes the file, displays it and removes it from the list immediately
+    # shows and pops the next file from the list if path.nil?
+    def show(path=nil)
+      exec %{#{"push '#{path}';" if path}next;pop;}
+    end
+
+    # turn status line on/off
+    def status_line(switch_on = true)
+      if switch_on
+        set_vars :_display_busy => 1, :_display_status => 1
+      else # switch off
+        set_vars :_display_busy => 0, :_display_status => 0
+      end
+    end
+
+    def toggle_autowidth
+      exec 'autowidth=1-autowidth;'
+    end
+
+    def push(*files)
+      exec files.map{|f| "push '#{f}';"}.join + "prefetch;"
+    end
+
+    def set_vars(vars = {})
+      exec vars.to_a.map{|name, value| %{#{name}=#{value};}}.join
+    end
+
+    def exec(cmd)
+      @mutex.synchronize do
+        TCPSocket.open(@host, @port).tap do |s|
+          s << cmd
+          s.close
+        end
+      end
+    rescue
+      # this happens from time to time when fim is busy
+      PiSlides.debug "error sending command, will retry in 1s"
+      PiSlides.debug "host=#{@host} port=#{@port} cmd=#{cmd}"
+      PiSlides.debug $!
+      #PiSlides.debug $!.backtrace.join "\n"
+      sleep 1
+      retry
+    end
+  end
+
+end

data/lib/pi_slides/image_dir.rb

@@ -0,0 +1,21 @@
+module PiSlides
+
+  ImageDir = Struct.new(:path) do
+    def file_list(pattern = '**/*.jpg')
+      @file_list ||= Dir[File.join(path, pattern)].shuffle
+    end
+
+    def reset
+      @file_list = nil
+    end
+
+    def random_file
+      file_list.pop
+    end
+
+    def size
+      file_list.size
+    end
+  end
+
+end

data/lib/pi_slides/slideshow.rb

@@ -0,0 +1,92 @@
+module PiSlides
+  class Slideshow
+    attr_reader :fim, :interval
+
+    def initialize(image_dir, fim, options = {})
+      options = { :interval => 30 }.merge options
+      @interval = options[:interval]
+      @image_dir = image_dir
+      @fim = fim
+    end
+
+    # the pause/play/next/paused? methods are called from sinatra and
+    # manipulate instance variables that are checked by _run in the background
+    # thread.
+
+    def interval=(new_interval)
+      if @interval != new_interval
+        @interval = new_interval
+        self.next
+      end
+    end
+
+    def pause
+      @paused = true
+    end
+
+    def play
+      @paused = false
+    end
+
+    def next
+      @skip_to_next = true
+    end
+
+    def paused?
+      !!@paused
+    end
+
+    def running?
+      !paused?
+    end
+
+    def join
+      @thread.join
+    end
+
+    def stop
+      @stopped = true
+    end
+
+    def run
+      @thread = Thread.new{ _run }
+    end
+
+    private
+
+    def should_exit?
+      !!@stopped
+    end
+
+    def skip_to_next?
+      !!@skip_to_next
+    end
+
+    WAIT_INCREMENT = 0.2
+    def wait(interval)
+      time_spent = 0.0
+      while !skip_to_next? && (paused? || time_spent < interval) && !should_exit?
+        sleep WAIT_INCREMENT
+        time_spent += WAIT_INCREMENT
+      end
+      @skip_to_next = false
+    end
+
+    def _run
+      @paused = false
+      @skip_to_next = false
+      PiSlides.debug "running with #{@image_dir.size} files"
+      @fim.status_line false
+      loop do
+        while f = @image_dir.random_file
+          PiSlides.debug f
+          @fim.show f
+          wait @interval
+          return if should_exit?
+        end
+        @image_dir.reset
+      end
+    end
+
+  end
+end