VideoLAN Wiki - User contributions [en]

Playback States

2019-01-28T14:48:52Z

Caro: Created page with "= Saving State = We have different settings and options per media and per Application in the clients. The settings should behave the same across all of Platforms. This docume..."

= Saving State =

We have different settings and options per media and per Application in the clients. The settings should behave the same across all of Platforms.
This document tries to formulate a guideline on how to persist these states

==What states need to be considered for persistance?==

{| border="1" cellpadding="2" class="wikitable" style="border: 1px solid dark green; text-align: center; align: left; margin: 1em auto 1em auto"
! scope="col" width="150px" | State/Setting
! scope="col" width="100px" | Media
! scope="col" width="100px" | Application
! scope="col" width="100px" | has Default
|-
| Repeat || {{No}} || {{Yes}} || {{No}} ||
|-
| Playback speed || {{Yes}} || {{No}} || {{Yes}} ||
|-
| Shuffle || {{No}} || {{Yes}} || {{No}} ||
|-
| Audio/Video track || {{Yes}} || {{No}} || {{No}} ||
|-
| Aspect Ratio || {{Yes}} || {{No}} || {{No}} ||
|-
| Audio/Video sync || {{Yes}} || {{No}} || {{Yes}} ||
|-
| Equalizer || {{No}} || {{Yes}} || {{No}} ||
|-
| Subtitle sync || {{Yes}} || {{No}} || {{Yes}} ||
|-
| last played media || {{No}} || {{Yes}} || {{No}} ||
|-
| play as audio || {{No}} || {{Yes}} || {{No}} ||
|-
| Current renderer || {{No}} || {{Yes}} || {{No}} ||
|-
| Current position in playlist || {{No}} || {{Yes}} || {{No}} ||
|}

has Default: means that there is a general value and can be changed in the settings or somewhere in the application

Application: means that it is application wide one state

Media: just a state per media

==Reasoning==

===Playback Speed===

If you watch conference videos you might want to double the speed. Persisting this across the Application when you change it on one Media item and applying it to the next might be confusing and unwanted.
Instead there should be a default playback speed that can be set. Up for discussion is still if it should be a checkmark next to the playback speed control like [x] always apply or if it should be somewhere hidden in the settings.
On Android Devices we also detect the medium, like Podcast or Audiobook to set a different playback speed automatically.

=== Audio Video sync, subtitle sync ===
For bluetooth headsets some users want a default delay to make up for the delay experienced due to bluetooth connectivity

Hacker Guide

2019-01-28T14:24:27Z

Caro:

= Introduction =

{{VLC}} is a very popular, but quite large and complex piece of software.<br />
It uses a large number of [[Contrib Status|3rd party libraries]].

VLC development is open source, and then a large community of developers worldwide contribute to it.<br />
However, entering a project such as {{VLC}} can be long and complex for new developers.

This '''guide''' seeks to help understanding the VLC code base and VLC internals to quickly get up to speed.<br />
''NB: this guide is '''not''' about [[Compile|compiling]] VLC.''

A very good introduction to VLC can also be found on (an archived copy of the site) [//web.archive.org/web/20141204234622/http://www.enjoythearchitecture.com/vlc-architecture.html enjoythearchitecture].

= The layers of VLC and libVLC =

== VLC's Core / libVLCcore ==

The most important (and probably most complex) part of VLC is the core, located in src/ in the repository.

*[[Documentation:Hacker's Guide/Core|Introduction to the core]]
** This is a '''MUST-READ''' for developers.
*[[Documentation:VLC Modules Loading|VLC modules loading]]
** How the numerous VLC modules work and are loaded.
*[[Documentation:Hacker's Guide/Input|Input]]
** How the main input chain works (slightly outdated)
*[[Documentation:Hacker's Guide/Object Management|VLC Object Management]]
*[[Hacker Guide/Variables|VLC variables]]
*[[Documentation:Hacker's Guide/VLM Internals|VLM Internals]]

== Plugins / Modules ==

[[Documentation:Hacker's Guide/Module Writers Guide|How to write a VLC module]].

=== Input ===
*[[Documentation:Hacker's Guide/Access|Access]]
** An access module provides a byte stream from a location string [[MRL]], like support for files, HTTP streams, webcams...
*[[Documentation:Hacker's Guide/Demux|Demuxer]]
** A demux module parses a byte stream and splits it into [http://en.wikipedia.org/wiki/Elementary_stream elementary streams] (tracks).
*[[Documentation:Hacker's Guide/Access Demux|Access-Demuxer]]
** An access_demux module combines the functionality of access and demux (and bypass any stream filters), splitting elementary streams directly from a location string. It's used where the bytestream abstraction is inadequate.
*[[Documentation:Hacker's Guide/Stream Filters|Stream Filters]]
** A stream filter module converts a byte stream into another byte stream. It could be used for file or byte stream decryption, as it is already used for decompression (gzip, Bzip2, XZ) and multi-part files.
*[[Documentation:Hacker's Guide/Decoder|Decoder]]
** A decoder takes an elementary stream and convert into raw video, audio or text data, reading for output.

=== Audio ===

*[[Documentation:Hacker's Guide/Audio Filters|Audio Filters]]
**[[Documentation:Hacker's Guide/Audio Mixers|Audio Mixers]]
*[[Documentation:Hacker's Guide/Audio Output|Audio Output]]

=== Video ===

*[[Documentation:Hacker's Guide/Video Filters|Video Filters]]
**[[Documentation:Hacker's Guide/Video Filters/Deinterlace|Deinterlace]]
*[[Documentation:Hacker's Guide/Video Output|Video Output]]

=== Interfaces ===
*[[Documentation:Hacker's Guide/Interfaces|Interfaces]]

=== Modules types not documented (yet) ===
==== Misc ====
*[[Documentation:Hacker's Guide/Visualization|Visualization]]
*[[Documentation:Hacker's Guide/Packetizers|Packetizers]]

==== Streaming output ====
*[[Documentation:Hacker's Guide/Encoder|Encoder]]
*[[Documentation:Hacker's Guide/Mux|Mux]]
*[[Documentation:Hacker's Guide/Stream Output|Stream Output]]
*[[Documentation:Hacker's Guide/Access Output|Access Output]]

== libVLC and bindings ==

*Using [[Documentation:Hacker's Guide/libvlc|libvlc]]
*bindings

= VLC source code overview =

*[[VLC source tree]]
*[[Modules source tree]]
*[[Documentation:Hacker's Guide/Preferences|VLC Preferences]]
*[[Documentation:Hacker's Guide/Playlist|VLC Playlist and Media Library]]

= Coding for VLC =

*[[Patches|Patching]]
*[[Sending Patches]]
*[[Code Conventions]]
*[[Documentation:Hacker's Guide/Module Writers Guide|Adding a module]]
*[[Documentation:Unicode]]
*[http://www.videolan.org/developers/vlc/doc/doxygen/html/ Doxygen Documentation]
*[[C Types]]
*[[Strings]]

= User Experience =

*[[Playback States]]

= Testing =

*[[Test Suite]]

= Mozilla plugins =

* [[Plugins/Mozilla|Plugins in Mozilla]]

{{Hacker_Guide}}

IOSCompile

2013-11-27T20:35:39Z

Caro:

== Development environment ==

To develop VLC for iOS, you need:
* Mac OS X Lion (or later)
* Latest XCode version (4.6.3 works so far)
* A correct shell (we recommend iTerm2 and zsh)

== Get the source ==

If you want to develop VLC for iOS, it is '''highly recommended''' that you use the [[git]] version:

git clone git://git.videolan.org/vlc-ports/ios.git

== Build it ==

Build it for the simulator.

sh compileVLCforiOS.sh -s

Wait, and grab a coffee.

Manually assign the code sign in Xcode, and build it for devices.

sh compileVLCforiOS.sh

Grab a second coffee. :)

== Deploy ==

Open the project in Xcode and click on Run.

If you want to run in the simulator after running compileVLCforiOS.sh without the -s option, you need to run it again with the -s option, and vice versa.

== Send patches ==
You can create patches and send them to our [http://mailman.videolan.org/listinfo/ios mailing list] ios@v.o, or on our [[IRC]].

Please see [[Git#Submitting_patches]] on how to send patches...

== Notes ==
If everything goes well, congratulations to Lucky You! If not, please report any problem to our [http://mailman.videolan.org/listinfo/ios mailing list] ios@v.o, or on our [[IRC]].

This might help you more than Google, because any lately committing might cause compiling errors(at least these days), although the latest git is supposed to be an all time stable one.

=== History ===
The first version of this howto was written by [[User:J-b|jb]] on 18 July 2013.

Last edited by leoujzwiki on 12 Oct 2013.

=== Previous Version ===
The old version of the app can be compiled using this [[MobileVLC|howto]].

[[Category:Building]]
[[Category:iOS]]