Commit 12dc2be0 authored by Michael Bradshaw's avatar Michael Bradshaw Committed by Jean-Baptiste Kempf

Document the thread context in which Dav1dPicAllocator's functions are called

parent 41874f89
Pipeline #3531 passed with stages
in 4 minutes and 47 seconds
...@@ -75,6 +75,9 @@ typedef struct Dav1dPicAllocator { ...@@ -75,6 +75,9 @@ typedef struct Dav1dPicAllocator {
* pixel width/height multiple of 128 pixels. * pixel width/height multiple of 128 pixels.
* data[1] and data[2] must share the same stride[1]. * data[1] and data[2] must share the same stride[1].
* *
* This function will be called on the main thread (the thread which calls
* dav1d_get_picture()).
*
* @param pic The picture to allocate the buffer for. The callback needs to * @param pic The picture to allocate the buffer for. The callback needs to
* fill the picture data[0], data[1], data[2], stride[0] and * fill the picture data[0], data[1], data[2], stride[0] and
* stride[1]. * stride[1].
...@@ -89,6 +92,11 @@ typedef struct Dav1dPicAllocator { ...@@ -89,6 +92,11 @@ typedef struct Dav1dPicAllocator {
/** /**
* Release the picture buffer. * Release the picture buffer.
* *
* If frame threading is used, this function may be called by the main
* thread (the thread which calls dav1d_get_picture()) or any of the frame
* threads and thus must be thread-safe. If frame threading is not used,
* this function will only be called on the main thread.
*
* @param pic The picture that was filled by alloc_picture_callback(). * @param pic The picture that was filled by alloc_picture_callback().
* @param cookie Custom pointer passed to all calls. * @param cookie Custom pointer passed to all calls.
*/ */
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment