diff --git a/validate/docs/validate/Makefile.am b/validate/docs/validate/Makefile.am index ee4796bf92..a9eaaff9e8 100644 --- a/validate/docs/validate/Makefile.am +++ b/validate/docs/validate/Makefile.am @@ -77,7 +77,7 @@ IGNORE_CFILES = \ # HTML_IMAGES = gdp-header.png # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -content_files = scenarios.xml command-line-tools.xml envvariables.xml +content_files = gst-validate.xml gst-validate-transcoding.xml gst-validate-media-check.xml gst-validate-launcher.xml envvariables.xml scenarios.xml # Other files to distribute. extra_files = diff --git a/validate/docs/validate/command-line-tools.xml b/validate/docs/validate/command-line-tools.xml deleted file mode 100644 index 33c08bed68..0000000000 --- a/validate/docs/validate/command-line-tools.xml +++ /dev/null @@ -1,316 +0,0 @@ - - -%version-entities; -]> - - - GstValidate Command line tools - 1 - GstValidate - - - GstValidate command line tools - Documentation of the various command line tools provided by GstValidate - - - - Introduction - - - In order to make gst-validate usage simple, dedicated tools that allow plugin developers test there elements in many use cases from a high level perspective - are provided with GstValidate. - - - - - gst-validate: The simplest gst-launch like pipeline launcher running inside GstValidate monitoring infrastructure - gst-validate-transcoding: A tool to easily create media files transcoding pipeline running inside GstValidate monitoring infrastructure - * Encoding Profile: The serialization format of a GstEncodingProfile - gst-validate-media-check: A tool to easily check that the discovering of a media file works properly over runs - gst-validate-launcher: An application permitting to create testsuites on top of GstValidate tools - * The default testsuite The default GstValidate testsuite - * Implementing a testsuite How to implement a testsuite - - - - gst-validate-&GST_API_VERSION; - - It is the simplest tool and is used to run a gst - launch style pipeline. Monitors are added to it to identify issues in the - used elements. At the end a report will be printed, this report will - contain information about all issues that were encountered while running - gst-validate. To view issues as they are created, set the environment - variable GST_DEBUG=validate:2 and it will be printed as gstreamer - debugging. You can basically run any GstPipeline pipeline using it. - If you are not familiar with gst-launch syntax, please refer to - gst-launch's documentation. - - Simple playback pipeline: - gst-validate-1.0 playbin uri=file:///path/to/some/media/file - - Transcoding pipeline: - gst-validate-1.0 filesrc location=/media/file/location ! qtdemux name=d ! queue ! x264enc ! h264parse ! mpegtsmux name=m ! progressreport ! filesink location=/root/test.ts d. ! queue ! faac ! m. - - - - - It will report what issues happened during the execution of that pipeline in a human readable report like: - - issue : buffer is out of the segment range Detected on theoradec0.srcpad at 0:00:00.096556426 - - Details : buffer is out of segment and shouldn't be pushed. Timestamp: 0:00:25.000 - duration: 0:00:00.040 Range: 0:00:00.000 - 0:00:04.520 - Description : buffer being pushed is out of the current segment's start-stop range. Meaning it is going to be discarded downstream without any use - - - - The return code of the process will be 18 in case a CRITICAL issue has been found - - - - The gst-validate-transcoding tool - - - A command line tool allowing to test media files transcoding with a straight forward syntax. You can for example transcode any media file to vorbis vp8 in webm doing: - gst-validate-transcoding-&GST_API_VERSION; file:///./file.ogg file:///.../transcoded.webm -o 'video/webm:video/x-vp8:audio/x-vorbis' - - - - - - - It will report what issues happened during the execution of that pipeline in a human readable report like: - - issue : buffer is out of the segment range Detected on theoradec0.srcpad at 0:00:00.096556426 - - Details : buffer is out of segment and shouldn't be pushed. Timestamp: 0:00:25.000 - duration: 0:00:00.040 Range: 0:00:00.000 - 0:00:04.520 - Description : buffer being pushed is out of the current segment's start-stop range. Meaning it is going to be discarded downstream without any use - - - - The return code of the process will be 18 in case a CRITICAL issue has been found - - - - The Encoding profile serialization format - - Internally the transcoding application uses GstEncodeBin. gst-validate-transcoding-&GST_API_VERSION; uses its own - serialization format to describe the GstEncodeBin.profile - property of the encodebin. - - - - - The simplest serialized profile looks like: - muxer_source_caps:videoencoder_source_caps:audioencoder_source_caps - - - - - - For example to encode a stream into a webm container, with a ogg audio stream and a h264 video stream, - the serialized GstEncodingProfile will look like: - video/webm:video/x-vp8:audio/x-vorbis - - - - - - You can also set the preset name of the encoding profile using the caps+preset_name syntax such as in: - video/webm:video/x-vp8+youtube-preset:audio/x-vorbis - - - - - - Moreover, you can set the presence property of an - encoding profile using the '|presence' syntax such as in: - video/webm:video/x-vp8|1:audio/x-vorbis - - - This field allows you to specify how many times maximum a GstEncodingProfile can be used inside a encodebin. - - - You can also use the 'restriction_caps->encoded_format_caps' to specify the - restriction caps - to be set on a GstEncodingProfile. It corresponds to the restriction GstCaps to apply before - the encoder that will be used in the profile. The fields present in restriction - caps are properties of the raw stream (that is before encoding), such as height - and width for video and depth and sampling rate for audio. This property does not - make sense for muxers. - - - - - To force to encode a video in full HD (using webm as a container, - vp8 as a video codec and vorbis as an audio codec), you should use: - video/webm:video/x-raw-yuv,width=1920,height=1080-->video/x-vp8:audio/x-vorbis - - - - Some serialized encoding formats examples: - - MP3 audio and H264 in MP4: - video/quicktime,variant=iso:video/x-h264:audio/mpeg,mpegversion=1,layer=3 - - Vorbis and theora in OGG: - application/ogg:video/x-theora:audio/x-vorbis - - AC3 and H264 in MPEG-TS: - video/mpegts:video/x-h264:audio/x-ac3 - - - - - - The gst-validate-media-check tool - - - A command line tool checking that media files discovering works properly with gst-discoverer. Basically it - needs a reference text file containing valid information about a media file (which can be generated with the same tool) - and then it will be able to check that those information correspond to what is reported by gst-discoverer over new runs. - For example, given that we have a valid reference.media_info file, we can run: - gst-validate-media-check-&GST_API_VERSION; file:///./file.ogv --expected-results reference.media_info - - - - That will then output found errors if any and return an exist code different from 0 if an error was found. - - - - - As you can notice, those tools let us test static pipelines execution and not that the pipeline reacts properly during execution of actions from the end user such as seeking, or changing the pipeline state, etc… In order to make that possible and easy to use we introduced the concept of - scenarios - - - - gst-validate-launcher - - To be able to implement actual testsuite based on the previously described command line tools, - a test launcher has been developed: gst-validate-launcher. - - - - You can find detailed information about the launcher reading its help manual: - gst-validate-launcher --help - - - - Run the GstValidate default testsuite - - GstValidate comes with a default testsuite to be executed on a default set of media samples. - Those media samples are stored with git-annex so you will need it to be able to launch that - default testsuite. - - - The first time you launch the testsuite, you will need to make sure that the media samples are - downloaded. To do so and launch the testsuite you can simply do: - gst-validate-launcher validate --sync - - - This will only launch the GstValidate tests and not other application that might be supported - (currently ges-launch is also supported and has its own default testsuite). - - - Launching the default testsuite will open/close many windows, you might want to mute it - so you can keep using your computer: - gst-validate-launcher validate --sync --mute - - - - Example of a testsuite implementation - - To implement a testsuite, you will have to write some simple python code that will define - the test to be launched by the gst-validate-launcher. - - - In that example, we will consider that you want to write a whole new testsuite based on - your own media samples and scenarios. - That set of file and the testsuite implementation file will be structured as follow: - -testsuite_folder/ - |-> testsuite.py - |-> sample_files/ - |-> file.mp4 - |-> file1.mkv - |-> file2.ogv - |-> scenarios - |-> scenario.scenario - |-> scenario1.scenario - - - - - You should generate the .media_infos files. To generate them for local files, - you can use: - gst-validate-launcher --medias-paths /path/to/sample_files/ --generate-media-info - For remote streams, you should use gst-validate-media-check-&GST_API_VERSION;. For an http stream you can for example do: - gst-validate-media-check-&GST_API_VERSION; http://someonlinestream.com/thestream --output-file /path/to/testsuite_folder/sample_files/thestream.stream_info - - - The gst-validate-launcher will use those .media_info and .stream_info files to generate the tests as those contain the necessary information. - - - - Then you will need to write the testsuite.py file. You can for example implement the following testsuite: - - -import os - -# Make sure gst-validate-launcher uses our special media files -options.paths = os.path.dirname(os.path.realpath(__file__)) - -# Make sure GstValidate will be able to use our special scenarios -# from the testsuite_folder/scenarios folder -os.environ["GST_VALIDATE_SCENARIOS_PATH"] = \ - os.path.join(os.path.dirname(os.path.realpath(__file__)), "scenarios") - -# You can activate the following if you care only about the critical issues in -# the report: -# os.environ["GST_VALIDATE"] = "print_criticals" - -# Make gst-validate use our scenarios -validate.add_scenarios(["scenario", "scenario1"]) - - -# Now add the theora and vorbis in OGG as a wanted transcoding format. That means -# that tests with all the media files/streams will be converted to that format. -validate.add_encoding_formats([MediaFormatCombination("ogg", "vorbis", "theora")]) - -# Use the GstValidatePlaybinTestsGenerator to generate tests that will use playbin -# and GstValidateTranscodingTestsGenerator to create media transcoding tests that -# will use all the media format added with validate.add_encoding_formats -validate.add_generators([validate.GstValidatePlaybinTestsGenerator(validate), - GstValidateTranscodingTestsGenerator(self)]) - -# Blacklist some test that are known to fail because a feature is not supported -# or any reason. -# The tuple defining those tests is of the form: -# ("regex defining the test name", "Reason why the test should be disabled") -validate.set_default_blacklist([ - ("validate.*.scenario1.*ogv$" - "oggdemux does not support some action executed in scenario1")] - ) - - - - - - Once this is done, we got a testsuite that will: - - - Run playbin pipelines on file.mp4, file1.mkv and file2.ogv executing "scenario" and "scenario1" scenarios - - - Transcode file.mp4, file1.mkv and file2.ogv to theora and vorbis in OGG - - - - The only thing to do to run the testsuite is: - gst-validate-launcher --config /path/to/testsuite_folder/testsuite.py - - - - - diff --git a/validate/docs/validate/envvariables.xml b/validate/docs/validate/envvariables.xml index 89af17900b..7a04a0e67a 100644 --- a/validate/docs/validate/envvariables.xml +++ b/validate/docs/validate/envvariables.xml @@ -4,21 +4,12 @@ %version-entities; ]> - - - GstValidate environment variables - 1 - GstValidate - - - GstValidate environment variables - The environment variable variable influencing the run of GstValidate - + + GstValidate Environment Variables - - - The runtime behaviour of GstValidate applications can be influenced by a number of environment variables. - + + The runtime behaviour of GstValidate applications can be influenced by a number of environment variables. + <envar>GST_VALIDATE</envar> @@ -72,7 +63,7 @@ - You can use the special names "stdout" and "stderr" to use those output. + You can use the special names stdout and stderr to use those output. @@ -84,7 +75,8 @@ scan these paths for GstValidate scenario files. By default GstValidate will look for scenarios in the user data directory as - specified in the XDG standard: .local/share/gstreamer-&GST_API_VERSION;/validate/scenarios + specified in the XDG standard: + .local/share/gstreamer-&GST_API_VERSION;/validate/scenarios and the system wide user data directory: /usr/lib/gstreamer-&GST_API_VERSION;/validate/scenarios @@ -93,11 +85,12 @@ <envar>GST_VALIDATE_OVERRIDE</envar> - Set this variable to a to a colon-separated list of dynamically linkable files. GstValidate will - scan these paths for GstValidate overrides + Set this variable to a colon-separated list of dynamically linkable files that GstValidate will + scan looking for overrides. By default GstValidate will look for scenarios in the user data directory as - specified in the XDG standard: .local/share/gstreamer-&GST_API_VERSION;/validate/scenarios + specified in the XDG standard: + .local/share/gstreamer-&GST_API_VERSION;/validate/scenarios and the system wide user data directory: /usr/lib/gstreamer-&GST_API_VERSION;/validate/scenarios @@ -107,7 +100,7 @@ A decimal number to set as a multiplier for the wait actions. For example if you set - GST_VALIDATE_SCENARIO_WAIT_MULITPLIER=0.5, for a wait action that has a duration of 2.0 + GST_VALIDATE_SCENARIO_WAIT_MULITPLIER=0.5, for a wait action that has a duration of 2.0 the waiting time will only be of 1.0 second. If set to 0, wait action will be ignored. @@ -116,9 +109,9 @@ <envar>GST_VALIDATE_REPORTING_DETAILS</envar> - The reporting level can be set through the "GST_VALIDATE_REPORTING_DETAILS" - environment variable, as a comma-separated list of (optional) object categories / names - and levels. No object category / name sets the global level. + The reporting level can be set through the GST_VALIDATE_REPORTING_DETAILS + environment variable, as a comma-separated list of (optional) object categories / names + and levels. Omit the object category / name to set the global level. Examples: @@ -153,7 +146,7 @@ If set as the default level, similar issues can be reported multiple times for - different subchains. If set as the level for a particular object (my_object:subchain), + different subchains. If set as the level for a particular object (my_object:subchain), validate will report the issues where the object is the first to report an issue for a subchain. @@ -181,16 +174,15 @@ All the issues will be reported, even those - that repeat themselves inside the same object. This can be *very* verbose if + that repeat themselves inside the same object. This can be very verbose if set globally. Setting the reporting level allows to control the way issues are reported - when calling #gst_validate_runner_printf. + when calling gst_validate_runner_printf(). - - + diff --git a/validate/docs/validate/gst-validate-docs.sgml b/validate/docs/validate/gst-validate-docs.sgml index ce6c333557..907ac3e928 100644 --- a/validate/docs/validate/gst-validate-docs.sgml +++ b/validate/docs/validate/gst-validate-docs.sgml @@ -13,8 +13,9 @@ - + Overview and usage + GstValidate is a tool that allows GStreamer developers to check that the GstElements they write behave the way they are supposed to. @@ -25,27 +26,33 @@ GstValidate implements a monitoring logic that allows the system to check that the elements of a GstPipeline respect some rules GStreamer components - have to follow so that elements can properly interact together. + have to follow to make them properly interact together. For example, a GstValidatePadMonitor will make sure that if we receive a GstSegment from upstream, an equivalent segment is sent downstream before any buffer gets out. Then GstValidate implements a reporting system that allows users to - get detailed informations about what was not properly handle in elements. - The reports are order by level of importance from "issue" to "critical". + get detailed informations about what was not properly handled by the elements. + The generated reports are ordered by level of importance from "issue" to "critical". - Some tools have been implemented to help the developer validate and test - their GstElement, you can have a look at the command line tools section to find more information + Some tools have been implemented to help developers validate and test + their GstElement, you can have a look at the command line tools section + to find more information. - On top of those tools, the notion of - scenario has been implemented so that developers can easily execute a set - of actions on pipelines and thus test real world interactive cases and reproduce existing + On top of that, the notion of a validation + scenario has been implemented so that developers can easily execute a set + of actions on pipelines to test real world interactive cases and reproduce existing issues in a convenient way. + + + + + + - diff --git a/validate/docs/validate/gst-validate-launcher.xml b/validate/docs/validate/gst-validate-launcher.xml new file mode 100644 index 0000000000..b2818ffb87 --- /dev/null +++ b/validate/docs/validate/gst-validate-launcher.xml @@ -0,0 +1,189 @@ + + +%version-entities; +]> + + + + The GstValidate team + see http://cgit.freedesktop.org/gstreamer/gst-devtools/ + + gst-validate + + + + gst-validate-launcher + 1 + GstValidate + &GST_API_VERSION; + GstValidate Manual Pages + + + + gst-validate-launcher + Tool to launch GstValidate testsuites + + + + + gst-validate-launcher + options + TESTSUITE + + + + + Description + gst-validate-launcher is an application to create + full testsuites on top of the GstValidate tools, testing behaviour with + dynamic pipelines and user actions (seeking, changing the pipeline + state, etc.) as described by the scenario format. + + + Run the GstValidate default testsuite + + GstValidate comes with a default testsuite to be executed on a default set of media samples. + Those media samples are stored with git-annex so you + will need it to be able to launch the default testsuite. + + + The first time you launch the testsuite, you will need to make sure that the media samples are + downloaded. To do so and launch the testsuite you can simply do: + + + gst-validate-launcher validate --sync + + + This will only launch the GstValidate tests and not other applications that might be supported + (currently ges-launch is also supported and has its own default testsuite). + + + Launching the default testsuite will open/close many windows, you might want to mute it + so you can keep using your computer: + + + gst-validate-launcher validate --sync --mute + + + + Example of a testsuite implementation + + To implement a testsuite, you will have to write some simple python code that defines + the tests to be launched by gst-validate-launcher. + + + In this example, we will assume that you want to write a whole new testsuite based on + your own media samples and scenarios. + The set of media files and the testsuite implementation file will be structured as follow: + + +testsuite_folder/ + |-> testsuite.py + |-> sample_files/ + |-> file.mp4 + |-> file1.mkv + |-> file2.ogv + |-> scenarios + |-> scenario.scenario + |-> scenario1.scenario + + + You should generate the .media_info files. To generate them for local files, + you can use: + + + gst-validate-launcher --medias-paths /path/to/sample_files/ --generate-media-info + + + For remote streams, you should use gst-validate-media-check-&GST_API_VERSION;. For an http stream you can for example do: + + + gst-validate-media-check-&GST_API_VERSION; http://someonlinestream.com/thestream \ + --output-file /path/to/testsuite_folder/sample_files/thestream.stream_info + + + The gst-validate-launcher will use the generated + .media_info and .stream_info + files to validate the tests as those contain the necessary information. + + + Then you will need to write the testsuite.py file. You can for example implement the following testsuite: + + + +import os + +# Make sure gst-validate-launcher uses our media files +options.paths = os.path.dirname(os.path.realpath(__file__)) + +# Make sure GstValidate is able to use our scenarios +# from the testsuite_folder/scenarios folder +os.environ["GST_VALIDATE_SCENARIOS_PATH"] = \ + os.path.join(os.path.dirname(os.path.realpath(__file__)), "scenarios") + +# You can activate the following if you only care about critical issues in +# the report: +# os.environ["GST_VALIDATE"] = "print_criticals" + +# Make gst-validate use our scenarios +validate.add_scenarios(["scenario", "scenario1"]) + + +# Now add "Theora and Vorbis in OGG container" as a wanted transcoding format. That means +# that conversion to this format will be tested on all the media files/streams. +validate.add_encoding_formats([MediaFormatCombination("ogg", "vorbis", "theora")]) + +# Use the GstValidatePlaybinTestsGenerator to generate tests that will use playbin +# and GstValidateTranscodingTestsGenerator to create media transcoding tests that +# will use all the media format added with validate.add_encoding_formats +validate.add_generators([validate.GstValidatePlaybinTestsGenerator(validate), + GstValidateTranscodingTestsGenerator(self)]) + +# Blacklist some tests that are known to fail because a feature is not supported +# or due to any other reason. +# The tuple defining those tests is of the form: +# ("regex defining the test name", "Reason why the test should be disabled") +validate.set_default_blacklist([ + ("validate.*.scenario1.*ogv$" + "oggdemux does not support some action executed in scenario1")] + ) + + + + + Once this is done, you've got a testsuite that will: + + + + + Run playbin pipelines on file.mp4, file1.mkv and + file2.ogv> executing scenario and scenario1 scenarios + + + + + Transcode file.mp4, file1.mkv and file2.ogv + to Theora and Vorbis in a OGG container + + + + + The only thing to do to run the testsuite is: + + + gst-validate-launcher --config /path/to/testsuite_folder/testsuite.py + + + + + Invocation + + You can find detailed information about the launcher by launching it: + + + gst-validate-launcher --help + + + diff --git a/validate/docs/validate/gst-validate-media-check.xml b/validate/docs/validate/gst-validate-media-check.xml new file mode 100644 index 0000000000..ce1631b073 --- /dev/null +++ b/validate/docs/validate/gst-validate-media-check.xml @@ -0,0 +1,89 @@ + + +%version-entities; +]> + + + + The GstValidate team + see http://cgit.freedesktop.org/gstreamer/gst-devtools/ + + gst-validate + + + + gst-validate-media-check + 1 + GstValidate + &GST_API_VERSION; + GstValidate Manual Pages + + + + gst-validate-media-check + Tool to test GStreamer media types discovery + + + + + gst-validate-media-check + options + URI + + + + + Description + + gst-validate-media-check is command line tool checking that media files discovering works + properly with gst-discoverer over multiple runs. It needs a reference text file containing + valid information about a media file (which can be generated with the same tool) and then it will be able to check + that the reference matches what will be reported by gst-discoverer in the following runs. + + + For example, given that we have a valid reference.media_info file, we can run: + + + gst-validate-media-check-&GST_API_VERSION; file:///./file.ogv --expected-results reference.media_info + + + It will then output any error encountered and return an exit code different from 0 if any error is found. + + + + Invocation + + gst-validate-media-check takes an URI to analyze + and some extra options to control the output. + + + Options + + + + , + + The output file to store the results. + + + + + , + + Fully analize the file frame by frame. + + + + + , + + Path to file containing the expected results (or the last results found) for comparison with new results. + + + + + + + diff --git a/validate/docs/validate/gst-validate-transcoding.xml b/validate/docs/validate/gst-validate-transcoding.xml new file mode 100644 index 0000000000..4b69b994a6 --- /dev/null +++ b/validate/docs/validate/gst-validate-transcoding.xml @@ -0,0 +1,220 @@ + + +%version-entities; +]> + + + + The GstValidate team + see http://cgit.freedesktop.org/gstreamer/gst-devtools/ + + gst-validate + + + + gst-validate-transcoding + 1 + GstValidate + &GST_API_VERSION; + GstValidate Manual Pages + + + + gst-validate-transcoding + Tool to test GStreamer transcoding components + + + + + gst-validate-transcoding + options + INPUT-URI + OUTPUT-URI + + + + + Description + gst-validate-transcoding is tool to create media + files transcoding pipelines running inside the GstValidate monitoring + infrastructure. + + You can for example transcode any media file to Vorbis audio + VP8 video in a WebM container by doing: + + + gst-validate-transcoding-&GST_API_VERSION; file:///./file.ogg file:///.../transcoded.webm -o 'video/webm:video/x-vp8:audio/x-vorbis' + + + + gst-validate-transcoding will list every issue encountered during the execution of the + transcoding operation in a human readable report like the one below: + + + + issue : buffer is out of the segment range Detected on theoradec0.srcpad at 0:00:00.096556426 + + Details : buffer is out of segment and shouldn't be pushed. Timestamp: 0:00:25.000 - duration: 0:00:00.040 Range: 0:00:00.000 - 0:00:04.520 + Description : buffer being pushed is out of the current segment's start-stop range. Meaning it is going to be discarded downstream without any use + + + The return code of the process will be 18 in case a CRITICAL issue has been found. + + + + The encoding profile serialization format + This is the serialization format of a GstEncodingProfile. + + Internally the transcoding application uses GstEncodeBin. gst-validate-transcoding-&GST_API_VERSION; uses its own + serialization format to describe the GstEncodeBin.profile + property of the encodebin. + + + + The simplest serialized profile looks like: + + + muxer_source_caps:videoencoder_source_caps:audioencoder_source_caps + + + + For example to encode a stream into a WebM container, with an OGG audio stream and a VP8 video stream, + the serialized GstEncodingProfile will look like: + + + video/webm:video/x-vp8:audio/x-vorbis + + + + You can also set the preset name of the encoding profile using the caps+preset_name syntax as in: + + + video/webm:video/x-vp8+youtube-preset:audio/x-vorbis + + + + Moreover, you can set the presence property of an + encoding profile using the |presence syntax as in: + + + video/webm:video/x-vp8|1:audio/x-vorbis + + + + This field allows you to specify how many times maximum a GstEncodingProfile can be used inside an encodebin. + + + You can also use the restriction_caps->encoded_format_caps syntax to specify the + restriction caps + to be set on a GstEncodingProfile. It corresponds to the + restriction GstCaps to apply before + the encoder that will be used in the profile. The fields present in restriction + caps are properties of the raw stream (that is, before encoding), such as height + and width for video and depth and sampling rate for audio. This property does not + make sense for muxers. + + + To force a video stream to be encoded with a Full HD resolution (using WebM as the container format, + VP8 as the video codec and Vorbis as the audio codec), you should use: + + + video/webm:video/x-raw-yuv,width=1920,height=1080-->video/x-vp8:audio/x-vorbis + + + Some serialized encoding formats examples: + + MP3 audio and H264 in MP4: + + + video/quicktime,variant=iso:video/x-h264:audio/mpeg,mpegversion=1,layer=3 + + + + Vorbis and theora in OGG: + + + application/ogg:video/x-theora:audio/x-vorbis + + + + AC3 and H264 in MPEG-TS: + + + video/mpegts:video/x-h264:audio/x-ac3 + + + + + + Invocation + + gst-validate-transcoding takes and input URI and an output URI, + plus a few options to control how transcoding should be tested. + + + Options + + + + + + Let you set a scenario, it can be a full path to a scenario file + or the name of the scenario (name of the file without the + .scenario extension). + + + + + , + + List the avalaible scenarios that can be run. + + + + + + + The output file to store scenarios details. Implies . + + + + + , + + Inspect the avalaible action types with which to write scenarios + if no parameter passed, it will list all avalaible action types + otherwize will print the full description of the wanted types. + + + + + + + Let you set a config scenario. The scenario needs to be set as + config. You can specify a list of scenarios + separated by :. It will override the + GST_VALIDATE_SCENARIO environment variable. + + + + + , + + If an EOS event should be sent to the pipeline if an interrupt is + received, instead of forcing the pipeline to stop. Sending an EOS + will allow the transcoding to finish the files properly before exiting. + + + + + , + + Whether to try to force reencoding, meaning trying to only remux if possible, defaults to TRUE. + + + + + + + diff --git a/validate/docs/validate/gst-validate.xml b/validate/docs/validate/gst-validate.xml new file mode 100644 index 0000000000..7965791ed6 --- /dev/null +++ b/validate/docs/validate/gst-validate.xml @@ -0,0 +1,139 @@ + + +%version-entities; +]> + + + + The GstValidate team + see http://cgit.freedesktop.org/gstreamer/gst-devtools/ + + gst-validate + + + + gst-validate + 1 + GstValidate + &GST_API_VERSION; + GstValidate Manual Pages + + + + gst-validate + Tool to test GStreamer components + + + + + gst-validate + options + PIPELINE-DESCRIPTION + + + + + Description + + gst-validate is the simplest gst-launch-like pipeline launcher + running inside GstValidate monitoring infrastructure. Monitors are added to it to identify issues in the + used elements. At the end it will print a report with some information + about all the issues encountered during its run. To view issues as they are detected, set the environment + variable GST_DEBUG=validate:2 and they will get printed in the GStreamer debug log. + You can basically run any GstPipeline pipeline using this tool. + If you are not familiar with gst-launch syntax, please refer to + gst-launch's documentation. + + + Simple playback pipeline: + + + gst-validate-1.0 playbin uri=file:///path/to/some/media/file + + + Transcoding pipeline: + + + gst-validate-1.0 filesrc location=/media/file/location ! qtdemux name=d ! queue \ + ! x264enc ! h264parse ! mpegtsmux name=m ! progressreport \ + ! filesink location=/root/test.ts d. ! queue ! faac ! m. + + + It will list each issue that has been encountered during the execution of the specified pipeline in a human readable report like: + + + issue : buffer is out of the segment range Detected on theoradec0.srcpad at 0:00:00.096556426 + +Details : buffer is out of segment and shouldn't be pushed. Timestamp: 0:00:25.000 - duration: 0:00:00.040 Range: 0:00:00.000 - 0:00:04.520 +Description : buffer being pushed is out of the current segment's start-stop range. Meaning it is going to be discarded downstream without any use + + + The return code of the process will be 18 in case a CRITICAL issue has been found. + + + + Invocation + + gst-validate takes a mandatory description of the + pipeline to launch, similar to gst-launch, and + some extra options. + + + Options + + + + + + Let you set a scenario, it can be a full path to a scenario file + or the name of the scenario (name of the file without the + .scenario extension). + + + + + , + + List the avalaible scenarios that can be run. + + + + + + + The output file to store scenarios details. Implies . + + + + + , + + Inspect the avalaible action types with which to write scenarios + if no parameter passed, it will list all avalaible action types + otherwize will print the full description of the wanted types. + + + + + + + Set a media_info XML file descriptor to share information about the media file that will be reproduced. + + + + + + + Let you set a config scenario. The scenario needs to be set as + config. You can specify a list of scenarios + separated by ":". It will override the + GST_VALIDATE_SCENARIO environment variable. + + + + + + + diff --git a/validate/docs/validate/scenarios.xml b/validate/docs/validate/scenarios.xml index 8984db3641..d1ef39cc89 100644 --- a/validate/docs/validate/scenarios.xml +++ b/validate/docs/validate/scenarios.xml @@ -1,134 +1,143 @@ - %version-entities; ]> - - - GstValidate Scenario File Format - 1 - - GST-VALIDATE Library - - - - Scenario File Format - The GstValidate Scenarios file format - + + GstValidate Scenario File Format - - Description - - To be able to define a list of actions to execute on a GstPipeline, a dedicated file format is used. - The name of the scenario is the name of the file without its '.scenario' extension. - The scenario file format is based on the GstStructure serialized format which is a basic, type aware, - key value format. - It takes the type of the action as first comma separated field, and then - the key values pair of the form 'parameter=value' separated by commas. The values - type will be guessed if not casted as in 'parameter=(string)value'. You can force the type - guessing system to actually know what type you want by giving it the right hints. For example - to make sure the value is a double, you should add a decimal (ie '1' will be considered as a - int, but '1.0' will be considered as a double and '"1.0"' will be considered as a string) - - - For example to represent a seek action, you should add the following line in the '.scenario' - file. - - - - - seek, playback-time=10.0, start=0.0, flags=accurate+flush - - - - - The files to be used as scenario should have a '.scenario' extension and - should be placed either in $USER_DATA_DIR/gstreamer-1.0/validate/scenarios , - $GST_DATADIR/gstreamer-1.0/validate/scenarios or in a path defined in the - $GST_VALIDATE_SCENARIOS_PATH environment variable. - - - Each line in the '.scenario' file represent an action (you can also use \ at the end of a line - write a single action on multiple lines). Usually you should start you scenario with a 'description' - "config" action in order for the user to have more information about the scenario. It can contain - a 'summary' field which is a string explaining what the scenario does and then several info fields - about the scenario. You can find more info about it running: - - - - - gst-validate-1.0 --inspect-action-type action_type_name - - - - - So a basic scenario file that will seek three times and stop would look like: - - - - - - description, summary="Seeks at 1.0 to 2.0 then at \ - 3.0 to 0.0 and then seeks at \ - 1.0 to 2.0 for 1.0 second (between 2.0 and 3.0).", \ - seek=true, duration=5.0, min-media-duration=4.0 - seek, playback-time=1.0, rate=1.0, start=2.0, flags=accurate+flush - seek, playback-time=3.0, rate=1.0, start=0.0, flags=accurate+flush - seek, playback-time=1.0, rate=1.0, start=2.0, stop=3.0, flags=accurate+flush - - - - - Many action types have been implemented to help users define their own scenarios. - For example there are: - Action type examples: - seek: Seeks into the stream - - play: Set the pipeline state to GST_STATE_PLAYING - - pause: Set the pipeline state to GST_STATE_PAUSED - - stop: Stop the execution of the pipeline. NOTE: That action actually post a - GST_MESSAGE_REQUEST_STATE (requesting GST_STATE_NULL) message on the bus and - the application should quit. - - ... - - - - To get all the details about the registered action types, you can list them all with: - - - - - gst-validate-1.0 --inspect-action-type - - - - - and (includes transcoding specific action types): - - - - - gst-validate-transcoding-1.0 --inspect-action-type - - - - - Many scenarios are distributed with gst-validate, you can list them all using: - - - - - gst-validate-1.0 --list-scenarios - - - - - You can find more information about the implementation of GstValidateScenario and the action types here - - - + + To be able to define a list of actions to execute on a GstPipeline, + a dedicated file format is used. + The name of the scenario is the name of the file without its .scenario extension. + The scenario file format is based on the GstStructure + serialized format which is a basic, type aware, key value format. + It takes the type of the action in the first comma separated field, and then + some key value pairs in the form parameter=value separated by commas. The values + type will be guessed if not casted as in parameter=(string)value. You can force the type + guessing system to actually know what type you want by giving it the right hints. For example + to make sure the value is a double, you should add a decimal (ie. 1 will be considered as a + int, but 1.0 will be considered as a double and "1.0" + will be considered as a string). + + + For example to represent a seek action, you should add the following line in the .scenario + file. + + + + + seek, playback-time=10.0, start=0.0, flags=accurate+flush + + + + + The files to be used as scenario should have a .scenario extension and + should be placed either in $USER_DATA_DIR/gstreamer-1.0/validate/scenarios , + $GST_DATADIR/gstreamer-1.0/validate/scenarios or in a path defined in the + $GST_VALIDATE_SCENARIOS_PATH environment variable. + + + Each line in the .scenario file represent an action (you can also use \ at the end of a line + write a single action on multiple lines). Usually you should start you scenario with a description + "config" action in order for the user to have more information about the scenario. It can contain + a summary field which is a string explaining what the scenario does and then several info fields + about the scenario. You can find more info about it running: + + + + + gst-validate-1.0 --inspect-action-type action_type_name + + + + + So a basic scenario file that will seek three times and stop would look like: + + + + + description, summary="Seeks at 1.0 to 2.0 then at \ + 3.0 to 0.0 and then seeks at \ + 1.0 to 2.0 for 1.0 second (between 2.0 and 3.0).", \ + seek=true, duration=5.0, min-media-duration=4.0 + seek, playback-time=1.0, rate=1.0, start=2.0, flags=accurate+flush + seek, playback-time=3.0, rate=1.0, start=0.0, flags=accurate+flush + seek, playback-time=1.0, rate=1.0, start=2.0, stop=3.0, flags=accurate+flush + + + + + Many action types have been implemented to help users define their own scenarios. + For example there are: + Action type examples: + + + seek: Seeks into the stream. + + + + + play: Set the pipeline state to + GST_STATE_PLAYING. + + + + + pause: Set the pipeline state to + GST_STATE_PAUSED. + + + + + stop: Stop the execution of the pipeline. + + + NOTE: This action actually posts a + GST_MESSAGE_REQUEST_STATE message requesting + GST_STATE_NULL on the bus and + the application should quit. + + + + ... + + + + + To get all the details about the registered action types, you can list them all with: + + + + + gst-validate-1.0 --inspect-action-type + + + + + and to include transcoding specific action types: + + + + + gst-validate-transcoding-1.0 --inspect-action-type + + + + + Many scenarios are distributed with gst-validate, you can list them all using: + + + + + gst-validate-1.0 --list-scenarios + + + + + You can find more information about the scenario implementation and action types in the + GstValidateScenario section. + +