...
 
Commits (5)
# Contributing to LibVLCSharp
We'd love for you to contribute to our source code and to make LibVLCSharp even better than it is
today! Here are the guidelines we'd like you to follow:
- [Code of Conduct](https://wiki.videolan.org/Code_of_Conduct/)
- [Question or Problem?](#question)
- [Issues and Bugs](#issue)
- [Feature Requests](#feature)
- [Submission Guidelines](#submit)
- [Coding Rules](#rules)
## <a name="question"></a> Got a Question or Problem?
If you have questions about how to use LibVLCSharp, please direct these to [StackOverflow](https://stackoverflow.com/questions/tagged/libvlcsharp). The project maintainers hang out in this [Gitter](https://gitter.im/libvlcsharp/Lobby) channel.
## <a name="issue"></a> Found an Issue?
If you find a bug in the source code or a mistake in the documentation, you can help us by
submitting an issue to our [GitLab](https://code.videolan.org/videolan/LibVLCSharp) Repository. Even better you can submit a Pull Request with a fix.
**Please see the [Submission Guidelines](#submit) below.**
## <a name="feature"></a> Want a Feature?
You can request a new feature by submitting an issue to our [GitLab](https://code.videolan.org/videolan/LibVLCSharp) Repository. If you
would like to implement a new feature then consider what kind of change it is:
* **Major Changes** that you wish to contribute to the project should be discussed first in [Gitter](https://gitter.im/libvlcsharp/Lobby) so that we can better coordinate our efforts,
prevent duplication of work, and help you to craft the change so that it is successfully accepted
into the project.
* **Small Changes** can be crafted and submitted to the [GitLab](https://code.videolan.org/videolan/LibVLCSharp) or [GitHub](https://github.com/videolan/libvlcsharp/pulls) Repository as a Pull
Request.
## <a name="submit"></a> Submission Guidelines
### Submitting an Issue
If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.
Providing the following information will increase the chances of your issue being dealt with
quickly:
* **Overview of the Issue** - if an error is being thrown a stack trace helps
* **Motivation for or Use Case** - explain why this is a bug for you
* **LibVLCSharp/LibVLC Version(s)** - is it a regression?
* **Operating System** - is this a problem with all platforms or only specific ones?
* **Reproduce the Error** - provide a example or an unambiguous set of steps.
* **Related Issues** - has a similar issue been reported before?
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
causing the problem (line of code or commit)
**If you get help, help others. Good karma rulez!**
### Submitting a Pull Request
Before you submit your pull request consider the following guidelines:
* Search [GitLab](https://code.videolan.org/videolan/LibVLCSharp/merge_requests) or [GitHub](https://github.com/videolan/libvlcsharp/pulls) for an open or closed Pull Request
that relates to your submission. You don't want to duplicate effort.
* Make your changes in a new git branch:
```shell
git checkout -b my-fix-branch develop
```
* Create your patch, **including appropriate test cases**.
* Follow our [Coding Rules](#rules).
* Run the test suite, as described below.
* Commit your changes using a descriptive commit message.
```shell
git commit -a
```
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
* Push your branch to GitHub:
```shell
git push origin my-fix-branch
```
In GitHub, send a pull request to `libvlcsharp:master`.
If we suggest changes, then:
* Make the required updates.
* Re-run the test suite to ensure tests are still passing.
* Commit your changes to your branch (e.g. `my-fix-branch`).
* Push the changes to your GitHub repository (this will update your Pull Request).
If the PR gets too outdated we may ask you to rebase and force push to update the PR:
```shell
git rebase master -i
git push origin my-fix-branch -f
```
That's it! Thank you for your contribution!
#### After your pull request is merged
After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
```shell
git push origin --delete my-fix-branch
```
* Check out the master branch:
```shell
git checkout master -f
```
* Delete the local branch:
```shell
git branch -D my-fix-branch
```
* Update your master with the latest upstream version:
```shell
git pull --ff upstream master
```
## Coding
### Developer Environment
- Visual Studio 2017 (with latest patches/updates), with the following workloads/components
- .NET desktop development workload
- Mobile development with .NET workload
- .NET Core cross-platform development
### <a name="rules"></a> Coding Rules
To ensure consistency throughout the source code, keep these rules in mind as you are working:
* All features or bug fixes **must be tested** by one or more unit tests (if possible and applicable).
* All public API methods **must be documented** with XML documentation.
......@@ -5,19 +5,21 @@ using LibVLCSharp.Forms.Shared;
using Xamarin.Forms;
using Xamarin.Forms.Platform.iOS;
using UIKit;
using System;
[assembly: ExportRenderer(typeof(VideoView), typeof(VideoViewRenderer))]
[assembly: ExportRenderer(typeof(LibVLCSharp.Forms.Shared.VideoView), typeof(VideoViewRenderer))]
namespace LibVLCSharp.Forms.Platforms.iOS
{
public class VideoViewRenderer : ViewRenderer<LibVLCSharp.Forms.Shared.VideoView, LibVLCSharp.Platforms.iOS.VideoView>
{
protected override void OnElementChanged(ElementChangedEventArgs<VideoView> e)
protected override void OnElementChanged(ElementChangedEventArgs<LibVLCSharp.Forms.Shared.VideoView> e)
{
base.OnElementChanged(e);
if(Control == null)
{
SetNativeControl(new LibVLCSharp.Platforms.iOS.VideoView());
SetNativeControl(new LibVLCSharp.Forms.Platforms.iOS.VideoView());
}
if (e.OldElement != null)
......@@ -36,4 +38,26 @@ namespace LibVLCSharp.Forms.Platforms.iOS
Control.MediaPlayer = e.NewMediaPlayer;
}
}
public class VideoView : LibVLCSharp.Platforms.iOS.VideoView, IVisualElementRenderer
{
public VisualElement Element { get; private set; }
public UIView NativeView => this;
public UIViewController ViewController => ViewController;
public event EventHandler<VisualElementChangedEventArgs> ElementChanged;
public SizeRequest GetDesiredSize(double widthConstraint, double heightConstraint) => this.GetSizeRequest(widthConstraint, heightConstraint);
public void SetElement(VisualElement element)
{
Element = element;
ElementChanged?.Invoke(this, new VisualElementChangedEventArgs(null, Element));
}
public void SetElementSize(Size size) => Element.Layout(new Rectangle(Element.X, Element.Y, size.Width, size.Height));
}
}
\ No newline at end of file
......@@ -32,7 +32,7 @@ namespace LibVLCSharp.Tests
var rendererList = libVLC.RendererList;
Assert.IsNotEmpty(rendererList);
var rendererDiscoverer = new RendererDiscoverer(libVLC);
var rendererDiscoverer = new RendererDiscoverer(libVLC, libVLC.RendererList.LastOrDefault().Name);
var rendererItems = new List<RendererItem>();
var tcs = new TaskCompletionSource<bool>();
......@@ -63,7 +63,9 @@ namespace LibVLCSharp.Tests
[Test]
public void DisposeRendererDiscoverer()
{
var rendererDiscoverer = new RendererDiscoverer(new LibVLC());
var libVLC = new LibVLC();
var rendererDiscoverer = new RendererDiscoverer(libVLC, libVLC.RendererList.LastOrDefault().Name);
rendererDiscoverer.Start();
rendererDiscoverer.Dispose();
Assert.AreEqual(IntPtr.Zero, rendererDiscoverer.NativeReference);
......
......@@ -151,11 +151,6 @@ namespace LibVLCSharp.Shared
#endif
internal const string CoreLibraryName = "libvlccore";
#if COCOA
internal const string ServiceDiscoveryProtocol = "Bonjour_renderer";
#else
internal const string ServiceDiscoveryProtocol = "microdns_renderer";
#endif
/// <summary>
/// The name of the folder that contains the per-architecture folders
/// </summary>
......
using LibVLCSharp.Shared.Helpers;
using System;
using System.Linq;
using System.Runtime.InteropServices;
using System.Security;
namespace LibVLCSharp.Shared
{
/// <summary>
/// The renderer discoverer can be used to find and use a Chromecast or other distant renderers.
/// </summary>
public class RendererDiscoverer : Internal
{
RendererDiscovererEventManager _eventManager;
struct Native
{
[DllImport(Constants.LibraryName, CallingConvention = CallingConvention.Cdecl,
EntryPoint = "libvlc_renderer_discoverer_new")]
internal static extern IntPtr LibVLCRendererDiscovererNew(IntPtr libvlc, string name);
[DllImport(Constants.LibraryName, CallingConvention = CallingConvention.Cdecl,
EntryPoint = "libvlc_renderer_discoverer_release")]
internal static extern void LibVLCRendererDiscovererRelease(IntPtr rendererDiscoverer);
[DllImport(Constants.LibraryName, CallingConvention = CallingConvention.Cdecl,
EntryPoint = "libvlc_renderer_discoverer_start")]
internal static extern int LibVLCRendererDiscovererStart(IntPtr rendererDiscoverer);
[DllImport(Constants.LibraryName, CallingConvention = CallingConvention.Cdecl,
EntryPoint = "libvlc_renderer_discoverer_stop")]
internal static extern void LibVLCRendererDiscovererStop(IntPtr rendererDiscoverer);
[DllImport(Constants.LibraryName, CallingConvention = CallingConvention.Cdecl,
EntryPoint = "libvlc_renderer_discoverer_event_manager")]
internal static extern IntPtr LibVLCRendererDiscovererEventManager(IntPtr rendererDiscoverer);
}
public RendererDiscoverer(LibVLC libVLC, string name = Constants.ServiceDiscoveryProtocol)
/// <summary>
/// Create a new renderer discoverer with a LibVLC and protocol name depending on host platform
/// </summary>
/// <param name="libVLC">libvlc instance this will be connected to</param>
/// <param name="name">The service discovery protocol name depending on platform. Use LibVLC.RendererList to find the one for your platform</param>
public RendererDiscoverer(LibVLC libVLC, string name)
: base(() => Native.LibVLCRendererDiscovererNew(libVLC.NativeReference, name), Native.LibVLCRendererDiscovererRelease)
{
}
......@@ -55,22 +58,39 @@ namespace LibVLCSharp.Shared
}
}
/// <summary>
/// Start the renderer discovery
/// </summary>
/// <returns>true if start successful</returns>
public bool Start() => Native.LibVLCRendererDiscovererStart(NativeReference) == 0;
/// <summary>
/// Stop the renderer discovery
/// </summary>
public void Stop() => Native.LibVLCRendererDiscovererStop(NativeReference);
/// <summary>
/// Raised when a renderer item has been found
/// </summary>
public event EventHandler<RendererDiscovererItemAddedEventArgs> ItemAdded
{
add => EventManager.AttachEvent(EventType.RendererDiscovererItemAdded, value);
remove => EventManager.DetachEvent(EventType.RendererDiscovererItemAdded, value);
}
/// <summary>
/// Raised when a renderer item has disappeared
/// </summary>
public event EventHandler<RendererDiscovererItemDeletedEventArgs> ItemDeleted
{
add => EventManager.AttachEvent(EventType.RendererDiscovererItemDeleted, value);
remove => EventManager.DetachEvent(EventType.RendererDiscovererItemDeleted, value);
}
/// <summary>
/// Dispose of this renderer discoverer instance
/// </summary>
/// <param name="disposing">true if called from a method</param>
protected override void Dispose(bool disposing)
{
if (IsDisposed || NativeReference == IntPtr.Zero)
......@@ -85,6 +105,9 @@ namespace LibVLCSharp.Shared
}
}
/// <summary>
/// A renderer item represents a device that libvlc can use to render media.
/// </summary>
public class RendererItem : Internal
{
const int VideoRenderer = 0x0002;
......@@ -119,22 +142,41 @@ namespace LibVLCSharp.Shared
internal static extern int LibVLCRendererItemFlags(IntPtr rendererItem);
}
public RendererItem(IntPtr reference) :
internal RendererItem(IntPtr reference) :
base(() => reference, Native.LibVLCRendererItemRelease)
{
Native.LibVLCRendererItemHold(reference);
}
/// <summary>
/// Name of the renderer item
/// </summary>
public string Name => _utf8Marshaler.MarshalNativeToManaged(Native.LibVLCRendererItemName(NativeReference)) as string;
/// <summary>
/// Type of the renderer item
/// </summary>
public string Type => _utf8Marshaler.MarshalNativeToManaged(Native.LibVLCRendererItemType(NativeReference)) as string;
/// <summary>
/// IconUri of the renderer item
/// </summary>
public string IconUri => _utf8Marshaler.MarshalNativeToManaged(Native.LibVLCRendererItemIconUri(NativeReference)) as string;
/// <summary>
/// true if the renderer item can render video
/// </summary>
public bool CanRenderVideo => (Native.LibVLCRendererItemFlags(NativeReference) & VideoRenderer) != 0;
/// <summary>
/// true if the renderer item can render audio
/// </summary>
public bool CanRenderAudio => (Native.LibVLCRendererItemFlags(NativeReference) & AudioRenderer) != 0;
/// <summary>
/// Dispose of this renderer item instance
/// </summary>
/// <param name="disposing">true if called from a method</param>
protected override void Dispose(bool disposing)
{
if (IsDisposed || NativeReference == IntPtr.Zero)
......