Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rb2k/viddl-rb

An extendable commandline video downloader for flash video sites like vimeo, youtube, ...
https://github.com/rb2k/viddl-rb

Last synced: about 2 months ago
JSON representation

An extendable commandline video downloader for flash video sites like vimeo, youtube, ...

Awesome Lists containing this project

README 

        
## NOTE: UNMAINTAINED

**This project is currently unmaintained.**  

I am afraid that I (@rb2k) am not able to keep up with the amount of changes that sites like Youtube implement on a weekly basis. Even with the support of 3rd parties, there just isn't enough time to play catch up with the latest attempts in obfuscation of the URLs



For now, I'd recommend you take a look at [youtube-dl](http://rg3.github.io/youtube-dl/).  

They have over 300 contributors and might stand a chance :)  



Thanks to all of the contributors!  

If you feel like taking over the project, shoot me a message (@rb2k on twitter)!



## Original Readme



__viddl-rb:__

Initially created by Marc Seeger ([@rb2k](github.com/rb2k))



Repo: http://github.com/rb2k/viddl-rb



[![Gem Version](https://badge.fury.io/rb/viddl-rb.png)](http://badge.fury.io/rb/viddl-rb)[![Build Status](https://secure.travis-ci.org/rb2k/viddl-rb.png)](http://travis-ci.org/rb2k/viddl-rb) [![Dependency Status](https://gemnasium.com/rb2k/viddl-rb.png)](https://gemnasium.com/rb2k/viddl-rb)



__Installation:__



`gem install viddl-rb`



__Usage:__



Download a video:

    ```viddl-rb http://www.youtube.com/watch?v=QH2-TGUlwu4```



Viddl-rb supports the following command line options:

```

-e, --extract-audio              Extract the audio track of the download to a separate file

-a, --abort-on-failure           Abort if one of the videos in a list fails to download

-u, --url-only                   Just display the download url without downloading the file.

-t, --title-only                 Just display the title without downloading the file.

-f, --filter REGEX               Filters a video playlist according to the regex (Youtube only right now)

-s, --save-dir DIRECTORY         Specifies the directory where videos should be saved

-d, --downloader TOOL            Specifies the tool to download with. Supports 'wget', 'curl', 'aria2c' and 'net-http'

-q, --quality QUALITY            Specifies the video format and resolution in the following way: width:height:format (e.g. 1280:720:mp4)

                                 The width, height and format may be omitted with a *.

                                 For example, to match any quality with a height of 720 pixels in any format specify --quality *:720:*

-h, --help                       Displays the help screen

```



Download a video and extract the audio:

    ```viddl-rb http://www.youtube.com/watch?v=QH2-TGUlwu4 --extract-audio```



In both cases we'll name the output file according to the video title.



Setting the video save directory:

    ```viddl-rb http://vimeo.com/38372260 --save-dir C:/myvideos```



The --save-dir option works with both absolute and relative paths (relative based on the directory viddl-rb is run from).

If you want to save to a folder with spaces in it, you have to quote the path like this: --save-dir "C:/my videos"



__Want faster download speeds?__



Consider installing aria2 (http://aria2.sourceforge.net/). aria2 differs from curl and wget in that it supports opening multiple connections when downloading a file which may give significant speed improvements if the download service limits the bandwidth a connection receives. viddl-rb will use aria2 as the default downloader if it is available.



__Youtube plugin specifics:__



Download all videos on a playlist:

    ```viddl-rb http://www.youtube.com/playlist?list=PL7E8DA0A515924126```



Download all videos from a user:

    ```viddl-rb http://www.youtube.com/user/tedtalksdirector```



Download all videos from a channel:

    ```viddl-rb http://www.youtube.com/channel/UCa2K4rTxFfnyOhujv7Dmwlg```



Filter videos to download from a user/channel/playlist:

    ```viddl-rb http://www.youtube.com/user/tedtalksdirector --filter /internet/i```



The --filter argument accepts a regular expression and will only download videos where the title matches the regex.

It uses the same syntax as Ruby regular expression literals do.



__Library Usage:__



```ruby

require 'viddl-rb'



download_urls = ViddlRb.get_urls("http://www.youtube.com/watch?v=QH2-TGUlwu4")

download_urls.first     # => "http://o-o.preferred.arn06s04.v3.lscac ..."

```



The ViddlRb module has the following module public methods:



* __get_urls_names(url)__

-- Returns an array of one or more hashes that has the keys :url which

points to the download url and :name which points to the name

(which is a filename safe version of the video title with a file extension).

Returns nil if the url is not recognized by any plugins.



* __get_urls_exts(url)__

-- Same as get_urls_names but with just the file extension (for example ".mp4")

instead of the full filename, and the :name key is replaced with :ext.

Returns nil if the url is not recognized by any plugins.



* __get_urls(url)__

-- Returns an array of download urls for the specified video url.

Returns nil if the url is not recognized by any plugins.



* __get_names(url)__

-- Returns an array of filenames for the specified video url.

Returns nil if the url is not recognized by any plugins.



* __io=(io_object)__

-- By default all plugin output to stdout will be suppressed when the library is used.

If you are interested in the output of a plugin, you can set an IO object that

will receive all plugin output using this method. For example:



```ruby

require 'viddl-rb'



ViddlRb.io = $stdout     # plugins will now write their output to $stdout

```



All the __get__ methods in the ViddlRb module will raise either a ViddlRb::PluginError or a ViddlRb::DownloadError if the plugin fails.

A ViddlRb::PluginError is raised if the plugin fails in an unexpected way, and a ViddlRb::DownloadError is raised if the video could not be downloaded for some reason.

An example of that is if a Youtube video is not embeddable - then it can't be downloaded.



```ruby

begin

  ViddlRb.get_urls(video_url)

rescue ViddlRb::DownloadError => e

  puts "Could not get download url: #{e.message}"

rescue ViddlRb::PluginError => e

  puts "Plugin blew up! #{e.message}\n" +

       "Backtrace:\n#{e.backtrace.join("\n")}"

end

```



__Requirements:__



* curl/wget/aria2c or the [progress bar](http://github.com/nex3/ruby-progressbar/) gem

* [Nokogiri](http://nokogiri.org/)

* ffmpeg if you want to extract audio tracks from the videos



__Co Maintainers:__

* [kl](https://github.com/kl): Windows support (who knew!), bug fixes, veoh plugin, metacafe plugin, refactoring it into a library, ...

* [farleyknight](https://github.com/farleyknight): Various small fixes and improvements



__Contributors:__

* [albertoboni](https://github.com/albertoboni) bandcamp plugin, soundcloud improvements

* [divout](https://github.com/divout) aka Ivan K: blip.tv plugin, bugfixes

* [laserlemon](https://github.com/laserlemon): Adding gemnasium images to readme

* [mbajur](https://github.com/mbajur) aka Mike Bajur: The instagram plugin

* Sniper: bugfixes

* [Serabe](https://github.com/Serabe) aka Sergio Arbeo: packaging viddl as a binary

* [simplysoft](https://github.com/simplysoft): Improve vimeo plugin