Skip to content

Latest commit

 

History

History
354 lines (269 loc) · 8.92 KB

README.CN.md

File metadata and controls

354 lines (269 loc) · 8.92 KB
Raw

前言

概述

gstreamill is an open source, based on gstreamer-1.0 with dvr support and hls output.

亮点

  • hls, http progressive streaminig, udp output.
  • Multi-Rate with GOP Alignment.
  • RESTful management interface, allowing easy integration into operator environment.
  • Job is descript in json.
  • Job run in subprocess, and auto restart on error.
  • Base on gstreamer and easy to extend.
  • B/S Management.
  • Time Shift and Catchup.

应用

IP >-----+ 
         |   +------------+   +----> UDP
CVBS >---+   | gstreamill |   |                 +-- 直播
         +---+  with dvr  +---+---> M3U8(HLS) --+-- 时移 (?timeshift=nnnn)
SDI >----+   +------+-----+   |                 +-- 回看 (?start=yyyymmddhhmmss&end=yyyymmddhhmmss)
         |          |         +---> HTTP
LIVE >---+          |
                    |
     REST 接口 (json over http post)

用到的第三方软件

  • Parson
  • JQuery
  • BootStrap
  • BootBox
  • i18next
  • Resumable

安装

gstreamill have been tested in ubuntu 16.04.2.

获取源码

git clone https://github.com/i4tv/gstreamill.git

安装依赖

sudo apt-get install autoconf automake libtool libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libgstreamer-plugins-bad1.0-dev libaugeas-dev

编译与安装

./autogen.sh
./configure (--help)
make
make install

生成发布包

./make dist

使用GSTREAMILL

安装应用时依赖

sudo apt-get install gstreamer1.0-plugins-ugly gstreamer1.0-plugins-bad gstreamer1.0-plugins-good gstreamer1.0-plugins-base

B/S架构管理界面URL

http://gstreamill.ip:20118/admin/

命令行

  • help

    gstreamill -h

      Usage:
    gstreamill [OPTION...]

    Help Options:
      -h, --help                        Show help options
      --help-all                        Show all help options
      --help-gst                        Show GStreamer Options

    Application Options:
      -j, --job                         -j /full/path/to/job.file: Specify a job file, full path is must.
      -l, --log                         -l /full/path/to/log: Specify log path, full path is must.
      -m, --httpmgmt                    -m http managment service address.
      -a, --httpstreaming               -a http streaming service address.
      -s, --stop                        Stop gstreamill.
      -v, --version                     display version information and exit.

  • 启动gstreamill

    service gstreamill start

  • 停止gstreamill

    service gstreamill stop

  • 启动一个job

default management port is 20118, use curl to invoke test job via management interface for example:

    curl -H "Content-Type: application/json" --data @examples/test.job http://localhost:20118/admin/start

  • 在前台启动一个job，即调试模式：

      gstreamill -j job_descript_file

  • 通过http渐进下载方式访问输出：

      http://host.name.or.ip:20119/test/encoder/0

  • 通过m3u8访问输出

      http://host.name.or.ip:20119/test/playlist.m3u8 （直播）
  http://host.name.or.ip:20119/test/playlist.m3u8?timeshift=3600 （按照相对时间时移）
  http://host.name.or.ip:20119/test/playlist.m3u8?position=1486556428 （按照绝对时间时移）
  http://host.name.or.ip:20119/test/playlist.m3u8?start=201506060606&end=20150606070600 （回看）

Management interface

  • start a job over http use curl

      curl -H "Content-Type: application/json" --data @examples/test.job http://localhost:20118/admin/start

test.job is job description in json, can be found in examples directory.

  • stop a job

      curl http://host.name.or.ip:20118/admin/stop/job_name

job_name is value of the "name" field in job description.

  • query gstreamill stat:

      curl http://host.name.or.ip:20118/stat/gstreamill
  curl http://host.name.or.ip:20118/stat/gstreamill/job/test

  • query gstreamer information:

      curl http://host.name.or.ip:20118/stat/gstreamer[/plugin]

Output

job name is the value of name of job description.

  • http progressive streaming

      http://host.name.or.ip:20119/job name/encoder/encoder_index

  • hls

      http://host.name.or.ip:20119/job name/playlist.m3u8
  http://host.name.or.ip:20119/job name/encoder/encoder_index/playlist.m3u8

  • udp

      udp://@ip:port

JOB DESCRIPTION

Job example:

/*
 * test job, videotestsrc and audiotestsrc
 */
{
    "name" : "test",
    "debug" : "gstreamill:3",
    "source" : {
        "elements" : {
            "videotestsrc" : {
                "caps" : "video/x-raw,width=720,height=576,framerate=25/1"
            },
            "audiotestsrc" : {
                "property" : {
                    "wave" : 8
                }
            }
        },
        "bins" : [
            "videotestsrc ! appsink name=video",
            "audiotestsrc ! appsink name=audio"
        ]
    },
    "encoders" : [
        {
            "elements": {
                "appsrc" : {
                    "property" : {
                        "format" : 3,
                        "is-live" : true
                    }
                },
                "x264enc" : {
                    "property" : {
                        "bitrate" : 1000,
                        "byte-stream" : true,
                        "threads" : 4,
                        "bframes" : 3
                    }
                },
                "faac" : {
                    "property" : {
                        "name" : "faac",
                        "outputformat" : 1
                    }
                },
                "appsink" : {
                    "property" : {
                        "sync" : false
                    }
                }
            },
            "bins" : [
                "appsrc name=video ! queue ! timeoverlay ! queue ! x264enc ! queue ! muxer.",
                "appsrc name=audio ! audioconvert ! audioresample ! voaacenc ! muxer.",
                "mpegtsmux name=muxer ! queue ! appsink"
            ]
        }
    ],
    "m3u8streaming" : {
        "version" : 3,
        "window-size" : 10,
        "segment-duration" : 3.00
    },
    "dvr_duration": 86400
}

JOB file structure:

{
    'name' : 'cctv2',
    'debug' : '3',
    'is-live' : false,
    'log-path' : '/home/zhangping/tmp/cctv2',
    'source' : {
        ...
    },
    'encoders' : [
        ...
    ],
    'm3u8streaming' : {
        ...
    },
    "dvr_duration": 86400
}

name : job name

debug : debug option, reference gst-launch gst-debug, optional.

is-live : true for live source, false otherwise, for example transcode, default is true.

log-path : dont log to default log direcotry for non-live source, log to log-path if it is presented.

source : source of encoders.

encoders : encoders.

m3u8streaming : m3u8 streaming

dvr_duration : dvr duration, seconds, it's optional.

structure of source:

"source" : {
    "elements" : {
        ...
    },
    "bins" : [
        ...
    ]
}

structure of elements:

"elements" : {
    "element" : {
        "property" : {
            ...
        },
        "caps" : "..."
    },
    ...
}

structure of bins:

"bins" : [
    bin,
    bin,
    ...
]

bins is an array of bin, syntax of bin is like gst-launch, for example:

[
    "udpsrc ! queue ! tsdemux name=demuxer",
    "demuxer.video ! queue ! mpeg2dec ! queue ! appsink name = video",
    "demuxer.audio ! mpegaudioparse ! queue ! mad ! queue ! appsink name = audio" 
]

in this example, first bin with tsdemux has sometimes pads, second and third bin link with first bin: demuxer.video and demuxer.audio. second bin with appsink named video and third bin with appsink named audio. source bins must have bin with appsink that is corespond endoders' source.

structure of encoders:

"encoders" : [
    encoder,
    ...
]

encoders is an array of encoder, encoder is an object, every encoder correspneds an encode output, that means gstreamill support mutilty bitrate output.

structure of encoder:

{
    "elements" : {
        ...
    },
    "bins" : [
        ...
    ],
    "udpstreaming" : "uri"
}

elements and bins is just the same as source structure in syntax, the differnce is encoder bins must have bins with appsrc element, appsrc must have name property, the value of name is the same as appsink name value in source bins. udpstreaming uri is udp streaming output uri, it's optional.

m3u8streaming is hls output, it's optional:

"m3u8streaming" : {
    "version" : 3,
    "window-size" : 10,
    "segment-duration" : 3.00,
}

There are examples in examples directory of source.

Talk about gstreamill on gstreamill or report a bug on issues page.

License

gstreamill is available under GPL v3. See the LICENSE file for more info.