destreamerの使い方(日本語要約)

destreamerとは、Microsoft Streamの動画を保存し、オフライン環境でも視聴できるようにするためのツールです。

速報(ソフトウェアの更新履歴)

destreamer v3.0がリリースされます！ダウンロード速度の向上は驚くべきレベルとなりました:) このバージョンのコードネームを決める議論がここで行われています。ブランチは、ここです。

destreamer v2がリリースされました！

免責事項

destreamerを利用したことによる責任について、製作者、もしくはこの翻訳者は、一切負いません。
最新の情報は、destreamerのrepoを確認してください。
この内容は、公式文章の翻訳(意訳含む)の他に、公式README.mdに記載のない情報も含まれています。

前提条件

Node.js: バージョンは8.0以降である必要があります。利用するNodeが、Node 8の場合はParse Errorのcode: HPE_HEADER_OVERFLOWを受け取るかもしれません。その際は、Node 10以上にアップデートし、再度ビルドをしてください。
npm: 通常Node.jsインストール時に入っています。コマンドラインで npm と入力してインストールしているか確認してください。
ffmpeg: 2019年以降の最新バージョンである必要があります。パスを通すか、プロジェクトのルートディレクトリに入れてください。
git: npmの依存関係。

動作環境

Win/Mac/Linux で動作します。

Windows

destreamer.cmd (コマンドプロンプト)か、
destreamer.ps1(PowerShell) で実行してください。
改行している場合、エスケープ文字も必要です。
PowerShellはバックティック[ ` ]を使用し、cmd.exeはキャレット[ ^ ]を使用します。
MinGWや、MSYS、Cygwinでは動作しないことがあります。
(一部ユーザーからは、出来ないとの報告が上がっています。)
WSLでは動作しません。詳しくは、公式README.mdに記載してあります。
管理者権限で実行すると動作しないことがあります。

Mac/Linux

destreamer.sh(ターミナル)で実行してください。
改行している場合には、エスケープ文字も必要です。
rootユーザーの場合、動作しないことがあります。

ビルド方法

destreamerをビルドするには、repoのcloneを作成。
前提条件のソフトをインストールした後npmでビルドするだけです。
以下に入力するコマンドを記します。

$ echo +++++前提条件をここまでに整えておくと手間が省けます。+++++
$ git clone https://github.com/snobu/destreamer
$ cd destreamer
$ npm install
$ npm run build

オプションを意訳すると…

$ ./destreamer.sh

オプション:
  --help                   ヘルプを表示します
  --version                バージョンを表示します
  --username, -u           "username@example.com"の形式でユーザー名を入力します
  --videoUrls, -i          このオプションの後にURLを入力します
  --inputFile, -f      このオプションの後にURLを記載したtxtファイルへのパスを
                           入力します
  --outputDirectory, -o    出力ファイルを配置するディレクトリを変更します
                          （無指定の場合、プロジェクトファイル配下の`videos`に
                            そのまま保存します）
  --outputDirectories, -O  出力ファイルを配置するディレクトリを変更します
                          （1リンクごとに、一つ新たにディレクトリを作成し保存します）
  --outputTemplate, -t    保存する動画のファイル名を変更します
                          記法はREADME(日本語版 or 公式)を参照してください。
                                 [default: "{title} - {publishDate} {uniqueId}"]
  --keepLoginCookies, -k   同封のChromiumブラウザに、認証用のトークン(cookies)を
                           キャッシュさせます。自動的にログインさせるためには、
                           ここを毎回[有効(T)]にする必要があります。
                                                              [default: 無効(F)]
  --noExperiments, -x      コンソール上にサムネイル画像の表示しません 
                                                              [default: 無効(F)]
  --simulate, -s           ビデオのダウンロードを行わず、メタデータのみを表示します。
                                                              [default: 無効(F)]
  --verbose, -v            追加の情報(debug情報)を表示し、実行します
                                                              [default: 無効(F)]
  --closedCaptions, --cc   字幕(CC)が使用可能かどうかを確認し、
                           ユーザがダウンロードする字幕を選択できるようにします
                           (字幕の言語が1つしかない場合は確認しません。) 
                                                              [default: 無効(F)]
  --noCleanup, --nc        FFmpegで出力エラーが発生した際は、
                           自動的にファイルを消しません         [default: 無効(F)]
                         
  --vcodec                動画を再エンコードする際のFFmpegコーディックを指定します
                          (ex. libx265) もしくは"none" と指定して動画を無効にします
                                              [default: "copy"(再エンコードなし)]
  --acodec               音声を再エンコードする際のFFmpegコーディックを指定します
                           (ex.libopus) もしくは"none" と指定して音声を無効化します
                                              [default: "copy"(再エンコードなし)]
  --format                出力時のビデオコンテナのフォーマットを指定します。  
                         (対応フォーマット:mkv, mp4, movなどFFmpegがサポートする形式
                                                                [default: "mkv"]
  --skip                  ファイルを既にダウンロードしている場合はスキップします。
                                                                [default: 無効(F)]

For example(Mac/Linux)

Windowsでは、 ./destreamer.sh → destreamer.ps1 or destreamer.cmdに置き換えてください。

最小実行コマンド

$ ./destreamer.sh -i "https://web.microsoftstream.com/video/VIDEO-1"

ユーザー名を自動入力するには…

$ ./destreamer.sh -u user@example.com -i "https://web.microsoftstream.com/video/VIDEO-1"

ビデオを任意の場所に保存するには…

$ ./destreamer.sh -i "https://web.microsoftstream.com/video/VIDEO-1" -o /Users/hacker/Downloads

2つ以上の動画をダウンロードするには…

$ ./destreamer.sh -i "https://web.microsoftstream.com/video/VIDEO-1" \
                     "https://web.microsoftstream.com/video/VIDEO-2"

エスケープ文字も必ず入力してください。

txtファイルからURLを入力するなら…

$ ./destreamer.sh -f list.txt

.txtのURLリンクは一行につき1リンクのみです。
エスケープ文字を忘れないで下さい。

---Trips---

デフォルトの出力コンテナは.mkvです。ほかのコンテナを利用したい場合(ex.mp4)は、
ダウンロードする際--format mp4と指定してください。
念のため、--username は任意です。
ただユーザー名が自動入力されるだけです。
-oでは、絶対パスで入力してください。
ex. /mnt/videos(Mac/Linux).
%USERPROFILE%/destreamer/videos (Win)
ダウンロードしたファイルは、デフォルトでvideos/に保存されます。 -oとパスを指定することで任意の場所に保存することができます。

自分が使っているブラウザでもトークンの取得をすることはできますか？

できます。これはメインブラウザに、 Microsoft Streamテナントへのログオンに必要な認証プラグインがある場合に便利です。なお、通常は同封のChromiumブラウザでも、トークンの取得は可能です。トークン取得部分に独自のブラウザを使用するには、src/destreamer.tsで次のコードを見つけます。

  const browser: puppeteer.Browser = await puppeteer.launch({
        executablePath: getPuppeteerChromiumPath(),
        headless: false,
        userDataDir: (argv.keepLoginCookies) ? chromeCacheFolder : undefined,
        args: [
            '--disable-dev-shm-usage',
            '--fast-start',
            '--no-sandbox'
        ]
    });

次に、executablePathを変更して、ブラウザとプロファイルへのパスを反映させます。もちろん構成が変更されてた場合は、更新毎にnpmでリビルド(npm build run)してください。

バグを報告 / アイデアを発表

まずは、README.mdを確認して次のことを確認してください。

前提条件は、一つも不適合がありませんか？
npmで正しくビルドされていますか？
コマンドを実行する際は、
WindowsではcmdかPowerShell、
MacやLinuxでは、ターミナルで実行してください。
コマンド実行時の構文は間違っていませんか？
そのURLは、対応サービス(MS Stream)ですか？
利用しているアカウントは適切なアクセス権が付与されていますか？
Streamをダウンロードする際は、
安定したネットワークでないとダウンロードが失敗する場合があります。
MS Streamなどのネットワークサービスは予告なく仕様が変更となり、
動作しない場合があります。
destreamerを最新版に更新し、再度実行してみてください。

それでもバグが発生した場合はここをクリックして、同じ内容の報告がないか確認してから報告してください。
--verbose, -vオプションで実行し、
このログとともに報告するとスムーズな対応ができるかもしれません。

なおこの文章の誤りは、ここに報告してください。
私は先のビッグイベントで日々忙しいので、対応が遅れるかもしれません。

[備忘録] Input file

wonisan/destreamer-help-jp