activevlc 0.0.1

data/lib/activevlc/pipeline_dump.rb

@@ -0,0 +1,61 @@
+##
+## debug_print.rb
+## Login : <lta@still>
+## Started on  Fri Sep  6 17:42:31 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+require 'debugger'
+
+module ActiveVlc
+  module PipelineDump
+    extend ActiveSupport::Concern
+
+    TAB_WIDTH = 2
+
+    def _dump(depth = 0)
+      name = instance_eval &_find_in_ancestors(:_dump_name)
+      childs = instance_eval &_find_in_ancestors(:_dump_childs)
+
+      "#{_dump_depth(depth)}+ #{name}\n" +
+        childs.map { |c| c._dump(depth + 1) }.join
+    end
+
+    def _dump_depth(depth)
+      ' ' * depth * TAB_WIDTH
+    end
+
+    # FIXME Find an elegant way to do this :-/
+    # Here we walk the ancestor array to find the one which included us first and therefore
+    # has a default _dump_name and _dump_childs. It will stops to the first ancestor which has
+    # (re)defined it.
+    def _find_in_ancestors(sym)
+      klass = self.class
+      while klass.respond_to?(sym) and klass.superclass and not klass.send(sym)
+        klass = klass.superclass
+      end
+      klass.send(sym)
+    end
+
+    included do
+      dump_name { self.class.name }
+      dump_childs { [] }
+    end
+
+    module ClassMethods
+      attr_accessor :_dump_name, :_dump_childs
+
+      def dump_name(&block)
+        self._dump_name = block
+      end
+
+      def dump_childs(&block)
+        self._dump_childs = block
+      end
+    end
+  end
+end

data/lib/activevlc/stage/base.rb

@@ -0,0 +1,75 @@
+##
+## base.rb
+## Login : <lta@still>
+## Started on  Thu Sep  5 10:08:46 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+# Represents a stage in the pipeline
+module ActiveVlc::Stage
+  class Base
+    include ActiveVlc::PipelineDump
+    dump_name { "#{self.class.name}(#{@type}): #{options}" }
+
+    attr_reader :type
+    attr_reader :options
+
+    def initialize(type = :dummy)
+      @options = Hash.new
+      @type = type
+    end
+
+    def [](key) @options[key] end
+    def []=(key, value) @options[key] = value end
+
+    def fragment
+      _recurse_on_suboption(@type, @options)
+    end
+
+    protected
+    # Handles the rendering of the options hash to a vlc sout format
+    #
+    # key = vlc, value = {test: 42, sub: {_this_: 'this', opt1='foo'}, sub2: {opt2: 'bar'}}
+    # renders to "key{test=42,sub=this{opt1=foo},sub2{opt2:bar}}"
+    def _recurse_on_suboption(k, h)
+      map = h.map do |key, value|
+        if value.is_a?(Hash)
+          value_without_this = value.clone
+          this = value_without_this.delete :_this_
+          if this
+            "#{key}=#{_recurse_on_suboption(this, value_without_this)}"
+          else
+            _recurse_on_suboption(key, value)
+          end
+        else
+          if value.nil?
+            "#{key}"
+          elsif value == false
+            "no-#{key}"
+          else
+            "#{key}=#{format_value value}"
+          end
+        end
+      end.join(', ')
+
+      if map == ""
+        "#{k}"
+      else
+        "#{k}{#{map}}"
+      end
+    end
+
+    def format_value(value)
+      if value.is_a? String
+        "'#{value}'"
+      else
+        "#{value}"
+      end
+    end
+
+  end
+end

data/lib/activevlc/stage/chain.rb

@@ -0,0 +1,18 @@
+##
+## chain.rb
+## Login : <lta@still>
+## Started on  Tue Sep 10 19:43:11 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+module ActiveVlc::Stage
+  class Chain < Stream
+    def fragment
+      @chain.map{|s| s.fragment}.join ':'
+    end
+  end
+end

data/lib/activevlc/stage/duplicate.rb

@@ -0,0 +1,38 @@
+##
+## duplicate.rb
+## Login : <lta@still>
+## Started on  Thu Sep  5 10:15:03 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+require 'activevlc/stage/base'
+
+module ActiveVlc::Stage
+  class Duplicate < Base
+    attr_reader :stages
+
+    dump_childs { @stages }
+
+    def initialize()
+      super(:duplicate)
+      @stages = []
+    end
+
+    def <<(stage)
+      @stages.push stage
+      @stages.flatten!
+      self
+    end
+
+    def fragment
+      f = @stages.map do |s|
+        "dst=#{s.fragment}"
+      end.join ', '
+      "duplicate{#{f}}"
+    end
+  end
+end

data/lib/activevlc/stage/gather.rb

@@ -0,0 +1,18 @@
+##
+## gather.rb
+## Login : <lta@still>
+## Started on  Mon Sep  9 10:49:03 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+module ActiveVlc::Stage
+  class Gather < Base
+    def initialize
+      super :gather
+    end
+  end
+end

data/lib/activevlc/stage/input.rb

@@ -0,0 +1,41 @@
+##
+## input_stage.rb
+## Login : <lta@still>
+## Started on  Wed Sep  4 19:13:47 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+require 'activevlc/stage'
+
+module ActiveVlc::Stage
+  class Input < Base
+    include ActiveVlc::PipelineDump
+
+    attr_reader :inputs
+
+    def initialize(array_or_string)
+      super(:input)
+
+      @inputs = [array_or_string] if array_or_string.is_a? String
+      @inputs ||= array_or_string
+    end
+
+    def <<(new_inputs)
+      @inputs.push new_inputs
+      @inputs.flatten!
+      self
+    end
+
+    def fragment
+      @inputs.join ' '
+    end
+
+    dump_name { "Input : " + @inputs.join(', ') }
+    dump_childs { [] }
+  end
+end
+

data/lib/activevlc/stage/stream.rb

@@ -0,0 +1,33 @@
+##
+## stream_stage.rb
+## Login : <lta@still>
+## Started on  Wed Sep  4 19:35:50 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+module ActiveVlc::Stage
+  class Stream < Base
+    dump_childs { @chain }
+
+    def initialize
+      super :sout
+      @chain = []
+    end
+
+    def <<(stage)
+      @chain.push stage
+      @chain.flatten!
+      self
+    end
+
+    def fragment
+      return "" if @chain.empty?
+      sout_string = @chain.map{|s| s.fragment}.join ':'
+      ":sout=\"##{sout_string}\""
+    end
+  end
+end

data/lib/activevlc/stage/transcode.rb

@@ -0,0 +1,18 @@
+##
+## transcode.rb
+## Login : <lta@still>
+## Started on  Fri Sep  6 16:09:02 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+module ActiveVlc::Stage
+  class Transcode < Base
+    def initialize
+      super :transcode
+    end
+  end
+end

data/lib/activevlc/stage.rb

@@ -0,0 +1,23 @@
+##
+## stage.rb
+## Login : <lta@still>
+## Started on  Wed Jul  3 16:08:37 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+module ActiveVlc
+  module Stage
+  end
+end
+
+require 'activevlc/stage/base'
+require 'activevlc/stage/input'
+require 'activevlc/stage/stream'
+require 'activevlc/stage/duplicate'
+require 'activevlc/stage/transcode'
+require 'activevlc/stage/gather'
+require 'activevlc/stage/chain'

data/lib/activevlc/version.rb

@@ -0,0 +1,3 @@
+module ActiveVlc
+  VERSION = "0.0.1"
+end

data/lib/activevlc.rb

@@ -0,0 +1,7 @@
+require 'active_support'
+require 'activevlc/version'
+require 'activevlc/pipeline'
+require 'activevlc/dsl'
+
+module ActiveVlc
+end

data/spec/basic_pipe_spec.rb

@@ -0,0 +1,29 @@
+##
+## basic_pipe_spec.rb
+## Login : <lta@still>
+## Started on  Wed Jun 12 20:46:26 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+require 'spec_helper'
+
+describe ActiveVlc do
+  describe '::pipe_for' do
+    it 'creates a new Pipeline' do
+      ActiveVlc::Pipeline.for('test.mp4'){}.should be_a(ActiveVlc::Pipeline)
+    end
+
+    it 'has input file in the fragment string' do
+      ActiveVlc::Pipeline.for('test.mp4'){}.fragment.should match('test.mp4')
+    end
+
+    it 'handles an array of input' do
+      ActiveVlc::Pipeline.for(['test.mp4', 'test.flv']){}.fragment.should match(/test\.mp4.+test\.flv/)
+    end
+  end
+end
+

data/spec/basic_spec.rb

@@ -0,0 +1,40 @@
+##
+## basic.rb
+## Login : <lta@still>
+## Started on  Wed Jun 12 14:08:35 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+require 'spec_helper'
+
+describe ActiveVlc do
+  it 'has a version' do
+    ActiveVlc::VERSION.is_a?(String).should be_true
+  end
+
+  describe 'cmd' do
+    it 'return version number on \'version\' command' do
+      expect(`bundle exec activevlc version`).to match(/version \d+\.\d+\.\d+/)
+      expect(`bundle exec activevlc version`).to match(ActiveVlc::VERSION)
+    end
+  end
+
+  describe 'VLC detection' do
+    it 'detects and returns VLV version number on \'vlc version\'' do
+      expect(`bundle exec activevlc vlc version`).to match(/VLC version \d+\.\d+\.\d+/)
+    end
+
+    it 'tells if detected VLC version is supported on \'vlc version\'' do
+      expect(`bundle exec activevlc vlc version`).to match(/supported = (true|false)/)
+    end
+
+    it 'tells if detected VLC version is supported on \'vlc supported\'' do
+      expect(`bundle exec activevlc vlc supported`).to match(/(true|false)/)
+    end
+  end
+end
+

data/spec/pipeline_dump_spec.rb

@@ -0,0 +1,38 @@
+##
+## pipeline_dump_spec.rb
+## Login : <lta@still>
+## Started on  Mon Sep  9 12:31:23 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+require 'spec_helper'
+
+describe 'ActiveVlc::PipelineDump' do
+  describe 'CLI' do
+    it 'needs a pipeline file as paremeter' do
+      `bundle exec activevlc dump 2>&1`.should match(/ERROR/)
+    end
+    it 'needs an existent pipeline file' do
+      `bundle exec activevlc dump inexistent.rb`
+      $?.exitstatus.should_not eq(0)
+    end
+  end
+
+  it 'return a readable representation of the pipeline' do
+    dump = <<-DUMP
+ActiveVlc: Dumping pipeline internal representation
++ ActiveVlc::Pipeline
+  + Input : input.mp4
+  + ActiveVlc::Stage::Stream(sout): {}
+    + ActiveVlc::Stage::Transcode(transcode): {:acodec=>:aac, :vcodec=>:h264, :scodec=>:svcd}
+    + ActiveVlc::Stage::Duplicate(duplicate): {}
+      + ActiveVlc::Stage::Base(standard): {"mux"=>:mp4, "dst"=>"output.mp4"}
+      + ActiveVlc::Stage::Base(display): {}
+DUMP
+    ActiveVlc::Pipeline.parse('spec/pipes/transcode_and_display.rb').dump.should eq(dump)
+  end
+end

data/spec/pipeline_spec.rb

@@ -0,0 +1,84 @@
+##
+## pipeline_spec.rb
+## Login : <lta@still>
+## Started on  Wed Jul  3 15:57:47 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+require 'spec_helper'
+
+describe ActiveVlc::Pipeline do
+  describe '\'basic\' pipeline' do
+    it 'returns nil if the file doesn\'t exists' do
+      ActiveVlc::Pipeline.parse('dontexist.rb').should be_nil
+    end
+
+    it 'is loaded' do
+      pipe = ActiveVlc::Pipeline.parse 'spec/pipes/basic.rb'
+      pipe.class.should be(ActiveVlc::Pipeline)
+    end
+
+    it 'can produces a basic fragment' do
+      pipe = ActiveVlc::Pipeline.parse 'spec/pipes/basic.rb'
+      pipe.fragment.should match(/input.mp4/)
+    end
+
+    it 'allows adding new inputs' do
+      pipe = ActiveVlc::Pipeline.parse 'spec/pipes/basic.rb'
+      pipe.input << 'test.mp3'
+      pipe.fragment.should match(/input.mp4/)
+      pipe.fragment.should match(/test.mp3/)
+    end
+  end
+
+  describe '\'duplicate\' pipeline' do
+    it 'is loaded' do
+      ActiveVlc::Pipeline.parse('spec/pipes/duplicate.rb').class.should be(ActiveVlc::Pipeline)
+    end
+
+    it 'produce the correct fragment' do
+      expect(ActiveVlc::Pipeline.parse('spec/pipes/duplicate.rb').fragment)
+        .to eq("input.mp3 :sout=\"#duplicate{dst=display, dst=standard{dst='output.mp3'}}\"")
+    end
+  end
+
+  describe '\'transcode_and_display\' pipeline' do
+    it 'is loaded' do
+      ActiveVlc::Pipeline.parse('spec/pipes/transcode_and_display.rb').class.should be(ActiveVlc::Pipeline)
+    end
+
+    it 'produce the correct fragment' do
+      expect(ActiveVlc::Pipeline.parse('spec/pipes/transcode_and_display.rb').fragment)
+        .to eq("input.mp4 :sout=\"#transcode{acodec=aac, vcodec=h264, scodec=svcd}:duplicate{dst=standard{mux=mp4, dst='output.mp4'}, dst=display}\"")
+    end
+  end
+
+  describe '\'transcode_and_display_with_options\' pipeline' do
+    it 'is loaded' do
+      ActiveVlc::Pipeline.parse('spec/pipes/transcode_and_display_with_options.rb').class
+        .should be(ActiveVlc::Pipeline)
+    end
+
+    it 'produce the correct fragment' do
+      expect(ActiveVlc::Pipeline.parse('spec/pipes/transcode_and_display_with_options.rb').fragment)
+        .to eq("input.mp4 :sout=\"#gather:transcode{deinterlace, acodec=aac, ab=128, channels=2, vcodec=h264, venc=x264{bpyramid=strict, bframes=4, no-cabac}, vb=512}:duplicate{dst=standard{mux=mp4, dst='output.mp4'}, dst=display}\"")
+    end
+  end
+
+  describe '\'duplicate_then_transcode\' pipeline' do
+    it 'is loaded' do
+      ActiveVlc::Pipeline.parse('spec/pipes/duplicate_then_transcode.rb').class
+        .should be(ActiveVlc::Pipeline)
+    end
+
+    it 'produce the correct fragment' do
+      expect(ActiveVlc::Pipeline.parse('spec/pipes/duplicate_then_transcode.rb').fragment)
+        .to eq("input.mp4 :sout=\"#duplicate{dst=transcode{acodec=aac, vcodec=h264, scodec=svcd}:standard{mux=mp4, dst='output.mp4'}, dst=display}\"")
+    end
+  end
+
+end

data/spec/pipes/basic.rb

@@ -0,0 +1,14 @@
+##
+## basic.rb
+## Login : <lta@still>
+## Started on  Wed Jun 12 14:41:04 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+# Basic pipe for rspec testing
+
+ActiveVlc::Pipeline.for 'input.mp4'

data/spec/pipes/duplicate.rb

@@ -0,0 +1,18 @@
+##
+## duplicate.rb
+## Login : <lta@still>
+## Started on  Wed Sep  4 17:29:45 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+# input.mp3 :sout="#duplicate{dst=display, dst=std{dst='output.mp3'}}"
+ActiveVlc::Pipeline.for 'input.mp3' do
+  duplicate do
+    to :display
+    to file: 'output.mp3'
+  end
+end

data/spec/pipes/duplicate_then_transcode.rb

@@ -0,0 +1,29 @@
+##
+## duplicate_then_transcode.rb
+## Login : <lta@still>
+## Started on  Tue Sep 10 18:30:41 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+ActiveVlc::Pipeline.for 'input.mp4' do
+  duplicate do
+    to :chain do
+      #debugger
+      transcode do
+        audio :aac
+        video :h264
+        subtitle :svcd
+      end
+      to :file do
+        mux :mp4
+        dst 'output.mp4'
+      end
+    end
+    to :display
+  end
+end
+

data/spec/pipes/transcode_and_display.rb

@@ -0,0 +1,25 @@
+##
+## transcode_and_display.rb
+## Login : <lta@still>
+## Started on  Wed Jun 12 14:45:36 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+ActiveVlc::Pipeline.for 'input.mp4' do
+  transcode do
+    audio :aac
+    video :h264
+    subtitle :svcd
+  end
+  duplicate do
+    to :file do
+      mux :mp4
+      dst 'output.mp4'
+    end
+    to :display
+  end
+end

data/spec/pipes/transcode_and_display_with_options.rb

@@ -0,0 +1,36 @@
+##
+## transcode_and_display.rb
+## Login : <lta@still>
+## Started on  Wed Jun 12 14:45:36 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+ActiveVlc::Pipeline.for 'input.mp4' do
+  gather
+  transcode do
+    deinterlace
+    audio :aac do
+      bitrate 128 # 128 kpbs
+      channels 2
+    end
+    video :h264 do
+      encoder :x264 do
+        bpyramid :strict
+        bframes 4
+        cabac false
+      end
+      bitrate 512 # 512 kbps
+    end
+  end
+  duplicate do
+    to :file do
+      mux :mp4
+      dst 'output.mp4'
+    end
+    to :display
+  end
+end