activevlc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2cfe489b2cfbfad5e9f2e34f8047568c0d0d2308
+  data.tar.gz: bcb80b8ed6a3cd149d0a2d394885ee46ba780ca8
+SHA512:
+  metadata.gz: f7c078deb42fcad7eec5913ea57f994552e123e1293911b2e2c48eb52367e896d62b81e88371878d06a20604b362d073907312650ef45dd2d8f4f2227be11477
+  data.tar.gz: 01ac07764a7d0b86bebc5b816f0a2f900391909214e93f74d08f14ee443286b1065d3ee7e0b43ba2c0d31ef3958eea704af5bacacbea99151336ffe116bb36fb

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+-fd --color

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activevlc.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Julien 'Lta' BALLET
+
+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,89 @@
+# ActiveVlc
+
+Do you know VLC, the famous media player ? I'm pretty sure you do ! 
+Do you know this is also a pretty powerfull media processing and streaming framework ? Maybe...
+Do you understand something about the command line syntax to access vlc's underlying 
+powers ? If you don't this tool is for you !
+
+ActiveVlc provides a simple syntax to configure and run transcoding/streaming/processing 
+operations using VLC. Here's a simple example :
+
+## Example
+
+Let's say you want to read an mp4 file, transcode it using different options, save the result to 
+another file while displaying it to control what's happening. Using the standard vlc's chain syntax
+you'd have to write
+
+    vlc input.mp4 :sout="#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}"
+    
+Not very readable isn't it ? Let's try the same with ActiveVlc :
+
+```ruby
+AtiveVlc::Pipeline.for 'input.mp4' do
+  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
+```
+
+This sintax might be a lot more verbose than the original vlc's one, 
+it is still A LOT more readable and understandable, and since this is plain ruby
+you can add comment and arbitrary code !
+Then you can run it using :
+
+    activevlc exec /path/to/the/pipeline.rb
+    
+## Development status
+
+This gem is not yet published yet and is still under active 
+development althought it might already be usable for many usages
+
+## Installation
+
+First and foremost, you must have VLC installed on your system and the
+vlc binary must be in your PATH since we doesn't provide yet a cool 
+configuration system for this (contribution welcomed !)
+
+Add this line to your application's Gemfile:
+
+    gem 'activevlc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activevlc
+
+## Usage
+
+Currently, the best documentation is to have a look to the spec (/spec/pipes) 
+or to run the CLI tool to get the embedded help.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO.md

@@ -0,0 +1,12 @@
+TODO file for ActiveVlc
+=======================
+
+  - Portable vlc version detection and configuration
+  - vlc process management
+  - Preset support (this is also a cool way of documenting vlc's features
+  - vlc team suggestions (jb/etix)
+    - Some syntactic sugar for http-live will be helpfull, pay attention to this shitty module
+    - duplicate -> transcode, transcode -> duplicate
+  - Long-term ideas
+    - carrierwave integration
+

data/activevlc.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activevlc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activevlc"
+  spec.version       = ActiveVlc::VERSION
+  spec.authors       = ["Julien 'Lta' BALLET"]
+  spec.email         = ["contact@lta.io"]
+  spec.summary       = %q{DSL for building VLC pipelines}
+  spec.description   = %q{ActiveVlc provides a convenient DSL to build VLC transcoding and/or streaming pipelines}
+  spec.homepage      = "http://github.com/elthariel/activevlc"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "debugger"
+
+  spec.add_dependency 'thor'
+  spec.add_dependency 'activesupport'
+end

data/bin/activevlc

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'activevlc/cli'
+
+ActiveVlc::Cli.start

data/examples/design.rb

@@ -0,0 +1,84 @@
+##
+## design.rb
+## Login : <lta@still>
+## Started on  Wed Jun 12 01:18:11 2013 Lta Akr
+##
+## Author(s):
+##  - Julien 'Lta' BALLET <contact@lta.io>
+##
+## Copyright (C) 2013 Julien 'Lta' BALLET
+
+# This example isn't supposed to work yet. It justs document what it's
+# supposed to look like when it's ready
+
+pipe_for 'file.mp4' do |pipe|
+  transcode do
+    audio do
+      codec :aac do
+        rc_method :vbr
+        psy_model :test1
+      end
+      bitrate 256
+    end
+    video :h264 do
+      encoder :qsv
+      async_depth 6
+      h264_level '5.1'
+    end
+  end
+  deinterlace
+
+  duplicate do
+    to :dst do
+      caching 300
+      muxer 'mp4'
+      path '/tmp/test.mp4'
+    end
+    to :rtp do
+      caching 1500
+      muxer :ts
+      dst '192.168.0.1:4567'
+    end
+    to_display
+  end
+end
+
+
+
+#
+# Kind of memory representation of the next pipeline
+# Pipeline
+#   @stages =
+#      - Stage (@type = :transcode)
+#        @options = {
+#          acodec = {
+#            _this_: :aac,
+#            opt1:   'test',
+#            opt1:   'test',
+#          }
+#        }
+#      - DuplicateStage (@type = :duplicate)
+#        @substages =
+#          - Stage (@type = :standard)
+#            @options = {
+#              mux: 'mp4'
+#              dst: 'output.mp4'
+#            }
+#
+ActiveVlc::pipe_for 'input.mp4' do
+  transcode do
+    audio :aac do
+      opt1 'test'
+      opt2 'caca'
+      opt3 42
+    end
+    video :h264
+  end
+  duplicate do
+    to :file do
+      mux :mp4
+      dst 'output.mp4'
+    end
+    to :display
+  end
+end

data/lib/activevlc/cli/vlc.rb

@@ -0,0 +1,45 @@
+##
+## version.rb
+## Login : <lta@still>
+## Started on  Wed Sep  4 15:44:38 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+module ActiveVlc::CLI
+  class Vlc < Thor
+    desc 'version', 'reports currently found VLC version and if it is supported'
+    def version
+      v = _version
+      if v
+        puts "VLC version #{v[0]}.#{v[1]}.#{v[2]} (supported = #{_supported})"
+      else
+        puts "vlc binary NOT FOUND (probably not in $PATH)"
+      end
+    end
+
+
+    desc 'supported', 'returns whether the found vlc version is supported or not'
+    def supported
+      puts _supported
+    end
+
+    private
+    def _version
+      version_string = `vlc --version 2>&1`
+      if version_string =~ /version (\d+)\.(\d)+\.(\d)+/
+        [$1, $2, $3].map &:to_i
+      else
+        nil
+      end
+    end
+
+    def _supported
+      v = _version
+      v and v[0] == 2
+    end
+  end
+end

data/lib/activevlc/cli.rb

@@ -0,0 +1,73 @@
+##
+## cli.rb
+## Login : <lta@still>
+## Started on  Wed Jun 12 14:22:50 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+require 'activevlc'
+require 'thor'
+
+# Create the CLI module before loading CLI classes.
+module ActiveVlc::CLI
+end
+
+require 'activevlc/cli/vlc'
+
+
+
+module ActiveVlc
+  class Cli < Thor
+    package_name "ActiveVlc"
+
+    desc 'version', 'Show current ActiveVlc version'
+    def version
+      puts "ActiveVlc version #{ActiveVlc::VERSION}"
+    end
+
+    desc 'vlc SUBCOMMAND ...ARGS', 'vlc specific commands'
+    subcommand 'vlc', ActiveVlc::CLI::Vlc
+
+    desc 'fragment PIPE_PATH', 'Outputs vlc :sout=chain fragment for the pipe defined in \'PIPE_PATH\' file'
+    def fragment(path)
+      if File.readable?(path)
+        pipe = eval(File.read(path))
+        puts pipe.fragment
+      else
+        puts "Error: file [#{path}] doesn't exist or reading permission denied."
+        exit 42
+      end
+    end
+
+    desc 'exec PIPE_PATH', 'Run the PIPE_PATH pipe file in VLC'
+    def exec(path)
+      if File.readable?(path)
+        begin
+          pipe = eval(File.read(path))
+          fragment = pipe.fragment
+        rescue
+          puts "Error while parsing pipe file"
+          exit 43
+        end
+        Kernel.exec "cvlc -vvv --play-and-exit #{fragment}"
+      else
+        puts "Error: file [#{path}] doesn't exist or reading permission denied."
+      end
+        exit $?.exitstatus
+    end
+
+    desc 'dump PIPE_PATH', 'Dump the internal representation of the pipeline defined in the file PIPE_PATH'
+    def dump(path)
+      if File.readable?(path)
+        puts eval(File.read(path)).dump
+      else
+        puts "Error: file [#{path}] doesn't exist or reading permission denied."
+        exit 42
+      end
+    end
+  end
+end

data/lib/activevlc/dsl/base.rb

@@ -0,0 +1,35 @@
+##
+## base.rb
+## Login : <lta@still>
+## Started on  Wed Jun 12 20:59:51 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+module ActiveVlc::DSL
+  class Base
+    def initialize(context)
+      @context = context
+    end
+
+    def method_missing(sym, *args, &block)
+      __option(normalize_option(sym), args.first, &block)
+    end
+
+    protected
+    def normalize_option(name) name.to_s.downcase.gsub('_', '-') end
+
+    def __option(name, value, &block)
+      if block_given?
+        subcontext = { _this_: value }
+        Base.new(subcontext).instance_eval &block
+        @context[name] = subcontext
+      else
+        @context[name] = value
+      end
+    end
+  end
+end

data/lib/activevlc/dsl/duplicate.rb

@@ -0,0 +1,16 @@
+##
+## duplicate.rb
+## Login : <lta@still>
+## Started on  Fri Sep  6 15:56:10 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+module ActiveVlc::DSL
+  class Duplicate < Stream
+
+  end
+end

data/lib/activevlc/dsl/pipeline.rb

@@ -0,0 +1,31 @@
+##
+## pipeline.rb
+## Login : <lta@still>
+## Started on  Wed Jun 12 21:00:28 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+module ActiveVlc::DSL
+  module Pipeline
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def parse(path)
+        return nil unless File.exists?(path)
+
+        # FIXME I hope to find some cleaner way to do this at some point
+        eval(File.open(path).read, nil, path, 0)
+      end
+
+      def for(*inputs, &block)
+        pipeline = new(inputs)
+        ::ActiveVlc::DSL::Stream.new(pipeline.sout).instance_eval(&block) if block_given?
+        pipeline
+      end
+    end
+  end
+end

data/lib/activevlc/dsl/stream.rb

@@ -0,0 +1,75 @@
+##
+## stream.rb
+## Login : <lta@still>
+## Started on  Thu Sep  5 11:13:44 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+module ActiveVlc::DSL
+  class Stream < Base
+    # FIXME refactor more DRY
+    def method_missing(sym, *args, &block)
+      begin
+        klass = ActiveVlc::Stage.const_get sym.to_s.capitalize.to_sym
+      rescue
+        klass = ActiveVlc::Stage::Base
+        args.unshift(sym)
+      end
+
+      begin
+        dsl_klass = ActiveVlc::DSL.const_get sym.to_s.capitalize.to_sym
+      rescue
+        dsl_klass = ActiveVlc::DSL::Base
+      end
+
+      add_substage(klass, dsl_klass, *args, &block)
+    end
+
+    # FIXME This method contains some dirty syntactic sugar as a PoC and need refactor
+    def to(sym_or_hash, &block)
+      if sym_or_hash.is_a?(Hash)
+        type, opt = sym_or_hash.first
+      else
+        type, opt = [sym_or_hash]
+      end
+
+      if type == :chain
+        to_chain(&block)
+      elsif [:file, :standard, :std].include? type
+        to_file(opt, &block)
+      else
+        stage = ActiveVlc::Stage::Base.new(type)
+        # Evaluate against the DSL if a block is given
+        ActiveVlc::DSL::Base.new(stage).instance_eval(&block) if block_given?
+        @context << stage
+      end
+    end
+
+    def to_chain(&block)
+      chain = ActiveVlc::Stage::Chain.new
+      ActiveVlc::DSL::Stream.new(chain).instance_eval(&block) if block_given?
+      @context << chain
+    end
+
+    def to_file(dst = nil, &block)
+      stage = ActiveVlc::Stage::Base.new(:standard)
+      stage[:dst] = dst if dst
+
+      # Evaluate against the DSL if a block is given
+      ActiveVlc::DSL::Base.new(stage).instance_eval(&block) if block_given?
+      @context << stage
+    end
+
+    protected
+    def add_substage(stage_klass, dsl_klass, *args, &block)
+      stage = stage_klass.new(*args)
+      @context << stage
+      dsl = dsl_klass.new(stage)
+      dsl.instance_eval &block if block_given?
+    end
+  end
+end

data/lib/activevlc/dsl/transcode.rb

@@ -0,0 +1,56 @@
+##
+## transcode.rb
+## Login : <lta@still>
+## Started on  Fri Sep  6 16:04:12 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+module ActiveVlc::DSL
+  class Transcode < Base
+    def audio(codec, &block)
+      __option :acodec, codec
+      TranscodeAudio.new(@context).instance_eval &block if block_given?
+    end
+    def video(codec, &block)
+      __option :vcodec, codec
+      TranscodeVideo.new(@context).instance_eval &block if block_given?
+    end
+    def subtitle(codec, &block)
+      __option :scodec, codec
+      TranscodeSubtitle.new(@context).instance_eval &block if block_given?
+    end
+  end
+
+
+  # Syntactic sugar classes for different type of streams
+  class TranscodeAudio < Base
+    def bitrate(val)
+      __option :ab, val
+    end
+    def encoder(val, &block)
+      __option :aenc, val, &block
+    end
+  end
+
+  class TranscodeVideo < Base
+    def bitrate(val)
+      __option :vb, val
+    end
+    def encoder(val, &block)
+      __option :venc, val, &block
+    end
+  end
+
+  class TranscodeSubtitle
+    def encoder(val, &block)
+      __option :senc, val, block
+    end
+    def filter(val)
+      __option :sfilter, val
+    end
+  end
+end

data/lib/activevlc/dsl.rb

@@ -0,0 +1,22 @@
+##
+## dsl.rb
+## Login : <lta@still>
+## Started on  Wed Jun 12 20:48:40 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+module ActiveVlc
+  module DSL
+  end
+end
+
+require 'activevlc/pipeline'
+require 'activevlc/dsl/base'
+require 'activevlc/dsl/pipeline'
+require 'activevlc/dsl/stream'
+require 'activevlc/dsl/transcode'
+require 'activevlc/dsl/duplicate'

data/lib/activevlc/pipeline.rb

@@ -0,0 +1,37 @@
+##
+## pipeline.rb
+## Login : <lta@still>
+## Started on  Wed Jun 12 20:46:52 2013 Lta Akr
+## $Id$
+##
+## Author(s):
+##  - Lta Akr <>
+##
+## Copyright (C) 2013 Lta Akr
+
+require 'activevlc/pipeline_dump'
+require 'activevlc/stage'
+require 'activevlc/dsl/pipeline'
+
+module ActiveVlc
+  class Pipeline
+    include DSL::Pipeline
+    include PipelineDump
+
+    attr_reader :input, :sout
+
+    def initialize(input_array_or_string)
+      @input = Stage::Input.new(input_array_or_string)
+      @sout = Stage::Stream.new  # SOut = Stream Out
+    end
+
+    def fragment
+      [@input.fragment, @sout.fragment].join ' '
+    end
+
+    dump_childs { [input, sout] }
+    def dump
+      "ActiveVlc: Dumping pipeline internal representation\n" + _dump
+    end
+  end
+end