serrecorder.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2014 by geehalel <[email protected]>
 
    SER File Format Recorder (see http://www.grischa-hahn.homepage.t-online.de/astro/ser/index.htm)
    Specifications can be found in
      - for V2: http://www.grischa-hahn.homepage.t-online.de/astro/ser/SER%20Doc%20V2.pdf
      - for V3: http://www.grischa-hahn.homepage.t-online.de/astro/ser/SER%20Doc%20V3b.pdf
 
    SER Files may be used as input files for Registax 6 or astrostakkert
    (which you can both run under Linux using wine), or also Siril, the linux iris version.
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
*/
 
#include "serrecorder.h"
#include "jpegutils.h"
 
#include <ctime>
#include <cerrno>
#include <cstring>
#include <sys/time.h>
 
 
#define ERRMSGSIZ 1024
 
namespace INDI
{
 
SER_Recorder::SER_Recorder()
{
    name = "SER";
    strncpy(serh.FileID, "INDI-RECORDER", 14);
    strncpy(serh.Observer, "Unknown Observer", 40);
    strncpy(serh.Instrume, "Unknown Instrument", 40);
    strncpy(serh.Telescope, "Unknown Telescope", 40);
    serh.LuID = 0;
    serh.PixelDepth = 8;
    number_of_planes = 1;
    // JM 2020-11-06: It appears we must always set it to BIG_ENDIAN since this is how astro-processing software
    // always default to. LITTLE_ENDIAN appears to be ignored by them leading to garbled data.
    serh.LittleEndian = SER_BIG_ENDIAN;
    isRecordingActive = false;
    f = nullptr;
 
    jpegBuffer = static_cast<uint8_t*>(malloc(1));
}
 
SER_Recorder::~SER_Recorder()
{
    free(jpegBuffer);
}
 
bool SER_Recorder::is_little_endian()
{
    unsigned int magic        = 0x00000001;
    unsigned char black_magic = *(unsigned char *)&magic;
    return black_magic == 0x01;
}
 
void SER_Recorder::write_int_le(uint32_t *i)
{
    if (is_little_endian())
        fwrite((i), sizeof(uint32_t), 1, f);
    else
    {
        unsigned char *c = (unsigned char *)i;
        fwrite((c + 3), sizeof(char), 1, f);
        fwrite((c + 2), sizeof(char), 1, f);
        fwrite((c + 1), sizeof(char), 1, f);
        fwrite((c), sizeof(char), 1, f);
    }
}
 
void SER_Recorder::write_long_int_le(uint64_t *i)
{
    if (is_little_endian())
    {
        fwrite(((uint32_t *)i), sizeof(int), 1, f);
        fwrite(((uint32_t *)(i) + 1), sizeof(int), 1, f);
    }
    else
    {
        write_int_le((uint32_t *)(i) + 1);
        write_int_le((uint32_t *)(i));
    }
}
 
void SER_Recorder::write_header(ser_header *s)
{
    fwrite((s->FileID), sizeof(char), 14, f);
    write_int_le(&(s->LuID));
    write_int_le(&(s->ColorID));
    write_int_le(&(s->LittleEndian));
    write_int_le(&(s->ImageWidth));
    write_int_le(&(s->ImageHeight));
    write_int_le(&(s->PixelDepth));
    write_int_le(&(s->FrameCount));
    fwrite((s->Observer), sizeof(char), 40, f);
    fwrite((s->Instrume), sizeof(char), 40, f);
    fwrite((s->Telescope), sizeof(char), 40, f);
    write_long_int_le(&(s->DateTime));
    write_long_int_le(&(s->DateTime_UTC));
}
 
bool SER_Recorder::setPixelFormat(INDI_PIXEL_FORMAT pixelFormat, uint8_t pixelDepth)
{
    serh.PixelDepth  = pixelDepth;
    m_PixelFormat = pixelFormat;
    number_of_planes = 1;
    switch (pixelFormat)
    {
        case INDI_MONO:
            serh.ColorID = SER_MONO;
            break;
 
        case INDI_BAYER_BGGR:
            serh.ColorID = SER_BAYER_BGGR;
            break;
        case INDI_BAYER_GBRG:
            serh.ColorID = SER_BAYER_GBRG;
            break;
        case INDI_BAYER_GRBG:
            serh.ColorID = SER_BAYER_GRBG;
            break;
        case INDI_BAYER_RGGB:
            serh.ColorID = SER_BAYER_RGGB;
            break;
        case INDI_RGB:
            number_of_planes = 3;
            serh.ColorID     = SER_RGB;
            break;
        case INDI_BGR:
            number_of_planes = 3;
            serh.ColorID     = SER_BGR;
            break;
        case INDI_JPG:
            number_of_planes = 3;
            serh.ColorID = SER_RGB;
            break;
        default:
            return false;
    }
 
    return true;
}
 
bool SER_Recorder::setSize(uint16_t width, uint16_t height)
{
    if (isRecordingActive)
        return false;
 
    rawWidth  = width;
    rawHeight = height;
 
    serh.ImageWidth = width;
    serh.ImageHeight = height;
    return true;
}
 
bool SER_Recorder::open(const char *filename, char *errmsg)
{
    if (isRecordingActive)
        return false;
    serh.FrameCount = 0;
    if ((f = fopen(filename, "w")) == nullptr)
    {
        snprintf(errmsg, ERRMSGSIZ, "recorder open error %d, %s\n", errno, strerror(errno));
        return false;
    }
 
    serh.DateTime     = getLocalTimeStamp();
    serh.DateTime_UTC = getUTCTimeStamp();
    write_header(&serh);
    frame_size        = serh.ImageWidth * serh.ImageHeight * (serh.PixelDepth <= 8 ? 1 : 2) * number_of_planes;
    isRecordingActive = true;
 
    frameStamps.clear();
 
    return true;
}
 
bool SER_Recorder::close()
{
    if (f)
    {
        // Write all timestamps
        for (auto value : frameStamps)
            write_long_int_le(&value);
 
        frameStamps.clear();
 
        fseek(f, 0L, SEEK_SET);
        write_header(&serh);
        fclose(f);
        f = nullptr;
    }
 
    isRecordingActive = false;
    return true;
}
 
bool SER_Recorder::writeFrame(const uint8_t *frame, uint32_t nbytes, uint64_t timestamp)
{
    if (!isRecordingActive)
        return false;
 
#if 0
    if (serh.ColorID == SER_MONO)
    {
        if (isStreamingActive == false &&
                (offsetX > 0 || offsetY > 0 || serh.ImageWidth != rawWidth || serh.ImageHeight != rawHeight))
        {
            int offset = ((rawWidth * offsetY) + offsetX);
 
            uint8_t *srcBuffer  = frame + offset;
            uint8_t *destBuffer = frame;
            int imageWidth      = serh.ImageWidth;
            int imageHeight     = serh.ImageHeight;
 
            for (int i = 0; i < imageHeight; i++)
                memcpy(destBuffer + i * imageWidth, srcBuffer + rawWidth * i, imageWidth);
        }
    }
    else
    {
        if (isStreamingActive == false &&
                (offsetX > 0 || offsetY > 0 || serh.ImageWidth != rawWidth || serh.ImageHeight != rawHeight))
        {
            int offset = ((rawWidth * offsetY) + offsetX);
 
            uint8_t *srcBuffer  = frame + offset * 3;
            uint8_t *destBuffer = frame;
            int imageWidth      = serh.ImageWidth;
            int imageHeight     = serh.ImageHeight;
 
            // RGB
            for (int i = 0; i < imageHeight; i++)
                memcpy(destBuffer + i * imageWidth * 3, srcBuffer + rawWidth * 3 * i, imageWidth * 3);
        }
    }
#endif
 
    if(timestamp)
        frameStamps.push_back(timestamp * m_sepaseconds_per_microsecond);
    else
        frameStamps.push_back(getUTCTimeStamp());
 
    // Not technically pixel format, but let's use this for now.
    if (m_PixelFormat == INDI_JPG)
    {
        int w = 0, h = 0, naxis = 1;
        size_t memsize = 0;
        if (decode_jpeg_rgb(const_cast<uint8_t *>(frame), nbytes, &jpegBuffer, &memsize, &naxis, &w, &h) < 0)
            return false;
 
        serh.ImageWidth = w;
        serh.ImageHeight = h;
        serh.ColorID = (naxis == 3) ? SER_RGB : SER_MONO;
        fwrite(jpegBuffer, 1, memsize, f);
    }
    else
        fwrite(frame, 1, nbytes, f);
    serh.FrameCount += 1;
    return true;
}
 
// Copyright (C) 2015 Chris Garry
//
 
//
// Calculate if a year is a leap yer
//
bool SER_Recorder::is_leap_year(uint32_t year)
{
    if ((year % 400) == 0)
    {
        // If year is divisible by 400 then is_leap_year
        return true;
    }
    else if ((year % 100) == 0)
    {
        // Else if year is divisible by 100 then not_leap_year
        return false;
    }
    else if ((year % 4) == 0)
    {
        // Else if year is divisible by 4 then is_leap_year
        return true;
    }
    else
    {
        // Else not_leap_year
        return false;
    }
}
 
uint64_t SER_Recorder::getUTCTimeStamp()
{
    uint64_t utcTS;
 
    // Get starting time
    timeval currentTime;
    gettimeofday(&currentTime, nullptr);
 
    struct tm *tp;
    time_t t   = (time_t)currentTime.tv_sec;
    uint32_t u = currentTime.tv_usec;
 
    // UTC Time
    tp = gmtime(&t);
 
    dateTo64BitTS(tp->tm_year + 1900, tp->tm_mon + 1, tp->tm_mday, tp->tm_hour, tp->tm_min, tp->tm_sec, u, &utcTS);
 
    return utcTS;
}
 
uint64_t SER_Recorder::getLocalTimeStamp()
{
    uint64_t localTS;
 
    // Get starting time
    timeval currentTime;
    gettimeofday(&currentTime, nullptr);
 
    struct tm *tp;
    time_t t   = (time_t)currentTime.tv_sec;
    uint32_t u = currentTime.tv_usec;
 
    // Local Time
    tp = localtime(&t);
 
    dateTo64BitTS(tp->tm_year, tp->tm_mon, tp->tm_mday, tp->tm_hour, tp->tm_min, tp->tm_sec, u, &localTS);
 
    return localTS;
}
 
// Convert real time to timestamp
//
void SER_Recorder::dateTo64BitTS(int32_t year, int32_t month, int32_t day, int32_t hour, int32_t minute, int32_t second,
                                 int32_t microsec, uint64_t *p_ts)
{
    uint64_t ts = 0;
    int32_t yr;
 
    // Add 400 year blocks
    for (yr = 1; yr < (year - 400); yr += 400)
    {
        ts += m_septaseconds_per_400_years;
    }
 
    // Add 1 years
    for (; yr < year; yr++)
    {
        uint32_t days_this_year = 365;
        if (is_leap_year(yr))
        {
            days_this_year = 366;
        }
 
        ts += (days_this_year * m_septaseconds_per_day);
    }
 
    // Add months
    for (int mon = 1; mon < month; mon++)
    {
        switch (mon)
        {
            case 4:  // April
            case 6:  // June
            case 9:  // September
            case 11: // Novenber
                ts += (30 * m_septaseconds_per_day);
                break;
            case 2: // February
                if (is_leap_year(year))
                {
                    ts += (29 * m_septaseconds_per_day);
                }
                else
                {
                    ts += (28 * m_septaseconds_per_day);
                }
 
                break;
            default:
                ts += (31 * m_septaseconds_per_day);
                break;
        }
    }
 
    // Add days
    ts += ((day - 1) * m_septaseconds_per_day);
 
    // Add hours
    ts += (hour * m_septaseconds_per_hour);
 
    // Add minutes
    ts += (minute * m_septaseconds_per_minute);
 
    // Add seconds
    ts += (second * C_SEPASECONDS_PER_SECOND);
 
    // Micro seconds
    ts += (microsec * m_sepaseconds_per_microsecond);
 
    // Output result
    *p_ts = ts;
}
 
}