Making Rust HTTP source Feature equivalent - Part 1 | GSoC 2019

souphttpsrc is the C version of HTTP source plugin of GStreamer. Making reqwesthttpsrc feature equivalent to that of souphttpsrc is a very important part of the conversion. Although Rust HTTP source is functioning well, it is not fully in to use because it is not equivalent to C HTTP source.

For now there is only one property implemented from C HTTP source apart from the ones which come from base class. That is 'location'. We can set a URL to read using this property. For example

> gst-launch-1.0 reqwesthttpsrc location=https://www.google.com ! fakesink dump=true

I introduced two more properties to Rust HTTP source. Let's all give a warm welcome to 'is-live' and 'user-agent'. I had to go through the C code of the plugin to understand about the those properties and see where they've been used in the plugin. 

'is-live' was a easy point to start with because the implementation was straight forward. This is a property which can have Boolean value. If it's set to true then the plugin act as a live source. What is a live source? Yes, I was wondering about that for sometime. Live sources are sources that when paused discard data, such as audio or video capture devices. A typical live source also produces data at a fixed rate and thus provides a clock to publish this rate. A live source does not produce data in the PAUSED state.

 Example usage using gst-launch

 > gst-launch-1.0 reqwesthttpsrc location=https://www.google.com is-live=true ! fakesink dump=true

'user-agent' is the next property that I added to reqwesthttpsrc. User-Agent is a HTTP request header field. This header is used to identify where the request is being originated from. The User-Agent HTTP request header is set to a custom string using this property. Default value for user-agent header is "GStreamer reqwesthttpsrc".

Example usage

> gst-launch-1.0 reqwesthttpsrc location=https://www.google.com user-agent="Hi, I am new here" ! fakesink dump=true

We can capture the request and check the user-agent header which is going to be "Hi, I am new here". There a few more properties missing in the Rust HTTP source. Below table shows them.


Properties
Description
1
automatic-redirect 
When the status code is 3xx, follow the redirect link. Go to this link for implementing this property using reqwest.
2
compress
Allow compressed content encodings. Go to this link for implementing this property using reqwest.
3
cookies
HTTP request cookies.
4
extra-headers
Extra headers to append to the HTTP request.
5
iradio-mode
Enable internet radio mode (ask server to send shoutcast/ icecast metadata interleaved with the actual stream data)
6
keep-alive
Use HTTP persistent connections.
7
method
Use GET, HEAD requests.
8
proxy
HTTP proxy server related properties.
9
proxy-id
10
proxy-pw
11
retries
Number of retries before giving up.
12
ssl-ca-file
SSL related properties.
13
ssl-strict
14
ssl-use-system-ca-file
15
timeout
Seconds to timeout a blocking I/O. Go to this link for implementing this property using reqwest.
16
user-id
HTTP location URI user id for authentication. Go to this link for implementing this property using reqwest.
17
user-pw
HTTP location URI user password for authentication.

Other than these properties, there are some more features which should be implemented in Rust HTTP source. For example HTTP context sharing feature. Keep in touch for more posts :)

Comments

Post a Comment

Popular posts from this blog

The Journey Begins | Google Summer of Code

Image
Google Summer of Code (GSoC) is a global program focused on bringing more student developers into open source software development. Students work with an open source organization on a 3 month programming project during their break from school. It has always been a wish of mine to contribute to open source community. I was ecstatic would be an understatement when I got the opportunity to contribute Gnome foundation through GSoC 2019. We go through an organized and friendly environment during this period which makes GSoC a great way to enter the open source community. More importantly each student gets a mentor to guide him/her through out the GSoC period. And I am the luckiest to have gotten Sebastian Dröge as my mentor. I'm working on GStreamer based project of Gnome Foundation. GStreamer is a pipeline-based multimedia framework that links together a wide variety of media processing systems to complete complex workflows. The framework is based on plugins that will provide t...
Read more

Review | GSoC 2019

Image
I've been working on GStreamer based project of Gnome Foundation. GStreamer is a pipeline-based multimedia framework that links together a wide variety of media processing systems to complete complex workflows. The framework is based on plugins that will provide various codec and other functionality. The plugins can be linked and arranged in a pipeline. And most of the plugins are written in C. Now the developers are in an attempt to convert them to Rust which is more robust and easily maintainable. My task is to be a part of this conversion and to help fix issues related to this. Planned Tasks Implement Hyper-based HTTP source around async IO and make it feature-complete. (Explained in below section) GitLab issue: https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs/issues/31 Tutorial for gst-plugin-tutorial crate. (Explained in below section) GitLab issue: https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs/issues/44 Finish FLV demuxer. Conversion of FLV demuxer t...
Read more

I was there at GNOME.Asia Summit 2019

Image
I was there at Gnome Asia Summit 2019 in Gresik, Indonesia as a speaker. Since I am very new to open source community this was a great experience. I conducted the New comers workshop with my pal Gaurav Agarwal from India. We had our parallel class on day 0 (which is actually day 1) on the premises of University of Muhammadhiya. The expenses of me to attend the event was sponsored by Gnome Foundation. I'm so thankful for this great opportunity. Let me run through my experience in Gresik and in the conference. I and Guarav landed on 10th of October 2019 in Surabaya. Mr. Firdhous from local community came to pick us up and we had the hotel already booked in Gresik. They dropped us in Hotel Santika Gresik which was fabulous. On the next day I went to the conference and met with people from local community and open source community. I had my talk after lunch and It went very well. We used our personal experience and getting started with Gnome guide to steer the participants towa...
Read more