gopro/cineform-sdk

The GoPro® CineForm video codec SDK.

cineform-sdk's Issues

artifacts in samples

Saw it on samples from here:
http://www.siliconimaging.com/DigitalCinema/Gallery/spider_8_22_Jul_2007_07_23_24.zip
See picture:
https://s1.postimg.org/5azx0o2tyn/frame-36.png

1. (marked blue): some smearing at the bottom. Not present when decoding with vfw codec 9.0.5
2. (marked red): vertical line, visible in RG24, BGRA decoding modes. Also present with vfw codec.

[wish] make a new release

There have been 81 commits since the first release on GitHub back on 2017-10-23.

Memory leak caused by CFHD_PrepareToEncode (Windows only?)

There appears to be a memory leak when calling CFHD_PrepareToEncode. I've only tested on Windows 10.

I first observed this in some unit tests for my encoder (the unit test calls _CrtDumpMemoryLeaks), so to try and confirm the problem, I tried an infinite loop of creating an encoder, calling PrepareToEncode, and closing the encoder, to see how the process VM usage grows over time.

Using 8fd6bba from 'master' (9 Nov 21), build the solution with VS 2019 x64, and then insert the following at the very start of main() in TestCFHD.cpp

while (true)
{
    CFHD_EncoderRef enc = nullptr;
    CFHD_Error res = CFHD_OpenEncoder(&enc, nullptr);
    if (res != CFHD_ERROR_OKAY)
        return res;

    res = CFHD_PrepareToEncode(
        enc,
        320,
        160,
        CFHD_PIXEL_FORMAT_RG24,
        CFHD_ENCODED_FORMAT_YUV_422,
        CFHD_ENCODING_FLAGS_NONE,
        CFHD_ENCODING_QUALITY_DEFAULT);
    if (res != CFHD_ERROR_OKAY)
        return res;

    CFHD_CloseEncoder(enc);
}

Watch the process memory usage in something like Windows Task Manager.

The VM usage grows sharply with smaller resolutions (like 160x80, 320x160, etc) but much slower with higher resolutions.

Bayer format description

Hi! I've been trying to use the encoder with a bayer image. Other than the very vague description of "Raw Bayer 12-bits per component, packed line of 8-bit then line a 4-bit reminder" (CFHDTypes.h:145) I can't figure out what the format is.

Is it two pixels combined as two bytes of MSB then one byte containing the 4 bits LSB for the two?
Or is it MSB for all the pixels than LSB for all the pixels?
I've even tried one byte of MSB then one byte with the remaining 4 bits.

I've spent hours trying different formats and I'm always getting a cropped image with different parts overplayed in colors. Google doesn't turn up anything since this is a not a common thing.

Windows and MacOS compiled codec?

Hey Cineform Team,

Is there a guide available for installing the latest compile of Cineform so we can get playback in our native OS's?

Thanks,
Jonathan

ARM M1 Mac - Porting SSE2 instructions to NEON

Has anybody had success building for ARM, apple M1 in particular, and replacing the SSE2 instructions with NEON.

I tried using this library but was not fully successful. https://github.com/DLTcollab/sse2neon

encoding small frame from v210 fails

64 * 64 -> file with artifacts, or crashing vfw decoder.
also tried 96 * 64
s64.zip

Port to WebAssembly?

Has anyone tried to or contemplated porting the decoder to wasm for use in web browsers?

Crashes with odd image height in Stereo 3D

I have a bunch of files shot with a DSLR on a slider and converted to 2k CineForm 3D files. Due to the sensor size the 2k frames are 2048x1363. So this is an odd image height (not a multiple of two).

The decoder returns a Stereo 3D image when set to VIDEO_SELECT_BOTH_EYES and STEREO3D_TYPE_DEFAULT that is 2048x2728 (i.e. not 2048x2726 as one would expect) and has a black line (single pixel height) below each of the views/eyes.

Switching the Stereo 3D types to STEREO3D_TYPE_STACKED or STEREO3D_TYPE_FIELDS crashes the decoder. All other types work correctly (as long as I make the output buffer large enough to hold an extra scanline).

Availability of original C implementation

Hi, I'd like to ask if there are still any original C implementation codes available.

I'm currently working on multi-platform codes and revive cross-platform implementation of _PROCESSOR_DISPATCH feature for SIMD like SSE2, AVX2 and AVX-512 implementations for the future while keep the backwards compatibility.
And it seems some functions only have SSE2/MMX codes with no corresponding C implementation left. Maybe I could rewrite them in C but before doing this, I'd like to ask if they are available.

Regards.

DPX I/O support for demo code

This was in the closed CineForm example code, can that be added to the open source release?

inconsistent rgb/rgba behavior

I see different maximum values depending on requested decoding format.

decode to CFHD_PIXEL_FORMAT_BGRA:
result: r/g/b/a = 0xFF as expected

decode to CFHD_PIXEL_FORMAT_R210:
result: r/g/b = 0x3FC (expected 0x3FF)

decode to CFHD_PIXEL_FORMAT_B64A:
sample: CFHD_ENCODED_FORMAT_RGB_4444
result: r/g/b = 0xFF00, a = 0xFFFF (expected r/g/b 0xFFFF)
sample: CFHD_ENCODED_FORMAT_RGB_444
result: r/g/b = 0xFF00, a = 0xFFF0

Main issue is underscaled rgb, alpha seems ok where it is present.

Where are samples/documentation?

Hello,

I thought about integrating cineform into a toy project of mine which currently can just process image sequences through openimageio. I know oiio would even be able to do some stuff with video files, but my implementation is for frame sequences only at the moment.
Cineform seems like a nice intermediate codec and as I just realized a few days ago that DaVinci Resolve supports Cineform it would be nice to integrate it as working with large sequences of OpenEXR/tiff/dpx files is cumbersome. (Resolve for Linux is Cineform read only at the moment so I never saw it in the export and hadn't realized Resolve has at least some support for it.)

However, I'm unable to find a documentation for the use of Cineform either in the repository nor in the README and there is no usage sample. As I haven't found any other repository from gopro, is there any sample repository for the usage of cineform-sdk or a sample site?
I saw some mentions about some docu/samples from the times before cineform-sdk was open source somewhere. Are those available?

VCPKG integration

Hi,

is there any plan to integrate your SDK into vckpg install manager?

Building on Debian Jessie

I was able to successfully build this project on Debian Jessie with a couple of notes.

First, it is necessary to install cmake through jessie-backports to ensure you are on 3.5.1+

Second, I had to edit Example/TestCFHD.cpp line 497 from:

else sprintf_s(restxt, sizeof(restxt), "THUM");

to:

else sprintf(restxt, "THUM");

as "sprintf_s" is apparently not a standard c/c++ function, but sprintf will work with a change in parameters.

No code path to encode with optimised COLOR_FORMAT_BYR3 bayer color format

Looking at the code, the COLOR_FORMAT_BYR3 has a fast path which is by default enabled with the 'FAST_BYR3' define (encoder.c:119).
However, there is no exposed CFHD pixel format to use that code path.
There is a CFHD_PIXEL_FORMAT_BYR4 and a CFHD_PIXEL_FORMAT_BYR5 which map to COLOR_FORMAT_BYR4 and COLOR_FORMAT_BYR5 respectively but nothing for COLOR_FORMAT_BYR3 :(.

Is this an incomplete code optimisation which can't be used or have I misunderstood something?

multi-threaded encoder generates different output than single-threaded

I noticed some pattern, therefore looks suspicious.
Encoding constant input (repeated still frame)
single-threaded encoder output:
A,B,C,C,C,...
multi-threaded (2 threads):
A,A,B,B,C,C,C,...
multi-threaded (4 threads):
A,A,A,A,B,B,B,B,C,C,C,...
So is the output affected by some internal state in CSampleEncoder? Should this happen? Should this state be shared in encoders pool?
Decoded differences are somewhere 1-bit high.

Is there a working codec that can be installed on Win10 for viewing files?

After a couple years, i'm trying to view some old HD footage with cineform compression, but don't have the codec. Is this codec available any more so I can simply view/transcode my old cineform avi files? I can't get past the no-longer-supported license key step when trying to install the old version of neo3d I have archived. Any help would be appreciated, thanks!

LUTPaths: when is it used/useful?

There is some weirdness here (hardcoded fully qualified path)

cineform-sdk/Codec/lutpath.cpp

Line 483 in 1eb2cb7

TCHAR defaultLUTpath[260] = "C:\\Program Files\\Common Files\\CineForm\\LUTs";

and here

cineform-sdk/DecoderSDK/SampleMetadata.cpp

Line 62 in 1eb2cb7

TCHAR defaultLUTpath[260] = "C:\\Program Files\\Common Files\\CineForm\\LUTs";

Is this actually executed at some point?
Also there are registry access, system variable access etc. Is it a convention shared between all CineForm-enabled programs? Which programs create these registry keys and lut files?

aborting cleanly

First of all, thanks for releasing this to the community!

I've got the encoding working OK. I have 1 input thread submitting input samples by calling CFHD_EncodeAsyncSample(), and another output thread getting output samples by calling CFHD_WaitForSample(). Both of these functions (and therefore the threads) can block.

Perhaps I've missed something, but I can't find a way to cleanly abort if, for example, the user wants to prematurely cancel the encoding. At the moment of abort, either of the threads may be blocked. I've found that in a third thread I can call CFHD_ReleaseEncoderPool() - that unblocks both threads but with an exception, so this is obviously a dirty way of doing this that might leave the heap in a mess or a memory leak.

Is there a way of aborting cleanly, or just forcing CFHD_EncodeAsyncSample() and CFHD_WaitForSample() to unblock cleanly ?