diff --git a/basic_pipeline/11_Pipeline.md b/basic_pipeline/11_Pipeline.md index adab710..f6f584b 100644 --- a/basic_pipeline/11_Pipeline.md +++ b/basic_pipeline/11_Pipeline.md @@ -109,4 +109,4 @@ In case of any problems you can refer to the code on the `template/end` branch o Now our solution is completed. You have acquired a basic understanding of Membrane, and you can implement a simple pipeline using elements. -If you wish to extend your knowledge of Membrane's concepts we encourage you to read the [extension to this tutorial](../basic_pipeline_extension/01_Introduction.md). +If you wish to extend your knowledge of Membrane's concepts we encourage you to read the next chapters. There you'll learn about some abstractions and concepts that are useful for creating solutions that are more scalable and maintainable. diff --git a/basic_pipeline_extension/02_Bin.md b/basic_pipeline/12_Bin.md similarity index 98% rename from basic_pipeline_extension/02_Bin.md rename to basic_pipeline/12_Bin.md index f7790ee..a88e14c 100644 --- a/basic_pipeline_extension/02_Bin.md +++ b/basic_pipeline/12_Bin.md @@ -78,4 +78,4 @@ defmodule Basic.Pipeline do end ``` -Combining the usage of the bin and [dynamic pads](03_DynamicPads.md) will result in an even cleaner and more scalable solution. +Combining the usage of the bin and [dynamic pads](13_DynamicPads.md) will result in an even cleaner and more scalable solution. diff --git a/basic_pipeline_extension/03_DynamicPads.md b/basic_pipeline/13_DynamicPads.md similarity index 98% rename from basic_pipeline_extension/03_DynamicPads.md rename to basic_pipeline/13_DynamicPads.md index 9f0921a..a199390 100644 --- a/basic_pipeline_extension/03_DynamicPads.md +++ b/basic_pipeline/13_DynamicPads.md @@ -121,4 +121,4 @@ As you can see, we have created two `:input` pads: `:first` and `:second`. While As an exercise, you can try to modify the `lib/pipeline.ex` file and define a pipeline consisting of three parallel branches, being mixed in a single Mixer. Later on, you can check if the pipeline works as expected, by generating the input files out of the conversation in which participate three speakers. -If you combine the approach taken in the chapter about [Bin](02_Bin.md) you can simplify this solution by reducing the size of the link defintions inside the pipeline. +If you combine the approach taken in the chapter about [Bin](12_Bin.md) you can simplify this solution by reducing the size of the link defintions inside the pipeline. diff --git a/basic_pipeline_extension/04_Tests.md b/basic_pipeline/14_Tests.md similarity index 100% rename from basic_pipeline_extension/04_Tests.md rename to basic_pipeline/14_Tests.md diff --git a/basic_pipeline_extension/assets/diagrams/basic_pipeline_bin.drawio b/basic_pipeline/assets/diagrams/basic_pipeline_bin.drawio similarity index 100% rename from basic_pipeline_extension/assets/diagrams/basic_pipeline_bin.drawio rename to basic_pipeline/assets/diagrams/basic_pipeline_bin.drawio diff --git a/basic_pipeline_extension/assets/images/basic_pipeline_bin.png b/basic_pipeline/assets/images/basic_pipeline_bin.png similarity index 100% rename from basic_pipeline_extension/assets/images/basic_pipeline_bin.png rename to basic_pipeline/assets/images/basic_pipeline_bin.png diff --git a/basic_pipeline/index.md b/basic_pipeline/index.md index f0009df..fe1d638 100644 --- a/basic_pipeline/index.md +++ b/basic_pipeline/index.md @@ -1,5 +1,5 @@ --- -title: All you need to know about pipelines pt 1 +title: All you need to know about pipelines description: >- See how pipeline works in Membrane and learn how to set it up for you part: 2 @@ -19,3 +19,6 @@ graphicPath: assets/images/Illo_basic pipeline.png | 9 | Mixer | 09_Mixer.md | | 10 | Sink | 10_Sink.md | | 11 | Pipeline | 11_Pipeline.md | +| 12 | Bin | 12_Bin.md | +| 13 | Dynamic Pads | 13_DynamicPads.md | +| 14 | Tests | 14_Tests.md | diff --git a/basic_pipeline_extension/01_Introduction.md b/basic_pipeline_extension/01_Introduction.md deleted file mode 100644 index 956e346..0000000 --- a/basic_pipeline_extension/01_Introduction.md +++ /dev/null @@ -1,9 +0,0 @@ - -In this section, we gathered some topics which should give you better insight into Membrane. We will base on the ["All you need to know about pipelines pt 1" tutorial](../basic_pipeline/01_Introduction.md), so make sure you have gone through it first. -The chapters are loosely related, so feel free to read them in any order you want. - -**Table of contents** - -- [Bin](../basic_pipeline_extension/02_Bin.md) - how to create a reusable group of [elements](../glossary/glossary.md#element) -- [Dynamic Pads](../basic_pipeline_extension/03_DynamicPads.md) - a more flexible way to define element's [pads](../glossary/glossary.md#pad) -- [Tests](../basic_pipeline_extension/04_Tests.md) - creating unit tests for the elements diff --git a/basic_pipeline_extension/assets/diagrams/basic_pipeline.drawio b/basic_pipeline_extension/assets/diagrams/basic_pipeline.drawio deleted file mode 100644 index f176610..0000000 --- a/basic_pipeline_extension/assets/diagrams/basic_pipeline.drawio +++ /dev/null @@ -1 +0,0 @@ -7Vtbb6s4EP410T6lAhMIeUzapq201ak2u+rpeVk5YC4twaxx2uT8+rXBDveEtrmhlpfg8djY428+jy/paZeL1Q2BkXePbRT0gGKvetpVDwBV0wbsh0vWqWSoaqnAJb4tlDLBzP+NhFAR0qVvo7igSDEOqB8VhRYOQ2TRggwSgt+Kag4Oil+NoIsqgpkFg6r00bepl0pNMMzkt8h3Pfll1RilOQsolUVPYg/a+C0n0q572iXBmKZvi9UlCrjxpF3SctOG3E3DCAppmwLP5OF5HKzv8PVv8vj0Sxm83j32RTdiupYdRjbrv0hiQj3s4hAG15l0QvAytBGvVWWpTOdPjCMhfEaUrsVgwiXFTOTRRSBy0cqnP3PvT+xdudBF6opjR5GJtUyElKx/5hO5UjyZFUtSslxMCX7ZDJ2a6KeySxxgkvRZU5KH5VRtKswc4yWx0BZDSmxC4iK6RU+gn1s59wExYjcILxBrPVMgKIDUfy2iEAowuxs9UXRMCFznFCLshzTO1fzABUxB+uVIgFJ4pTosYed9+uwlbYFM5bqSiRI8vgObotOvMFgKM/SAETDjThycNM6BYkiM/5bciyb3TB4j1hKayTj3QAr7vEw/JlahgEcp55Ex7wmYcpX4wsXYDRCM/PjCwgsmtmKmMnXgwg949xs+EkvqkjI1n2244jdpfxzBsOB1UjFtZFITa5OigmhVrWWWYlHUxRqYVlf8hOhOJi65edGJ3zyfolmU2vONMXnRYR0/CHLu4jgOsKw6R7KNuaEbFbdjMJxAYglCSFzwBVHLEz7a6HWviFC02uonIlcr4XMg0m8ZZ6uSiL0cXxtKs2fl0P0B8CoVk7+HWZVuMuvH+RO05E993/z5qVEGXaKoBvb4wjQBzFPThPkVWeIQ8ZfWkj8GZ8UfWvf44wexEfFDd7J0HESOwSM2RKZTyyOGZaK5U8sjEWskGyNE+GdYcwUct9CLv8it8cBgP4SzWf2dTWCiad2jnIxlngokc4zAZNCSWNThWTHLoHvMcoUiuA4wtI9EKzoy7UEdrZhgrhltwhM3gLx7Ker2HKoM1BbMoR6TOUbdI45Trmj0lsRhnBVv6N3jjY5EJIdd2ZQDjdMvbTTQPb4oBhrqUfnC6GagYXSPML4DjW2BRi1zHDXQ2LjM2TPHfhlAevZuCjDPigJku7vEAff+6jjeD4GiAF2Yorg7yp7aGGIqdsN2scIenF/XS86vnjxsGHxR5zdbOj84M+c3u+f8Mz98OZMTkNKqoOLxe/DxYfnU4+Q+Djp4bjb1ScxbtmQKf8SyuXMi8wM/ycZOMlwWC9LithCLPRjxVwsSezfGqhgpQlRcRNCq2917wFLfLGJJq0LJrEGSqhwMSh08QpkhC4d2F7B0ePzoJwdQ3Y5XOQAJ7TG/S8jtyldivlU0YzH8+Oi5xYe2LljiQR51bYlLWA+mfrCJdkJ505JPQWnE8VB/YFaZudLnU6GOtPDudU7LSCcHHr0GPFL2vjt1lUtwfbW0UtbKE2Tac1Esw2W1JqNUkVqqSAxJuaJ93awDdZs2B8H8ri20Q2L+EwBte5sAfAP0MADt4KLiLxQRbC8t5hPAgAs+04bzOOpldzKzCZ7N/2zOjNlg4/AwM3spJjz8TsJIKUJGrdlGHNXN7GAPM/uv4T8/bq5N4+5ujh7c27/7tz/+3XI5by6NPM4Zf95o+dam5kzUuFXLB3daA6Q0ZyY5KYUl0DkwdQ5NvQmcegpPpioByl5rak6HWa3uQIc4RLXgyC9jhVIDHGpA0xz7gZ1rh7pV6MHw0bxy2EBh8o2PE+KjZm1wVIA0n4XnsFCYlXbf6DfqbvSPm6/tf8PvWPAbGbsnMG0/8GPJ7H9facyU/XtOu/4f \ No newline at end of file diff --git a/basic_pipeline_extension/assets/images/Illo_basic pipeline extension.png b/basic_pipeline_extension/assets/images/Illo_basic pipeline extension.png deleted file mode 100644 index b6924ac..0000000 Binary files a/basic_pipeline_extension/assets/images/Illo_basic pipeline extension.png and /dev/null differ diff --git a/basic_pipeline_extension/assets/images/basic_pipeline.png b/basic_pipeline_extension/assets/images/basic_pipeline.png deleted file mode 100644 index 7ad5399..0000000 Binary files a/basic_pipeline_extension/assets/images/basic_pipeline.png and /dev/null differ diff --git a/basic_pipeline_extension/index.md b/basic_pipeline_extension/index.md deleted file mode 100644 index b4693f0..0000000 --- a/basic_pipeline_extension/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: All you need to know about pipelines pt 2 -description: >- - Additional features you might find usefull while setting up your pipelines -part: 3 -graphicPath: assets/images/Illo_basic pipeline extension.png ---- - -| number | title | file | -| ------ | ------------- | ------------------ | -| 1 | Introductions | 01_Introduction.md | -| 2 | Bin | 02_Bin.md | -| 3 | Dynamic Pads | 03_DynamicPads.md | -| 4 | Tests | 04_Tests.md | diff --git a/broadcasting/05_RTMP_Pipeline.md b/broadcasting/05_RTMP_Pipeline.md index 8fdd201..3a92dbb 100644 --- a/broadcasting/05_RTMP_Pipeline.md +++ b/broadcasting/05_RTMP_Pipeline.md @@ -33,7 +33,7 @@ First, we define the list of children. The following children are defined: - `:muxer_segment_duration` - the maximal duration of a segment. Each segment of each track shouldn't exceed that value. In our case, we have decided to limit the length of each segment to 8 seconds. - `:storage` - the sink element, the module responsible for writing down the HLS playlist and manifest files. In our case, we use a pre-implemented `Membrane.HTTPAdaptiveStream.FileStorage` module, designed to write the files to the local filesystem. We configure it so that the directory where the files will be put in the `output/` directory (make sure that that directory exists as the storage module won't create it itself). -The fact that the configuration of a pipeline, which performs relatively complex processing, consists of just two elements, proves the power of [bins](/basic_pipeline_extension/02_Bin.md). Feel free to stop for a moment and read about them if you haven't done it yet. +The fact that the configuration of a pipeline, which performs relatively complex processing, consists of just two elements, proves the power of [bins](/basic_pipeline/12_Bin.md). Feel free to stop for a moment and read about them if you haven't done it yet. After providing the children's specifications, we are ready to connect the pads between these children. Take a look at that part of the code: **_`lib/rtmp_to_hls/pipeline.ex`_** @@ -56,7 +56,7 @@ After providing the children's specifications, we are ready to connect the pads end ``` -The structure of links reflects the desired architecture of the application, described in the [chapter about system architecture](../videoroom/3_SystemArchitecture.md). +The structure of links reflects the desired architecture of the application. `:src` has two output pads: the `:audio` pad and the `:video` pad, transferring the appropriate media tracks. The source's `:audio` pad is linked to the input `:audio` pad of the sink - along with the `:encoding` option. That option is an atom, describing the codec which is used to encode the media data - when it comes to audio data, we will be using AAC coded. diff --git a/broadcasting/11_RTSP_Pipeline.md b/broadcasting/11_RTSP_Pipeline.md index 241df3b..21c3e71 100644 --- a/broadcasting/11_RTSP_Pipeline.md +++ b/broadcasting/11_RTSP_Pipeline.md @@ -1,4 +1,4 @@ -As explained in the [Architecture chapter](07_RTSP_Architecture.md), the pipeline will consist of a couple of elements, that will be processing the RTP stream. +As explained in the [Architecture chapter](08_RTSP_Architecture.md), the pipeline will consist of a couple of elements, that will be processing the RTP stream. The flow of the pipeline will consist of three steps. First, when the pipeline is initialized we will start the Connection Manager, which will set up the RTP stream via the RTSP. Once that is finished, we will set up two initial elements in the pipeline - the `UDP Source` and `RTP SessionBin`, which will allow us to receive RTP packets and process them. diff --git a/broadcasting/index.md b/broadcasting/index.md index 8f3b3cf..6eb4283 100644 --- a/broadcasting/index.md +++ b/broadcasting/index.md @@ -2,7 +2,7 @@ title: Membrane broadcasting tutorial description: >- Create your own media broadcasting solution! -part: 8 +part: 7 --- | number | title | file | @@ -19,4 +19,4 @@ part: 8 | 10 | Connection manager | 10_ConnectionManager.md | | 11 | RTSP to HLS - pipeline | 11_RTSP_Pipeline.md | | 12 | Summary | 12_Summary.md | -| 13 | (Suplement) H264 codec | 13_H264_codec.md | \ No newline at end of file +| 13 | (Suplement) H264 codec | 13_H264_codec.md | diff --git a/create_new_plugin/index.md b/create_new_plugin/index.md index 4f3fde2..2940b9d 100644 --- a/create_new_plugin/index.md +++ b/create_new_plugin/index.md @@ -2,7 +2,7 @@ title: How to create your own plugin description: >- In this short guide we provide you with an overview of how to create your own Membrane plugin and how to integrate it into your project. -part: 4 +part: 3 graphicPath: assets/images/Illo_create new plugin.png --- diff --git a/digital_video_introduction/index.md b/digital_video_introduction/index.md index 74acf77..2a1293f 100644 --- a/digital_video_introduction/index.md +++ b/digital_video_introduction/index.md @@ -2,7 +2,7 @@ title: Digital Video Introduction description: >- All you need to know to understand digital video. Written by Leonardo Moreira. -part: 6 +part: 5 graphicPath: assets/images/Illo_ digital video introduction.png --- diff --git a/glossary/glossary.md b/glossary/glossary.md index 10fd62c..0766502 100644 --- a/glossary/glossary.md +++ b/glossary/glossary.md @@ -3,7 +3,7 @@ - #### **Packet** It is a formatted unit of data transmitted over the network. To send data over the network it has to be fragmented into packets, which size is limited by [MTU(Maximum Transfer Unit)](https://en.wikipedia.org/wiki/Maximum_transmission_unit) - 1500 bytes when using [Ethernet](https://en.wikipedia.org/wiki/Ethernet_frame). - #### **Frame** - 'Frame' can refer to either [network frame]() or **media frame**, which is a basic data unit used by media coding formats. In particular, one media frame can represent a single image in a video. + 'Frame' can refer to either [network frame](https://en.wikipedia.org/wiki/Frame_(networking)) or **media frame**, which is a basic data unit used by media coding formats. In particular, one media frame can represent a single image in a video. - #### **Track** A media track is equivalent to a single audio or video stream. - #### **Simulcast** diff --git a/glossary/index.md b/glossary/index.md index 998f8c6..1072316 100644 --- a/glossary/index.md +++ b/glossary/index.md @@ -1,7 +1,7 @@ --- title: Glossary description: Set of terms we're using in our tutorials you might want to learn more about. -part: 7 +part: 6 graphicPath: assets/images/Illo_glossary.png --- diff --git a/h264/index.md b/h264/index.md index f865bbc..2d9101d 100644 --- a/h264/index.md +++ b/h264/index.md @@ -2,7 +2,7 @@ title: H264 - what, why and how description: In this tutorial we will describe what is H264, why to use it and how to fetch interesting information from the H264 stream -part: 9 +part: 8 graphicPath: ---