csd 0.4.0 → 0.4.1

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/csd.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{csd}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Technology Transfer Alliance Team"]
-  s.date = %q{2010-09-23}
+  s.date = %q{2010-09-27}
   s.description = %q{CSD stands for Communication Systems Design and is a project of the Telecommunication Systems Laboratory (TSLab) of the Royal Institute of Technology in Stockholm, Sweden. Within CSD many software tools are used to build up various networks and services. This gem is supposed to automate processes to handle the compilation and installation of these software tools. Technology Transfer Alliance (TTA) is the project team, which maintains this code.}
   s.email = %q{mtoday11@gmail.com}
   s.executables = ["ai", "ttai"]

data/lib/csd/application/decklink/base.rb

@@ -10,6 +10,7 @@ module CSD
         #
         DEBIAN_DEPENDENCIES = %w{ libnotify-bin libmng1 dkms }
         
+        # Command to block BlackMagic Design Decklink driver loaded together with system boot.
         MODPROBE_BLACKLIST = %{# Minisip.org
 # We know that BlackMagic Design Decklink conflicts
 # with fglrx. We would like to load it manually later
@@ -89,7 +90,10 @@ blacklist blackmagic
           end
         end
         
-        # This method extracts the tar file of DeckLink driver.
+        # This method extracts the tar file of DeckLink driver. AI will first check whether the tar files have been
+        # extracted, if not, AI will create a working directory for the tar file and extract the tar file into the 
+        # newly created directory.
+        #
         def extract
           if Path.packages.directory?
             UI.warn "The tar file will not be extracted, because package repository already exist: #{Path.packages.enquote}"
@@ -101,6 +105,10 @@ blacklist blackmagic
           end
         end
         
+        # The method executes the Debian package of the selected DeckLink driver. It starts with detecting the architecture
+        # of current system, and then picks up the corresponding drivers. Before execute the selected Debian file, AI will
+        # also install all the Library dependencies of DeckLink driver.
+        #
         def apply
           Cmd.cd Path.packages, :internal => true
           archflag = Gem::Platform.local.cpu =~ /64/ ? 'amd64' : 'i386'
@@ -111,6 +119,9 @@ blacklist blackmagic
           Cmd.run "sudo dpkg -i #{file.first || '[DRIVER FILE FOR THIS ARCHITECTURE]'}", :announce_pwd => false
         end
         
+        # The method add Blackmagic to the kernel module blacklist and load it on runtime after system boot.
+        # The reason of doing that is because BlackMagic Design Decklink conflicts with fglrx.
+        #
         def add_boot_loader
           UI.info "Adding Blackmagic to the kernel module blacklist".green.bold
           Cmd.touch_and_replace_content Path.new_blacklist, MODPROBE_BLACKLIST
@@ -122,15 +133,22 @@ blacklist blackmagic
           Cmd.run "sudo update-rc.d blackmagic defaults", :announce_pwd => false
         end
         
+        # The method loads DeckLink driver after completion of the installation process.
+        #
         def load_kernel_module
           UI.info "Loading Decklink drivers".green.bold
           Cmd.run "sudo modprobe blackmagic", :announce_pwd => false
         end
-
+        
+        # This method notifies users that decklinik installation process is completed successfully.
+        # This notification will be shown on the top right of the desktop in Ubuntu system.
+        #
         def send_notification
           Cmd.run %{notify-send --icon=gdm-setup "DeckLink installation complete" "You are now ready to use your Blackmagic Design DeckLink device." }, :internal => true, :die_on_failure => false
         end
         
+        # This method is to define relative path in decklink module. This will make the program clean and easy to read.
+        #
         def define_relative_paths
           blacklink_repository   = 'http://www.blackmagic-design.com/downloads/software/'
           decklink_basename      = 'DeckLink_Linux_7.9'

data/lib/csd/application/i2conf/base.rb

@@ -99,7 +99,7 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           return unless Options.apt_get
           UI.info "Installing Debian dependencies for i2conf".green.bold
           Cmd.run 'sudo apt-get update', :announce_pwd => false
-          Cmd.run "sudo apt-get install #{DEBIAN_DEPENDENCIES.sort.join(' ')} --yes --fix-missing", :announce_pwd => false
+          Cmd.run "sudo apt-get install #{DEBIAN_DEPENDENCIES.sort.join(' ')} --yes --fix-missing --force-yes", :announce_pwd => false
         end
         
         # The method checks out the Lib strManager source code from git repository.
@@ -139,7 +139,7 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           Cmd.cd Path.str_manager, :internal => true
           Cmd.run './configure'
           Cmd.run 'aclocal'
-          Cmd.run 'make -j 15'
+          Cmd.run "make -j #{Options.threads}"
           Cmd.run 'sudo make install'
           Cmd.run "sudo ldconfig /usr/local/lib/libstrmanager.so", :announce_pwd => false
         end
@@ -177,7 +177,7 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           Cmd.run './bootstrap'
           Cmd.run './configure'
           Cmd.run 'aclocal'
-          Cmd.run 'make -j 15'
+          Cmd.run "make -j #{Options.threads}"
           Cmd.run 'sudo make install'
         end
         

data/lib/csd/application/minisip/base.rb

@@ -127,6 +127,7 @@ module CSD
           Path.repository_avdecoder_cxx           = Pathname.new(File.join(Path.repository, 'libminisip', 'source', 'subsystem_media', 'video', 'codec', 'AVDecoder.cxx'))
           Path.repository_sip_conf                = Pathname.new(File.join(Path.repository, 'libminisip', 'source', 'subsystem_signaling', 'sip', 'SipSoftPhoneConfiguration.cxx'))
           Path.repository_decklinksdk             = Pathname.new(File.join(Path.repository_grabber, 'decklinksdk'))
+          Path.repository_main_window             = Pathname.new(File.join(Path.repository, 'minisip', 'minisip', 'gui', 'gtkgui', 'MainWindow.cxx'))
           Path.ffmpeg_repository                  = Pathname.new(File.join(Path.work, 'ffmpeg'))
           Path.ffmpeg_libavutil                   = Pathname.new(File.join(Path.ffmpeg_repository, 'libavutil'))
           Path.ffmpeg_libavutil_common            = Pathname.new(File.join(Path.ffmpeg_libavutil, 'common.h'))

data/lib/csd/application/minisip/component/core.rb

@@ -17,7 +17,7 @@ module CSD
           # are sorted according to the sequence in which they need to be compiled (because they depend on each other).
           #
           LIBRARIES = %w{ libmutil libmnetutil libmcrypto libmikey libmsip libmstun libminisip minisip mloggingutil }
-          
+
           class << self
             
             include Packaging
@@ -43,6 +43,15 @@ module CSD
               update_decklink_firmware
             end
             
+            # The method removes FFmpeg, if FFmpeg is already installed in the system before MiniSIP compilation.
+            # This is because MiniSIP use HDViper as its H.264 encoder, while HDviper use modified FFmpeg library within it.
+            # This may cause conflict with original FFmpeg library. The solution to that is to remove FFmpeg before MiniSIP
+            # compilation and install it again after completion of MiniSIP compilation process.
+            # However,if the user set the option "--force-ffmpeg", AI will skip the process, even though FFmpeg may have been
+            # installed in the system.
+            # Currently, FFmpeg must have been installed via apt-get or via the AI in order for this to work,
+            # because manual compilations of FFmpeg cannot be removed automatically.
+            # 
             def remove_ffmpeg
               ffmpeg_available = Cmd.run('ffmpeg -h', :internal => true, :die_on_failure => false).success?
               return if Options.ffmpeg_first or !libraries.include?('libminisip') or !ffmpeg_available
@@ -78,6 +87,12 @@ module CSD
             def libraries
               Options.only ? LIBRARIES.map { |lib| lib if Options.only.to_a.include?(lib) }.compact : LIBRARIES
             end
+
+            # Determines which libraries of MiniSIP should be configured using --enable-debug
+            #
+            def debug_libraries
+              Options.enable_debug_on ? LIBRARIES.map { |lib| lib if Options.enable_debug_on.to_a.include?(lib) }.compact : LIBRARIES
+            end
             
             # This method downloads the minisip source code in the right version. If the <tt>Options.branch</tt>
             # parameter is set to a branchname of the source code repository, that branch will be downloaded. Currently
@@ -103,6 +118,10 @@ module CSD
               Cmd.run 'git submodule update'
             end
             
+            # The method downloads MiniSIP source code from official SVN repository. If the <tt>Options.vendor</tt>
+            # parameter is set, AI will not use the default git repository and use SVN to download the source code
+            # of MiniSIP.
+            #
             def checkout_from_vendor
               Cmd.cd Path.work, :internal => true
               Cmd.run "svn checkout svn://svn.minisip.org/minisip/trunk minisip"
@@ -143,9 +162,14 @@ module CSD
                 Cmd.replace Path.repository_avcoder_cxx,   'PIX_FMT_RGBA32', 'PIX_FMT_RGB32'
                 Cmd.replace Path.repository_avdecoder_cxx, 'PIX_FMT_RGBA32', 'PIX_FMT_RGB32'
               end
+              # Changing MiniSIP HELP Version text
+              repository_name = Options.vendor ? 'SVN repository' : "Github (#{Options.branch})"
+              Cmd.replace Path.repository_main_window, '(VERSION)', %{("#{repository_name} via AI #{CSD::Version.gsub("\n", '')}")}
               modify_libminisip_rules
             end
             
+            # The method fixes libminisip Debian rules file.
+            #
             def modify_libminisip_rules
               if Path.repository_libminisip_rules_backup.file?
                 UI.warn "The libminisip rules seem to be fixed already, I won't touch them now. Delete #{Path.repository_libminisip_rules_backup.enquote} to enforce it."
@@ -168,12 +192,20 @@ module CSD
               end
             end
             
+            # The method links shared MiniSIP libraries by +ldconfig+ command. +ldconfig+ determines run-time
+            # linkbindings between ld.so and shared libraries. It scans a running system and sets up the
+            # symbolic links that are used to load shared libraries properly.
+            #
             def link_libraries
               return if Options.this_user
               UI.info "Linking shared MiniSIP libraries".green.bold
               Cmd.run "sudo ldconfig #{Path.build_lib_libminisip_so}", :announce_pwd => false
             end
             
+            # The method holds the CPPFLAGS value, where MiniSIP +make+ process is needed. CPPFLAGS is for compiler to find
+            # the libraries and their header files. When force_ffmpeg option is set, the value of CPPFLAGS will also includes
+            # the path to related FFmpeg libraries.
+            #
             def libminisip_cpp_flags
               if Options.ffmpeg_first
                 %{CPPFLAGS="-I#{Path.hdviper_x264} -I#{Path.hdviper_x264_test_x264api} -I#{Path.ffmpeg_libavutil} -I#{Path.ffmpeg_libavcodec} -I#{Path.ffmpeg_libswscale} -I#{Path.repository_grabber} -I#{Path.repository_decklinksdk}"}
@@ -182,6 +214,9 @@ module CSD
               end
             end
             
+            # The method holds the LDFLAGS value, where MiniSIP +make+ process is needed. CPPFLAGS is for linker to find
+            # the libraries and their header files.
+            #
             def libminisip_ld_flags
               %{LDFLAGS="#{Path.hdviper_libx264api} #{Path.hdviper_libtidx264} -lpthread -lrt"}
             end
@@ -235,10 +270,19 @@ module CSD
               end
             end
             
+            # This method runs the `configure´ command in the current directory unless --no-configure was given.
+            # It is only used for the internal MiniSIP libraries.
+            #
             def configure(name='')
               configure! name if Options.configure
             end
             
+            # This method forces running the `configure´ command in the current directory.
+            # It is only used for the internal MiniSIP libraries.
+            # If enable_debug option is set, the configuration option will include "--enable-debug", except for the default options.
+            # If blank_minisip_configuration option is set, the configuration option will be blank. For example, this option will be
+            # used during the i2conf server setting-up procedure.
+            #
             def configure!(name='')
               individual_options = case name
                 when 'libminisip'
@@ -249,7 +293,7 @@ module CSD
                   ''
               end
               # The --enable-debug option should only be there if specifically requested
-              debug_options = '--enable-debug' if Options.enable_debug
+              debug_options = '--enable-debug' if Options.enable_debug or debug_libraries.include?(name)
               # These options are used by all libraries
               common_options = %Q{--prefix="#{Path.build}" PKG_CONFIG_PATH="#{Path.build_lib_pkg_config}" ACLOCAL_FLAGS="#{Path.build_share_aclocal}" LD_LIBRARY_PATH="#{Path.build_lib}"} if Options.this_user
               # I2conf needs to compile MiniSIP without any options
@@ -258,18 +302,31 @@ module CSD
               Cmd.run ['./configure', common_options, debug_options, individual_options].compact.join(' ')
             end
             
+            # This method runs the `make´ command in the current directory unless --no-make was given.
+            # It is only used for the internal MiniSIP libraries.
+            #
             def make
               make! if Options.make
             end
             
+            # This method forces running the `make´ command in the current directory.
+            # It is only used for the internal MiniSIP libraries.
+            # AI uses "-j 15" option of +make+ command to speed up the make process.
+            #
             def make!
-              Cmd.run("make -j 15")
+              Cmd.run "make -j #{Options.threads}"
             end
             
+            # This method runs the `make install´ command in the current directory unless --no-make-install was given.
+            # It is only used for the internal MiniSIP libraries.
+            #
             def make_install
               make_install! if Options.make_install
             end
             
+            # This method forces running the `make install´ command in the current directory.
+            # It is only used for the internal MiniSIP libraries.
+            #
             def make_install!
               if Options.this_user
                 Cmd.run("make install")
@@ -289,6 +346,9 @@ module CSD
               end
             end
             
+            # The method create default MiniSIP phonebook for MiniSIP. The default phonebook is derived from carenet-se scenario,
+            # users can modify it in MiniSIP GUI after MiniSIP successfully installed.
+            #
             def create_address_book
               return unless !Path.phonebook.file? or ::CSD::Application::Minisip::OUTDATED_PHONEBOOKS.include?(File.read(Path.phonebook).hashed)
               UI.info "Creating default MiniSIP phonebook".green.bold
@@ -317,6 +377,8 @@ module CSD
               Cmd.run "sudo aticonfig --set-pcs-u32=BUSID-2:0:0-0/OpenGL,VSyncControl,2", :announce_pwd => false
             end
             
+            # The method updates Decklink Firmware (if needed).
+            #
             def update_decklink_firmware
               UI.info "Updating Decklink Firmware (if needed)".green.bold
               Cmd.run "BlackmagicFirmwareUpdater update", :announce_pwd => false, :die_on_failure => false

data/lib/csd/application/minisip/component/core_packaging.rb

@@ -30,11 +30,25 @@ module CSD
               end
             end
             
+            # This method is to provide general introductions to users, like current working directory.
+            # Since MiniSIP need to be installed before packaging its core libraries, AI will first check whether MiniSIP
+            # has been compiled in the current working directory, if it is not, AI will raise an error and notify users to
+            # to install MiniSIP before packaging, other wise, AI will continue with its operation.
+            #
+            # ====Options
+            # [debug]  If debug option is set, users will be notified about system platform and current working module.
+            # [help]   If help option is set, AI will provide all help information and cleanup in case the working directory was temporary and is empty.
+            # [reveal] If reveal option is set, AI will continue and process the next method.
+            # [yes]    If yes option is set, AI will continue and process the next method.
+            # 
+            # If users did not specify any option, AI will ask for their willingness to continue and process the next method 
+            # after the users choose 'yes'. Or AI will terminate its operation.
+            # 
             def packing_introduction
               UI.info " Working directory:       ".green.bold + Path.work.to_s.yellow
               unless Path.repository.directory?
                 UI.warn "#{::CSD.executable} install minisip --no-temp"
-                raise Error::Minisip::Core::PackagingNeedsInstalledMinisip
+                raise Error::Minisip::Core::PackagingNeedsInstalledMinisip,"Please install MiniSIP by AI, before creating its Debain packages. "
               end
               UI.separator
               if Options.help
@@ -46,13 +60,20 @@ module CSD
                 raise Interrupt unless Options.yes or Options.reveal or UI.continue?
               end
             end
-        
+            
+            # The method initiates corresponding method to package MiniSIP core libraries. The reason of doing that
+            # is to keep the source code clean and easy to read.
+            #
             def package!
               make_dist
               extract_tar_file
               build_package
             end
             
+            # The method executes +make+ +dist+ command for each selected MiniSIP core library. This operation will
+            # create a tar file for each library, and AI will copy the tar file to the directory, which is created by AI
+            # to store all the intermediate files during the packaging process.
+            #
             def make_dist
               UI.info "Making #{@library} with target dist".green.bold
               Cmd.cd(@directory) or Options.reveal
@@ -61,12 +82,18 @@ module CSD
               Cmd.move(File.join(@directory, @tar_filename.to_s), Path.packaging) if @tar_filename or Options.reveal
             end
             
+            # The method extracts the tar files, which are generated by previous +make+ +dist+ steps.
+            #
             def extract_tar_file
               Cmd.cd(Path.packaging) or Options.reveal
               Cmd.run("tar -xzf #{@tar_filename}")
               @tar_dirname = File.basename(@tar_filename.to_s, '.tar.gz')
             end
               
+            # The method makes Debain packages for each core MiniSIP libraries. Before building each package, all its
+            # library dependencies need to installed first. Thus AI installs the packages, right after the building process
+            # is finished. AI also creates a separate directory to store all the Debian packages.
+            #
             def build_package
               Cmd.cd(File.join(Path.packaging, @tar_dirname))
               Cmd.run("dpkg-buildpackage -rfakeroot")

data/lib/csd/application/minisip/component/ffmpeg.rb

@@ -65,7 +65,7 @@ module CSD
               UI.info "Compiling and installing FFmpeg".green.bold
               Cmd.cd Path.ffmpeg_repository, :internal => true
               Cmd.run("#{c_flags} ./configure --enable-gpl --enable-libx264 --enable-x11grab")
-              Cmd.run('make -j 15')
+              Cmd.run "make -j #{Options.threads}"
               Cmd.run('sudo checkinstall --pkgname=ffmpeg --pkgversion "99:-`git log -1 --pretty=format:%h`" --backup=no --default')
             end
             

data/lib/csd/application/minisip/component/hdviper.rb

@@ -36,9 +36,9 @@ module CSD
               UI.info "Compiling HDVIPER".green.bold
               Cmd.cd Path.hdviper_x264, :internal => true
               Cmd.run('./configure')
-              Cmd.run('make -j 15')
+              Cmd.run "make -j #{Options.threads}"
               Cmd.cd Path.hdviper_x264_test_x264api, :internal => true
-              Cmd.run('make -j 15')
+              Cmd.run "make -j #{Options.threads}"
             end
           
           end

data/lib/csd/application/minisip/component/x264.rb

@@ -30,7 +30,7 @@ module CSD
               UI.info "Compiling and installing x264".green.bold
               Cmd.cd Path.x264_repository, :internal => true
               Cmd.run('./configure')
-              Cmd.run('make -j 15')
+              Cmd.run "make -j #{Options.threads}"
               Cmd.run('sudo checkinstall --pkgname=x264 --pkgversion "99:-`git log -1 --pretty=format:%h`" --backup=no --default')
             end
             

data/lib/csd/application/minisip/options/install.rb

@@ -1,9 +1,9 @@
 # -*- encoding: UTF-8 -*-
 # This file gets eval'ed by the global options parser in lib/csd/options_parser
 
-opts.on("--this-user","Compile MiniSIP only for the current user (enforces the --no-temp option)") do |value|
-  self.this_user = value
-end
+#opts.on("--this-user","Compile MiniSIP only for the current user (enforces the --no-temp option)") do |value|
+#  self.this_user = value
+#end
 
 opts.on("--no-apt-get","Don't run any apt-get commands") do |value|
   self.apt_get = value
@@ -43,10 +43,18 @@ opts.on("--no-make-install","Don't run the make install command on any MiniSIP l
   self.make_install = value
 end
 
+opts.on("--threads [INT]", Integer, "Simultaneous compiling with this many threads (e.g. 10)") do |value|
+  self.threads = value
+end
+
 opts.on("--only libmutil,libmsip,etc.", Array, "Process only these libraries") do |list|
   self.only = list
 end
 
-opts.on("--enable-debug","Enable MiniSIP-internal debugging") do |value|
+opts.on("--enable-debug","Enable full MiniSIP-internal debugging") do |value|
   self.enable_debug = value
 end
+
+opts.on("--enable-debug-on libmsip,..", Array, "Enable MiniSIP-internal debugging only for these libraries") do |list|
+  self.enable_debug_on = list
+end

data/lib/csd/application/minisip/options/install_defaults.rb

@@ -1,12 +1,14 @@
-self.this_user = false
+self.this_user = false # Deprecated, that's why always false
 self.apt_get = true
 self.ffmpeg_first = false
 self.github_tar = false
 self.vendor = false
 self.branch = 'edge'
+self.threads = 1
 self.bootstrap = true
 self.configure = true
 self.make = true
 self.make_install = true
 self.only = nil
-self.enable_debug = false
+self.enable_debug = false
+self.enable_debug_on = nil

data/lib/csd/application/minisip/unix/linux/debian.rb

@@ -8,7 +8,7 @@ module CSD
         
         # A list of apt-get packages that are required to compile minisip including hdviper and ffmpeg
         #
-        DEBIAN_DEPENDENCIES = %w{ automake build-essential checkinstall git-core libasound2-dev libavcodec-dev libglademm-2.4-dev libgtkmm-2.4-dev libltdl3-dev libnotify-bin libsdl-dev libsdl-ttf2.0-dev libssl-dev libswscale-dev libtool libx11-dev libxv-dev nasm subversion yasm }
+        DEBIAN_DEPENDENCIES = %w{ automake build-essential checkinstall git-core libasound2-dev libavcodec-dev libglademm-2.4-dev libgtkmm-2.4-dev libltdl-dev libnotify-bin libsdl-dev libsdl-ttf2.0-dev libssl-dev libswscale-dev libtool libx11-dev libxv-dev nasm subversion yasm }
 
         def compile!
           aptitude
@@ -39,7 +39,7 @@ module CSD
           return unless Options.apt_get
           UI.info "Installing Debian dependencies for MiniSIP".green.bold
           Cmd.run 'sudo apt-get update', :announce_pwd => false
-          Cmd.run "sudo apt-get install #{DEBIAN_DEPENDENCIES.sort.join(' ')} --yes --fix-missing", :announce_pwd => false
+          Cmd.run "sudo apt-get install #{DEBIAN_DEPENDENCIES.sort.join(' ')} --yes --fix-missing --force-yes", :announce_pwd => false
           # For some reason OpenGL crashes if we try to use this packet.
           # return unless Gem::Platform.local.ubuntu_10? or Options.reveal
           # UI.info "Installing 2D/3D acceleration for ATI graphic cards".green.bold

data/lib/csd/path_container.rb

@@ -4,18 +4,26 @@ require 'ostruct'
 module CSD
   class PathContainer < OpenStruct
     
+    # This method chooses and holds the container for root privilege.
+    #
     def root
       @root ||= Dir.pwd
     end
     
+    # This method chooses and holds the container for gem.
+    #
     def gem
       @gem ||= File.expand_path(File.join(File.dirname(__FILE__), '..' ,'..'))
     end
     
+    # This method chooses and holds the container for vendor.
+    #
     def vendor
       @vendor ||= File.join(self.gem, 'vendor')
     end
     
+    # This method chooses and holds the container for applications.
+    #
     def applications
       @applications ||= File.expand_path(File.join(self.gem, 'lib', 'csd', 'application'))
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: csd
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Technology Transfer Alliance Team
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-23 00:00:00 +02:00
+date: 2010-09-27 00:00:00 +02:00
 default_executable: 
 dependencies: []